LoRa_APRS_Meteo

LoRa APRS Meteostation, IGate and Digipeater firmware for LilyGO TTGO

Features: measures temperature, pressure (with BMP280), wind (with hall sensor anemometer - KY-024) and PM (dust) with SPS30, sends meteodata via LoRa APRS, via APRS-IS and/or via own GET requests. Works as a standard LoRa APRS IGate and/or digipeater, reports coverage.

Source code is in src/main.cpp, before running your station please check:

• you have a valid HAM radio license
• you have edited config.h and wrote your own configuration
  
  If you need help or have any questions or suggestions, please reach to me: david(at)ok2dds.cz

  Changes v5.0 (last ver. 4.2)

• added support for SPS30 particulates sensor
  
• redesigned the main meteo dashboard
  
• added SPS30 value to API endpoints (added /reset-sps)
  
• /graphs and /api/graphs-json changed to /charts and /charts-json
  
• /watch removed (replaced with Apple Shortcut and /api/meteo endpoint)
  
• added language.h file for partial translation to other languages

  Setup guide

  1. Download this repository and open it in PlatformIO. It should obtain all dependencies automatically, otherwise they are listed in platformio.ini.
     
  2. Edit include/config.h.
     
  3. Upload to your TTGO desk
     
     For running the temperature/pressure measurement, you will need to use BMP280 sensor. Please solder VCC to 3.3V pin, GND to GND, SCL to IO22 and SDA to IO21.
     For wind measurement, you will have to obtain an anemometer with magnets in it (suggest 3D printed) and KY-024 hall sensor in the anemometer base. Please solder + to 3.3V pin, G to GND and AO to IO35 (you can use also other pins, if you modify the config file). BMP280 often needs a calibration, please write correct offsets to config file. If you don't want to measure wind, turn USE_ANEMOMETER to false. Temperature/pressure sensor is detected automatically, so simply don't connect BMP280 if you don't want to measure temp./pressure. For using SPS30 to measure particulates, solder VCC to 5V pin, GND to GND, SCL to IO22 and SDA to IO21 (it will share pins with BMP280).
     

     Config file documentation

     Use_WiFi true/false - whether to connect to Wi-Fi (enables functions that need internet)
     ssid, password, Hostname - insert your Wi-Fi details and desired hostname (name, under which you will see the station in the LAN)
     
     USE_METEO true/false - enables LoRa APRS meteo beacons
     METEO_BEACON (in minutes), METEO_LAT, METEO_LON, METEO_COMMENT - details for meteo APRS beacon (WX station)
     USE_METEO_STATUS, METEO_STATUS - if you want to air link to your website or other text via status beacon
     GRAPH_LIMIT - how many values should be stored for weather charts. (suggested keeping default)
     USE_ANEMOMETER true/false - if you want to use wind meter, turn on
     USE_PMSENSOR true/false - if you want to use SPS30 sensor for particulates
     Next values are for anemometer calibration. See comments in config.h.
     BMP_OFFSET - calibration of BMP280
     
     USE_IGATE - send received packets to APRS-IS, needs Wi-Fi turned on
     Next values are IGate and APRS-IS settings, please insert your callsign and other values!
     USE_DIGIPEATER - enable digipeating received packets with WIDE1-1 inside
     USE_LASTRX_STATUS - will send a status message via APRS-IS so you can see your station coverage
     HTTP GET DATA UPLOAD - for working with your own systems, will send a GET request with meteo values to the URL you specify every x minutes. (keep default - off=false)
     Please keep all settings you don't understand or need to use, false. Do not use experimental settings as you might overload your local LoRa network with it.
     
     Czech language info: if you want your meteo dashboard to be in Czech, replace include/language.h with language-cs.h file to overwrite the values.
     If you want to translate the meteo station to your language, kindly edit the language.h.
     

     Meteostation Apple Shortcut for your iPhone/Apple Watch

     If you have iPhone, you can download and setup LoRa_APRS_Meteo.shortcut file and setup it on your phone. Download the shortcut file to your iPhone (you need to have installed the Shortcuts app), tap 'Setup shortcut', replace '192.168.1.1' with your meteostation's IP. Then add the shortcut to your iPhone's desktop to get fresh meteo information quickly and easily. The shortcut also works at Apple Watch, so you can have your meteostation also on your wrist!

     API documentation

     If the meteostation is connected to Wi-Fi, it runs a tiny webserver. Some of the endpoints are even suitable for browser use.
     Access your station dashboard with entering your station IP to your browser. For accessing from outside your home network, make sure you open ports 80 and 5028 (websocket).
     Documentation of GET requests (API endpoints) is also in APIdocs.txt
     
     API endpoints with HTML webpage output (with previews)
     / - meteo dashboard with WebSocket (the values update automatically) - WebSocket uses port 5028
     
     
     /lora - station dashboard
     
     
     /charts - charts of weather history
     
     
     
     API command endpoints
     /switch-meteo - meteo APRS beacon on/off
     /switch-aprs - APRS-IS on/off
     /new-aprsis/newServer - change APRS-IS server
     /restart - station restart (all stored values, as minimal and maximal temperature etc. will be lost)
     /tx/custPkt - sends custom packet via LoRa
     /reset-tx - resets timeouts
     /reset-bmp - reset of maximal and minimal temperature and pressure values history
     /reset-temp - reset of maximal and minimal temperature values history
     /reset-press - reset of maximal and minimal pressure values history
     /reset-wind - reset of maximal and minimal wind values history
     /reset-sps - reset of maximal and minimal particulates concentration history
     
     API endpoints suitable for working with your projects providing data in machine-readable format
     /api/meteo - CSV of meteo values
     /api/charts-json - JSON of history of meteo values (same as on /graphs but only values in JSON)
     Example: { "temperature": [ -1.5, 1.38, ... 8.21, 8.35 ], "pressure": [ 1025, 1025, ... 1023, 1023 ], "wind": [ 1.75, 1.5, ... 1.25, 1 ], "pm2.5": [ 10.5, 9.5, ... 7.5, 8.3 ], "pm10": [ 10.5, 9.5, ... 7.5, 8.3 ] } /api/json - complete JSON of all values from your station Example: { "general": { "version": "4.0", "destcall_meteo": "APLDM0", "destcall_igate": "APLDI0", "system_time": 172848, "voltage": 4.14, "battery": 70, "wifi_status": true, "wifi_signal_db": -45, "bmp280_status": true, "sps30_status": true }, "lora": { "meteo_callsign": "OK2DDS-6", "meteo_enabled": true, "igate_callsign": "OK2DDS-1", "aprs_is_enabled": true, "aprs_is_status": true, "aprs_is_server": "czech.aprs2.net", "hall_sensor": 2000, "last_rx": "OK2DDS-7" }, "meteo": { "temperature": 10.0, "pressure": 1013, "pressure_trend": "steady", "actual_wind": 2.25, "long_period_wind": 0.5, "gust": 3.5, "particles": { "status": true, "pm1": 4.74, "pm2.5": 5.01, "pm4": 5.01, "pm10": 5.01, "nc2.5": 37.79, "nc10": 37.81, "typical_particle_size": 0.43 }, "zamretti_index": 8.30, "zambretti_symbol": "☀", "min_temperature": -10, "max_temperature": 30, "min_pressure": 990, "max_pressure": 1020, "max_wind": 4, "max_gust": 6.5, "min_pm": 0.23, "max_pm": 42.22 } }