Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

zpc: Fix documentation #72

Open
3 tasks
rzr opened this issue Mar 18, 2025 · 0 comments
Open
3 tasks

zpc: Fix documentation #72

rzr opened this issue Mar 18, 2025 · 0 comments

Comments

@rzr
Copy link
Collaborator

rzr commented Mar 18, 2025 •
edited
Loading

Been told that there is a lot of outdated documentations available in various places.

For example:

https://www.silabs.com/documents/public/quick-start-guides/qsg185-z-wave-800-dev-kit.pdf

Is about 1.3 (and refer to online doc which is currently 1.7)

It would make sense to aggregate and maintain it in a single place (ideally where the code is maintained)

Also online docs should be versioned in a proper way (a la readthedocs.io).

Meanwhile I can provide some hints, in this ticket.

You can start by looking at README.md file:

#41

Current doc does not cover:

  • how to use dev-ui (which should be downloaded from unify repo to be used along zpc)
  • how to use Portable Env
  • WSL2 support is not documented either, but it should be trivial to adapt, only this trick will be needed to connect the NCP: ( https://learn.microsoft.com/en-us/windows/wsl/connect-usb )

Help or feedback welcome

cc: @vietnq-silabs
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
build: d/host_dependencies.apt: Remove libasound2 for WSL SiliconLabs…
4e1daa9 
…Software#72

Since Zap is not used in zpc, it can be safely removed.
More cleanup can be done later.

Observed issue was:

    sudo apt install -y (...)
    Package libasound2 is a virtual package provided by:
    liboss4-salsa-asound2 4.2-build2020-1ubuntu3
    libasound2t64 1.2.11-1build2 (= 1.2.11-1build2)
    You should explicitly select one to install.

Origin: SiliconLabsSoftware#41
Relate-to:"SiliconLabsSoftware#72
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: build: Add run rule (SiliconLabsSoftware#72)
c9387ce 
Also hotfix version if tags are not cloned.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: Docs add Quickstart instructions (SiliconLabsSoftware#72)
9b4bf60 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: git: Ignore temp files (SiliconLabsSoftware#72)
d1f5103 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: docker: Run zpc in container (SiliconLabsSoftware#72)
d2bb276 
Since the port is exposed, the user can interact with mosquitto clients
ouside the container.

   mosquitto_sub -t '#'

Not this feature is not explicilty supported at the moment,
but it can be useful for validation purposes.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: build: Add run rule (SiliconLabsSoftware#72)
aee776b 
Also hotfix version if tags are not cloned.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: Docs add Quickstart instructions (SiliconLabsSoftware#72)
7dd5ca4 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: git: Ignore temp files (SiliconLabsSoftware#72)
2f8918d 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: docker: Run zpc in container (SiliconLabsSoftware#72)
901105b 
Since the port is exposed, the user can interact with mosquitto clients
ouside the container.

   mosquitto_sub -t '#'

Not this feature is not explicilty supported at the moment,
but it can be useful for validation purposes.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
@rzr rzr mentioned this issue Mar 18, 2025
Open
1 task
Thomasdjb added a commit to Thomasdjb/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@Thomasdjb
script: Add wsl2 devices support SiliconLabsSoftware#73
fde8b4a 
Relates-to:SiliconLabsSoftware#72
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
build: d/host_dependencies.apt: Remove libasound2 for WSL SiliconLabs…
13b3c14 
…Software#72

Since Zap is not used in zpc, it can be safely removed.
More cleanup can be done later.

Observed issue was:

    sudo apt install -y (...)
    Package libasound2 is a virtual package provided by:
    liboss4-salsa-asound2 4.2-build2020-1ubuntu3
    libasound2t64 1.2.11-1build2 (= 1.2.11-1build2)
    You should explicitly select one to install.

Origin: SiliconLabsSoftware#41
Relate-to:"SiliconLabsSoftware#72
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: build: Add run rule (SiliconLabsSoftware#72)
64fcb58 
Also hotfix version if tags are not cloned.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: Docs add Quickstart instructions (SiliconLabsSoftware#72)
869d68f 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: git: Ignore temp files (SiliconLabsSoftware#72)
954decc 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 18, 2025
@rzr
SWPROT-8953: docker: Run zpc in container (SiliconLabsSoftware#72)
195fc7e 
Since the port is exposed, the user can interact with mosquitto clients
ouside the container.

   mosquitto_sub -t '#'

Not this feature is not explicilty supported at the moment,
but it can be useful for validation purposes.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 19, 2025
@rzr
build: d/host_dependencies.apt: Remove libasound2 for WSL SiliconLabs…
0109508 
…Software#72

Since Zap is not used in zpc, it can be safely removed.
More cleanup can be done later.

Observed issue on Ubuntu 24.04 (noble) was:

    sudo apt install -y (...)
    Package libasound2 is a virtual package provided by:
    liboss4-salsa-asound2 4.2-build2020-1ubuntu3
    libasound2t64 1.2.11-1build2 (= 1.2.11-1build2)
    You should explicitly select one to install.

Origin: SiliconLabsSoftware#41
Relate-to:"SiliconLabsSoftware#72
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: build: Add run rule (SiliconLabsSoftware#72)
71e1a37 
Also hotfix version if tags are not cloned.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: Docs add Quickstart instructions (SiliconLabsSoftware#72)
7e49fca 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: git: Ignore temp files (SiliconLabsSoftware#72)
d90116f 
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: docker: Run zpc in container (SiliconLabsSoftware#72)
d82d304 
Since the port is exposed, the user can interact with mosquitto clients
ouside the container.

   mosquitto_sub -t '#'

Not this feature is not explicilty supported at the moment,
but it can be useful for validation purposes.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this issue Mar 19, 2025
@rzr
build: d/host_dependencies.apt: Remove libasound2 for WSL #72
e295959 
Since Zap is not used in zpc, it can be safely removed.
More cleanup can be done later.

Observed issue on Ubuntu 24.04 (noble) was:

    sudo apt install -y (...)
    Package libasound2 is a virtual package provided by:
    liboss4-salsa-asound2 4.2-build2020-1ubuntu3
    libasound2t64 1.2.11-1build2 (= 1.2.11-1build2)
    You should explicitly select one to install.

Origin: #41
Relate-to:"#72
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: build: Add run rule (#72)
7acb53d 
Also hotfix version if tags are not cloned.

Origin: #41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: Docs add Quickstart instructions (#72)
559863c 
Origin: #41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: git: Ignore temp files (#72)
793f1f5 
Origin: #41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this issue Mar 19, 2025
@rzr
SWPROT-8953: docker: Run zpc in container (#72)
871899e 
Since the port is exposed, the user can interact with mosquitto clients
ouside the container.

   mosquitto_sub -t '#'

Not this feature is not explicilty supported at the moment,
but it can be useful for validation purposes.

Origin: #41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rzr