cs_MeshTopologyResearch.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: May 6, 2020
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
 
#pragma once
 
#include <events/cs_EventListener.h>
#include <protocol/cs_MeshTopologyPackets.h>
#include <structs/cs_PacketsInternal.h>
#include <util/cs_Coroutine.h>
#include <util/cs_Variance.h>
 
#include <cstdint>
#include <map>
 
class MeshTopologyResearch : public EventListener {
public:
    MeshTopologyResearch();
 
    void handleEvent(event_t& evt);
 
    void init();
 
private:
    stone_id_t my_id                                                     = 0xff;
 
    // stores the relevant history, per neighbor stone_id.
    static constexpr uint8_t CHANNEL_COUNT                               = 3;
    static constexpr uint8_t CHANNEL_START                               = 37;
 
    // TODO: change maps to object for small ram memory footprint optimization
    std::map<stone_id_t, VarianceAggregator> variance_map[CHANNEL_COUNT] = {};
 
    // will be set to true by coroutine to flush data after startup.
    bool boot_sequence_finished                                          = false;
 
    // loop variables to keep track of outside of coroutine for the burst loop
    stone_id_t last_stone_id_broadcasted_in_burst                        = 0;
 
    // --------------- Coroutine parameters ---------------
 
    Coroutine flushRoutine;
 
    struct TimingSettings {
        uint8_t min_samples_to_trigger_burst;
 
        uint32_t burst_period_ms;
 
        uint32_t accumulation_period_ms;
 
        uint32_t boot_sequence_period_ms;
    };
 
    static constexpr TimingSettings Settings = {
#ifdef DEBUG
            .min_samples_to_trigger_burst = 20,
            .burst_period_ms              = 500,
            .accumulation_period_ms       = 2 * 60 * 1000,
            .boot_sequence_period_ms      = 1 * 60 * 1000
#else
            .min_samples_to_trigger_burst = 20,
            .burst_period_ms              = 5,
            .accumulation_period_ms       = 30 * 60 * 1000,
            .boot_sequence_period_ms      = 1 * 60 * 1000,
#endif
    };
 
    // -------------------- Methods --------------------
 
    uint32_t flushAggregatedRssiData();
 
    inline uint8_t getVarianceRepresentation(float standard_deviation);
 
    inline uint8_t getMeanRssiRepresentation(float mean);
 
    inline uint8_t getCountRepresentation(uint32_t count);
 
    // --------------- generating rssi data --------------
 
    void sendPingRequestOverMesh();
 
    void sendPingResponseOverMesh();
 
    void receivePingMessage(MeshMsgEvent& mesh_msg_evt);
 
    // ------------- communicating rssi data -------------
 
    void sendRssiDataOverMesh(rssi_data_message_t* rssi_data_message);
 
    void sendRssiDataOverUart(rssi_data_message_t* rssi_data_message);
 
    void receiveRssiDataMessage(MeshMsgEvent& mesh_msg_evt);
 
    // ------------- recording mesh messages -------------
 
    void receiveMeshMsgEvent(MeshMsgEvent& mesh_msg_evt);
 
    void recordRssiValue(stone_id_t sender_id, int8_t rssi, uint8_t channel);
};