You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 23, 2021. It is now read-only.
[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
Copy file name to clipboardExpand all lines: docs/developers-setup.md
+6Lines changed: 6 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,10 @@
30
30
31
31
- Run the command in a console : `pip install python-socketio`
32
32
33
+
- Application Insights
34
+
35
+
- Run the command in a console : `pip install applicationinsights`
36
+
33
37
- Requests
34
38
35
39
- Run the command in a console : `pip install requests`
@@ -74,3 +78,5 @@
74
78
-`view` : React side
75
79
-`components/`
76
80
-`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.
Copy file name to clipboardExpand all lines: docs/how-to-use.md
+31-6Lines changed: 31 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
Commands are accessible through :
4
4
5
5
-**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\*
7
7
8
8
## Available commands
9
9
@@ -18,13 +18,24 @@ Commands are accessible through :
18
18
-**Deploy to Device** : saves the code to a Circuit Playground Express.
19
19
_(**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))_.
20
20
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
+
21
31
## Available features
22
32
23
33
- We currently support the [Adafruit Circuit Playground Express board](https://www.adafruit.com/product/3333)
24
34
- Access to auto-completion and Python error flagging
25
35
- Output panel for the simulator
26
36
- Deploy to the physical device (if correctly formatted)
27
37
- Debugger for the simulator
38
+
- Serial Monitor
28
39
- Device's features :
29
40
- NeoPixels
30
41
- Buttons (A & B)
@@ -42,15 +53,28 @@ Commands are accessible through :
42
53
## Not supported yet
43
54
44
55
- Auto-detect/format the device
45
-
- Serial monitor for the device
46
56
- Device's features
47
57
- Sound sensor
48
58
- Tones
49
-
- Sound detection\*
50
-
- IR transmitter\*
59
+
- Sound detection\*\*
60
+
- IR transmitter\*\*
51
61
- Motion sensors
52
62
- Tap detection
53
63
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
+
54
78
## Troubleshooting Tips
55
79
56
80
- 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 :
62
86
63
87
### Note
64
88
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'`.
0 commit comments