Merge pull request #18 from exsilium/development

[v0.4.0-rc.0] From Grove to Custom design - From 1 channel to 4

Author: exsilium

.github/workflows/c-cpp.yml

@@ -0,0 +1,21 @@
+name: C/C++ CI
+
+on:
+  push:
+    branches: [ master, development ]
+  pull_request:
+    branches: [ master, development ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install 32-bit libraries
+      run: sudo apt-get install lib32stdc++6
+    - name: make
+      run: make
+      env:
+        WRAPINDOCKER: ""

.gitignore

@@ -1,3 +1,11 @@
 .DS_Store
 err.txt
 obj
+
+# Autodesk Eagle Backup files
+*.s#?
+*.b#?
+*.l#?
+*.b$?
+*.s$?
+*.l$?

Dockerfile

@@ -1,5 +1,5 @@
 # Basic image to compile
-FROM ubuntu:16.04
+FROM ubuntu:20.04
 MAINTAINER Sten Feldman <[email protected]>
 RUN apt-get update
 RUN apt-get install -y lib32stdc++6 make

Makefile

@@ -34,9 +34,10 @@ APP_NAME=trigger
 
 # Toolchain and output. If you are using Docker to build, make sure the paths
 # are relative and within this directory to ensure container access.
-CC=./hc08c/bin/chc08
-LINKER=./hc08c/bin/linker
-BURNER=./hc08c/bin/burner
+WRAPINDOCKER ?=docker run -v $(CURDIR):$(CURDIR) -w=$(CURDIR) $(APP_NAME)
+CC=$(WRAPINDOCKER) ./hc08c/bin/chc08
+LINKER=$(WRAPINDOCKER) ./hc08c/bin/linker
+BURNER=$(WRAPINDOCKER) ./hc08c/bin/burner
 OUTPUT=obj
 
 PXBEE_API_SRC=./pxbee
@@ -79,6 +80,7 @@ all:	start cpu drivers misc pan link burn
 start:	$(OUTPUT) \
 	$(OUTPUT)/start08.o \
 	$(OUTPUT)/util.o \
+	$(OUTPUT)/serialpass.o \
 	$(OUTPUT)/main.o
 
 $(OUTPUT)/start08.o: ./src/start08.c
@@ -87,6 +89,9 @@ $(OUTPUT)/start08.o: ./src/start08.c
 $(OUTPUT)/util.o: ./src/util.c
 	$(CC) $(CFLAGS) -ObjN="$@" -Lm="$@.d" -LmCfg=xilmou $<
 
+$(OUTPUT)/serialpass.o: ./src/serialpass.c
+	$(CC) $(CFLAGS) -ObjN="$@" -Lm="$@.d" -LmCfg=xilmou $<
+
 $(OUTPUT)/main.o: ./src/main.c
 	$(CC) $(CFLAGS) -ObjN="$@" -Lm="$@.d" -LmCfg=xilmou $<
 
@@ -288,6 +293,7 @@ link:
 	"$(OUTPUT)/pan/zigbee/zigbee_zdo.o" \
 	"$(OUTPUT)/start08.o" \
 	"$(OUTPUT)/util.o" \
+	"$(OUTPUT)/serialpass.o" \
 	"$(OUTPUT)/main.o" \
 	"$(HC08C)/lib/$(HC08C_LIB)"\) \
 	-O"$(OUTPUT)/$(APP_NAME).abs"
@@ -332,7 +338,7 @@ builddocker:
 	docker build --tag=$(APP_NAME):latest .
 
 dall:
-	docker run -v $(CURDIR):/$(APP_NAME) -w=/$(APP_NAME) --rm=true $(APP_NAME)
+	docker run -v $(CURDIR):$(CURDIR) -w=$(CURDIR) --env WRAPINDOCKER="" --rm=true $(APP_NAME)
 
 ###############################################################################
 # CLEAN #######################################################################

README.md

@@ -1,15 +1,38 @@
 # pxbee-trigger
 
-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
-
-|  Component    | Manufacturer  | Quantity | SKU / Part nr. | Mandatory / Optional |
-| ------------- | ------------- | -------- | -------------- | -------------------- |
-| [Programmable XBee](https://www.digi.com/products/xbee-rf-solutions/rf-modules/xbee-zigbee#partnumbers) | [Digi](https://www.digi.com) | 1 | XBP24CZ7PITB003 | M |
-| [Grove - XBee Carrier](https://www.seeedstudio.com/Grove-XBee-Carrier-p-905.html) | [Seeed Development](https://www.seeedstudio.com/) | 1 | 113020004 | O |
-| [Grove - Relay](https://www.seeedstudio.com/Grove-Relay-p-769.html) | [Seeed Development](https://www.seeedstudio.com/) | 1 | 103020005 | O |
-| [Grove 5cm Cable](https://www.seeedstudio.com/Grove-Universal-4-Pin-Buckled-5cm-Cable-(5-PCs-Pack)-p-925.html) | [Seeed Development](https://www.seeedstudio.com/) | 1 | 110990036 | O |
+Programmable XBee Trigger that is ZigBee Home Automation profile compliant. Possible to integrate with [SmartThings](https://www.smartthings.com) Hub v3 or a separate ZigBee / XBee network. Includes a reference hardware design up to 4 channels with a full BOM, perfect for DIYselfers out there.
+
+Used in real life to automate garage / gate automatons.
+
+## Hardware example
+
+![Picture](doc/board_top.jpg)
+
+An assembled board without a mounted XBee radio. Metric scale for reference (cm.). Board dimension - 51 x 57 mm.
+## Bill of Materials (BOM)
+
+| Designator  | Component                                                                                                            | Manufacturer                                      | Quantity | SKU / Part nr.                | Spec                                                                               | Option |
+| ----------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -------- | ----------------------------- | ---------------------------------------------------------------------------------- | ------ |
+| XB1         | [Programmable XBee](https://www.digi.com/products/xbee-rf-solutions/rf-modules/xbee-zigbee#partnumbers) (with RPSMA) | [Digi](https://www.digi.com)                      |        1 | XBP24CZ7SITB003               | [PDF](http://www.digi.com/resources/documentation/digidocs/pdfs/90002002.pdf)      |        |
+| BR1         | [Bridge Rectifier DF01M](https://www.mouser.ee/ProductDetail/512-DF01M)                                              | [ON Semiconductor](https://www.onsemi.com)        |        1 | Mouser No: 512-DF01M          | [PDF](https://www.mouser.ee/datasheet/2/308/DF10M-D-1803766.pdf)                   |        |
+| C1 (C2)     | [Electrolytic Capacitor - Radial 220uF 50V](https://www.mouser.ee/ProductDetail/EEU-FM1H221)                         | [Panasonic](https://industrial.panasonic.com).    |      1-2 | Mouser No: 667-EEU-FM1H221.   | [PDF](https://www.mouser.ee/datasheet/2/315/ABA0000C1018-947496.pdf).              |        |
+| PS1         | [DC/DC Isolated Converter Cosel MGFS1R5243R3](https://www.mouser.ee/ProductDetail/436-MGFS1R5243R3)                  | [Cosel](https://www.coseleurope.eu)               |        1 | Mouser No: 436-MGFS1R5243R3   | [PDF](https://www.mouser.ee/datasheet/2/622/SFE_MGFS-1115632.pdf)                  |        |
+| Q1,Q2,Q3,Q4 | [Bipolar Transistor BC548BTA](https://www.mouser.ee/ProductDetail/512-BC548BTA)                                      | [ON Semiconductor](https://www.onsemi.com)        |        4 | Mouser No: 512-BC548BTA       | [PDF](https://www.mouser.ee/datasheet/2/308/BC548-1118644.pdf)                     |        |
+| D1,D2,D3,D4 | [Diode 1N4004](https://www.mouser.ee/ProductDetail/863-1N4004RLG)                                                    | [ON Semiconductor](https://www.onsemi.com)        |        4 | Mouser No: 863-1N4004RLG      | [PDF](https://www.mouser.ee/datasheet/2/308/1N4001-D-110363.pdf)                   |        |
+| K1,K2,K3,K4 | [General Purpose Relay (APAN3103)](https://www.mouser.ee/ProductDetail/769-APAN3103)                                 | [Panasonic](https://industrial.panasonic.com)     |        4 | Mouser No: 769-APAN3103       | [PDF](https://www.mouser.ee/datasheet/2/315/mech_eng_pan-1299258.pdf)              |        |
+| R1,R2,R3,R4 | [Resistor RN55D1801FB14](https://www.mouser.ee/ProductDetail/71-RN55D1801FB14)                                       | [Vishay](https://www.vishay.com)                  |        4 | Mouser No: 71-RN55D1801FB14   | [PDF](https://www.mouser.ee/datasheet/2/427/cmfmil-109690.pdf)                     |        |
+| XB1         | [10 pin header for XBee](https://www.mouser.ee/ProductDetail/855-M22-7131042)                                        | [Harwin](https://www.harwin.com)                  |        2 | Mouser No: 855-M22-7131042    | [PDF](https://www.mouser.ee/datasheet/2/181/M22-713-1134021.pdf)                   |        |
+| J1          | [2 pin Terminal Block (PCB)](https://www.mouser.ee/ProductDetail/538-39501-1002)                                     | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-39501-1002     | [PDF](https://www.mouser.ee/datasheet/2/276/0395011002_TERMINAL_BLOCKS-163759.pdf) | A      |
+|             | [2 pin Terminal Plug](https://www.mouser.ee/ProductDetail/538-39500-0002)                                            | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-39500-0002     | [PDF](https://www.mouser.ee/datasheet/2/276/0395000002_TERMINAL_BLOCKS-136229.pdf) | A      |
+| J2          | [9 pin Terminal Block (PCB)](https://www.mouser.ee/ProductDetail/538-39501-1009)                                     | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-39501-1009     | [PDF](https://www.mouser.ee/datasheet/2/276/0395011009_TERMINAL_BLOCKS-163629.pdf) | A      |
+|             | [9 pin Terminal Plug](https://www.mouser.ee/ProductDetail/651-1908101)                                               | [Molex](https://www.molex.com)                    |        1 | Mouser No: 651-1908101        | [PDF](https://www.mouser.ee/datasheet/2/276/0395000009_TERMINAL_BLOCKS-163669.pdf) | A      |
+| J1          | [2 pin Fixed Terminal Block (PCB)](https://www.mouser.ee/ProductDetail/538-39357-0002)                               | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-39357-0002     | [PDF](https://www.mouser.ee/datasheet/2/276/0393570002_TERMINAL_BLOCKS-227759.pdf) | B      |
+| J2          | [9 pin Fixed Terminal Block (PCB)](https://www.mouser.ee/ProductDetail/538-39357-0009)                               | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-39357-0009     | [PDF](https://www.mouser.ee/datasheet/2/276/0393570009_TERMINAL_BLOCKS-136250.pdf) | B      |
+|             | [Antenna with RP-SMA Connector](https://www.mouser.ee/ProductDetail/712-ANT-2.4-CW-RAH)                              | [Linx Technologies](https://linxtechnologies.com) |        1 | Mouser No: 712-ANT-2.4-CW-RAH | [PDF](https://www.mouser.ee/datasheet/2/238/ant-2.4-cw-rah-ccc-1659143.pdf)        |        |
+| JP1         | [6 pin Debug Header](https://www.mouser.ee/ProductDetail/538-22-28-8065)                                             | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-22-28-8065     | [PDF](https://www.mouser.ee/datasheet/2/276/0022288065_PCB_HEADERS-159204.pdf)     | O      |
+| J3          | [2 pin Reset Header](https://www.mouser.ee/ProductDetail/Molex/22-28-5027)                                           | [Molex](https://www.molex.com)                    |        1 | Mouser No: 538-22-28-5027     | [PDF](https://www.mouser.ee/ProductDetail/Molex/22-28-5027)                        | O      |
+
+Standard 3.5 width headers are used. Option **A**) uses pluggable termination; **B**) Fixed screw termination; **O**) Parts are optional and meant for development; Components can easily be switched with other termination blocks or use direct wire soldering.
 
 ## Compiling
 
@@ -30,7 +53,7 @@ Programmable XBee Trigger that is ZigBee Home Automation profile compliant. The
 
 ## Trigger
 
-Send a Unicast ZCL "On" command to trigger the connected relay for 125ms. The state of the switch remains in "Off" state. Broadcast command is ignored by default.
+Send a Unicast ZCL "On" command to trigger the connected relay for 125ms (Relay 1). The state of the switch remains in "Off" state. Broadcast command is ignored by default.
 
 ```
 Endpoint: 0xEA,
@@ -49,6 +72,16 @@ The following defines can be altered in `custom.h` prior to compilation to chang
 | `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" |
 
+### Endpoints
+
+|  Endpoint | Description |
+| ----------| ----------- |
+| `0xEA` | Relay 1 |
+| `0xEB` | Relay 2 |
+| `0xEC` | Relay 3 |
+| `0xED` | Relay 4 |
+| `0xEE` | Auxiliary binary input endpoint |
+
 ## 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.