Swagbadge2021 MQTT - Revision history

Marcmerlin: /* Making your badge perform */

2021-01-23T22:08:14Z

Making your badge perform

← Older revision		Revision as of 22:08, 23 January 2021
Line 31:		Line 31:

	<code>		<code>
	mosquitto_sub -h 101.181.46.180 -t public/esp32_id/0/~~out~~ (~~may~~ receive messages output by the badge)		mosquitto_sub -h 101.181.46.180 -t public/esp32_id/0/# (will receive messages output by the badge like "(boot v04 swagbadge)")

	mosquitto_sub -h 101.181.46.180 -t public/esp32_id/# (shows message sent to the badge)		mosquitto_sub -h 101.181.46.180 -t public/esp32_id/# (shows message sent to the badge)

Marcmerlin: /* Controlling your badge over MQTT */

2021-01-23T21:46:23Z

Controlling your badge over MQTT

← Older revision		Revision as of 21:46, 23 January 2021
Line 31:		Line 31:

	<code>		<code>
	mosquitto_sub -h 101.181.46.180 -t public/esp32_id/0 ~~& << does this~~ receive ~~anything?~~		mosquitto_sub -h 101.181.46.180 -t public/esp32_id/0/out (may receive messages output by the badge)

			mosquitto_sub -h 101.181.46.180 -t public/esp32_id/# (shows message sent to the badge)

			mosquitto_sub -h 101.181.46.180 -t public/# (show all messages for all badges)

	mosquitto_pub -h 101.181.46.180 -t public/esp32_id/0/in -m "(oled:clear)"		mosquitto_pub -h 101.181.46.180 -t public/esp32_id/0/in -m "(oled:clear)"

Marcmerlin: /* Going direct to MQTT */

2021-01-23T21:31:50Z

Going direct to MQTT

@@ Line 107: / Line 107: @@
 [https://github.com/geekscape/aiko_engine_mp/blob/master/lib/umqtt/simple.py All of the available MQTT Client functions]
 = Encrypting messages with your badge =
 Placeholder text.

Marcmerlin: /* Receiving a message and taking action */

2021-01-23T21:19:05Z

Receiving a message and taking action

← Older revision		Revision as of 21:19, 23 January 2021
Line 67:		Line 67:

	If you want to listen/subscribe to all sub-topics, use a <code>#</code> at the end. For example <code>public/chocolate/#</code> will listen to public/chocolate and public/chocolate/lindt and public/chocolate/kokoblack and public/chocolate/ganache		If you want to listen/subscribe to all sub-topics, use a <code>#</code> at the end. For example <code>public/chocolate/#</code> will listen to public/chocolate and public/chocolate/lindt and public/chocolate/kokoblack and public/chocolate/ganache

			See https://github.com/geekscape/aiko_engine_mp/blob/master/configuration/mqtt.py#L13 as well as line 132 and 63

	'''Handle messages on that topic'''		'''Handle messages on that topic'''
Line 76:		Line 78:
	Add this handler function to the MQTT client: this is typically done in your application's initialise() method.		Add this handler function to the MQTT client: this is typically done in your application's initialise() method.
	mqtt.add_message_handler(on_message, "YOUR_TOPIC")		mqtt.add_message_handler(on_message, "YOUR_TOPIC")

			'''Example code'''

			Here is a complete application example … https://github.com/geekscape/aiko_engine_mp/blob/master/applications/step_controller.py

			In this case, Aiko’s general MQTT on_message() handler will route all incoming messages to the specific handlers matching a given topic and supports multiple handlers “listening” to various specific topics. There is an exception handler wrapped around every message handler … so that the MQTT thread doesn’t fail. And over time Aiko’s error handling will improve, e.g re-subscribe to all MQTT topics on reconnection, etc. At some point, Aiko will provide the heavy lifting for encrypted message publish / subscribe. Finally, once Aiko Services (a general purpose distributed / embedded system) is released, then our ESP32 devices can become first-class citizens of a broader distributed service-based network (perhaps a month or so away). Aiko also supports some “dangerous” fun, like opt-in enabling receiving microPython code as an MQTT message and executing it (obviously this is dangerous)

	=== Publishing a message ===		=== Publishing a message ===

Nicola: /* Controlling your badge over MQTT */

2021-01-20T07:09:41Z

Controlling your badge over MQTT

@@ Line 1: / Line 1: @@
-= Controlling your badge over MQTT =
+= About MQTT =
 == About the LCA Swagbadge MQTT server ==
@@ Line 8: / Line 12: @@
 * The ''upgrade/'' topic path prefix is public read: only Jon and Andy can update it.
 * The ''aiko/'' topic path prefix is public read/write
 * The ''secret/'' topic path prefix is write-only
 * We have some server monitoring to look for things snooping for all the channels, or who aren't using aiko/on a badge, and mitigations in the event a badge goes beserk and starts a spamming DOS attack.
 You are welcome to change which MQTT server your badge uses, by updating the mqtt.py configuration file. Some publicly hosted alternatives are provided (commented out) in the config.
 == Making your badge perform ==
@@ Line 46: / Line 51: @@
 If you'd like to make your application MQTT aware, take a look at the [https://github.com/geekscape/aiko_engine_mp/blob/master/lib/aiko/oled.py oled code].

Nicola: /* About the LCA Swagbadge MQTT server */

2021-01-20T06:30:27Z

About the LCA Swagbadge MQTT server

← Older revision		Revision as of 06:30, 20 January 2021
Line 9:		Line 9:
	* The ''aiko/'' topic path prefix is public read/write		* The ''aiko/'' topic path prefix is public read/write
	* The ''secret/'' topic path prefix is write-only		* The ''secret/'' topic path prefix is write-only
			* The ''public/'' topic path prefix is available for everyone to read/write
	* You can create other channels for your own purposes in addition to these.		* You can create other channels for your own purposes in addition to these.
	* We have some server monitoring to look for things snooping for all the channels, or who aren't using aiko/on a badge, and mitigations in the event a badge goes beserk and starts a spamming DOS attack.		* We have some server monitoring to look for things snooping for all the channels, or who aren't using aiko/on a badge, and mitigations in the event a badge goes beserk and starts a spamming DOS attack.

Nicola: /* About the LCA Swagbadge MQTT server */

2021-01-16T04:22:12Z

About the LCA Swagbadge MQTT server

← Older revision		Revision as of 04:22, 16 January 2021
Line 8:		Line 8:
	* The ''upgrade/'' topic path prefix is public read: only Jon and Andy can update it.		* The ''upgrade/'' topic path prefix is public read: only Jon and Andy can update it.
	* The ''aiko/'' topic path prefix is public read/write		* The ''aiko/'' topic path prefix is public read/write
			* The ''secret/'' topic path prefix is write-only
			* You can create other channels for your own purposes in addition to these.
	* We have some server monitoring to look for things snooping for all the channels, or who aren't using aiko/on a badge, and mitigations in the event a badge goes beserk and starts a spamming DOS attack.		* We have some server monitoring to look for things snooping for all the channels, or who aren't using aiko/on a badge, and mitigations in the event a badge goes beserk and starts a spamming DOS attack.

Marcmerlin: /* Making your badge perform */

2021-01-15T20:26:26Z

Making your badge perform

← Older revision		Revision as of 20:26, 15 January 2021
Line 21:		Line 21:

	Messages are usually in the form of <code>(component:command arguments)</code>.		Messages are usually in the form of <code>(component:command arguments)</code>.

			<code>
			mosquitto_sub -h 101.181.46.180 -t public/esp32_id/0 & << does this receive anything?

			mosquitto_pub -h 101.181.46.180 -t public/esp32_id/0/in -m "(oled:clear)"

			mosquitto_pub -h 101.181.46.180 -t public/esp32_id/0/in -m "(oled:pixel 64 32)"

			mosquitto_pub -h 101.181.46.180 -t public/esp32_id/0/in -m "(oled:text 0 50 Hello World)"
			</code>

	=== OLED messages ===		=== OLED messages ===

Nicola: /* Making your badge perform */

2020-12-26T01:47:38Z

Making your badge perform

← Older revision		Revision as of 01:47, 26 December 2020
Line 18:		Line 18:
	# Install an mqtt client on your machine		# Install an mqtt client on your machine
	# Connect to the mqtt server (if you forget what it is, the IP address is shown on bootup)		# Connect to the mqtt server (if you forget what it is, the IP address is shown on bootup)
	# Using your badge's topic (~~aiko~~/~~your_badge_id~~/0/in) send it a message		# Using your badge's topic (public/esp32_your_badge_id/0/in) send it a message

	Messages are usually in the form of <code>(component:command arguments)</code>.		Messages are usually in the form of <code>(component:command arguments)</code>.

Nicola: Created page with "= Controlling your badge over MQTT = == About the LCA Swagbadge MQTT server == The badges have MQTT configured to talk to a dedicated server hosted by Andy Gelme, one of the..."

2020-12-23T06:47:29Z

Created page with "= Controlling your badge over MQTT = == About the LCA Swagbadge MQTT server == The badges have MQTT configured to talk to a dedicated server hosted by Andy Gelme, one of the..."

New page

= Controlling your badge over MQTT =

== About the LCA Swagbadge MQTT server ==

The badges have MQTT configured to talk to a dedicated server hosted by Andy Gelme, one of the OHMC organisers. We have done this for security and privacy reasons, and because it gives us an Australian server so it's faster.

This server is at <code>101.181.46.180</code>, the configuration for which is held on the badge at [https://github.com/geekscape/aiko_engine_mp/blob/master/configuration/mqtt.py configuration/mqtt.py]. The server has some special features:
* The ''upgrade/'' topic path prefix is public read: only Jon and Andy can update it.
* The ''aiko/'' topic path prefix is public read/write
* We have some server monitoring to look for things snooping for all the channels, or who aren't using aiko/on a badge, and mitigations in the event a badge goes beserk and starts a spamming DOS attack.

You are welcome to change which MQTT server your badge uses, by updating the mqtt.py configuration file. Some publicly hosted alternatives are provided (commented out) in the config.

== Making your badge perform ==

The easiest thing to do is send messages to show up on your screens.

# Install an mqtt client on your machine
# Connect to the mqtt server (if you forget what it is, the IP address is shown on bootup)
# Using your badge's topic (aiko/your_badge_id/0/in) send it a message

Messages are usually in the form of <code>(component:command arguments)</code>.

=== OLED messages ===
;(oled:clear)
: clears both screens
;(oled:log Hello World!)
: writes a message along the bottom of the screens, scrolling up whatever is there out of the way
; (oled:pixel x y)
: lights a pixel at that spot
; (oled:text x y This is a test !)
: Puts some text at the position x,y. It will be displayed over the top of whatever's there.

If you'd like to make your application MQTT aware, take a look at the [https://github.com/geekscape/aiko_engine_mp/blob/master/lib/aiko/oled.py oled code].