Bluenet  5.7.0
Bluenet, firmware for nRF52 smart home devices
Loading...
Searching...
No Matches
cs_MicroappPackets.h File Reference
#include <cfg/cs_AutoConfig.h>
#include <cfg/cs_StaticConfig.h>
#include <cs_MemoryLayout.h>
#include <cstdint>
Include dependency graph for cs_MicroappPackets.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  microapp_binary_header_t
 Header of a microapp binary. More...
 
struct  microapp_ctrl_header_t
 
struct  microapp_upload_t
 
struct  microapp_message_t
 
struct  microapp_sdk_version_t
 SDK version: determines the API / protocol between microapp and firmware. More...
 
struct  microapp_state_t
 State of tests of a microapp, also stored in flash. More...
 
struct  microapp_status_t
 Status of a microapp. More...
 
struct  microapp_info_t
 Packet with all info required to upload a microapp, and to see the status of already uploaded microapps. More...
 

Enumerations

enum  MICROAPP_TEST_STATE { MICROAPP_TEST_STATE_UNTESTED = 0 , MICROAPP_TEST_STATE_TRYING = 1 , MICROAPP_TEST_STATE_FAILED = 2 , MICROAPP_TEST_STATE_PASSED = 3 }
 

Variables

constexpr uint16_t MICROAPP_UPLOAD_MAX_CHUNK_SIZE = 256
 Max allowed chunk size when uploading a microapp. More...
 
constexpr uint8_t MICROAPP_CONTROL_COMMAND_PROTOCOL = 1
 Protocol version of the communication over the command handler, the microapp command and result packets. More...
 
constexpr uint8_t MICROAPP_SDK_MAJOR = 1
 SDK major version of the data going back and forth between microapp and bluenet within the mutually shared buffers. More...
 
constexpr uint8_t MICROAPP_SDK_MINOR = 0
 SDK minor version of the data going back and forth between microapp and bluenet within the mutually shared buffers. More...
 
constexpr uint16_t MICROAPP_MAX_SIZE = (g_FLASH_MICROAPP_PAGES * CS_FLASH_PAGE_SIZE)
 Max flash size of a microapp, must be a multiple of flash page size. More...
 
constexpr uint8_t MICROAPP_INDEX_NONE = 255
 Invalid microapp index. More...
 
const uint8_t MICROAPP_FUNCTION_NONE = 255
 

Enumeration Type Documentation

◆ MICROAPP_TEST_STATE

Enumerator
MICROAPP_TEST_STATE_UNTESTED 
MICROAPP_TEST_STATE_TRYING 
MICROAPP_TEST_STATE_FAILED 
MICROAPP_TEST_STATE_PASSED 

Variable Documentation

◆ MICROAPP_CONTROL_COMMAND_PROTOCOL

constexpr uint8_t MICROAPP_CONTROL_COMMAND_PROTOCOL = 1
constexpr

Protocol version of the communication over the command handler, the microapp command and result packets.

◆ MICROAPP_FUNCTION_NONE

const uint8_t MICROAPP_FUNCTION_NONE = 255

◆ MICROAPP_INDEX_NONE

constexpr uint8_t MICROAPP_INDEX_NONE = 255
constexpr

Invalid microapp index.

◆ MICROAPP_MAX_SIZE

constexpr uint16_t MICROAPP_MAX_SIZE = (g_FLASH_MICROAPP_PAGES * CS_FLASH_PAGE_SIZE)
constexpr

Max flash size of a microapp, must be a multiple of flash page size.

◆ MICROAPP_SDK_MAJOR

constexpr uint8_t MICROAPP_SDK_MAJOR = 1
constexpr

SDK major version of the data going back and forth between microapp and bluenet within the mutually shared buffers.

◆ MICROAPP_SDK_MINOR

constexpr uint8_t MICROAPP_SDK_MINOR = 0
constexpr

SDK minor version of the data going back and forth between microapp and bluenet within the mutually shared buffers.

◆ MICROAPP_UPLOAD_MAX_CHUNK_SIZE

constexpr uint16_t MICROAPP_UPLOAD_MAX_CHUNK_SIZE = 256
constexpr

Max allowed chunk size when uploading a microapp.

We could calculate this from MTU or characteristic buffer size for BLE, and UART RX buffer size for UART. But let's just start with a number that fits in both.