Skip to content

Commit f2f2561

Browse files
rzrrzr
committed
SWPROT-8953: doc: Add reference to UnifySDK online doc
Those files should be revised for next release. Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
1 parent d006ae0 commit f2f2561

13 files changed

+153
-110
lines changed

‎doc/getting_started.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Running Unify on Raspberry Pi
22

3+
4+
Note: For reference documentation please refer to
5+
[UnifySDK documentation](
6+
https://SiliconLabs.github.io/UnifySDK/
7+
)
8+
9+
WARNING: The following chapters may be oudated,
10+
they are still here until the new release of UnifySDK.
11+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
12+
13+
314
The Unify Host SDK targets our reference platform, a Raspberry Pi 4 (RPi4).
415
It is therefore recommended to set up a RPi4 for evaluating the full set of functionalities.
516

‎doc/getting_started_as_developer.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Getting Started as a Developer
22

3+
4+
Note: For reference documentation please refer to
5+
[UnifySDK documentation](
6+
https://SiliconLabs.github.io/UnifySDK/
7+
)
8+
9+
WARNING: The following chapters may be oudated,
10+
they are still here until the new release of UnifySDK.
11+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
12+
13+
314
```{toctree}
415
---
516
maxdepth: 2

‎doc/getting_started_unify.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Getting Started with Unify
22

3+
4+
Note: For reference documentation please refer to
5+
[UnifySDK documentation](
6+
https://SiliconLabs.github.io/UnifySDK/
7+
)
8+
9+
WARNING: The following chapters may be oudated,
10+
they are still here until the new release of UnifySDK.
11+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
12+
13+
314
## Introduction
415

516
Unify SDK is a software framework that simplifies the developer experience, removing difficult parts of network control and network management as it relates to gateway and hub development in IoT applications. It can also provide Matter bridge functionality to other protocols that do not natively run matter.
@@ -10,9 +21,6 @@ Unify SDK is a software framework that simplifies the developer experience, remo
1021

1122
- At least one of the following, supported wireless radios is connected to the RPi4 via USB:
1223
- [Z-Wave module](https://www.silabs.com/wireless/z-wave) flashed with Z-Wave - NCP Serial API Controller.
13-
- [Zigbee module](https://www.silabs.com/wireless/zigbee) EFR32MG2X/EFR32xG22 running NCP for Zigbee or RCP for Multiprotocol
14-
- [Bluetooth module](https://www.silabs.com/wireless/bluetooth) EFR32xG22 running NCP Firmware for AoXPC
15-
1624

1725
The following are the ways to get started with Unify..
1826

‎doc/getting_started_unify_sdk.md‎

Lines changed: 12 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
# Unify Framework Getting Started
22

3+
4+
Note: For reference documentation please refer to
5+
[UnifySDK documentation](
6+
https://SiliconLabs.github.io/UnifySDK/
7+
)
8+
9+
WARNING: The following chapters may be oudated,
10+
they are still here until the new release of UnifySDK.
11+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
12+
13+
314
## Setup base system
415

516
Unify Framework has a number of service applications which enables different basic
617
functionality. For unlocking all features of the Unify Framework, install the Debian
718
packages of the applications below.
8-
It is recommended to use the Developer GUI for controlling the Unify Framework IoT Protocol Controllers such as `ZPC`,
9-
`ZigPC` or `AoXPC`.
19+
It is recommended to use the Developer GUI for controlling the Unify Framework IoT Protocol Controllers such as `ZPC`.
1020

1121
For installation steps refer to the [](how-to-install) section.
1222

@@ -21,8 +31,6 @@ For installation steps refer to the [](how-to-install) section.
2131
For including an IoT protocol stack, you need to install and setup at least one protocol controller.
2232

2333
- [](zpc)
24-
- [](zigpc)
25-
- [](aoxpc)
2634

2735
(zpc)=
2836

@@ -39,35 +47,6 @@ provide the USB path for the Z-Wave module at the configuration steps.
3947
A more in depth getting started guide specifically for the `ZPC` is
4048
[ZPC User's Guide](../applications/zpc/readme_user.md).
4149

42-
(zigpc)=
43-
44-
### Zigbee Protocol Controller (ZigPC)
45-
46-
**Prerequisite**: Required hardware for using the `ZigPC` is a [Zigbee module](https://www.silabs.com/wireless/zigbee) which could be EFR32MG12/EFR32xG22
47-
running NCP or CPC Firmware for Zigbee.
48-
49-
The `ZigPC` enables the Unify Framework to control Zigbee devices. Starting quickly
50-
can be done by simply installing the `uic-zigpc` Debian package and configuring
51-
the USB device at the configuration step. After installing, the protocol
52-
controller should be started automatically as a systemd service.
53-
54-
For more information on getting started with the `ZigPC` is placed in
55-
[ZigPC User's Guide](../applications/zigpc/readme_user.md).
56-
57-
(aoxpc)=
58-
59-
### Bluetooth Angle of Arrival/Departure Protocol Controller (AoXPC)
60-
61-
**Prerequisite**: Required hardware for using the `AoXPC` is a [Bluetooth module](https://www.silabs.com/wireless/bluetooth)
62-
EFR32xG22 running NCP Firmware for AoXPC.
63-
64-
Lastly of the protocol controllers the above approach can again be used for the
65-
`AoXPC`. Installing `uic-aoxpc`, going through configuration steps and it should
66-
be running.
67-
68-
For more information on getting started with the `AoXPC` is found in
69-
[AoXPC User Guide](../applications/aox/applications/aoxpc/readme_user.md).
70-
7150
### Evaluation after Installation
7251

7352
Once all Unify Framework Applications are installed and configured, one can evaluate the system via the Unify Framework Developer GUI.

‎doc/protocol_controllers.md‎

Lines changed: 11 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Protocol Controllers
22

3+
Note: For reference documentation please refer to
4+
[UnifySDK documentation](
5+
https://SiliconLabs.github.io/UnifySDK/
6+
)
7+
8+
WARNING: The following chapters may be oudated,
9+
they are still here until the new release of UnifySDK.
10+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
11+
12+
313
The Unify Framework currently includes several protocol controllers.
414

515
Each protocol controller interfaces with its radio hardware and implements a
@@ -19,43 +29,11 @@ protocol/zwave/zpc_introduction.md
1929
```
2030
- [The Z-Wave protocol controller (ZPC)](protocol/zwave/zpc_introduction.md) implements the Z-Wave wireless protocol using a Z-Wave NCP.
2131

22-
```{toctree}
23-
---
24-
maxdepth: 2
25-
hidden:
26-
---
27-
protocol/zigbee/zigpc_introduction.md
28-
```
29-
- [The Zigbee protocol controller (ZigPC)](protocol/zigbee/zigpc_introduction.md) implements the ZigBee wireless protocol using a Zigbee NCP.
30-
31-
```{toctree}
32-
---
33-
maxdepth: 2
34-
hidden:
35-
---
36-
./multiprotocol.md
37-
```
38-
- [The Multiprotocol Host Software (Zigbee, OpenThread, Bluetooth)](multiprotocol.md) uses the RCP mode of the wireless SoC to implement Zigbee, OpenThread, and Bluetooth.
39-
4032
```{toctree}
4133
---
4234
maxdepth: 2
4335
hidden:
4436
---
4537
protocol/matter/matter_mpc.md
4638
```
47-
- [The Matter protocol controller](protocol/matter/matter_mpc.md) implements the matter protocol.
48-
49-
```{toctree}
50-
---
51-
maxdepth: 2
52-
hidden:
53-
---
54-
protocol/aox/aox_introduction.md
55-
```
56-
- [The Bluetooth AoX protocol controller (AoXPC)](protocol/aox/aox_introduction.md) implements Bluetooth AoX functionality.
57-
58-
59-
60-
61-
39+
- [The Matter protocol controller (Deprecated)](protocol/matter/matter_mpc.md) implements the matter protocol.

‎doc/readme_building.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Unify Build Guide
22

3+
Note: For reference documentation please refer to
4+
[UnifySDK documentation](
5+
https://SiliconLabs.github.io/UnifySDK/
6+
)
7+
8+
WARNING: The following chapters may be oudated,
9+
they are still here until the new release of UnifySDK.
10+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
11+
12+
313
This document is intended for systems integrators who are trying to
414
cross-compile the Unify components. This guide explains how to build Debian
515
packages for the Raspberry Pi.

‎doc/readme_cmake.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# CMake Integration
22

3+
Note: For reference documentation please refer to
4+
[UnifySDK documentation](
5+
https://SiliconLabs.github.io/UnifySDK/
6+
)
7+
8+
WARNING: The following chapters may be oudated,
9+
they are still here until the new release of UnifySDK.
10+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
11+
12+
313
```{toctree}
414
---
515
maxdepth: 2

‎doc/readme_developer.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Unify Developer Guide
22

3+
Note: For reference documentation please refer to
4+
[UnifySDK documentation](
5+
https://SiliconLabs.github.io/UnifySDK/
6+
)
7+
8+
WARNING: The following chapters may be oudated,
9+
they are still here until the new release of UnifySDK.
10+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
11+
12+
313
This is a guide for developers who wish to get started on adding or modifying the
414
Unify SDK source code.
515

@@ -59,9 +69,6 @@ i.e. "unify_my_sample_component".
5969
| |-- zpc/ // ZPC application code
6070
| | |-- components/ // ZPC components
6171
| | `-- ...
62-
| |-- zigpc/ // ZIGPC application code
63-
| | |-- components/ // ZIGPC components
64-
| | `-- ...
6572
| |-- gms/ // GMS application code
6673
| |-- upvl/ // UPVL application code
6774
| `-- ...

‎doc/release_notes.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Unify Release Notes
22

3+
4+
Note: For reference documentation please refer to
5+
[UnifySDK documentation](
6+
https://SiliconLabs.github.io/UnifySDK/
7+
)
8+
9+
WARNING: The following chapters may be oudated,
10+
they are still here until the new release of UnifySDK.
11+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
12+
13+
314
Below are descriptions of the changes to our shared components.
415
These changes affects all applications based on the Unify Host SDK.
516

@@ -13,15 +24,9 @@ For the application specific release notes, please follow these links:
1324
* [Dev GUI](../applications/dev_ui/dev_gui/release_notes.md)
1425
* [Image Provider](../applications/image_provider/release_notes.md)
1526
* [UPVL](../applications/upvl/release_notes.md)
16-
* [ZigPC](../applications/zigpc/release_notes.md)
1727
* [ZPC](../applications/zpc/release_notes.md)
1828
* [UPTICap](../applications/upti_cap/release_notes.md)
1929
* [UPTIWriter](../applications/upti_writer/release_notes.md)
20-
* [AoXPC](../applications/aox/applications/aoxpc/release_notes.md)
21-
* [AoX Positioning application](../applications/aox/applications/positioning/release_notes.md)
22-
* [CPCd](../applications/cpcd/release_notes.md)
23-
* [OpenThread Border Router](../applications/openthread_border_router/release_notes.md)
24-
* [Zigbeed](../applications/zigbeed/release_notes.md)
2530
* [Portable Runtime](../portable_runtime/release_notes.md)
2631

2732
## [1.6.0] - August 2024

‎doc/running_unify.md‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Setting up Raspberry Pi for Unify
22

3+
4+
Note: For reference documentation please refer to
5+
[UnifySDK documentation](
6+
https://SiliconLabs.github.io/UnifySDK/
7+
)
8+
9+
WARNING: The following chapters may be oudated,
10+
they are still here until the new release of UnifySDK.
11+
In the future, Z-Wave parts will be more isolated and the rest deduplicated.
12+
13+
314
## Introduction
415

516
Here we explain how to set up and running quickly to test out Unify on the Raspberry Pi reference platform. Depending on the protocol(s) used this setup may vary so there are several sections that go into more detail for each protocol controller. This page contains the steps to install Unify on the Raspberry Pi regardless of the protocol(s) used.
@@ -75,17 +86,4 @@ hidden:
7586
protocol/zwave/running_zpc.md
7687
```
7788

78-
[Zigbee (ZigPC)](protocol/zigbee/running_zigpc.md)
79-
80-
```{toctree}
81-
---
82-
maxdepth: 1
83-
titlesonly:
84-
hidden:
85-
---
86-
protocol/zigbee/running_zigpc.md
87-
```
88-
89-
[Matter Protocol Controller](protocol/matter/matter_mpc.md)
90-
91-
[Multiprotocol](getting_started_multiprotocol_cpc.md)
89+
[Matter Protocol Controller (Deprecated)](protocol/matter/matter_mpc.md)

0 commit comments

Comments
 (0)