32 |
33 | ## Features
34 |
35 | - Wide range of Zigbee Modules (CC2652P, CC2652RB, etc)
36 | - 2 WORKING MODES: LAN Coordinator or USB Coordinator/Router
37 | - BOOT,FLASH,RESET Buttons
38 | - 2 LED for indication [Custom firmware](https://github.com/jethome-ru/zigbee-firmware/tree/master/ti/coordinator/cc2652)
39 | - Communicates via USB or LAN network with [Z2M](https://www.zigbee2mqtt.io/) and [ZHA](https://www.home-assistant.io/integrations/zha/)
40 | - SMA port for an external antenna
41 | - Easy programming with [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool).No external programmer needed!
42 | - Plug & Play, comes pre-flashed
43 |
44 | ## Revisions
45 |
46 | There are 3 version of Zigbee LAN Gateway,what are tested:
47 | - [RF-STAR RF-BM-2652P2 - 20dBm](https://github.com/mercenaruss/zigstar_gateways/raw/main/files/Gerbers/LAN%20Gateway/Gerber_WT32_RF-BM-2652P2.zip)
48 | - [Ebyte E72-2G4M20S1E - 20dBm](https://github.com/mercenaruss/zigstar_gateways/raw/main/files/Gerbers/LAN%20Gateway/Gerber_WT32_E72-2G4M20S1E.zip)
49 | - [Ebyte E72-2G4M05S1F - 5dBm](https://github.com/mercenaruss/zigstar_gateways/raw/main/files/Gerbers/LAN%20Gateway/Gerber_WT32_E72-2G4M05S1F.zip)[^1]
50 |
51 |
52 | !!! INFO
53 | - RF-STAR RF-BM-2652P2 recommended
54 | - PCB thickness 1.2mm is recommended
55 |
56 |
57 | ## Bill of Materials
58 |
59 | EasyEDA Generated BOM,you can order on [LCSC](https://lcsc.com) directly - [BOM](https://github.com/mercenaruss/zigstar_gateways/blob/main/files/BOM/BOM_WT32_RF-BM-2652P2.csv)
60 |
61 | | Designator | Name | Footprint | Quantity |
62 | | :------------|:---------------|:-----|:--------:|
63 | | U1|[RF-BM-2652P1/P2](https://letyshops.com/r/aliexpress-c83c7878b18b)| | 1 |
64 | | U2|[WT32-ETH01](https://letyshops.com/r/aliexpress-73b6cc1c03c9) |N/A| 1 |
65 | | U3 | CH340C|SOP-16 |1|
66 | | U4 | AMS1117-3.3|SOT-223 |1|
67 | | R1 | 10 kohm|SMD 0805 |1|
68 | | R2,R3 | 1 kohm|SMD 0805 |2|
69 | | R4,R5 | 5.1 kohm|SMD 0805 |2|
70 | | R6,R7 | 22 ohm|SMD 0805 |2|
71 | | C1| 10uF|SMD_L3.5-W2.8|1|
72 | | C2,C4| 100nF|SMD 0805|2|
73 | | C3| 22uF|SMD_L3.5-W2.8|1|
74 | | L1,L2| RED/GREEN LED|SMD 0805|2|
75 | | SBL,RST,BOOT|PUSH BUTTON |SMD_L3.9-W3.0-P4.45|3|
76 | | USB| TYPE-C|USB-C_SMD-TYPE-C-31-M-12|1|
77 | | CON| [STACKABLE HEADER 13 PIN](https://letyshops.com/r/aliexpress-09c274fbb012) |2.54x13P|1|
78 | | ANT| [SMA ANTENNA PORT 1.2mm](https://letyshops.com/r/aliexpress-e6704ce906c0)|SMA EDGE|1|
79 |
80 | Next items are not available on LCSC,you can get them on Aliexpress:
81 |
82 | | Name | Shop 1 | Shop 2 |
83 | | :------------|:---------------|:-----|
84 | | WT32-ETH01| [CLICK](https://letyshops.com/r/aliexpress-a4dd8609c8d4)| [CLICK](https://letyshops.com/r/aliexpress-401d07dc02d1) |
85 | | RF-STAR RF-BM-2652P1/P2|[CLICK](https://letyshops.com/r/aliexpress-dbe513b72282) | [CLICK](https://letyshops.com/r/aliexpress-1f3e1a35e82d) |
86 | | Ebyte E72-2G4M20S1E | [CLICK](https://letyshops.com/r/aliexpress-b25ea4b8642a)| [CLICK](https://letyshops.com/r/aliexpress-00563b7dcf47) |
87 | | Ebyte E72-2G4M05S1F | [CLICK](https://letyshops.com/r/aliexpress-dd63f3c1afdc)| [CLICK](https://letyshops.com/r/aliexpress-c8b5adc0e26c) |
88 | | RP-SMA Antenna PCB Connector 1.2mm | [CLICK](https://letyshops.com/r/aliexpress-7507f61580c3)| N/A |
89 | | RP-SMA Antenna Female - Inner hole |[CLICK](https://letyshops.com/r/aliexpress-81d294a1360f)| [CLICK](https://letyshops.com/r/aliexpress-5ebae68206ac) |
90 | | STACKABLE FEMALE HEADER 13 PIN| [CLICK](https://letyshops.com/r/aliexpress-fb2fa1673785) | [CLICK](https://letyshops.com/r/aliexpress-09c274fbb012) |
91 |
92 | ## Options
93 |
94 | In order to use your LAN Gateway in USB Mode(without connection to WT32-ETH01):
95 | Solder jumpers, labeled J1/USB or change default DIP switch position
96 |
97 | !!! danger "DIP Switch Positions"
98 | - ON for USB Mode
99 | - OFF for LAN Mode
100 |
101 | Both switches should be in the same position.
102 |
103 | {: style="height:20%;width:20%" loading=lazy} {: style="height:15%;width:15%" loading=lazy}
104 |
105 | ## Firmware
106 |
107 | Help on choosing correct firmware for your device is located [HERE](/radio-docs/quick-start/#step-2-download-the-correct-firmware-for-your-device)
108 |
109 | ## Flashing
110 |
111 | * [YAML Config](https://github.com/mercenaruss/zigstar_gateways/blob/main/files/ESP-HOME/zigstar-gw-lan.yaml)
112 | * [WT32-ETH01 Firmware ESP-Home](https://github.com/mercenaruss/zigstar_gateways/raw/main/files/ESP-HOME/zigstar-gw-lan.bin)
113 | * [ZigStar Firmware](https://github.com/xyzroe/ZigStarGW-FW/releases)[^2]
114 | * ESP-HOME flashing guide - [ESP-HOME](/radio-docs/esp-home/)
115 | * ZigStar flashing guide - [ZigStar Firmware](/radio-docs/flash-zigstargw/)
116 | * Zigbee Module flashing guide - [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool))
117 |
118 | ## Downloads
119 | - [Gerbers](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Gerbers)
120 | - [STL Case](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/STL)
121 | - [Schematics (pdf)](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Schematics)
122 | - [LCSC BOM File](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/BOM)
123 |
124 | ## Video
125 |
126 | *English subtitles available
127 |
128 | 1. Ethernet Zigbee ZigStar Gateway, installing multiple zigbee2mqtt
129 |
130 |
131 |
132 | 2. Server redundancy with Zigbee2MQTT on Zigbee LAN Coordinator Zigstar
133 |
134 |
135 |
136 | [^1]: **Not recommended for new assembly.**
137 | [^2]: **All forces will be used for this firmware, ESPHOME debugging and development is depreceated**
--------------------------------------------------------------------------------
/documentation/docs/projects/zigbee-shield.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar Shield
3 | description: Zigbee Shield (CC2652P Zigbee Coordinator) Design Files and Description, working with Zigbee2Mqtt (Z2M) and ZHA
4 | ---
5 |
6 | {: style="height:60%;width:60%" loading=lazy}
7 |
8 | ## Features
9 |
10 | - [TI CC2652P](https://www.ti.com/product/CC2652P)SimpleLink™ 2.4 GHz Multiprotocol Wireless MCU targeting Zigbee,Bluetooth 5.1 Low Energy,Thread + 19.5-dBm high-power amplifier
11 | - Support RF-BM-2652P1 and RF-BM-2652P2 Module from RF-STAR,with CC2652P on board
12 | - BSL,RST Buttons
13 | - 2 LED for indication
14 | - Compatible with [Z2M](https://www.zigbee2mqtt.io/) and [ZHA](https://www.home-assistant.io/integrations/zha/)
15 | - IPX port for an external antenna
16 | - Self-programming via [cc2538-bsl](https://github.com/JelmerT/cc2538-bsl). No external programmer needed! Push BSL button to trigger this mode.
17 |
18 | ## Bill of Materials:
19 |
20 | EasyEDA Generated Boom,you can order on [LCSC](https://lcsc.com)directly - [BOOM](https://github.com/mercenaruss/zigbee-stick-v4/blob/main/files/BOM_ZigStar_Shield.csv)
21 |
22 | | Designator | Name | Footprint | Quantity |
23 | | :------------|:---------------|:-----|:--------:|
24 | | U1| RF-BM-2652P1/P2| | 1 |
25 | | U2|AMS1117-3.3 |SOT-223| 1 |
26 | | R1 | 10 kohm|SMD 0805 |1|
27 | | R2,R3 | 1 kohm|SMD 0805 |2|
28 | | C1| 10uF|SMD_L3.5-W2.8-R-RD|1|
29 | | C2| 22uF|SMD_L3.5-W2.8-R-RD|1|
30 | | C3| 100nF|SMD 0805|1|
31 | | L1,L2| RED/GREEN LED|SMD 0805|2|
32 | | SBL,RST|PUSH BUTTON |SMD_L3.9-W3.0-P4.45|2|
33 | | JTAG| PIN HEADER 5 PIN|2.54x5P|1|
34 | | H1| FEMALE HEADER 2x5 PIN|2.54 2x5P|1|
35 |
36 | Next item is not available on LCSC,you can get it on Aliexpress:
37 |
38 | - [RF-BM-2652P1/P2](https://letyshops.com/r/aliexpress-f6e2c6d280d5)
39 |
40 | ## Firmware
41 |
42 | Module is compatible with [Z2M](https://www.zigbee2mqtt.io/).
43 | Firmware [CC1352P2_CC2652P_launchpad_*.zip](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin).
44 | Default TX Power is 5dbm. It can be adjusted in Z2M config section:
45 |
46 | experimental:
47 | transmit_power: 5
48 |
49 | Available TX power values: -20,-18,-15,-12,-10,-9,-6,-5,-3,0,1..5,14..20
50 |
51 | ## Downloads
52 | - [Gerber](https://github.com/mercenaruss/zigbee-stick-v4/tree/main/files/gerber)
53 | - [Schematics (pdf), Revision 1](https://github.com/mercenaruss/zigbee-stick-v4/tree/main/files/schematics)
54 | - [LCSC Boom File](https://github.com/mercenaruss/zigbee-stick-v4/blob/main/files/BOM_ZigStar_Shield.csv)
55 |
--------------------------------------------------------------------------------
/documentation/docs/projects/zigbee-stick-v4.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar Stick v4
3 | description: Zigbee USB Stick - CC2652P Zigbee Coordinator
4 | tags:
5 | - zigbee stick
6 | - zigbee usb-stick
7 | - usb zigbee gateway
8 | - zigbee dongle
9 | - zigbee coordinator
10 | hide:
11 | - tags
12 | - toc
13 | ---
14 |
15 |
16 |
17 |
18 |
ZigStar Stick - Top
19 |
20 |
21 |
22 |
ZigStar Stick - Bottom
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 | ## Features
31 |
32 | - [TI CC2652P](https://www.ti.com/product/CC2652P) SimpleLink™ 2.4 GHz Multiprotocol Wireless MCU targeting Zigbee,Bluetooth 5.1 Low Energy,Thread + 19.5-dBm high-power amplifier
33 | - Support RF-BM-2652P1 and RF-BM-2652P2 Module from RF-STAR,with CC2652P on board
34 | - BSL,RST Buttons
35 | - 2 LED for indication
36 | - Compatible with [Z2M](https://www.zigbee2mqtt.io/)and [ZHA](https://www.home-assistant.io/integrations/zha/)
37 | - SMA antenna port for an external antenna
38 | - Easy programming with [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool).No external programmer needed!
39 | - Communicates via the common CH340E/CH340C USB-UART Bridge
40 | - Plug & Play, comes pre-flashed
41 |
42 | ## Purchase
43 |
44 | Assembled versions of Zigbee Stick v4 is available for purchase.
45 | Shiping is done from Germany
46 | Each order contains a fully assembled and tested PCBA along with a plastic enclosure and a small +3dBi antenna.
47 |
48 | ## Revisions
49 |
50 | There are 2 versions of stick,both of them tested:
51 | - [CH340C 3D Printed Case version](https://github.com/mercenaruss/zigbee-stick-v4/raw/main/files/gerber/Gerber_Zigbee%20Stick%20v4.0%20-%20CH340C.zip), more easy to solder,Auto-BSL enabled and includes ESD protection.[^1]
52 | - [CH340C Factory Case version](https://github.com/mercenaruss/zigbee-stick-v4/raw/main/files/gerber/Gerber_Zigbee%20Stick%20v4.0%20-%20CH340C%20-%20Factory%20VG-S48_AK-N-12.zip),[^2] fits in this factory cases [VG-S48](https://letyshops.com/r/aliexpress-5891f3cb4a88)/[AK-N-12](https://letyshops.com/r/aliexpress-0f3a529a9464)
53 |
54 | CH340C versions use this [3D Model Case](https://github.com/mercenaruss/zigbee-stick-v4/blob/main/files/STL)
55 | Factory cases are found on Aliexpress: [VG-S48](https://letyshops.com/r/aliexpress-5891f3cb4a88)/[AK-N-12](https://letyshops.com/r/aliexpress-0f3a529a9464)
56 |
57 | ## Bill of Materials:
58 |
59 | EasyEDA Generated Boom,you can order on [LCSC](https://lcsc.com)directly - [BOM](https://github.com/mercenaruss/zigbee-stick-v4/blob/main/files/BOM_Zigbee%20Stick%204.0%20CH340E-C.csv)
60 |
61 | | Designator | Name | Footprint | Quantity |
62 | | :------------|:---------------|:-----|:--------:|
63 | | U1| RF-BM-2652P1/P2| | 1 |
64 | | U2|AMS1117-3.3 |SOT-223| 1 |
65 | | U3 | CH340E/CH340C|MSOP-10/SOP-16 |1|
66 | | R1 | 10 kohm|SMD 0805 |1|
67 | | R2,R3 | 1 kohm|SMD 0805 |2|
68 | | R4 | 100 ohm|SMD 0805 |1|
69 | | C1| 10uF|SMD_L3.2-W1.6|1|
70 | | C2,C4| 100nF|SMD 0805|2|
71 | | C3| 22uF|SMD_L3.2-W1.6|1|
72 | | L1,L2| RED/GREEN LED|SMD 0805|2|
73 | | SBL,RST|PUSH BUTTON |SMD_L3.9-W3.0-P4.45|2|
74 | | USB| USB A MALE|USB-A-SMD_USB-A-1-TH|1|
75 | | JTAG| PIN HEADER 5 PIN|2.54x5P|1|
76 | | ANT| SMA ANTENNA PORT 1.6mm||1|
77 | | D1| ESD USBLC6-2SC6|SOT-23-6|1|
78 |
79 | **WARNING** D1 is used only for CH340C and Factory Case sticks.
80 | Next items are not available on LCSC,you can get them on Aliexpress:
81 | - [RF-BM-2652P1/P2](https://letyshops.com/r/aliexpress-c83c7878b18b)
82 | - [RP-SMA Antenna PCB Connector 1.2/1.6mm](https://letyshops.com/r/aliexpress-7507f61580c3)
83 | - [RP-SMA Antenna Female - Inner hole](https://letyshops.com/r/aliexpress-81d294a1360f)
84 | - Cases [VG-S48](https://letyshops.com/r/aliexpress-5891f3cb4a88)/[AK-N-12](https://letyshops.com/r/aliexpress-0f3a529a9464)
85 |
86 | ## Firmware
87 |
88 | Module is compatible with [Z2M](https://www.zigbee2mqtt.io/).
89 | Firmware [CC1352P2_CC2652P_launchpad_*.zip](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin).
90 | Default TX Power is 9dbm. It can be adjusted in Z2M config section:
91 |
92 | experimental:
93 | transmit_power: 10
94 |
95 | Available TX power values: -20,-18,-15,-12,-10,-9,-6,-5,-3,0,1..5,14..20 [^3]
96 |
97 | ## Downloads
98 | - [Gerbers](https://github.com/mercenaruss/zigbee-stick-v4/tree/main/files/gerber)
99 | - [STL Case](https://github.com/mercenaruss/zigbee-stick-v4/tree/main/files/STL)
100 | - [Schematics (pdf), Revision 1](https://github.com/mercenaruss/zigbee-stick-v4/tree/main/files/schematics)
101 | - [LCSC Boom File](https://github.com/mercenaruss/zigbee-stick-v4/blob/main/files/BOM_Zigbee%20Stick%204.0%20CH340E-C.csv)
102 |
103 | ## Video
104 |
105 | *English subtitles available
106 |
107 |
108 |
109 | [^1]: **Not recomended for new assembly.**
110 | [^2]: **Recomended version for assembly.**
111 | [^3]: **After many tests recomended value is 10dbm, depending on your environment.**
112 |
--------------------------------------------------------------------------------
/documentation/docs/projects/zigbee-zigihat.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar ZigiHAT
3 | description: Raspberry HAT - Zigbee Coordinator
4 | tags:
5 | - raspberry coordinator
6 | - raspberry zigbee shield
7 | - raspberry hat
8 | - zigihat
9 | hide:
10 | - tags
11 | - toc
12 | ---
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 | ## Features
32 | - [CC2652P](https://www.ti.com/product/CC2652P)chip from Texas Instruments, using the [RF-BM-2652P2](https://letyshops.com/r/aliexpress-c83c7878b18b)module:
33 | - Max. RF Power: 20dBm
34 | - Built-in ROM serial bootloader - no external programmer/debugger needed
35 | - SMA antenna for 2.4GHz(ZigBee)
36 | - PoE IEEE 802.3af or passive 48V PoE support
37 | - RTC with backup battery for offline timekeeping
38 | - ID EEEPROM (firmware still under development)
39 | - Easy programming using [CC2538-BSL](https://github.com/JelmerT/cc2538-bsl)or [OpenOCD](https://openocd.org/)JTAG([scripts provided](#flashing))
40 | - QWIIC/Stemma QT compatible I2C expansion header
41 | - BSL,RESET Buttons
42 |
43 |
44 | ## What is included:
45 | - ZigiHAT Addon board - 1 pcs
46 | - Standoff - 4 pcs
47 | - Plastic screws - 4 pcs
48 |
49 | ## Flashing
50 |
51 | To make setup and flashing procedure more pleasant for end-user,we make some scripts to be used for setup of ZigiHAT
52 |
53 | - Pi_Flasher_CC2538 - Run to flash last [Koenkk firmware](https://github.com/Koenkk/Z-Stack-firmware)using [CC2538-BSL](https://github.com/JelmerT/cc2538-bsl)
54 | ```
55 | curl -s https://raw.githubusercontent.com/mercenaruss/zigstar_gateways/main/files/Tools/Scripts/Pi_Flasher_CC2538.sh > Pi_Flasher_CC2538.sh && chmod +x ./Pi_Flasher_CC2538.sh && ./Pi_Flasher_CC2538.sh
56 | ```
57 | - Pi_Flasher_JTAG - Run to flash over JTAG the last [Koenkk firmware](https://github.com/Koenkk/Z-Stack-firmware)using [OpenOCD](https://openocd.org/)
58 | ```
59 | curl -s https://raw.githubusercontent.com/mercenaruss/zigstar_gateways/main/files/Tools/Scripts/Pi_Flasher_JTAG.sh > Pi_Flasher_JTAG.sh && chmod +x ./Pi_Flasher_JTAG.sh && ./Pi_Flasher_JTAG.sh
60 | ```
61 | - Pi_Starter - Run to setup your Raspberry Pi Wifi/Bluetooth, RTC and I2C,what is available on board of ZigiHAT
62 | ```
63 | curl -s https://raw.githubusercontent.com/mercenaruss/zigstar_gateways/main/files/Tools/Scripts/Pi_Starter.sh > Pi_Starter.sh && chmod +x ./Pi_Starter.sh && ./Pi_Starter.sh
64 | ```
65 |
66 | !!! tip
67 |
68 | Wifi and Bluetooth is recomended to disable in case in not used by system,when Pi_Starter ask you.
69 |
70 | ??? danger "Flashing settings"
71 | In order to use any of flashing methods(Pi_Flasher_CC2538 or Pi_Flasher_JTAG),all swithes from DIP switch(FLASH) should be in ON position.
72 |
73 | ## Downloads
74 |
75 | - [Gerbers](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Gerbers)
76 | - [Schematics](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Schematics)
77 | - [LCSC BOM File](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/BOM)
--------------------------------------------------------------------------------
/documentation/docs/projects/zigstar-lilyzig.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar LilyZig
3 | description: ZigStar Zigbee POE Coordinator based on CC2652P.
4 | tags:
5 | - zigbee gateway poe
6 | - zigbee poe coordinator
7 | - zigbee ethernet gateway
8 | - zigbee poe bridge
9 | - ethernet zigbee
10 | - zigbee ethernet
11 | hide:
12 | - tags
13 | - toc
14 | ---
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 | !!! note
37 |
38 | **LiliZig is retired** Not anymore on sale. Available only for self assembly.
39 |
40 | ## Features
41 |
42 | - 802.3af PoE or USB C-Type [^1]
43 | - CC2652P TI chip, the most powerful (+20dB)
44 | - 2 WORKING MODES: LAN/POE Coordinator or USB Coordinator/Router
45 | - 2 LED for indication [KoenK Firmware](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin)
46 | - Communicates via USB or LAN network with [Z2M](https://www.zigbee2mqtt.io/) and [ZHA](https://www.home-assistant.io/integrations/zha/)
47 | - SMA port for an external antenna
48 | - Easy programming with [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool). No external programmer needed!
49 |
50 | !!! danger "Important notice"
51 | **USB and PoE is forbidden to use simultaneously!**
52 | LilyZig has **no galvano isolation** from Ethernet's power supply, when you program the board via the USB-C connector the Ethernet cable should be disconnected.
53 |
54 | ## Revisions
55 |
56 | There are 2 version of LilyZig POE Gateway,what are tested:
57 | - [RF-STAR RF-BM-2652P2 - 20dBm](https://github.com/mercenaruss/zigstar_gateways/raw/main/files/Gerbers/LilyZig/Gerber_TTGO_RF-BM-2652P2.zip)
58 | - [Ebyte E72-2G4M20S1E - 20dBm](https://github.com/mercenaruss/zigstar_gateways/raw/main/files/Gerbers/LilyZig/Gerber_TTGO_E72-2G4M20S1E.zip)
59 |
60 |
61 | !!! INFO
62 | - RF-STAR RF-BM-2652P2 recommended
63 | - PCB thickness 1.2mm is recommended
64 |
65 |
66 | ## Bill of Materials
67 |
68 | EasyEDA Generated BOM,you can order on [LCSC](https://lcsc.com) directly - [BOM](https://github.com/mercenaruss/zigstar_gateways/blob/main/files/BOM/BOM_TTGO_RF-BM-2652P2.csv)
69 |
70 | Next items are not available on LCSC,you can get them on Aliexpress:
71 |
72 | | Name | Shop 1 | Shop 2 |
73 | | :------------|:---------------|:-----|
74 | | LILYGO® TTGO T-Internet-POE| [CLICK](https://letyshops.com/r/aliexpress-69affae66921)| [CLICK](https://letyshops.com/r/aliexpress-95230416106d)|
75 | | RF-STAR RF-BM-2652P1/P2|[CLICK](https://letyshops.com/r/aliexpress-c83c7878b18b) | [CLICK](https://letyshops.com/r/aliexpress-dbe513b72282) |
76 | | Ebyte E72-2G4M20S1E | [CLICK](https://letyshops.com/r/aliexpress-b25ea4b8642a)| [CLICK](https://letyshops.com/r/aliexpress-00563b7dcf47) |
77 | | RP-SMA Antenna PCB Connector 1.2mm | [CLICK](https://letyshops.com/r/aliexpress-7507f61580c3)| N/A |
78 | | RP-SMA Antenna Female - Inner hole |[CLICK](https://letyshops.com/r/aliexpress-81d294a1360f)| [CLICK](https://letyshops.com/r/aliexpress-5ebae68206ac) |
79 |
80 | ## Firmware
81 |
82 | Help on choosing correct firmware for your device is located [HERE](/radio-docs/quick-start/#step-2-download-the-correct-firmware-for-your-device)
83 |
84 | ## Flashing
85 |
86 | * [ZigStar ESP Firmware!](https://github.com/xyzroe/ZigStarGW-FW/releases)[^2]
87 | * Zigbee Module flashing guide - [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool))
88 |
89 | ## Downloads
90 | - [Gerbers](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Gerbers)
91 | - [STL Case](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/STL)
92 | - [Schematics (pdf)](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Schematics)
93 | - [LCSC Boom File](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/BOM)
94 |
95 | ## Video
96 |
97 | *English subtitles available
98 |
99 |
100 |
101 | [^1]: **USB and PoE is forbidden to use simultaneously**
102 | [^2]: **All forces will be used for this firmware, ESPHOME debugging and development is depreceated**
--------------------------------------------------------------------------------
/documentation/docs/projects/zigstar-olizig.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar Olizig
3 | description: Zigbee POE Coordinator based on CC2652P.
4 | tags:
5 | - zigbee gateway poe
6 | - zigbee poe coordinator
7 | - zigbee ethernet gateway
8 | - zigbee poe bridge
9 | - ethernet zigbee
10 | - zigbee ethernet
11 | hide:
12 | - tags
13 | - toc
14 | ---
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 | ## Features
37 |
38 | - 802.3af PoE or USB C-Type
39 | - CC2652P TI chip, the most powerful (+20dB)
40 | - 2 WORKING MODES: LAN/POE Coordinator or USB Coordinator/Router
41 | - 2 LED for indication [KoenK Firmware](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin)
42 | - Communicates via USB or LAN network with [Z2M](https://www.zigbee2mqtt.io/) and [ZHA](https://www.home-assistant.io/integrations/zha/)
43 | - DS18B20 temperature sensor for extra safety
44 | - Power Switch beetween POE and USB power
45 | - SMA port for an external antenna
46 | - Easy programming with [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool). No external programmer needed!
47 |
48 | ## Flashing
49 |
50 | * [ZigStar ESP Firmware!](https://github.com/xyzroe/ZigStarGW-FW/releases)[^1]
51 | * Zigbee Module flashing guide - [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool))
52 |
53 | ## Downloads
54 |
55 | - [Gerbers](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Gerbers)
56 | - [Schematics](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/Schematics)
57 | - [LCSC BOM File](https://github.com/mercenaruss/zigstar_gateways/tree/main/files/BOM)
58 |
59 | [^1]: **All forces will be used for this firmware, ESPHOME debugging and development is depreceated**
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/esp-home.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Configuration ESP-HOME
3 | description: ZigStar LAN Coordinator Setup Documentation
4 | hide:
5 | - tags
6 | tags:
7 | - ESP-HOME
8 | - LAN
9 | - WEB
10 | ---
11 |
12 | # ESP-HOME
13 |
14 | In order to change default setting for ESP-HOME firmware, please follow next guides.
15 |
16 | ## Install ESP-HOME
17 |
18 | Choose from 2 optional avalaible at the moment:
19 |
20 | === "HA Supervised"
21 |
22 | It's using Home Assistant add-on, install instruction are found [HERE](https://esphome.io/guides/getting_started_hassio.html)
23 |
24 | === "Standalone"
25 |
26 | It can be installed barematel or using docker( personally using on windows ), follow instructions from [HERE](https://esphome.io/guides/getting_started_command_line.html)
27 |
28 | !!! info
29 | For both cases is required to download .yaml for your PCB
30 |
31 | ## Substitutions
32 |
33 | For example you want to change gateway hostname, friendly name in HA, your API and OTA passwords.
34 |
35 | In this case edit just next items,at the beggining of .yaml file:
36 |
37 | { loading=lazy }
38 |
39 | ## Static IP
40 |
41 | In order to make your device have the same IP each time after reboot, you have 2 ways to achieve this:
42 |
43 | - setup static ip in your router config
44 | - modify .yaml file.
45 |
46 | { loading=lazy }
47 |
48 | ## Generate and install updated firmware
49 |
50 | { loading=lazy }
51 |
52 |
53 | !!! danger
54 | Any error in ip configuration could cause the gw to not connect and require to be flashed with Serial to USB converter( applies to Wifi Gateway)
55 | !!! danger
56 | After changing IP parameters, OTA update it's not gonna work,until firmware is flashed to ESP module,using Manual Download.
57 |
58 | === "Wirelessly"
59 |
60 | If you made changes only in subtitutions section,then just press Install button in ESP-HOME interface,followed by Wirelessly.
61 |
62 | { loading=lazy }
63 |
64 | { loading=lazy }
65 |
66 | === "Manual Download"
67 |
68 | After changing IP parameters, OTA update it's not gonna work,until firmware is flashed to ESP module manually.
69 |
70 | 1. Press Manual Download
71 |
72 | { loading=lazy }
73 |
74 | 2. Debug console confirm that firmware was built and Download button appear in righ bottom corner.
75 |
76 | { loading=lazy } { loading=lazy }
77 |
78 | 3. Open your gateway address in browser and update firmware:
79 |
80 | { loading=lazy }
81 |
82 |
83 |
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/flash-cc-bsl.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar Flashing Instructions
3 | description: Instructions for flashing ZigBee Stick using cc2538-bsl
4 | hide:
5 | - tags
6 | tags:
7 | - cc2538-bsl
8 | - flashing
9 | - bsl
10 | - erase
11 | ---
12 |
13 | # Flash Firmware using JelmerT's serial bootload tool
14 |
15 | [JelmerT's serial bootload tool](https://github.com/JelmerT/cc2538-bsl)is a cross-platform Python script that allows you to flash firmware on TI's newer chips.
16 | All ZigStar boards are supported by cc2538-bsl.py.
17 |
18 | ## Installation
19 |
20 | - Install [python](https://www.python.org/downloads/)
21 | - Use ```python --version``` to be sure, that you are running python 3 or above!
22 | - If you are **NOT** running **3.4** or higher, you need to install `pip`, too.
23 | - Install dependencies with ```pip install pyserial intelhex```
24 | - Download the [cc2538-bsl.py] file or just clone the repo.
25 |
26 | Copy and paste the command into your terminal.
27 |
28 | === "Linux(Debian/Ubuntu)"
29 | ```
30 | sudo apt update && sudo apt-get install python3-pip
31 | ```
32 | ```
33 | wget -O cc2538-bsl.zip https://codeload.github.com/JelmerT/cc2538-bsl/zip/master && unzip cc2538-bsl.zip
34 | ```
35 | ```
36 | sudo pip3 install pyserial intelhex
37 | ```
38 | === "MacOS"
39 | Python3 should already be shipped with macOS,if no then follow below procedure:
40 |
41 | Download and extract cc2538-bsl:
42 | ```
43 | curl --output cc2538-bsl.zip https://codeload.github.com/JelmerT/cc2538-bsl/zip/master && unzip cc2538-bsl.zip
44 | ```
45 | Install required dependencies:
46 | ```
47 | /usr/bin/python3 -m pip install --user pyserial intelhex
48 | ```
49 | === "Windows"
50 |
51 | Download [Python for Windows](https://www.python.org/downloads/)and install. After installation verify Python if its installed by running `python -V` in Command Prompt.
52 |
53 | If you receive a message similar to `Python is not recognized as an internal or external command, operable program or batch file.`, this means Python is either not installed or the system variable PATH hasn’t been set. You’ll need to launch Python from the folder in which it is installed or adjust your system variables to allow it to be launched from any location.
54 |
55 | Download the [zipped code](https://github.com/JelmerT/cc2538-bsl/archive/master.zip)and extract to a folder.
56 |
57 | Install required dependencies:
58 | ```
59 | pip install pyserial intelhex
60 | ```
61 | !!! tip
62 | Please use the [Power Shell](https://docs.microsoft.com/en-us/powershell/)to have the best user experience. If you encounter permissions issues, ensure that you are running your terminal as an administrator.
63 |
64 | ## Determine the USB port/ IP address
65 |
66 | Plug your device in and ensure that device is recognised by your OS:
67 |
68 | === "Linux(Debian/Ubuntu)"
69 |
70 | On linux, use this:
71 | ```
72 | ls -l /dev/serial/by-id
73 | ```
74 | Issue `dmesg` and observe the device enumeration:
75 |
76 | ```Shell
77 | [152343.203201] usb 1-1.4: new full-speed USB device number 5 using dwc_otg
78 | [152343.336384] usb 1-1.4: New USB device found, idVendor=1a86, idProduct=7523, bcdDevice= 2.62
79 | [152343.336400] usb 1-1.4: New USB device strings: Mfr=0, Product=2, SerialNumber=0
80 | [152343.336409] usb 1-1.4: Product: USB2.0-Serial
81 | [152343.338315] ch341 1-1.4:1.0: ch341-uart converter detected
82 | [152343.341440] usb 1-1.4: ch341-uart converter now attached to ttyUSB0
83 | ```
84 |
85 | === "MacOS"
86 |
87 | On macOS find the device using:
88 | ```
89 | ls /dev/tty.*
90 | ```
91 | Issue `dmesg` and observe the device enumeration:
92 | ```
93 | IOUserSerial::AppleUSBCHCOM::: 127 0x6000013e4058
94 | IOUserSerial::: 456 0x6000013e4058
95 | IOUserSerial::: 41 0x6000013e4058
96 | DK: AppleUSBCHCOM-0x1000030ea::start(IOUSBHostInterface-0x1000030e5) ok
97 | ```
98 |
99 | === "Windows"
100 |
101 | On windows, use this in a Powershell or go to Device Manager
102 |
103 | ```
104 | $comports = Get-WMIObject Win32_SerialPort; $comports | Get-PnpDeviceProperty -InstanceId {$_.pnpdeviceid} -Keyname DEVPKEY_Device_BusReportedDeviceDesc | ForEach-Object { foreach($comport in $comports) { if ($comport.pnpdeviceid -eq $_.instanceid) { new-object psobject -property @{COMPORT = $comport.deviceid; 'Device-Name' = $_.data} } } }
105 | ```
106 | The drivers for CH340 should be automatically be picked up,check under "Ports (COM & LPT)" in Device Manager:
107 |
108 | { loading=lazy }
109 |
110 | If you need to install the drivers manually, go [HERE](http://www.wch.cn/downloads/CH341SER_ZIP.html)for official drivers.
111 |
112 | !!! TIP
113 | Double-check by undocking the device again.
114 |
115 | !!! info
116 | For network device find out IP or hostname.
117 |
118 | ## Put your device in BSL mode
119 |
120 | Please follow the following instructions to put your device in BSL mode:
121 |
122 | === "USB Coordinator"
123 |
124 | - Unplug your stick from the host
125 | - Press the `BSL/FLASH` pushbutton and keep holding while plugging the device back into the host
126 |
127 | {: style="height:15%;width:15%" loading=lazy} {: style="height:15%;width:15%" loading=lazy}
128 |
129 | - Give it a few seconds for the device to settle and set up and release the BSL button
130 | - Your stick should now be in ROM bootloader mode
131 |
132 | It's very important that you press and hold the BSL button **before** plugging it in to the host and release it **after a few seconds**.
133 | !!! note
134 | cc2538-bsl.py and .exe supports "Auto-BSL", now you can skip the BSL pushbutton press for flashing boards.
135 |
136 | Just follow normal firmware procedure using cc2538-bsl.py or cc2538-bsl.exe. ( Boards using CH340E does not support Auto-BSL! )
137 |
138 | === "Network Coordinator "
139 |
140 | - Access device by IP or hostname using your browser
141 | - Click Firmware Update initiate the bootloader (BSL) mode for the module:
142 |
143 | { loading=lazy }
144 |
145 | - Watch the Debug output and when promted go to next step.
146 |
147 | { loading=lazy }
148 |
149 | ## Flash firmware
150 |
151 | To flash firmware, run:
152 |
153 | === "Option 1 - cc2538-bsl.exe"
154 |
155 | ```
156 | ./cc2538-bsl.exe -p PORT -evw FIRMWARE
157 | ```
158 | ...where `PORT` is the serial port your board is connected to.
159 | ```
160 | ./cc2538-bsl.exe -p socket://ip_or_localdns_name:6638 -evw FIRMWARE
161 | ```
162 |
163 | === "Option 2 - Python"
164 |
165 | ```
166 | python cc2538-bsl.py -p PORT -evw FIRMWARE
167 | ```
168 | ...where `PORT` is the serial port your board is connected to
169 | ```
170 | python cc2538-bsl.py -p socket://ip_or_localdns_name:6638 -evw FIRMWARE
171 | ```
172 |
173 | (see [above](#determine-the-usb-port)) and `FIRMWARE` is the hex file you want to flash (see [here](/radio-docs/quick-start/#step-2-download-the-correct-firmware-for-your-device) for help on choosing firmware).
174 |
175 | !!! INFO
176 | -p: will select the port
177 | -evw: will erase,write and check firmware
178 |
179 | !!! warning
180 | It is crucial that you download the correct firmware for your stick as using the wrong firmware will disable the BSL and you will need an external debugger / programmer to flash your stick again.
181 |
182 | ## Additional:
183 |
184 | ### Erase device
185 |
186 | To completely erase the device flash, run:
187 |
188 | === "Option 1 - cc2538-bsl.exe"
189 |
190 | ```
191 | ./cc2538-bsl.exe -p PORT -e
192 | ```
193 | ...where `PORT` is the serial port your board is connected to.
194 | ```
195 | ./cc2538-bsl.exe -p socket://ip_or_localdns_name:6638 -e
196 | ```
197 |
198 | === "Option 2 - Python"
199 |
200 | ```
201 | python cc2538-bsl.py -p PORT -e
202 | ```
203 | ...where `PORT` is the serial port your board is connected to.
204 | ```
205 | python cc2538-bsl.py -p socket://ip_or_localdns_name:6638 -e
206 | ```
207 |
208 |
209 | ### Clearing NVRAM
210 |
211 | During the flashing process, the coordinator's memory (NVMEM) may contain arbitrary data, which may in some cases prevent NVMEM recovery from the backup.
212 |
213 | === "Zigbee2MQTT"
214 | The coordinator's memory is cleared by the `zStackEraseAllNvMem.js` script, which is usually located in this directory:
215 | ```
216 | /opt/zigbee2mqtt/scripts
217 | ```
218 | The command line will look something like this:
219 | ```
220 | node zStackEraseAllNvMem.js /dev/ttyUSB0
221 | ```
222 | ```
223 | node zStackEraseAllNvMem.js socket://ip_or_localdns_name:6638
224 | ```
225 | === "Zigpy-ZNP"
226 |
227 | Download and install zigpy-znp:
228 | ```
229 | pip install zigpy-znp
230 | ```
231 | Erase your device's NVRAM entries to fully reset it:
232 | ```
233 | python -m zigpy_znp.tools.nvram_reset /dev/serial/by-id/your-radio
234 | ```
235 | ```
236 | python -m zigpy_znp.tools.nvram_reset socket://ip_or_localdns_name:6638
237 | ```
238 | Some warnings are normal, as not all entries will be present in every device.
239 |
240 | !!! info
241 | At the end of the flashing, you may need to unplug-plug your device or press RST.
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/flash-ti-flash-prog.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Smart RF Flash Programmer 2
3 | description: Flashing Zigbee Modules using Smart RF Flash Programmer 2
4 | hide:
5 | - tags
6 | tags:
7 | - flashing
8 | - bsl
9 | - erase
10 | ---
11 |
12 | # Flash Firmware using TI SmartRF Flash Programmer v2
13 |
14 | Go to [TI's Website](https://www.ti.com/tool/FLASH-PROGRAMMER)and download SmartRF Flash Programmer v2.
15 |
16 | Make sure you download and install FLASH-PROGRAMMER-2.
17 |
18 | ## Determine the USB port
19 |
20 | Plug your device in and ensure that device is recognised by your OS:
21 |
22 | On windows, use this in a Powershell or go to Device Manager
23 |
24 | $comports = Get-WMIObject Win32_SerialPort; $comports | Get-PnpDeviceProperty -InstanceId {$_.pnpdeviceid} -Keyname DEVPKEY_Device_BusReportedDeviceDesc | ForEach-Object { foreach($comport in $comports) { if ($comport.pnpdeviceid -eq $_.instanceid) { new-object psobject -property @{COMPORT = $comport.deviceid; 'Device-Name' = $_.data} } } }
25 |
26 | The drivers for CH340 should be automatically be picked up,check under "Ports (COM & LPT)" in Device Manager:
27 |
28 | { loading=lazy }
29 |
30 | If you need to install the drivers manually, go [HERE](http://www.wch.cn/downloads/CH341SER_ZIP.html)for official drivers.
31 |
32 | !!! TIP
33 | Double-check by undocking the device again.
34 |
35 | ## Put your stick in BSL mode
36 |
37 | Please follow the following instructions to put your stick in BSL mode:
38 |
39 | - Unplug your stick from the host
40 | - Press the `BSL` pushbutton and keep holding while plugging the device back into the host:
41 |
42 | {: style="height:15%;width:15%" loading=lazy} {: style="height:15%;width:15%" loading=lazy}
43 |
44 | - Give it a few seconds for the device to settle and set up and release the BSL button
45 | - Your stick should now be in ROM bootloader mode
46 |
47 | It's very important that you press and hold the BSL button **before** plugging it in to the host and release it **after a few seconds**. If you don't follow this, your stick will not enter BSL mode and flashing will fail.
48 |
49 |
50 | ## Select correct device
51 |
52 | We need to tell SmartRF Flash Programmer v2 what target device we have on our stick. Select "CC2652P":
53 |
54 | {: style="height:15%;width:15%" loading=lazy}
55 |
56 |
57 | ## Select firmware file and flash device
58 |
59 | With the correct serial port chosen and target device selected, click "Browse" and select the firmware you want to flash (see [here](/radio-docs/quick-start/#step-2-download-the-correct-firmware-for-your-device) for help on choosing firmware).
60 |
61 | !!! warning
62 | It is crucial that you download the correct firmware for your stick as using the wrong firmware will disable the BSL and you will need an external debugger / programmer to flash your stick again.
63 |
64 | With the correct firmware chosen, make sure that "Erase", "Program" and "Verify" are all chosen under "Actions" and press the blue button to start flashing:
65 |
66 | {: style="height:70%;width:70%" loading=lazy}
67 |
68 | If all goes to plan, after a few seconds you should see a green bar confirming that the flashing operating suceeded:
69 |
70 | {: style="height:70%;width:70%" loading=lazy}
71 |
72 | You can now proceed to configuring your software of choice see [HERE](/radio-docs/z2m-zha/).
73 |
74 | If your stick is not in BSL mode or you have not chosen the correct serial port, you will get the following error message:
75 |
76 | {: style="height:70%;width:70%" loading=lazy}
77 |
78 | Unplug your stick and try again according the instructions.
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/flash-zigstargw.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Flash ZigStar LAN Gateway
3 | description: Flashing Procedure for ZigStar LAN/POE Gateway
4 | hide:
5 | - tags
6 | tags:
7 | - esp32
8 | - firmware
9 | - WT32-ETH01
10 | - TTGO
11 | - LAN
12 | - gateway
13 | ---
14 |
15 | # Flash ZigStar LAN Gateway Firmware
16 |
17 | ## Requirements
18 |
19 | - [NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher/releases/latest/download/NodeMCU-PyFlasher.exe)
20 | - [ZigStarGW-FW](https://github.com/xyzroe/ZigStarGW-FW/releases/latest/)[^1]
21 | - USB-C Type Cable
22 |
23 | ## Flash firmware
24 |
25 | ### Step 1: Activate Flash Mode
26 |
27 | To enable flash mode on ESP32, BOOT button/switch should be pressed before you plug in your USB cable.
28 | Press and HOLD for 5 seconds after you plugged in your USB cable to PC.
29 |
30 | *Be sure DIP switch is in ESP Mode( or jumpers are not soldered)
31 |
32 | {: style="height:50%;width:50%" loading=lazy}
33 |
34 | ### Step 2: Firmware flashing
35 |
36 | Start the previously loaded NodeMCU pyFlasher Tool, and select the identified serial port from the list, as well as the downloaded firmware file.
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 | ???+ done
56 |
57 | At this point you are up and running.
58 | Access your device by IP or hostname using your browser.
59 |
60 | ???+ note
61 |
62 | Flashing is required only once if you assembly device yourself or move from ESP-HOME.
63 | Use [ZigStarGW_vx.x.x.full.bin](https://github.com/xyzroe/ZigStarGW-FW/releases/latest/)for [NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher/releases/latest/download/NodeMCU-PyFlasher.exe)
64 |
65 | ### Step 3: ZigBee Firmware Update ( Optional )
66 |
67 | In case you want to update/install your Zigbee Firmware, follow [ZigStar MultiTool Instructions](/radio-docs/zigstar-multi-tool/)
68 |
69 |
70 | [^1]: Download [ZigStarGW_vx.x.x.full.bin](https://github.com/xyzroe/ZigStarGW-FW/releases/latest/)if you are using [NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher/releases/latest/download/NodeMCU-PyFlasher.exe)
71 | [^2]: Will be downloaded .bin , is specially for OTA update.
72 |
73 | ## Update your firmware
74 |
75 | To update your existing firmware[^2] just go to your browser and access your device by IP or hostname.
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 | ???+ done
96 |
97 | Congratulations, you are on last firmware.[^2]
98 |
99 |
100 |
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/quick-start.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Quick Start
3 | description: Quick Start for ZigStar Projects
4 | hide:
5 | - tags
6 | tags:
7 | - Quickstart
8 | - ZHA
9 | - Zigbee2MQTT
10 | - Z2M
11 | - Home Assistant
12 | - HA
13 | ---
14 |
15 | # Quick Start for ZigStar Projects
16 |
17 | This page provides a overview of what you'll need to do to set up your USB/LAN Coordinator to be used with the great collection of open-source home automation software, [Z2M(Zigbee2MQTT)](https://www.zigbee2mqtt.io/)or [ZHA](https://www.home-assistant.io/integrations/zha/)
18 |
19 | ## 1.Plug your device in
20 |
21 | First step in getting your coordinator working is to ensure that your computer, server or Raspberry Pi recognises the device plugged in (specifically, the "USB to Serial Converter" chip) and installs the drivers needed.
22 |
23 | For network devices that they are reachable by network, using IP address or hostname.
24 |
25 | Each coordinator is compatible by default with [Z2M(Zigbee2MQTT)](https://www.zigbee2mqtt.io/)and [ZHA](https://www.home-assistant.io/integrations/zha/)
26 |
27 | ## 2.Download firmware
28 |
29 | If you are using correct firmware,you dont need an external debugger/programmer as the chips used have a built-in bootloader (BSL)!
30 |
31 | There are two ways you can use your device, either as a **coordinator** or a **router**.
32 |
33 | === "**Coordinator**"
34 | This is the firmware you need if you're going to be using your coordinator with [Z2M(Zigbee2MQTT)](https://www.zigbee2mqtt.io/), [ZHA(Home Assistant)](https://www.home-assistant.io/integrations/zha/)or any other ZNP-firmware-compliant software.
35 |
36 | | RF-STAR RF-BM-2652P2 | Ebyte E72-2G4M20S1E
37 | |----------------------|--------------------|
38 | | [CC1352P2_CC2652P_launchpad_*.zip](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin)| [CC1352P2_CC2652P_other_*.zip](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin)|
39 |
40 | !!! info
41 | CC1352P2_CC2652P_launchpad_*.zip - RF-BM-2652P1/P2 modules
42 | CC1352P2_CC2652P_other_*.zip - E72-2G4M20S1E module
43 |
44 | === "**Router**"
45 | If you're looking to extend the range of your network, flash your coordinator with the router firmware and plug it into a power source somewhere central in your home for stand-alone operation. Refer to the [README](https://github.com/Koenkk/Z-Stack-firmware/blob/master/router/Z-Stack_3.x.0/bin/README.md)for setup instructions.
46 |
47 | | RF-STAR RF-BM-2652P2 | Ebyte E72-2G4M20S1E
48 | |----------------------|--------------------|
49 | | [CC1352P2_CC2652P_launchpad_router_*.zip](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin)| [CC1352P2_CC2652P_other_router_*.zip](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/Z-Stack_3.x.0/bin)|
50 |
51 | !!! info
52 | CC1352P2_CC2652P_launchpad_router_*.zip - RF-BM-2652P1/P2 modules
53 | CC1352P2_CC2652P_other_router*.zip - E72-2G4M20S1E module
54 |
55 | !!! danger
56 | It is crucial that you download the correct firmware for your coordinator as using the wrong firmware will disable the BSL and you will need an external debugger / programmer to flash your coordinator again.
57 |
58 | ## 3.Flash the firmware
59 |
60 | With the firmware of your choice downloaded and unziped, you should end up with a single .hex file that will need to be flashed to your coordinator. Three options for that:
61 |
62 | - The beginner friendly option: [ZigStar Multi Tool](/radio-docs/zigstar-multi-tool/#zigstar-multi-tool)
63 | - Windows-only option: [Flash firmware using TI's Flash Programmer 2](/radio-docs/flash-ti-flash-prog/)
64 | - Cross-platform option using Python: [Flash firmware using cc2538-bsl](/radio-docs/flash-cc-bsl/)
65 |
66 | ## 4.Setup Zigbee2MQTT or ZHA
67 |
68 | Configure your choice of software so that it can talk to your coordinator.
69 | For instruction go [HERE](/radio-docs/z2m-zha/)
70 |
71 | ## 5.Have fun!
72 |
73 | With your coordinator flashed and the software of your choice configured, you can start to pair your devices and start exploring the world of open-source Home Automation!
74 | A significant amount of effort goes to developing, maintaining and supporting the open source home automation ecosystem so if you can, please consider donating to the great software projects that are mentioned in these pages.
75 |
76 | A portion of each sale of ZigStar radio boards will be donated to [@Koenkk](https://github.com/Koenkk/) to support his work on [Zigbee2mqtt](https://github.com/Koenkk/zigbee2mqtt).
77 |
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/z2m-zha.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Configuration Z2M/ZHA
3 | description: Zigbee2MQTT and ZHA Setup Documentation ZigStar
4 | hide:
5 | - tags
6 | tags:
7 | - Z2M
8 | - ZHA
9 | - Zigbee2MQTT
10 | - Home Assistant
11 | ---
12 |
13 | # Choose your side
14 |
15 | [Zigbee2MQTT](https://www.zigbee2mqtt.io/) has support for TI CC2652P/CC2652RB chips used on this boards.
16 | ZHA Supports both TI and SiLabs chips.
17 |
18 | ## First Steps
19 |
20 | Choose your device instructions:
21 |
22 | === "USB Stick v4"
23 |
24 | 1. Power on your USB Stick
25 | 2. Make sure that the USB-serial bridge drivers are installed and your device is recognised (instructions [here](/radio-docs/flash-cc-bsl/#determine-the-usb-port-ip-address)).
26 | 3. Configure your software to access the device.
27 |
28 | === "Zigbee2MQTT"
29 |
30 | Currently only TI Chips are supported by Z2M( CC2652P/CC2652RB ).
31 |
32 | With the correct serial port identified, edit your Zigbee2MQTT `configuration.yaml` :
33 | ```
34 | serial:
35 | port: /dev/ttyUSB0 (change this if it is different on your machine)
36 | ```
37 |
38 | === "ZHA"
39 | 3.1. Add the ZHA Integration via the Add Integrations option:
40 |
41 | {: style="height:50%;width:50%" loading=lazy}
42 |
43 | 3.2. From dropdown menu select your stick:
44 |
45 | {: style="height:50%;width:50%" loading=lazy}
46 |
47 | 3.3. Choose the device path of USB Stick and wait for installation to complete.
48 |
49 | - In case the autodetection fails,a manual setup menu will be displayed.
50 |
51 | !!! info
52 | Enter device path and Port Speed:115200 and Software Flow Control leave empty.
53 |
54 | {: style="height:50%;width:50%" loading=lazy}
55 |
56 | !!! info
57 | If ZHA is unable to connect to the USB adapter then try re-plugging in the USB adapter or try moving it to another USB-port.
58 |
59 | === "LAN/PoE Gateway"
60 |
61 | 1. Connect the gateway to a ethernet cable which has access to your local network.
62 | 2. Power on the gateway with a Type C cable.
63 | 3. Determine the device's ip address,if your local network supports .local mdns addresses, the devices can be reached that way:
64 | ```
65 | zigstargw.local
66 | ```
67 | or by static ip.
68 |
69 | !!! info
70 | If its used Static IP Address - be sure it is reserved in your router,so will not change after reboot.
71 |
72 | 4. Configure your software to access the device.
73 |
74 | === "Zigbee2MQTT"
75 |
76 | Currently only TI Chips are supported by Z2M( CC2652P/CC2652RB ).
77 |
78 | With the correct IP or hostname identified, edit your Zigbee2MQTT `configuration.yaml`:
79 | ```
80 | serial:
81 | port: 'tcp://ip_or_hostname:6638'
82 | ```
83 |
84 |
85 | === "ZHA"
86 | 4.1. Add the ZHA Integration via the Add Integrations option:
87 |
88 | {: style="height:50%;width:50%" loading=lazy}
89 |
90 | 4.2. From dropdown menu select Manual:
91 |
92 | {: style="height:50%;width:50%" loading=lazy}
93 |
94 | 4.3. Select the Radio type for your chip:
95 |
96 | {: style="height:50%;width:50%" loading=lazy}
97 |
98 | !!! info
99 | For TI based gateways select ZNP
100 | For SiLabs based gateways select EZSP
101 |
102 | 4.4. Enter socket://ip_or_hostname:6638 and Port Speed:115200 and Software Flow Control leave empty.
103 |
104 | {: style="height:50%;width:50%" loading=lazy}
105 |
106 | ## Troubleshooting
107 |
108 | ### Zigbee2MQTT: Error Network Commissioning Timeout (panID or extendedPanID already exists nearby)
109 | This error is discussed in these two threads: [first](https://github.com/Koenkk/zigbee2mqtt/issues/10858) and [second](https://github.com/tube0013/tube_gateways/issues/95).
110 | According to the first thread, the most possible issue cause this error is: `zigbee2mqtt will always use the same, default extendedPanId unless you set it to something else in the config file`
111 | ```yaml
112 | advanced:
113 | pan_id: GENERATE
114 | ext_pan_id: [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]
115 | network_key: GENERATE
116 | ```
117 | According to the second thread, the users propose to start without antennas or routers nearby: `Try unscrewing the antenna during startup or unplug any near by routers temporarily.`
118 |
119 | Try to do abovementioned as well as start ZHA just to test your device:
120 |
121 | 1. Go to Home Assistant
122 | 2. Click `Settings`
123 | 3. Go to `Devices & Services`
124 | 4. Click `Add integration` (right bottom corner)
125 | 5. Find «Zigbee Home Automation», click on it;
126 | 6. Between two options «Add Zigbee device» and «Zigbee Home Automation» choose `Zigbee Home Automation`;
127 | 7. Select serial port window - `Enter manually`
128 | 8. Radio type window - `ZNP = Texas Instruments Z-Stack ZNP … `
129 | 9. Serial port settings window:
130 | - Serial device path: « socket://192.168.1.105:6638 », where 192.168.1.105 is IP address of your ZigStar Adapter;
131 | - port speed left by default 115200;
132 | - data flow control undefined (it does not matter for LAN adapters)
133 | 10. Press `Submit`.
134 | 11. Network formation window - `Erase network settings and form a new network`
135 | 12. Wait for Zigbee network and try to add some Zigbee end-device (e.g. sensor etc)
136 |
137 | If ZHA starts - means that the problem in communication between Zigbee2MQTT and Z-Stack firmware, flashed to the adapter. To solve it - try steps above ZHA part.
138 |
139 |
140 |
--------------------------------------------------------------------------------
/documentation/docs/radio-docs/zigstar-multi-tool.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ZigStar Multi Tool
3 | description: Instructions for ZigStar Multi Tool
4 | hide:
5 | - tags
6 | tags:
7 | - cc2538-bsl
8 | - flashing
9 | - bsl
10 | - erase
11 | - nvram
12 | - multi tool
13 | ---
14 |
15 | # ZigStar Multi Tool
16 |
17 | [ZigStar Multi Tool](https://github.com/xyzroe/ZigStarGW-MT)is GUI tool designed for easy work with ZigStar LAN GW and USB Stick and packed into single executable file.
18 | You can get started without installing Python and the required modules - just download and open.
19 |
20 | *All ZigStar boards( LAN or USB) are supported by Multi Tool.(now also supports sticks, regardless of the manufacturer)
21 |
22 | [Download](https://github.com/xyzroe/ZigStarGW-MT/releases/){ .md-button , target=_blank}
23 |
24 | ## Features
25 | - Read / Write / Erase NVRAM memory of Zigbee module
26 | - Write / Verify / Erase firmware of Zigbee module
27 | - Backdoor Serial Loader turns on automatically
28 | - Manual restart of Zigbee module or ESP32 is available
29 | - Comaptible with OS X, Windows and Ubuntu
30 |
31 | ## Screenshots
32 |
33 |