Skip to content

Commit 320372b

Browse files
committed
Update to main README
- Added reference hardware picture - Reduced the role of SmartThings as it’s not a major integration point going forward - Endpoints described
1 parent bef93ea commit 320372b

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# pxbee-trigger
22

3-
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 v3. A default ZigBee device handler can be used for limited functionality.
3+
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.
44

5+
Used in real life to automate garage / gate automatons.
6+
7+
## Hardware example
8+
9+
![Picture](doc/board_top.jpg)
10+
11+
An assembled board without a mounted XBee radio. Metric scale for reference (cm.). Board dimension - 51 x 57 mm.
512
## Bill of Materials (BOM)
613

714
| Designator | Component | Manufacturer | Quantity | SKU / Part nr. | Spec | Option |
@@ -46,7 +53,7 @@ Standard 3.5 width headers are used. Option **A**) uses pluggable termination; *
4653

4754
## Trigger
4855

49-
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.
56+
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.
5057

5158
```
5259
Endpoint: 0xEA,
@@ -65,6 +72,16 @@ The following defines can be altered in `custom.h` prior to compilation to chang
6572
| `ZCL_MANUFACTURER` | The reported manufacturer string. For SmartThings local execution support without custom device handler, set this to "Leviton". | "PXBee" |
6673
| `ZCL_MODEL` | The reported model string. For SmartThings local execution support without custom device handler, set this to "ZSS-10". | "Trigger" |
6774

75+
### Endpoints
76+
77+
| Endpoint | Description |
78+
| ----------| ----------- |
79+
| `0xEA` | Relay 1 |
80+
| `0xEB` | Relay 2 |
81+
| `0xEC` | Relay 3 |
82+
| `0xED` | Relay 4 |
83+
| `0xEE` | Auxiliary binary input endpoint |
84+
6885
## License
6986

7087
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.

doc/board_top.jpg

757 KB
Loading

0 commit comments

Comments
 (0)