System

Functions related to system status and control. More...

Collaboration diagram for System:

Classes
struct	Bs120xOpModeConfig
	BS1201 operational mode configuration structure. More...
struct	Bs120xStatus
	BS1201 status structure. More...

Functions
int	Bs120xEnet_SetOpModeConfig (Bs120xEnetHandle handle, struct Bs120xOpModeConfig config)
	Configures the operating mode of the unit.
int	Bs120xEnet_GetStatus (Bs120xEnetHandle handle, struct Bs120xStatus *status_out)
	Gets the status of the unit.
int	Bs120xEnet_Reset (Bs120xEnetHandle handle)
	Commands the unit to reset.

Detailed Description

Functions related to system status and control.

Function Documentation

Bs120xEnet_GetStatus()

int Bs120xEnet_GetStatus	(	Bs120xEnetHandle	handle,
		struct Bs120xStatus *	status_out
	)

Gets the status of the unit.

Note

The BS120x unit must have UDP data broadcast enabled for this method to return valid data.

Parameters

[in]	handle	Ethernet client handle.
[out]	status_out	Pointer to the returned status.

Returns

0 on success or a negative error code.

Bs120xEnet_Reset()

int Bs120xEnet_Reset

(

Bs120xEnetHandle

handle

)

Commands the unit to reset.

Note

Disconnect and Connect must be called after this method to establish a new connection.

Parameters

[in]

handle

Ethernet client handle.

Returns

0 on success or a negative error code.

Bs120xEnet_SetOpModeConfig()

int Bs120xEnet_SetOpModeConfig	(	Bs120xEnetHandle	handle,
		struct Bs120xOpModeConfig	config
	)

Configures the operating mode of the unit.

Parameters

[in]	handle	Ethernet client handle.
[in]	config	The operating mode options to set.

Returns

0 on success or a negative error code.