Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation / readme update #99

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Documentation / readme update #99

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0aeecd5
Updated pinout table
markusb Jul 15, 2018
2c72faf
Added status LED info and table
markusb Jul 15, 2018
81fca2d
Added status LED info and table
markusb Jul 15, 2018
f3498bc
Added status LED info and table, fix
markusb Jul 15, 2018
999b90e
Added status LED info and table, fix formatting 2nd
markusb Jul 15, 2018
8e36803
Added status LED info and table, fix formatting 4th
markusb Jul 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 31 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,16 +122,37 @@ Note: You still need to set the Artnet net, subnet and universe correctly.

Modify FX is only currently used for the Static effect and is used to resize colour 1 within the overall size.

## NodeMCU & Wemos Pins
These boards use strange numbering that doesn't match the ESP8266 numbering. Here are the main hookups needed:

| NodeMCU & Wemos | ESP8266 GPIO | Purpose |
|-----------------|--------------|---------|
| TX | GPIO1 | DMX_TX_A |
| D4 | GPIO2 | DMX_TX_B |
| RX | GPIO3 | DMX_RX (for A & B) |
| D1 | GPIO5 | DMX_DIR_A |
| D0 | GPIO16 | DMX_DIR_B |
## ESP Pins used (including NodeMCU & Wemos)
This is the pins used by the ArtNetNode firmware. The NodeMCU & Wemos/Lolin boards use strange numbering that doesn't match the ESP8266 numbering. They are show also

Here are the main hookups needed:

| ESP8266 GPIO | NodeMCU & Wemos | Purpose |
|--------------|-----------------|---------|
| GPIO1 | TX | DMX_TX_A / WS2812 data A |
| GPIO2 | D4 | DMX_TX_B / WS2812 data B |
| GPIO3 | RX | DMX_RX (for A & B) |
| GPIO5 | D1 | DMX_DIR_A |
| GPIO16 | D0 | DMX_DIR_B |
| GPIO12 | D6 | LED_A 3 x WS2812 for status display |
| GPIO14 | D5 | Button for reset to factory defaults |

## Node status display
If a string of three WS2812 LEDs are connected to LED_A then they show the status of the device.

| LED | Display | Color |
|-------|---------------|-------|
| LED 1 | Channel A | Cyan: DMX input sent to Artnet |
| | | Blue: Artnet input sent to DMX (DMX mode) |
| | | Green: Artnet input sent to WS2812 (WS2812 mode) |
| LED 2 | Channel B | Cyan: DMX input sent to Artnet |
| | | Blue: Artnet input sent to DMX (DMX mode) |
| | | Green: Artnet input sent to WS2812 (WS2812 mode) |
| LED 3 | Device status | Pink: Startup |
| | | Green flashing: Hartbeat |
| | | Red flashing: Error |

For the node status display three WS2812 LEDs need to be connected to pin LED_A.

## Special Thanks To
I'd like to thank these people. They have either contributed with donations, a large amount of testing and feedback, or with their own code/projects that have been of assistance or inspiration.
Expand Down