https://github.com/tuna-f1sh/py-nixiepipe
Python package for interfacing with the Nixie Pipe Master hardware
https://github.com/tuna-f1sh/py-nixiepipe
nixie-pipe python-library
Last synced: about 1 year ago
JSON representation
Python package for interfacing with the Nixie Pipe Master hardware
- Host: GitHub
- URL: https://github.com/tuna-f1sh/py-nixiepipe
- Owner: tuna-f1sh
- License: gpl-3.0
- Created: 2016-11-27T17:16:56.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-18T15:00:54.000Z (over 8 years ago)
- Last Synced: 2025-01-28T12:44:25.976Z (over 1 year ago)
- Topics: nixie-pipe, python-library
- Language: Python
- Size: 27.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nixie Pipe Python Package
Python package containing *nixiepipe* class for interfacing with [Nixie Pipe](www.nixiepipe.com)
Master hardware.
## Dependancies
* [pyserial](https://github.com/pyserial/pyserial).
* Nixie Pipe Master running [np-serial](https://github.com/tuna-f1sh/NixiePipe/tree/master/firmware/np-serial) firmware.
* _pyowm_, _configparser_, _threading_ _to use example scripts_.
## Install
In root folder, run `./setup.py install`.
## Basic Usage
```python
import nixiepipe
# Create pipe object from nixiepipe class. Will auto find serial port using device descriptor
pipe = nixiepipe.pipe()
pipe.setNumberUnits(0) # Set number of Nixie Pipe Unit modules
pipe.setColour(0,0,255) # Set array colour blue
pipe.setNumber(9999) # Set array number to 9999
# Write and show new settings
pipe.show()
```
## Examples 'examples/'
* **np-serial.py**: Basic API example showing for loop increment and colour
set.
* **weather.py**: Display weather with Nixie Pipe Weather Unit Pipe using Open
Weather Map.
* **cpu-usage.py**: Display CPU usage.
* **stock-ticker.py**: Display stock symbols. Pass symbols as arguments.
### Weather Example API Key Config File
You will need an API key for the Open Weather Map module. I have used
_configparser_ to save my API key outside the repo. To use the `weather.py`
you will need to **create a file 'owm-api.ini'** in the 'examples/' directory
with the contents:
```
[API]
OpenWeatherMap = YOUR_API_KEY
```
# License and Attribution
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CFA7TQXNFURLQ)
Licensed under GPL 3.0. I many of my projects open source so others can learn as I have but please attribute my creations if you derive use of them in your own work, by following the license terms, linking to www.jbrengineering.co.uk and/or the project page.