cs_CrownstoneCentral.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Apr 15, 2021
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
 
#pragma once
 
#include <ble/cs_UUID.h>
#include <events/cs_EventListener.h>
 
class CrownstoneCentral : EventListener {
public:
    cs_ret_code_t init();
 
    cs_ret_code_t connect(stone_id_t stoneId, uint16_t timeoutMs = 3000);
 
    cs_ret_code_t connect(const device_address_t& address, uint16_t timeoutMs = 3000);
 
    cs_ret_code_t disconnect();
 
    cs_ret_code_t write(cs_control_cmd_t commandType, uint8_t* data, uint16_t size);
 
    cs_data_t requestWriteBuffer();
 
private:
    enum ServiceIndex {
        SERVICE_INDEX_CROWNSTONE  = 0,
        SERVICE_INDEX_SETUP       = 1,
        SERVICE_INDEX_DEVICE_INFO = 2,
        SERVICE_INDEX_DFU         = 3,
        SERVICE_INDEX_COUNT       = 4
    };
 
    enum class Operation : uint8_t { NONE, CONNECT, WRITE };
 
    enum class ConnectSteps : uint8_t {
        NONE = 0,
        GET_ADDRESS,
        CONNECT,
        DISCOVER,
        ENABLE_NOTIFICATIONS,
        SESSION_KEY,
        SESSION_DATA,
        DONE
    };
 
    enum class WriteControlSteps : uint8_t { NONE = 0, WRITE, RECEIVE_RESULT, DONE };
 
    UUID _serviceUuids[SERVICE_INDEX_COUNT];
 
    uint16_t _sessionKeyHandle;
    uint16_t _sessionDataHandle;
    uint16_t _controlHandle;
    uint16_t _resultHandle;
    uint16_t _resultCccdHandle;
 
    OperationMode _opMode       = OperationMode::OPERATION_MODE_UNINITIALIZED;
 
    Operation _currentOperation = Operation::NONE;
 
    uint8_t _currentStep;
 
    uint8_t _notificationNextIndex       = 0;
 
    uint16_t _notificationMergedDataSize = 0;
 
    stone_id_t _stoneId                  = 0;
 
    uint16_t _timeoutMs;
 
    uint16_t _timeoutCountDown = 0;
 
    void reset();
 
    void resetNotifactionMergerState();
 
    void readSessionData();
 
    cs_ret_code_t mergeNotification(const cs_const_data_t& notificationData, cs_data_t& resultData);
 
    bool isBusy();
 
    void startTimeoutTimer(uint16_t timeoutMs);
    void stopTimeoutTimer();
 
    void setStep(ConnectSteps step);
    void setStep(WriteControlSteps step);
    void setStep(uint8_t step);
 
    bool finalizeStep(uint8_t step, cs_ret_code_t retCode);
    bool finalizeStep(ConnectSteps step, cs_ret_code_t retCode);
    bool finalizeStep(WriteControlSteps step, cs_ret_code_t retCode);
 
    void finalizeOperation(Operation operation, cs_ret_code_t retCode);
    void finalizeOperation(Operation operation, uint8_t* data, uint8_t dataSize);
    void sendOperationResult(event_t& event);
 
    void onTimeout();
    void onMacAddress(mesh_topo_mac_result_t& result);
    void onConnect(cs_ret_code_t retCode);
    void onDisconnect();
    void onDiscovery(ble_central_discovery_t& result);
    void onDiscoveryDone(cs_ret_code_t retCode);
    void onRead(ble_central_read_result_t& result);
    void onReadDuringConnect(ble_central_read_result_t& result);
    void onWrite(ble_central_write_result_t& result);
    void onNotification(ble_central_notification_t& result);
 
public:
    void handleEvent(event_t& event);
};