lr1110_lr_fhss.h File Reference

LR_FHSS driver definition for LR1110. More...

#include "lriot.h"
#include "transceiver/lr1110_lr_fhss_types.h"
#include "common/lr1110_types.h"

Go to the source code of this file.

Macros
#define	LR_FHSS_SYNC_WORD_BYTES   ( 4 )
	Length, in bytes, of a LR-FHSS sync word.

Functions
err_t	lr1110_lr_fhss_init (lriot_t *ctx)
	Initialize the LR_FHSS.
err_t	lr1110_lr_fhss_build_frame (lriot_t *ctx, lr1110_lr_fhss_params_t *lr_fhss_params, uint16_t hop_sequence_id, uint8_t *payload, uint8_t payload_length)
	Configure a payload to be sent with LR_FHSS.
uint32_t	lr1110_lr_fhss_get_time_on_air_in_ms (lr1110_lr_fhss_params_t *params, uint16_t payload_length)
	Get the time on air in ms for LR-FHSS transmission.
uint32_t	lr1110_lr_fhss_get_hop_sequence_count (lr1110_lr_fhss_params_t *lr_fhss_params)
	Return the number of hop sequences available using the given parameters.

Detailed Description

LR_FHSS driver definition for LR1110.

The Clear BSD License Copyright Semtech Corporation 2021. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

LR_FHSS_SYNC_WORD_BYTES

#define LR_FHSS_SYNC_WORD_BYTES   ( 4 )

Length, in bytes, of a LR-FHSS sync word.

Function Documentation

lr1110_lr_fhss_build_frame()

err_t lr1110_lr_fhss_build_frame	(	lriot_t *	ctx,
		lr1110_lr_fhss_params_t *	lr_fhss_params,
		uint16_t	hop_sequence_id,
		uint8_t *	payload,
		uint8_t	payload_length )

Configure a payload to be sent with LR_FHSS.

When calling this method, lr1110_lr_fhss_set_sync_word is implicitely called to configure the sync word. Note that the syncword must be 4 bytes long.

Parameters

[in]	ctx	Chip implementation context
[in]	lr_fhss_params	Parameter configuration structure of the LRFHSS
[in]	hop_sequence_id	Seed used to derive the hopping sequence pattern. Only the nine LSBs are taken into account
[in]	payload	The payload to send. It is the responsibility of the caller to ensure that this references an array containing at least payload_length elements
[in]	payload_length	The length of the payload

Returns

Operation status

lr1110_lr_fhss_get_hop_sequence_count()

uint32_t lr1110_lr_fhss_get_hop_sequence_count

(

lr1110_lr_fhss_params_t *

lr_fhss_params

)

Return the number of hop sequences available using the given parameters.

Parameters

[in]

lr_fhss_params

Parameter configuration structure of the LRFHSS

Returns

Returns the number of valid hop sequences (512 or 384)

lr1110_lr_fhss_get_time_on_air_in_ms()

uint32_t lr1110_lr_fhss_get_time_on_air_in_ms	(	lr1110_lr_fhss_params_t *	params,
		uint16_t	payload_length )

Get the time on air in ms for LR-FHSS transmission.

Parameters

[in]	params	LR1110 LR-FHSS parameter structure
[in]	payload_length	Length of application-layer payload

Returns

Time-on-air value in ms for LR-FHSS transmission

lr1110_lr_fhss_init()

err_t lr1110_lr_fhss_init

(

lriot_t *

ctx

)

Initialize the LR_FHSS.

Parameters

[in]

ctx

Chip implementation context

Returns

Operation status