mira_provisioning.h File Reference

MiraOS provisioning application. More...

Go to the source code of this file.

Enumerations
enum	MiraProvisionState { MIRA_PROV_UNKOWN = 0, MIRA_PROV_PROVISIONED = 1, MIRA_PROV_PRE_PROVISIONED = 2, MIRA_PROV_TEMP_PRE_PROVISIONED = 3 }
	Provisioning States. More...
enum	MiraConfigDataError {   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 }
	Result codes for provisioning configuration data. More...
enum	MiraConfigWriteProtection { MIRA_CONFIG_WRITE_PROTECTION_WRITE_ONCE = 0, MIRA_CONFIG_WRITE_PROTECTION_NONE = 1 }
	Write protection configuration options. More...

Functions
void	mira_provisioning_init (void)
	Initialize provisioning application. More...
MiraProvisionState	mira_provisioning_get_state (void)
	Get the provisioning state. More...
MiraConfigDataError	mira_provisioning_config_data_read (uint8_t id, uint8_t page_number, uint8_t *data_ptr)
	Get a page of configuration data. More...
MiraConfigDataError	mira_provisioning_config_data_write_start (uint8_t id, MiraConfigWriteProtection write_protection)
	Start a configuration block write. More...
MiraConfigDataError	mira_provisioning_config_data_write (uint8_t page_number, uint8_t *data_ptr)
	Write a page to a configuration block. More...
MiraConfigDataError	mira_provisioning_config_data_write_done (void)
	Finish a configuration block write. More...
MiraConfigDataError	mira_provisioning_config_data_write_cancel (void)
	Cancel a configuration block write. More...

Detailed Description

MiraOS provisioning application.

Author

LumenRadio AB

Date

17 Jan 2016 The MiraOS library provides functions for controlling the Mira radio module, sending/receiving messages, controlling peripherals, etc.

See also

http://docs.lumenrad.io/mira

Enumeration Type Documentation

enum MiraConfigDataError

Result codes for provisioning configuration data.

Enumerator
MIRA_CONFIG_DATA_SUCCESS	Success
MIRA_CONFIG_DATA_UNKNOWN_PAGE	Configuration block or page number is unknown
MIRA_CONFIG_DATA_EMPTY	Configuration block is empty
MIRA_CONFIG_DATA_WRITE_IN_PROGRESS	A write is currently in progress
MIRA_CONFIG_DATA_WRITE_NOT_IN_PROGRESS	Writing has not been started
MIRA_CONFIG_DATA_WRITE_PROTECTED	Data block is write protected

enum MiraConfigWriteProtection

Write protection configuration options.

Enumerator
MIRA_CONFIG_WRITE_PROTECTION_WRITE_ONCE	Write once
MIRA_CONFIG_WRITE_PROTECTION_NONE	Write/erase enabled

enum MiraProvisionState

Provisioning States.

Enumerator
MIRA_PROV_UNKOWN	Unprovisioned or otherwise unknown state
MIRA_PROV_PROVISIONED	Provisioned state
MIRA_PROV_PRE_PROVISIONED	Pre-provisioned state
MIRA_PROV_TEMP_PRE_PROVISIONED	Temporary pre-provisioned state

Function Documentation

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

Get a page of configuration data.

Parameters

id	configuration data block ID
page_number	page number within the data block
data_ptr	pointer to where data should be written. Buffer MUST be at least 32 bytes.

Returns

Result code

MiraConfigDataError mira_provisioning_config_data_write	(	uint8_t	page_number,
		uint8_t *	data_ptr
	)

Write a page to a configuration block.

Parameters

page_number	page number within the data block
data_ptr	pointer to where data should be written. Data length is always 32 bytes.

Returns

Result code

MiraConfigDataError mira_provisioning_config_data_write_cancel

(

void

)

Cancel a configuration block write.

If this function is called, any data written to this page will be discarded and the old data kept.

Returns

Result code

MiraConfigDataError mira_provisioning_config_data_write_done

(

void

)

Finish a configuration block write.

Returns

Result code

MiraConfigDataError mira_provisioning_config_data_write_start	(	uint8_t	id,
		MiraConfigWriteProtection	write_protection
	)

Start a configuration block write.

Parameters

id	configuration data block ID
write_protect	write protection flag

Returns

Result code

MiraProvisionState mira_provisioning_get_state

(

void

)

Get the provisioning state.

Returns

The current state of the device provisioning application

void mira_provisioning_init

(

void

)

Initialize provisioning application.

Returns

logic level at input pin