util.h File Reference

Utility functionality. More...

#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Macros
#define	ERROR_FORWARDING   1

Functions
void	led (bool enabled)
	Enable or disable the LED. More...
void	error (uint8_t number)
	Error method. More...

Detailed Description

Utility functionality.

Version

3.1

Author

Brecht Van Eeckhoudt

---

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 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.

Definition in file util.h.

Macro Definition Documentation

ERROR_FORWARDING

#define ERROR_FORWARDING   1

Public definition to enable/disable the logic to send certain error call values (everything except 30 - 50) to the cloud using LoRaWAN.

• 0 - Keep the MCU in a while(true) loop if the error method is called while flashing the LED and displaying a UART message.
• 1 - Display a UART message when the error method is called but also forward the number to the cloud using LoRaWAN. Don't go in a while(true) loop.

Definition at line 49 of file util.h.

Function Documentation

error()

void error

(

uint8_t

number

)

Error method.

ERROR_FORWARDING == 0
The method flashes the LED, displays a UART message and holds the MCU forever in a loop until it gets reset. The error value gets stored in a global variable.

ERROR_FORWARDING == 1
The method sends the error value to the cloud using LoRaWAN if the error number doesn't correspond to LoRaWAN-related functionality (numbers 30 - 55).

Parameters

[in]

number

The number to indicate where in the code the error was thrown.

Definition at line 131 of file util.c.

{
    /* Initialize LED if not already the case */
    if (!LED_initialized) initLED();

    /* Save the given number in the global variable */
    errorNumber = number;

#if ERROR_FORWARDING == 0 /* ERROR_FORWARDING */

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
    dbprint_color(">>> Error (", 5);
    dbprintInt(number);
    dbprintln_color(")! Please reset MCU. <<<", 5);
#endif /* DEBUG_DBPRINT */

    while (1)
    {
        delay(100);
        GPIO_PinOutToggle(LED_PORT, LED_PIN); /* Toggle LED */
    }

#else /* ERROR_FORWARDING */

    /* Check if the error number isn't called in LoRaWAN functionality */
    if ((number < 30) || (number > 55))
    {
#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
        dbprint_color(">>> Error (", 5);
        dbprintInt(number);
        dbprintln_color(")! Sending the message to the cloud. <<<", 5);
#endif /* DEBUG_DBPRINT */

        initLoRaWAN(); /* Initialize LoRaWAN functionality */

        sendStatus(number); /* Send the status value */

        disableLoRaWAN(); /* Disable RN2483 */
    }
    else
    {

#if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
        dbprint_color(">>> Error in LoRaWAN functionality (", 5);
        dbprintInt(number);
        dbprintln_color(")! <<<", 5);
#endif /* DEBUG_DBPRINT */

    }

#endif /* ERROR_FORWARDING */

}

led()

void led

(

bool

enabled

)

Enable or disable the LED.

This method also initializes the pin-mode if necessary.

Parameters

[in]

enabled

true - Enable LED. false - Disable LED.

Definition at line 103 of file util.c.

{
    /* Initialize LED if not already the case */
    if (!LED_initialized) initLED();

    /* Set the selected state */
    if (enabled) GPIO_PinOutSet(LED_PORT, LED_PIN);
    else GPIO_PinOutClear(LED_PORT, LED_PIN);
}