Driver for HARDWARIO SigFox Module. More...

Enumerations
enum	twr_module_sigfox_revision_t { TWR_MODULE_SIGFOX_REVISION_R1 = 0 , TWR_MODULE_SIGFOX_REVISION_R2 = 1 }
	SigFox Module hardware revision. More...

enum	twr_module_sigfox_event_t { TWR_MODULE_SIGFOX_EVENT_READY = 0 , TWR_MODULE_SIGFOX_EVENT_ERROR = 1 , TWR_MODULE_SIGFOX_EVENT_SEND_RF_FRAME_START = 2 , TWR_MODULE_SIGFOX_EVENT_SEND_RF_FRAME_DONE = 3 , TWR_MODULE_SIGFOX_EVENT_READ_DEVICE_ID = 4 , TWR_MODULE_SIGFOX_EVENT_READ_DEVICE_PAC = 5 }
	Callback events. More...

Functions
void	twr_module_sigfox_init (twr_module_sigfox_t *self, twr_module_sigfox_revision_t revision)
	Initialize HARDWARIO SigFox Module. More...

void	twr_module_sigfox_set_event_handler (twr_module_sigfox_t self, void(event_handler)(twr_module_sigfox_t , twr_module_sigfox_event_t, void ), void *event_param)
	Set callback function. More...

bool	twr_module_sigfox_is_ready (twr_module_sigfox_t *self)
	Check if modem is ready for commands. More...

bool	twr_module_sigfox_send_rf_frame (twr_module_sigfox_t self, const void buffer, size_t length)
	Send RF frame command. More...

bool	twr_module_sigfox_read_device_id (twr_module_sigfox_t *self)
	Read device ID command. More...

bool	twr_module_sigfox_get_device_id (twr_module_sigfox_t self, char buffer, size_t buffer_size)
	Get device ID (can be called only in TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID event) More...

bool	twr_module_sigfox_read_device_pac (twr_module_sigfox_t *self)
	Read device PAC command. More...

bool	twr_module_sigfox_get_device_pac (twr_module_sigfox_t self, char buffer, size_t buffer_size)
	Get device PAC (can be called only in TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID event) More...

bool	twr_module_sigfox_continuous_wave (twr_module_sigfox_t *self)
	Generate continuous wave command. More...

Detailed Description

Driver for HARDWARIO SigFox Module.

Enumeration Type Documentation

◆ twr_module_sigfox_event_t

enum twr_module_sigfox_event_t

Callback events.

Enumerator
TWR_MODULE_SIGFOX_EVENT_READY	Ready event.
TWR_MODULE_SIGFOX_EVENT_ERROR	Error event.
TWR_MODULE_SIGFOX_EVENT_SEND_RF_FRAME_START	RF frame transmission started event.
TWR_MODULE_SIGFOX_EVENT_SEND_RF_FRAME_DONE	RF frame transmission finished event.
TWR_MODULE_SIGFOX_EVENT_READ_DEVICE_ID	Device ID has been read event.
TWR_MODULE_SIGFOX_EVENT_READ_DEVICE_PAC	Device PAC has been read event.

Definition at line 25 of file twr_module_sigfox.h.

◆ twr_module_sigfox_revision_t

enum twr_module_sigfox_revision_t

SigFox Module hardware revision.

Enumerator
TWR_MODULE_SIGFOX_REVISION_R1	Hardware revision R1.
TWR_MODULE_SIGFOX_REVISION_R2	Hardware revision R2.

Definition at line 13 of file twr_module_sigfox.h.

Function Documentation

◆ twr_module_sigfox_continuous_wave()

bool twr_module_sigfox_continuous_wave ( twr_module_sigfox_t * self )

Generate continuous wave command.

Parameters

[in] self Instance

Returns: true If command was accepted for processing; false If command was denied for processing

Definition at line 94 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_get_device_id()

bool twr_module_sigfox_get_device_id	(	twr_module_sigfox_t *	self,
		char *	buffer,
		size_t	buffer_size
	)

Get device ID (can be called only in TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID event)

Parameters

[in]	self	Instance
[out]	buffer	Pointer to destination buffer
[in]	buffer_size	Size of destination buffer

Returns: true If device ID was retrieved; false If device ID could not be retrieved

Definition at line 64 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_get_device_pac()

bool twr_module_sigfox_get_device_pac	(	twr_module_sigfox_t *	self,
		char *	buffer,
		size_t	buffer_size
	)

Get device PAC (can be called only in TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID event)

Parameters

[in]	self	Instance
[out]	buffer	Pointer to destination buffer
[in]	buffer_size	Size of destination buffer

Returns: true If device PAC was retrieved; false If device PAC could not be retrieved

Definition at line 84 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_init()

void twr_module_sigfox_init	(	twr_module_sigfox_t *	self,
		twr_module_sigfox_revision_t	revision
	)

Initialize HARDWARIO SigFox Module.

Parameters

[in] self Instance

Definition at line 7 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_is_ready()

bool twr_module_sigfox_is_ready ( twr_module_sigfox_t * self )

Check if modem is ready for commands.

Parameters

[in] self Instance

Returns: true If ready; false If not ready

Definition at line 34 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_read_device_id()

bool twr_module_sigfox_read_device_id ( twr_module_sigfox_t * self )

Read device ID command.

Parameters

[in] self Instance

Returns: true If command was accepted for processing; false If command was denied for processing

Definition at line 54 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_read_device_pac()

bool twr_module_sigfox_read_device_pac ( twr_module_sigfox_t * self )

Read device PAC command.

Parameters

[in] self Instance

Returns: true If command was accepted for processing; false If command was denied for processing

Definition at line 74 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_send_rf_frame()

bool twr_module_sigfox_send_rf_frame	(	twr_module_sigfox_t *	self,
		const void *	buffer,
		size_t	length
	)

Send RF frame command.

Parameters

[in]	self	Instance
[in]	buffer	Pointer to data to be transmitted
[in]	length	Length of data to be transmitted in bytes (must be from 1 to 12 bytes)

Returns: true If command was accepted for processing; false If command was denied for processing

Definition at line 44 of file twr_module_sigfox.c.

Here is the call graph for this function:

◆ twr_module_sigfox_set_event_handler()

void twr_module_sigfox_set_event_handler	(	twr_module_sigfox_t *	self,
		void()(twr_module_sigfox_t , twr_module_sigfox_event_t, void *)	event_handler,
		void *	event_param
	)

Set callback function.

Parameters

[in]	self	Instance
[in]	event_handler	Function address
[in]	event_param	Optional event parameter (can be NULL)

Definition at line 27 of file twr_module_sigfox.c.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ twr_module_sigfox_event_t

◆ twr_module_sigfox_revision_t

Function Documentation

◆ twr_module_sigfox_continuous_wave()

◆ twr_module_sigfox_get_device_id()

◆ twr_module_sigfox_get_device_pac()

◆ twr_module_sigfox_init()

◆ twr_module_sigfox_is_ready()

◆ twr_module_sigfox_read_device_id()

◆ twr_module_sigfox_read_device_pac()

◆ twr_module_sigfox_send_rf_frame()

◆ twr_module_sigfox_set_event_handler()