Skip to content
This repository was archived by the owner on Dec 23, 2021. It is now read-only.

Commit cc1b0db

Browse files
authored
Updating the documentation (#133)
[PBI 32829] * changing doc * added app insight to doc * adding configuration section * fixed sound svg issue * adding config doc * removing unused line * updating important files * corrections * Update docs/developers-setup.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/developers-setup.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/developers-setup.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * updated according to review * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * Update docs/how-to-use.md Co-Authored-By: Jonathan Wang <[email protected]> * correcting typo * put css back
1 parent 79f0473 commit cc1b0db

File tree

4 files changed

+41
-8
lines changed

4 files changed

+41
-8
lines changed

docs/developers-setup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030

3131
- Run the command in a console : `pip install python-socketio`
3232

33+
- Application Insights
34+
35+
- Run the command in a console : `pip install applicationinsights`
36+
3337
- Requests
3438

3539
- Run the command in a console : `pip install requests`
@@ -74,3 +78,5 @@
7478
- `view` : React side
7579
- `components/`
7680
- `cpx/` and `Simulator.tsx` : contain the React components and objects to display and handle the simulator webview
81+
- `toolbar/` : contains the React components used in the toolbar and the modal.
82+
- `translation/en.json`: contains the constants that should be localized. To internationalize the extension you can add additional files with constants sharing the same id found in _en.json_, but with the translated value.

docs/how-to-use.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Commands are accessible through :
44

55
- **The command palette** (`Ctrl+shift+P` or `View->Command Palette`) and type 'Pacifica : `command_name`'
6-
- **The extension buttons** available on the top right of the Text Editor Panel when you have a Python file open
6+
- **The extension buttons** available on the top right of the Text Editor Panel when you have a Python file open\*
77

88
## Available commands
99

@@ -18,13 +18,24 @@ Commands are accessible through :
1818
- **Deploy to Device** : saves the code to a Circuit Playground Express.
1919
_(**Note :** the board needs to be correctly formatted to a `CIRCUITPY` drive first if it's not the case : [Installing CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython))_.
2020

21+
- **Select Serial Port** : selects the serial port of the board you want the serial monitor to interact with.
22+
_(**Note :** USB detection must be enabled in the extension settings.)_
23+
24+
- **Open Serial Monitor** : opens the serial monitor.
25+
_(**Note :** A serial port must have been selected already)_.
26+
27+
- **Change Baud Rate** : changes the baud rate of the serial monitor.
28+
29+
- **Close Serial Montitor** : closes the serial monitor.
30+
2131
## Available features
2232

2333
- We currently support the [Adafruit Circuit Playground Express board](https://www.adafruit.com/product/3333)
2434
- Access to auto-completion and Python error flagging
2535
- Output panel for the simulator
2636
- Deploy to the physical device (if correctly formatted)
2737
- Debugger for the simulator
38+
- Serial Monitor
2839
- Device's features :
2940
- NeoPixels
3041
- Buttons (A & B)
@@ -42,15 +53,28 @@ Commands are accessible through :
4253
## Not supported yet
4354

4455
- Auto-detect/format the device
45-
- Serial monitor for the device
4656
- Device's features
4757
- Sound sensor
4858
- Tones
49-
- Sound detection\*
50-
- IR transmitter\*
59+
- Sound detection\*\*
60+
- IR transmitter\*\*
5161
- Motion sensors
5262
- Tap detection
5363

64+
## Pacifica configuration
65+
66+
Here are the settings you can change in the Pacifica configuration:
67+
68+
- **Debugger Server Port:** allows you to change the port used to communicate with the debugger. Default value is _5577_.
69+
70+
- **Enable USBDetection:** when disabled, prevents the serial monitor from listening to messages from the serial port.
71+
72+
- **Show Device Icon In Editor Title Menu:** allows you to chose whether the _`Deploy to Device`_ button should be in the editor title.
73+
74+
- **Show Open Icon In Editor Title Menu:** allows you to chose whether the _`Open Simulator`_ button should be in the editor title.
75+
76+
- **Show Simulator Icon In Editor Title Menu:** allows you to chose whether the _`Run Simulator`_ button should be in the editor title.
77+
5478
## Troubleshooting Tips
5579

5680
- The first time you install the extension, you'll need to execute the `run` command at least once in order to access auto-completion.
@@ -62,5 +86,6 @@ Commands are accessible through :
6286

6387
### Note
6488

65-
\* Sensors currently not supported by the official adafruit_circuit_playground Express library (v2.1.2).
66-
\*\* The regular communication is using the stdout and stdin of the Pyhton process. But when you debug your code, it will use a communication over sockets on the port 5577. This is the default port that you can change in your `Settings` : `'Pacifica: Debugger Server Port'`.
89+
\* Can be changed in settings.
90+
\*\* Sensors currently not supported by the official adafruit_circuit_playground.express library (v2.1.2).
91+
\*\*\* The regular communication is using the stdout and stdin of the Python process. But when you debug your code, it will communicate over sockets on port 5577. This is the default port that you can change in your `Settings` : `'Pacifica: Debugger Server Port'`.

src/view/styles/Button.css

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
.button-icon {
88
fill: var(--vscode-badgeForegroundOverride);
99
}
10+
.button-rectangle {
11+
stroke: var(--vscode-badgeForegroundOverride);
12+
}
1013

1114
.play-button {
1215
border-radius: 8px 0px 0px 8px;
@@ -31,7 +34,6 @@
3134
border: none;
3235
}
3336

34-
.toolbar-button:focus,
3537
.toolbar-button:hover {
3638
outline: none;
3739
}

src/view/svgs/toolbar_svg.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,13 +355,13 @@ export const SOUND_SVG = (
355355
/>
356356
<rect
357357
id="Rectangle-2"
358-
stroke="#FFFFFF"
359358
stroke-width="1.2"
360359
x="3.40000068"
361360
y="1.1"
362361
width="3.8"
363362
height="9.3"
364363
rx="1.9"
364+
className="button-rectangle"
365365
/>
366366
</g>
367367
</g>

0 commit comments

Comments
 (0)