miralib.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (C) 2016 LumenRadio AB                                         *
 *                                                                          *
 * This file is part of MiraOS.                                             *
 *                                                                          *
 *   MiraOS contains software components that are patented by LumenRadio.   *
 *   Use of this software is under the terms of the LumenRadio MiraOS       *
 *   license.
 *                                                                          *
 *   You should have received a copy of the MiraOS license from your        *
 *   LumenRadio representative. If not, email to <licenses@lumenradio.com>  *
 ****************************************************************************/

#ifndef LIBMIRA_H_
#define LIBMIRA_H_

#include "sys/autostart.h"
#include "sys/process.h"
#include "sys/etimer.h"
#include "mira_gpio.h"
#include "mira_adc.h"
#include "mira_pwm.h"
#include "mira_i2c.h"
#include "mira_spi.h"

#include <stdint.h>


typedef enum {
  MIRA_NOERROR                  = 0,    
  MIRA_ERROR_UNKNOWN_ADDRESS    = -1,   
  MIRA_ERROR_UNSUPPORTED_SIZE   = -2,   
} MiraErrorType;

typedef enum {
  MIRA_TO_EUI64     = 0x12,   
  MIRA_TO_ROOT      = 0x21,   
  MIRA_TO_LOCAL     = 0x41,   
  MIRA_TO_BROADCAST = 0x81    
} MiraAddressType;

typedef enum {
  MIRA_CHIP_ANTENNA     = 0,   
  MIRA_EXT_ANTENNA      = 1,   
} MiraAntennaType;

typedef enum {
  MIRA_CONNECTION_HAS_NOT_SYNCHRONIZED,   
  MIRA_CONNECTION_HAS_SYNCHRONIZED,       
  MIRA_CONNECTION_HAS_JOINED              
} MiraConnectionStatus;

typedef enum {
    MIRA_SERIAL_COMMAND_INTERFACE_DISABLED = 0,
    MIRA_SERIAL_COMMAND_INTERFACE_ENABLED
} MiraSerialCommandInterfaceMode;

typedef void (*MiraReceivedDataCallback)(uint8_t* data_ptr, uint8_t length, MiraAddressType address_type, uint8_t* address_ptr);

typedef void (*MiraReceivedMailCallback)(uint8_t* data_ptr, uint8_t length);


extern process_event_t mira_tx_queue_empty_event;


MiraErrorType mira_send_data(MiraAddressType address_type, uint8_t* address_ptr, uint8_t* data_ptr, uint8_t length);

uint8_t mira_tx_queue_is_empty(void);

#define mira_wait_for_empty_queue() \
{ \
    while (!mira_tx_queue_is_empty()) { \
        PROCESS_PAUSE(); \
    } \
}

void mira_register_data_received_callback(MiraReceivedDataCallback callback);

void mira_enable_data_forwarding();

void mira_disable_data_forwarding();

void mira_register_mail_received_callback(MiraReceivedMailCallback callback);

int8_t mira_check_mailbox(void);

void mira_set_credentials(uint16_t pan_id, uint8_t* aes_key);

void mira_become_root(void);

void mira_commit_network_setup(void);

void mira_set_name(char* name);

MiraConnectionStatus mira_get_connection_status(void);

void mira_select_antenna(MiraAntennaType antenna);

void mira_disable_rf_frontend(void);

void mira_enable_rf_frontend(void);

void mira_reboot(void);

void mira_init(MiraSerialCommandInterfaceMode serial_command_interface_mode);

void mira_init_bootloader(MiraSerialCommandInterfaceMode serial_command_interface_mode, uint16_t firmware_image_id);

void mira_set_fw_encryption_key(uint8_t *key);

void mira_copy_board_eui(uint8_t *eui_ptr);

void mira_leave_fwup_process(void);

#endif /* LIBMIRA_H_ */