WIO Firmware

Content → WIO Overview

• WIO Overview | WIO Setup | WIO Control | User Bitmaps | WIO Firmware | LEDScript | IOScript
• WIO RASCII | WIO CAN Protocol
• I2C Device Addresses

This project is targeted to the ESP8266, ESP32 and RP2040¹⁾ platforms.
The source code is only available to be able to flash it on the target device if no other method is possible.
Forking or manipulating the source code is NOT allowed and is protected by copyright.

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

• Raspberry Pi Pico W → recommended
• Lolin D1 Mini
• Lolin D32
• ESP32 Dev Module
• ESP32 D1 Mini

Check the pin mapping in Pins.cpp:

• Pins.cpp

• WIO-2

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.

Prepare the Arduino IDE with the following boards and libraries:

Add in the preference dialog to "Additional Boards Manager" the following URL's:

https://arduino.esp8266.com/stable/package_esp8266com_index.json
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json

And install the ESP8266 and ESP32 Boards.

LOLIN(WEMOS)D1 R2 & mini

• ESP8266 (Board Manager)
• Adafruit NeoPixel (WS2812)
• RotaryEncoder
• MFRC522 (RC522)
• Servo
• ArduinoOTA
• mcp_can
  • https://github.com/coryjfowler/MCP_CAN_lib
  • MCP_CAN modifications
• SparkFun APDS9960 RGB and Gesture Sensor
  Line 198 in the Arduino/libraries/SparkFun_APDS9960.h must be changed from NA_STATE into NO_STATE because it conflicts with the WiFi RP2040 library. This Enum value ist not used in the Arduino/libraries/SparkFun_APDS9960.cpp. (implementation)

MFRC522 Bugfix
Replace in MFRC522Extended.cpp on line 824 and 847:

if (backData && (backLen > 0))

with

if (backData && (backLen != NULL))

To compile WIO

• Board esp32 → 2.0.17

• ESP32 (Board Manager) → WIO does NOT support ESP32 version 3.x; The API not compatible with 2.x. ²⁾
• ESP32Servo
• ESP32CAN
  • https://github.com/miwagner/ESP32-Arduino-CAN

ESP32CAN Modifications
The xSemaphoreTake should timeout after 500ms instead of wait for ever.
Replace portMAX_DELAY with 500, and return the rc of the xSemaphoreTake function instead of zero. (CAN.c)

int CAN_write_frame(const CAN_frame_t *p_frame) {
	if (sem_tx_complete == NULL) {
		return -1;
	}
 
	// Write the frame to the controller
	CAN_write_frame_phy(p_frame);
 
	// wait for the frame tx to complete
	int rc = xSemaphoreTake(sem_tx_complete, 250);
	return rc;
}

Select 1M FS size:

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

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

WIO is firmware for controlling all functions.
The source code is not public.

Use the Espressif tool to upload the WIO Binary.

• WIO Binaries
• ESP Flash Download Tool
  • Do not uncheck "DoNotChgBin"

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:

------------------------------
revision=458 WIO (c)Rocrail
192.168.100.175 RSSI=-52
battery=186
EEPROM size=3804
Free heap=174271
I/O state=00 00 00 00
------------------------------
SPIFFS total=1345kb used=0kb
file: Disco01.led size=110
------------------------------
Configuration:
------------------------------
ssid1=
pwd1=
ssid2=
pwd2=
server=
name=[local]
id=45
io=i2cled 
i2c=ooooooooiiiiiiii
steps=64
sleeptimer=5
pulse=5
pwmsize=0
options=0xC2 0x01 0x00 0x00
booster=0
board=1
display=3
railcom=0
id12=0
depart=0
stepper=0
canprot=0(0)
canio=0
canusb=0
trace=0
------------------------------

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 values in the USERCNF.h-file are only used, if there is no configuration yet (new device).
- If the values in the flash memory of an existing WIO-device should be replaced by those in the USERCNF.h, the option "Erase Flash" in the Arduino-IDE has to be set to "All Flash Contents".
- If just the firmware of an existing WIO-device should be updated, without changing the configuration (e.g. WLAN-settings), set the Arduino-IDE to "Erase flash → only Sketch".

The Arduino Serial Monitor can be use with 115200 bps to change WIO settings.

1. If RailCom has been activated the baudrate switches automatically to 250000 and the Serial Monitor is read only.
2. If ID12 has been activated the baudrate switches automatically to 9600 and the Serial Monitor is read only.

Basic connection setup can also be done on the Maintenance Tab of the WIO Setup Dialog.

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

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 (Default "12345678").

• Install WIO by OTA from scratch

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 224.0.1.20, the WIO 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, MCP23017, compatible with all GCA interfaces.
  • Input
  • Output
  • Block
  • Pulse
• 100 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.)

Up to 4 pieces of I/O extender type PCF8574 can be used as alternative to the 2 pieces of MCP23017.

1. 0x20 and 0x21 should not be available as I2C slave ID's. (No MCP23017's installed.)
2. The slave ID's of the PCF8574 must start with 0x22.

Note: Check for the correct type to match the 0x20 base address: PCF8574P or PCF857T. (The PCF8574A type starts with base address 0x38.)

This addressing schema is used for:

• Outputs
• Switches
• Signals
• Sensors

The next address for none single gate switches is used for the turnout command.
So if on port 1 is a dual coil switch, port 2 should not be used, and the second switch goes on port 3.
Both I2C outputs are automatically used as type 'p' Pulse.
Possible hardware:

• GCA76
• GCA77
• GCA107

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.

"NeoPixel"
The addressing is the same as normal outputs.

Dimming information:
WIO version 875+
The dimming frequentation depends of Controller Steps and Output/Signal delay.
The brightness is divided by the number of steps, and multiplied by the delay value which is subtracted/added every refresh cycle to the new brightness.
A low step and high delay value will cause fastest dimming.

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+)

1. WIO-ID: Bus
2. LED offset: Address
3. Port type: Output
4. Control type: Aspect number

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

Only available on WIOesp32 16 I/O, WIOpico 16 I/O, SIOpico
A Rocrail signal with control aspects and port type multiplex, uses 4 pins starting with the port offset.
The refresh rate is about 250µs.
Aspect values are used from the details tab. 24bits are used, the upper 12bits are for blinking.
Example: LED 1 and 2 on and LED 2 blinking: 0x002003 → Aspect value = 8195

A second signal on the mast can be defined in Rocrail with address + 100 to combine it with the main signal.

Brightness sets brightness, only values ​​between 200-255 can be used. A value < 200 is set to 200.
Fading with dimming is not possible.

For a correct display of the main signal at red and shunting, the distant signal must be blanked.
The brightness value in the main and distant signal must be identical.

Multiplex inputs from Vissmann, viewed from below on the connector.

The addressing is the same as normal outputs.

* Details tab, enter using the field with decimals in the Value button
² Attention, too high or too low values ​​can damage the servo start with PWM 1500 = 0°.
The value of the servo angle must be confirmed with enter in the decimal field.

Not possible with WIO Type I/O16, please use ID-12LA here.

1. Two 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.

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 or UID-Name, 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 1: This is to scan tags between the rails to let Rocrail know where the running vehicle is.
Note 2: Use selected Tags which respond rapidly.

Example.	{f8} on a SH1106 display.

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.

Up to 16 display can be used with Display multiplexing.

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.

Fast Clock
The Adafruit breakout board HT16K33 is supported on I2C address 0x70.
It displays alternate time, date and temperature.
With the NTP_CLOCK USERCNF.h setting the "pool.ntp.org" service will be used to get the time of day instead from the Rocrail server. It will not alternate between date and temperature.

• Loco speed and direction. (No support for 14 speed steps.)
• Loco functions 0-32.
• PoM set/get. (A RailCom detector, GCA214, is needed for PoM get.)
• Accessories.
• BinState
• Programming Track; Service mode. (A second H-Bridge is required: WIO-Prog2)
  1. Global power must be ON
  2. PT must be set to ON
  3. Read/Write CV
• 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 one connected.
• 48 slot refresh stack with auto purging.
• 12 accessory command queue.

To use the 3.3V level a 470 Ohm resistor must be added 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.

The serial connector on the WIO PCB can be used to connect it to an amplifier for reading RailCom data.
The GCA214 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 BME280/BMP280 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.
One TSL2591 'Light-to-Digital Converter' sensor, connected to I2C, is supported for calculating brightness.

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)
The USER_SOUND in the USERCNF.h must be set to true:

// Sound
#define USER_SOUND          true

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-02 supports two types of step motors: 4-wire and 3-wire step driver.

The number of decoder steps for one turntable rotation is needed to calculate the shortest way.

XML example: (Only mandatory attributes are listed.)

  <tt ori="west" id="tt1" x="11" y="4" z="0" pos="0" iid="RCAN-1" bus="102" addr="1" type="wio" decsteps="4096">
    <track nr="0" decnr="0"/>
    <track nr="12" decnr="1024"/>
    <track nr="24" decnr="2048"/>
    <track nr="36" decnr="3072"/>
  </tt>

Calibration is not possible!

The WIO CAN type can be used as CAN-WiFi bridge for

• MBUS, type TCP on port 5550
• RCAN, type TCP+binary on port 5550

Pin mapping for using the SPI MCP2515(16MHz) on the GC2a:

The Lolin D1 must be connected to 5V USB without power supply from the CAN bus.
A WIO-CAN kit will become available.

The current WIO firmware, 1.94, does use the internal CAN controller, and uses therefor only the MCP2551/2561. (SPI CAN is no longer supported for the MCP2515)
In case of ESP32 the CAN communication is always activated, independent of wich WIO type is selected.

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] reports RFID event 56:101 [4.102.181.114.9.64.128] ON

The reported RFID must mach with a Sensor-ID in Rocrail.
The sensor in Rocrail should have an address unique other than 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.

A KeyPad is supported on WIO Type IO16 on I/O connector 1. The # key will send the input to Rocrail es Text event. Rocrail will look up a Text object with this NodeID set on the interface tab.
With the * key the input can be corrected.
If a display is connected the input will be shown on line 3, but can be changed in the USERCNF.h. (Zero based line offset.)
Supportes KeyPads: 3x4 and 4x4. The 4x4 has "ABCD" on the extra key column.
It is recommended to set the ports 1…8 on the setup tab as follows:

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

If an I2C module, like the Pi02 or Pi03, is connected to the I2C bus of the WIO, and has no power, it will slowdown the processing and no other I2C devices are detected. (Multiple seconds between the loop calls.)
The P82B715 I2C-bus extender seems to drain the I2C clock and data lines, which will confuse the ISR in the Wire library.
The Pi08, with the PCA9622 chip, does not suffer this problem with its internal I2C-bus extender.

Make sure all conneted I2C modules are powered up at the same time as the WIO.

• https://forum.arduino.cc/index.php?topic=702144.0

• https://github.com/espressif/esptool/issues/540

export WIOBIN=~/Downloads/WIO.ino.d1_mini.bin

/Users/$USER/Library/Arduino15/packages/esp8266/tools/python3/3.7.2-post1/python3 \
/Users/$USER/Library/Arduino15/packages/esp8266/hardware/esp8266/3.0.1/tools/upload.py \
--chip esp8266 --port /dev/cu.usbserial-110 --baud 921600 --before default_reset --after hard_reset write_flash 0x0 $WIOBIN

~/Library/Arduino15/packages/esp32/tools/esptool_py/3.1.0/esptool \
--chip esp32 \
--port /dev/cu.usbserial-01B9FA0C \
--baud 921600 \
--before default_reset \
--after hard_reset write_flash \
-z \
--flash_mode dio \
--flash_freq 80m \
--flash_size 4MB \
0x10000 WIO.ino.d1_mini32.bin

set WIOBIN=\Users\%USERNAME%\Downloads\WIO.ino.d1_mini.bin

C:\Users\%USERNAME%\AppData\Local\Arduino15\packages\esp8266\tools\python3\3.7.2-post1/python3 -I C:\Users\%USERNAME%\AppData\Local\Arduino15\packages\esp8266\hardware\esp8266\3.0.2/tools/upload.py --chip esp8266 --port COM3 --baud 921600 --before default_reset --after hard_reset write_flash 0x0 %WIOBIN%

export WIOBIN=/home/$USER/Downloads/WIO.ino.d1_mini.bin

/home/$USER/.arduino15/packages/esp8266/tools/python3/3.7.2-post1/python3 -I /home/$USER/.arduino15/packages/esp8266/hardware/esp8266/3.0.2/tools/upload.py --chip esp8266 --port /dev/ttyUSB0 --baud 921600 --before default_reset --after hard_reset write_flash 0x0 $WIOBIN