Merge pull request #43 from johnrm174/develop

Develop

PUBLIC_API.md

@@ -676,6 +676,9 @@ for connecting in to the broker but note that these are NOT ENCRYPTED when sendi
 internet unless you are also using a SSL connection.
 <pre>
 configure_networking - Configures the local client and opens a connection to the MQTT broker
+                   Returns whether the connection was successful (or timed out)
+                   NOTE THAT THE 'CONFIGURE_NETWORKING' FUNCTION IS NOW DEPRECATED
+                   Use the 'configure_mqtt_client' and 'mqtt_broker_connect' functions instead
   Mandatory Parameters:
       broker_host:str - The name/IP address of the MQTT broker host to be used
       network_identifier:str - The name to use for this signalling network (any string)
@@ -686,6 +689,22 @@ configure_networking - Configures the local client and opens a connection to the
       broker_password:str - the password to log into the MQTT Broker (default = None)
       mqtt_enhanced_debugging:bool - 'True' to enable additional debug logging (default = False)
 
+configure_mqtt_client - Configures the local MQTT client and layout network node
+  Mandatory Parameters:
+      network_identifier:str - The name to use for this signalling network (any string)
+      node_identifier:str - The name to use for this node on the network (can be any string)
+  Optional Parameters:
+      mqtt_enhanced_debugging:bool - 'True' to enable additional debug logging (default = False)
+
+mqtt_broker_connect - Opens a connection to a local or remote MQTT broker
+                   Returns whether the connection was successful or not (True/False)
+  Mandatory Parameters:
+      broker_host:str - The name/IP address of the MQTT broker host to be used
+  Optional Parameters:
+      broker_port:int - The network port for the broker host (default = 1883)
+      broker_username:str - the username to log into the MQTT Broker (default = None)
+      broker_password:str - the password to log into the MQTT Broker (default = None)
+
 set_node_to_publish_dcc_commands - Enables publishing of DCC commands to other network nodes
   Optional Parameters:
       publish_dcc_commands:bool - 'True' to Publish / 'False' to stop publishing (default=False)

README.md

@@ -21,14 +21,15 @@ What's currently supported by the Editor:
 * Configure GPIO sensors and track sections to provide a 'mimic' display of the layout
 * Configure a level of automation for the signals as trains traverse the layout
 
-What's new in Release 3.4.1:
-* Minor bug fixes and enabling work for MQTT networking
-* Improvements to the operation of single line block instruments
-* Some block instrument library API functions have been DEPRECATED (see PUBLIC_API.md)
+What's new in Release 3.5:
+* MQTT networking - large layouts with multiple signalling areas can be split across multiple platforms
+  * Simple configuration for connecting to a local (you'll have to stand-up) or internet-based MQTT broker
+  * Publish and subscribe to signals, track sections and block instruments from each application instance
+  * Publish and subscribe to DCC feeds - allows multiple applications to share the same R-Pi/Pi-SPROG
 
 What's coming soon:
-* MQTT networking (for linking layouts)
-* Better application documentation
+* MQTT publish and subscribe to GPIO ports - for signal-passed and signal-approached events
+* Text boxs - Ability to add and edit text boxes on the schematic
 
 Any bug reports and feedback you may have would be gratefully appreciated - specifically:
 * What aspects are intuitive? What aspects aren't?