MQTT Broker - Revision history

Tanner.collin at 19:47, 10 August 2021

2021-08-10T19:47:56Z

← Older revision		Revision as of 19:47, 10 August 2021
Line 45:		Line 45:
	*password: [ask Tanner]		*password: [ask Tanner]

	=== Usage ===		===Usage===
	Please send messages to a topic starting with <code>test/</code> or <code>firstname/</code> while developing. This makes sure you don't screw up logged sensor data. For example:		Please send messages to a topic starting with <code>test/</code> or <code>firstname/</code> while developing. This makes sure you don't screw up logged sensor data. For example:

	* test/air/2/temp		*test/air/2/temp
	* tanner/air/2/temp		*tanner/air/2/temp

	After testing your device, show Tanner and we can make sure it's ready and add the data to the Protospace IoT API so others can use it.		After testing your device, show Tanner and we can make sure it's ready and add the data to the Protospace IoT API so others can use it.
Line 57:		Line 57:
	Please don't send values more than once per minute to prevent filling up the database.		Please don't send values more than once per minute to prevent filling up the database.

	==== CLI Example ====		====CLI Example====
	These examples use the <code>mosquitto</code> client program.		These examples use the <code>mosquitto</code> client program.

	Reading:		Reading:
	$ mosquitto_sub -d --capath /etc/ssl/certs/ -h webhost.protospace.ca -p 8883 -u reader -P cf503b99ba8cb0103da8884f09694fcd60ba1f2d -t sensors/air/0/temp		$ mosquitto_sub --capath /etc/ssl/certs/ -h webhost.protospace.ca -p 8883 -u reader -P cf503b99ba8cb0103da8884f09694fcd60ba1f2d -t sensors/air/0/temp
	... wait 60 seconds.		... wait 60 seconds and a number should appear.

	Writing:		Writing:
	$ mosquitto_pub -d --capath /etc/ssl/certs/ -h webhost.protospace.ca -p 8883 -u writer -P [ask Tanner] -t test -m 'hello world'		$ mosquitto_pub --capath /etc/ssl/certs/ -h webhost.protospace.ca -p 8883 -u writer -P [ask Tanner] -t test -m 'hello world'
	On MacOS, you might need to copy <code>/etc/ssl/certs/</code> from a Linux computer to somewhere on your machine.		On MacOS, you might need to copy <code>/etc/ssl/certs/</code> from a Linux computer to somewhere on your machine.

	==== Arduino Example ====		====Arduino Example====
	Please see https://github.com/Protospace/telemetry/blob/master/air_quality/air_quality.ino for example MQTT sensor code.		Please see https://github.com/Protospace/telemetry/blob/master/air_quality/air_quality.ino for example MQTT sensor code.

Tanner.collin at 19:47, 10 August 2021

2021-08-10T19:47:06Z

← Older revision		Revision as of 19:47, 10 August 2021
Line 16:		Line 16:
	Normally messages aren't stored anywhere. They just get sent out and received by whoever happens to be listening to the same topic. However, we automatically log messages to the <code>sensors/</code> topics using [https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer Telegraf] + [https://github.com/influxdata/influxdb#influxdb- InfluxDB].		Normally messages aren't stored anywhere. They just get sent out and received by whoever happens to be listening to the same topic. However, we automatically log messages to the <code>sensors/</code> topics using [https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer Telegraf] + [https://github.com/influxdata/influxdb#influxdb- InfluxDB].

	==== Topics ====		====Topics====
	MQTT topics consist of categories separated by slashes. Here are some topics currently in use:		MQTT topics consist of categories separated by slashes. Here are some topics currently in use:

	* sensors/air/0/temp		*sensors/air/0/temp
	* sensors/air/0/pm25		*sensors/air/0/pm25
	* sensors/air/1/temp		*sensors/air/1/temp
	* sensors/air/1/pm25		*sensors/air/1/pm25

	You can use <code>+</code> as a wildcard to match a single hierarchy when subscribing. For example, <code>sensors/air/+/temp</code> will subscribe to all air temperature sensors.		You can use <code>+</code> as a wildcard to match a single hierarchy when subscribing. For example, <code>sensors/air/+/temp</code> will subscribe to all air temperature sensors.
Line 30:		Line 30:
	===Access===		===Access===
	Server / host: webhost.protospace.ca		Server / host: webhost.protospace.ca

			Port: 8883

	====Reading====		====Reading====
Line 42:		Line 44:
	*username: writer		*username: writer
	*password: [ask Tanner]		*password: [ask Tanner]

			=== Usage ===
			Please send messages to a topic starting with <code>test/</code> or <code>firstname/</code> while developing. This makes sure you don't screw up logged sensor data. For example:

			* test/air/2/temp
			* tanner/air/2/temp

			After testing your device, show Tanner and we can make sure it's ready and add the data to the Protospace IoT API so others can use it.

			The last thing you do should be to change the topic to the real one before deploying the device. Make sure you don't commit this code change to prevent others from screwing up your logged sensor data if they run your code.

			Please don't send values more than once per minute to prevent filling up the database.

			==== CLI Example ====
			These examples use the <code>mosquitto</code> client program.

			Reading:
			$ mosquitto_sub -d --capath /etc/ssl/certs/ -h webhost.protospace.ca -p 8883 -u reader -P cf503b99ba8cb0103da8884f09694fcd60ba1f2d -t sensors/air/0/temp
			... wait 60 seconds.

			Writing:
			$ mosquitto_pub -d --capath /etc/ssl/certs/ -h webhost.protospace.ca -p 8883 -u writer -P [ask Tanner] -t test -m 'hello world'
			On MacOS, you might need to copy <code>/etc/ssl/certs/</code> from a Linux computer to somewhere on your machine.

			==== Arduino Example ====
			Please see https://github.com/Protospace/telemetry/blob/master/air_quality/air_quality.ino for example MQTT sensor code.

	===Technical Info===		===Technical Info===

Tanner.collin at 19:32, 10 August 2021

2021-08-10T19:32:38Z

← Older revision		Revision as of 19:32, 10 August 2021
Line 15:		Line 15:

	Normally messages aren't stored anywhere. They just get sent out and received by whoever happens to be listening to the same topic. However, we automatically log messages to the <code>sensors/</code> topics using [https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer Telegraf] + [https://github.com/influxdata/influxdb#influxdb- InfluxDB].		Normally messages aren't stored anywhere. They just get sent out and received by whoever happens to be listening to the same topic. However, we automatically log messages to the <code>sensors/</code> topics using [https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer Telegraf] + [https://github.com/influxdata/influxdb#influxdb- InfluxDB].

			==== Topics ====
			MQTT topics consist of categories separated by slashes. Here are some topics currently in use:

			* sensors/air/0/temp
			* sensors/air/0/pm25
			* sensors/air/1/temp
			* sensors/air/1/pm25

			You can use <code>+</code> as a wildcard to match a single hierarchy when subscribing. For example, <code>sensors/air/+/temp</code> will subscribe to all air temperature sensors.

			You can use <code>#</code> as a wildcard to match all '''remaining''' hierarchies. It must be the last character. For example, <code>sensors/#</code> will subscribe to all sensors.

	===Access===		===Access===

Tanner.collin at 19:22, 10 August 2021

2021-08-10T19:22:16Z

← Older revision		Revision as of 19:22, 10 August 2021
Line 8:		Line 8:
	Messages are just strings of text like "hello world" or "12.3".		Messages are just strings of text like "hello world" or "12.3".

	Messages are sent to arbitrary topics like <code>/pets/dogs/charlie</code>. By convention slashes separate levels of category that we all agree on.		Messages are sent to arbitrary topics like <code>pets/dogs/charlie</code>. By convention slashes separate levels of category that we all agree on.

	When a message is sent to a topic, all devices that are subscribed to that topic receive the message.		When a message is sent to a topic, all devices that are subscribed to that topic receive the message.

	Topics aren't really created, they just exist as soon as a message is sent to them.		Topics aren't really created, they just exist as soon as a message is sent to them.

			Normally messages aren't stored anywhere. They just get sent out and received by whoever happens to be listening to the same topic. However, we automatically log messages to the <code>sensors/</code> topics using [https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer Telegraf] + [https://github.com/influxdata/influxdb#influxdb- InfluxDB].

	===Access===		===Access===
Line 18:		Line 20:

	====Reading====		====Reading====
	Anyone can read any topic. Don't send anything private ~~over~~ the broker.		Anyone can read any topic. Don't send anything private to the broker.

	*username: reader		*username: reader
Line 32:		Line 34:
	The MQTT Broker is hosted on the [[Webhost VPS]] managed by Tanner. The same one that's running the main [[Website]] and the [[Wiki]].		The MQTT Broker is hosted on the [[Webhost VPS]] managed by Tanner. The same one that's running the main [[Website]] and the [[Wiki]].

	=== References ===		===References===
	<references />		<references />

Tanner.collin at 19:17, 10 August 2021

2021-08-10T19:17:13Z

← Older revision		Revision as of 19:17, 10 August 2021
Line 3:		Line 3:
	It's meant for sensors and devices at Protospace to communicate publicly and for fun.		It's meant for sensors and devices at Protospace to communicate publicly and for fun.

	=== Theory ===		===Theory===
	MQTT is a lightweight, publish-subscribe network protocol that transports messages between devices<ref>https://en.wikipedia.org/wiki/MQTT</ref>. It's low power and ideal for microcontrollers hooked up to sensors and devices.		MQTT is a lightweight, publish-subscribe network protocol that transports messages between devices<ref>https://en.wikipedia.org/wiki/MQTT</ref>. It's low power and ideal for microcontrollers hooked up to sensors and devices.

Line 14:		Line 14:
	Topics aren't really created, they just exist as soon as a message is sent to them.		Topics aren't really created, they just exist as soon as a message is sent to them.

	=== Access ===		===Access===
	Server / host: webhost.protospace.ca		Server / host: webhost.protospace.ca

	==== Reading ====		====Reading====
	Anyone can read any topic. Don't send anything private over the broker.		Anyone can read any topic. Don't send anything private over the broker.

	* username: reader		*username: reader
	* password: cf503b99ba8cb0103da8884f09694fcd60ba1f2d		*password: cf503b99ba8cb0103da8884f09694fcd60ba1f2d

	==== Writing ====		====Writing====
	Ask Tanner for write access to the broker. We want to make sure you don't accidentally screw up sensor data.		Ask Tanner for write access to the broker. We want to make sure you don't accidentally screw up sensor data.

	* username: writer		*username: writer
	* password: [ask Tanner]		*password: [ask Tanner]

	=== Technical Info ===		===Technical Info===
	The MQTT Broker is hosted on the [[Webhost VPS]] managed by Tanner. The same one that's running the main [[Website]] and the [[Wiki]].		The MQTT Broker is hosted on the [[Webhost VPS]] managed by Tanner. The same one that's running the main [[Website]] and the [[Wiki]].

			=== References ===
			<references />

Tanner.collin: Created page with "The MQTT Broker is a server that allows publishing and subscribing to MQTT topics. It's meant for sensors and devices at Protospace to communicate publicly and for fun. ===..."

2021-08-10T19:16:17Z

Created page with "The MQTT Broker is a server that allows publishing and subscribing to MQTT topics. It's meant for sensors and devices at Protospace to communicate publicly and for fun. ===..."

New page

The MQTT Broker is a server that allows publishing and subscribing to MQTT topics.

It's meant for sensors and devices at Protospace to communicate publicly and for fun.

=== Theory ===
MQTT is a lightweight, publish-subscribe network protocol that transports messages between devices<ref>https://en.wikipedia.org/wiki/MQTT</ref>. It's low power and ideal for microcontrollers hooked up to sensors and devices.

Messages are just strings of text like "hello world" or "12.3".

Messages are sent to arbitrary topics like <code>/pets/dogs/charlie</code>. By convention slashes separate levels of category that we all agree on.

When a message is sent to a topic, all devices that are subscribed to that topic receive the message.

Topics aren't really created, they just exist as soon as a message is sent to them.

=== Access ===
Server / host: webhost.protospace.ca

==== Reading ====
Anyone can read any topic. Don't send anything private over the broker.

* username: reader
* password: cf503b99ba8cb0103da8884f09694fcd60ba1f2d

==== Writing ====
Ask Tanner for write access to the broker. We want to make sure you don't accidentally screw up sensor data.

* username: writer
* password: [ask Tanner]

=== Technical Info ===
The MQTT Broker is hosted on the [[Webhost VPS]] managed by Tanner. The same one that's running the main [[Website]] and the [[Wiki]].