User Tools

Site Tools


arduino:wio-en

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
arduino:wio-en [2019/11/10 14:01]
rjversluis [Attention]
arduino:wio-en [2020/11/25 08:00] (current)
rjversluis [macOS "Big Sur"]
Line 1: Line 1:
-====== ​W I O - Throttle - 32 I/O - LEDs - Servos - RFID - OLED - DCC ======+[[:​arduino:​wio-fr|{{ icons:​fr.png|French Version}}]][[:​arduino:​wio-de|{{ icons:​de.png|Deutsche Version}}]][[:​arduino:​wio-en|{{ icons:​uk.png|English Version}}]] 
 +====== ​WIO Firmware ​======
 [[:​english|{{ :​hardware.png}}]][[:​english|{{ :​rocrail-logo-35.png}}]] [[:​english|{{ :​hardware.png}}]][[:​english|{{ :​rocrail-logo-35.png}}]]
 [[:​english|Content]] -> [[:​hardware-en#​arduino|Arduino]] [[:​english|Content]] -> [[:​hardware-en#​arduino|Arduino]]
-  ​* **[[:​arduino:​wio-en|WIO ​Firmware]]** | [[:​arduino:​wio-setup-en|WIO Setup]] +  * [[:​arduino:​wio-overview-en|WIO ​Overview]] | [[:​arduino:​wio-setup-en|WIO Setup]] ​| [[:arduino:wioctrl-en|WIO Control]] | [[:​arduino:​amp-en|User Bitmaps]] | **[[:​arduino:​wio-en|WIO Firmware]]** | [[:​arduino:​wio-cam-en|WIO CAM]] | [[:​wio:​wio-ledscript-en|LEDScript]] 
- \\ +  ​* [[:​arduino:​wio-rascii-en|WIO RASCII]] | [[:​arduino:​wio-canprot-en|WIO CAN Protocol]]
-{{ :arduino:rici-proto.png?​0x300}}{{ ​:​arduino:​wio-01-pcb.jpg?​0x300}} +
- W o r k I n P r o g r e s s  ^+
  
  \\  \\
 =====Introduction===== =====Introduction=====
-This solution is based on the LOLIN D1 Mini. (ESP8266)\\+This solution is based on the ESP8266/ESP32 family.\\ 
 It can be used as: It can be used as:
   * Wireless Throttle   * Wireless Throttle
-or as wireless I/O with one of the following four options+or as wireless I/O with: 
-  * 32 I/O  +  * 32 I2C I/O [[:​hardware-en#​extension_units|GCA compatible]] ​ 
-  * 2 Displays +  * 2 Displays ​SSD1306 
-    - LED control WS2812 +and one of the following extra functions:​ 
-    - 4 Servos +  ​- LED control WS2812 
-    - 2 RC522 readers +  - 4 Servos 
-    - DCC Generator+  - 2 RC522 readers 
 +  - DCC Generator 
 +  - Mobile PWM, direction and lights 
 +and one of the following options: 
 +  * ID12LA 125kHz RFID reader on RX 
 +  * RailCom reader on RX 
 + 
 +====Supported Boards==== 
 +  * Lolin D1 Mini 
 +  * Lolin D32 
 +  * ESP32 Dev Module 
 +  * ESP32 CAM Module 
 + 
 +====Used ESP Pins==== 
 +Check the pin mapping in Pins.cpp: 
 +  * https://​gitlab.com/​rocrail/​wio/​-/​blob/​master/​Pins.cpp
  
 ====Flyer==== ====Flyer====
-  * https://​gitlab.com/​rocrail/​Arduino/​blob/​master/WIO/docu/WIO.pdf+  * https://​gitlab.com/​rocrail/​wio/​blob/​master/​docu/​WIO.odp
  
  \\  \\
 =====Attention===== =====Attention=====
-  ​- The Rocrail server must run on a PC which dus __not__ automatically suspend or sleep in case of no user activity. Check the energy setting to prevent communication loss. +{{ :​arduino:​wifi-analyse.jpg?​300|Exhibition used WiFi channels...}} 
-  - The used WiFi Router/​Accesspoint ​should be state of the art; Only use maintained hardware.+  ​- 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. 
 +  - __The used WiFi Router should be state of the art; Only use maintained hardware.__
   - Make sure the SSID is not visible to prevent extra public traffic.   - Make sure the SSID is not visible to prevent extra public traffic.
  
Line 34: Line 50:
  
  \\  \\
-=====Arduino IDE===== +=====Arduino IDE 1.8.12===== 
-//Tested with version ​1.8.10//\\+:!: 1.8.11 does not work! Event the BasicOTA example will not compile...\\ 
 +  * https://​www.arduino.cc/​en/​Main/​OldSoftwareReleases#​previous
 Prepare the Arduino IDE with the following boards and libraries: Prepare the Arduino IDE with the following boards and libraries:
 ====Board manager===== ====Board manager=====
 Add in the preference dialog to "​Additional board manager"​ the following URL: Add in the preference dialog to "​Additional board manager"​ the following URL:
 <​code>​ <​code>​
-https://​arduino.esp8266.com/​stable/​package_esp8266com_index.json+https://​arduino.esp8266.com/​stable/​package_esp8266com_index.json, https://​dl.espressif.com/​dl/​package_esp32_index.json
 </​code>​ </​code>​
 {{ :​arduino:​board-manager-en.png?​300}} {{ :​arduino:​board-manager-en.png?​300}}
Line 47: Line 64:
 {{ :​arduino:​lolin-ide-board.png?​240}} {{ :​arduino:​lolin-ide-board.png?​240}}
 ''​LOLIN(WEMOS)D1 R2 & mini''​\\ ''​LOLIN(WEMOS)D1 R2 & mini''​\\
 +
 ====Libraries==== ====Libraries====
-  ​ESP8266WiFi ​(Board Manager)+===ESP8266 & ESP32=== 
 +  ​ESP8266 ​(Board Manager) ​\\ :!: Stick with version **2.5.2** because there are unsolved issues with version 2.6.x.
   * Wire (I2C)   * Wire (I2C)
   * FastLED (WS2812)   * FastLED (WS2812)
Line 54: Line 73:
   * MFRC522 (RC522)   * MFRC522 (RC522)
   * Servo   * Servo
 +  * ArduinoOTA
 +  * MCP_CAN ​
 +    * https://​github.com/​coryjfowler/​MCP_CAN_lib
 +    * [[:​arduino:​rcan-en#​modifications|MCP_CAN modifications]]
 +  * NTPClient
 +===ESP32===
 +  * ESP32 (Board Manager)
 +  * 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)
 +<code 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,​ 500);
 + return rc;
 +}
 +</​code>​
 +
 +| Just decreas "​Upload Speed" to 460800 in case the sketch upload does show communication errors. |
 + \\
 +
 +====SPIFFS====
 +Select 2M SPIFFS size:\\
 +{{:​arduino:​arduino-esp8266-spiffs-2m.png?​400}}\\
 +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
  
 ====Dark Theme==== ====Dark Theme====
Line 61: Line 118:
  \\  \\
 =====WIO Sketch===== =====WIO Sketch=====
-| //Copyright (c) 2002-2019 Robert Jan Versluis, Rocrail.net//​ |+| //Copyright (c) 2002-2020 Robert Jan Versluis, Rocrail.net//​ |
 WIO is firmware for controlling Throttle, I2C, LEDs, Servos, RFID, Displays and DCC.\\ WIO is firmware for controlling Throttle, I2C, LEDs, Servos, RFID, Displays and DCC.\\
-  * https://​gitlab.com/​rocrail/​Arduino/​tree/​master/​WIO +  * https://​gitlab.com/​rocrail/​wio 
-  * [[https://​gitlab.com/​rocrail/​Arduino/​-/​archive/​master/​Arduino-master.zip?path=WIO|Download as Zip]] +  * [[https://​gitlab.com/​rocrail/​wio/​-/​archive/​master/​wio-master.zip|Download as Zip]] 
-  * [[https://​gitlab.com/​rocrail/​Arduino/​-/​network/​master|Change Log]]+  * [[https://​gitlab.com/​rocrail/​wio/​-/​network/​master|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.\\ 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.\\
 +
 +:!: **Note:** After unpacking the ZIP the folder should be renamed before loading it into the Arduino IDE from "​wio-master"​ into "​WIO"​.\\
 ====Binary==== ====Binary====
 {{ :​arduino:​esp-downloadtool.jpg?​400}} {{ :​arduino:​esp-downloadtool.jpg?​400}}
 Use the Espressif tool to upload the WIO Binary. Use the Espressif tool to upload the WIO Binary.
-  * [[https://launchpad.net/rocrail/+download|WIO Binary]]+  * [[https://gitlab.com/rocrail/wio/​-/​blob/​master/​WIO.ino.d1_mini.bin|WIO Binary]]
   * [[https://​www.espressif.com/​en/​support/​download/​other-tools|ESP Flash Download Tool]]   * [[https://​www.espressif.com/​en/​support/​download/​other-tools|ESP Flash Download Tool]]
 +    * :!: Do not uncheck "​DoNotChgBin"​
  
 ====Compile output==== ====Compile output====
Line 87: Line 147:
  
  
-Setting up the WiFi can be done with the Arduino Serial Monitor ​9600bps, or by modifying the [[#​user_configuration|USERCNF.h]]:​+Setting up the WiFi can be done with the Arduino Serial Monitor ​115200 bps, or by modifying the [[#​user_configuration|USERCNF.h]]:​
 <​code>​ <​code>​
 #​1CConnecting to [secure.home] #​1CConnecting to [secure.home]
Line 98: Line 158:
 Output after a ? command:\\ Output after a ? command:\\
 <​code>​ <​code>​
 +------------------------------
 +revision=261 WIO 20200812a (c)Rocrail
 +------------------------------
 Settings: Settings:
 ------------------------------ ------------------------------
-version=0.85 WIO 20191031d (c)Rocrail +ssid1
-ssid=xxxxxxxx +pwd1
-pwd=xxxxxxxx +ssid2= 
-server=xxxxxxxx+pwd2
 +server=
 port=8051 port=8051
-name= +name=[wio104] 
-id=33 +id=104 
-io=i2cdcc +io=i2cdcc ​(master) 
-i2c=ooooooooooooooooppppiiiibbbbbbbb +iostate=00 00 00 00 
-steps=50 +i2c=oooooooobbbbbbbboooooooobbbbbbbb 
-pulse=50 +steps=64 
-display=22 +sleeptimer=5 
-dccsc=0 +pulse=5 
-RSSI=-53 +pwmsize=0 
-MCP23017 status: 0x20=OK 0x21=OK +options=0x00 0x01 0x18 
-I2C device found at address 0x20 +booster=
-I2C device found at address 0x21 +board=1 
-I2C device found at address 0x3C +display=0 
-I2C found 3 devices +railcom=0 
-loco1=0 loco2=3 active=0+id12=0 
 +depart=0 
 +stepper=0 3w=
 +canprot=1(1) 
 +canio=1 
 +canusb=0 
 +trace=0 
 +SPIFFS total=1345kb used=0kb
  
 Change settings by typing: Change settings by typing:
Line 129: Line 200:
 *name=<​Node name> *name=<​Node name>
 *id=<​Node number> *id=<​Node number>
-*io=<​type> ​<​throttle>​ or <​i2cled>​ or <​i2cservo>​ or <​i2crfid>​ or <​i2cdcc>​+*io=<​throttle>​ or <​i2cled>​ or <​i2cservo>​ or <​i2crfid>​ or <​i2cdcc> ​or <​i2cmobile>​ or <​i2ccam>​ or <​i2cbus>​ (reboot)
 *i2c=<​oooooooobbbbbbbboooooooobbbbbbbb>​ o=output, i=input, b=block, p=pulse *i2c=<​oooooooobbbbbbbboooooooobbbbbbbb>​ o=output, i=input, b=block, p=pulse
 *steps=<​number of rotary steps> *steps=<​number of rotary steps>
 *pulse=<​output pulse length in 100ms units> *pulse=<​output pulse length in 100ms units>
-*display=<geometry1><geometry2> 0=96x16 1=128x32 2=128x64 +*pwm=<mobile PWM size multiplier> 
-*dccsc=<short circuit detection> 0=off 1=on+*boost=<booster option for i2cdcc type> 0=off 1=on (reboot) 
 +*dccslave=<​dccmode>​ 0=master 1=slave 
 +*board=<​board type> 0=D1 1=D32 2=DevMod 3=User (reboot) 
 +*display=<​display type> 0=96x16 1=128x32 2=128x64 ​3=132x64 
 +*trace=<level> 0=info 1=debug 9=none 
 +*canprot=<​protocol>​ 0=MBUS 1=RCAN 
 +*canio=<​I/​O over CAN> 0=no 1=yes 
 </​code>​ </​code>​
  
  
 ====User Configuration==== ====User Configuration====
-The [[https://​gitlab.com/​rocrail/​Arduino/​blob/​master/LOLii/​USERCNF.h|USERCNF.h]] file can be used for initial, first boot, WiFi and Rocrail server values.\\+The [[https://​gitlab.com/​rocrail/​wio/-/​blob/​master/​USERCNF.h|USERCNF.h]] file can be used for initial, first boot, WiFi and Rocrail server values.\\
 The values must be set before compile and upload.\\ The values must be set before compile and upload.\\
 Afterwards those values can be changed with monitor commands.\\ 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"​.
 ====Monitor commands==== ====Monitor commands====
-^ Command ^ Description ^ Default ^+The Arduino Serial Monitor can be use with 115200 bps to change WIO settings.\\ 
 +  - If RailCom has been activated the baudrate switches automatically to 250000 and the Serial Monitor is read only. 
 +  - If ID12 has been activated the baudrate switches automatically to 9600 and the Serial Monitor is read only. 
 + 
 +^ Command ^ Description ^ Default ​^ Remark ​^
 | ?  | Shows the current settings and how to change them. | | ?  | Shows the current settings and how to change them. |
 | !  | Dumps the used Flash memory. | | !  | Dumps the used Flash memory. |
-| *ssid=<​value>​ | Set the WiFi access point SSID. | - | +| *ssid=<​value>​ | Set the WiFi access point SSID. | - | Primary SSID 
-| *pwd=<​value>​ | Set the WiFi password. A WiFi reconnect is triggered. | - | +| *pwd=<​value>​ | Set the WiFi password. A WiFi reconnect is triggered. | - | Primary WiFi password | 
-| *server=<​value>​ | Set the Rocrail Sever IP or Name. | - |+| *ssid2=<​value>​ | Set the WiFi access point SSID. | - | Alternative SSID | 
 +| *pwd2=<​value>​ | Set the WiFi password. A WiFi reconnect is triggered. | - | Alternative WiFi password ​
 +| *server=<​value>​ | Set the Rocrail Sever IP or Name. | - | May be a CSV of max 32 characters.(1.71+) \\ Example: "​mba2019,​win2019" ​|
 | *port=<​value>​ | Set the Rocrail Sever port. | 8051 | | *port=<​value>​ | Set the Rocrail Sever port. | 8051 |
 | *name=<​value>​ | Optional node name. | - | | *name=<​value>​ | Optional node name. | - |
 | *id=<​value>​ | Node number/​throttle ID; Should be unique. | 33 | | *id=<​value>​ | Node number/​throttle ID; Should be unique. | 33 |
-| *io=<​value>​ | I/O configuration.  | throttle ​|+| *io=<​value>​ | WIO type.  | i2cled ​|
 | *i2c=<​value>​ | I2C port configuration. ​ | oooooooobbbbbbbboooooooobbbbbbbb | | *i2c=<​value>​ | I2C port configuration. ​ | oooooooobbbbbbbboooooooobbbbbbbb |
 | *steps=<​value>​ | Number of rotary steps. | 127 | | *steps=<​value>​ | Number of rotary steps. | 127 |
 | *pulse=<​value>​ | Output pulse length in 100ms units. | 5 | | *pulse=<​value>​ | Output pulse length in 100ms units. | 5 |
-| *display=<​value>​ | Default ​display ​geometry: 0=96x16 1=128x32 2=128x64 | 00 |+| *canprot=<​value>​ | CAN protocol | MBUS | 0=MBUS, 1=RCAN | 
 +| *dccslave=<​value>​ | DCC role | Master | 0=Master, 1=Slave(Booster) | 
 +| *trace=<​value>​ | Trace level | 9 (volatile) | 0=Info, 1=Debug, 9=None \\ Only for current session. | 
 +| *ptmain=<​value>​ | Service mode, PT, on the main H-Bridge | 0 (volatile) | 0=off, 1=on \\ Only for testing! | 
 +| *pwm=<​value>​ | PWM size for mobile motor control | - | 600=10Hz | 
 +| *display=<​value>​ | Display type: 0=96x161=128x322=128x64, 3=SH1106 ​- | 1 |
 **Note:​** ​ Replace <​value>​ to meet the local WiFi environment and setup.\\ **Note:​** ​ Replace <​value>​ to meet the local WiFi environment and setup.\\
 +**Note:​** ​ A reset is necessary after changing the WIO Type.\\
  
 |< >| |< >|
Line 177: Line 270:
  
  \\  \\
 +
 +
 +====Basic Setup with WEB Browser====
 +|  //Not activated in case of DCC 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:\\
 +{{:​arduino:​win10-aps.png?​0x280}} {{:​arduino:​wio-ap.png?​0x280}}\\
 +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:
 +<​code>​
 +http://​192.168.4.1
 +</​code>​
 +After **Submit** the WIO will retry automatically the WiFi and Rocrail Server connection.\\
 +The AP will be stopped after:
 +  * a submit.
 +  * 2 minutes idle.
 + \\
 +====OTA Updating====
 +|  //Must be activated by WIO Dialog.// ​ |
 +If it's not possible, or cumbersome, to update by USB, the WIO can also be updated "Over The Air" (OTA).\\
 +{{:​arduino:​wio-ota-en.png?​400}}\\
 +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 [[#​basic_setup_with_web_browser|Access Point]] (Default "​12345678"​).\\
 +{{:​arduino:​wio-ota-display.png}}{{:​arduino:​ota-upload-en.png?​600}}\\
 +
 +
 + \\
 +
 =====RIC - Throttle===== =====RIC - Throttle=====
 +| Note: RIC is no longer supported in the firmware, and is replaced by [[:​arduino:​wioctrl-en|WIO Control]]. |
 **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.//​\\ **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 pocket throttle I/O mode needs a rotary switch, one LED and four buttons.\\
Line 243: Line 366:
     * Block     * Block
     * Pulse     * Pulse
-  * 128 LEDs compatible with WS2812 on D8. (Color type output in Rocrail.)+  * 100 LEDs compatible with WS2812 on D8. (Color type output in Rocrail.)
     * RGB color     * RGB color
     * Brightness     * Brightness
Line 255: Line 378:
   * Up to 255 units in the same WiFi network. (Depending on the IP configuration and availability.)   * 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.   * An alarm will be generated if 'a live' messages are no longer come in.
-  * Output/​Switch commands are acknowledged after they have been processed.+  * 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.)   * Input events must be acknowledged within 100ms. After this timeout a resend will occur. (Max. 5 retries.)
  
Line 263: Line 386:
 ^ Rocrail ^ WIO ^ ^ Rocrail ^ WIO ^
 | Interface ID | "​WIO"​ | | Interface ID | "​WIO"​ |
-| Bus | ID | +Node ID (Bus| ID | 
-| Address | I2C or I/O Port |+| Address | I2C Port |
 | Address | LED Port | | Address | LED Port |
 | Address | Servo Port | | Address | Servo Port |
Line 273: Line 396:
   * Sensors   * Sensors
  
 +===Dual Coil Switches===
 +| //​__Disable__ the '​Accessory'​ and '​Single gate' options, and __select__ output type.// |
 +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 must be of type '​p'​ Pulse.\\
 +Possible hardware:
 +  * **[[:​mgv76-en|GCA76]]**
 +  * [[:​gca77-en|GCA77]]
 +  * [[:​gca107-en|GCA107]]
 +
 +====Blink====
 +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.\\
  \\  \\
 ====LEDs==== ====LEDs====
 +{{ :​arduino:​ws2812.jpg?​200}}{{ :​arduino:​ws2811-chip.jpg?​200}}
 The addressing is the same as normal outputs.\\ The addressing is the same as normal outputs.\\
  
Line 296: Line 433:
  \\  \\
 ====Servos==== ====Servos====
 +{{ :​arduino:​servo.jpg?​200}}{{ :​arduino:​servo-pwm.png?​200}}
 The addressing is the same as normal outputs.\\ The addressing is the same as normal outputs.\\
 ^ Control ^ Output ^ Switch ^ Range ^ ^ Control ^ Output ^ Switch ^ Range ^
 | WIO | IID="​WIO"​ | IID="​WIO"​ | - | | WIO | IID="​WIO"​ | IID="​WIO"​ | - |
-| WIO ID | Bus | Bus | 1...255 |+| WIO ID | Node ID (BusNode ID (Bus| 1...255 |
 | Servo port | Address | Address | 1...4 | | Servo port | Address | Address | 1...4 |
-| Extra options | - | Single gate | - |+| Extra options | - | Single gate ON | - |
 | Position 1 | Parameter ON | Parameter | 0...180° | | Position 1 | Parameter ON | Parameter | 0...180° |
 | Position 2 | Parameter OFF | Value | 0...180° | | Position 2 | Parameter OFF | Value | 0...180° |
Line 345: Line 483:
  
  \\  \\
-====Display SSD1306====+====Display SSD1306/SH1106====
 {{:​arduino:​wio-oled-128x32.jpg?​0x160}}{{:​cbus:​display-goes.jpg?​0x160}}\\ {{:​arduino:​wio-oled-128x32.jpg?​0x160}}{{:​cbus:​display-goes.jpg?​0x160}}\\
 Two displays can be connected to the I2C of Type SSD1306 with the I2C addresses 0x3C and 0x3D.\\ Two displays can be connected to the I2C of Type SSD1306 with the I2C addresses 0x3C and 0x3D.\\
Line 361: Line 499:
 </​code>​ </​code>​
 ^ Command ^ Parameter ^ Description ^ Remark ^ ^ Command ^ Parameter ^ Description ^ Remark ^
-| {Bn} | n=0-19 Draw a bitmap on the current position. |+| {B#} | #=0-99999999 ​Read an AMP file, "#​.amp",​ from SPIFFS, and draw the bitmap on the current position. | 
 +| {B'//​name//'​} | AMP file //name// | Read an AMP file, "//​name//​.amp",​ from SPIFFS, and draw the bitmap on the current position. | The name must be between single quotes. |
 | {E} | - | Erase display buffer. An extra {P} is needed to erase the display. | | {E} | - | Erase display buffer. An extra {P} is needed to erase the display. |
-| {Fn} | n=0-2 | Select font. 0=7x5 1=6x5w 2=6x5n | Font 5x5 is not supported because its unreadable. | +| {F#} | #=0-2 | Select font. 0=7x5 1=6x5w 2=6x5n | Font 5x5 is not supported because its unreadable. | 
-| {Hn} | n=0-255 | Set the display contrast. | +| {H#} | #=0-255 | Set the display contrast. | 
-| {In} | n=0-1 | Invert the display. 0=normal 1=inverted | +| {I#} | #=0-1 | Invert the display. 0=normal 1=inverted | 
-| {Ln} | n=0-3 | Goto line. The range depends on the display size. |+| {L#} | #=0-3 | Goto line. The range depends on the display size. |
 | {P} | - | Copy buffer to the display. | | {P} | - | Copy buffer to the display. |
-| {Rn} | n=0,2 | Set display mapping rotation. 0=0° 2=180° |+| {R#} | #=0,2 | Set display mapping rotation. 0=0° 2=180° |
 | {?V} | - | Show firmware version. | | {?V} | - | Show firmware version. |
-| {Xn} | n=0-127 | Goto column. The range depends on the display size. | +| {X#} | #=0-127 | Goto column. The range depends on the display size. | 
-| {Yn} | n=0-32 | Goto row. The range depends on the display size. |+| {Y#} | #=0-32 | Goto row. The range depends on the display size. |
 ^ New command ^ Parameter ^ Description ^ ^ New command ^ Parameter ^ Description ^
-| {cn} | n=0-16 | Draw an analog clock with the given radius on the current position. | +| {c#} | #=0-16 | Draw an analog clock with the given radius on the current position. | 
-| {gn} | n=0,**1**,2 | Set display geometry. 0=96x16, 1=128x32, 2=128x64 (1 is default)| This is for testing only. To save CPU load set the [[#​monitor_commands|display]] option. |+| {g#} | #=0,**1**,2,3 | Set display geometry. 0=96x16, 1=128x32, 2=128x64, 3=SH1106 ​(1 is default)| This is for testing only. To save CPU load set the [[#​monitor_commands|display]] option. |
 | {i} | - | Toggle inverted text. | | {i} | - | Toggle inverted text. |
-| {sn} | n=1-x | Draw scrolling text on the current position, with a view width of n characters. | Example: {s12}Scrolling text to show...{s} |+| {s#} | #=1-x | Draw scrolling text on the current position, with a view width of n characters. | Example: {s12}Scrolling text to show...{s} |
 | {d} | - | Scroll one text line down. | | {d} | - | Scroll one text line down. |
 | {f} | - | 7-Segment fast clock. | | {f} | - | 7-Segment fast clock. |
 +| {p} | - | Swap displays. |
 **Note:** //If the geometry is not default, 128x32, the text MUST start with a {gn} command for selecting the right geometry.//​\\ **Note:** //If the geometry is not default, 128x32, the text MUST start with a {gn} command for selecting the right geometry.//​\\
  
-==Bitmaps== + \\ 
-The bitmaps are sized 20 x 8 pixel. +====7-Segment Display HT16K33 ​==== 
-^ Number ^ Description ^ Original ^ +{{ :arduino:adafruit-ht16k33.jpg?200}} 
-| 13 | Nederlandse Spoorwegen (NS) | {{:arduino:bitmaps:ns.jpg}} ​|+//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.\\
  \\  \\
  
Line 391: Line 534:
 === WIO supports following DCC packets === === WIO supports following DCC packets ===
   * Loco speed and direction. (No support for 14 speed steps.)   * Loco speed and direction. (No support for 14 speed steps.)
-  * Loco functions 0-28+  * Loco functions 0-32
-  * POM set/get. (A RailCom detector is needed for POM get.)+  * PoM set/get. (A RailCom detector, GCA214, ​is needed for PoM get.)
   * Accessories.   * Accessories.
   * BinState   * BinState
 +  * Programming Track; Service mode. (A second H-Bridge is required: WIO-Boost-PT)
 +  * Loco addresses >= 100 are regarded as long address.
 +  * Short address 111 is used as dummy to trigger other decoders to broadcast there address.
 ===Features=== ===Features===
   * 100% NMRA timing conform.   * 100% NMRA timing conform.
   * Automatically Power OFF after a Rocrail Server connection loss.   * Automatically Power OFF after a Rocrail Server connection loss.
-  * Shows activity on a display if one is connected. +  * Shows activity on a display if one connected. 
-  * 64 slot refresh stack with auto purging. +  * 48 slot refresh stack with auto purging. 
-  * 16 accessory command queue.+  * 12 accessory command queue.
 ===Pins DCC=== ===Pins DCC===
 ^ Pin ^ Usage ^ Remark ^ ^ Pin ^ Usage ^ Remark ^
 | D6 & D7 | DCC symmetric signal. | | | D6 & D7 | DCC symmetric signal. | |
-| D5 | Short circuit detection. ​Needs a 10k pull-up resistor. ​|+| D5 | Enable H-Bridge 1 Operation | 
 +| D8 | Enable H-Bridge 2 | Service ​|
 ===ORD3=== ===ORD3===
-To use the 3.3V level a 470 Ohm resistor must be add parallel to R1.\\+To use the 3.3V level a 470 Ohm resistor must be added parallel to R1.\\
 ===Mobile Addressing=== ===Mobile Addressing===
 ^ IID | WIO | Remark | ^ IID | WIO | Remark |
-^ Bus | WIO ID |+Node ID (Bus| WIO ID |
 ^ Address | DCC decoder address. | Addresses > 99 are regarded as long DCC address. | ^ Address | DCC decoder address. | Addresses > 99 are regarded as long DCC address. |
 ^ Speed steps | 28 or 128 |  | ^ Speed steps | 28 or 128 |  |
  
  
 + \\
 +====Mobile====
 +Use the WIO as mobile decoder.\\
 +The locomotive __**[[:​loc-int-en#​bus|Bus]]**__ value must be set to the WIO ID.\\
 +The number of __**[[:​loc-int-en#​decoder_steps|Decoder Steps]]**__ must be set in the range 50 to 100.\\
 +===Pins LOLIN D1===
 +{{  arduino:​lipo3s-measure-.png?​240}}
 +^ Pin ^ Usage ^ H-Bridge ^ Remark ^
 +| D0 | Lights front | | Cab1 |
 +| D3 | Lights rear | | Cab2 |
 +| D5 | Motor Enable | ENA | RC ESC servo PWM |
 +| D6 | PWM forwards direction | IN1 | |
 +| D7 | PWM reverse direction | IN2 | |
 +| D8 | Servo PWM for coupler | | F1 |
 +| I2C 1-32 | Functions 1 to 32 | | |
 +| A0 | Battery monitor LiPo 3S | | + 100kΩ A0 32kΩ - |
 +Acceleration/​deceleration can be simulated with the locomotive interface parameter __**[[:​loc-int-en#​mass|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 __**[[:​loc-int-en#​step_range|Step range]]**__\\
 +===Electronic Speed Controller===
 +An **E**lectronic **S**peed **C**ontroller,​ 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.**__\\
 + \\
 +====ID-12LA====
 +{{ :​arduino:​rfid-card-antenna.jpg?​200}}{{ http://​id-innovations.com/​httpdocs/​assets/​immage/​id12new.jpg}}
 +Optional a RFID reader from type [[http://​id-innovations.com|ID-12LA]] can be connected to the RX pin for detecting tags which will be reported to Rocrail.\\
 +The tag is used as **[[:​sensor-gen-en#​id|Sensor ID]]** or **[[:​sensor-int-en#​uid-name|UID-Name]]**,​ **[[:​can-gc4-en#​rfid_notation|decimal dot formatted]]**.\\
 +The **[[:​gca_rfid-en|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.\\
  
 + \\
 +====RailCom====
 +{{ :​arduino:​railcom_cutout.jpg?​400}}
 +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:
 +^ ID ^ Channel ^ Description ^
 +|  0  |  2  | POM read |
 +|  1  |  1  | Low decoder address |
 +|  2  |  1  | High decoder address |
 +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.__\\
  \\  \\
  
-=====Mobile=====+====Sensors==== 
 +{{ :​arduino:​bmp280.jpg?​140}}{{ :​arduino:​tsl2591.jpg?​140}} 
 +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.\\ 
 +===Dynamic Text=== 
 +Temperature,​ pressure and humidity can be used as text and XMLScript variables.\\ 
 +See: __**[[:​text-gen-en#​dynamic_text|Dynamic Text]]**__ \\ 
 + \\ 
 + 
 + 
 +====Sound==== 
 +Sound can be played on ESP32 boards using one of the DAC pins. (GPIO25 or GPIO26)\\ 
 +Supported [[ https://​de.wikipedia.org/​wiki/​RIFF_WAVE|RIFF Wave]] format: 
 +  * PCM type 
 +  * Sample rate 11.025 Hz 
 +  * 16 sample bits 
 +  * One channel (Mono) 
 +===Action=== 
 +  * Type: Sound 
 +  * Command: Play 
 +  * Parameter: Sound file incl. path like: "/​F9.wav"​ 
 +  * Interface Bus: WIO ID 
 +Example: 
 +<code xml> 
 +<ac id="​F9"​ cmd="​play"​ param="/​F9.wav"​ type="​sound"​ iid="​WIO"​ bus="​38"​ addr="​0"​ port="​0"/>​ 
 +</​code>​ 
 +===Recommendations=== 
 +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. 
 + 
 + 
 + \\ 
 +====StepMotor==== 
 +The WIO-02 supports two types of step motors: 4-wire and 3-wire step driver.\\ 
 +{{ :​arduino:​stepmotor-4wire.jpg?​0x200}}{{ :​arduino:​stepmotor-3wire.jpg?​0x200}} 
 +^ WIO-02 ^ 4-wire ^ 3-wire ^ Remark ^ 
 +| Servo 5 | IN1 | CLK+ | 
 +| Servo 6 | IN2 | DIR+ | 
 +| Servo 7 | IN3 | ENABLE+ | 
 +| Servo 8 | IN4 | - | 
 +| DA1     | -   | | Hall/Reed calibrate sensor |  
 +| EP1-1   | GND | CLK-,​DIR-,​ENABLE- | 
 +| -       | VCC | 12V-45V DC | External power supply | 
 +===Turntable Setup=== 
 +|  Turntable Interface ​ || 
 +^ Field ^ Value ^ Remark ^ 
 +| Node ID | WIO-02 ID | | 
 +| Address | 1 | Fixed | 
 +| Lights ​ | 1...32 | Optional bridge cabin lights. \\ Digital output port on the same WIO-02. | 
 +| Type | wio | 
 +| Decoder steps | Nr of steps for one 360° rotation. \\ In case of a 28BYJ-48: 4096 steps. | 
 +//The number of decoder steps for one turntable rotation is needed to calculate the shortest way.//\\ 
 + \\ 
 +|  Turntable Tracks (Example 4096 steps) ​ || 
 +^ Track ^ Decoder track ^ 
 +|  0  |  0  | 
 +|  12  |  1024  | 
 +|  24  |  2048  | 
 +|  36  |  3072  | 
 + 
 +XML example: (Only mandatory attributes are listed.) 
 +<code xml> 
 +  <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>​ 
 +</​code>​ 
 + 
 + 
 + \\ 
 + 
 +====CAN==== 
 +{{ :​arduino:​gc2a-wio-can.jpg?​400}} 
 +The WIO CAN type can be used as CAN-WiFi bridge for  
 +  * [[:​mbus:​cs3-en#​communication_type|MBUS,​ type TCP on port 5550]] 
 +  * RCAN, type TCP+binary on port 5550 
 +====MCP2515==== 
 +Pin mapping for using the SPI MCP2515(16MHz) on the __**[[:​can-gca2a-en|GC2a]]**__:​ 
 + 
 +^ Name ^ Nano ^ Lolin D1 Mini ^ Lolin D32 ^ Remark ^ 
 +| GND | GND | GND | GND | Ground | 
 +| 5V | 5V | 5V | 5V(USB) | | 
 +| CS | D10 | D3 | GPIO14 | Chip Select | 
 +| MOSI | D11 | D7 | GPIO23(MOSI) | Master Output, Slave Input | 
 +| MISO | D12 | D6 | GPIO19(MISO) | Master Input, Slave Output | 
 +| SCK | D13 | D5 | GPIO18(SCK) | Serial Clock | 
 + 
 +The Lolin D1 must be connected to 5V USB without power supply from the CAN bus.\\ 
 +A WIO-CAN kit will become available.\\ 
 + 
 + \\ 
 +====ESP32==== 
 +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.\\ 
 +|< >|< >|< >| 
 +^ Connection ^ ESP32 Pin ^ MCP2561 ^ 
 +| TXCAN  |  16 |  1 | 
 +| RXCAN  |   4 |  4 | 
 + 
 + \\ 
 +=====Mobile ​RFID reader=====
 The WIO can also be used as mobile RFID reader and I/O.\\ The WIO can also be used as mobile RFID reader and I/O.\\
 The WIO ID must be set in the loco **[[:​loc-int-en#​secondary_address|Secondary Address]]** field.\\ The WIO ID must be set in the loco **[[:​loc-int-en#​secondary_address|Secondary Address]]** field.\\
Line 447: Line 740:
   * https://​wiki.rocrail.net/​doku.php?​id=gca:​gca-index-en   * https://​wiki.rocrail.net/​doku.php?​id=gca:​gca-index-en
  
 +
 + \\
 +=====Trouble Shooting=====
 +====LOLIN vs Wemos====
 +|< >|
 +|  Top  ||  Bottom ​ ||
 +|  LOLIN D1 mini  |  Wemos mini  |  LOLIN D1 mini  |  Wemos mini  |
 +| {{:​arduino:​d1-top.jpg?​0x300}} || {{:​arduino:​d1-bottom.jpg?​0x300}} ||
 +
 +|< >|
 +^ Pin ^ Lolin ^ Wemos ^
 +|  D3  |  -  | Won't boot in case low. |
 +
 +
 + \\
 +====Very slow====
 +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.\\
 +===Solution===
 +Make sure all conneted I2C modules are powered up at the same time as the WIO.\\
 +
 + \\
 +====macOS "Big Sur"​====
 +===Upload tool ESP8266===
 +  * https://​forum.arduino.cc/​index.php?​topic=702144.0
 +
 +===Upload tool ESP32===
 +  * https://​github.com/​espressif/​esptool/​issues/​540
arduino/wio-en.1573390862.txt.gz · Last modified: 2019/11/10 14:01 by rjversluis