REST API to light up individual NeoPixels associated with a specific cart/shelf/bin via a serial link to a microcontroller.
Clone this repository, install package dependencies with npm install, and then from the root folder run at any time:
npm start
neopixel-serial-bindicators will attempt to connect with a microcontroller at 9600 baud on a serial/USB link, and accept requests to configure via API any LED strips connected to that microcontroller.
The following microcontrollers are supported, with code provided:
| Microcontroller (and shield) | Code (in /microcontrollers folder) |
|---|---|
| Arduino Nano with Grove shield | arduino-nano.ino |
| Adafruit Feather RP2040 SCORPIO | adafruit-feather-rp2040-scorpio.ino |
Program each microcontroller using the Arduino IDE.
To get set up with the Adafruit Feather RP2040 SCORPIO, follow the Arduino IDE Setup tutorial and the Adafruit_NeoPXL8 library installation tutorial. Then program the board with the adafruit-feather-rp2040-scorpio.ino file from the Arduino IDE.
neopixel-serial-bindicators's REST API includes the following base route:
- /bindicators to indicate one or more bins with specific LED settings
Update the strips to indicate one or more bins with specific LED settings.
| Method | Route | Content-Type |
|---|---|---|
| PUT | /bindicators | application/json |
[
{ "cart": "A", "shelf": 1, "bin": 2, "rgb": "0770a2" },
{ "cart": "B", "shelf": 3, "bin": 1, "rgb": [ 7, 112, 162 ] }
]
{
"_meta": {
"message": "ok",
"statusCode": 200
},
"_links": {
"self": {
"href": "http://localhost:3000/bindicators/"
}
}
}
To turn off all LEDs, PUT /bindicators with an empty array ([]).
On startup, neopixel-serial-bindicators will load all relevant files in the /config directory.
The strips-x.csv files define the association of a chain of strips with the cart(s)/shelves/bins it serves to indicate. The 'x' represents the id of the chain of strips with reference to the microcontroller (ex: strips-0.csv).
The first line of the file is ignored, and therefore typically used as a header defining each column to facilitate manual editing. The second line, and all subsequent lines, are read into the configuration, each representing a specific shelf, and observe the following column ordering:
| Column | Title | Description |
|---|---|---|
| 1 | "cartName" | String identifying the cart (ex: "1") |
| 2 | "shelfId" | Positive integer defining the shelf (ex: 2) |
| 3 | "shelfWidth" | Width of the shelf in mm (ex: 1000) |
| 4 | "stripOffset" | Offset of the first LED of this shelf (ex: 0) |
| 5 | "stripLength" | Number of LEDs associated with this shelf (ex: 60) |
| 6 | "isReverse" | true if strip goes left-to-right, false otherwise |
| 7 | "bin(1)" | Offset in mm from the start of the shelf to the start of the first bin (ex: 0) |
| 7+n-1 | "bin(n)" | Offset in mm from the start of the shelf to the start of the n-th bin (ex: 920) |
The line corresponding with the table above is as follows: "1",2,1000,0,60,true,0,...,920
neopixel-serial-bindicators translates API requests into serial messages, according to the following protocol, which can easily be interpreted by resource-constrained microcontrollers and transformed into neopixel commands using existing libraries.
Each serial message is 6 bytes long, as specified in the following table, and terminated with a newline character ('\n').
| Byte offset | Description |
|---|---|
| 0 | Strip id (0 to 127) or special command (128-255) |
| 1 | MSB of LED offset or strip id for special command |
| 2 | LSB of LED offset |
| 3 | Red intensity (0 to 255) |
| 4 | Green intensity (0 to 255) |
| 5 | Blue intensity (0 to 255) |
The following special commands are supported:
- 0xaa: display the current configuration
- 0xff: clear the current configuration
For example, to clear strip 1 and make the first three LEDs red, green and blue, respectively, the serial message sequence, as hexadecimal strings, would be as follows:
ff01000000000a
000000ff00000a
00000100ff000a
0000020000ff0a
aa01000000000a
The seventh byte in each message above is the newline character (0x0a).
MIT License
Copyright (c) 2023 reelyActive
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.