search

dagnall53 / RocClientThrottle

A WiFi Rocrail Client throttle
4 stars 5 forks source link

readme

RocClientThrottle

A WiFi Rocrail Client throttle

A Simple throttle for Rocrail.

Uses the new Rocrail 'lcprops' command to get the Loco list. This method sends each command as a separate MQTT message. Now optimised to use a rotary switch and pushbutton.

Compiling

Compatible with ESP32 and ESP8266 hardware. Tested with Arduino Board = "NodeMCU 1.0 (ESP12E Module)" and Board= '"Wemos" Wifi+Bluetooth' options. Uses these Arduino Libraries, which must be installed for the program to compile:

//https://github.com/brianlow/Rotary // https://github.com/JChristensen/JC_Button // https://github.com/ThingPulse/esp8266-oled-ssd1306 //https://github.com/knolleary/pubsubclient Because Rocrail sends unusually long MQTT messages, it is important to increase the size of message that PubSubClient can accept. To do this you need to moodify your PubSubClient.h at or around line 17 or so..to add #define MQTT_MAX_PACKET_SIZE 10000 ## USE When the unit is turned on, it waits 3 seconds to allow you to modify its WiFi router settings etc. After this short delay it will connect to the wifi, find the Rocrail MQTt broker, and ask Rocrail for a list of Locos. It will then display a screen that allows you to select which loco to control. This list only shows locos that are Active and Not hidden in the Rocrail Loco table. Whilst on the "Select Loco" menu, you can LONGPress the select button to change the Rocrail Power State. LongPress for more than 1 second will turn Power OFF. Pressing and holding for longer than two seconds will turn power back ON. An indicator in the top left of the screen shows the current RocRail power status. A quick, short press of the select button moves from Select Loco to Speed Control. A Longpress here will instantly take the selected loco to Speed=0. Moving the rotary switch or selecting up or down buttons will change speed and send this command to RocRail. A quick, short press of the select button moves from Speed Control to Functions. Up and down (or rotate the rotary switch) select which function to operate. A LongPress will then send the function command to Rocrail. If the Function is a momentary function, the Throttle will send a "start", and rocrail will later turn the function off at the time set in the loco function table. If the Function is a toggle, like for example "lights", the throttle will toggle between the two states with every "Longpress". If you have set names for the functions, the throttle will display these names. A quick, short press of the select button then moves from Functions back to Select Loco. ## Hardware The code is designed by default to use the NodeMCU / Wemos OLED + 18650 battery +4 way switch board. With this board, Press "right" (Away from the OLED) to scroll through the menu levels, Pressing the button "in" is used for the short and long presses. Pressing "Left" at any time on this hardware will reboot the code. Do not blame me, the switch is hardwired to reset!. The code also works nicely with the WiFi Bluetooth Battery Esp32 0.96 Inch OLED board, but you will have to add connections to an external rotary switch. (All connections needed for the OLED, Rotary Switch and 4 way or 5 way switches are listed in the Secrets.h file). The Battery monitor needs a resistor voltage divider from battery +v to be added to the boards: For the ESP32 boards, use 220k/68k and use Pin 35 as the analog input. For ESP 8266, use 220k/47k and use A0. A calibration adjustment sequence has been added to the Serial input used for modifying the WiFi parameters that allows the calibration factors to me adjusted to try and get good accuracy. - But the ESP ADC are not particularly accurate, and I have seen changes depending on if the device is transmitting, so do not rely on the ADC for anything critical. ## Select Loco Up and Down buttons (or the Rotary switch) can be used to select which loco to control. Short press of the select switch then changes to speed control. (very) Long press of the select switch toggles the Rocrail power on/off. A small display at the bottom of the screen shows how many locos are available. ## Speed Control The Throttle should pick up any speed changes made by Rocrail. If you change the speed, Rocrail will change the Loco Speed. Short press of the select switch then changes to Functions control. If you LongPress the select button, the speed will immediately be dropped to 0. The Rotary switch uses knowledge of the V_Max set in the rocrail loco table to modify how the speed changes. This should give about one and a half turns from 0 to full speed. Up and down buttons add or subtract 5 to the speed. ## Functions When change to the function view, the throttle requests Function settings from Rocrail and uses these to display the Function names, and to decide if the Function is momentary or toggled. Function states should be mirrored if any changes are made by other throttles, but may not be immediately in synch until some changes have been made. Long press of the select switch then toggles each function. Short press of the select switch then changes to Loco select. ## Setting WiFi name, password, etc. (V35) you can set your Router name etc in the secrets.h file, or.. When first turned on, the throttle waits 3 seconds to allow you to enter "xxx" via a serial port. This makes the throttle enter a mode where you can change the saved WIFI name and password, and other settings. If you have connected the Throttle to a terminal emulator set to speed 115200 baud, you should see text like this as the throttle turns on: " This is Rocrail Client Throttle " Named "ESP8266Throttle" "--- To enter new wifi SSID / Password type 'xxx' BEFORE wifi connects--- "-- Use 'Newline' OR 'CR' to end input line -- If you then press "xxx" (+enter with lf or cr) on a connected terminal, (OR (v26 on) press the Select key..) the Throttle will prompt sequentially for a new Router name, password, MQTT broker address and nickname for the throttle. Pressing (return) will keep the current settings, but typing anything will change the settings. The last menu otion is to press "sss" or "rrr". sss(+cr or lf) will save the new entries to the EEPROM, and the throttle will start. "rrr" will go to the start of the entry process to allow you to reenter any changes. There is a very easy way to get this to work, by using PuTTY. |If you have PuTTY, set up a session like this: Session: Serial Line (the serial port you use) Speed(115200) Connection type "serial". (+ save it!) Then Terminal: Set the "Answerback to ^E " to "xxx^M" (without inverted commas!!), Local Echo "on", Local Line editing "on". Implicit CR with LF "ON" , Implicit LF with CR "ON" ....Then go Back to Session and "SAVE" the session with a name you chose. (Very important as otherwise the terminal answerback stuff will not be saved!) From V 31 there is an additional option {'ccc'} instead of {'sss'} at the final stage of this sequence will allow entry of the actual battery voltage (using three digits and NO Decimal) this is then used to improve the internal ADC calibration. The final cal factor is saved in EEPROM, so this should only need to be done once. Now, turn on the throttle, and connect to PC. -- do not worry that it starts up fully and logs in etc. Open PuTTY, select the session we saved before, and press "Open". For some reason, this seems to initiate a reset on the board and then PuTTY sends the magic xxx(cr) which immmediately gets us into the "SSID select" etc, with NO waiting! - But I have found that sometimes the inuts from PuTTY do not seem to be recieved by the booards, so watch the results on screen. The Arduino Serial Terminal seems more reliable for me. Note: For some reason this setup method does not work the very first time after the board has been flashed, so you need to power down and restart after a programming via Arduino, otherwise it works well. ## Rocrail Version Needs version after: 13870 2018-04-17 07:47:28 +0200 model: extended the lcprops command to itterate all ## Notes To get xbm images working with the //https://github.com/ThingPulse/esp8266-oled-ssd1306 it is essential to download and use GIMP https://www.gimp.org/downloads/ Load your image, then export as XBM. None of the simpler LCD image tools correctly format for the XBM format and all I tested had the bit order wrong for the code. Thanks to Jan Vanderborden for directing me in the direction of a solution! ## FINALLY - Modify PUBSUBClient.h ! As noted at the start.. Its very important to increase the size that the MQTT interface can use: // put this in pubsubclient.h in your arduino/libraries/PubSubClint/src #define MQTT_MAX_PACKET_SIZE 10000 // lclist is LONG...! I am not connected to Rocrail, I just like it and use it. Rocrail is Copyright © 2002-2018 Robert Jan Versluis, Rocrail.net. All rights reserved.