Version¶

Provides version access utilities.

brainstem.version.get_version_string(packed_version=None, buffer_length=256)[source]¶

Gets the version string from a packed version.

Parameters:

packed_version (unsigned int) – If version is provided, it is unpacked and presented as the version string. Most useful for printing the firmware version currently installed on a module.
buffer_length (unsigned short) – The amount of C memory to allocate

Returns:

The library version as a string

Return type:

str

brainstem.version.unpack_version(packed_version)[source]¶

Unpacks a packed version.

Parameters:: packed_version (unsigned int) – The packed version number.
Returns:: Returns the library version as a 3-tuple (major, minor, patch)
Return type:: str