Differences

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

--- users:dagnall53:node_setup [2018/11/12 08:56] – external edit 127.0.0.1
+++ users:dagnall53:node_setup [2019/03/17 19:24] – ["FIXED" Functionality] dagnall53
@@ Line 1: / Line 1: @@
- \\
-**ESP8266 Rocnet Nodes**
+**WiRocS Node Information**
-  * [[:users:Dagnall53:Description|ESPRocNetSoundDescription]]
+  * [[:users:Dagnall53:Description|Back to WiRocs Description]]
-  * [[https://github.com/dagnall53/ESPMQTTRocnetSound|ESP8266 Code]]
+  * [[https://github.com/dagnall53/WiRocS|Source Code]]
   * [[:users:Dagnall53:Node_Setup|Node_Setup]]
   * [[:users:Dagnall53:Troubleshooting|Troubleshooting]]
   * [[:users:Dagnall53:Hardware|Hardware]]
- \\
-** RocClient Experiments ** \\
-Rocrail Client experiments using the Wemos Oled Battery board.
-  * [[:users:Dagnall53:RocClientTool|RocClientTool]]
-  * [[:users:Dagnall53:RocClientThrottle|RocClientThrottle]]
-----
-====== ESPMQTTROCNETSound NODE SETUP ======
+====== WiRocs NODE SETUP ======
-===== Setting up the Node Software  =====
+===== Setting up the Node Software with RocView (Once Programmed) =====
-Full documentation with illustrations is in {{:users:dagnall53:setting_up_the_node_and_using_rocrail.pdf| Node Setup.pdf}}
+Full printable documentation for the original ESPMQTTWIFOROCNET code setup, with illustrations is in {{:users:dagnall53:setting_up_the_node_and_using_rocrail.pdf| Node Setup.pdf}} This should remain largely valid for the updated 'WiRocS' code.
 This includes full details on:
@@ Line 30: / Line 21: @@
   * Updating the code
   * Updating the sounds:
--
+Also see [[users:dagnall53:Port_Setup|Compile Directives]] to see how the compile directives can be used to select the functionality of each WiRocS node.
@@ Line 38: / Line 30: @@
 ====== Selecting Pins as Inputs or Outputs  ======
- The code use settings from BOTH Pi02 and Pi03 settings tables to determine the functionality of each pin.
+ The code uses settings from BOTH Pi02 and Pi03 settings tables to determine the functionality of each pin.
   * If Pi02 Is set as "INPUT" then the pin is an input (and automatically has the weak pull-up switched on)
@@ Line 55: / Line 47: @@
 Set Delay = 0 and steps to 0 for the fastest movement.
+See [[users:dagnall53:setting_up_wirocs_using_rocview|this guide]] for how to use RocView to set up a WiRocS node
 ----
@@ Line 73: / Line 66: @@
   * Port :8 is Servo NodePortType :0  Pi03_Setting_options32
+I would recommend keeping D8 as an output as most boards have a relatively strong pull down resistor on this pin to assist with startup. This makes it harder to use as an input.
+(As a very simplistic overview, NodePortType Determines if the port is Input or Output, Pi03_Setting_options determines if the output will be digital, PWM or a servo drive.) See also [[:users:Dagnall53:ESP32Differences|ESP32 Setup]]
-(As a very simplistic overview, NodePortType Determines if the port is Input or Output, Pi03_Setting_options determine the Pi03 settings.)
-Use the Rocrail Rocnet Programming tabs to get a much clearer picture of exactly how the ports are set)
-When set as a Loco, the code expects LEDS connected to 3v3 and the Back or Frontlight pins (D2 and D5). Currently the "fixed" nodes cannot have their phase altered using the Rocrail Rocnet Programming PI02 tab.\\
+----
- \\
-{{:users:dagnall53:img_2153.jpg?800}}
+======  Mobile Decoder ======
+==== LOCO HEADLIGHTS ====
+When set as a Loco, the code expects LEDS connected to 3v3 and the Back or Frontlight pins (D2 and D5). Currently the "fixed" nodes cannot have their phase altered using the Rocrail Rocnet Programming PI02 tab.
+==== CV settings ====
-----
-====== CV settings for Mobile Decoder ======
 Clicking on “Programming” will open the Rocrail CV Programming interface.
@@ Line 103: / Line 92: @@
 Changing the Loco address **can** be done with this interface, but care needs to be taken to ensure the programming interface loco address and the loco address stay in synch.
-To change from a Short Loco address to a Long loco address, First set the Loco "long" address to the Current Short address. Then change the Loco so it reads the Long address, and then chang ethe Loco address to the desired Long address.
+To change from a Short Loco address to a Long loco address, First set the Loco "long" address to the Current Short address. Then change the Loco so it reads the Long address, and then change the Loco address to the desired Long address.
-=== Sound CV settings ===
+====  Sound System ====
+Click here for more details on the [[:users:Dagnall53:Sound_System|Sound System]]
-The volume of each "F" effect is controlled by a CV: These are defaulted to 127, but can be changed using normal DCC "CV change" procedures:
+==== Speed settings: ====
+  WiRocS tries to be NMRA compliant.
-  * CV[100]=127; // Overall volume control
-  * CV[101]=127; //volume for F1
-  * CV[102]=127; // F2
-  * CV[103]=127; //F3
-  * CV[104]=127; //F4
-  * CV[105]=127;
-  * CV[106]=127;
-  * CV[107]=127;
-  * CV[108]=127; // Volume for F8
-  * CV[110]=127; // volume for chuffs
-  * CV[111]=127; // volume for Brake Squeal
-=== Speed settings: ===
   * CV[2]; Minimum speed setting (not MPH!..) Will have CV 66 or 95 added to set power at minimum speed demand
-  * CV[5]; Multiplier for speed setting, is multiplied by required speed to set power to motor
+  * CV[5]; High Speed Multiplier for speed setting, is multiplied by required speed to set power to motor
-  * CV[66]; Forward speed trim Added to CV 2 when in "forward"
+  * CV[6]; Mid Speed multiplier (used for first half of the throttle)
-  * CV[95]; Reverse speed trim Added to CV 2 when in "reverse"
+  * CV[3]; Acceleration rate (typ 2)
+  * CV[4]; Decelleration (typ 2)
+  * CV[29]; Standard Config usage
+  * CV[67-94] ; Speed table
+  * CV[66]; Forward speed trim multiplier (multiplies by  CV[66]/127 when in "forward")
+  * CV[95]; Reverse speed trim multiplier (multiplies by  CV[95]/127 when in "reverse")
   * CV[65]; Kick start sets duration of high speed motor setting when starting.
@@ Line 136: / Line 118: @@
 Set the kick start CV65 to a value so that the motor reliably starts without a visible kick. If it kicks noticeably then lower the value. If it does not start, increase the value.
-Set the loco to 10 mph and adjust CV5 so the loco travels at 10 mph.
+Set the loco to desired speed and adjust CV5 and CV6  so the loco travels at the speed you want.\\
+Or use the speed table to select the speed.
 ----
-====== Some examples using Rocrail Rocnet programming   ======
-Go to Rocrail and select "Programming / Rocnet / Setup" and then press “Query”.
-This will bring up a page that shows all the nodes connected to the MQTT broker. (Note this does not update actively so may show nodes that are currently off or not powered up).
-If you press "Show", the built-in LED on the highlighted node will flash to help identify / find the node. (As shown here, Node "Shed1" / ID 10" will flash)
-{{:users:dagnall53:rocnet_query.jpg|}}
-The decoder we were looking at via the Arduino Serial monitor is ID 28, and has the nickname “NoDAC”.
-The Roc Node address was set initially to the last byte of the IP address because of the _ForceRocnetNodeID_to_subIPL directive. This prevents nodes being on the same “node” address. Once the unit is reprogrammed with the directive disabled, you can set the Node Address via the Rocrail “Rocnet” ID interface, and also the node “nickname or “UID-Name” as Rocrail calls it.
-I would recommend leaving the Node ID as the IP address as it may help debugging later, but the "Shed1" and Swing" nodes have been set in this example with RocID's of 10 and 12, but their WiFi sub ip's are 19 and 20.
-If we now highlight node ID 28, and Click “Pi02 Port Setup”, it will show us how the various ports are set up:
-{{:users:dagnall53:pi02_example.jpg|}}
-Port 6 is an input, but all others are outputs.
-If any of the Pi02 ports were set with “Blink”, they will blink/flash with a delay set by the Delay setting.
-“Invert” would  invert the port  phase.
-Note Rocrail does not know that some ports are “FIXED”, but if you try to modify them they will revert to their “FIXED” settngs.
-Pressing “Pi03 Channel Setup” shows further information about our 8 io pins:
-{{:users:dagnall53:pi03_example.jpg|}}
-Here we see that Pin 1 and 8  are defined as a servos.. Pin 1 is actually the “FIXED” Motor drive servo, and is a special case where Left Right, Left steps Right steps etc are defined by CV values so these values cannot be changed here.
-Pin 5 has Blink set, so will be a PWM output, switching between the Left and Right PWM settings of 160 and 600.
-Pin 8 is a “normal” Servo output and will switch between positions 236 and 457. Note that in Rocrail, Min and Max positions for a servo are 150 and 600.
-Because this example is a “loco” at address 7 we can look at the throttle:
-I have set this one in the Rocrail “Locomotives table” with some default sound effect names.
-{{:users:dagnall53:rocnet_throttle_7.jpg|}}
-Clicking on “programming” will open the CV programming interface.
-To make this work, you need to select “POM” and the loco to be programmed in the top left box, and Rocrail will interrogate the set loco address and get the main CV settings: