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

Commit a21d967

Browse files
Merge pull request #151 from microsoft/Fix-VSIX-Details-and-Readme.md
Change naming in Readme.md for vsix details
2 parents ce1f25b + 47537d8 commit a21d967

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Project Device Simulator Express
1+
# Device Simulator Express, a Microsoft Garage project
22

3-
Make without limit! Pacifica, a Microsoft Garage project, allows you to code in CircuitPython for your awesome
3+
Make without limit! Device Simulator Express, a Microsoft Garage project, allows you to code in CircuitPython for your awesome
44
Circuit Playground Express (CPX) projects! Test and debug your code on the device simulator and see the same
55
result when you plug in your actual microcontroller. Curious about the output of the device, the serial
66
monitor allows you to observe the device output.
@@ -30,18 +30,18 @@ monitor allows you to observe the device output.
3030
- 7 Capacitive Touch sensors
3131

3232
The simulator supports most of the sensors on CPX except **IR transmitter & Receiver**, **Sound Sensor (microphone)**, **Speaker (Play Tone)** and the **“tap” on Motion Sensor**.
33-
The code related to these sensors can still run on the actual CPX board and be deployed using Pacifica.
33+
The code related to these sensors can still run on the actual CPX board and be deployed using Device Simulator Express.
3434
As we only support CPX library now, other libraries (i.e. simpleio) can’t run on the simulator. But they will work on the actual device!
3535

3636
## Prerequisites
3737

38-
The following dependencies are required to install before launching Pacifica.
38+
The following dependencies are required to install before launching Device Simulator Express.
3939
You will be prompted to install the Python dependencies during the first use.
4040

4141
- _**[Visual Studio Code](https://code.visualstudio.com/)**_
4242
- _**[Node](https://nodejs.org/en/download/)**_
4343
- _**[Python 3.7.4](https://www.python.org/downloads/)**_: Make sure you've added python and pip to your PATH in your environment variables. (1)
44-
- _**[Python VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)**_: This will be installed automatically from the marketplace when you install Pacifica.
44+
- _**[Python VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)**_: This will be installed automatically from the marketplace when you install Device Simulator Express.
4545

4646
The following dependecies can be installed for you by the extension by clicking yes when you are prompted to (**except** `pywin32` which is needed only on Windows platform). (2)
4747

@@ -70,15 +70,15 @@ The following dependecies can be installed for you by the extension by clicking
7070

7171
## How to use
7272

73-
To use Pacifica, install the extension from the marketplace and reload VS Code.
73+
To use Device Simulator Express, install the extension from the marketplace and reload VS Code.
7474

7575
### 1. Start with the “New File” Command.
7676

77-
1. Type in “Pacifica: New File” in the command palette(`CTRL+SHIFT+P`to open the command palette).
77+
1. Type in Device Simulator Express: New File” in the command palette(`CTRL+SHIFT+P`to open the command palette).
7878
![](assets/readmeFiles/newFile.gif?raw=true)
7979
2. Name and save your file somewhere, and we’re good to go!(3)
8080
3. Start with some examples: you can find examples files and tutorials inside the comments,
81-
as well as in the notification pop up when you run the `Pacifica: New File”` Command.
81+
as well as in the notification pop up when you run the `Device Simulator Express: New File”` Command.
8282

8383
![](assets/readmeFiles/findExamples.jpg?raw=true)
8484

@@ -111,7 +111,7 @@ Before deploying the python code to your CPX device, you need to format your dev
111111
3. Select your baud rate for the serial port
112112
4. The print() statements in your code will show in the output console
113113

114-
### 6. Use the sensors in the Pacifica Simulator
114+
### 6. Use the sensors in the Device Simulator Express
115115

116116
Generating input for the sensors can be done by interacting directly with device on the webview
117117
or by using the toolbar.
@@ -129,20 +129,20 @@ or by using the toolbar.
129129

130130
## Commands
131131

132-
Pacifica provides several commands in the Command Palette (F1 or Ctrl + Shift + P/ Cmd + Shift + P for Mac OS) for working with \*.py files:
132+
Device Simulator Express provides several commands in the Command Palette (F1 or Ctrl + Shift + P/ Cmd + Shift + P for Mac OS) for working with \*.py files:
133133

134-
- `Pacifica: New File`: Opens an unsaved .py file with template code, also open the simulator.
135-
- `Pacifica: Open Simulator`: Opens the simulator in the webView
136-
- `Pacifica: Run on Simulator`: Runs python code on the simulator
137-
- `Pacifica: Deploy to Board`: Copies & Pastes the code.py or main.py file to CIRCUITPY drive if detected a CPX is plugged in
138-
- `Pacifica: Open Serial Monitor`: Opens the serial monitor in the integrated output window.
139-
- `Pacifica: Close Serial Monitor`: Stops the serial monitor and releases the serial port.
140-
- `Pacifica: Change Baud Rate`: Changes the baud rate of the selected serial port. For Adafruit CPX, the default baud rate is 115200.
141-
- `Pacifica: Select Serial Port`: Changes the current serial port.
134+
- `Device Simulator Express: New File`: Opens an unsaved .py file with template code, also open the simulator.
135+
- `Device Simulator Express: Open Simulator`: Opens the simulator in the webView
136+
- `Device Simulator Express: Run on Simulator`: Runs python code on the simulator
137+
- `Device Simulator Express: Deploy to Board`: Copies & Pastes the code.py or main.py file to CIRCUITPY drive if detected a CPX is plugged in
138+
- `Device Simulator Express: Open Serial Monitor`: Opens the serial monitor in the integrated output window.
139+
- `Device Simulator Express: Close Serial Monitor`: Stops the serial monitor and releases the serial port.
140+
- `Device Simulator Express: Change Baud Rate`: Changes the baud rate of the selected serial port. For Adafruit CPX, the default baud rate is 115200.
141+
- `Device Simulator Express: Select Serial Port`: Changes the current serial port.
142142

143143
## Keybindings
144144

145-
In Pacifica, you can use keyboard to interact with the device:
145+
In Device Simulator Express, you can use keyboard to interact with the device:
146146

147147
- Push Button `A & B: A B`
148148
- Capacitive Touch Sensor `A1 – A7: SHIFT + 1~7`
@@ -169,12 +169,12 @@ Our extension is collecting anonymous data about your usage of our features to h
169169
- To open the output panel again after closing it go to VS Code menu: `View->Output`.
170170
- If you have pylint enabled, it might underline the import of the adafruit_circuitplayground library, but it will work correctly.
171171
- If you try to deploy to the device while it's plugged in but you still get an error saying it cannot find the board, make sure your Circuit Playground Express is formatted correctly and that its name matches `CIRCUITPY`.
172-
- If you can't get the Simulator communication working while debugging, try to open your `Settings` and check the port used under `'Pacifica: Debugger Server Port'`. You can either change it (usually ports above 5000 should work) or try to free it, then start debugging again.
172+
- If you can't get the Simulator communication working while debugging, try to open your `Settings` and check the port used under `'Device Simulator Express: Debugger Server Port'`. You can either change it (usually ports above 5000 should work) or try to free it, then start debugging again.
173173
- When you are using the serial monitor, if you get some unusual error messages, unplug the device and reload the VS Code windows.
174174

175175
## License
176176

177-
Project Pacifica
177+
Device Simulator Express, a Microsoft Garage project
178178

179179
Copyright (c) Microsoft Corporation. All rights reserved.
180180

0 commit comments

Comments
 (0)