Merge pull request #3 from exsilium/feature/smartthings

Improvements to structure, support for SmartThings local processing

Author: exsilium

LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2016 - 2018, Sten Feldman
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -78,11 +78,15 @@ all:	start cpu drivers misc pan link burn
 
 start:	$(OUTPUT) \
 	$(OUTPUT)/start08.o \
+	$(OUTPUT)/util.o \
 	$(OUTPUT)/main.o
 
 $(OUTPUT)/start08.o: ./src/start08.c
 	$(CC) $(CFLAGS) -ObjN="$@" -Lm="$@.d" -LmCfg=xilmou $<
 
+$(OUTPUT)/util.o: ./src/util.c
+	$(CC) $(CFLAGS) -ObjN="$@" -Lm="$@.d" -LmCfg=xilmou $<
+
 $(OUTPUT)/main.o: ./src/main.c
 	$(CC) $(CFLAGS) -ObjN="$@" -Lm="$@.d" -LmCfg=xilmou $<
 
@@ -283,6 +287,7 @@ link:
 	"$(OUTPUT)/pan/zigbee/zigbee_zcl.o" \
 	"$(OUTPUT)/pan/zigbee/zigbee_zdo.o" \
 	"$(OUTPUT)/start08.o" \
+	"$(OUTPUT)/util.o" \
 	"$(OUTPUT)/main.o" \
 	"$(HC08C)/lib/$(HC08C_LIB)"\) \
 	-O"$(OUTPUT)/$(APP_NAME).abs"

README.md

@@ -1,6 +1,6 @@
 # pxbee-trigger
 
-Programmable XBee Trigger that is ZigBee Home Automation profile compliant. The testing of this feature branch is carried out using [SmartThings](https://www.smartthings.com) Hub and a default ZigBee device handler.
+Programmable XBee Trigger that is ZigBee Home Automation profile compliant. The testing of this feature is carried out using [SmartThings](https://www.smartthings.com) Hub and a default ZigBee device handler.
 
 ## Bill of Materials
 
@@ -38,3 +38,27 @@ clusterId: 0x0006,
 profileId: 0x0104,
 command: 0x01
 ```
+
+## Settings
+
+The following defines can be altered in `custom.h` prior to compilation to change the behavior how the Trigger works:
+
+|  Name | Description | Default |
+| ------| ----------- | ------- |
+| `PXBEE_TRIGGER_IGNORE_BROADCAST` | When enabled, ignores broadcast commands and reacts only when unicast messages are sent to the specific address (ignores All On/All Off commands). | Enabled |
+| `ZCL_MANUFACTURER` | The reported manufacturer string. For SmartThings local execution support without custom device handler, set this to "Leviton". | "PXBee" |
+| `ZCL_MODEL` | The reported model string. For SmartThings local execution support without custom device handler, set this to "ZSS-10". | "Trigger" |
+
+## License
+
+This project is based on [exsilium/pxbee-blink-led](https://github.com/exsilium/pxbee-blink-led) boilerplate and includes the full [Digi](http://www.digi.com) XBee SDK version 1.6.0 sources.
+
+Includes the necessary build binaries:
+```
+HI-CROSS+ ANSI-C Compiler for HC08 V-5.0.39, Dec 13 2011
+HI-CROSS+ SmartLinker V-5.0.48, Dec 13 2011
+HI-CROSS+ Burner V-5.0.16, Dec 13 2011
+(c) Copyright Freescale 1987-2010
+```
+
+If not otherwise noted, the added code is [BSD licensed](LICENSE).

include/custom.h

@@ -6,7 +6,7 @@
  *
  */
 
-/* Additional XBee settings */
+/* Additional XBee settings for SmartThings compatibility */
 #define XBEE_PARAM_ZS       2
 #define XBEE_PARAM_NJ       0x5A
 #define XBEE_PARAM_NH       0x1E
@@ -16,8 +16,19 @@
 #define XBEE_PARAM_EO       1
 #define XBEE_PARAM_KY       "5A6967426565416C6C69616E63653039"
 
+/* Reported manufacturer and model in basic cluster
+ *
+ * For SmartThings local execution without custom device handler, set the following:
+ * - ZCL_MANUFACTURER "Leviton"
+ * - ZCL_MODEL        "ZSS-10"
+ */
+#define ZCL_MANUFACTURER    "PXBee"
+#define ZCL_MODEL           "Trigger"
+
 /* Ignore On command received via Broadcast message */
 #define PXBEE_TRIGGER_IGNORE_BROADCAST
+
+/* Settings END */
 
 #include <zigbee/zdo.h>
 
@@ -29,13 +40,13 @@ extern wpan_ep_state_t custom_ha_ep_state;
 
  /* With this macro the prototypes of clusters' callbacks and extern variables are included in endpoints.c
   * Array custom_ep_data_clusters[] is declared in main.c
-  * Function custom_ep_default_cluster() is implemented in main.c */
+  * Function custom_ep_basic_cluster() is implemented in main.c */
 #define EP_INCLUDE_DECLARATIONS extern const wpan_cluster_table_entry_t custom_ep_clusters[];  \
-                                int custom_ep_default_cluster(const wpan_envelope_t FAR *, void FAR *);
+                                int custom_ep_basic_cluster(const wpan_envelope_t FAR *, void FAR *);
 
  /* This is a wpan_endpoint_table_entry_t structure, see its declaration in aps.h, the '{}' are because they
   * will be included in endpoints_table[] in endpoints.c */
-#define ADDITIONAL_ENDPOINTS {CUSTOM_ENDPOINT, CUSTOM_EP_PROFILE, custom_ep_default_cluster, &custom_ha_ep_state, 0x0002, 0x00, custom_ep_clusters}, \
+#define ADDITIONAL_ENDPOINTS {CUSTOM_ENDPOINT, CUSTOM_EP_PROFILE, custom_ep_basic_cluster, &custom_ha_ep_state, 0x0002, 0x00, custom_ep_clusters}, \
                              ZDO_ENDPOINT(zdo_ep_state)
 
  /* This macro is automatically defined if Process Incoming frames, Node Discovery Support or Over-the-Air

include/util.h

@@ -0,0 +1 @@
+uint8_t* appendStringChar(uint8_t* dest, const char* str);

src/main.c

@@ -52,27 +52,33 @@
  *
  ************************************/
 
-
 #include <xbee_config.h>
 #include <types.h>
+#include <util.h>
 
 // Custom profile and cluster implementation
-#define CUSTOM_EP_NULL_CLUSTER    0x0000
-#define CUSTOM_EP_CUSTOM_CLUSTER  0x0006
+#define CUSTOM_EP_BASIC_CLUSTER    0x0000
+#define CUSTOM_EP_IDENTIFY_CLUSTER 0x0003 /* Not implemented */
+#define CUSTOM_EP_GROUPS_CLUSTER   0x0004 /* Not implemented */
+#define CUSTOM_EP_SCENES_CLUSTER   0x0005 /* Not implemented */
+#define CUSTOM_EP_ONOFF_CLUSTER    0x0006
 
 zcl_command_t zcl;
 
 int trigger(void);
-int custom_ep_rx_cluster(const wpan_envelope_t FAR *envelope, void FAR *context);
+int custom_ep_rx_on_off_cluster(const wpan_envelope_t FAR *envelope, void FAR *context);
+int custom_ep_rx_notimpl_cluster(const wpan_envelope_t FAR *envelope, void FAR *context);
 
 const wpan_cluster_table_entry_t custom_ep_clusters[] = {
-    {CUSTOM_EP_NULL_CLUSTER, NULL, NULL, WPAN_CLUST_FLAG_INPUT},
-    {CUSTOM_EP_CUSTOM_CLUSTER, custom_ep_rx_cluster, NULL, WPAN_CLUST_FLAG_INPUT},
+    {CUSTOM_EP_BASIC_CLUSTER, NULL, NULL, WPAN_CLUST_FLAG_INPUT},
+    {CUSTOM_EP_IDENTIFY_CLUSTER, custom_ep_rx_notimpl_cluster, NULL, WPAN_CLUST_FLAG_INPUT},
+    {CUSTOM_EP_GROUPS_CLUSTER, custom_ep_rx_notimpl_cluster, NULL, WPAN_CLUST_FLAG_INPUT},
+    {CUSTOM_EP_SCENES_CLUSTER, custom_ep_rx_notimpl_cluster, NULL, WPAN_CLUST_FLAG_INPUT},
+    {CUSTOM_EP_ONOFF_CLUSTER, custom_ep_rx_on_off_cluster, NULL, WPAN_CLUST_FLAG_INPUT},
     WPAN_CLUST_ENTRY_LIST_END
 };
 
-
-int custom_ep_default_cluster(const wpan_envelope_t FAR *envelope, void FAR *context)
+int custom_ep_basic_cluster(const wpan_envelope_t FAR *envelope, void FAR *context)
 {
   uint8_t *payload_pointer = envelope->payload;
   int i = 0;
@@ -141,12 +147,7 @@ int custom_ep_default_cluster(const wpan_envelope_t FAR *envelope, void FAR *con
           *end_response++ = 0x00;
           *end_response++ = ZCL_STATUS_SUCCESS;
           *end_response++ = 0x42;
-          *end_response++ = 0x05; // Length of data
-          *end_response++ = 'P';
-          *end_response++ = 'X';
-          *end_response++ = 'B';
-          *end_response++ = 'e';
-          *end_response++ = 'e';
+          end_response = appendStringChar(end_response, ZCL_MANUFACTURER);
 
           printf("Response length: %02X\n", end_response - start_response);
           if(zcl_send_response(&zcl, start_response, end_response - start_response) == 0) {
@@ -160,14 +161,7 @@ int custom_ep_default_cluster(const wpan_envelope_t FAR *envelope, void FAR *con
           *end_response++ = 0x00;
           *end_response++ = ZCL_STATUS_SUCCESS;
           *end_response++ = 0x42;
-          *end_response++ = 0x07; // Length of data
-          *end_response++ = 'T';
-          *end_response++ = 'r';
-          *end_response++ = 'i';
-          *end_response++ = 'g';
-          *end_response++ = 'g';
-          *end_response++ = 'e';
-          *end_response++ = 'r';
+          end_response = appendStringChar(end_response, ZCL_MODEL);
 
           printf("Response length: %02X\n", end_response - start_response);
           if(zcl_send_response(&zcl, start_response, end_response - start_response) == 0) {
@@ -186,7 +180,7 @@ int custom_ep_default_cluster(const wpan_envelope_t FAR *envelope, void FAR *con
   return 0;
 }
 
-int custom_ep_rx_cluster(const wpan_envelope_t FAR *envelope, void FAR *context)
+int custom_ep_rx_on_off_cluster(const wpan_envelope_t FAR *envelope, void FAR *context)
 {
   uint8_t                 *start_response;
   uint8_t									*end_response;
@@ -332,6 +326,31 @@ int custom_ep_rx_cluster(const wpan_envelope_t FAR *envelope, void FAR *context)
 
   return 0;
 }
+
+int custom_ep_rx_notimpl_cluster(const wpan_envelope_t FAR *envelope, void FAR *context)
+{
+  uint8_t                 *start_response;
+  uint8_t									*end_response;
+  PACKED_STRUCT {
+    zcl_header_response_t	header;
+    uint8_t								buffer[20];
+  } response;
+
+  printf("\nNOTIMPL CLUSTER HANDLER\n");
+  printf("=======================\n");
+  printf("\n\nBuilding ZCL Command based on received envelope: ");
+  if(zcl_command_build(&zcl, envelope, context) == 0) {
+    printf("OK!\n");
+    printf("----------------------\n");
+    printf("Frame Control: %02X\n", zcl.frame_control);
+    printf("Command: %02X\n", zcl.command);
+    printf("ZCL Payload length: %02X\n", zcl.length);
+    hex_dump(zcl.zcl_payload, zcl.length, HEX_DUMP_FLAG_TAB);
+    printf("----------------------\n");
+    zcl_envelope_payload_dump(envelope);
+  }
+  return 0;
+}
 // END: Custom profile and cluster implementation
 
 /* Callback function for XBee commands */

src/util.c

@@ -0,0 +1,19 @@
+/* Generic Helper/Utility functions */
+
+#include <types.h>
+
+// Contribution by ST Community member - gazor
+uint8_t* appendStringChar(uint8_t* dest, const char* str)
+{
+  // Write string, preceeded by length byte, no termination character
+  size_t len = 0;
+  for(;;)
+  {
+    uint8_t c = (uint8_t) str[len];
+    if(c == 0) break;
+    dest[1+len] = c;
+    len++;
+  }
+  dest[0] = (uint8_t) len;
+  return dest + 1 + len;
+}