OpenMarine Internet of Things Documentation Release 0 Sailoog Jun 17, 2020
OpenMarine Internet of ThingsDocumentation
Release 0
Sailoog
Jun 17, 2020
Description
1 What is OpenMarine Internet of Things? 3
2 OpenPlotter 5
3 Others ways to acquire data 7
4 Sending data through MQTT 9
5 Public MQTT Broker 11
6 Private MQTT Broker 13
7 Using other MQTT brokers 15
8 Storing Signal K data 17
9 Other ways to store data 19
10 Displaying and processing data 21
11 MQTT apps 23
12 Using ThingsBoard 25
13 Using the OpenMarine Telegram bot 27
14 Using Influxdb tools to display data 29
15 Using Grafana to display Influxdb data 31
i
ii
OpenMarine Internet of Things Documentation, Release 0
Description 1
OpenMarine Internet of Things Documentation, Release 0
2 Description
CHAPTER 1
What is OpenMarine Internet of Things?
3
OpenMarine Internet of Things Documentation, Release 0
4 Chapter 1. What is OpenMarine Internet of Things?
CHAPTER 2
OpenPlotter
5
OpenMarine Internet of Things Documentation, Release 0
6 Chapter 2. OpenPlotter
CHAPTER 3
Others ways to acquire data
7
OpenMarine Internet of Things Documentation, Release 0
8 Chapter 3. Others ways to acquire data
CHAPTER 4
Sending data through MQTT
Using an MQTT client like the OpenPlotter IoT app you can exchange data between your boat and other devicesrunning other MQTT clients. You can find MQTT clients for Windows, Linux, Mac, OS and Android. All of theminclude tools to display and send data.
An MQTT broker is a server in charge of managing the traffic between MQTT clients. OpenPlotter IoT app alsoincludes an MQTT broker to manage MQTT clients connected to its local network but if you want to connect to yourboat from anywhere you will need a remote MQTT broker.
OpenMarine MQTT Broker is a 24/7 server available in 2 versions, public and free or private and paid.
4.1 Configuring the OpenPlotter IoT app
Coming soon
9
OpenMarine Internet of Things Documentation, Release 0
10 Chapter 4. Sending data through MQTT
CHAPTER 5
Public MQTT Broker
Note: OpenMarine Public MQTT Broker is in beta stage
Public server details
Protocol TCP
Adress mqtt.openmarine.net
Port 1883
OpenMarine public MQTT Broker is open to everyone and does not require a username or password.
5.1 Allowed topics
You can only do these actions on these topics:
Publish
<client ID>/signalk/delta
<client ID>/signalk/key/#
You can only publish data on topics that contain your client ID at the first level. The client ID must be unique, so it isa good idea to use your Signal K UUID or your MMSI. No one but you can publish on these topics. # is used to matchall subsequent levels of hierarchy.
Examples:
topic vessels.urn:mrn:imo:mmsi:234567890/signalk/delta
payload {“context”: “vessels.urn:mrn:imo:mmsi:234567890”,”updates”: [{“source”: {“label”:“N2000-01”,”type”: “NMEA2000”,”src”: “017”,”pgn”: 127488},”timestamp”: “2010-01-07T07:18:44Z”,”values”: [{“path”: “propulsion.0.revolutions”,”value”: 16.341667}]}]}
11
OpenMarine Internet of Things Documentation, Release 0
topic vessels.urn:mrn:imo:mmsi:234567890/signalk/key/propulsion/0/revolutions
payload 16.341667
Caution: Anyone can subscribe to your topics on the public server so do not send sensitive information
Subscribe
+/signalk/delta
+/signalk/key/#
You can subscribe to any topic sent from any client. + is used to match a single level of hierarchy. # is used to matchall subsequent levels of hierarchy.
Examples:
topic vessels.urn:mrn:imo:mmsi:234567890/signalk/delta
topic vessels.urn:mrn:imo:mmsi:234567890/signalk/key/propulsion/0/revolutions
Caution: Use wildcards wisely. If you subscribe to this topic: +/signalk/delta or to this one: +/signalk/key/# youwill receive all messages sent by all clients in the server and you will get thousands of messages colapsing yourclient.
12 Chapter 5. Public MQTT Broker
CHAPTER 6
Private MQTT Broker
13
OpenMarine Internet of Things Documentation, Release 0
14 Chapter 6. Private MQTT Broker
CHAPTER 7
Using other MQTT brokers
15
OpenMarine Internet of Things Documentation, Release 0
16 Chapter 7. Using other MQTT brokers
CHAPTER 8
Storing Signal K data
17
OpenMarine Internet of Things Documentation, Release 0
18 Chapter 8. Storing Signal K data
CHAPTER 9
Other ways to store data
19
OpenMarine Internet of Things Documentation, Release 0
20 Chapter 9. Other ways to store data
CHAPTER 10
Displaying and processing data
21
OpenMarine Internet of Things Documentation, Release 0
22 Chapter 10. Displaying and processing data
CHAPTER 11
MQTT apps
23
OpenMarine Internet of Things Documentation, Release 0
24 Chapter 11. MQTT apps
CHAPTER 12
Using ThingsBoard
25
OpenMarine Internet of Things Documentation, Release 0
26 Chapter 12. Using ThingsBoard
CHAPTER 13
Using the OpenMarine Telegram bot
27
OpenMarine Internet of Things Documentation, Release 0
28 Chapter 13. Using the OpenMarine Telegram bot
CHAPTER 14
Using Influxdb tools to display data
29
OpenMarine Internet of Things Documentation, Release 0
30 Chapter 14. Using Influxdb tools to display data
CHAPTER 15
Using Grafana to display Influxdb data
31