104 lines
5.5 KiB
Arduino
104 lines
5.5 KiB
Arduino
|
/*********************************************************************************
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
********************************************************************************/
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////
|
||
|
|
// //
|
||
|
|
// HomeSpan: A HomeKit implementation for the ESP32 //
|
||
|
|
// ------------------------------------------------ //
|
||
|
|
// //
|
||
|
|
// Example 14: Emulated PushButtons //
|
||
|
|
// //
|
||
|
|
////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
#include "HomeSpan.h"
|
||
|
|
#include "DEV_Blinker.h"
|
||
|
|
|
||
|
|
void setup() {
|
||
|
|
|
||
|
|
// Though HomeKit and the HomeKit Accessory Protocol (HAP) Specification provide a very flexible framework
|
||
|
|
// for creating iOS- and MacOS-controlled devices, they does not contain every possible desired feature.
|
||
|
|
//
|
||
|
|
// One very common Characteristic HomeKit does not seem to contain is a simple pushbutton, like the type you
|
||
|
|
// would find on a remote control. Unlike switches that can be "on" or "off", a pushbutton has no state.
|
||
|
|
// Rather, a pushbutton performs some action when it's pushed, and that's all it does until it's pushed
|
||
|
|
// again.
|
||
|
|
//
|
||
|
|
// Though HomeKit does not contain such a Characteristic, it's easy to emulate in HomeSpan. To do so, simply
|
||
|
|
// define a Service with a boolen Characteristic (such as the On Characteristic), and create an update()
|
||
|
|
// method to peform the operations to be executed when the "pushbutton" is "pressed" (i.e. set to true).
|
||
|
|
//
|
||
|
|
// You could stop there and have something in HomeKit that acts like a pushbutton, but it won't look like a
|
||
|
|
// pushbutton because every time you press the tile for your device in HomeKit, the Controller will toggle
|
||
|
|
// between showing it's on and showing it's off. Pressing a tile that shows the status is already ON, and will
|
||
|
|
// change to OFF, when you actually want to re-trigger some sort of "on" action is not very satisfying.
|
||
|
|
//
|
||
|
|
// Ideally, we'd like HomeKit to acknowledge you've pressed the tile for the device by lighting up, sending
|
||
|
|
// a request to update(), AND THEN resetting itself automatically to the "off" position a second or two later.
|
||
|
|
// This would indeed emulate a light-up pushbutton.
|
||
|
|
//
|
||
|
|
// Fortunately, it is easy to emulate this in HomeSpan through the use of a Service's loop() function. Simply
|
||
|
|
// code a derived Service as you normally would with its own update() method, and implement a loop() method
|
||
|
|
// that "resets" one or more Characteristics after a set period of time. This is similar to what we did in the
|
||
|
|
// with loop() methods in the prior two examples, except a lot simpler since the only logic is to set the value
|
||
|
|
// of a Characteristic to "off" after a few seconds using timeVal() and setVal().
|
||
|
|
//
|
||
|
|
// Example 14 demonstrates this by implementing a "pushbutton" Service to blink an LED three times. By itself, this
|
||
|
|
// is not very useful. But it is a good model for showing how to implement an IR LED that sends a Volume-Up command to
|
||
|
|
// a TV; or an RF Transmitter to control to some remote device, like a ceiling fan.
|
||
|
|
//
|
||
|
|
// All the functionality is wrapped up in a newly-defined "DEV_Blinker" Service, which can be found in DEV_Blinker.h.
|
||
|
|
// This new Service is a copy of the DEV_LED service from Example 9, with modifications to make it into a generic
|
||
|
|
// blinking LED. As usual, changes and new lines between this Example 14, and original Example 9, are notably commented.
|
||
|
|
|
||
|
|
Serial.begin(115200);
|
||
|
|
|
||
|
|
homeSpan.begin(Category::Bridges,"HomeSpan Bridge");
|
||
|
|
|
||
|
|
// Defines the Bridge Accessory
|
||
|
|
|
||
|
|
new SpanAccessory();
|
||
|
|
new Service::AccessoryInformation();
|
||
|
|
new Characteristic::Identify();
|
||
|
|
|
||
|
|
// *** NEW *** defines an LED Blinker Accessory attached to pin 16 which blinks 3 times
|
||
|
|
|
||
|
|
new SpanAccessory();
|
||
|
|
new Service::AccessoryInformation();
|
||
|
|
new Characteristic::Identify();
|
||
|
|
new Characteristic::Name("LED Blinker");
|
||
|
|
new DEV_Blinker(16,3); // DEV_Blinker takes two arguments - pin, and number of times to blink
|
||
|
|
|
||
|
|
} // end of setup()
|
||
|
|
|
||
|
|
//////////////////////////////////////
|
||
|
|
|
||
|
|
void loop(){
|
||
|
|
|
||
|
|
homeSpan.poll();
|
||
|
|
|
||
|
|
} // end of loop()
|