cs_PresenceHandler.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Nov 13, 2019
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <common/cs_Component.h>
#include <events/cs_EventListener.h>
#include <presence/cs_PresenceDescription.h>
#include <time/cs_SystemTime.h>
#include <util/cs_Store.h>
 
#include <optional>
 
class PresenceHandler : public EventListener, public Component {
public:
    struct __attribute__((__packed__)) ProfileLocation {
        static const constexpr uint8_t MAX_LOCATION_ID = 63;
        static const constexpr uint8_t MAX_PROFILE_ID  = 7;
 
        uint8_t profile;
        uint8_t location;
 
        bool operator==(const ProfileLocation& other) { return memcmp(this, &other, sizeof(*this)) == 0; }
 
        bool isValid() { return profile <= MAX_PROFILE_ID && location <= MAX_LOCATION_ID; }
    };
 
    PresenceHandler();
    virtual ~PresenceHandler();
 
    virtual cs_ret_code_t init() override;
 
    std::optional<PresenceStateDescription> getCurrentPresenceDescription();
 
    void registerPresence(ProfileLocation profileLocation);
 
private:
    static const constexpr uint8_t PRESENCE_TIMEOUT_SECONDS                      = 10;
 
    static const constexpr uint8_t PRESENCE_MESH_SEND_THROTTLE_SECONDS           = 10;
    static const constexpr uint8_t PRESENCE_MESH_SEND_THROTTLE_SECONDS_VARIATION = 20;
 
    static const constexpr uint32_t PRESENCE_UNCERTAIN_SECONDS_AFTER_BOOT        = 30;
 
    static const constexpr uint8_t MAX_RECORDS                                   = 20;
 
    struct PresenceRecord {
        ProfileLocation profileLocation;
        uint8_t timeoutCountdownSeconds;
        uint8_t meshSendCountdownSeconds;
 
        PresenceRecord(
                ProfileLocation profileLocation = {},
                uint8_t timeoutSeconds          = PRESENCE_TIMEOUT_SECONDS,
                uint8_t meshThrottleSeconds     = 0)
                : profileLocation(profileLocation)
                , timeoutCountdownSeconds(timeoutSeconds)
                , meshSendCountdownSeconds(meshThrottleSeconds) {}
 
        void invalidate() { timeoutCountdownSeconds = 0; }
 
        bool isValid() { return timeoutCountdownSeconds != 0; }
 
        ProfileLocation id() { return profileLocation; }
    };
 
    Store<PresenceRecord, MAX_RECORDS> _store;
 
    PresenceRecord* clearOldestRecord(ProfileLocation profileLocation);
 
    void handlePresenceEvent(ProfileLocation profileLocation, bool forwardToMesh);
 
    PresenceMutation handleProfileLocation(ProfileLocation profileLocation, bool forwardToMesh);
 
    PresenceMutation getMutationType(
            std::optional<PresenceStateDescription> prevDescription,
            std::optional<PresenceStateDescription> nextDescription);
 
    void sendMeshMessage(ProfileLocation profileLocation);
 
    void dispatchPresenceChangeEvent(PresenceChange type, ProfileLocation profileLocation = {});
 
    void dispatchPresenceMutationEvent(PresenceMutation mutation);
 
    void tickSecond();
 
public:
    virtual void handleEvent(event_t& evt) override;
};