AFBR-S50 Explorer Application - Util functions

AFBR-S50 Explorer Application - Util functions. More...

Collaboration diagram for AFBR-S50 Explorer Application - Util functions:

Functions
bool	ExplorerApp_SuspendTimerMeasurement (argus_hnd_t *argus)
	Suspends the current active measurement on the device.
status_t	ExplorerApp_StartTimerMeasurement (argus_hnd_t *argus)
	Starts the measurements.
status_t	ExplorerApp_StopTimerMeasurement (argus_hnd_t *argus)
	Stops the measurements and goes to idle state.
status_t	ExplorerApp_SingleMeasurement (argus_hnd_t *argus)
	Triggers a single measurement and goes to idle afterwards.
status_t	ExplorerApp_DeviceAbort (argus_hnd_t *argus)
	Aborts all device activity immediately.
void	ExplorerApp_DisplayUnambiguousRange (argus_hnd_t *argus)
	Displays the unambiguous range in meter on the SLCD display.

Detailed Description

AFBR-S50 Explorer Application - Util functions.

---

Util functions to be used by the rest of the API.

Function Documentation

ExplorerApp_DeviceAbort()

status_t ExplorerApp_DeviceAbort

(

argus_hnd_t *

argus

)

Aborts all device activity immediately.

---

Parameters

argus

The Argus device handler.

Returns

Returns the status (STATUS_OK on success).

ExplorerApp_DisplayUnambiguousRange()

void ExplorerApp_DisplayUnambiguousRange

(

argus_hnd_t *

argus

)

Displays the unambiguous range in meter on the SLCD display.

---

Parameters

argus

The Argus device handler.

ExplorerApp_SingleMeasurement()

status_t ExplorerApp_SingleMeasurement

(

argus_hnd_t *

argus

)

Triggers a single measurement and goes to idle afterwards.

---

Parameters

argus

The Argus device handler.

Returns

Returns the status (STATUS_OK on success).

ExplorerApp_StartTimerMeasurement()

status_t ExplorerApp_StartTimerMeasurement

(

argus_hnd_t *

argus

)

Starts the measurements.

---

Parameters

argus

The Argus device handler.

Returns

Returns the status (STATUS_OK on success).

ExplorerApp_StopTimerMeasurement()

status_t ExplorerApp_StopTimerMeasurement

(

argus_hnd_t *

argus

)

Stops the measurements and goes to idle state.

---

Parameters

argus

The Argus device handler.

Returns

Returns the status (STATUS_OK on success).

ExplorerApp_SuspendTimerMeasurement()

bool ExplorerApp_SuspendTimerMeasurement

(

argus_hnd_t *

argus

)

Suspends the current active measurement on the device.

---

Suspends the currently ongoing measurements on the device by calling the Argus_StopMeasurementTimer method. Further it checks if data evaluation of any raw measurement data is pending and performs a context switch to the corresponding data evaluation task in the task scheduler. After the function returns true, the measurements are suspended and the device is idle and ready to receive other API calls, e.g. configuration updates. If the function returns true, use the ExplorerApp_StartTimerMeasurement to resume the measurement on the device again.

Parameters

argus

The Argus device handler.

Returns

Returns true if the measurements have been suspended and needs to be resumed afterwards.