Content → Arduino

• WIO Overview | WIO Setup | WIO Control | User Bitmaps | WIO Firmware | WIO CAM

This solution is based on the ESP8266/ESP32 family.

It can be used as:

• Wireless Throttle

or as wireless I/O with:

• 32 I2C I/O GCA compatible
• 2 Displays SSD1306

and one of the following extra functions:

1. LED control WS2812
2. 4 Servos
3. 2 RC522 readers
4. DCC Generator
5. Mobile PWM, direction and lights

and one of the following options:

• ID12LA 125kHz RFID reader on RX
• RailCom reader on RX

• Lolin D1 Mini
• Lolin D32
• ESP32 Dev Module

Check the pin mapping in Pins.cpp:

• https://gitlab.com/rocrail/wio/-/blob/master/Pins.cpp

• https://gitlab.com/rocrail/wio/blob/master/docu/WIO.odp

1. The Rocrail server must run on a PC which does not automatically suspend or sleep in case of no user activity. Check the energy setting to prevent communication loss.
2. The used WiFi Router should be state of the art; Only use maintained hardware.
3. Make sure the SSID is not visible to prevent extra public traffic.

Tested with version 1.8.10 (1.8.11 does not work!)
Prepare the Arduino IDE with the following boards and libraries:

Add in the preference dialog to "Additional board manager" the following URL:

https://arduino.esp8266.com/stable/package_esp8266com_index.json, https://dl.espressif.com/dl/package_esp32_index.json

And install the ESP8266 board library.

LOLIN(WEMOS)D1 R2 & mini

• ESP8266WiFi (Board Manager)
  Stick with version 2.5.2 because there are unsolved issues with version 2.6.x.
• Wire (I2C)
• FastLED (WS2812)
• RotaryEncoder
• MFRC522 (RC522)
• Servo
• ArduinoOTA

Select 2M SPIFFS size:

SPIFFS is a file system which can be used in WIO for uploading user bitmaps.
Installing the Arduino IDE Plugin for uploading data:

• https://github.com/esp8266/arduino-esp8266fs-plugin

For those who wants a Dark Theme for the Arduino IDE:

• https://github.com/konrad91/OneDarkArduino

WIO is firmware for controlling Throttle, I2C, LEDs, Servos, RFID, Displays and DCC.

• https://gitlab.com/rocrail/wio
• Download as Zip
• Change Log

The source code is public but not open source licensed, and it should be used only to compile and load it on the LOLIN D1 Mini.

Use the Espressif tool to upload the WIO Binary.

• WIO Binary
• ESP Flash Download Tool

The red FastLED pragma messages, which is information only, can be ignored, as long as the last two white lines show up:

 #    pragma message "FastLED version 3.003.002"
 #      pragma message "No hardware SPI pins defined.  All SPI access will default to bitbanged output"

Sketch uses 293716 bytes (28%) of program storage space. Maximum is 1044464 bytes.
Global variables use 33104 bytes (40%) of dynamic memory, leaving 48816 bytes for local variables. Maximum is 81920 bytes.

Setting up the WiFi can be done with the Arduino Serial Monitor 115200 bps, or by modifying the USERCNF.h:

#1CConnecting to [secure.home]
#13WiFi try to connect
...
#13WiFi try to connect
#17WiFi connected RSSI=-55

Output after a ? command:

Settings:
------------------------------
version=0.85 WIO 20191031d (c)Rocrail
ssid=xxxxxxxx
pwd=xxxxxxxx
server=xxxxxxxx
port=8051
name=
id=33
io=i2cdcc
i2c=ooooooooooooooooppppiiiibbbbbbbb
steps=50
pulse=50
display=22
dccsc=0
railcom=0
maxpower=0
RSSI=-53
MCP23017 status: 0x20=OK 0x21=OK
I2C device found at address 0x20
I2C device found at address 0x21
I2C device found at address 0x3C
I2C found 3 devices
loco1=0 loco2=3 active=0

Change settings by typing:
------------------------------
*ssid=<your WiFi SSID>
*pwd=<your WiFi password>
*server=<your Rocrail server IP/host>
*port=<your Rocrail server port>
*name=<Node name>
*id=<Node number>
*io=<type> <throttle> or <i2cled> or <i2cservo> or <i2crfid> or <i2cdcc> or <i2cmobile>
*i2c=<oooooooobbbbbbbboooooooobbbbbbbb> o=output, i=input, b=block, p=pulse
*steps=<number of rotary steps>
*pulse=<output pulse length in 100ms units>
*display=<geometry1><geometry2> 0=96x16 1=128x32 2=128x64
*dccsc=<short circuit detection> 0=off 1=on
*railcom=<use RX for detection> 0=off 1=on
*maxpower=<set max. WiFi power> 0=off 1=on (Needs a reboot)

The USERCNF.h file can be used for initial, first boot, WiFi and Rocrail server values.
The values must be set before compile and upload.
Afterwards those values can be changed with monitor commands.

The Arduino Serial Monitor can be use with 57600 bps to change WIO settings.
(If RailCom has been activated the baudrate switches automatically to 250000 and the Serial Monitor is read only.)

Note: Replace <value> to meet the local WiFi environment and setup.
Note: A reset is necessary after changing the WIO Type.

The WIO acts as a tiny Access Point to be able to connect and do the basic setup without serial monitor.
The WIO AP name is formatted as follows: "WIO<id>.<name>" (Default: WIO33.local)
The WIO APs are listed up and can be selected:

The AP default Password is "12345678" which can be changed in the USERCNF.h.
After connecting to the WIO, the basic setup can be changed with a WEB browser at URL:

http://192.168.4.1

After Submit the WIO will retry automatically the WiFi and Rocrail Server connection.
The AP will be stopped after:

• a submit.
• 2 minutes idle.

If it's not possible, or cumbersome, to update by USB, the WIO can also be updated "Over The Air" (OTA).

Just select the desired WIO from the list instead of the USB port, and upload.
If asked for a Password, this is the same as for the Access Point.

Note: RIC controls locos by address, not by ID. So the first one in the list will be used if multiple locos share the same address.
The pocket throttle I/O mode needs a rotary switch, one LED and four buttons.
The LED can also be the build in one. (D4)

F0 is flipped if both F3 and F4 are pressed.

An emergency break will send to the server if both F1 and F2 are pressed.

Loco 1 is selected by default.
Select loco 1 if both F1 and F4 are pressed.
Select loco 2 if both F2 and F3 are pressed.

At boot the LED will turn on until a WiFi connection is established.

1. In case the LOLii did not catch a dispatched loco, and the rotary is pressed long, about 2 seconds, the LED will start flashing fast.
2. If the LOLii sees in this mode a loco dispatch, it will catch it and the LED will start flashing slow.
3. This loco catch will be saved in the flash memory and reused at reboot if it was not released.

• Turn the rotary for speed changes.
• A short rotary press will flip the loco direction.

The four function buttons represents F1 to F4.
With a long click F5 to F8 can be accessed.
A function will be flipped after releasing the button to be able to process long clicks. (Same as with smartphones.)

1. Press the rotary long, about 2 seconds,
2. A release message is send.
3. The LED will go off.

The analog input will check the battery voltage.
If the voltage is below a certain level, LOLii will send automatically a zero speed command to the locomotive and a release command.
The LED will start blinking very fast as long the battery is not drained completely.

If the Rocrail Server has R2RNet active on multicast address 226.0.0.1, the LOLii can retrieve the server name/IP to connect it to the 8051 client port automatically.

• Connects directly to the Rocrail Server Client port 8051.
• WiFi and Server connection recovery.
• 32 digital I/O compatible with all GCA interfaces.
  • Input
  • Output
  • Block
  • Pulse
• 128 LEDs compatible with WS2812 on D8. (Color type output in Rocrail.)
  • RGB color
  • Brightness
  • Dimming
  • Flashing
• 4 Servos
  • Adjustable movement speed
  • Positions are saved in the plan.xml, Output/Switch, which makes swapping of hardware easier.
  • Reached end positions are saved in flash to provide a stable reboot.
• DCC Command Station
• Up to 255 units in the same WiFi network. (Depending on the IP configuration and availability.)
• An alarm will be generated if 'a live' messages are no longer come in.
• Output/Switch commands are acknowledged after they have been processed. (Blink outputs are not acknowledged.)
• Input events must be acknowledged within 100ms. After this timeout a resend will occur. (Max. 5 retries.)

This addressing schema is used for:

• Outputs
• Switches
• Signals
• Sensors

The output blink and delay options can be used to blink an I2C port.
If the delay is zero the default pulse length will be used.

The addressing is the same as normal outputs.

1. WIO-ID: Bus
2. LED number: Address
3. LED range: ON parameter
4. The Interface → Color option and type light must be set
5. Brightness is set by Interface → Value
6. Dimming step is set by Interface → Delay (0…15) (A value of zero deactivate dimming.)
7. The Interface → Blink option may be used to flash the LED
8. The LED color is set by Color → RGB

1. WIO-ID: Bus
2. LED offset: Address
3. Port type: LED
4. Control type: Aspect number (Max. 6 sub LEDs → 2 x WS2812)
5. Brightness

The aspect values are compatible with RocNetNode Pi08. (WIO version 0.81+)

The addressing is the same as normal outputs.

1. Two Mifare RFID RC522 readers are supported.
2. It needs 5 extra ports; Parallel Servos are not possible.
3. Reporting addresses are 100 and 101. (In Rocrail 101 and 102.)
4. Automatic sensor off event after 1500ms. (Before it must be acknowledged by the server.)
5. Four times retry until acknowledge, then give up.

Two displays can be connected to the I2C of Type SSD1306 with the I2C addresses 0x3C and 0x3D.
Formatted text is compatible with RocDisplay.
WIO supports only a subset, and some new lower case commands are introduced.
Code page is ISO 8859 Latin for font {F0}; {F1} is 7 bit ASCII only.

The Bus is used for the WIO ID, and the Display number for selecting between 1 and 2. (0x3C or 0x3D)
The Address value is not used.

Formatting commands are enclose in curly brackets. Example:

{g1}{E}{L0}{X0}Hello World!{P}

Note: If the geometry is not default, 128x32, the text MUST start with a {gn} command for selecting the right geometry.

Only supported on ESP8266 boards.

• Loco speed and direction. (No support for 14 speed steps.)
• Loco functions 0-28.
• POM set/get. (A RailCom detector is needed for POM get.)
• Accessories.
• BinState
• Loco addresses >= 100 are regarded as long address.
• Short address 111 is used as dummy to trigger other decoders to broadcast there address.

• 100% NMRA timing conform.
• Automatically Power OFF after a Rocrail Server connection loss.
• Shows activity on a display if a one is connected.
• 48 slot refresh stack with auto purging.
• 12 accessory command queue.

To use the 3.3V level a 470 Ohm resistor must be add parallel to R1.

Use the WIO as mobile decoder.
The locomotive Bus value must be set to the WIO ID.
The number of Decoder Steps must be set in the range 50 to 100.

Acceleration/deceleration can be simulated with the locomotive interface parameter Mass. (10ms resolution.)
A mass value of 5 will increase/decrease the PWM 1 step at every 5*10ms.
Vstart and Vhigh, CV2/CV5, can be simulated with the Step range

An Electronic Speed Controller, ESC, on pin D5 can also be used for motor control if this option is set.
Note: Only connect ground and PWM in case the ESC supports BEC.

Optional a RFID reader from type ID-12LA can be connected to the RX pin for detecting tags which will be reported to Rocrail.
The tag is used as Sensor ID, decimal dot formatted.
The GCA RFID board can be used to mount and connect the ID-12LA.
The serial monitor will be set to 9600bps.
Note: This is to scan tags between the rails to let Rocrail know where the running vehicle is.

The serial connector on the WIO PCB can be used to connect it to an amplifier for reading RailCom data.
At the moment there is no such board in the GCA line. For testing the GCA204 can be used as amplifier.
The following RailCom IDs are supported:

The only way to activate RailCom reading in WIO is to set this option in the WIO Dialog. (WIO 0.105, Rocrail 2.1.212)
The serial bps will switch to 250000, and the monitor will be read only. So with this option active its not possible to setup the WIO by monitor commands.

One BMx280 sensor, connected to I2C, is supported for temperature, pressure and humidity.
The USER_ALTITUDE in the USERCNF.h must be adjusted to meet the local altitude for correct pressure values.

Temperature, pressure and humidity can be used as text and XMLScript variables.
See: Dynamic Text

Sound can be played on ESP32 boards using one of the DAC pins. (GPIO25 or GPIO26)
Supported RIFF Wave format:

• PCM type
• Sample rate 11.025 Hz
• 16 sample bits
• One channel (Mono)

• Type: Sound
• Command: Play
• Parameter: Sound file incl. path like: "/F9.wav"
• Interface Bus: WIO ID

Example:

<ac id="F9" cmd="play" param="/F9.wav" type="sound" iid="WIO" bus="38" addr="0" port="0"/>

The DAC is only capable to use 8 bits. The 16 bit data must be interpreted, which is not possible without data loss.
To get the best result:

• Normalise the sounds files so the data uses the full 16 bit.

The WIO can also be used as mobile RFID reader and I/O.
The WIO ID must be set in the loco Secondary Address field.

Loco [ICE-CAM] reports RFID event 56:101 [4.102.181.114.9.64.128] ON

The reported RFID must mach with a Sensor-ID in Rocrail.
This sensor should have its address set to zero.
The ID must be set in this notation: RFID Notation
The Rocrail traces can be used to copy this ID or the Sensor Monitor.

To dispatch functions to a WIO the function must be setup with Function address and FX.

The firmware for IO-Type RIC does not function without pull-up resistors on the button inputs, including the rotary switch.

• https://gitlab.com/rocrail/Arduino/tree/master/WIO/hardware

The published hardware are prototypes, are incomplete and not ready for release.
Only original GCA Kits are supported.

• https://wiki.rocrail.net/doku.php?id=gca:gca-index-en