Forskjell mellom versjoner av «IoT»
(→MQTT-stil: Mere detaljer på MQTT-stilen.) |
(Legger til info om "device" protokollen.) |
||
Linje 40: | Linje 40: | ||
* For Bitrafs egne tjenester bruker vi <tt>bitraf/#</tt>. De fleste tjenestene er åpne og lesbare for alle for alle, mens noen vil være skrivebeskyttet og noen også lesebeskyttet. | * For Bitrafs egne tjenester bruker vi <tt>bitraf/#</tt>. De fleste tjenestene er åpne og lesbare for alle for alle, mens noen vil være skrivebeskyttet og noen også lesebeskyttet. | ||
− | == | + | == Applikasjoner == |
Denne delen beskriver de topicene som de enhetene vi har lagd sender på. | Denne delen beskriver de topicene som de enhetene vi har lagd sender på. | ||
+ | |||
+ | === Device === | ||
+ | |||
+ | '''device''' er en meta-applikasjon for å beskrive enheten som er i bruk. | ||
+ | |||
+ | Prefiks: <tt>bitraf/device/$device-id</tt>. | ||
+ | |||
+ | <tt>$device-id</tt> er tilfeldig, men konsistent for hver enhet. F.eks. for ESP8266-baserte er det nyttig å bruke <tt>system_get_chip_id()</tt> for å generere en enhets-id. | ||
+ | |||
+ | ; Undertopics: | ||
+ | : <tt>/online</tt>: <tt>1</tt> hvis online, <tt>0</tt> ellers. | ||
+ | : <tt>/name</tt>: Kort navn på enheten. Beregnet for mennesker, gjør det lettere å finne ut hvilken enhet som er hvilken. | ||
+ | : <tt>/firmware</tt>: Tekstlig beskrivelse av hvilken versjon av firmwaren som kjøres. Kan f.eks. inneholde versjon, tidspunkt for kompilering og Git revisjon. | ||
+ | : <tt>/ip</tt>: IPen til enheten. | ||
+ | |||
+ | Det er forventet at enheten bruker last will-meldingen på <tt>/online</tt>. | ||
=== Temperatur === | === Temperatur === | ||
Linje 62: | Linje 78: | ||
<code> | <code> | ||
bitraf/humidity/1/value | bitraf/humidity/1/value | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</code> | </code> | ||
Revisjonen fra 17. jun. 2018 kl. 17:54
Bitraf IoT er en gruppe med folk som synes "internet of things" er spennende og vil lage IoT-ting for Bitraf
- Meldingsflyt: https://iot.bitraf.no/live
- Kode med oppsett, kildekode og diverse: https://github.com/bitraf/bitraf-iot
- Grafer og historikk i OpenMCT: http://iot.bitraf.no:8080
- OpenHAB: https://openhab.bitraf.no
I dag (oktober 2016) har vi to typer ting som er satt opp: dørsystemet og temperatur-/fuktighetsmålinger på Bitraf.
Innhold
MQTT
Bitrafs MQTT-tjener er åpen og tilgjengelig for alle medlemmer:
- Host
- mqtt.bitraf.no
- Plain-port
- 1883
- TLS-port
- 8883
- Websockets (med TLS)
- 9001
Det meste er basert på MQTT. For å se på trafikken kan du bruke nettleseren eller en kommandolinjeklient fra f.eks. Mosquitto. Bitrafs produksjonsoppsett bruker bitraf/# (eller /bitraf/#), mens alle eksperimenter bruker public/# som topic.
Nettleserklienten er installert på https://mqtt.bitraf.no/web.
For å se alle meldinger med Mosquittos kommandolinjeklient, bruk denne kommandoen:
mosquitto_sub -h mqtt.bitraf.no -v \ -t bitraf/# -t /bitraf/# \ -t /public/# -t public/#
MQTT-stil
MQTT-protokollen spesifiserer lite av hvordan topics skal brukes så dette er vår stil. Denne delen er levende og bygges ut etterhvert som vi får mer erfaring.
- Topics starter uten slash: foo, ikke /foo.
- Ikke alle tjenestene oppdatert med denne standarden enda.
- For testing og utvikling bruker public/#.
- Dette området vil alltid være åpent for bruk.
- Dette området oppfordrer vi medlemmer til å bruke så mye de vil. Bruk gjerne public/$brukernavn/ som prefiks.
- For Bitrafs egne tjenester bruker vi bitraf/#. De fleste tjenestene er åpne og lesbare for alle for alle, mens noen vil være skrivebeskyttet og noen også lesebeskyttet.
Applikasjoner
Denne delen beskriver de topicene som de enhetene vi har lagd sender på.
Device
device er en meta-applikasjon for å beskrive enheten som er i bruk.
Prefiks: bitraf/device/$device-id.
$device-id er tilfeldig, men konsistent for hver enhet. F.eks. for ESP8266-baserte er det nyttig å bruke system_get_chip_id() for å generere en enhets-id.
- Undertopics
- /online: 1 hvis online, 0 ellers.
- /name: Kort navn på enheten. Beregnet for mennesker, gjør det lettere å finne ut hvilken enhet som er hvilken.
- /firmware: Tekstlig beskrivelse av hvilken versjon av firmwaren som kjøres. Kan f.eks. inneholde versjon, tidspunkt for kompilering og Git revisjon.
- /ip: IPen til enheten.
Det er forventet at enheten bruker last will-meldingen på /online.
Temperatur
Prefiks: bitraf/temperature/$id
Temperaturen sendes på topicen $id/value som en tekststreng som er antall grader med desimaler, f.eks.:
bitraf/temperature/1/value
Luftfuktighet
Prefiks: bitraf/humidity/$id
Luftfuktigheten sendes på topicen $id/value som en tekststreng som er antall prosent luftfuktighet.
bitraf/humidity/1/value
Enheter
Denne typen er eksperimentell.
bitraf/device/1/value
boxy2
Døråpner i 2.
boxy4
Døråpner i 4.
arduino-button-box
ESP8266/NodeMCU-basert boks som har knapper og temperatursensor.
Implementerer temperatur (id=1) og humidity (id=1).
Kildekode: https://github.com/bitraf/bitraf-iot/tree/master/arduino-button-box