Package tockloader.tbfh Documentation

Class TBFHeader

Tock Binary Format header class. This can parse TBF encoded headers and return various properties of the application.


def __init__(self, buffer)

Initialize self. See help(type(self)) for accurate signature.


def get_app_name(self)

Return the package name if it was encoded in the header, otherwise return a tuple of (package_name_offset, package_name_size).


def get_app_size(self)

Get the total size the app takes in bytes in the flash of the chip.


def get_binary(self)

Get the TBF header in a bytes array.


def get_header_size(self)

Get the size of the header in bytes. This includes any alignment padding at the end of the header.


def is_enabled(self)

Whether the application is marked as enabled. Enabled apps start when the board boots, and disabled ones do not.


def is_sticky(self)

Whether the app is marked sticky and won't be erase during normal app erases.


def is_valid(self)

Whether the CRC and other checks passed for this header.


def set_flag(self, flag_name, flag_value)

Set a flag in the TBF header.

Valid flag names: enable, sticky


def __str__(self)

Return str(self).


def _checksum(self, buffer)

Calculate the TBF header checksum.