ClearCore Library
Loading...
Searching...
No Matches
List of all members | Public Types | Public Member Functions
ClearCore::SysManager Class Reference

Detailed Description

ClearCore Board Supervisory System Manager.

This class manages the features of the Teknic ClearCore board.

ClearCore Board Supervisory System Manager. More...

#include <SysManager.h>

Public Types

enum  ResetModes { RESET_NORMAL , RESET_TO_BOOTLOADER }
 Reset modes for the ClearCore board. More...
 

Public Member Functions

ConnectorConnectorByIndex (ClearCorePins connectorIndex)
 Pin-determined accessor for ClearCore Connector objects.
 
void ResetBoard (ResetModes mode=RESET_NORMAL)
 Resets the ClearCore.
 

Member Enumeration Documentation

◆ ResetModes

Reset modes for the ClearCore board.

Enumerator
RESET_NORMAL 

Reset and restart normal program execution.

RESET_TO_BOOTLOADER 

Reset and start up in the bootloader.

Member Function Documentation

◆ ConnectorByIndex()

Connector * ClearCore::SysManager::ConnectorByIndex ( ClearCorePins  connectorIndex)

Pin-determined accessor for ClearCore Connector objects.

// Save and cast a pointer to the IO-3 connector object.
// Be sure to cast the base Connector pointer to the correct type!
@ CLEARCORE_PIN_IO3
[03] IO-3 ClearCore::DigitalInOut Connector
Definition SysConnectors.h:59
ClearCore digital output connector class.
Definition DigitalInOut.h:60
Connector * ConnectorByIndex(ClearCorePins connectorIndex)
Pin-determined accessor for ClearCore Connector objects.
SysManager SysMgr
System manager.
Definition MotorDriver.h:59
Parameters
[in]connectorIndexThe index in the connector array
Returns
A pointer to a connector. If the connector is out of range, a NULL pointer is returned.

◆ ResetBoard()

void ClearCore::SysManager::ResetBoard ( ResetModes  mode = RESET_NORMAL)

Resets the ClearCore.

// Reset the ClearCore and restart the application from the beginning.
void ResetBoard(ResetModes mode=RESET_NORMAL)
Resets the ClearCore.
Parameters
[in]modeThe reset mode. Valid reset modes are:

The documentation for this class was generated from the following file: