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.

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

SWPROT-8953: Docs add Quickstart instructions #41

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

rzr
Copy link
Collaborator

@rzr rzr commented Feb 17, 2025

Change

Checklist

@rzr rzr marked this pull request as draft February 17, 2025 13:44
rzr added a commit to rzr/z-wave-protocol-controller that referenced this pull request Feb 17, 2025
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 pull request Feb 17, 2025
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this pull request Feb 21, 2025
Origin: #41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit that referenced this pull request Feb 21, 2025
Origin: #41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
rzr added a commit to rzr/z-wave-protocol-controller that referenced this pull request Feb 26, 2025
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 pull request Feb 26, 2025
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 pull request Feb 26, 2025
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 pull request Feb 26, 2025
Since the port is exposed, the user can interact with mosquitto clients
ouside the container.

mosquitto_sub -t '#'

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
@rzr rzr requested a review from vietnq-silabs March 6, 2025 18:40
rzr added a commit to rzr/z-wave-protocol-controller that referenced this pull request Mar 7, 2025
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 pull request Mar 7, 2025
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 pull request Mar 7, 2025
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 pull request Mar 7, 2025
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 force-pushed the doc/review/main branch from ce63cb0 to ebc7364 Compare March 7, 2025 08:56
rzr added a commit to rzr/z-wave-protocol-controller that referenced this pull request Mar 7, 2025
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
@rzr rzr force-pushed the doc/review/main branch from ebc7364 to d02c263 Compare March 7, 2025 08:57
rzr added a commit to rzr/z-wave-protocol-controller that referenced this pull request Mar 7, 2025
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 pull request Mar 7, 2025
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>
@vietnq-silabs
Copy link

This is my full log
build_log_all.txt

@rzr
Copy link
Collaborator Author

rzr commented Mar 7, 2025

This is my full log build_log_all.txt

you did not clone that branch, try again

script z-wave-protocol-controller-pull-41.txt
git clone -b doc/review/main https://github.com/rzr/z-wave-protocol-controller
set -x
cd z-wave-protocol-controller
./helper.mk help VERBOSE=1
./helper.mk all/help VERBOSE=1
./helper.mk setup VERBOSE=1
./helper.mk all VERBOSE=1
./helper.mk run VERBOSE=1

Then it should show you the help menu, then you can run application directly if you prefer.

@vietnq-silabs
Copy link

I cloned this branch and this is the log.

z-wave-protocol-controller-pull-41.txt

@rzr
Copy link
Collaborator Author

rzr commented Mar 7, 2025

I cloned this branch and this is the log.

z-wave-protocol-controller-pull-41.txt

ESC[?2004l^MESC[?2004hroot@NB0020681:~/z-wave-protocol-controller# ESC[7m/helper.mk run VERBOSE=1ESC^H^H^H^H^H^H^H^H^H^H^H^H^H^H^H^H^H^H^H^H/helper.mk run VERBOSE=1
ESC[?2004l^Mbash: /helper.mk: No such file or directory
ESC[?2004hroot@NB0020681:~/z-wave-protocol-controller# ^G^G^G^G^G^G^GESC[1@.
ESC[?2004l^Mfatal: No tags can describe 'd02c263bf399b468f11046cb801c790f4f7cf57b'.
Try --always, or create some tags.
fatal: No tags can describe 'd02c263bf399b468f11046cb801c790f4f7cf57b'.
Try --always, or create some tags.
file -E build/applications/zpc/zpc
build/applications/zpc/zpc: ELF 64-bit LSB pie executable, x86-64, version 1 (GNU/Linux), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=d9631b8ae9868b3d9e7a2bb93da5d4a0922d4b26, for GNU/Linux 3.2.0, with debug_info, not stripped
build/applications/zpc/zpc --help
ls: cannot access '/dev/disk/by-uuid': No such file or directory
2025-Mar-07 16:52:52.892414ESC[31;1m <E> [zpc_config] Failure in finding device_id by /dev/disk/by-uuid. Try setting zpc.device_id in UIC config fileESC[0m
2025-Mar-07 16:52:52.893080ESC[32;1m <i> [uic_init] # Unify build version: ver_0.0.0-d02c263bESC[0m
2025-Mar-07 16:52:52.893218ESC[32;1m <i> [uic_init] # Unify build SHA: d02c263bESC[0m

Usage: build/applications/zpc/zpc [Options]

ok it looks like you figured out how to run the app, let me add the --always option it should not hurt.

rzr added 3 commits March 7, 2025 11:09
Also hotfix version if tags are not cloned.

Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
Origin: SiliconLabsSoftware#41
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
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>
```

It should print zpc's help.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vietnq-silabs do you validate this 1st part above ?

@rzr rzr force-pushed the doc/review/main branch from d02c263 to f8cdcd3 Compare March 7, 2025 10:14
(...)
```

Refer to [./doc](doc) for more (using MQTT, WebApp etc).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please double check dev-ui is explained there...

to make long story short you need to download it from unify repo
One you installed the deb file
you can check installed services using
sudo systemctl
and then restart it if needed
sudo systemctl restart uic-dev-ui something

(...)
```

Refer to [./doc](doc) for more (using MQTT, WebApp etc).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please double check dev-ui is explained there...

to make long story short you need to download it from unify repo
One you installed the deb file
you can check installed services using
sudo systemctl
and then restart it if needed
sudo systemctl restart uic-dev-ui something

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants