OpenMQTT-Gateway/main/config_BT.h

/*
  Theengs OpenMQTTGateway - We Unite Sensors in One Open-Source Interface

   Act as a gateway between your 433mhz, infrared IR, BLE, LoRa signal and one interface like an MQTT broker
   Send and receiving command by MQTT

   This files enables to set your parameter for the bluetooth low energy gateway (beacons detection)

    Copyright: (c)Florian ROBERT

    This file is part of OpenMQTTGateway.

    OpenMQTTGateway is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenMQTTGateway is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef config_BT_h
#define config_BT_h

#include "TheengsCommon.h"

extern void setupBT();
extern void XtoBT(const char* topicOri, JsonObject& RFdata);
extern void launchBTDiscovery(bool overrideDiscovery);
extern void stopProcessing(bool deinit);
extern String stateBTMeasures(bool);

#ifdef ESP32
#  include "NimBLEDevice.h"
#endif

/*-----------BT TOPICS & COMPILATION PARAMETERS-----------*/
#define subjectBTtoMQTT    "/BTtoMQTT"
#define subjectMQTTtoBTset "/commands/MQTTtoBT/config"
#define subjectMQTTtoBT    "/commands/MQTTtoBT"
#define subjectTrackerSync "internal/trackersync"
// Uncomment to send undecoded device data to another gateway device for decoding
// #define MQTTDecodeTopic    "undecoded"
#ifndef UseExtDecoder
#  ifdef MQTTDecodeTopic
#    define UseExtDecoder true
#  else
#    define UseExtDecoder false
#  endif
#endif
#ifndef MQTTDecodeTopic
#  define MQTTDecodeTopic "undecoded"
#endif

#ifndef AttemptBLEConnect
#  define AttemptBLEConnect true //do we by default attempt a BLE connection to sensors with ESP32
#endif

#ifndef BLE_FILTER_CONNECTABLE
#  define BLE_FILTER_CONNECTABLE 0 // Sets whether to filter publishing of scanned devices that require a connection.
#endif // Setting this to 1 prevents overwriting the publication of the device connection data with the advertised data (Recommended for use with OpenHAB).

#ifndef MinimumRSSI
#  define MinimumRSSI -100 //default minimum rssi value, all the devices below -100 will not be reported
#endif

#ifndef Scan_duration
#  define Scan_duration 10000 //define the duration for a scan; in milliseconds
#endif
#ifndef MinScanDuration
#  define MinScanDuration 1000 //minimum duration for a scan; in milliseconds
#endif
#ifndef BLEScanInterval
#  define BLEScanInterval 52 // How often the scan occurs / switches channels; in milliseconds,
#endif
#ifndef BLEScanWindow
#  define BLEScanWindow 30 // How long to scan during the interval; in milliseconds.
#endif
#ifndef AdaptiveBLEScan
#  define AdaptiveBLEScan true // Sets adaptive scanning, this will automatically decide on the best passive and active scanning intervals
#endif
#ifndef TimeBtwActive
#  define TimeBtwActive 55555 //define default time between two BLE active scans when general passive scanning is selected; in milliseconds
#endif
#ifndef MinTimeBtwScan
#  define MinTimeBtwScan 100 //define the time between two scans; in milliseconds
#endif
#ifndef TimeBtwConnect
#  define TimeBtwConnect 3600000 //define default time between BLE connection attempt (not used for immediate actions); in milliseconds
#endif
#ifndef PresenceAwayTimer
#  define PresenceAwayTimer 120000 //define the time between Offline Status update for the tracker sensors
#endif
#ifndef MovingTimer
#  define MovingTimer 60000 //define the time between Offline Status update for the moving sensors with an accelerometer
#endif

#ifndef BLEScanDuplicateCacheSize
#  define BLEScanDuplicateCacheSize 100
#endif
#ifndef MaxBLEDevices
#  define MaxBLEDevices 80
#endif
#ifndef TimeBtwRead
#  define TimeBtwRead 55555 //define default time between 2 scans; in milliseconds
#endif

#ifndef PublishOnlySensors
#  define PublishOnlySensors false //false if we publish all BLE devices discovered or true only the identified sensors (like temperature sensors)
#endif

#ifndef PublishRandomMACs
#  define PublishRandomMACs false //false to not publish devices which randomly change their MAC addresses
#endif

#ifndef HassPresence
#  define HassPresence false //true if we publish into Home Assistant presence topic
#endif

#ifndef EnableBT
#  define EnableBT true
#endif

#ifndef BLEDecoder
#  define BLEDecoder true //true if we use the Theengs decoder
#endif

#if !BLEDecoder
#  define UNKWNON_MODEL -1
#else
#  define UNKWNON_MODEL TheengsDecoder::BLE_ID_NUM::UNKNOWN_MODEL
#endif

#ifndef BLE_CNCT_TIMEOUT
#  define BLE_CNCT_TIMEOUT 3000
#endif

extern unsigned long scanCount;

#ifndef pubBLEAdvData
#  define pubBLEAdvData false // define true if you want to publish all advertisement data
#endif

#ifndef useBeaconUuidForTopic
#  define useBeaconUuidForTopic false // define true to use iBeacon UUID as topic, instead of sender (random) MAC address
#endif

#ifndef enableMultiGTWSync
#  define enableMultiGTWSync true // //define true to use tracker and closest control devices sync across OpenMQTTGateway and Theengs Gateway gateways
#endif

/*--------------HOME ASSISTANT ROOM PRESENCE--------------*/
#define subjectHomePresence "presence/" // will send Home Assistant room presence message to this topic (first part is same for all rooms, second is room name)

#ifndef useBeaconUuidForPresence
#  define useBeaconUuidForPresence false // //define true to use iBeacon UUID as for presence, instead of sender MAC (random) address
#endif

/*----------------CONFIGURABLE PARAMETERS-----------------*/
struct BTConfig_s {
  bool bleConnect; // Attempt a BLE connection to sensors with ESP32
  bool adaptiveScan;
  unsigned long intervalActiveScan; // Time between 2 active scans when generally passive scanning
  unsigned long BLEinterval; // Time between 2 scans
  unsigned long intervalConnect; // Time between 2 connects
  unsigned long scanDuration; // Duration for a scan; in milliseconds
  bool pubOnlySensors; // Publish only the identified sensors (like temperature sensors)
  bool pubRandomMACs; // Publish devices which randomly change their MAC address
  bool presenceEnable; // Publish into Home Assistant presence topic
  String presenceTopic; // Home Assistant presence topic to publish on
  bool presenceUseBeaconUuid; // Use iBeacon UUID as for presence, instead of sender MAC (random) address
  int minRssi; // Minimum rssi value, all the devices below will not be reported
  bool extDecoderEnable; // Send undecoded device data to another gateway device for decoding
  String extDecoderTopic; // Topic to send undecoded device data on
  bool filterConnectable; // Sets whether to filter publishing of scanned devices that require a connection.
  bool pubAdvData; // Publish advertisement data
  bool pubBeaconUuidForTopic; // Use iBeacon UUID as topic, instead of sender (random) MAC address
  bool ignoreWBlist; // Disable Whitelist & Blacklist
  unsigned long presenceAwayTimer; //Timer that trigger a tracker/PIR state as offline/off if not seen
  unsigned long movingTimer; //Timer that trigger a moving sensor state as offline if not seen
  bool forcePassiveScan; //Force passive scan
  bool enabled; // Enable or disable the BT gateway
};

// Global struct to store live BT configuration data
extern BTConfig_s BTConfig;

/*-------------------PIN DEFINITIONS----------------------*/
#if !defined(BT_RX) || !defined(BT_TX)
#  ifdef ESP8266
#    define BT_RX 13 //D7 ESP8266 RX connect HM-10 or 11 TX
#    define BT_TX 12 //D6 ESP8266 TX connect HM-10 or 11 RX
#  elif defined(ESP32)
#    define BT_RX 18 // not tested
#    define BT_TX 19 // not tested
#  else
#    define BT_RX 5 //arduino RX connect HM-10 or 11 TX
#    define BT_TX 6 //arduino TX connect HM-10 or 11 RX
#  endif
#endif

/*---------------INTERNAL USE: DO NOT MODIFY--------------*/
#ifdef ESP32
enum ble_val_type {
  BLE_VAL_STRING = 0,
  BLE_VAL_HEX,
  BLE_VAL_INT,
  BLE_VAL_FLOAT,
};

struct BLEAction {
  NimBLEAttValue value;
  NimBLEAddress addr;
  NimBLEUUID service;
  NimBLEUUID characteristic;
  bool write;
  bool complete;
  uint8_t ttl;
  ble_val_type value_type;
};
#endif

struct BLEdevice {
  char macAdr[18];
  char name[20];
  int macType;
  bool isDisc;
  bool isWhtL;
  bool isBlkL;
  bool connect;
  int sensorModel_id;
  unsigned long lastUpdate;
};

class BLEconectable {
public:
  enum id {
    MIN = 1000,
    LYWSD03MMC,
    MHO_C401,
    DT24_BLE,
    XMWSDJ04MMC,
    MAX,
  };
};

#endif