cs_AssetFilterStore.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Nov 29, 2020
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <common/cs_Component.h>
#include <events/cs_EventListener.h>
#include <localisation/cs_AssetFilterPacketAccessors.h>
#include <protocol/cs_AssetFilterPackets.h>
#include <structs/cs_AssetFilterStructs.h>
 
#include <optional>
 
class AssetFilterStore : public EventListener, public Component {
public:
    cs_ret_code_t init();
 
    bool isReady();
 
    bool isInProgress();
 
    uint8_t getFilterCount();
 
    AssetFilter getFilter(uint8_t index);
 
    std::optional<uint8_t> findFilterIndex(uint8_t filterId);
 
    uint16_t getMasterVersion();
 
    uint32_t getMasterCrc();
 
    constexpr static uint8_t MAX_FILTER_IDS                       = 8;
 
    constexpr static size_t FILTER_BUFFER_SIZE                    = 520;
 
    constexpr static int MODIFICATION_IN_PROGRESS_TIMEOUT_SECONDS = 20;
 
private:
    uint8_t* _filters[MAX_FILTER_IDS] = {};
 
    uint8_t _filtersCount             = 0;
 
    uint16_t _masterVersion           = 0;
 
    uint32_t _masterCrc;
 
    uint16_t _modificationInProgressCountdown = 0;
 
    uint8_t* allocateFilter(uint8_t filterId, size_t stateDataSize);
 
    bool deallocateFilter(uint8_t filterId);
 
    void deallocateFilterByIndex(uint8_t parsingFilterIndex);
 
    CS_TYPE getStateType(uint16_t filterDataSize);
 
    uint16_t getStateSize(uint16_t filterDataSize);
 
    CS_TYPE getNthStateType(uint8_t index);
 
    uint8_t* findFilter(uint8_t filterId);
 
    size_t getTotalHeapAllocatedSize();
 
    // -------------------------------------------------------------
    // ---------------------- Command interface --------------------
    // -------------------------------------------------------------
 
    cs_ret_code_t handleUploadFilterCommand(const asset_filter_cmd_upload_filter_t& cmdData);
 
    cs_ret_code_t handleRemoveFilterCommand(const asset_filter_cmd_remove_filter_t& cmdData);
 
    cs_ret_code_t handleCommitFilterChangesCommand(const asset_filter_cmd_commit_filter_changes_t& cmdData);
 
    void handleGetFilterSummariesCommand(cs_result_t& result);
 
    void onTick();
 
    // -------------------------------------------------------------
    // ---------------------- Utility functions --------------------
    // -------------------------------------------------------------
 
    void startInProgress();
 
    void endInProgress(uint16_t newMasterVersion, uint32_t newMasterCrc);
 
    void inProgressTimeout();
 
    void sendInProgressStatus();
 
    cs_ret_code_t commit(uint16_t masterVersion, uint32_t masterCrc, bool store);
 
    uint32_t computeMasterCrc();
 
    bool validateFilters();
 
    void computeFilterCrcs();
 
    void storeFilters();
 
    void loadFromFlash();
 
    void loadFromFlash(CS_TYPE type);
 
    void markFiltersCommitted();
 
public:
    void handleEvent(event_t& evt);
};