CircuitPython interface for DYMO postage scales.
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-dymoscale
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-dymoscale
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-dymoscale
Initialize the scale by passing it a data pin and a pin to toggle the units button:
# initialize the dymo scale
units_pin = digitalio.DigitalInOut(board.D3)
units_pin.switch_to_output()
dymo = adafruit_dymoscale.DYMOScale(board.D4, units_pin)
Get the item's weight from the scale:
reading = dymo.weight
print(reading.weight)
Get the item's units from the scale:
print(reading.units)
To toggle between units (simulate a button press):
dymo.toggle_unit_button(switch_unit=True)
To toggle the unit button, but preserve the unit displayed:
dymo.toggle_unit_button()
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
To build this library locally you'll need to install the circuitpython-build-tools package.
python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
source .env/bin/activate
Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-dymoscale --library_location .
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/html
This will output the documentation to docs/_build/html
. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.