Skip to content

Class VersionHAL

ClassList > VersionHAL

Handles the versioning for the spin board. More...

  • #include <VersionHAL.h>

Public Functions

Type Name
board_version_t getBoardVersion ()
return board version
void setBoardVersion (board_version_t board_version)
Sets the version of the microcontroller board. It can take the following values: nucleo_G474RE, O2_v_0_9, O2_v_1_1_2, SPIN_v_0_1, SPIN_v_0_9, SPIN_v_1_0, TWIST_v_1_1_2 TWIST_v_1_1_3, TWIST_v_1_1_4.

Detailed Description

Note:

Use this element to defined your version of the SPIN board

Public Functions Documentation

function getBoardVersion

return board version 

board_version_t VersionHAL::getBoardVersion ()

Returns:

Return one of these values : nucleo_G474RE, O2_v_0_9, O2_v_1_1_2, SPIN_v_0_1, SPIN_v_0_9, SPIN_v_1_0, TWIST_v_1_1_2 TWIST_v_1_1_3, TWIST_v_1_1_4

function setBoardVersion

Sets the version of the microcontroller board. It can take the following values: nucleo_G474RE, O2_v_0_9, O2_v_1_1_2, SPIN_v_0_1, SPIN_v_0_9, SPIN_v_1_0, TWIST_v_1_1_2 TWIST_v_1_1_3, TWIST_v_1_1_4. 

void VersionHAL::setBoardVersion (
    board_version_t board_version
)

Stand alone versions such as SPIN_v_X comprise only the spin board itself. Legacy versions such as nucleo or O2_X comprise the nucleo board or the old O2 boards. Twist versions comprise all the available Twist connected versions.

Parameters:

  • board_version Enum representing the microcontroller version.

The documentation for this class was generated from the following file docs/core/zephyr/modules/owntech_spin_api/zephyr/src/VersionHAL.h