lr1110_modem_lorawan.h

Go to the documentation of this file.

 
#ifndef LR1110_MODEM_LORAWAN_H
#define LR1110_MODEM_LORAWAN_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdbool.h>
#include <stdint.h>
#include "modem/lr1110_modem_lorawan_types.h"
#include "lriot.h"
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
err_t lr1110_modem_get_event( lriot_t *ctx, lr1110_modem_event_fields_t* event_fields );
 
err_t lr1110_modem_get_version( lriot_t *ctx, lr1110_modem_version_t* version );
 
err_t lr1110_modem_reset( lriot_t *ctx );
 
err_t lr1110_modem_reset_charge( lriot_t *ctx );
 
err_t lr1110_modem_get_charge( lriot_t *ctx, uint32_t* charge );
 
err_t lr1110_modem_get_tx_power_offset( lriot_t *ctx, int8_t* tx_power_offset );
 
err_t lr1110_modem_set_tx_power_offset( lriot_t *ctx, int8_t tx_power_offset );
 
err_t lr1110_modem_test_mode_start( lriot_t *ctx );
 
err_t lr1110_modem_test_nop( lriot_t *ctx );
 
err_t lr1110_modem_test_tx_single( lriot_t *ctx, uint32_t frequency, int8_t tx_power, 
                                   lr1110_modem_tst_mode_sf_t sf, lr1110_modem_tst_mode_bw_t bw,
                                   lr1110_modem_tst_mode_cr_t cr, uint8_t payload_length );
 
err_t lr1110_modem_test_tx_cont( lriot_t *ctx, uint32_t frequency, int8_t tx_power,
                                 lr1110_modem_tst_mode_sf_t sf, lr1110_modem_tst_mode_bw_t bw,
                                 lr1110_modem_tst_mode_cr_t cr, uint8_t payload_length );
 
err_t lr1110_modem_test_tx_cw( lriot_t *ctx, uint32_t frequency, int8_t tx_power );
 
err_t lr1110_modem_test_rx_cont( lriot_t *ctx, uint32_t frequency, lr1110_modem_tst_mode_sf_t sf, 
                                 lr1110_modem_tst_mode_bw_t bw, lr1110_modem_tst_mode_cr_t cr );
 
err_t lr1110_modem_test_read_packet_counter_rx_cont( lriot_t *ctx, uint32_t* rx_packet_counter );
 
err_t lr1110_modem_test_rssi_subghz( lriot_t *ctx, uint32_t frequency, uint16_t time_ms, lr1110_modem_tst_mode_bw_t bw );
 
err_t lr1110_modem_test_radio_rst( lriot_t *ctx );
 
err_t lr1110_modem_test_exit( lriot_t *ctx );
 
err_t lr1110_modem_test_tx_single_preamble( lriot_t *ctx, uint32_t frequency, int8_t tx_power, lr1110_modem_tst_mode_sf_t sf,
                                            lr1110_modem_tst_mode_bw_t bw, lr1110_modem_tst_mode_cr_t cr,
                                            uint8_t payload_length, uint16_t preamble_length );
 
err_t lr1110_modem_test_read_rssi( lriot_t *ctx, int8_t* rssi );
 
err_t lr1110_modem_test_rssi_2g4( lriot_t *ctx, uint8_t channel, uint16_t time_ms, lr1110_modem_tst_mode_bw_t bw );
 
err_t lr1110_modem_test_rssi_gnss( lriot_t *ctx, lr1110_modem_tst_mode_constellation_t constellation_modulation, 
                                   uint16_t time_ms, lr1110_modem_tst_mode_bw_t bw );
 
err_t lr1110_modem_get_gps_time( lriot_t *ctx, uint32_t* time );
 
err_t lr1110_modem_get_status( lriot_t *ctx, lr1110_modem_status_t* status );
 
err_t lr1110_modem_set_alarm_timer( lriot_t *ctx, uint32_t seconds );
 
err_t lr1110_modem_get_pin( lriot_t *ctx, uint32_t* pin );
 
err_t lr1110_modem_get_chip_eui( lriot_t *ctx, lr1110_modem_chip_eui_t chip_eui );
 
err_t lr1110_modem_get_join_eui( lriot_t *ctx, lr1110_modem_join_eui_t join_eui );
 
err_t lr1110_modem_set_join_eui( lriot_t *ctx, lr1110_modem_join_eui_t join_eui );
 
err_t lr1110_modem_get_dev_eui( lriot_t *ctx, lr1110_modem_dev_eui_t dev_eui );
 
err_t lr1110_modem_set_dev_eui( lriot_t *ctx, lr1110_modem_dev_eui_t dev_eui );
 
err_t lr1110_modem_set_app_key( lriot_t *ctx, lr1110_modem_app_key_t app_key );
 
err_t lr1110_modem_get_class( lriot_t *ctx, lr1110_modem_classes_t* modem_class );
 
err_t lr1110_modem_set_class( lriot_t *ctx, lr1110_modem_classes_t modem_class );
 
err_t lr1110_modem_get_region( lriot_t *ctx, lr1110_modem_regions_t* region );
 
err_t lr1110_modem_set_region( lriot_t *ctx, lr1110_modem_regions_t region );
 
err_t lr1110_modem_list_regions( lriot_t *ctx, uint8_t *region_codes, uint8_t* region_codes_size );
 
err_t lr1110_modem_get_adr_profile( lriot_t *ctx, lr1110_modem_adr_profiles_t* adr_profile );
 
err_t lr1110_modem_set_adr_profile( lriot_t *ctx, lr1110_modem_adr_profiles_t adr_profile, uint8_t* adr_custom_list );
 
err_t lr1110_modem_get_dm_port( lriot_t *ctx, uint8_t* port );
 
err_t lr1110_modem_set_dm_port( lriot_t *ctx, uint8_t port );
 
err_t lr1110_modem_get_dm_info_interval( lriot_t *ctx, uint8_t* format, uint8_t* interval );
 
err_t lr1110_modem_set_dm_info_interval( lriot_t *ctx, lr1110_modem_reporting_interval_format_t format, uint8_t interval );
 
err_t lr1110_modem_get_dm_info_field( lriot_t *ctx, lr1110_modem_dm_info_fields_t* dm_info_fields );
 
err_t lr1110_modem_set_dm_info_field( lriot_t *ctx, lr1110_modem_dm_info_fields_t* dm_info_fields );
 
err_t lr1110_modem_send_dm_status( lriot_t *ctx, lr1110_modem_dm_info_fields_t* dm_info_fields );
 
err_t lr1110_modem_set_app_status( lriot_t *ctx, uint8_t* app_status );
 
err_t lr1110_modem_join( lriot_t *ctx );
 
err_t lr1110_modem_leave_network( lriot_t *ctx );
 
err_t lr1110_modem_suspend( lriot_t *ctx, lr1110_modem_suspend_t suspend );
 
err_t lr1110_modem_get_next_tx_max_payload( lriot_t *ctx, uint8_t* tx_max_payload );
 
err_t lr1110_modem_request_tx( lriot_t *ctx, uint8_t port, lr1110_modem_uplink_type_t uplink_type, 
                               uint8_t* data_buf, uint8_t length );
 
err_t lr1110_modem_emergency_tx( lriot_t *ctx, uint8_t port, lr1110_modem_uplink_type_t uplink_type,
                                 uint8_t* data_buf, uint8_t length );
 
err_t lr1110_modem_upload_init( lriot_t *ctx, uint8_t port, lr1110_modem_encryption_mode_t encryption_mode,
                                uint16_t size, uint16_t interval );
 
err_t lr1110_modem_upload_data( lriot_t *ctx, uint8_t* data_buf, uint8_t length );
 
err_t lr1110_modem_upload_start( lriot_t *ctx, uint32_t crc );
 
err_t lr1110_modem_stream_init( lriot_t *ctx, uint8_t port, lr1110_modem_encryption_mode_t encryption_mode );
 
err_t lr1110_modem_send_stream_data( lriot_t *ctx, uint8_t port, uint8_t* record, uint8_t length );
 
err_t lr1110_modem_stream_status( lriot_t *ctx, uint8_t port, lr1110_modem_stream_status_t* stream_status );
 
err_t lr1110_modem_set_gps_time( lriot_t *ctx, uint32_t gps_time );
 
err_t lr1110_modem_derive_keys( lriot_t *ctx );
 
err_t lr1110_modem_set_rf_output( lriot_t *ctx, lr1110_modem_radio_pa_selection_t output );
 
err_t lr1110_modem_set_alc_sync_port( lriot_t *ctx, uint8_t port );
 
err_t lr1110_modem_get_alc_sync_port( lriot_t *ctx, uint8_t* port );
 
err_t lr1110_modem_set_alc_sync_mode( lriot_t *ctx, lr1110_modem_alc_sync_mode_t mode );
 
err_t lr1110_modem_get_alc_sync_mode( lriot_t *ctx, lr1110_modem_alc_sync_mode_t* mode );
 
err_t lr1110_modem_set_connection_timeout( lriot_t *ctx, uint16_t nb_uplink_mobile_static, uint16_t nb_uplink_reset );
 
err_t lr1110_modem_get_connection_timeout( lriot_t *ctx, uint16_t* nb_uplink_mobile_static, uint16_t* nb_uplink_reset );
 
err_t lr1110_modem_get_connection_timeout_status( lriot_t *ctx, uint16_t* nb_uplink_mobile_static, uint16_t* nb_uplink_reset );
 
err_t lr1110_modem_get_lorawan_state( lriot_t *ctx, lr1110_modem_lorawan_state_t* lorawan_state );
 
err_t lr1110_modem_write_user_defined_charge_counter( lriot_t *ctx, uint16_t charge );
 
err_t lr1110_modem_read_user_defined_charge_counter( lriot_t *ctx, uint16_t* charge );
 
err_t lr1110_modem_select_charge_uplink( lriot_t *ctx, lr1110_modem_charge_type_t charge_type );
 
err_t lr1110_modem_get_duty_cycle_status( lriot_t *ctx, int32_t* duty_cycle );
 
err_t lr1110_modem_activate_duty_cycle( lriot_t *ctx, lr1110_modem_duty_cycle_t duty_cycle );
 
err_t lr1110_modem_set_certification_mode( lriot_t *ctx, lr1110_modem_certification_mode_t enable );
 
err_t lr1110_modem_get_certification_mode( lriot_t *ctx, lr1110_modem_certification_mode_t* enable );
 
err_t lr1110_modem_get_available_data_rate( lriot_t *ctx, uint16_t* available_data_rate );
 
err_t lr1110_modem_set_output_power_config( lriot_t *ctx, lr1110_modem_output_power_config_list_t output_power_config );
 
err_t lr1110_modem_get_output_power_config( lriot_t *ctx, lr1110_modem_output_power_config_list_t output_power_config );
 
err_t lr1110_modem_get_network_type( lriot_t *ctx, lr1110_modem_network_type_t* network_type );
 
err_t lr1110_modem_set_network_type( lriot_t *ctx, lr1110_modem_network_type_t network_type );
 
err_t lr1110_modem_activate_lbt( lriot_t *ctx, lr1110_modem_lbt_mode_t enable, int16_t threshold,
                                 uint32_t duration, uint32_t bandwidth );
 
err_t lr1110_modem_set_nb_trans( lriot_t *ctx, uint8_t nb_trans );
 
err_t lr1110_modem_get_nb_trans( lriot_t *ctx, uint8_t* nb_trans );
 
err_t lr1110_modem_set_stream_redundancy_rate( lriot_t *ctx, uint8_t stream_redundancy_rate );
 
err_t lr1110_modem_get_stream_redundancy_rate( lriot_t *ctx, uint8_t* stream_redundancy_rate );
 
 
err_t lr1110_modem_set_crystal_error( lriot_t *ctx, uint32_t crystal_error );
 
err_t lr1110_modem_get_crystal_error( lriot_t *ctx, uint32_t* crystal_error );
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_MODEM_LORAWAN_H
 
/* --- EOF ------------------------------------------------------------------ */