Metadata-Version: 2.1
Name: trident-helix4-parser
Version: 0.1.6
Summary: Parser to read the Trident Sensors Helix 4 SBD message format from a byte stream or SBD file
Home-page: UNKNOWN
Author: Patrick Leibold and contributors, GEOMAR Helmholtz Centre for Ocean Research Kiel
License: NOT FOR PUBLIC USE
Requires-Dist: dataclasses

do not distribute w/o prior consent of author(s)

Description: # Trident Sensors Helix 4 Iridium SBD Message Parser
        
        ## Overview
        The parser reads Trident Sensors Helix 4 Tracker messages from file or byte stream and parses them into TridentHelix4Messages.
        Messages are generated and sent by the Trident Sensors Helix 4 Tracker via Iridium SBD which is commonly used to track buoys and drifters.
        
        A TridentHelix4Message contains:
        * 5 GPS locations (timestamp, latitude, longitude), at intervals of 2 minutes
        * Battery level of the tracker
        * Temperature of the tracker / surrounding environment
        
        As the tracker message format does not provide information on the date of the GPS fixes, 
        the parser must be initialized with an appropriate date.
        The most reasonable option would be to use the timestamp of the SBD email, received from the Iridium satellite gateway.
        Please note that there might be some delay between the transmission of the SBD message and the actual reception of the SBD 
        mail, which can cause inconsistencies at midnight.
        
        ## Code example
        ```python
        parser = TridentHelix4MessageParser(datetime(2019, 11, 05))
        msg = parser.parse_file("data/test_file.sbd")
        
        # Locations
        for location in msg.locations
            print(location)
        
        # Battery level
        print(msg.battery_level)
        
        # Temperature
        print(msg.temperature)
        ```
        
        ## Resources
        * Manual: [docs/AWI_Buoy_HX_4.3_manual.pdf](docs/AWI_Buoy_HX_4.3_manual.pdf)
        * Data sheet: https://www.tridentsensors.com/images/Products/Buoy%20flyer.pdf
        * Product page: https://www.tridentsensors.com/products/19-buoy-tracking-systems/21-buoy-tracking-2
        
Platform: UNKNOWN
Requires-Python: >= 3.6