Clean up implementation of enable/disable of tx over regions #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

MedadRufus wants to merge 36 commits into icspace-dev from transmit-all-over-europe

src/peripherals/bsp.c

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -352,7 +352,7 @@ void BSP_sensor_Init(void)
  
    	IWDG_reset();

    	// Initialise the geofence permissions mask

    	bool values[N_POLYGONS];

    	tx_permission_t values[n_polygons];

    	read_geofence_settings_in_eeprom(values);

    	playback_hw_init();

src/peripherals/eeprom_settings_manager.c

-Original file line number
+Diff line change
@@ Expand Up / @@ -19,6 +19,33 @@ @@
     #include "bsp.h"
     #include "eeprom_settings_manager.h"
+    static const tx_permission_t default_geofence_settings[n_polygons] = {
+    	[AS920923_PHILIPPINES_polygon] = TX_OK,
+    	[US902928_NAMERICA_polygon] = TX_OK,
+    	[AS923925_BRUNEI_polygon] = TX_OK,
+    	[AS923925_TAIWAN_polygon] = TX_OK,
+    	[AS923925_INDONESIA_polygon] = TX_OK,
+    	[AS923925_THAILAND_polygon] = TX_OK,
+    	[US902928_ARGENTINA_polygon] = TX_OK,
+    	[AU915928_BRAZIL_polygon] = TX_OK,
+    	[AU915928_CHILE_polygon] = TX_OK,
+    	[CN779787_CHINA_polygon] = TX_OK,
+    	[IN865867_INDIA_polygon] = TX_OK,
+    	[AS920923_JAPAN_polygon] = TX_OK,
+    	[KR920923_SKOREA_polygon] = TX_OK,
+    	[AS920923_MALAYSIASG_polygon] = TX_OK,
+    	[AU915928_AUSTRALIA_polygon] = TX_OK,
+    	[RU864870_RUSSIA_polygon] = TX_OK,
+    	[EU863870_EUROPE_polygon] = TX_OK,
+    	[US902928_GUAM_polygon] = TX_OK,
+    	[US902928_ANTARTICA_polygon] = TX_OK,
+    	[AS920923_ISRAEL_polygon] = TX_OK,
+    	[US902928_MALDIVES_polygon] = TX_OK,
+    	[EU863870_UKRAINE_polygon] = TX_OK,
+    	[EU863870_NORTH_KOREA_polygon] = TX_NOT_OK,
+    	[OUTSIDE_polygon] = TX_NOT_OK,
+    };
     /**
      * @brief Get the eeprom stored lorwan region
      *
@@ Expand Down Expand Up @@
     /**
      * @brief Reads and initialised the geofence module with the tx enable/disable settings
      * from EEPROM. Fills passed buffer with the settings. Ensure buffer passed is
-     * of size N_POLYGONS * sizeof(bool)
+     * of size n_polygons * sizeof(tx_permission_t)
      *
-     * @param values Pointer to buffer that will be filled with the bool enable/disable setting
+     * @param values Pointer to buffer that will be filled with the tx_permission_t setting
      */
-    void read_geofence_settings_in_eeprom(bool *values)
+    void read_geofence_settings_in_eeprom(tx_permission_t *values)
     {
+    	// todo: check non-null
     	// read settings stored in EEPROM
     	geofence_settings_t geofence_settings;
     	NvmmRead((uint8_t *)&geofence_settings, TX_PERMISSIONS_LEN, TX_PERMISSIONS_ADDR);
+    	uint16_t sizeof_values = sizeof(geofence_settings.values);
     	// Use eeprom stored values only if CRC is correct. Else assume the default settings
     	if (is_crc_correct(sizeof(geofence_settings_t), (void *)&geofence_settings))
     	{
-    		memcpy(values, geofence_settings.values, N_POLYGONS * sizeof(bool));
-    	}
-    	else
-    	{
-    		bool default_geofence_settings[N_POLYGONS] = {true, true, true, true, true, true,
-    													  true, true, true, true, true, true,
-    													  true, true, true, true, true, true,
-    													  true, true, true, true, false};
-    		memcpy(values, default_geofence_settings, N_POLYGONS * sizeof(bool));
+    		memcpy(values, geofence_settings.values, sizeof_values);
+    		geofence_init_with_settings(values);
     	}
-    	geofence_init_with_settings(values);
     }
     /**
@@ Expand Down Expand Up / @@ -220,7 +238,7 @@ uint8_t get_settings_crc() @@
     	}
     	// CRC of tx enable/disable settings for different regions.
-    	bool values[N_POLYGONS];
+    	tx_permission_t values[n_polygons];
     	read_geofence_settings_in_eeprom(values);
     	crc = Crc8Update(crc, (uint8_t *)values, sizeof(values));
@@ Expand Down @@

src/peripherals/eeprom_settings_manager.h

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -19,25 +19,24 @@ extern "C"
  
    #include "stdint.h"

    #include "stdbool.h"

    #include "LoRaWAN_config_switcher.h"

    #include "geofence.h"

        typedef struct

        {

            uint32_t tx_interval;

            uint32_t Crc32;

        } tx_interval_eeprom_t;

    #define N_POLYGONS 23

        typedef struct

        {

            bool values[N_POLYGONS];

            tx_permission_t values[n_polygons];

            uint32_t Crc32;

        } geofence_settings_t;

        bool update_device_tx_interval_in_eeprom(uint32_t address, uint32_t interval_ms);

        uint32_t read_tx_interval_in_eeprom(uint32_t address, uint32_t default_value);

        bool update_geofence_settings_in_eeprom(uint8_t *settings, uint16_t size);

        void read_geofence_settings_in_eeprom(bool *values);

        void read_geofence_settings_in_eeprom(tx_permission_t *values);

        void retrieve_eeprom_stored_lorawan_region(void);

        void set_eeprom_stored_lorwan_region(void);

        bool update_device_credentials_to_eeprom(network_keys_t keys, registered_devices_t registered_device);

src/peripherals/geofence.c

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -34,52 +34,38 @@
  
    /* Global variables definitions go here */

    // GEOFENCE variables

    /* The world is split into polygons e.g. EU863870_EUROPE_polygon. 

     * Multiple polygons can have the same LoRa region settings. E.g. LORAMAC_REGION_EU868.

     * Keeps track of which polygon the tracker is in, and if it changes to another polygon,

     * all LoRa settings are reinitialised when the balloon enters another polygon.

     * 

     */

    /*!

     * Polygon region enumeration

     */

    typedef enum polygon_t

    {

    	AS920923_PHILIPPINES_polygon,

    	US902928_NAMERICA_polygon,

    	AS923925_BRUNEI_polygon,

    	AS923925_TAIWAN_polygon,

    	AS923925_INDONESIA_polygon,

    	AS923925_THAILAND_polygon,

    	US902928_ARGENTINA_polygon,

    	AU915928_BRAZIL_polygon,

    	AU915928_CHILE_polygon,

    	CN779787_CHINA_polygon,

    	IN865867_INDIA_polygon,

    	AS920923_JAPAN_polygon,

    	KR920923_SKOREA_polygon,

    	AS920923_MALAYSIASG_polygon,

    	AU915928_AUSTRALIA_polygon,

    	RU864870_RUSSIA_polygon,

    	EU863870_EUROPE_polygon,

    	US902928_GUAM_polygon,

    	US902928_ANTARTICA_polygon,

    	AS920923_ISRAEL_polygon,

    	US902928_MALDIVES_polygon,

    	EU863870_UKRAINE_polygon,

    	OUTSIDE_polygon,

    	n_polygons,

    } Polygon_t;

    /**

     * @brief Transmission enable/disable mask for each region. Each

     * boolean value corresponds to each enum value in Polygon_t.

     * By default, transmissions are disabled over regions

     * outside of the geofence regions.

     */

    bool tx_permissions_for_regions[n_polygons];

    static tx_permission_t tx_permissions_for_regions[n_polygons] = {

    	[AS920923_PHILIPPINES_polygon] = TX_OK,

    	[US902928_NAMERICA_polygon] = TX_OK,

    	[AS923925_BRUNEI_polygon] = TX_OK,

    	[AS923925_TAIWAN_polygon] = TX_OK,

    	[AS923925_INDONESIA_polygon] = TX_OK,

    	[AS923925_THAILAND_polygon] = TX_OK,

    	[US902928_ARGENTINA_polygon] = TX_OK,

    	[AU915928_BRAZIL_polygon] = TX_OK,

    	[AU915928_CHILE_polygon] = TX_OK,

    	[CN779787_CHINA_polygon] = TX_OK,

    	[IN865867_INDIA_polygon] = TX_OK,

    	[AS920923_JAPAN_polygon] = TX_OK,

    	[KR920923_SKOREA_polygon] = TX_OK,

    	[AS920923_MALAYSIASG_polygon] = TX_OK,

    	[AU915928_AUSTRALIA_polygon] = TX_OK,

    	[RU864870_RUSSIA_polygon] = TX_OK,

    	[EU863870_EUROPE_polygon] = TX_OK,

    	[US902928_GUAM_polygon] = TX_OK,

    	[US902928_ANTARTICA_polygon] = TX_OK,

    	[AS920923_ISRAEL_polygon] = TX_OK,

    	[US902928_MALDIVES_polygon] = TX_OK,

    	[EU863870_UKRAINE_polygon] = TX_OK,

    	[EU863870_NORTH_KOREA_polygon] = TX_NOT_OK,

    	[OUTSIDE_polygon] = TX_NOT_OK,

    };

    geofence_status_t current_geofence_status =

    	{

    @@ -425,7 +411,7 @@ static const float AS920923_JAPAN_F[32] = {
  
    };

    static const float KR920923_SKOREA_F[18] = {

    static const float KR920923_SKOREA_F[22] = {

    	122.94545,

    	36.60046,

    	122.59912,

    @@ -436,8 +422,12 @@ static const float KR920923_SKOREA_F[18] = {
  
    	35.18414,

    	131.42570,

    	38.21762,

    	131.67979,

    	41.62004,

    	131.84483,

    	41.61509,

    	130.90107,

    	42.36039,

    	129.65493,

    	40.70374,

    	127.96554,

    	39.81694,

    	128.33108,

    @@ -807,6 +797,34 @@ static const float EU863870_UKRAINE_F[46] = {
  
    };

    static const float EU863870_NORTH_KOREA_F[24] = {

    	124.16708,

    	39.74409,

    	124.86613,

    	39.40398,

    	124.56884,

    	38.03067,

    	125.59527,

    	37.58797,

    	128.25518,

    	38.53998,

    	127.77692,

    	39.27210,

    	127.66038,

    	39.73660,

    	129.59331,

    	40.73516,

    	129.92897,

    	41.36654,

    	130.75795,

    	42.26509,

    	130.24571,

    	43.24406,

    	124.16708,

    	39.74409,

    };

    /* ==================================================================== */

    /* ========================== private data ============================ */

    /* ==================================================================== */

    @@ -1025,6 +1043,11 @@ Polygon_t get_polygon(float latitude, float longitude)
  
    		current_poly = US902928_MALDIVES_polygon;

    	}

    	else if (pointInPolygonF(12, EU863870_NORTH_KOREA_F, latitude, longitude) == 1)

    	{

    		current_poly = EU863870_NORTH_KOREA_polygon;

    	}

    	return current_poly;

    }

    @@ -1037,11 +1060,12 @@ Polygon_t get_polygon(float latitude, float longitude)
  
     */

    tx_permission_t get_permissions(Polygon_t currentpoly)

    {

    	// then lookup value. Danger, there is no bounds validation for current poly. Can cause corruption.

    	bool can_transmit = tx_permissions_for_regions[currentpoly];

    	// then return permission

    	return can_transmit ? TX_OK : TX_NOT_OK;

    	tx_permission_t result = TX_OK; // failsafe by allowing TX

    	if (currentpoly < n_polygons)

    	{

    		result = tx_permissions_for_regions[currentpoly];

    	}

    	return result;

    }

    static void set_current_loramac_region_from_polygon(Polygon_t current_poly)

    @@ -1127,7 +1151,9 @@ static void set_current_loramac_region_from_polygon(Polygon_t current_poly)
  
    	case EU863870_UKRAINE_polygon:

    		current_geofence_status.current_loramac_region = LORAMAC_REGION_EU868;

    		break;

    	case EU863870_NORTH_KOREA_polygon:

    		current_geofence_status.current_loramac_region = LORAMAC_REGION_EU868;

    		break;

    	case OUTSIDE_polygon:

    		current_geofence_status.current_loramac_region = LORAMAC_REGION_EU868;

    		break;

    @@ -1153,7 +1179,7 @@ tx_permission_t get_current_tx_permission()
  
    	return current_geofence_status.tx_permission;

    }

    void geofence_init_with_settings(bool *settings)

    void geofence_init_with_settings(tx_permission_t *settings)

    {

    	memcpy(tx_permissions_for_regions, settings, n_polygons * sizeof(bool));

    	memcpy(tx_permissions_for_regions, settings, sizeof(tx_permissions_for_regions));

    }

src/peripherals/geofence.h

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -44,7 +44,7 @@ extern "C"
  
    	typedef enum

    	{

    		TX_OK = 0,

    		TX_OK = 0, // Default value is TX_OK. If this value is uninitialised, it will failsafe to TX_OK.

    		TX_NOT_OK

    	} tx_permission_t;

    @@ -56,14 +56,51 @@ extern "C"
  
    	} geofence_status_t;

    	/* The world is split into polygons e.g. EU863870_EUROPE_polygon.

    	 * Multiple polygons can have the same LoRa region settings. E.g. LORAMAC_REGION_EU868.

    	 * Keeps track of which polygon the tracker is in, and if it changes to another polygon,

    	 * all LoRa settings are reinitialised when the balloon enters another polygon.

    	 */

    	/*!

    	 * Polygon region enumeration

    	 */

    	typedef enum polygon_t

    	{

    		AS920923_PHILIPPINES_polygon,

    		US902928_NAMERICA_polygon,

    		AS923925_BRUNEI_polygon,

    		AS923925_TAIWAN_polygon,

    		AS923925_INDONESIA_polygon,

    		AS923925_THAILAND_polygon,

    		US902928_ARGENTINA_polygon,

    		AU915928_BRAZIL_polygon,

    		AU915928_CHILE_polygon,

    		CN779787_CHINA_polygon,

    		IN865867_INDIA_polygon,

    		AS920923_JAPAN_polygon,

    		KR920923_SKOREA_polygon,

    		AS920923_MALAYSIASG_polygon,

    		AU915928_AUSTRALIA_polygon,

    		RU864870_RUSSIA_polygon,

    		EU863870_EUROPE_polygon,

    		US902928_GUAM_polygon,

    		US902928_ANTARTICA_polygon,

    		AS920923_ISRAEL_polygon,

    		US902928_MALDIVES_polygon,

    		EU863870_UKRAINE_polygon,

    		EU863870_NORTH_KOREA_polygon,

    		OUTSIDE_polygon,

    		n_polygons,

    	} Polygon_t;

    	/* ==================================================================== */

    	/* ======================= public functions =========================== */

    	/* ==================================================================== */

    	/* Function prototypes for public (external) functions go here */

    	void update_geofence_position(float latitude, float longitude);

    	void geofence_init_with_settings(bool *settings);

    	void geofence_init_with_settings(tx_permission_t *settings);

    	LoRaMacRegion_t get_current_loramac_region(void);

    	as923_subbands_t get_as923_subband(void);

    	void set_current_loramac_region(LoRaMacRegion_t region);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up implementation of enable/disable of tx over regions #481

Uh oh!

Diff view

Diff view

There are no files selected for viewing

MedadRufus Jan 18, 2023

Uh oh!

Uh oh!

Clean up implementation of enable/disable of tx over regions #481

Are you sure you want to change the base?

Uh oh!

Clean up implementation of enable/disable of tx over regions #481

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

MedadRufus Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!