AFBR-S50 Explorer - Explorer Device functions

AFBR-S50 Explorer - Explorer Device functions. More...

Collaboration diagram for AFBR-S50 Explorer - Explorer Device functions:

Functions
argus_hnd_t *	ExplorerApp_GetArgusPtr (sci_device_t deviceID)
	Gets the Argus device instance handle pointer.
explorer_t *	ExplorerApp_GetExplorerPtr (sci_device_t deviceID)
	Gets the Explorer instance handle pointer.
explorer_t *	ExplorerApp_GetExplorerPtrFromArgus (argus_hnd_t *argus)
	Gets the Explorer instance handle pointer given an Argus handle pointer.
sci_device_t	ExplorerApp_GetDeviceID (explorer_t *explorer)
	Gets the device ID of the specified Explorer instance pointer.
uint8_t	ExplorerApp_GetInitializedExplorerCount ()
	Gets the number of initialized Argus sensor devices.
explorer_t *	ExplorerApp_GetInitializedExplorer (uint8_t index)
	Gets the initialized Explorer instance handle pointer given its index in the list. This is used to obtain a consecutive list of instances, regardless of their DeviceID (the DeviceID could be non-consecutive).
status_t	ExplorerApp_InitDevice (explorer_t *explorer, argus_mode_t mode, bool reinit)
	Initializes the associated Argus device handle belonging to an Explorer instance handle pointer.
status_t	ExplorerApp_DeviceReinit (explorer_t *explorer, argus_mode_t mode)
	Reinitializes the device w/ default settings w/o MCU reset.
status_t	ExplorerApp_InitExplorer (sci_device_t deviceID)
	Initializes the selected Explorer instance handle pointer with the selected device ID.

Detailed Description

AFBR-S50 Explorer - Explorer Device functions.

---

Util functions for handling the Explorer device to be used by the rest of the API.

Function Documentation

ExplorerApp_DeviceReinit()

status_t ExplorerApp_DeviceReinit	(	explorer_t *	explorer,
		argus_mode_t	mode
	)

Reinitializes the device w/ default settings w/o MCU reset.

---

Parameters

explorer	The AFBR-Explorer control block.
mode	The measurement mode to initialize with.

Returns

Returns the status (STATUS_OK on success).

ExplorerApp_GetArgusPtr()

argus_hnd_t * ExplorerApp_GetArgusPtr

(

sci_device_t

deviceID

)

Gets the Argus device instance handle pointer.

---

Parameters

deviceID

The Device ID of the selected Argus sensor.

Returns

Returns the Argus device instance handle pointer.

ExplorerApp_GetDeviceID()

sci_device_t ExplorerApp_GetDeviceID

(

explorer_t *

explorer

)

Gets the device ID of the specified Explorer instance pointer.

---

Parameters

explorer

The AFBR-Explorer control block.

Returns

The Device ID of the selected Explorer instance.

ExplorerApp_GetExplorerPtr()

explorer_t * ExplorerApp_GetExplorerPtr

(

sci_device_t

deviceID

)

Gets the Explorer instance handle pointer.

---

Parameters

deviceID

The Device ID of the selected Argus sensor.

Returns

Returns the Explorer instance handle pointer.

ExplorerApp_GetExplorerPtrFromArgus()

explorer_t * ExplorerApp_GetExplorerPtrFromArgus

(

argus_hnd_t *

argus

)

Gets the Explorer instance handle pointer given an Argus handle pointer.

---

Parameters

argus

The Argus device pointer of the selected Argus sensor.

Returns

Returns the Explorer instance handle pointer.

ExplorerApp_GetInitializedExplorer()

explorer_t * ExplorerApp_GetInitializedExplorer

(

uint8_t

index

)

Gets the initialized Explorer instance handle pointer given its index in the list. This is used to obtain a consecutive list of instances, regardless of their DeviceID (the DeviceID could be non-consecutive).

---

Parameters

index

Index of the initialized Explorer instance.

Returns

Returns the selected Explorer instance handle pointer.

ExplorerApp_GetInitializedExplorerCount()

uint8_t ExplorerApp_GetInitializedExplorerCount

(

)

Gets the number of initialized Argus sensor devices.

---

Returns

Returns the number of initialized Argus sensor devices.

ExplorerApp_InitDevice()

status_t ExplorerApp_InitDevice	(	explorer_t *	explorer,
		argus_mode_t	mode,
		bool	reinit
	)

Initializes the associated Argus device handle belonging to an Explorer instance handle pointer.

---

Parameters

explorer	Explorer instance handle pointer to be initialized.
mode	Selected mode for the Argus sensor device.
reinit	Indicate whether the device should first be deinitialized.

Returns

Returns the status (STATUS_OK on success).

ExplorerApp_InitExplorer()

status_t ExplorerApp_InitExplorer

(

sci_device_t

deviceID

)

Initializes the selected Explorer instance handle pointer with the selected device ID.

---

Parameters

deviceID

The Device ID of the selected Argus sensor.

Returns

Returns the status (STATUS_OK on success).