mira_provisioning.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_PROV_H_
#define LIBMIRA_PROV_H_

#include "mira_gpio.h"

typedef enum {
    MIRA_PROV_UNKOWN = 0,                   
    MIRA_PROV_PROVISIONED = 1,              
    MIRA_PROV_PRE_PROVISIONED = 2,          
    MIRA_PROV_TEMP_PRE_PROVISIONED = 3,     
} MiraProvisionState;

typedef enum {
    MIRA_PROV_DEVICE_NOT_SELECTED = 0,      
    MIRA_PROV_DEVICE_SELECTED = 1,          
} MiraProvisionDeviceSelectedState;

typedef enum {
    MIRA_CONFIG_DATA_SUCCESS = 0,               
    MIRA_CONFIG_DATA_UNKNOWN_PAGE = 1,          
    MIRA_CONFIG_DATA_EMPTY = 2,                 
    MIRA_CONFIG_DATA_WRITE_IN_PROGRESS = 3,     
    MIRA_CONFIG_DATA_WRITE_NOT_IN_PROGRESS = 4, 
    MIRA_CONFIG_DATA_WRITE_PROTECTED = 5        
} MiraConfigDataError;

typedef enum {
    MIRA_CONFIG_WRITE_PROTECTION_WRITE_ONCE = 0,        
    MIRA_CONFIG_WRITE_PROTECTION_NONE = 1,              
} MiraConfigWriteProtection;

typedef void (*MiraProvisioningCallback)(MiraProvisionDeviceSelectedState selected_state, MiraProvisionState provisioning_state);

typedef void (*MiraConfigWrittenCallback)(uint8_t id);

void mira_provisioning_init(MiraGpioPorts provisioning_led_port, uint8_t provisioning_led_pin);


void mira_provisioning_disable_led(void);


void mira_provisioning_enable_led(void);


void mira_provisioning_override_led_set_on(void);

void mira_provisioning_override_led_set_off(void);

void mira_provisioning_release_overridden_led(void);


void mira_provisioning_register_callback(MiraProvisioningCallback callback);

MiraProvisionState mira_provisioning_get_state(void);


void mira_provisioning_config_register_data_written_callback(MiraConfigWrittenCallback callback);

MiraConfigDataError mira_provisioning_config_data_read(uint8_t id, uint8_t page_number, uint8_t* data_ptr);

MiraConfigDataError mira_provisioning_config_data_write_start(uint8_t id, MiraConfigWriteProtection write_protection);

MiraConfigDataError mira_provisioning_config_data_write(uint8_t page_number, uint8_t* data_ptr);

MiraConfigDataError mira_provisioning_config_data_write_done(void);

MiraConfigDataError mira_provisioning_config_data_write_cancel(void);

void mira_provisioning_set_custom_data_pointer(void* pointer);

void mira_provisioning_announce(void);


void mira_provisioning_set_state_temppreprovisioned();

void mira_provisioning_set_state(MiraProvisionState state);

#endif /* LIBMIRA_PROV_H_ */