fitdecode 0.3.0

FIT file parser and decoder

fitdecode

A FIT file parsing and decoding library written in Python3 (3.6+ only).

Usage Example

Read a FIT file, frame by frame:

import fitdecode

with fitdecode.FitReader(src_file) as fit:
    for frame in fit:
        # The yielded *frame* object is of one of the following types:
        # * fitdecode.FitHeader
        # * fitdecode.FitDefinitionMessage
        # * fitdecode.FitDataMessage
        # * fitdecode.FitCRC
        #
        # A fitdecode.FitDataMessage object contains decoded values that are
        # directly usable in your script logic.
        pass

Installation

fitdecode is available on PyPI:

$ pip install fitdecode

Or, to get the latest working version, you can clone fitdecode’s source code repository before installing it:

$ git clone [e-mail]:polyvertex/fitdecode.git
$ cd fitdecode
$ python setup.py test     # optional step to run unit tests
$ python setup.py install

Note that for convenience, the cmd directory located at the root of the source code tree can safely be added to your PATH, so that fitdecode commands can be called without the package to be installed.

Overview

fitdecode is a non offensive and incompatible rewrite of the fitparse library, with some improvements and additional features, as well as efforts made to optimize both speed and memory usage.

Main differences between fitdecode and fitparse:

• fitdecode requires Python version 3.6 or greater

• fitdecode allows concurrent reading of multiple files by being thread-safe, in the sense that fitdecode’s objects keep their state stored locally

• fitdecode high-level interfaces are not compatible with fitparse’s FitFile

• fitdecode does not discard the FIT header and the CRC footer while iterating a file, which allow to get a complete 1:1 representation of the file that is being read

• This also allows the client to easily deal with so-called chained FIT files, as per FIT SDK definition (i.e. concatenated FIT files)

• fitdecode offers optional access to records, headers and footers in their binary form, to allow FIT file cutting, stitching and filtering at binary level

Why a new library?

A new library has been created instead of just offering to patch fitparse because many changes and adds in fitdecode break fitparse’s backward compatibilty and because it allowed more freedom during the development of fitdecode.

Documentation

Documentation is available at http://fitdecode.readthedocs.io/

License

This project is distributed under the terms of the MIT license. See the LICENSE.txt file for details.

Credits

fitdecode is largely based on the generic approach adopted by fitparse to define FIT types and to decode raw values. That includes the module profile.py and all the classes it refers to, as well as the script generate_profile.py.

Change Log

v0.3.0 (2018-07-27)

• Added fitdecode.utils.get_mesg_field

• Added fitdecode.utils.get_mesg_field_num

• Minor improvements and corrections

v0.2.0 (2018-07-16)

• Added FieldData.name_or_num

• Added FitDataMessage.get_fields

• Added FitDataMessage.get_values

• Improved FitDataMessage.get_field (idx arg)

• Improved FitDataMessage.get_value (idx arg)

• Completed documentation of FitDataMessage

• Improved documentation of FieldData

• FitReader’s internal state is reset as well after a FitCRC has been yielded (i.e. not only when a FIT header is about to be read), in order to avoid incorrect behavior due to malformed FIT stream

v0.1.0 (2018-07-14)

• Added class property frame_type (read-only) to FitHeader, FitCRC, FitDefinitionMessage and FitDataMessage (records module) to ease and speed up type checking

• Added FitDataMessage.get_value method

• string values with no null byte are still decoded (in full length)

• cmd directory added to the source code tree for convenience

v0.0.1 (2018-07-08)

• First release

v0.0.0 (2018-05-31)

• Birth!