Wifi and mqtt on the rs9113 - Revision history

Dsojka at 17:19, 17 September 2018

2018-09-17T17:19:36Z

Dsojka at 17:18, 17 September 2018

2018-09-17T17:18:55Z

Dsojka at 17:17, 17 September 2018

2018-09-17T17:17:12Z

Dsojka at 17:02, 17 September 2018

2018-09-17T17:02:23Z

Dsojka at 16:56, 17 September 2018

2018-09-17T16:56:51Z

Dsojka at 21:15, 6 June 2018

2018-06-06T21:15:10Z

Dsojka at 21:03, 6 June 2018

2018-06-06T21:03:55Z

Dsojka at 21:01, 6 June 2018

2018-06-06T21:01:29Z

Dsojka at 20:53, 6 June 2018

2018-06-06T20:53:10Z

Dsojka at 20:52, 6 June 2018

2018-06-06T20:52:51Z

@@ Line 47: / Line 47: @@
 </syntaxhighlight>
 *Puts the RS911X module into deep (disconnected) sleep mode. This function is best called after the board is reset, so re-initializing the class should be done before calling sleep.
 nic = network.RS911X(pyb.SPI(2), pyb.Pin("I0"), pyb.Pin("E3"), pyb.Pin("E4"))
 nic.sleep()

@@ Line 42: / Line 42: @@
 </syntaxhighlight>
 *Disconnects from the WiFi network.
 <syntaxhighlight lang=python>
@@ Line 57: / Line 47: @@
 </syntaxhighlight>
 *Puts the RS911X module into deep (disconnected) sleep mode. This function is best called after the board is reset, so re-initializing the class should be done before calling sleep.
-nic = network.RS911X(pyb.SPI(1), pyb.Pin("A4"), pyb.Pin("D9"), pyb.Pin("D10"))
+nic = network.RS911X(pyb.SPI(2), pyb.Pin("I0"), pyb.Pin("E3"), pyb.Pin("E4"))
 nic.sleep()

@@ Line 45: / Line 45: @@
 <syntaxhighlight lang=python>
 RS911X.isconnected()
 </syntaxhighlight>
 *Returns a True if connected to a network, False otherwise.
@@ Line 68: / Line 73: @@
 RS911X.scan()
 </syntaxhighlight>
-Returns a list of 4-tuples with (SSID, RSSI value, security mode, RF channel, BSSID)
+*Returns a list of 4-tuples with (SSID, RSSI value, security mode, RF channel, BSSID)
 <syntaxhighlight lang=python>

@@ Line 17: / Line 17: @@
 <syntaxhighlight lang=python>
 import network
-nic = network.RS911X(pyb.SPI(1), pyb.Pin("A4"), pyb.Pin("D9"), pyb.Pin("D10"))
+nic = network.RS911X(pyb.SPI(2), pyb.Pin("I0"), pyb.Pin("E3"), pyb.Pin("E4"))
 nic.connect('SSID', 'Password')
 </syntaxhighlight>

@@ Line 8: / Line 8: @@
 <!-- /****************************************  Page Description Text  ****************************************/ -->
 <!-- /*********************************************************************************************************/ -->
-The RS9113 family of modules are ultra-low power radio modules that support wifi, Bluetooth, and ZigBee.
+The RS911X family of modules are ultra-low power radio modules that support wifi, Bluetooth, and ZigBee.
 Emac has developed driver support for these modules in Micropython.
 ==Wifi==
-===Class RS9113:===
+===Class RS911X:===
-This class provides the driver for the RS9113 module through the SPI interface. It is imported from the 'network' module. The following is an example usage:
+This class provides the driver for the RS911X module through the SPI interface. It is imported from the 'network' module. The following is an example usage:
 <syntaxhighlight lang=python>
 import network
-nic = network.RS9113(pyb.SPI(1), pyb.Pin("A4"), pyb.Pin("D9"), pyb.Pin("D10"))
+nic = network.RS911X(pyb.SPI(1), pyb.Pin("A4"), pyb.Pin("D9"), pyb.Pin("D10"))
 nic.connect('SSID', 'Password')
 </syntaxhighlight>
@@ Line 23: / Line 23: @@
 ===Constructor:===
 <syntaxhighlight lang=python>
-network.RS9113(spi, pin_cs, pin_rst, pin_irq)
+network.RS911X(spi, pin_cs, pin_rst, pin_irq)
 </syntaxhighlight>
-This constructor creates the RS913 object and initializes the module given the SPI bus and pins. Returns the RS9113 object. Arguments are:
+This constructor creates the RS913 object and initializes the module given the SPI bus and pins. Returns the RS911X object. Arguments are:
 *spi       a Micropython SPI object.
 *pin_cs    a Micropython Pin object connected to the RS91113 module's Chip Select pin.
@@ Line 34: / Line 34: @@
 ===Methods:===
 <syntaxhighlight lang=python>
-RS9113.connect(ssid, key=None,*,security=WPA2, ssl=False, nonblocking=False)
+RS911X.connect(ssid, key=None,*,security=WPA2, ssl=False, nonblocking=False)
 </syntaxhighlight>
 *Connects to the given SSID and security paramaters. If 'ssl' is set to True, all of the sockets created will be set to use SSL. If 'nonblocking' is set to True, all sockets will use nonblocking functionality.
 <syntaxhighlight lang=python>
-RS9113.disconnect()
+RS911X.disconnect()
 </syntaxhighlight>
 *Disconnects from the WiFi network.
 <syntaxhighlight lang=python>
-RS9113.isconnected()
+RS911X.isconnected()
 </syntaxhighlight>
 *Returns a True if connected to a network, False otherwise.
 <syntaxhighlight lang=python>
-RS9113.sleep()
+RS911X.sleep()
 </syntaxhighlight>
-*Puts the RS9113 module into deep (disconnected) sleep mode. This function is best called after the board is reset, so re-initializing the class should be done before calling sleep.
+*Puts the RS911X module into deep (disconnected) sleep mode. This function is best called after the board is reset, so re-initializing the class should be done before calling sleep.
-nic = network.RS9113(pyb.SPI(1), pyb.Pin("A4"), pyb.Pin("D9"), pyb.Pin("D10"))
+nic = network.RS911X(pyb.SPI(1), pyb.Pin("A4"), pyb.Pin("D9"), pyb.Pin("D10"))
 nic.sleep()
 <syntaxhighlight lang=python>
-RS9113.ifconfig()
+RS911X.ifconfig()
 </syntaxhighlight>
 *Returns a 4-tuple with (ip address, subnet mask, gateway, MAC address). This method requires the module to be successfully connected to a network.
 <syntaxhighlight lang=python>
-RS9113.macaddr()
+RS911X.macaddr()
 </syntaxhighlight>
 *Returns a string containing the MAC address for the module. The string is colon separated octets without leading '0x.'
 <syntaxhighlight lang=python>
-RS9113.scan()
+RS911X.scan()
 </syntaxhighlight>
 Returns a list of 4-tuples with (SSID, RSSI value, security mode, RF channel, BSSID)
 <syntaxhighlight lang=python>
-RS9113.fwap(ssid=None)
+RS911X.fwap(ssid=None)
 </syntaxhighlight>
@@ Line 90: / Line 90: @@
 ===Constants:===
-RS9113.WPA2
+RS911X.WPA2
-RS9113.OPEN
+RS911X.OPEN
-Security types to be used in RS9113.scan() and returned in a tuple with RS9113.scan().
+Security types to be used in RS911X.scan() and returned in a tuple with RS911X.scan().
-{{note | Information regarding sockets can be found in the Micropython documentation. Once the RS9113 is initialized and
+{{note | Information regarding sockets can be found in the Micropython documentation. Once the RS911X is initialized and
 connected, the socket module will use it without prompting.
 http://docs.micropython.org/en/v1.8.7/pyboard/library/usocket.html?}}
@@ Line 101: / Line 101: @@
 ===Class MQTTClient:===
-This class provides an MQTT interface for use with RS9113 WiFi modems. It is imported from the 'umqtt.robust' or 'umqtt.simple' modules. The following is an example usage:
+This class provides an MQTT interface for use with RS911X WiFi modems. It is imported from the 'umqtt.robust' or 'umqtt.simple' modules. The following is an example usage:
 <syntaxhighlight lang=python>
 import network
 import umqtt.simple
-nic = network.RS9113(pyb.SPI(3), pyb.Pin("I0"), pyb.Pin("E3"), pyb.Pin("E4"))
+nic = network.RS911X(pyb.SPI(3), pyb.Pin("I0"), pyb.Pin("E3"), pyb.Pin("E4"))
 nic.connect('SSID', 'Password')
 client = umqtt.simple.MQTTClient('client id', 'example-server.com', port=1883, user='uname', password='pword', ssl=False)

@@ Line 137: / Line 137: @@
 <syntaxhighlight lang=python>
-MQTT.publish(topic, msg, retain=False, qos=0)
+MQTTClient.publish(topic, msg, retain=False, qos=0)
 </syntaxhighlight>
 *Publishes a message to a topic on the connected server. Arguments:

@@ Line 116: / Line 116: @@
 </syntaxhighlight>
-This constructor cretes and returns an MQTTClient object. The server connection is not handled by the constructor.
+*This constructor cretes and returns an MQTTClient object. The server connection is not handled by the constructor. Arguments:
-Arguments:
+**client_id         The client ID sent to the server.
-*client_id         The client ID sent to the server.
+**server            The URL or IP address of the server to connect to.
-*server            The URL or IP address of the server to connect to.
+**port              The port of the server to connect to.
-*port              The port of the server to connect to.
+**user              The username to use, if applicable.
-*user              The username to use, if applicable.
+**password          The password to use, if applicable.
-*password          The password to use, if applicable.
+**keepalive         How long to keep the connection alive, in seconds. 0 disabels the timeout.
-*keepalive         How long to keep the connection alive, in seconds. 0 disabels the timeout.
+**ssl               Determines if SSL is used for the connection.
 ===Methods:===
@@ Line 140: / Line 139: @@
 MQTT.publish(topic, msg, retain=False, qos=0)
 </syntaxhighlight>
-Publishes a message to a topic on the connected server.
+*Publishes a message to a topic on the connected server. Arguments:
-Arguments:
+**topic             Topic to publish to.
-*topic             Topic to publish to.
+**msg               Message to publish.
-*msg               Message to publish.
+**retain            Determines if the message should be retained on reconnect.
-*retain            Determines if the message should be retained on reconnect.
+**qos               The quality of service level to use.
 <syntaxhighlight lang=python>
 MQTTClient.set_callback(f)
 </syntaxhighlight>
-Sets the callback to be called when a message is retrieved.
+*Sets the callback to be called when a message is retrieved. Argument:
-Argument:
+**f                 The function to be set as the callback.
-*f                 The function to be set as the callback.
+*Note: The callback function definition should be in the following format:
-Note: The callback function definition should be in the following format:
+**<syntaxhighlight lang=python>
 def cb(topic, message):
 </syntaxhighlight>
@@ Line 161: / Line 158: @@
 MQTTClient.subscribe(topic, qos=0)
 </syntaxhighlight>
-Subscribes to a topic. A callback must be set by set_callback().
+*Subscribes to a topic. A callback must be set by set_callback(). Arguments:
-Arguments:
+**topic             Topic to subscribe to.
-*topic             Topic to subscribe to.
+**qos               The quality of service level to use.
 <syntaxhighlight lang=python>

← Older revision		Revision as of 21:01, 6 June 2018
Line 97:		Line 97:
	connected, the socket module will use it without prompting.		connected, the socket module will use it without prompting.
	http://docs.micropython.org/en/v1.8.7/pyboard/library/usocket.html?}}		http://docs.micropython.org/en/v1.8.7/pyboard/library/usocket.html?}}
		+
		+	==MQTT==
		+
		+	===Class MQTTClient:===
		+	This class provides an MQTT interface for use with RS9113 WiFi modems. It is imported from the 'umqtt.robust' or 'umqtt.simple' modules. The following is an example usage:
		+	<syntaxhighlight lang=python>
		+	import network
		+	import umqtt.simple
		+	nic = network.RS9113(pyb.SPI(3), pyb.Pin("I0"), pyb.Pin("E3"), pyb.Pin("E4"))
		+	nic.connect('SSID', 'Password')
		+	client = umqtt.simple.MQTTClient('client id', 'example-server.com', port=1883, user='uname', password='pword', ssl=False)
		+	client.connect()
		+	</syntaxhighlight>
		+
		+	===Constructor:===
		+	<syntaxhighlight lang=python>
		+	MQTTClient(client_id, server, port=0, user=None, password=None, keepalive=0, ssl=False)
		+	</syntaxhighlight>
		+
		+	This constructor cretes and returns an MQTTClient object. The server connection is not handled by the constructor.
		+	Arguments:
		+	*client_id The client ID sent to the server.
		+	*server The URL or IP address of the server to connect to.
		+	*port The port of the server to connect to.
		+	*user The username to use, if applicable.
		+	*password The password to use, if applicable.
		+	*keepalive How long to keep the connection alive, in seconds. 0 disabels the timeout.
		+	*ssl Determines if SSL is used for the connection.
		+
		+	===Methods:===
		+	<syntaxhighlight lang=python>
		+	MQTTClient.connect()
		+	</syntaxhighlight>
		+	*Connects to the server provided in the constructor.
		+
		+	<syntaxhighlight lang=python>
		+	MQTTClient.disconnect()
		+	</syntaxhighlight>
		+	*Disconnects from the server.
		+
		+	<syntaxhighlight lang=python>
		+	MQTT.publish(topic, msg, retain=False, qos=0)
		+	</syntaxhighlight>
		+	Publishes a message to a topic on the connected server.
		+	Arguments:
		+	*topic Topic to publish to.
		+	*msg Message to publish.
		+	*retain Determines if the message should be retained on reconnect.
		+	*qos The quality of service level to use.
		+
		+	<syntaxhighlight lang=python>
		+	MQTTClient.set_callback(f)
		+	</syntaxhighlight>
		+	Sets the callback to be called when a message is retrieved.
		+	Argument:
		+	*f The function to be set as the callback.
		+	Note: The callback function definition should be in the following format:
		+	<syntaxhighlight lang=python>
		+	def cb(topic, message):
		+	</syntaxhighlight>
		+
		+	<syntaxhighlight lang=python>
		+	MQTTClient.subscribe(topic, qos=0)
		+	</syntaxhighlight>
		+	Subscribes to a topic. A callback must be set by set_callback().
		+	Arguments:
		+	*topic Topic to subscribe to.
		+	*qos The quality of service level to use.
		+
		+	<syntaxhighlight lang=python>
		+	MQTTClient.wait_msg()
		+	</syntaxhighlight>
		+	*Wait for a single incoming MQTT message and process it. Subscribed messages are delivered to a callback previously set by .set_callback() method. Other (internal) MQTT messages processed internally.
		+
		+	<syntaxhighlight lang=python>
		+	MQTTClient.check_msg()
		+	</syntaxhighlight>
		+	*Checks whether a pending message from server is available. If not, returns immediately with None. Otherwise does the same processing as wait_msg.

← Older revision		Revision as of 20:52, 6 June 2018
Line 11:		Line 11:
	Emac has developed driver support for these modules in Micropython.		Emac has developed driver support for these modules in Micropython.

−	~~<!-- /*********************************************************************************************************/ -->~~
−	~~<!-- /*************************************** General Information ***************************************/ -->~~
−	~~<!-- /*********************************************************************************************************/ -->~~
−	~~{{:Templateimpl:geninfo \| initials=BS \| title=Micropython driver documentation \| desc=The following page can be used to get familiarized with Micropython drivers for the RS9113. \| project=OE 5.0 }}~~
	==Wifi==		==Wifi==