metisvela / sailtrack-monitor

On board monitor of the SailTrack system for visualizing real time data for the crew.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SailTrack Monitor

SailTrack Moitor is a component of the SailTrack system, it displays data to the onboard crew using the e-paper technology in order to achieve the best readability under bad sunlight conditions. To learn more about the SailTrack project, please visit the project repository.

The SailTrack Monitor module is based on a battery powered LilyGo EPD47, consisting of an ESP32 microcontroller, connected to an e-paper display. For a more detailed hardware description of the module, please refer to the Bill Of Materials. The 3D-printable enclosure con be found here.

The module performs the following tasks:

  • It gets up to 4 metrics from the SailTrack Network and displays them in the e-paper display with a refresh rate up to 2 Hz.


module-image

Installation

Follow the instructions below to get the SailTrack Monitor firmware correctly installed. If you encounter any problem, please open an issue.

  1. Install PlatformIO Core.
  2. Clone the SailTrack Monitor repository:
    git clone https://github.com/metisvela/sailtrack-monitor.git 
    
  3. Cd into the directory:
    cd sailtrack-monitor
    
  4. Connect the module with an USB cable.
  5. Finally, flash the firmware:
    pio run
    

Usage

Once the firmware is uploaded the module can work with the SailTrack system. When SailTrack Monitor is turned on, the SailTrack logo will appear on the screen, meaning that the module is trying to connect to the SailTrack Network. Once the module is connected the SailTrack logo will disappear and the metrics will start updating on the screen.

Contributing

Contributors are welcome. If you are a student of the University of Padova, please apply for the Metis Sailing Team in the website, specifying in the appliaction form that you are interested in contributing to the SailTrack Project. If you are not a student of the University of Padova, feel free to open Pull Requests and Issues to contribute to the project.

License

Copyright © 2023, Metis Sailing Team. SailTrack Monitor is available under the GPL-3.0 license. See the LICENSE file for more info.

About

On board monitor of the SailTrack system for visualizing real time data for the crew.

License:GNU General Public License v3.0


Languages

Language:C 98.2%Language:C++ 1.8%