cs_CmdSource.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Jul 22, 2019
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
 
#pragma once
 
#include <cstdint>
 
enum cs_cmd_source_type {
    CS_CMD_SOURCE_TYPE_ENUM      = 0,  // Source ID is one of cs_cmd_source_id.
    CS_CMD_SOURCE_TYPE_BEHAVIOUR = 1,  // Source ID is the Nth behaviour rule.
    CS_CMD_SOURCE_TYPE_BROADCAST = 3,  // Source ID is the device ID.
    CS_CMD_SOURCE_TYPE_UART      = 4,  // Source ID is the device ID.
};
 
enum cs_cmd_source_id {
    CS_CMD_SOURCE_NONE         = 0,
    CS_CMD_SOURCE_INTERNAL     = 2,  // Internal control command, should not be used.
    CS_CMD_SOURCE_CONNECTION   = 4,  // BLE connection.
    CS_CMD_SOURCE_SWITCHCRAFT  = 5,  // Switchcraft trigger.
    CS_CMD_SOURCE_TAP_TO_TOGLE = 6,  // Tap to toggle trigger.
    CS_CMD_SOURCE_MICROAPP     = 7,  // Command comes from a microapp.
};
 
struct __attribute__((packed)) cmd_source_t {
    bool flagExternal : 1;  // True when the command was received via mesh. Bit 0.
    uint8_t reserved : 4;   // Reserved for flags. Bits 1-4.
    uint8_t type : 3;       // See cs_cmd_source_type. Bits 5-7.
    uint8_t id : 8;         // Source ID, depends on type.
 
    cmd_source_t(cs_cmd_source_id sourceId = CS_CMD_SOURCE_NONE)
            : flagExternal(false), reserved(0), type(CS_CMD_SOURCE_TYPE_ENUM), id(sourceId) {}
 
    cmd_source_t(
            cs_cmd_source_type type = CS_CMD_SOURCE_TYPE_ENUM,
            uint8_t sourceId        = CS_CMD_SOURCE_NONE,
            bool viaMesh            = false)
            : flagExternal(viaMesh), reserved(0), type(type), id(sourceId) {}
};
 
struct __attribute__((packed)) cmd_source_with_counter_t {
    cmd_source_t source;
    uint8_t count;  // Command counter, increases each command.
    cmd_source_with_counter_t(cmd_source_t source = CS_CMD_SOURCE_NONE) : source(source), count(0) {}
    cmd_source_with_counter_t(cmd_source_t source, uint8_t count) : source(source), count(count) {}
};