Skip to content
This repository was archived by the owner on Dec 23, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Project Pacifica
Project Device Simulator Express

Copyright (c) Microsoft Corporation. All rights reserved.

Expand Down
2 changes: 1 addition & 1 deletion PRIVACY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The software may collect information about you and your use of the software and

## Disable Telemetry

The Microsoft Pacifica Extension for Visual Studio Code collects usage
The Microsoft Device Simulator Express Extension for Visual Studio Code collects usage
data and sends it to Microsoft to help improve our products and
services. Read our
[privacy statement](https://privacy.microsoft.com/privacystatement) to
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Project Pacifica
# Project Device Simulator Express

Make without limit! Pacifica, a Microsoft Garage project, allows you to code in CircuitPython for your awesome
Circuit Playground Express (CPX) projects! Test and debug your code on the device simulator and see the same
Expand Down
2 changes: 1 addition & 1 deletion docs/developers-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
- Debugging the extension opens a new VS Code window with the extension installed
- From the original VS Code window (opened in our repository) you can see outputs in the Debug Console
- In the new VS Code window, you can access the commands provided by the extension from the Commands Palette (Ctrl+Shift+P)
listed as 'Pacifica : ...'
listed as 'Device Simulator Express : ...'
- If you change some files you'll need to run the 'npm run compile' command again and restart debugging

## Repository Structure (important files)
Expand Down
10 changes: 5 additions & 5 deletions docs/how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Commands are accessible through :

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

## Available commands
Expand Down Expand Up @@ -61,9 +61,9 @@ Commands are accessible through :
- Motion sensors
- Tap detection

## Pacifica configuration
## Device Simulator Express configuration

Here are the settings you can change in the Pacifica configuration:
Here are the settings you can change in the Device Simulator Express configuration:

- **Debugger Server Port:** allows you to change the port used to communicate with the debugger. Default value is _5577_. (4)

Expand All @@ -84,11 +84,11 @@ Here are the settings you can change in the Pacifica configuration:
- To open the output panel again after closing it go to VS Code menu : `View->Output`.
- If you have pylint enabled, it might underline the import of the adafruit_circuitplayground library, but it will work correctly.
- 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`.
- If you can't get the Simulator communication working while debugging, try to open you `Settings` and check the port used under `'Pacifica: Debugger Server Port'`. You can either change it (usually ports above 5000 could work) or try to free it, then start debugging again.
- If you can't get the Simulator communication working while debugging, try to open you `Settings` and check the port used under `'Device Simulator Express: Debugger Server Port'`. You can either change it (usually ports above 5000 could work) or try to free it, then start debugging again.

### Notes

(1) Can be changed in settings.
(2) To use the Serial Monitor commands, you'll need to open a folder because this saves the configuration file for the serial communication. You can still use the rest of the extension without opening a folder.
(3) Sensors currently not supported by the official adafruit_circuit_playground.express library (v2.1.2).
(4) 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'`.
(4) 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` : `'Device Simulator Express: Debugger Server Port'`.
26 changes: 13 additions & 13 deletions docs/telemetry.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pacifica Telemetry
# Device Simulator Express Telemetry

Pacifica logs usage data and diagnostics telemetry through [Application Insights](https://azure.microsoft.com/en-us/services/monitor/).
The Device Simulator Express logs usage data and diagnostics telemetry through [Application Insights](https://azure.microsoft.com/en-us/services/monitor/).

## Telemetry Gathered

Expand All @@ -11,15 +11,15 @@ This extension collects basic diagnostics telemetry and usage data:

## Usage Telemetry

Through the Application Insights API, telemetry events are collected on Pacifica extension usage. The follow table describes the Telemetry events we collect:
Through the Application Insights API, telemetry events are collected on The Device Simulator Express extension usage. The follow table describes the Telemetry events we collect:

| **Property** | **Note** |
| :-------------------: | ---------------------------------------------------------------------------------------------------- |
| **Event Name** | Unique event name/descriptor for the event. For ex: Pacifica/COMMAND_NEW_FILE |
| **VS Code Session ID** | A unique identifier for the current session (changes each time the editor is started) |
| **VS Code Machine ID** | A unique identifier for the computer |
| **VS Code Version** | VS Code version being used by the user |
| **Extension Version** | Pacifica extension version being used |
| **OS** | User's operating system |
| **Performance** | A number indicating how long the command or API call took to execute |
| **Result** | If the event succeeded or not |
| **Property** | **Note** |
| :--------------------: | --------------------------------------------------------------------------------------------- |
| **Event Name** | Unique event name/descriptor for the event. For ex: Device Simulator Express/COMMAND_NEW_FILE |
| **VS Code Session ID** | A unique identifier for the current session (changes each time the editor is started) |
| **VS Code Machine ID** | A unique identifier for the computer |
| **VS Code Version** | VS Code version being used by the user |
| **Extension Version** | The Device Simulator Express extension version being used |
| **OS** | User's operating system |
| **Performance** | A number indicating how long the command or API call took to execute |
| **Result** | If the event succeeded or not |
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ gulp.task("vsce:publish", () => {

gulp.task("vsce:package", () => {
return vsce.createVSIX({
packagePath: "../../dist/pacifica-0.0.0-UNTRACKEDVERSION.vsix"
packagePath: "../../dist/deviceSimulatorExpress-0.0.0-UNTRACKEDVERSION.vsix"
});
});

Expand Down
9 changes: 5 additions & 4 deletions locales/en/out/constants.i18n.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"dialogResponses.installNow": "Install Now",
"dialogResponses.dontInstall": "Don't Install",
"dialogResponses.tutorials": "Tutorials on Adafruit",
"error.debuggerServerInitFailed": "Warning : The Debugger Server cannot be opened. Please try to free the port {0} if it's already in use or select another one in your Settings 'Pacifica: Debugger Server Port' and start another debug session.\n You can still debug your code but you won't be able to use the Simulator.",
"error.debuggerServerInitFailed": "Warning : The Debugger Server cannot be opened. Please try to free the port {0} if it's already in use or select another one in your Settings 'Device Simulator Express: Debugger Server Port' and start another debug session.\n You can still debug your code but you won't be able to use the Simulator.",
"error.debuggingSessionInProgress": "[ERROR] A debugging session is currently in progress, please stop it before running your code. \n",
"error.incorrectFileNameForDevice": "[ERROR] Can\\'t deploy to your Circuit Playground Express device, please rename your file to \"code.py\" or \"main.py\". \n",
"error.incorrectFileNameForDevicePopup": "Seems like you have a different file name than what the CPX requires, please rename it to \"code.py\" or \"main.py\".",
Expand All @@ -35,8 +35,9 @@
"info.privacyStatement": "Privacy Statement",
"info.successfulInstall": "Successfully installed Python dependencies.",
"info.thirdPartyWebsite": "By clicking \"Agree and Proceed\" you will be redirected to adafruit.com, a third party website not managed by Microsoft. Please note that your activity on adafruit.com is subject to Adafruit's privacy policy",
"info.welcomeOutputTab": "Welcome to the Pacifica Simulator output tab !\n\n",
"label.webviewPanel": "Pacifica Simulator",
"name": "Pacifica Simulator",
"info.welcomeOutputTab": "Welcome to the Adafruit Simulator output tab !\n\n",
"label.webviewPanel": "Device Simulator Express",
"name": "Device Simulator Express",

"warning.agreeAndRun": "By selecting ‘Agree and Run’, you understand the extension executes Python code on your local computer, which may be a potential security risk."
}
28 changes: 14 additions & 14 deletions locales/en/package.i18n.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{
"pacificaExtension.commands.changeBaudRate": "Change Baud Rate",
"pacificaExtension.commands.closeSerialMonitor": "Close Serial Monitor",
"pacificaExtension.commands.label": "Pacifica",
"pacificaExtension.commands.openSerialMonitor": "Open Serial Monitor",
"pacificaExtension.commands.openSimulator": "Open Simulator",
"pacificaExtension.commands.runSimulator": "Run Simulator",
"pacificaExtension.commands.newFile": "New File",
"pacificaExtension.commands.runDevice": "Deploy to Device",
"pacificaExtension.commands.selectSerialPort": "Select Serial Port",
"pacificaExtension.configuration.title": "Pacfica configuration",
"pacificaExtension.configuration.properties.open": "Whether to show 'Open Simulator' icon in editor title menu.",
"pacificaExtension.configuration.properties.device": "Whether to show 'Run Device' icon in editor title menu.",
"pacificaExtension.configuration.properties.simulator": "Whether to show 'Run Simulator' icon in editor title menu.",
"pacificaExtension.configuration.properties.debuggerPort": "The port the Server will listen on for communication with the debugger."
"deviceSimulatorExpressExtension.commands.changeBaudRate": "Change Baud Rate",
"deviceSimulatorExpressExtension.commands.closeSerialMonitor": "Close Serial Monitor",
"deviceSimulatorExpressExtension.commands.label": "Device Simulator Express",
"deviceSimulatorExpressExtension.commands.openSerialMonitor": "Open Serial Monitor",
"deviceSimulatorExpressExtension.commands.openSimulator": "Open Simulator",
"deviceSimulatorExpressExtension.commands.runSimulator": "Run Simulator",
"deviceSimulatorExpressExtension.commands.newFile": "New File",
"deviceSimulatorExpressExtension.commands.runDevice": "Deploy to Device",
"deviceSimulatorExpressExtension.commands.selectSerialPort": "Select Serial Port",
"deviceSimulatorExpressExtension.configuration.title": "Device Simulator Express configuration",
"deviceSimulatorExpressExtension.configuration.properties.open": "Whether to show 'Open Simulator' icon in editor title menu.",
"deviceSimulatorExpressExtension.configuration.properties.device": "Whether to show 'Run Device' icon in editor title menu.",
"deviceSimulatorExpressExtension.configuration.properties.simulator": "Whether to show 'Run Simulator' icon in editor title menu.",
"deviceSimulatorExpressExtension.configuration.properties.debuggerPort": "The port the Server will listen on for communication with the debugger."
}
Loading