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

Commit f090660

Browse files
Merge pull request #340 from microsoft/users/t-xunguy/release-notes-readme
Update the release notes and ReadMe for release
2 parents 5072861 + a7ea944 commit f090660

File tree

2 files changed

+22
-67
lines changed

2 files changed

+22
-67
lines changed

README.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<a href='https://microsoftgarage.visualstudio.com/002806e2-ebaa-4672-9d2e-5fe5d29154ef/_boards/board/t/227906bb-31ac-4b07-8626-3d757754a616/Microsoft.RequirementCategory/'><img src='https://microsoftgarage.visualstudio.com/002806e2-ebaa-4672-9d2e-5fe5d29154ef/227906bb-31ac-4b07-8626-3d757754a616/_apis/work/boardbadge/73f82653-3da1-4a6f-bb79-c91c9eecec28' alt='Azure DevOps Board Badge' /></a>
66

7-
Make without limit! Device Simulator Express, a Microsoft Garage project, allows you to code microcontrollers without the hardware on hand! You can program your Adafruit Circuit Playground Express (CPX) or your BBC micro:bit! Test and debug your code on the device simulator and see the same
7+
Make without limit! Device Simulator Express, a Microsoft Garage project, allows you to code microcontrollers without the hardware on hand! You can program your Adafruit Circuit Playground Express (CPX), your BBC micro:bit or the Adafruit CLUE! Test and debug your code on the device simulator and see the same
88
result when you plug in your actual microcontroller. Curious about the output of the device, the serial
99
monitor allows you to observe the device output.
1010

@@ -18,7 +18,7 @@ monitor allows you to observe the device output.
1818

1919
[<img alt='bbc micro:bit' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/microbit/microbit.png'>](#bbc-microbit-simulator)
2020

21-
- [**Adafruit CLUE**](#adafruit-clue-simulator) (hidden behind preview flag)
21+
- [**Adafruit CLUE**](#adafruit-clue-simulator)
2222

2323
[<img alt='Adafruit CLUE' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/clue/clue.png'>](#adafruit-clue-simulator)
2424

@@ -120,8 +120,6 @@ In Device Simulator Express, you can use keyboard to interact with the device:
120120

121121
## Adafruit CLUE Simulator
122122

123-
NOTE: This simulator is hidden under the preview mode flag. See below on how to enable the preview mode flag.
124-
125123
### Features
126124

127125
- IntelliSense and syntax highlighting for CircuitPython code for the following drivers and libraries:
@@ -164,22 +162,6 @@ NOTE: This simulator is hidden under the preview mode flag. See below on how to
164162
- Refresh the simulator: <kbd>Shift</kbd> + <kbd>R</kbd>
165163
- Run the simulator: <kbd>Shift</kbd> + <kbd>F</kbd>
166164

167-
## How to enable preview flag
168-
169-
Currently, we have our Adafruit CLUE simulator hidden behind a preview flag and we want you to try it out!
170-
171-
### I. Open settings
172-
173-
For Windows and Linux, you can use <kbd>Ctrl</kbd> + <kbd>,</kbd> or use `File -> Preferences -> Settings` in the top menu to navigate to settings. For Mac, you can use <kbd>Cmd</kbd> + <kbd>,</kbd> or use `Code -> Preferences -> Settings`.
174-
175-
<img alt='Adafruit CLUE' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/clue/open_settings.PNG'>
176-
177-
### II. Search for our preview flag and enable it!
178-
179-
In the top search bar, search for `DeviceSimulatorExpress.previewMode`. Then, check the checkbox for the setting that pops up when you serach.
180-
181-
<img alt='Adafruit CLUE' src='https://raw.githubusercontent.com/microsoft/vscode-python-devicesimulator/dev/assets/readmeFiles/clue/check_preview_mode.gif'>
182-
183165
## How to use
184166

185167
To use Device Simulator Express, install the extension from the marketplace and reload VS Code.
@@ -225,8 +207,12 @@ Before deploying the Python code to your CPX device, you need to format your dev
225207
- Download the lastest versions of the cpx libraries (link: https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries).
226208

227209
- _For the micro:bit_:
210+
228211
- Download the firmware with the .hex file (link: https://microbit.org/get-started/user-guide/firmware/).
229212

213+
- _For the CLUE_:
214+
- Download the latest versions of the cpx libraries and follow the instructions here (link:https://learn.adafruit.com/adafruit-clue/circuitpython).
215+
230216
1. Plug in your device (make sure it’s formatted properly already).
231217
2. Run the command `"Device Simulator Express: Deploy to Device"`.
232218

@@ -305,7 +291,7 @@ A `ThirdPartyNotices.txt` file is provided in the extension's source code listin
305291
- If you try to deploy to the CPX while it's plugged in but you still get an error saying it cannot find the board, make sure your device is formatted correctly and that its name matches `CIRCUITPY`.
306292
- 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.
307293
- When you are using the serial monitor, if you get some unusual error messages, unplug the device and reload the VS Code windows.
308-
- If you're using Ubuntu and having some problems with setting up the environment, try reviewing [this article's](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-ubuntu-16-04) "Step 1" section on how to set up Python 3 on Ubuntu 16.04. Then, ensure that you've run `sudo apt-get install -y python3-venv` to allow for virtual environment creation.
294+
- If you're using Ubuntu and having some problems with setting up the environment, try reviewing [this article's](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-ubuntu-16-04) "Step 1" section on how to set up Python 3 on Ubuntu 16.04. Then, ensure that you've run `sudo apt-get install -y python3-venv` to allow for virtual environment creation.
309295

310296
## License
311297

0 commit comments

Comments
 (0)