added makesmart lock-mechanism

Addes makesmart lock-mechanism with two easy to use functions:

open_lock(), close_lock()

Author: me-cooper

examples/Example06_makesmart_lock/Example06_makesmart_lock.ino

@@ -0,0 +1,116 @@
+/*
+ * makesmart_lock.ino
+ * 
+ *  Created on: 2021-02-05
+ *      Author: cooper @ makesmart.net
+ *      Thank you for this great library!
+ *      
+ * This example shows how to:
+ * 1. define a lock accessory and its characteristics in my_accessory.c
+ * 2. get the target-state sent from iOS Home APP.
+ * 3. report the current-state value to HomeKit.
+ * 
+ * you can use both:
+ *    void open_lock(){}
+ * and
+ *    void close_lock(){}
+ *    
+ * at the end of this file to let the lock-mechanism do whatever you want. 
+ * 
+ * 
+ * Pairing Code: 123-45-678
+ * 
+ * 
+ * You should:
+ * 1. read and use the Example01_TemperatureSensor with detailed comments
+ *    to know the basic concept and usage of this library before other examples。
+ * 2. erase the full flash or call homekit_storage_reset() in setup()
+ *    to remove the previous HomeKit pairing storage and
+ *    enable the pairing with the new accessory of this new HomeKit example.
+ * 
+ */
+
+#include <Arduino.h>
+#include <arduino_homekit_server.h>
+#include "wifi_info.h"
+
+#define LOG_D(fmt, ...)   printf_P(PSTR(fmt "\n") , ##__VA_ARGS__);
+
+void setup() {
+  Serial.begin(115200);
+  wifi_connect();
+  homekit_storage_reset();
+  my_homekit_setup();
+}
+
+void loop() {
+  my_homekit_loop();
+  delay(10);
+}
+
+//==============================
+// HomeKit setup and loop
+//==============================
+
+// access lock-mechanism HomeKit characteristics defined in my_accessory.c
+extern "C" homekit_server_config_t config;
+
+extern "C" homekit_characteristic_t cha_lock_current_state;
+extern "C" homekit_characteristic_t cha_lock_target_state;
+
+static uint32_t next_heap_millis = 0;
+
+
+// called when the lock-mechanism target-set is changed by iOS Home APP
+void set_lock(const homekit_value_t value) {
+  
+  uint8_t state = value.int_value;
+  cha_lock_current_state.value.int_value = state;
+  
+  if(state == 0){
+    // lock-mechanism was unsecured by iOS Home APP
+    open_lock();
+  }
+  if(state == 1){
+    // lock-mechanism was secured by iOS Home APP
+    close_lock();
+  }
+  
+  //report the lock-mechanism current-sate to HomeKit
+  homekit_characteristic_notify(&cha_lock_current_state, cha_lock_current_state.value);
+  
+}
+
+void my_homekit_setup() {
+  
+  cha_lock_target_state.setter = set_lock;
+  arduino_homekit_setup(&config);
+
+  
+}
+
+
+void my_homekit_loop() {
+  arduino_homekit_loop();
+  const uint32_t t = millis();
+  if (t > next_heap_millis) {
+    // show heap info every 30 seconds
+    next_heap_millis = t + 30 * 1000;
+    LOG_D("Free heap: %d, HomeKit clients: %d",
+        ESP.getFreeHeap(), arduino_homekit_connected_clients_count());
+
+  }
+}
+
+
+
+/* use this functions to let your lock mechanism do whatever yoi want */
+void open_lock(){
+  Serial.println("unsecure"); 
+  // add your code here eg switch a relay or whatever 
+}
+
+void close_lock(){
+  Serial.println("secure");  
+  // add your code here eg switch a relay or whatever
+}

examples/Example06_makesmart_lock/my_accessory.c

@@ -0,0 +1,51 @@
+/*
+ * my_accessory.c
+ * Define the accessory in C language using the Macro in characteristics.h
+ *
+ *  Created on: 2021-02-05
+ *      Author: cooper @ makesmart.net
+ *      Thank you for this great library!
+ *      
+ */
+
+#include <homekit/homekit.h>
+#include <homekit/characteristics.h>
+
+void my_accessory_identify(homekit_value_t _value) {
+  printf("accessory identify\n");
+}
+
+
+// characteristics of the lock-mechanism
+// format: uint8_t // 0 is unsecured // 1 is secured
+homekit_characteristic_t cha_lock_current_state = HOMEKIT_CHARACTERISTIC_(LOCK_CURRENT_STATE, 1);
+homekit_characteristic_t cha_lock_target_state = HOMEKIT_CHARACTERISTIC_(LOCK_TARGET_STATE, 1);
+
+homekit_characteristic_t cha_name = HOMEKIT_CHARACTERISTIC_(NAME, "Lock");
+
+homekit_accessory_t *accessories[] = {
+    HOMEKIT_ACCESSORY(.id=1, .category=homekit_accessory_category_door_lock, .services=(homekit_service_t*[]) {
+        HOMEKIT_SERVICE(ACCESSORY_INFORMATION, .characteristics=(homekit_characteristic_t*[]) {
+            HOMEKIT_CHARACTERISTIC(NAME, "Lock"),
+            HOMEKIT_CHARACTERISTIC(MANUFACTURER, "makesmart Community"),
+            HOMEKIT_CHARACTERISTIC(SERIAL_NUMBER, "1111111"),
+            HOMEKIT_CHARACTERISTIC(MODEL, "makesmart Lock"),
+            HOMEKIT_CHARACTERISTIC(FIRMWARE_REVISION, "1.0"),
+            HOMEKIT_CHARACTERISTIC(IDENTIFY, my_accessory_identify),
+            NULL
+        }),
+    HOMEKIT_SERVICE(LOCK_MECHANISM, .primary=true, .characteristics=(homekit_characteristic_t*[]){
+      &cha_lock_current_state,
+      &cha_lock_target_state,
+      &cha_name,
+      NULL
+    }),
+        NULL
+    }),
+    NULL
+};
+
+homekit_server_config_t config = {
+    .accessories = accessories,
+    .password = "123-45-678"
+};

examples/Example06_makesmart_lock/wifi_info.h

@@ -0,0 +1,34 @@
+/*
+ * wifi_info.h
+ *
+ *  Created on: 2020-05-15
+ *      Author: Mixiaoxiao (Wang Bin)
+ */
+
+#ifndef WIFI_INFO_H_
+#define WIFI_INFO_H_
+
+#if defined(ESP8266)
+#include <ESP8266WiFi.h>
+#elif defined(ESP32)
+#include <WiFi.h>
+#endif
+
+const char *ssid = "your-ssid";
+const char *password = "your-password";
+
+void wifi_connect() {
+  WiFi.persistent(false);
+  WiFi.mode(WIFI_STA);
+  WiFi.setAutoReconnect(true);
+  WiFi.begin(ssid, password);
+  Serial.println("WiFi connecting...");
+  while (!WiFi.isConnected()) {
+    delay(100);
+    Serial.print(".");
+  }
+  Serial.print("\n");
+  Serial.printf("WiFi connected, IP: %s\n", WiFi.localIP().toString().c_str());
+}
+
+#endif