HomeSpan/docs/Reference.md

HomeSpan API Reference

The HomeSpan Library is invoked by including HomeSpan.h in your Arduino sketch as follows:

#include "HomeSpan.h"

homeSpan

At runtime HomeSpan will create a global object named homeSpan that supports the following methods:

• void begin(Category catID, const char *displayName, const char *hostNameBase, const char *modelName)

  • initializes HomeSpan
  • must be called at the beginning of each sketch before any other HomeSpan functions and is typically placed near the top of the Arduino setup() method, but after Serial.begin() so that initialization diagnostics can be output to the Serial Monitor
  • all arguments are optional
    • catID - the HAP Category HomeSpan broadcasts for pairing to HomeKit. Default is Category::Lighting. See HomeSpan Accessory Categories for a complete list
    • displayName - the MDNS display name broadcast by HomeSpan. Default is "HomeSpan Server"
    • hostNameBase - the full MDNS host name is broadcast by HomeSpan as hostNameBase-DeviceID.local, where DeviceID is a unique 6-byte code generated automatically by HomeSpan. Default is "HomeSpan"
    • modelName - the HAP model name HomeSpan broadcasts for pairing to HomeKit. Default is "HomeSpan-ESP32"
  • example: homeSpan.begin(Category::Fans, "Living Room Ceiling Fan");

• void poll()

  • checks for HAP requests, local commands, and device activity
  • must be called repeatedly in each sketch and is typically placed at the top of the Arduino loop() method

---

The following optional homeSpan methods override various HomeSpan initialization parameters used in begin(), and therefore should be called before begin() to take effect. If a method is not called, HomeSpan uses the default parameter indicated below:

• void setControlPin(uint8_t pin)

  • sets the ESP32 pin to use for the HomeSpan Control Button. If not specified, HomeSpan will assume there is no Control Button

• void setStatusPin(uint8_t pin)

  • sets the ESP32 pin to use for the HomeSpan Status LED. If not specified, HomeSpan will assume there is no Status LED

• void setStatusAutoOff(uint16_t duration)

  • sets Status LED to automatically turn off after duration seconds
  • Status LED will automatically turn on, and duration timer will be reset, whenever HomeSpan activates a new blinking pattern
  • if duration is set to zero, auto-off is disabled (Status LED will remain on indefinitely)

• int getStatusPin()

• returns the pin number of the Status LED as set by setStatusPin(pin), or -1 if no pin has been set

• void setApSSID(const char *ssid)

  • sets the SSID (network name) of the HomeSpan Setup Access Point (default="HomeSpan-Setup")

• void setApPassword(const char *pwd)

  • sets the password of the HomeSpan Setup Access Point (default="homespan")

• void setApTimeout(uint16_t nSec)

  • sets the duration (in seconds) that the HomeSpan Setup Access Point, once activated, stays alive before timing out (default=300 seconds)

• void setCommandTimeout(uint16_t nSec)

  • sets the duration (in seconds) that the HomeSpan End-User Command Mode, once activated, stays alive before timing out (default=120 seconds)

• void setLogLevel(uint8_t level)

  • sets the logging level for diagnostic messages, where:
    • 0 = top-level status messages only (default),
    • 1 = all status messages, and
    • 2 = all status messages plus all HAP communication packets to and from the HomeSpan device
  • this parameter can also be changed at runtime via the HomeSpan CLI

• void reserveSocketConnections(uint8_t nSockets)

  • reserves nSockets network sockets for uses other than by the HomeSpan HAP Server for HomeKit Controller Connections
    • for sketches compiled under Arduino-ESP32 v2.0.1 or later, HomeSpan reserves 14 sockets for HAP Controller Connections
    • each call to reserveSocketConnections(nSockets) reduces this number by nSockets
    • use this method if you add code to a sketch that requires its own socket connections (e.g. a separate web service, an MQTT server, etc.)
  • multiple calls to this method are allowed - the number of sockets reserved will be the sum of nSockets across all calls
  • note you do not need to separately reserve sockets for built-in HomeSpan functionality
    • for example, enableOTA() already contains an embedded call to reserveSocketConnections(1) since HomeSpan knows one socket must be reserved to support OTA

• void setPortNum(uint16_t port)

  • sets the TCP port number used for communication between HomeKit and HomeSpan (default=80)

• void setHostNameSuffix(const char *suffix)

  • sets the suffix HomeSpan appends to hostNameBase to create the full hostName
  • if not specified, the default is for HomeSpan to append a dash "-" followed the 6-byte Accessory ID of the HomeSpan device
  • setting suffix to a null string "" is permitted
  • example: homeSpan.begin(Category::Fans, "Living Room Ceiling Fan", "LivingRoomFan"); will yield a default hostName of the form LivingRoomFan-A1B2C3D4E5F6.local. Calling homeSpan.setHostNameSuffix("v2") prior to homeSpan.begin() will instead yield a hostName of LivingRoomFanv2.local

• void setQRID(const char *id)

  • changes the Setup ID, which is used for pairing a device with a QR Code, from the HomeSpan default to id
  • the HomeSpan default is "HSPN" unless permanently changed for the device via the HomeSpan CLI using the 'Q' command
  • id must be exactly 4 alphanumeric characters (0-9, A-Z, and a-z). If not, the request to change the Setup ID is silently ignored and the default is used instead

---

The following optional homeSpan methods enable additional features and provide for further customization of the HomeSpan environment. Unless otherwise noted, calls should be made before begin() to take effect:

• void enableOTA(boolean auth=true, boolean safeLoad=true)

  • enables Over-the-Air (OTA) Updating of a HomeSpan device, which is otherwise disabled
  • HomeSpan OTA requires an authorizing password unless auth is specified and set to false
  • the default OTA password for new HomeSpan devices is "homespan-ota"
  • this can be changed via the HomeSpan CLI using the 'O' command
  • note enabling OTA reduces the number of HAP Controller Connections by 1
  • OTA Safe Load will be enabled by default unless the second argument is specified and set to false. HomeSpan OTA Safe Load checks to ensure that sketches uploaded to an existing HomeSpan device are themselves HomeSpan sketches, and that they also have OTA enabled. See HomeSpan OTA Safe Load for details

• void enableAutoStartAP()

  • enables automatic start-up of WiFi Access Point if WiFi Credentials are not found at boot time
  • methods to alter the behavior of HomeSpan's Access Point, such as setApTimeout(), must be called prior to enableAutoStartAP() to have an effect

• void setApFunction(void (*func)())

  • replaces HomeSpan's built-in WiFi Access Point with user-defined function func
  • func must be of type void and have no arguments
  • func will be called instead of HomeSpan's built-in WiFi Access Point whenever the Access Point is launched:
    • via the CLI by typing 'A', or
    • via the Control Button using option 3 of the Command Mode, or
    • automatically upon start-up if enableAutoStartAP() is set and there are no stored WiFi Credentials
  • after identifying the SSID and password of the desired network, func must call setWifiCredentials() to save and use these values
  • it is recommended that func terminates by restarting the device using ESP.restart(). Upon restart HomeSpan will use the SSID and password just saved

• void setWifiCredentials(const char *ssid, const char *pwd)

  • sets the SSID (ssid) and password (pwd) of the WiFi network to which HomeSpan will connect
  • ssid and pwd are automatically saved in HomeSpan's non-volatile storage (NVS) for retrieval when the device restarts
  • note that the saved values are truncated if they exceed the maximum allowable characters (ssid=32; pwd=64)

⚠️ SECURITY WARNING: The purpose of this function is to allow advanced users to dynamically set the device's WiFi Credentials using a customized Access Point function specified by setApFunction(func). It it NOT recommended to use this function to hardcode your WiFi SSID and password directly into your sketch. Instead, use one of the more secure methods provided by HomeSpan, such as typing 'W' from the CLI, or launching HomeSpan's Access Point, to set your WiFi credentials without hardcoding them into your sketch

• void setWifiCallback(void (*func)())

  • sets an optional user-defined callback function, func, to be called by HomeSpan upon start-up just after WiFi connectivity has been established. This one-time call to func is provided for users that are implementing other network-related services as part of their sketch, but that cannot be started until WiFi connectivity is established. The function func must be of type void and have no arguments

• void setPairCallback(void (*func)(boolean status))

  • sets an optional user-defined callback function, func, to be called by HomeSpan upon completion of pairing to a controller (status=true) or unpairing from a controller (status=false)
  • this one-time call to func is provided for users that would like to trigger additional actions when the device is first paired, or the device is later unpaired
  • note this func is not called upon start-up and should not be used to simply check whether a device is paired or unpaired. It is only called when pairing status changes
  • the function func must be of type void and have one boolean argument

• void setPairingCode(const char *s)

  • sets the Setup Pairing Code to s, which must be exactly eight numerical digits (no dashes)
  • example: homeSpan.setPairingCode("46637726");
  • a hashed version of the Pairing Code will be saved to the device's non-volatile storage, overwriting any currently-stored Pairing Code
  • if s contains an invalid code, an error will be reported and the code will not be saved. Instead, the currently-stored Pairing Code (or the HomeSpan default Pairing Code if no code has been stored) will be used
  • ❗ SECURTY WARNING: Hardcoding a device's Pairing Code into your sketch is considered a security risk and is not recommended. Instead, use one of the more secure methods provided by HomeSpan, such as typing 'S <code>' from the CLI, or launching HomeSpan's Access Point, to set your Pairing Code without hardcoding it into your sketch

• void deleteStoredValues()

  • deletes the value settings of all stored Characteristics from the NVS
  • performs the same function as typing 'V' into the CLI
  • can by called from anywhere in a sketch

• void setSketchVersion(const char *sVer)

  • sets the version of a HomeSpan sketch to sVer, which can be any arbitrary character string
  • if unspecified, HomeSpan uses "n/a" as the default version text
  • HomeSpan displays the version of the sketch in the Arduino IDE Serial Monitor upon start-up
  • HomeSpan also includes both the version of the sketch, as well as the version of the HomeSpan library used to compile the sketch, as part of its HAP MDNS broadcast. This data is not used by HAP. Rather, it is for informational purposes and allows you to identify the version of a sketch for a device that is updated via OTA, rather than connected to a computer

• const char *getSketchVersion()

  • returns the version of a HomeSpan sketch, as set using void setSketchVersion(const char *sVer), or "n/a" if not set
  • can by called from anywhere in a sketch

• void enableWebLog(uint16_t maxEntries, const char *timeServerURL, const char *timeZone, const char *logURL)

  • enables a rolling web log that displays the most recent maxEntries entries created with the WEBLOG() macro. Parameters, and their default values if unspecified, are as follows:
    • maxEntries - maximum number of (most recent) entries to save. If unspecified, defaults to 0, in which case the web log will only display status without any log entries
    • timeServerURL - the URL of a time server that HomeSpan will use to set its clock upon startup after a WiFi connection has been established. If unspecified, default to NULL, in which case HomeSpan skips setting the device clock
    • timeZone - specifies the time zone to use for setting the clock. Uses standard Unix timezone formatting as interpreted by Espressif IDF. Note the IDF uses a somewhat non-intuitive convention such that a timezone of "UTC+5:00" subtracts 5 hours from UTC time, and "UTC-5:00" adds 5 hours to UTC time. If serverURL=NULL this field is ignored; if serverURL!=NULL this field is required
    • logURL - the URL of the log page for this device. If unspecified, defaults to "status"
  • example: homeSpan.enableWebLog(50,"pool.ntp.org","UTC-1:00","myLog"); creates a web log at the URL http://HomeSpan-[DEVICE-ID].local:[TCP-PORT]/myLog that will display the 50 most-recent log messages produced with the WEBLOG() macro. Upon start-up (after a WiFi connection has been established) HomeSpan will attempt to set the device clock by calling the server "pool.ntp.org" and adjusting the time to be 1 hour ahead of UTC.
  • When attemping to connect to timeServerURL, HomeSpan waits 10 seconds for a response. If no response is received after the 10-second timeout period, HomeSpan assumes the server is unreachable and skips the clock-setting procedure. Use setTimeServerTimeout() to re-configure the 10-second timeout period to another value
  • See HomeSpan Logging for complete details

• void setTimeServerTimeout(uint32_t tSec)

  • changes the default 10-second timeout period HomeSpan uses when enableWebLog() tries set the device clock from an internet time server to tSec seconds

SpanAccessory(uint32_t aid)

Creating an instance of this class adds a new HAP Accessory to the HomeSpan HAP Database.

• every HomeSpan sketch requires at least one Accessory

• a sketch can contain a maximum of 41 Accessories per sketch (if exceeded, a runtime error will the thrown and the sketch will halt)

• there are no associated methods

• the argument aid is optional.

  • if specified and not zero, the Accessory ID is set to aid.
  • if unspecified, or equal to zero, the Accessory ID will be set to one more than the ID of the previously-instantiated Accessory, or to 1 if this is the first Accessory.
  • the first Accessory instantiated must always have an ID=1 (which is the default if aid is unspecified).
  • setting the aid of the first Accessory to anything but 1 throws an error during initialization.

• you must call homeSpan.begin() before instantiating any Accessories

• example: new SpanAccessory();

SpanService()

This is a base class from which all HomeSpan Services are derived, and should not be directly instantiated. Rather, to create a new Service instantiate one of the HomeSpan Services defined in the Service namespace. No arguments are needed.

• instantiated Services are added to the HomeSpan HAP Database and associated with the last Accessory instantiated
• instantiating a Service without first instantiating an Accessory throws an error during initialization
• example: new Service::MotionSensor();

The following methods are supported:

• SpanService *setPrimary()

  • specifies that this is the primary Service for the Accessory. Returns a pointer to the Service itself so that the method can be chained during instantiation.
  • example: (new Service::Fan)->setPrimary();

• SpanService *setHidden()

  • specifies that this is hidden Service for the Accessory. Returns a pointer to the Service itself so that the method can be chained during instantiation.
  • note this does not seem to have any affect on the Home App. Services marked as hidden still appear as normal

• SpanService *addLink(SpanService *svc)

  • adds svc as a Linked Service. Returns a pointer to the calling Service itself so that the method can be chained during instantiation.
  • note that Linked Services are only applicable for select HAP Services. See Apple's HAP-R2 documentation for full details.
  • example: (new Service::Faucet)->addLink(new Service::Valve)->addLink(new Service::Valve); (links two Valves to a Faucet)

• vector<SpanService *> getLinks()

  • returns a vector of pointers to Services that were added using addLink()
  • useful for creating loops that iterate over all linked Services
  • note that the returned vector points to generic SpanServices, which should be re-cast as needed
  • example: for(auto myValve : faucet::getLinks()) { if((MyValve *)myValve)->active->getVal()) ... } checks all Valves linked to to a Faucet

• virtual boolean update()

  • HomeSpan calls this method upon receiving a request from a HomeKit Controller to update one or more Characteristics associated with the Service. Users should override this method with code that implements that requested updates using one or more of the SpanCharacteristic methods below. Method must return true if update succeeds, or false if not.

• virtual void loop()

  • HomeSpan calls this method every time homeSpan.poll() is executed. Users should override this method with code that monitors for state changes in Characteristics that require HomeKit Controllers to be notified using one or more of the SpanCharacteristic methods below.

• virtual void button(int pin, int pressType)

  • HomeSpan calls this method whenever a SpanButton() object associated with the Service is triggered. Users should override this method with code that implements any actions to be taken in response to the SpanButton() trigger using one or more of the SpanCharacteristic methods below.
    • pin - the ESP32 pin associated with the SpanButton() object
    • pressType -
      • 0=single press (SpanButton::SINGLE)
      • 1=double press (SpanButton::DOUBLE)
      • 2=long press (SpanButton::LONG)

SpanCharacteristic(value [,boolean nvsStore])

This is a base class from which all HomeSpan Characteristics are derived, and should not be directly instantiated. Rather, to create a new Characteristic instantiate one of the HomeSpan Characteristics defined in the Characteristic namespace.

• instantiated Characteristics are added to the HomeSpan HAP Database and associated with the last Service instantiated
• instantiating a Characteristic without first instantiating a Service throws an error during initialization
• the first argument optionally allows you to set the initial value of the Characteristic at startup. If value is not specified, HomeSpan will supply a reasonable default for the Characteristic
• throws a runtime warning if value is outside of the min/max range for the Characteristic, where min/max is either the HAP default, or any new values set via a call to setRange()
• the second optional argument, if set to true, instructs HomeSpan to save updates to this Characteristic's value in the device's non-volative storage (NVS) for restoration at startup if the device should lose power. If not specified, nvsStore will default to false (no storage)
• examples:
  • new Characteristic::Brightness(); Brightness initialized to default value
  • new Characteristic::Brightness(50); Brightness initialized to 50
  • new Characteristic::Brightness(50,true); Brightness initialized to 50; updates saved in NVS

The following methods are supported for numerical-based Characteristics (e.g. int, float...):

• type T getVal<T>()

  • a template method that returns the current value of a numerical-based Characteristic, after casting into the type T specified (e.g. int, double, etc.). If template parameter is excluded, value will be cast to int.
  • example with template specified: double temp = Characteristic::CurrentTemperature->getVal<double>();
  • example with template excluded : int tilt = Characteristic::CurrentTiltAngle->getVal();

• type T getNewVal<T>()

  • a template method that returns the desired new value to which a HomeKit Controller has requested the Characteristic be updated. Same casting rules as for getVal<>(). Only applicable for numerical-based Characteristics

• void setVal(value [,boolean notify])

  • sets the value of a numerical-based Characteristic to value, and, if notify is set to true, notifies all HomeKit Controllers of the change. The notify flag is optional and will be set to true if not specified. Setting the notify flag to false allows you to update a Characateristic without notifying any HomeKit Controllers, which is useful for Characteristics that HomeKit automatically adjusts (such as a countdown timer) but will be requested from the Accessory if the Home App closes and is then re-opened
  • works with any integer, boolean, or floating-based numerical value, though HomeSpan will convert value into the appropriate type for each Characteristic (e.g. calling setValue(5.5) on an integer-based Characteristic results in value=5)
  • throws a runtime warning if value is outside of the min/max range for the Characteristic, where min/max is either the HAP default, or any new min/max range set via a prior call to setRange()
  • value is not restricted to being an increment of the step size; for example it is perfectly valid to call setVal(43.5) after calling setRange(0,100,5) on a floating-based Characteristic even though 43.5 does does not align with the step size specified. The Home App will properly retain the value as 43.5, though it will round to the nearest step size increment (in this case 45) when used in a slider graphic (such as setting the temperature of a thermostat)

• SpanCharacteristic *setRange(min, max, step)

  • overrides the default HAP range for a Characteristic with the min, max, and step parameters specified
  • step is optional; if unspecified (or set to a non-positive number), the default HAP step size remains unchanged
  • works with any integer or floating-based parameters, though HomeSpan will recast the parameters into the appropriate type for each Characteristic (e.g. calling setRange(50.5,70.3,0.5) on an integer-based Characteristic results in min=50, max=70, and step=0)
  • an error is thrown if:
    • called on a Characteristic that does not suport range changes, or
    • called more than once on the same Characteristic
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::Brightness(50))->setRange(10,100,5);

• SpanCharacteristic *setValidValues(int n, [int v1, int v2 ...])

  • overrides the default HAP Valid Values for Characteristics that have specific enumerated Valid Values with a variable-length list of n values v1, v2, etc.
  • an error is thrown if:
    • called on a Characteristic that does not have specific enumerated Valid Values, or
    • called more than once on the same Characteristic
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::SecuritySystemTargetState())->setValidValues(3,0,1,3); creates a new Valid Value list of length=3 containing the values 0, 1, and 3. This has the effect of informing HomeKit that a SecuritySystemTargetState value of 2 (Night Arm) is not valid and should not be shown as a choice in the Home App

The following methods are supported for string-based Characteristics (i.e. a null-terminated C-style array of characters):

• char *getString()

  • equivalent to getVal(), but used exclusively for string-characteristics (i.e. a null-terminated array of characters)

• char *getNewString()

  • equivalent to getNewVal(), but used exclusively for string-characteristics (i.e. a null-terminated array of characters)

• void setString(const char *value)

  • equivalent to setVal(value), but used exclusively for string-characteristics (i.e. a null-terminated array of characters)

The following methods are supported for all Characteristics:

• boolean updated()

  • returns true if a HomeKit Controller has requested an update to the value of the Characteristic, otherwise false. The requested value itself can retrieved with getNewVal<>() or getNewString()

• int timeVal()

  • returns time elapsed (in millis) since value of the Characteristic was last updated (whether by setVal(), setString() or as the result of a successful update request from a HomeKit Controller)

• SpanCharacteristic *setPerms(uint8_t perms)

  • changes the default permissions for a Characteristic to perms, where perms is an additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::IsConfigured(1))->setPerms(PW+PR+EV);

• SpanCharacteristic *addPerms(uint8_t perms)

  • adds new permissions, perms, to the default permissions for a Characteristic, where perms is an additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::IsConfigured(1))->addPerms(PW);

• SpanCharacteristic *removePerms(uint8_t perms)

  • removes permissions, perms, from the default permissions of a Characteristic, where perms is an additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::ConfiguredName("HDMI 1"))->removePerms(PW);

• SpanCharacteristic *setDescription(const char *desc)

  • adds an optional description, desc, to a Characteristic, as described in HAP-R2 Table 6-3
  • this field is generally used to provide information about custom Characteristics, but does not appear to be used in any way by the Home App
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::MyCustomChar())->setDescription("Tuner Frequency");

• SpanCharacteristic *setUnit(const char *unit)

  • adds or overrides the unit for a Characteristic, as described in HAP-R2 Table 6-6
  • returns a pointer to the Characteristic itself so that the method can be chained during instantiation
  • example: (new Characteristic::RotationSpeed())->setUnit("percentage");

SpanButton(int pin, uint16_t longTime, uint16_t singleTime, uint16_t doubleTime)

Creating an instance of this class attaches a pushbutton handler to the ESP32 pin specified.

• instantiated Buttons are associated with the last Service instantiated
• instantiating a Button without first instantiating a Service throws an error during initialization

The first argument is required; the rest are optional:

• pin - the ESP32 pin to which a one pole of a normally-open pushbutton will be connected; the other pole is connected to ground
• longTime - the minimum time (in millis) required for the button to be pressed and held to trigger a Long Press (default=2000 ms)
• singleTime - the minimum time (in millis) required for the button to be pressed to trigger a Single Press (default=5 ms)
• doubleTime - the maximum time (in millis) allowed between two Single Presses to qualify as a Double Press (default=200 ms)

Trigger Rules:

• If button is pressed and continuously held, a Long Press will be triggered every longTime ms until the button is released
• If button is pressed for more than singleTime ms but less than longTime ms and then released, a Single Press will be triggered, UNLESS the button is pressed a second time within doubleTime ms AND held again for at least singleTime ms, in which case a DoublePress will be triggered; no further events will occur until the button is released
• If singleTime>longTime, only Long Press triggers can occur
• If doubleTime=0, Double Presses cannot occur

HomeSpan automatically calls the button(int pin, int pressType) method of a Service upon a trigger event in any Button associated with that Service, where pin is the ESP32 pin to which the pushbutton is connected, and pressType is an integer that can also be represented by the enum constants indicated:

• 0=single press (SpanButton::SINGLE)
• 1=double press (SpanButton::DOUBLE)
• 2=long press (SpanButton::LONG)

HomeSpan will report a warning, but not an error, during initialization if the user had not overridden the virtual button() method for a Service contaning one or more Buttons; triggers of those Buttons will simply ignored.

SpanUserCommand(char c, const char *desc, void (*f)(const char *buf [,void *obj]) [,void *userObject])

Creating an instance of this class adds a user-defined command to the HomeSpan Command-Line Interface (CLI), where:

• c is the single-letter name of the user-defined command
• desc is a description of the user-defined command that is displayed when the user types '?' into the CLI
• f is a pointer to a user-defined function that is called when the command is invoked. Allowable forms for f are:
  1. void f(const char *buf), or
  2. void f(const char *buf, void *obj)
• userObject is a pointer to an arbitrary object HomeSpan passes to the function f as the second argument when the second form of f is used. Note it is an error to include userObject when the first form of f is used, and it is similarly an error to exclude userObject when the second form of f is used

To invoke your custom command from the CLI, preface the single-letter name c with '@'. This allows HomeSpan to distinguish user-defined commands from its built-in commands. For example,

new SpanUserCommand('s', "save current configuration", saveConfig);
...
void saveConfig(const char *buf){ ... };

would add a new command '@s' to the CLI with description "save current configuration" that will call the user-defined function void saveConfig(const char *buf) when invoked. The argument buf points to an array of all characters typed into the CLI after the '@'. This allows the user to pass arguments from the CLI to the user-defined function. For example, typing '@s123' into the CLI sets buf to "s123" when saveConfig is called.

In the second form of the argument, HomeSpan will pass an additional object to your function f. For example,

struct myConfigurations[10];
new SpanUserCommand('s', "<n> save current configuration for specified index, n", saveConfig, myConfigurations);
...
void saveConfig(const char *buf, void *obj){ ... do something with myConfigurations ... };

might be used to save all the elements in myArray when called with just the '@s' command, and perhaps save only one element based on an index added to the command, such as '@s34' to save element 34 in myArray. It is up to the user to create all necessary logic within the function f to parse and process the full command text passed in buf, as well as act on whatever is being passed via *obj.

To create more than one user-defined command, simply create multiple instances of SpanUserCommand, each with its own single-letter name. Note that re-using the same single-letter name in an instance of SpanUserCommand over-rides any previous instances using that same letter.

User Macros

LOG1(x), LOG1(const char *fmt, ...), LOG2(x), LOG2(const char *fmt, ...), WEBLOG(const char *fmt, ...)

#define REQUIRED VERSION(major,minor,patch)

If REQUIRED is defined in the main sketch prior to including the HomeSpan library with #include "HomeSpan.h", HomeSpan will throw a compile-time error unless the version of the library included is equal to, or later than, the version specified using the VERSION macro. Example:

#define REQUIRED VERSION(1,3,0)   // throws a compile-time error unless HomeSpan library used is version 1.3.0 or later
#include "HomeSpan.h"

#define CUSTOM_CHAR(name,uuid,perms,format,defaultValue,minValue,maxValue,staticRange)

#define CUSTOM_CHAR_STRING(name,uuid,perms,defaultValue)

Creates a custom Characteristic that can be added to any Service. Custom Characteristics are generally ignored by the Home App but may be used by other third-party applications (such as Eve for HomeKit). The first form should be used create numerical Characterstics (e.g., UINT8, BOOL...). The second form is used to String-based Characteristics. Parameters are as follows (note that quotes should NOT be used in any of the macro parameters, except for defaultValue):

• name - the name of the custom Characteristic. This will be added to the Characteristic namespace so that it is accessed the same as any HomeSpan Characteristic
• uuid - the UUID of the Characteristic as defined by the manufacturer. Must be exactly 36 characters in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, where X represent a valid hexidecimal digit. Leading zeros are required if needed as described more fully in HAP-R2 Section 6.6.1
• perms - additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
• format - specifies the format of the Characteristic value, as described in HAP-R2 Table 6-5. Valid value are BOOL, UINT8, UINT16, UNIT32, UINT64, INT, and FLOAT. Note that the HomeSpan does not presently support the TLV8 or DATA formats. Not applicable for Strings-based Characteristics
• defaultValue - specifies the default value of the Characteristic if not defined during instantiation
• minValue - specifies the default minimum range for a valid value, which may be able to be overriden by a call to setRange(). Not applicable for Strings-based Characteristics
• minValue - specifies the default minimum range for a valid value, which may be able to be overriden by a call to setRange(). Not applicable for Strings-based Characteristics
• staticRange - set to true if minValue and maxValue are static and cannot be overridden with a call to setRange(). Set to false if calls to setRange() are allowed. Not applicable for Strings-based Characteristics

As an example, the first line below creates a custom Characteristic named "Voltage" with a UUID code that is recognized by the Eve for HomeKit app. The parameters show that the Characteristic is read-only (PR) and notifications are enabled (EV). The default range of allowed values is 0-240, with a default of 120. The range can be overridden by subsequent calls to setRange(). The second line below creates a custom read-only String-based Characteristic:

CUSTOM_CHAR(Voltage, E863F10A-079E-48FF-8F27-9C2605A29F52, PR+EV, UINT16, 120, 0, 240, false);
CUSTOM_CHAR_STRING(UserTag, AAAAAAAA-BBBB-AAAA-AAAA-AAAAAAAAAAAA, PR, "Tag 123");
...
new Service::LightBulb();
  new Characteristic::Name("Low-Voltage Lamp");
  new Characteristic::On(0);
  new Characteristic::Brightness(50);
  new Characteristic::Voltage(12);      // adds Voltage Characteristic and sets initial value to 12 volts
  new Characteristic::UserTag();        // adds UserTag Characteristic and retains default initial value of "Tag 123"

Note that Custom Characteristics must be created prior to calling homeSpan.begin()

Advanced Tip: When presented with an unrecognized Custom Characteristic, Eve for HomeKit helpfully displays a generic control allowing you to interact with any Custom Characteristic you create in HomeSpan. However, since Eve does not recognize the Characteristic, it will only render the generic control if the Characteristic includes a description field, which you can add to any Characteristic using the setDescription() method described above. You may also want to use setUnit() and setRange() so that the Eve App displays a control with appropriate ranges for your Custom Characteristic.

#define CUSTOM_SERV(name,uuid)

Creates a custom Service for use with third-party applications (such as Eve for HomeKit). Custom Services will be displayed in the native Apple Home App with a Tile labeled "Not Supported", but otherwise the Service will be safely ignored by the Home App. Parameters are as follows (note that quotes should NOT be used in either of the macro parameters):

• name - the name of the custom Service. This will be added to the Service namespace so that it is accessed the same as any HomeSpan Service. For example, if name="Vent", HomeSpan would recognize Service::Vent as a new service class
• uuid - the UUID of the Service as defined by the manufacturer. Must be exactly 36 characters in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, where X represent a valid hexidecimal digit. Leading zeros are required if needed as described more fully in HAP-R2 Section 6.6.1

Custom Services may contain a mix of both Custom Characteristics and standard HAP Characteristics, though since the Service itself is custom, the Home App will ignore the entire Service even if it contains some standard HAP Characterstics. Note that Custom Services must be created prior to calling homeSpan.begin()

A fully worked example showing how to use both the CUSTOM_SERV() and CUSTOM_CHAR() macros to create a Pressure Sensor Accessory that is recognized by Eve for HomeKit can be found in the Arduino IDE under File → Examples → HomeSpan → Other Examples → CustomService.

---

Deprecated functions (available for backwards compatibility with older sketches):

• SpanRange(int min, int max, int step)

  • this legacy class was limited to integer-based parameters and has been re-coded to simply call the more generic setRange(min, max, step) method
  • last supported version: v1.2.0
  • please use setRange(min, max, step) for all new sketches

• void homeSpan.setMaxConnections(uint8_t nCon)

  • this legacy method was used to set the total number of HAP Controller Connections HomeSpan implements upon start-up to ensure there are still free sockets available for user-defined code requiring separate network resources
  • last supported version: v1.4.2
  • this method has been replaced by the more flexible method, reserveSocketConnections(uint8_t nSockets)
    • allows you to simply reserve network sockets for other custom code as needed
    • upon calling homespan.begin(), HomeSpan automatically determines how many sockets are left that it can use for HAP Controller Connections
  • please use homeSpan.reserveSocketConnections(uint8_t nSockets) for all new sketches

---

↩️ Back to the Welcome page