nixiepipe v1.0.2
Module for control of the Nixie Pipe Master over USB
Install
npm install nixiepipe
Usage
var NixiePipe = require('nixiepipe');
var pipes = new NixiePipe();
pipes.once("connected", function() {
pipes.setNumber(9999); // Set array number 9999
pipes.setColour(0,0,255); // Set blue
pipes.show(); // Write and set new settings
pipes.getNumber( function() { console.log(pipes.number); }); // Return display number
});Classes
NixiePipe ⇐ EventEmitter.
NixiePipe is a Nixie Pipe Master connected via USB
Kind: global class
Extends: EventEmitter.
Properties
| Name | Type | Description |
|---|---|---|
| _queue | Packet buffer to maintain syncronous serial communication. | |
| _busy | If queue is active. | |
| debug | Output debugging logs. | |
| connected | Status of connection. | |
| version | Version of Nixie Pipe firmware. | |
| number | Current display number (must be updated using getNumber). | |
| packet | Last data packet recieved. | |
| Serial | SerialPort | object used by class. |
- NixiePipe ⇐ EventEmitter.
new NixiePipe(port, callback)
| Param | Type | Description |
|---|---|---|
| port | string | Serial port Nixie Pipe Master connected to. If not passed, will auto-detect using device descriptor. |
| callback | function | Function to be called once handshake connection is confirmed. |
nixiePipe.setNumber(value)
Set new number to Nixie Pipe array.
Kind: instance method of NixiePipe
| Param | Type | Description |
|---|---|---|
| value | int | New value to be displayed. |
nixiePipe.setPipeNumber(pipe, value)
Set new individual pipe number.
Kind: instance method of NixiePipe
| Param | Type | Description |
|---|---|---|
| pipe | int | Index of Nixie Pipe to set. |
| value | int | New value to be displayed (0-9). |
nixiePipe.setColour(r, g, b)
Set new Nixie Pipe array RGB colour.
Kind: instance method of NixiePipe
| Param | Type | Description |
|---|---|---|
| r | int | Red colour saturation. |
| g | int | Green colour saturation. |
| b | int | Blue colour saturation. |
nixiePipe.setPipeColour(pipe, r, g, b)
Set individual Nixie Pipe RGB colour
Kind: instance method of NixiePipe
| Param | Type | Description |
|---|---|---|
| pipe | int | Index of Nixie Pipe to set. |
| r | int | Red colour saturation. |
| g | int | Green colour saturation. |
| b | int | Blue colour saturation. |
nixiePipe.show()
Write and show display changes. Changes to the display are not visable until this is called. Firmware must disable ISR to write LED updates so serial transmission will be disabled. Syncronous serial buffer will manage this by enforcing a wait until Nixie Pipe indicats LED update is complete
Kind: instance method of NixiePipe
nixiePipe.clear()
Clear Nixie Pipe array (set black)
Kind: instance method of NixiePipe
nixiePipe.clearPipe()
Clear single Nixie Pipe in array (set black)
Kind: instance method of NixiePipe
nixiePipe.setBrightness(value)
Set array brightness.
Kind: instance method of NixiePipe
| Param | Type | Description |
|---|---|---|
| value | int | 0-255 intensity - 0 off/255 full |
nixiePipe.getNumber(callback) ⇒ int
Update this.number with value reported by firmware.
Kind: instance method of NixiePipe
Returns: int - Number being displated on Nixie Pipe array.
| Param | Type | Description |
|---|---|---|
| callback | function | Function to call when firmware replies with value. |