147 lines
5.8 KiB
C
147 lines
5.8 KiB
C
/*********************************************************************************
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2020-2022 Gregg E. Berman
|
|
*
|
|
* https://github.com/HomeSpan/HomeSpan
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
********************************************************************************/
|
|
|
|
// USER-DEFINED SETTINGS AND REFERENCE ENUMERATION CLASSES
|
|
|
|
#include <core_version.h>
|
|
|
|
#pragma once
|
|
|
|
//////////////////////////////////////////////////////
|
|
// HomeSpan Version //
|
|
|
|
#define HS_MAJOR 1
|
|
#define HS_MINOR 6
|
|
#define HS_PATCH 0
|
|
|
|
#define STRINGIFY(x) _STR(x)
|
|
#define _STR(x) #x
|
|
|
|
#define HOMESPAN_VERSION STRINGIFY(HS_MAJOR) "." STRINGIFY(HS_MINOR) "." STRINGIFY(HS_PATCH)
|
|
|
|
#define VERSION(major,minor,patch) major*10000+minor*100+patch
|
|
|
|
#ifndef REQUIRED
|
|
#define REQUIRED 0
|
|
#endif
|
|
|
|
#if (REQUIRED>VERSION(HS_MAJOR,HS_MINOR,HS_PATCH))
|
|
#error THIS SKETCH REQUIRES A LATER VERSION OF THE HOMESPAN LIBRARY
|
|
#endif
|
|
|
|
#define ARDUINO_ESP_VERSION STRINGIFY(ARDUINO_ESP32_GIT_DESC)
|
|
|
|
#if ESP_ARDUINO_VERSION_MAJOR<2
|
|
#error HOMESPAN REQUIRES VERSION 2 OF THE ARDUINO ESP32 LIBRARY
|
|
#endif
|
|
|
|
//////////////////////////////////////////////////////
|
|
// DEFAULT SETTINGS //
|
|
|
|
#define DEFAULT_CATEGORY Category::Lighting // change with optional first argument in homeSpan.begin()
|
|
#define DEFAULT_DISPLAY_NAME "HomeSpan Server" // change with optional second argument in homeSpan.begin()
|
|
#define DEFAULT_HOST_NAME "HomeSpan" // change with optional third argument in homeSpan.begin()
|
|
#define DEFAULT_MODEL_NAME "HomeSpan-ESP32" // change with optional fourth argument in homeSpan.begin()
|
|
|
|
#define DEFAULT_SETUP_CODE "46637726" // changed during network setup or with 'S' command
|
|
|
|
#define DEFAULT_QR_ID "HSPN" // change with homeSpan.setQRID(qrID);
|
|
|
|
#define DEFAULT_STATUS_PIN -1 // change with homeSpan.setStatusPin(pin)
|
|
|
|
#define DEFAULT_AP_SSID "HomeSpan-Setup" // change with homeSpan.setApSSID(ssid)
|
|
#define DEFAULT_AP_PASSWORD "homespan" // change with homeSpan.setApPassword(pwd)
|
|
#define DEFAULT_OTA_PASSWORD "homespan-ota" // change with 'O' command
|
|
|
|
#define DEFAULT_AP_TIMEOUT 300 // change with homeSpan.setApTimeout(nSeconds)
|
|
#define DEFAULT_COMMAND_TIMEOUT 120 // change with homeSpan.setCommandTimeout(nSeconds)
|
|
|
|
#define DEFAULT_LOG_LEVEL 0 // change with homeSpan.setLogLevel(level)
|
|
|
|
#define DEFAULT_TCP_PORT 80 // change with homeSpan.setPort(port);
|
|
|
|
#define DEFAULT_WEBLOG_URL "status" // change with optional fourth argument in homeSpan.enableWebLog()
|
|
|
|
/////////////////////////////////////////////////////
|
|
// OTA PARTITION INFO //
|
|
|
|
#define HOMESPAN_MAGIC_COOKIE "HomeSpanMagicCookie##2022"
|
|
|
|
/////////////////////////////////////////////////////
|
|
// STATUS LED SETTINGS //
|
|
|
|
#define LED_WIFI_NEEDED 300,0.5,1,2700 // slow single-blink
|
|
#define LED_PAIRING_NEEDED 300,0.5,2,2400 // slow double-blink
|
|
#define LED_ALERT 100 // rapid flashing
|
|
#define LED_WIFI_CONNECTING 2000 // slow flashing
|
|
#define LED_AP_STARTED 100,0.5,2,300 // rapid double-blink
|
|
#define LED_AP_CONNECTED 300,0.5,2,400 // medium double-blink
|
|
#define LED_OTA_STARTED 300,0.5,3,400 // medium triple-blink
|
|
|
|
/////////////////////////////////////////////////////
|
|
// Message Log Level Control Macros //
|
|
// 0=Minimal, 1=Informative, 2=All //
|
|
|
|
#define LOG0(format,...) Serial.print ##__VA_OPT__(f)(format __VA_OPT__(,) __VA_ARGS__)
|
|
#define LOG1(format,...) if(homeSpan.getLogLevel()>0)Serial.print ##__VA_OPT__(f)(format __VA_OPT__(,) __VA_ARGS__)
|
|
#define LOG2(format,...) if(homeSpan.getLogLevel()>1)Serial.print ##__VA_OPT__(f)(format __VA_OPT__(,) __VA_ARGS__)
|
|
|
|
#define WEBLOG(format,...) homeSpan.addWebLog(false, format __VA_OPT__(,) __VA_ARGS__)
|
|
|
|
//////////////////////////////////////////////////////
|
|
// Types of Accessory Categories //
|
|
// Reference: HAP Section 13 //
|
|
|
|
enum class Category {
|
|
Other=1,
|
|
Bridges=2,
|
|
Fans=3,
|
|
GarageDoorOpeners=4,
|
|
Lighting=5,
|
|
Locks=6,
|
|
Outlets=7,
|
|
Switches=8,
|
|
Thermostats=9,
|
|
Sensors=10,
|
|
SecuritySystems=11,
|
|
Doors=12,
|
|
Windows=13,
|
|
WindowCoverings=14,
|
|
ProgrammableSwitches=15,
|
|
IPCameras=17,
|
|
VideoDoorbells=18,
|
|
AirPurifiers=19,
|
|
Heaters=20,
|
|
AirConditioners=21,
|
|
Humidifiers=22,
|
|
Dehumidifiers=23,
|
|
Sprinklers=28,
|
|
Faucets=29,
|
|
ShowerSystems=30,
|
|
Television=31
|
|
};
|