Skip to content

Latest commit

 

History

History
174 lines (125 loc) · 13.1 KB

README.md

File metadata and controls

174 lines (125 loc) · 13.1 KB
Raw

Welcome to my IoT-aboard notes/repository

IoT (and open source software) have recently changed how boat owners consume and interact with data on their boat, I'm very excited to present you the beginning of my journey into this technology.

This summer, I have been implementing a bright LED display functioning as a (data) repeater for displaying critical navigation data. It is mounted below deck at the mast support and readable at the steer about 8m. distance away. A short video here.

I cycle through 5 views (engine temperature/compass course/wind speed/atmospheric pressure/speed through water) using a remote control. The LED display quickly scrolls the data repeatedly. The remote control actually is a mini router with the stock firmware replaced by OpenWRT + Mosquitto.

It was quite easy to set up thanks to Node-RED (=browser-based editor), I only had to come up with some logical thinking and about 40 lines of Javascript code.

My current project

Now I want to expand on this functionallity, I'll be diving into Node.js, I'll code my first Signal K Node server plugin. Signal K is a modern and open data format for marine use with the server node being built on Node.js and making use of JSON, websockets and HTTP. This server is hosted on a Raspberry Pi running OpenPlotter (=Linux customized for marine use) and it provides a means for processing/sharing vessel/equipment information in a way that is friendly to wifi, cellphones, tablets and the internet.

My current project is the development of a plugin for such a Signal K server for the purpose of safety when navigating long routes.

I must confess that I don't fully trust my wife/autopilot handling the steer, but I didn't tell my wife about that yet :) I'd like to see my LED display show compass heading (as I managed earlier with Node-RED) while the server plugin compares the current heading against a preset value. Let's say that the compass course deviates 20 degrees from my preset variable, then I want the LED display to raise an alarm by blinking the unused pixels in red color. Other kind of alarms would be thinkable as well:

  • engine temperature reaching a certain treshold
  • wind speed reaching a certain treshold
  • water depth below a certain treshold
  • barometric pressure dropping at an alarming rate

The remote control (=mini router with button) will serve as an interface to acknowledge alarms. A long button press could be used to adjust tresholds. There is also a switch which can be set to 3 different positions.

Beside getting NMEA sensor data (compass course/wind speed/speed through water) to my Signal K server via USB, I added atmospheric pressure readings coming from the IMU plugged on top of my second Raspberry Pi (=the one with the LED display on top). I also found a library to reprogram my ESP8266 unit to send engine temperature data to the Signal K server over wifi and some instructions to add this unit as a (data) provider.

Next challenges:

  • the Signal K server is mounted behind wood at the navigation station and is some distance away from the LED display which is plugged on top of my second Raspberry (=Pi Zero W), the LED display will need to be controllable over HTTP
  • I'm not an experienced Javascript programmer, luckily I found a npm module for handling the LED display.

Future updates will show how this is progressing...

My Hardware specs

OpenPlotter configuration

  • OpenPlotter: Serial (component) -> assign USB device (auto-detected) to Signal K and set (input) type NMEA0183 and baud to 460800
  • Assure internet connectivity with USB tethering

Signal K config

  • configure Signal K via admin UI, user/pass openplotter/openplotter, import flowOP (node-red) stored in this repository
  • install + activate plugins: 'Node-Red', 'Signal K - MQTT Gateway', 'Signal K to Prometheus'
  • Prometheus endpoint will publish all incoming Signal K paths http://localhost:3000/signalk/v1/api/prometheus
  • if temperature needed in OpenCPN, ESP needs to be configured with path 'environment.outside.temperature' instead of 'propulsion.eng.temperature' (check OpenPlotter 2.0 documentation for updates)
  • Convert Signal K to NMEA0183: activate XDR TempAir
  • Configure Signal K - MQTT Gateway: Run local server, pi/raspberry
  • adjust flowOP to 'environment.outside.temperature' (if ESP was set with that), assure pi/raspberry set for MQTT (Security tab)
  • optional: Signal K delta simulator plugin installed and activated, set with 'environment.depth.belowTransducer' + Node-Red: add signalk send node, MQTT output node + Convert Signal K to NMEA0183: activate DBT

ESP8266 unit + DS18B20 Temperature sensor configuration

  • My ESP8266 unit: AI-Thinker ESP-01 with 1MB memory

  • Preparation: flash ai-thinker-v1.1.1.bin using esp8266_flasher.exe with pin GPIO0 and GND connected together , cables not longer than 20cm, prerequisite: 3.3V modified TTL to USB adapter at hand and driver installed. For connections, follow this diagram, 4K7 resistor between GPIO-2 and VCC is needed.

  • Procedure:

    Download and install Arduino IDE

    Clone https://github.com/mxtommy/SigkSens to your PC (by downloading as .zip or use git clone command)

    Follow the 6 steps on https://randomnerdtutorials.com/how-to-install-esp8266-board-arduino-ide

    Follow step 7 + 8 on https://slack-files.com/T02ENM6QA-FC5GCJ88H-a74ea73f0f ('Install Libraries' section). The three below libraries are not published in the library manager, so for each of them: do a git clone + add .zip library (using Arduino IDE) -> https://github.com/Reactduino/Reactduino / https://github.com/me-no-dev/ESPAsyncWebServer / https://github.com/me-no-dev/ESPAsyncTCP

    Open SigkSens.ino which is a part of the SigkSens directory

    Go to the 4th tab (Arduino IDE) and uncomment line 64 of config.h (to enable One-Wire) + In case of ESP-01 unit (instead of ESP-12E), change the number 13 to 2

    Assure Arduino IDE is set to board type 'Generic ESP8266 module', flash size is set to 1M and 64K SPIFFS and COM port to what is found in Device Manager on your PC

    Proceed with flashing the sketch assuring pin GPIO0 and GND are connected together

    Connect to the 'Unconfigured sensor' wifi and launch http://192.168.4.1

    Configure Wifi by entering OpenPlotter SID and password, hostname set to ESP1

    Launch /var/log/syslog on OpenPlotter and search for the latest DHCPOFFER, note the IP address

    Run the below 5 web requests (but replace with the IP from the previous step), the browser should return "success" for each of them

    http://10.10.10.149/setNewHostname?hostname=ESP1
http://10.10.10.149/setSignalKPort?port=3000
http://10.10.10.149/setSignalKHost?host=10.10.10.1
http://10.10.10.149/setSensorAttr?address=28:FF:79:26:81:16:04:41&attrName=tempK&path=propulsion.eng.temperature / comment: replace with the address of your sensor, for the moment the only way to find it is in serial monitor. Keep or replace propulsion.eng.temperature as appropriate
http://10.10.10.149/setSignalKToken?... / comment: replace ... with the token obtained by executing the below command in the home directory on OpenPlotter
signalk-generate-token -u openplotter -e "999d" -s ./.signalk/security.json

  • Last steps: power off/on ESP unit, launch Signal K and see if a new 'ws' provider is shown. Browsing to the sensor's IP should now show both (dummy) systemHz and freeMem values and temperature values as well.

  • Troubleshooting: use tcpdump (OpenPlotter) and Serial monitor (Arduino IDE), debug information is sent during the first few seconds after powering up the ESP8266, it is tricky to have the serial monitor open in time. Assure Arduino IDE is able to communicate with your ESP8266 module by reviewing the settings appropriate to your unit. Check if the websocket is up by launching http://x.x.x.x/getSensorInfo.

Remote control installation

  • Flash OpenWRT on TP-Link TL-MR3020 mini router

  • Router reset procedure: failsafe mode trigger after reset button blinking / telnet to 192.168.1.1 (computer IP to 192.168.1.2 over LAN), jffs2reset -y, reboot -f / Login with root/(empty) and set password same as OpenPlotter

  • OpenWRT initial config: upload mosquitto packages using WinSCP to \tmp / install mosquitto packages using opkg install name_of_the_package link / from base -> libuuid_2.25.2-4 + libpthread_0.9.33.2-1 + librt_0.9.33.2-1 / from packages -> libcares_1.10.0 + libmosquitto-nossl_1.4.7 + mosquitto-client-nossl_1.4.7 + mosquitto-nossl_1.4.7

  • OpenWRT set to both AP mode and client mode following link (In brief: fixed IP, bridge, scan and connect to OP AP, add another wifi interface = AP, set AP security) IP's: 10.10.10.2 LAN + 10.0.0.1xx Wifi (DHCP OpenPlotter), OpenWRT now reachable over http/ssh on 10.10.10.2 (even without LAN cable, if connected to OpenWRT AP)

    Continue instructions on link and execute:

    uci add system button
uci set system.@button[0].button=BTN_1
uci set system.@button[0].action=released
uci set system.@button[0].handler='mosquitto_pub -h 10.10.10.1 -t /test/switch-moved -u pi -P raspberry -m 1'
uci add system button
uci set system.@button[1].button=wps
uci set system.@button[1].action=released
uci set system.@button[1].handler='mosquitto_pub -h 10.10.10.1 -t /test/button-pressed -u pi -P raspberry -m 1'
uci set system.@button[1].min=0
uci set system.@button[1].max=0
uci add system button
uci set system.@button[2].button=wps
uci set system.@button[2].action=released
uci set system.@button[2].handler='mosquitto_pub -h 10.10.10.1 -t /test/switch-moved -u pi -P raspberry -m 1'
uci set system.@button[2].min=1
uci set system.@button[2].max=10
uci add system button
uci set system.@button[3].button=BTN_1
uci set system.@button[3].action=pressed
uci set system.@button[3].handler='mosquitto_pub -h 10.10.10.1 -t /test/switch-moved -u pi -P raspberry -m 1'
uci commit system

Headless Pi Zero W + node-red config

  • flash latest Raspbian image on fully(!) formatted SD-card using Etcher

  • Prepare for headless config via hotspot, use FR country code, see link, use Notepad++, not notepad. (If using ZTE hotspot -> terminal on phone -> su -> cd /data/misc/DHCP -> cat dnsmasq.leases -> ssh pi@192.168.1.xxx)

  • edit /etc/dhcpcd.conf and reboot

    #static IP configuration
interface wlan0
static ip_address=10.10.10.4/24
static routers=10.10.10.1
static domain_name_servers=10.10.10.1

  • Run both these commands:

    ssh pi@10.10.10.4
sudo raspi-config (and enable VNC), use VNC Viewer to remote in

  • install node-red-contrib-counter (offline copy) and node-red-dashboard (OpenPlotter) by copying files over to /home/pi/.node-red/node_modules

  • create /home/pi/filestowatch/switch-moved/switch-moved.txt and /home/pi/filestowatch/button-pressed/button-pressed.txt

  • run sudo systemctl enable nodered.service

  • import flowPiZeroW (node-red) stored in this repository, MQTT nodes are set to connect to OpenPlotter (signalk-node-red), don't forget MQTT Security = OP user/password