adding position and telemetry to db

Author: EricAndrechek

balloon-tracker/hardware/README.md

@@ -1,65 +1,95 @@
 ![Banner](https://github.com/trackuino/trackuino/wiki/img/trackuino-banner-narrow.png)
 
-The software and hardware for Trackuino, an open-source APRS tracker based on the Arduino platform. It was designed primarily to track high altitude balloons, so it has other handy features like reading temperature sensors and a buzzer for acoustic location.
+The software and hardware for Trackuino-v2, an open-source APRS tracker based on the Arduino platform. It was designed primarily to track high altitude balloons, so it has other handy features like reading temperature sensors and a buzzer for acoustic location.
 
 Trackuino is intended for use by licensed radio amateurs.
 
 # Features
 
-- Arduino form factor (support for Arduino Nano, Uno, and Mega)
-- Fully modular, choose the daughterboards you want to use and print/buy them and the motherboard that fits your Arduino
+- Arduino form factor (support for Arduino Nano, others coming soon:tm:)
+- Fully modular, choose the daughterboard you want to use and print/buy them and the motherboard that fits your Arduino
 - Onboard and external LED headers for module status indications
 - Internal/external temperature sensors to read temperature in and outside the payload
 - Active/passive buzzer support to ease acoustic payload location
 - Support for custom additional analog and digital sensors
 - Open source (GPLv2 license), both software and hardware. In other words, do whatever you want with it: modify it, add it to your project, etc. as long as you open-source your modifications as well.
 
-## Modules
+## Built-In Modules
 
-Choose whatever modules you want to use and add them onto your motherboard.
+The following modules are included on the motherboard:
 
 ### GPS Module
 
-- Any GPS module that outputs NMEA strings (e.g. SiRF, UBLOX, etc.) is supported
-- GPS used needs 5V, GND, RX, and TX pins
+- UBLOX MAX-M10S GPS chip
 
-### GSM Cellular Module
+### MicroSD Card Local Storage
 
-- Allows sending data to a GSM network (e.g. AT&T, T-Mobile, etc.) via web requests or SMS messages
-- Configuration for message format and destination phone number or URL
+- MicroSD card writing for an on-board copy of recorded data
+- Supports CSV format writing of data
+- Raw data dumping option
+- Custom pre-save formatting option (can convert raw analog input to temperature with given formula, etc.)
 
-### Radio Module
+### LoRa Radio Module
 
-- Radio: Radiometrix's HX1 (300 mW).
-- 1200 bauds AFSK using 8-bit PWM
-- Sends out standard APRS position messages (latitude, longitude, altitude, course, speed and time).
-- SMA female plug for radio out
+- Radio: RFM95W
+- 915MHz frequency (tuneable to others for different regions)
+- 20dBm output power
+- Used to send data in addition to daughterboard modules, allows 2-way communication
 
-### SD Card Local Storage Module
+### Flight Termination Unit (FTU) Transmitter Module
 
-- OpenLog SD Card writing for an on-board copy of recorded data
-- Supports CSV format writing of data
-- Raw data dumping option
-- Custom pre-save formatting option (can convert raw analog input to temperature with given formula, etc.)
+- Modified [315MHz transmitter](https://www.adafruit.com/product/1095) for sending digital FTU signals
 
-### Buzzer Module
+### Buzzer
 
 - Active buzzer for acoustic payload location
 - Supports GPS readings for variable buzzing based on altitude or satellite lock
 
+### Temperature Sensors
+
+- Internal and external temperature sensors
+- TMP36 analog temperature sensor
+
+### LED Indicators
+
+- Onboard and external LED headers for module status indications
+- Customizable LED blinking patterns for different module statuses
+
+## Daughterboard Modules
+
+In addition to the main motherboard, you can attach any one of the following daughterboards to the motherboard via the molex connector for additional functionality.
+
+### GSM Cellular Module
+
+**Note**: Work in progress
+
+- Allows sending data to a GSM network (e.g. AT&T, T-Mobile, etc.) via web requests or SMS messages
+- Configuration for message format and destination phone number or URL
+
+### HAM Radio APRS Module
+
+- Radio: DORJI DRA818V
+- 1200 baud AFSK using 8-bit PWM
+- Sends out standard APRS position messages (latitude, longitude, altitude, course, speed and time), and telemetry data
+- SMA plug for radio out
+
+### Iridium Satellite Module
+
+- RockBLOCK 9603 Iridium satellite modem
+
 # Setup
 
-Use the `Download ZIP` button or [click here](https://github.com/EricAndrechek/trackuino-v2/archive/refs/heads/main.zip) to get the source code and board schematics.
+Use the `Download ZIP` button or [click here](https://github.com/EricAndrechek/trackuino-v2/archive/refs/heads/main.zip) to get the source code and board schematics. The hardware is designed in KiCad and the software is written in C++ for the Arduino platform.
 
-## Choosing Boards
+Navigate to the `balloon-tracker/hardware` directory to find the KiCad files for the motherboard and daughterboard modules. Navigate to the `balloon-tracker/software` directory to find the Arduino sketch for the firmware.
 
-Choose the motherboard you want to use based on what Arduino/MCU form factor you plan to use. The larger the Arduino/MCU and therefore motherboard, the more modules you will be able to add.
+## Choosing Boards
 
-After selecting your motherboard, you can choose the modules you want to use. You can add as many modules as you want so long as they all fit on the motherboard. One of these modules needs to be the power daughterboard.
+Choose the motherboard you want to use based on what Arduino/MCU form factor you plan to use.
 
-**Important**: Pay attention to the voltage your Arduino is using. If you are unsure, check [this page](https://learn.sparkfun.com/tutorials/arduino-comparison-guide/totally-tabular) to find out. If your MCU is 3.3V, you will need to print the 3.3V power daughterboard, if it is 5V, you will need to print the 5V power daughterboard.
+After selecting your motherboard, you can choose the daughterboard you want to use.
 
-Select all motherboards and module daughter boards you would like to use, and find somewhere online to get them printed.
+Select all motherboards and daughterboards you would like to use, and find somewhere online to get them printed. You will need to open the KiCad files in KiCad and export the gerber files (and drill files) to send to a PCB printing service.
 
 ## Soldering
 
@@ -75,15 +105,15 @@ Unzip the software in your sketches directory and load it up by double-clicking
 
 The single most important configuration file is `config.h`. The file is self-documented. Here is where you set up your callsign, module settings, and more.
 
-Some modules, like GSM, allow you to make additional configuration changes in their own custom, self-documented files so that you can do things like specify a JSON format for data to be sent through.
+Some daughterboards, like GSM, allow you to make additional configuration changes in their own custom, self-documented files so that you can do things like specify a JSON format for data to be sent through.
 
 ## Flashing
 
-**Important**: When flashing the Arduino, remove the it from the motherboard. After flashing the firmware, you can plug it back in. The GPS, OpenLog, and the host computer share the same serial port on the AVR, so they will conflict when used together.
+**Important**: When flashing the Arduino, remove the it from the motherboard. After flashing the firmware, you can plug it back in. The GPS, microSD card module, and the host computer share the same serial port on the AVR, so they will conflict when used together.
 
 Within the Arduino IDE, be sure to select the correct board type for your Arduino.
 
-While trackuino.ino is opened in the Arduino IDE, select the `Program` tab and click the `Upload` button.
+While `software.ino` is opened in the Arduino IDE, select the `Program` tab and click the `Upload` button.
 
 ## Debugging
 

balloon-tracker/readme.md

@@ -53,14 +53,6 @@ APRS IS:
   host: rotate.aprs2.net
   port: 14580
 
-Telemetry:
-  # Whether to send telemetry packets such as GS cpu, ram, etc
-  enabled: true
-
-  # How often to send ground station telemetry packets (in seconds)
-  # these do not show up on aprs.fi
-  telemetry interval: 10
-
 GPS:
   # Whether to use a USB GPS
   # If false, the ground station will not send any position update packets

ground-station/config.yaml

@@ -52,14 +52,6 @@ def __init__(self):
         self.client.on_connect = self.on_connect
         self.client.on_disconnect = self.on_disconnect
 
-        if config.telemetry.enabled:
-            # run daemon thread to send telemetry every config.telemetry.telemetry_interval seconds
-            
-            from threading import Thread
-            self.telemetry_thread = Thread(target=self.telemetry_daemon, daemon=True, name="Telemetry Daemon")
-            self.telemetry_thread.daemon = True
-            self.telemetry_thread.start()
-
     def on_message(self, client, userdata, msg):
         print(parse_topic(msg.topic) + " " + msg.payload.decode())
 
@@ -68,33 +60,10 @@ def on_connect(self, client, userdata, flags, rc):
 
     def on_disconnect(self, client, userdata, rc):
         print("Disconnected - " + parse_rc(rc))
-    
-    def send_telemetry(self):
-        cpu = "{:.2f}".format(psutil.cpu_percent()) + "%"
-        memory = "{:.2f}".format(psutil.virtual_memory().percent) + "%"
-        total_memory = humanfriendly.format_size(psutil.virtual_memory().total)
-        disk = "{:.2f}".format(psutil.disk_usage('/').percent) + "%"
-        total_disk = humanfriendly.format_size(psutil.disk_usage('/').total)
-        network = humanfriendly.format_size(psutil.net_io_counters().bytes_sent + psutil.net_io_counters().bytes_recv)
-        uptime = humanfriendly.format_timespan(time.mktime(time.localtime()) - psutil.boot_time())
-
-        self.client.publish(f"{self.station}/cpu", cpu, qos=0, retain=True)
-        self.client.publish(f"{self.station}/memory", memory, qos=0, retain=True)
-        self.client.publish(f"{self.station}/total-memory", total_memory, qos=0, retain=True)
-        self.client.publish(f"{self.station}/disk", disk, qos=0, retain=True)
-        self.client.publish(f"{self.station}/total-disk", total_disk, qos=0, retain=True)
-        self.client.publish(f"{self.station}/network", network, qos=0, retain=True)
-        self.client.publish(f"{self.station}/uptime", uptime, qos=0, retain=True)
-
-    def telemetry_daemon(self):
-        while True:
-            self.send_telemetry()
-            time.sleep(config.telemetry.telemetry_interval)
-
 
 # Main Loop
 
 if __name__ == "__main__":
     client = GS_Client()
     while True:
-        time.sleep(1)
+        time.sleep(1)

ground-station/utilities/connection.py

@@ -7,30 +7,31 @@
 # data upload endpoints
 
 # upload should take data in the formats json and aprs, where data is replace with the aprs string or json object
-# {
-#     "callsign": "N0CALL",
-#     "ssid": 0,
-#     "timestamp": "2021-01-01T00:00:00Z",
-#     "type": "json",
-#     "data": {
-#         "callsign": "N0CALL",
-#         "ssid": 0,
-#         "symbol": "/",
-#         "lat": 0.0,
-#         "lon": 0.0,
-#         "alt": 0.0,
-#         "course": 0.0,
-#         "speed": 0.0,
-#         "comment": "test comment"
-#         "telemetry": {
-#             "battery": 0.0,
-#             "temperature": 0.0,
-#             "humidity": 0.0,
-#             "pressure": 0.0
-#         }
-#     }
-# }
+example = {
+    "callsign": "N0CALL",
+    "ssid": 0,
+    "timestamp": "2021-01-01T00:00:00Z",
+    "type": "json",
+    "data": {
+        "callsign": "N0CALL",
+        "ssid": 0,
+        "symbol": "/",
+        "lat": 0.0,
+        "lon": 0.0,
+        "alt": 0.0,
+        "course": 0.0,
+        "speed": 0.0,
+        "comment": "test comment",
+        "telemetry": {
+            "battery": 0.0,
+            "temperature": 0.0,
+            "humidity": 0.0,
+            "pressure": 0.0
+        }
+    }
+}
 
+# JSON upload route
 @data_app.route('/upload', methods=['POST'])
 def api_upload():
     data_obj = Data()
@@ -40,7 +41,9 @@ def api_upload():
     try:
         data = request.get_json()
     except Exception as e:
-        return "invalid json", 400
+        # if data is not in json format, return error and show expected format with 400 status code
+        # TODO: ideally prettier formatted json example?
+        return "Data must be in json format. Example: " + str(example), 400
 
     # accept upload data
     try:
@@ -49,8 +52,7 @@ def api_upload():
         return e, 400
 
     # check if sender matches token
-    if not data_obj.check_token(request.headers.get('Authorization')):
-        return "invalid token", 401
+    data_obj.check_token(request.headers.get('Authorization'))
 
     # get ip address of client
     data_obj.get_client_ip(request)
@@ -69,4 +71,4 @@ def api_upload():
         elif status_code == 208:
             return "Data already exists", 208
     except Exception as e:
-        return e, 400
+        return e, 400

tracking-dashboard/backend/api/data.py

@@ -6,13 +6,16 @@
 
 @db_app.route('/db', methods=['DELETE'])
 def api_db_delete():
-    # TODO: call the delete method of the db class (need to figure out context of db class)
+    # call the delete method of the db class
+    # TODO: implement delete method (need to figure out context of db class) <-- I don't remember what I meant when I wrote this...
+    # TODO: need authorization
     return "not implemented", 501
 
 @db_app.route('/db', methods=['GET'])
 def api_db_get():
-    # TODO: get the current db file and return it
+    # get all data from the db and return the files as a downloadable zip
+    # TODO: need to implement, probably need to run as a background job...
     return "not implemented", 501
 
 # TODO: allow getting specific tables from the db and render them in the browser
-# maybe just redirect to pgadmin instead?
+# maybe just redirect to pgadmin instead?

tracking-dashboard/backend/api/db.py

@@ -12,6 +12,8 @@
 # pull the latest version of the repo from github
 @server_app.route('/pull', methods=['GET'])
 def api_pull():
+    # TODO: very janky and could break prod, maybe do something as a background job instead?
+
     # ensure that the auth header is present and correct bearer token
     if 'Authorization' not in request.headers or request.headers.get('Authorization') != ('Bearer ' + config.push_key):
         return jsonify({'error': 'invalid authorization header'}), 401
@@ -35,11 +37,34 @@ def api_pull():
     return jsonify({'pull': pull_result.stdout.decode('utf-8'), 'install': install_result.stdout.decode('utf-8')})
 
 
+# allow getting and setting the config file from api route
+# dangerous - breaking change could disable the server
+@server_app.route('/config', methods=['GET', 'POST'])
+def api_config():
+    # ensure that the auth header is present and correct bearer token
+    if 'Authorization' not in request.headers or request.headers.get('Authorization') != ('Bearer ' + config.push_key):
+        return jsonify({'error': 'invalid authorization header'}), 401
+
+    if request.method == 'GET':
+        return jsonify(config)
+    elif request.method == 'POST':
+        # update the config with the new values
+        new_config = request.get_json()
+        for key in new_config:
+            config[key] = new_config[key]
+        
+        # write the new config to the config file
+        with open('config.json', 'w') as config_file:
+            json.dump(config, config_file, indent=4)
+        
+        return jsonify(config)
+
+
 @server_app.route('/health', methods=['GET'])
 def api_health():
     # return current date and time
     to_return = {
         'status': 'ok',
         'time': datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
     }
-    return jsonify(to_return)
+    return jsonify(to_return)

tracking-dashboard/backend/api/server.py

@@ -8,6 +8,7 @@
 
 @status_app.route('/status', methods=['GET'])
 def status_api():
+    # TODO
     # for now, we do Status().status every time
     # once we have a job scheduler, we can just return the .status value and not redefine Status() every time
-    return jsonify(Status().status)
+    return jsonify(Status().status)