HT32SX Monarch Scan
Monarch Scan application for HT32SX
retriever_api.h File Reference

This is used to retrieve the SigFox data as ID, PAC and AES-KEY. The AES-KEY is a private variable and is not returned to the user. More...

#include <stdint.h>
#include "nvm_api.h"

Go to the source code of this file.

Macros

#define RETR_OK   0 /* no error */
 
#define RETR_ERR   1 /* error */
 

Typedefs

typedef uint8_t retr_error_t
 

Enumerations

enum  KEY_ENC_MODES { KEY_ENC_FIXED = 0x01, KEY_ENC_VARIABLE = 0x02, KEY_ENC_NONE = 0x03 }
 

Functions

retr_error_t enc_utils_retrieve_data (uint32_t *id, uint8_t *pac, uint8_t *rcz)
 Retrieve the ID, PAC and RCZ number of the board and returns it to the caller. The ID should be used when opening the library. The PAC is used to register the node on the backend. More...
 
uint8_t enc_utils_retrieve_data_from_flash (NVM_BoardDataType *nvmBoardData)
 Retrieve board informations accordint to the NVM_BoardDataType and returns it to the caller. More...
 
retr_error_t enc_utils_encrypt (uint8_t *encrypted_data, uint8_t *data_to_encrypt, uint16_t data_len, uint8_t *key, uint8_t useExternalKey)
 
retr_error_t enc_utils_set_public_key (uint8_t en)
 Switch the encryption key to the public key: 0x00,0x11,0x22,0x33,0x44,0x55,0x66,0x77,0x88,0x99,0xAA,0xBB,0xCC,0xDD,0xEE,0xFF. More...
 
retr_error_t enc_utils_set_test_key (uint8_t en)
 Switch the to the test KEY 0x0123456789ABCDEF0123456789ABCDEF. More...
 
retr_error_t enc_utils_set_test_id (uint8_t en)
 Switch the to the test ID 0xFEDCBA98. More...
 
retr_error_t enc_utils_get_id (uint8_t *id)
 Gets the ID from the EEPROM on the board. More...
 
retr_error_t enc_utils_get_initial_pac (uint8_t *pac)
 Gets the PAC from the EEPROM on the board. More...
 

Detailed Description

This is used to retrieve the SigFox data as ID, PAC and AES-KEY. The AES-KEY is a private variable and is not returned to the user.

Author
LowPower RF BU - AMG
Version
1.3.0
Date
Feb 15, 2019

THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.

THIS SOURCE CODE IS PROTECTED BY A LICENSE. FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE.

© COPYRIGHT 2019 STMicroelectronics