main.c File Reference

The main file for Project 2 from Embedded System Design 2 - Lab. More...

#include <stdint.h>
#include <stdbool.h>
#include "em_device.h"
#include "em_chip.h"
#include "em_cmu.h"
#include "em_gpio.h"
#include "em_rtc.h"
#include "pin_mapping.h"
#include "debug_dbprint.h"
#include "delay.h"
#include "util.h"
#include "interrupt.h"
#include "ADXL362.h"
#include "DS18B20.h"
#include "adc.h"
#include "cable.h"
#include "lora_wrappers.h"
#include "datatypes.h"

Go to the source code of this file.

Macros
#define	WAKE_UP_PERIOD_S   180
#define	STORM_INTERRUPTS   8
#define	ADXL_THRESHOLD   7
#define	ADXL_RANGE   ADXL_RANGE_8G
#define	ADXL_ODR   ADXL_ODR_12_5_HZ
#define	LED_ENABLED   0

Functions
bool	checkBTNinterrupts (void)
	Method to check if any interrupts are triggered by buttons. More...
int	main (void)
	Main function. More...
void	NMI_Handler (void)
	NMI interrupt service routine. More...
void	HardFault_Handler (void)
	HardFault interrupt service routine. More...
void	SVC_Handler (void)
	SVC interrupt service routine. More...
void	PendSV_Handler (void)
	PendSV interrupt service routine. More...

Variables
static MCU_State_t	MCUstate
MeasurementData_t	data

Detailed Description

The main file for Project 2 from Embedded System Design 2 - Lab.

Version

5.2

Author

Brecht Van Eeckhoudt

---

Versions

Please check https://github.com/Fescron/Project-LabEmbeddedDesign2/tree/master/software to find the latest version!

• v1.0: Started from https://github.com/Fescron/Project-LabEmbeddedDesign1 and added code for the DS18B20 temperature sensor and the selfmade link breakage sensor. Reformatted some of these imported methods.
• v1.1: Removed unused files, add cable-checking method.
• v1.2: Moved initRTCcomp method to "util.c".
• v1.3: Stopped using deprecated function "GPIO_IntConfig".
• v1.4: Started using get/set method for the static variable "ADXL_triggered".
• v1.5: Reworked the code a lot (stopped disabling cmuClock_GPIO, ...).
• v1.6: Moved all documentation above source files to this file.
• v1.7: Updated documentation, started using a state-machine.
• v1.8: Moved checkCable method to "other.c" and started using readVBAT method.
• v1.9: Cleaned up documentation and TODO's.
• v2.0: Updated code with new DEFINE checks.
• v2.1: Updated code with new ADC functionality.
• v2.2: Started using working temperature sensor code.
• v2.3: Started using working cable checking code and added "SEND" mcu_state.
• v2.4: Started using a struct to keep the measurements in, added line to disable the RN2483.
• v2.5: Started using custom enum types for the accelerometer settings.
• v2.6: Added ADXL testing functionality.
• v2.7: Removed USTIMER logic from this file.
• v2.8: Added functionality to detect a storm.
• v2.9: Started adding LoRaWAN functionality, added more wake-up/sleep functionality.
• v3.0: Started using updated LoRaWAN send methods.
• v3.1: Added functionality to enable/disable the LED blinking when measuring/sending data.
• v3.2: Fixed button wake-up when sleeping for WAKE_UP_PERIOD_S/2.
• v3.3: Moved data.index reset to LoRaWAN sending functionality and updated documentation.
• v3.4: Moved data.index reset back to main.c.
• v3.5: Added functionality to go back to the remaining sleep time on an accelerometer wake-up.
• v3.6: Updated code to handle underlying changes.
• v4.0: Updated documentation and version number.
• v4.1: Added definitions to easily change the accelerometer's configuration settings.
• v5.0: Updated sleep logic when waking up using the accelerometer.
• v5.1: Added extra ISR handlers.
• v5.2: Removed static before a local variable (not necessary).

---

Todo:

Optimalisations:

• Change LoRaWAN Spreading Factor and send power, and check the effect on the power usage.
• Add some time to the while increment escape counters?
• Check power usage effect of disabling PM_SENS_EXT.
• Check difference between absolute/referenced mode for the accelerometer.
• Change mode to release.

Todo:

Future improvements:

• Use IAR toolchain instead of GCC, see section Optimizing code in documentation.h
• Sleep for some time in while loops instead of just incrementing the escape-counter.
  • First separate ULFRCO definition in `delay.c
• Try to shorten delays (for example: 40 ms power-up time for the RN2483...)
• Fix sleepLoRaWAN and wakeLoRaWAN functionality (also see lora_wrappers.c).

---

License

Copyright (C) 2019 - Brecht Van Eeckhoudt

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License can be found in the LICENSE file along with this source code.

Some methods also use code obtained from examples from Silicon Labs' GitHub. These sections are licensed under the Silabs License Agreement. See the file "Silabs_License_Agreement.txt" for details. Before using this software for any purpose, you must agree to the terms of that agreement.

---

Attention

See the file documentation.h for a lot of useful documentation about this project!

---

Errors

If in this project something unexpected occurs, an error method gets called. What happens in this method can be selected in util.h with the definition ERROR_FORWARDING. If it's value is 0 the MCU displays (if dbprint is enabled) a UART message and gets put in a while(true) to flash the LED. If it's value is 1 then certain values (all values except 30 - 55 since these are errors in the LoRaWAN functionality itself) get forwarded to the cloud using LoRaWAN functionality and the MCU resumes it's code.

When calling an error method, the following things were kept in mind:

• Values 0 - 9: Reserved for reset and other critical functionality.
  • 1: Send once after a reset (firstBoot == true in main.c)
  • 9: Used in sendTest(data); method (lora_wrappers.c)
• Values 10 - ... : Available to use for anything else.

Below is a list of values which correspond to certain functionality:

• 10: Problem in the case of the state machine (main.c)
• 11 - 13: adc.c
• 14 - 17: delay.c
• 18 - 19: interrupt.c
• 20 - 27: ADXL362.c
• 28 - 29: DS18B20.c
• 30 - 50: lora_wrappers.c
• 51 - 55: leuart.c

---

LoRaWAN sensor channels

• LPP_VBAT_CHANNEL 0x10 // 16
• LPP_TEMPERATURE_CHANNEL_INT 0x11 // 17
• LPP_TEMPERATURE_CHANNEL_EXT 0x12 // 18
• LPP_STORM_CHANNEL 0x13 // 19
• LPP_CABLE_BROKEN_CHANNEL 0x14 // 20
• LPP_STATUS_CHANNEL 0x15 // 21

Definition in file main.c.

Macro Definition Documentation

ADXL_ODR

#define ADXL_ODR   ADXL_ODR_12_5_HZ

The ODR setting to configure the accelerometer with

Definition at line 176 of file main.c.

ADXL_RANGE

#define ADXL_RANGE   ADXL_RANGE_8G

The g range to configure the accelerometer with

Definition at line 173 of file main.c.

ADXL_THRESHOLD

#define ADXL_THRESHOLD   7

The threshold value [g] for the accelerometer to detect and send an interrupt to wake-up the MCU

Definition at line 170 of file main.c.

LED_ENABLED

#define LED_ENABLED   0

Public definition to select if the LED is turned on while measuring or sending data

• 1 - Enable the LED when while measuring or sending data.
• 0 - Don't enable the LED while measuring or sending data.

Definition at line 181 of file main.c.

STORM_INTERRUPTS

#define STORM_INTERRUPTS   8

Amount of PIN interrupt wakeups (before a RTC wake-up) to be considered as a storm

Definition at line 167 of file main.c.

WAKE_UP_PERIOD_S

#define WAKE_UP_PERIOD_S   180

Time between each wake-up in seconds

• max 500 seconds when using LFXO delay
• 3600 seconds (one hour) works fine when using ULFRCO delay

Definition at line 164 of file main.c.

Function Documentation

checkBTNinterrupts()

bool checkBTNinterrupts

(

void

)

Method to check if any interrupts are triggered by buttons.

Returns

• true - A button interrupt was triggered.
• false - No button interrupt was triggered.

Definition at line 200 of file main.c.

{
    bool value = false;

    if (BTN_getTriggered(0))
    {

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
        dbprintln_color("PB0 pushed!", 4);
#endif /* DEBUG_DBPRINT */

        value = true;

        BTN_setTriggered(0, false); /* Clear variable */
    }


    if (BTN_getTriggered(1))
    {

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
        dbprintln_color("PB1 pushed!", 4);
#endif /* DEBUG_DBPRINT */

        value = true;

        BTN_setTriggered(1, false); /* Clear variable */
    }

    return (value);
}

HardFault_Handler()

void HardFault_Handler

(

void

)

HardFault interrupt service routine.

Note

The weak definition for this method is located in startup_gcc_efm32hg.h.

Definition at line 565 of file main.c.

{
    while(1);
}

main()

int main

(

void

)

Main function.

Definition at line 237 of file main.c.

{
    /* Keep a value if a storm has been detected */
    bool stormDetected = false;

    /* Value used to send one test LoRaWAN message after booting */
    bool firstBoot = true;

    /* Value to keep the remaining sleep time when waking up using the accelerometer */
    uint32_t remainingSleeptime = 0;

    /* Set the index to put the measurements in */
    data.index = 0;

    while (1)
    {
        switch (MCUstate)
        {
            case INIT:
            {
                CHIP_Init(); /* Initialize chip */

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
#if CUSTOM_BOARD == 1 /* Custom Happy Gecko pinout */
                dbprint_INIT(DBG_UART, DBG_UART_LOC, false, false);
                dbwarn("CUSTOM board pinout selected");
#else /* Regular Happy Gecko pinout */
                dbprint_INIT(USART1, 4, true, false); /* VCOM */
                dbwarn("REGULAR board pinout selected");
#endif /* Board pinout selection */
#endif  /* DEBUG_DBPRINT */

                led(true); /* Enable (and initialize) LED */

                delay(4000); /* 4 second delay to notice initialization */
                led(false);
                delay(100);
                led(true);

                initGPIOwakeup(); /* Initialize GPIO wake-up */

                initADC(BATTERY_VOLTAGE); /* Initialize ADC to read battery voltage */

                /* Initialize pin and disable power to RN2483 */
                GPIO_PinModeSet(PM_RN2483_PORT, PM_RN2483_PIN, gpioModePushPull, 0);

                /* Initialize pin and disable external sensor power on DRAMCO shield */
                GPIO_PinModeSet(PM_SENS_EXT_PORT, PM_SENS_EXT_PIN, gpioModePushPull, 0); // TODO: check power usage effect?

                /* Initialize accelerometer */
                if (true)
                {
                    /* Go through all of the accelerometer ODR settings to see the influence they have on power usage. */
                    if (false)
                    {
                        initADXL(); /* Initialize the accelerometer */

                        led(false);
                        testADXL();
                        led(true);
                    }

                    initADXL(); /* Initialize the accelerometer */

                    ADXL_configRange(ADXL_RANGE); /* Set the measurement range */

                    ADXL_configODR(ADXL_ODR); /* Configure ODR */

                    if (false) ADXL_readValues(); /* Read and display values forever */

                    ADXL_configActivity(ADXL_THRESHOLD); /* Configure (referenced) activity threshold mode on INT1 [g] */

                    ADXL_enableMeasure(true); /* Enable measurements */

                    delay(300);

                    ADXL_ackInterrupt(); /* ADXL gives interrupt, capture this and acknowledge it by reading from it's status register */

                    ADXL_enableSPI(false); /* Disable SPI after the initializations */

                    ADXL_clearCounter(); /* Clear the trigger counter */
                }

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
                dbprintln("");
#endif /* DEBUG_DBPRINT */

                led(false); /* Disable LED */

                MCUstate = MEASURE;
            } break;

            case MEASURE:
            {

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(true); /* Enable LED */
#endif /* LED_ENABLED */

                /* Measure and store the external temperature */
                data.extTemp[data.index] = readTempDS18B20();

                /* Measure and store the battery voltage */
                data.voltage[data.index] = readADC(BATTERY_VOLTAGE);

                /* Measure and store the internal temperature */
                data.intTemp[data.index] = readADC(INTERNAL_TEMPERATURE);

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
                dbinfoInt("Measurement ", data.index + 1, "");
                dbinfoInt("Temperature: ", data.extTemp[data.index], "");
                dbinfoInt("Battery voltage: ", data.voltage[data.index], "");
                dbinfoInt("Internal temperature: ", data.intTemp[data.index], "");
#endif /* DEBUG_DBPRINT */

                /* Increase the index to put the next measurements in */
                data.index++;

                /* Check if the cable is intact and send LoRaWAN data if necessary */
                if (checkCable(data)) data.index = 0; /* If measurements have been send, reset the index */

                if (firstBoot && (data.index > 0))
                {

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
                    dbwarn("Sending first measurements ...");
#endif /* DEBUG_DBPRINT */

                    initLoRaWAN(); /* Initialize LoRaWAN functionality */

                    sendStatus(1); /* Send the status data */

                    sendMeasurements(data); /* Send the measurements */

                    disableLoRaWAN(); /* Disable RN2483 */

                    data.index = 0; /* Reset the index to put the measurements in (needs to be here for the correct data to be affected) */

                    firstBoot = false;
                }

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(false); /* Disable LED */
#endif /* LED_ENABLED */

                /* Decide if 6 measurements are taken or not and react accordingly */
                if (data.index == 6) MCUstate = SEND;
                else MCUstate = SLEEP;
            } break;

            case SEND:
            {

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(true); /* Enable LED */
#endif /* LED_ENABLED */

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
                dbwarnInt("Sending ", data.index, " measurements ...");
#endif /* DEBUG_DBPRINT */

                initLoRaWAN(); /* Initialize LoRaWAN functionality */

                sendMeasurements(data); /* Send the measurements */

                disableLoRaWAN(); /* Disable RN2483 */

                data.index = 0; /* Reset the index to put the measurements in (needs to be here for the correct data to be affected) */

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(false); /* Disable LED */
#endif /* LED_ENABLED */

                MCUstate = SLEEP;
            } break;

            case SEND_STORM:
            {

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(true); /* Enable LED */
#endif /* LED_ENABLED */

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
                dbwarnInt("STORM DETECTED! Sending ", data.index, " measurement(s) ...");
#endif /* DEBUG_DBPRINT */

                initLoRaWAN(); /* Initialize LoRaWAN functionality */

                sendStormDetected(true); /* Send a message to indicate that a storm has been detected */

                if (data.index > 0)
                {
                    sendMeasurements(data); /* Send the already gathered measurements */

                    data.index = 0; /* Reset the index to put the measurements in (needs to be here for the correct data to be affected) */
                }

                disableLoRaWAN(); /* Disable RN2483 */

                stormDetected = true; /* Indicate that a storm has been detected */

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(false); /* Disable LED */
#endif /* LED_ENABLED */

                MCUstate = SLEEP_HALFTIME;
            } break;

            case SLEEP:
            {
                sleep(WAKE_UP_PERIOD_S); /* Go to sleep for xx seconds */

                MCUstate = WAKEUP;
            } break;

            case SLEEP_HALFTIME:
            {
                sleep(WAKE_UP_PERIOD_S/2); /* Go to sleep for xx seconds */

                MCUstate = WAKEUP;
            } break;

            case WAKEUP:
            {

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(true); /* Enable LED */
#endif /* LED_ENABLED */

                /* Check if we woke up using buttons */
                if (checkBTNinterrupts())
                {
                    ADXL_clearCounter(); /* Clear the trigger counter */
                    remainingSleeptime = 0; /* Reset passed sleeping time */

                    MCUstate = MEASURE; /* Take measurements on "case WAKEUP" exit */
                }

                /* Check if we woke up using the RTC sleep functionality and act accordingly */
                if (RTC_checkWakeup())
                {
                    RTC_clearWakeup(); /* Clear variable */

                    ADXL_clearCounter(); /* Clear the trigger counter because we woke up "normally" */
                    remainingSleeptime = 0; /* Reset passed sleeping time since it's an RTC wakeup */

                    MCUstate = MEASURE; /* Take measurements on "case WAKEUP" exit */
                }

                /* Check if we woke up using the accelerometer */
                if (ADXL_getTriggered())
                {
                    /* Check if we detected a storm */
                    if (ADXL_getCounter() > STORM_INTERRUPTS)
                    {
                        RTC_Enable(false); /* Disable the counter */

                        MCUstate = SEND_STORM; /* Storm detected, send a message on "case WAKEUP" exit */
                    }
                    else
                    {

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
                        dbprintln_color("INT-PD7 triggered!", 4);
#endif /* DEBUG_DBPRINT */

                        ADXL_enableSPI(true);  /* Enable SPI functionality */
                        ADXL_ackInterrupt();   /* Acknowledge ADXL interrupt by reading the status register */
                        ADXL_enableSPI(false); /* Disable SPI functionality */

                        /* Check if a storm was detected before going to sleep for WAKE_UP_PERIOD_S/2 */
                        if (stormDetected)
                        {
                            stormDetected = false; /* Reset variable */
                            MCUstate = MEASURE; /* Take measurements on "case WAKEUP" exit */
                        }
                        else
                        {
                            remainingSleeptime += RTC_getPassedSleeptime(); /* Add the time spend sleeping to the variable */

#if LED_ENABLED == 1 /* LED_ENABLED */
                            led(false); /* Disable LED */
#endif /* LED_ENABLED */

                            /* Go back to sleep for the remaining time until another measurement (we only take measurements on RTC/button wake-up) */
                            sleep(WAKE_UP_PERIOD_S - remainingSleeptime);

                            MCUstate = WAKEUP; /* Go back to this case if we wake-up */
                        }
                    }
                }

#if LED_ENABLED == 1 /* LED_ENABLED */
                led(false); /* Disable LED */
#endif /* LED_ENABLED */

            } break;

            default:
            {
                error(10);
            } break;
        }
    }
}

NMI_Handler()

void NMI_Handler

(

void

)

NMI interrupt service routine.

Note

The weak definition for this method is located in startup_gcc_efm32hg.h.

Definition at line 552 of file main.c.

{
    while(1);
}

PendSV_Handler()

void PendSV_Handler

(

void

)

PendSV interrupt service routine.

Note

The weak definition for this method is located in startup_gcc_efm32hg.h.

Definition at line 591 of file main.c.

{
    while(1);
}

SVC_Handler()

void SVC_Handler

(

void

)

SVC interrupt service routine.

Note

The weak definition for this method is located in startup_gcc_efm32hg.h.

Definition at line 578 of file main.c.

{
    while(1);
}

Variable Documentation

data

MeasurementData_t data

Keep the measurement data

Definition at line 189 of file main.c.

MCUstate

MCU_State_t MCUstate

static

Keep the state of the state machine

Definition at line 186 of file main.c.