Skip to content

Commit 4a6a950

Browse files
committed
Update docs
Change Python environment instructions from optional to recommended. Add warning box about potentially different cable colors for the LED button. Update instructions for blocking Witty Pi behaviour.
1 parent bcd69d5 commit 4a6a950

File tree

3 files changed

+44
-37
lines changed

3 files changed

+44
-37
lines changed

docs/deployment/classification.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -24,54 +24,54 @@ for faster CPU inference. The classification results are added to the merged met
2424
If you followed the steps in [Local Setup](../software/localsetup.md#python){target=_blank},
2525
you already have [Python](https://www.python.org/){target=_blank} installed on your computer.
2626

27-
??? info "Optional: Set up an isolated Python environment"
27+
???+ info "Recommended: Set up an isolated Python environment"
2828

29-
You can [create a virtual environment](https://virtualenv.pypa.io/en/latest/user_guide.html){target=_blank}
30-
before installing the required packages for YOLOv5 to avoid version and dependency
31-
conflicts of the packages, especially if you are working on different Python projects.
29+
You can [create a virtual environment](https://virtualenv.pypa.io/en/latest/user_guide.html){target=_blank}
30+
before installing the required packages for YOLOv5 to avoid version and dependency
31+
conflicts of the packages, especially if you are working on different Python projects.
3232

33-
- Install [`virtualenv`](https://virtualenv.pypa.io/en/latest/){target=_blank}:
33+
- Install [`virtualenv`](https://virtualenv.pypa.io/en/latest/){target=_blank}:
3434

35-
``` powershell
36-
py -m pip install virtualenv
37-
```
35+
``` powershell
36+
py -m pip install virtualenv
37+
```
3838

39-
- Navigate to the `YOLOv5-cls` folder:
39+
- Navigate to the `YOLOv5-cls` folder:
4040

41-
``` powershell
42-
cd YOLOv5-cls
43-
```
41+
``` powershell
42+
cd YOLOv5-cls
43+
```
4444

45-
- Create a new Python environment (folder in your current directory):
45+
- Create a new Python environment (folder in your current directory):
4646

47-
``` powershell
48-
py -m virtualenv env_yolov5
49-
```
47+
``` powershell
48+
py -m virtualenv env_yolov5
49+
```
5050

51-
- Activate the environment by running:
51+
- Activate the environment by running:
5252

53-
``` powershell
54-
.\env_yolov5\Scripts\activate
55-
```
53+
``` powershell
54+
.\env_yolov5\Scripts\activate
55+
```
5656

57-
If you cannot run the activate script because of your Execution Policy
58-
settings, open a new PowerShell as administrator and run the following:
57+
If you cannot run the activate script because of your Execution Policy
58+
settings, open a new PowerShell as administrator and run the following:
5959

60-
``` powershell
61-
Set-ExecutionPolicy RemoteSigned
62-
```
60+
``` powershell
61+
Set-ExecutionPolicy RemoteSigned
62+
```
6363

64-
You can find more info [here](https://virtualenv.pypa.io/en/latest/user_guide.html#activators){target=_blank}
65-
and [here](https://stackoverflow.com/questions/18713086/virtualenv-wont-activate-on-windows){target=_blank}.
64+
You can find more info [here](https://virtualenv.pypa.io/en/latest/user_guide.html#activators){target=_blank}
65+
and [here](https://stackoverflow.com/questions/18713086/virtualenv-wont-activate-on-windows){target=_blank}.
6666

67-
- Now all packages will be installed only in the virtual environment,
68-
which you have to activate everytime you want to run a script that
69-
depends on these packages.
70-
- You can deactivate the virtual environment by running:
67+
- Now all packages will be installed only in the virtual environment,
68+
which you have to activate everytime you want to run a script that
69+
depends on these packages.
70+
- You can deactivate the virtual environment by running:
7171

72-
``` powershell
73-
deactivate
74-
```
72+
``` powershell
73+
deactivate
74+
```
7575

7676
- Create the new folder `C:\Users\<username>\YOLOv5-cls`.
7777
- [Download](https://github.com/maxsitt/yolov5/archive/refs/heads/master.zip){target=_blank}

docs/hardware/2024_buildinstructions_hardware.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,13 @@ Put the sealing ring onto the thread of the button.
230230

231231
![Button Sealing Ring](assets/images/2024_button_sealing_ring.jpg){ width="600" }
232232

233+
!!! warning "Different Button Types"
234+
235+
Please check the cable colors and their respective assignment for your
236+
specific product on either the button itself or the button socket. Even if
237+
the button looks identical, the cable assignments/colors can be different
238+
depending on the producer or batch.
239+
233240
Take a look at the socket and note the colors of the cables that are labeled
234241
with **C** and **NO**. In our case this is green for **C** and yellow for **NO**.
235242
We won't use the white cable labeled with **NC**.

docs/software/pisetup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ More info:
103103
still stays on after 25 seconds, the button will not be responsive as the
104104
Witty Pi assumes that the RPi is still turned on. This can happen if the
105105
Witty Pi software is not yet installed or if there is a problem with the
106-
GPIO connection (check for faulty solder joints). In this case, you will
107-
need to unplug both batteries (USB-C and 3.7V) and connect them again to
108-
reset the Witty Pi board.
106+
GPIO connection (check for faulty solder joints). To make the Witty Pi
107+
responsive again, press and hold the button for 10 seconds until the red
108+
LED turns off.
109109

110110
---
111111

0 commit comments

Comments
 (0)