ODAK Air Quality Monitor GUI

A desktop application built with Electron for interfacing with ODAK Air Quality Monitoring devices.

Features

• Real-time Monitoring: Live display of air quality parameters including temperature, humidity, CO₂, VOC, PM1.0, PM2.5, PM10, pressure, elevation, and battery levels
• Visualized Data: Line charts for all sensor readings with time-based tracking
• CLI Interface: Built-in command-line interface to communicate directly with the device
• Device Configuration: Easy adjustment of device settings like language, measurement frequency, and display units
• Sensor Calibration: Tools for calibrating all sensors with offset and multiplier values
• Data Logging: Export sensor data to log files for record keeping and analysis
• Firmware Updates: Checks your Odak's firmware, offers the latest version for your board (v1 or v2) and installs it; see docs/FIRMWARE_UPDATES.md
• Device Clock: Sets the device clock from this computer (manually or automatically on connect) and shows the device's own time
• My Plan: Set when you wake, focus, rest and sleep (weekdays and weekend) and choose up to two priorities: allergy, infection, fatigue & migraine, or focus & productivity
• Insights: Day, week, month and 6-month views of the measurements stored on the device, rated per part of your day exactly like the device's screens (a night belongs to the day you wake into)
• Air Coach results: How many actions Odak suggested, how many you did, how often the air improved or a bad part of the day was prevented, and how your exposure changed for each of your priorities
• Import and export: Save a backup with measurements, Air Coach history and your plan, and import it (or a saved CSV/JSON history) by drag and drop
• Device History: Downloads the measurements stored in the device's flash memory ($DATA_DUMP) and saves them as CSV or JSON, with local time and pollutant names added
• Auto Reconnect: Reconnects by itself after a system reset, firmware update or replug

Installation

Prerequisites

• Node.js (v22.13 or higher)
• npm (v11.2 or higher)

Setup

1. Clone the repository

git clone https://github.com/mountainlabs-dev/odak-gui.git
cd odak-gui

2. Install dependencies

npm install

3. Start the application

npm start

Building Distributables

To build the application for distribution:

npm run make

This will create platform-specific distribution packages in the out directory.

Linux (Pardus 25, Debian, Ubuntu)

Build a .deb package (requires dpkg and fakeroot):

npm run make -- --targets @electron-forge/maker-deb

Install it:

sudo apt install ./out/make/deb/x64/odak-gui_0.7.0_amd64.deb

The package installs a udev rule (/etc/udev/rules.d/60-odak.rules) that gives the logged-in user access to the device and stops ModemManager from probing it. Unplug and replug the device after installing. When running from source instead (npm start), add your user to the dialout group and log in again:

sudo usermod -aG dialout $USER

Firmware updates on Linux use udisks2 to mount the RPI-RP2 drive if the desktop does not mount it automatically.

macOS

Download the .dmg for your Mac (arm64 for Apple Silicon, x64 for Intel) and drag the app to Applications. The app is not yet signed with an Apple Developer ID, so the first time you open it macOS says it cannot verify the developer: click Done, then open System Settings → Privacy & Security and click Open Anyway. If it still won't open, clear the download quarantine flag:

xattr -cr "/Applications/Mountain Labs.app"

Usage

Connecting to a Device

1. Connect your ODAK device to your computer via USB
2. In the application, select the appropriate port from the dropdown menu
3. Click the "Connect" button
4. Once connected, the dashboard will display real-time sensor readings

CLI Interface

The application includes a built-in CLI that allows you to:

• View and modify device settings
• Calibrate sensors
• Reset the device
• Control logging levels

Common commands:

• $HELP - Display available commands
• $GET_SETTINGS - Show current device settings
• $CAL_PRINT - View all calibration values
• $SYS_RST - Reset the device
• $EXIT - Exit calibration mode

For detailed CLI documentation, refer to the ODAK_CLI.md file.

Data Logging

1. Toggle the logging switch in the "Data Logging" panel
2. Select a location to save the log file
3. The application will automatically save sensor readings to the selected file

Firmware Updates

1. Navigate to the "Firmware Update" tab
2. Select a firmware file (.uf2)
3. Click "Update Firmware" to begin the update process

Configuration Options

Device Settings

• Language: Turkish or English
• Measurement Frequency: 3, 5, or 10 minutes
• Measurement Type: Celsius/Meter or Fahrenheit/Feet
• Buzzer: Enable or disable sound alerts
• Installation: Request or cancel installation status
• Startup Mode: Configure automatic startup mode

Sensor Calibration

Each sensor can be calibrated with:

• Offset: Adds or subtracts a fixed value
• Multiplier: Scales the measured value

Sensor Parameters

The application monitors and displays the following parameters:

Parameter	Unit	Description
Temperature	°C or °F	Ambient temperature
Humidity	%	Relative humidity
CO₂	ppm	Carbon dioxide concentration
VOC	mg/m³	Volatile organic compounds
PM1.0	µg/m³	Particulate matter (1.0 micron)
PM2.5	µg/m³	Particulate matter (2.5 microns)
PM10	µg/m³	Particulate matter (10 microns)
AQI	-	Air Quality Index
Pressure	hPa	Atmospheric pressure
Elevation	m or ft	Altitude above sea level
Battery	%	Device battery level

Development

Project Structure

odak-gui/
│
├── src/
│   ├── index.html      # Main application layout
│   ├── index.js        # Main process entry point
│   ├── preload.js      # Bridge between renderer and main
│   ├── renderer.js     # Renderer process logic
│   ├── styles.css      # Application styling
│   │
│   └── modules/        # Feature modules
│       ├── chart-management.js   # Chart visualization
│       ├── cli-interface.js      # CLI functionality
│       ├── data-logging.js       # Data logging features
│       ├── dom-elements.js       # DOM element references
│       ├── error-handling.js     # Error management
│       ├── firmware-update.js    # Firmware update logic
│       └── port-management.js    # Serial port handling
│
├── forge.config.js     # Electron Forge configuration
├── package.json        # Project metadata and dependencies
└── README.md           # Project documentation

Technologies Used

• Electron: Cross-platform desktop app framework
• Chart.js: Data visualization library
• Bootstrap: UI framework for responsive design
• Serialport: Serial communication library

Repository layout

Folder	What it holds
src/	The desktop app (Electron): main process, window, Insights, firmware updates
web/	The same app for Chrome and Edge, talking to Odak through Web Serial
firmware/	firmware.json, the list of the newest Odak firmware per board that the app checks
snap/, packaging/	Ubuntu snap, Microsoft Store and .deb packaging
docs/	Publishing, firmware updates, store listing, privacy policy

Odak firmware files are published as firmware-* releases of this repository; see docs/FIRMWARE_UPDATES.md. The firmware source code is not part of this repository.

Contributing

Issues and pull requests are welcome at https://github.com/mountainlabs-dev/odak-gui. Every pull request is built for Linux and Windows by GitHub Actions. Please test changes with a real Odak when they touch the serial connection or firmware updates.

License

MIT, see LICENSE. Odak and Mountain Labs are trademarks of Mountain Labs Teknoloji AŞ.

Troubleshooting

Common Issues

• Device Not Detected: Ensure the device is properly connected
• Connection Failed: Try a different USB port or cable
• Data Not Updating: Restart the device and reconnect
• Firmware Update Failed: Ensure you're using the correct firmware file and the device is properly connected
• Permission denied on /dev/ttyACM0 (Linux): Install the .deb package (adds a udev rule) or add your user to the dialout group and log in again