Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aldaviva/webscale.net
⚖ Measure weight using a Stamps.com digital USB postage scale
https://github.com/aldaviva/webscale.net
postage scale stamps-com usb-hid weight
Last synced: 15 days ago
JSON representation
⚖ Measure weight using a Stamps.com digital USB postage scale
- Host: GitHub
- URL: https://github.com/aldaviva/webscale.net
- Owner: Aldaviva
- License: apache-2.0
- Created: 2023-04-09T05:39:44.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-26T12:27:09.000Z (3 months ago)
- Last Synced: 2024-12-09T12:07:03.855Z (19 days ago)
- Topics: postage, scale, stamps-com, usb-hid, weight
- Language: C#
- Homepage: https://www.nuget.org/packages/WebScale
- Size: 810 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: License.txt
Awesome Lists containing this project
README
WebScale
========
[](https://www.nuget.org/packages/WebScale/) [](https://github.com/Aldaviva/WebScale.net/actions/workflows/dotnetpackage.yml) [](https://aldaviva.testspace.com/spaces/210815) [](https://coveralls.io/github/Aldaviva/WebScale.net?branch=master)
*Measure weight using a Stamps.com digital USB postage scale*
1. [Quick Start](#quick-start)
1. [Prerequisites](#prerequisites)
1. [Installation](#installation)
1. [Usage](#usage)
- [Connect to device](#connect-to-device)
- [Read weight](#read-weight)
- [Listen for weight change events](#listen-for-weight-change-events)
- [Tare](#tare)
- [Dispose](#dispose)
1. [Sample](#sample)
1. [See also](#see-also)
## Quick Start
```ps1
dotnet new console
dotnet add package WebScale
```
```cs
// Program.cs
using Aldaviva.WebScale;
using IWebScale webScale = new WebScale();
webScale.WeightChanged += (sender, weight) => Console.WriteLine($"{weight.OunceForce,4:N1} oz.");
// Keep console program running while waiting for WeightChanged events
CancellationTokenSource cancellationTokenSource = new();
Console.CancelKeyPress += (sender, eventArgs) => {
eventArgs.Cancel = true;
cancellationTokenSource.Cancel();
};
Console.WriteLine("Press Ctrl+C to exit");
cancellationTokenSource.Token.WaitHandle.WaitOne();
```
```ps1
dotnet run
```
## Prerequisites
- Stamps.com Stainless Steel 5 lb. Digital Scale
1. Sign up for free trial at [Stamps.com](https://registration.stamps.com/registration/).
2. During signup, request a complimentary [5-pound digital postage scale](https://store.stamps.com/collections/hardware/products/5lb-scale). Pay $9.99 USD shipping and handling.
3. Before the four-week trial is up, [cancel your account](https://www.stamps.com/postage-online/faqs/) and avoid the monthly fee.
*I successfully performed these steps in [September 2014](https://twitter.com/Aldaviva/status/516771809962651648). Today, it may work differently, or not at all.*
- Any .NET runtime that supports [.NET Standard 2.0 or later](https://docs.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0#net-standard-versions):
- [.NET 5.0 or later](https://dotnet.microsoft.com/en-us/download/dotnet)
- [.NET Core 2.0 or later](https://dotnet.microsoft.com/en-us/download/dotnet)
- [.NET Framework 4.6.1 or later](https://dotnet.microsoft.com/en-us/download/dotnet-framework)
- Operating systems:
- Windows
- MacOS
- Linux (may need superuser permissions to access `/dev/hidraw0`)
## Installation
This package is available as [`WebScale` on NuGet Gallery](https://www.nuget.org/packages/WebScale).
```ps1
dotnet add package WebScale
```
```ps1
NuGet\Install-Package WebScale
```
## Usage
### Connect to device
Construct a new `WebScale` instance.
```cs
using Aldaviva.WebScale;
using IWebScale webScale = new WebScale();
```
This connects to the first Stamps.com Stainless Steel 5 lb. Digital Scale found connected to the computer.
If there is no suitable device connected, this will wait asynchronously and connect when one appears. If the device disconnects, this will wait for it to reconnect and then automatically reestablish a connection.
The `IsConnected` property shows whether or not the instance is currently connected to a scale. Updates to this property are indicated by the `IsConnectedChanged` event.
### Read weight
Get how much weight is currently on the scale. The precision is 0.1 ounces. Can be negative if the scale was tared with weight on it which was subsequently reduced.
```cs
Force weight = webScale.Weight;
```
The `Force` type is from the [UnitsNet](https://github.com/angularsen/UnitsNet) library. You can get specific units of force using properties on it like `OunceForce` or `KilogramsForce`.
This property automatically updates every 400 ± 15 milliseconds whenever the scale is connected.
### Listen for weight change events
Receive a notification when the weight on the scale changes. Not fired while taring.
```cs
webScale.WeightChanged += (sender, weight) => Console.WriteLine($"{weight.OunceForce,4:N1} oz.");
```
The event argument is the amount of weight currently on the scale.
If you need event callbacks to run on the UI thread so you can update a Windows Forms or WPF UI, you can set the `IWebScale.EventSynchronizationContext` property.
### Tare
The scale automatically resets itself to zero when it powers on. You can also manually tare it by calling `Tare()`.
```cs
await webScale.Tare();
```
After this task completes, the scale's weight will read zero.
### Dispose
When you are done with this instance, call [`Dispose()`](https://learn.microsoft.com/en-us/dotnet/api/system.idisposable.dispose) to disconnect from the device. You can also use a [`using` statement](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/using-statement) or [declaration](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/using-statement).
```cs
public void ExplicitlyDispose() {
IWebScale webScale = new WebScale();
// use webScale here
webScale.Dispose();
}
```
```cs
public void ImplicitlyDisposeWithUsingDeclaration() {
using IWebScale webScale = new WebScale();
// use webScale here
// when control exits the ImplicitlyDisposeWithUsingDeclaration method, webScale will be disposed
}
```
```cs
public void ImplicitlyDisposeWithUsingStatement() {
using (IWebScale webScale = new WebScale()) {
// use webScale here
// when control exits the using block, webScale will be disposed
}
}
```
## Sample
The [sample application](https://github.com/Aldaviva/WebScale.net/blob/master/Sample/Program.cs) demonstrates usage of this library.
You may clone this repository and run the sample with `dotnet run` in the `Sample` project directory.
You may also [download prebuilt executables](https://github.com/Aldaviva/WebScale.net/releases/latest/download/Samples.zip) of the sample app for Windows, Linux, and MacOS, each on x64 and ARM. Remember that the Linux app needs to be run with `sudo`, and the MacOS and Linux apps need the `chmod +x` executable bit.
## See also
- [**Aldaviva/webscale**](https://github.com/Aldaviva/webscale) - Node.js version of this library