Functions

Onethinx LoRa Functions. More...

Functions
coreStatus_t	LoRa_RX (RadioParams_t *RadioParams, RadioStatus_t *RadioStatus, uint8_t *payload, uint8_t payloadSize, uint16_t timeOutMS, WaitMode_e waitMode)
	This functions waits for a LoRa transmition with given parameters. More...
coreStatus_t	LoRa_TX (RadioParams_t *RadioParams, RadioStatus_t *RadioStatus, uint8_t *payload, uint8_t payloadSize, uint16_t timeOutMS, WaitMode_e waitMode)
	This functions does the LoRa transmission with given parameters. More...
void	LoRaWAN_Debug (bool debugLedsOn, uint32_t *coreStatePNT)
	Uses the DevKit red LED to signal if stack is operating normally or is hanging. More...
void	LoRaWAN_Unlock ()
	Use the Unlock function before using any other extended functions. More...

Detailed Description

Onethinx LoRa Functions.

Function Documentation

LoRa_RX()

coreStatus_t LoRa_RX	(	RadioParams_t *	RadioParams,
		RadioStatus_t *	RadioStatus,
		uint8_t *	payload,
		uint8_t	payloadSize,
		uint16_t	timeOutMS,
		WaitMode_e	waitMode
	)

This functions waits for a LoRa transmition with given parameters.

Parameters

RadioParams	Pointer to the RadioParams_t structure where LoRa parameters are set.
RadioStatus	Pointer to the RadioStatus_t structure where the stack returns statuses.
payload	Pointer to the buffer where the receiving payload is saved.
payloadSize	Size of the payload that is to be received.
timeOutMS	Timeout in milliseconds. Will exit the function if timeout is reached. If zero, there is no timeout.
waitMode	Type of wait mode in which the M4 core waits.

Returns

Returns error / status code. (coreStatus_t)

See also

RadioParams_t, RadioStatus_t, WaitMode_e, coreStatus_t and LoRa_TX

LoRa_TX()

coreStatus_t LoRa_TX	(	RadioParams_t *	RadioParams,
		RadioStatus_t *	RadioStatus,
		uint8_t *	payload,
		uint8_t	payloadSize,
		uint16_t	timeOutMS,
		WaitMode_e	waitMode
	)

This functions does the LoRa transmission with given parameters.

Parameters

RadioParams	Pointer to the RadioParams_t structure where LoRa parameters are set.
RadioStatus	Pointer to the RadioStatus_t structure where the stack returns statuses.
payload	Pointer to the buffer where the receiving payload is saved.
payloadSize	Size of the payload that is to be received.
timeOutMS	Timeout in milliseconds. Will exit the function if timeout is reached. If zero, there is no timeout.
waitMode	Type of wait mode in which the M4 core waits.

Returns

Returns error / status code. (coreStatus_t)

See also

RadioParams_t, RadioStatus_t, WaitMode_e, coreStatus_t and LoRa_RX

LoRaWAN_Debug()

void LoRaWAN_Debug	(	bool	debugLedsOn,
		uint32_t *	coreStatePNT
	)

Uses the DevKit red LED to signal if stack is operating normally or is hanging.

Parameters

debugLedsOn	Red LED on Onethinx DevKit will flash at 2 Hz in normal operation.
coreStatePNT	Pointer to the stackState. Returns the tate the stack is currently in.

LoRaWAN_Unlock()

void LoRaWAN_Unlock

(

)

Use the Unlock function before using any other extended functions.

Enables the use of LoRa/FSK, CapSense. Unlocks Port 7.

Unlocking may void LoRa Alliance Certification by Similarity.