converter_components.py

#!/usr/bin/env python3
########################################################################
#
# COPYRIGHT NovAtel Inc, 2022. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
########################################################################
#                            DESCRIPTION
#
# \file converter_components.py
# \brief Demonstrate how to use the Python API for converting OEM
# messages using the low-level components.
########################################################################

import logging
from binascii import hexlify

import novatel_edie as ne
import novatel_edie.oem as oem
from novatel_edie import HEADER_FORMAT, ENCODE_FORMAT, CPP_PRETTY_VERSION, MAX_MESSAGE_LENGTH
import novatel_edie.oem.messages as oem_msgs

from common_setup import setup_example_logging, handle_args


def format_frame(frame, frame_format):
    """Format the frame into a human-readable string."""
    if frame_format in [HEADER_FORMAT.BINARY, HEADER_FORMAT.SHORT_BINARY,
                        HEADER_FORMAT.PROPRIETARY_BINARY,
                        ENCODE_FORMAT.BINARY, ENCODE_FORMAT.FLATTENED_BINARY]:
        return hexlify(frame, sep=" ").decode("ascii").upper()
    return frame


def main():
    """Example framer usage."""
    # Setup logging
    setup_example_logging(logging.WARNING)
    logger = logging.getLogger(__name__)
    logger.info(f"Decoder library information:\n{CPP_PRETTY_VERSION}")

    # Handle CLI arguments
    input_file, encode_format = handle_args(logger)

    # Set up the EDIE components
    framer = oem.Framer()
    framer.report_unknown_bytes = True
    framer.payload_only= False
    framer.frame_json = False
    decoder = oem.Decoder()
    my_filter = oem.Filter()

    with open(input_file, "rb") as input_stream:
        while read_data := input_stream.read(framer.available_space):
            written_bytes = framer.write(read_data)
            if written_bytes != len(read_data):
                raise ne.FailureException(
                    f'Wrote {written_bytes} bytes, expected {len(read_data)} bytes.')
            for frame, meta in framer:
                if meta.format == HEADER_FORMAT.UNKNOWN:
                    continue
                logger.info(f"Framed ({len(frame)}): {format_frame(frame, meta.format)}")

                # Decode the log header.
                header = decoder.decode_header(frame, meta)

                # Filter the log, pass over it if we don't want it.
                if not my_filter.do_filtering(meta):
                    continue

                # Decode the log body.
                payload = frame[meta.header_length:]
                message = decoder.decode_payload(payload, header, meta)

                # Get info from the log.
                if isinstance(message, oem_msgs.RANGE):
                    obs = message.obs
                    for ob in obs:
                        value = ob.psr
                        pass

                # Re-encode the log
                if isinstance(message, oem.Message):
                    encoded_message = message.to_ascii()

if __name__ == "__main__":
    main()