diff --git a/README.md b/README.md index 4e63beba2..0b9cd5057 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ monitor allows you to observe the device output. [bbc micro:bit](#bbc-microbit-simulator) - +- [**Adafruit CLUE**](#adafruit-clue-simulator) (hidden behind preview flag) + + [Adafruit CLUE](#adafruit-clue-simulator) ## Build Status | Branch | Build Status | @@ -78,15 +80,14 @@ As we only support CPX library now, other libraries (i.e. simpleio) can’t run - [Download Firmware .uf2 file](https://learn.adafruit.com/adafruit-circuit-playground-express/circuitpython-quickstart) - [Download the latest version of the Adafruit CPX library](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries) -### Keybindings - +### Keyboard Shortcuts In Device Simulator Express, you can use keyboard to interact with the device: -- Push Button `A for A, B for B, C for A & B` -- Capacitive Touch Sensor `A1 – A7: SHIFT + 1 ~ 7` -- Slider Switch: `SHIFT + S` -- Refresh the simulator: `SHIFT + R` -- Run the simulator: `SHIFT + F` +- Push Button: A for Button A, B for Button B, C for Buttons A & B +- Capacitive Touch Sensor: Shift + 1 ~ 7 for GPIO pins A1 - A7 +- Slider Switch: Shift + S +- Refresh the simulator: Shift + R +- Run the simulator: Shift + F ## BBC micro:bit Simulator @@ -98,6 +99,7 @@ In Device Simulator Express, you can use keyboard to interact with the device: - Serial monitor (available on Windows and Mac only) - Simulation of the micro:bit device, including: - 25 LEDs + - Push Buttons A and B - Light sensor - Motion sensors - Acceleration detection including gesture detection @@ -108,26 +110,82 @@ In Device Simulator Express, you can use keyboard to interact with the device: - [MicroPython documentation](https://microbit-micropython.readthedocs.io/en/latest/) - [BBC micro:bit examples on the official micro:bit website](https://microbit.org/projects/make-it-code-it/?filters=python) -### Keybindings -- Push Button `A for A, B for B, C for A & B` -- Refresh the simulator: `SHIFT + R` -- Run the simulator: `SHIFT + F` +### Keyboard Shortcuts +- Push Button: A for Button A, B for Button B, C for Buttons A & B +- Refresh the simulator: Shift + R +- Run the simulator: Shift + F + +## Adafruit CLUE Simulator +NOTE: This simulator is hidden under the preview mode flag. See below on how to enable the preview mode flag. + + +### Features +- IntelliSense and syntax highlighting for CircuitPython code for the following drivers and libraries: + - `adafruit_clue` + - `adafruit_slideshow` + - `adafruit_display_shapes` + - `adafruit_display_text` + - `adafruit_bitmap_font` + - `adafruit_fancyled` + - `neopixel` + - `displayio` +- Template file generation +- Integrated Python Debugging for the Simulator +- Deploy CircuitPython code to the physical device +- Serial monitor (available on Windows and Mac only) +- Simulation of the CLUE device, including: + - 240x240 color screen + - Push Buttons A and B + - Sensors for: + - Temperature + - Light + - Color + - Acceleration + - Humidity + - Pressure + - Proximity + - Gestures + - Gyro + - Magnetic Field + +### Useful Links +- Tutorials and Example Code for Adafruit CLUE: + - [Adafruit CLUE Overview](https://learn.adafruit.com/adafruit-clue) + - [Adafruit CLUE Examples on GitHub](https://github.com/adafruit/Adafruit_CircuitPython_CLUE/tree/master/examples) + +### Keyboard Shortcuts +- Push Button: A for Button A, B for Button B, C for Buttons A & B +- Refresh the simulator: Shift + R +- Run the simulator: Shift + F + +## How to enable preview flag +Currently, we have our Adafruit CLUE simulator hidden behind a preview flag and we want you to try it out! +### I. Open settings +For Windows and Linux, you can use Ctrl + , or use `File -> Preferences -> Settings` in the top menu to navigate to settings. For Mac, you can use Cmd + , or use `Code -> Preferences -> Settings`. + + Adafruit CLUE + +### II. Search for our preview flag and enable it! +In the top search bar, search for `DeviceSimulatorExpress.previewMode`. Then, check the checkbox for the setting that pops up when you serach. + + + Adafruit CLUE ## How to use To use Device Simulator Express, install the extension from the marketplace and reload VS Code. -To access many of the commands, you need to open the command palette. This can be done with `CTRL + SHIFT + P` for Windows and Linux / `CMD + SHIFT + P` for Mac. It can also be accessed from the toolbar by going to `View -> Command Palette`. +To access many of the commands, you need to open the command palette. This can be done with Ctrl + Shift + P for Windows and Linux / Cmd + Shift + P for Mac. It can also be accessed from the toolbar by going to `View -> Command Palette`. ### I. Take a look at the "Device Simulator Express: Getting Started" Command. -1. Type in `"Device Simulator Express: Getting Started"` in the command palette (`CTRL + SHIFT + P` / `CMD + SHIFT + P` to open the command palette). +1. Type in `"Device Simulator Express: Getting Started"` in the command palette (Ctrl + Shift + P / Cmd + Shift + P to open the command palette). 2. Choose the the device you want to play with from the dropdown. 3. Read, copy and learn some of the things you can do with the simulator! Getting Started ### II. Start with the "Device Simulator Express: New File" Command. -1. Type in `"Device Simulator Express: New File"` in the command palette (`CTRL + SHIFT + P` / `CMD + SHIFT + P` to open the command palette). +1. Type in `"Device Simulator Express: New File"` in the command palette (Ctrl + Shift + P / Cmd + Shift + P to open the command palette). 2. Select the device you want to use. 3. Name and save your file somewhere, and we’re good to go! 4. Start with some examples: you can find examples files and tutorials inside the comments at the top of the file. @@ -176,7 +234,7 @@ Before deploying the Python code to your CPX device, you need to format your dev ### Commands -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: +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: - `Device Simulator Express: Getting Started`: Opens a page in VS Code that helps users get started with the extension. Here, users can browse through code that they can use to play with the simulators. - `Device Simulator Express: Run Simulator`: Runs Python code on the simulator. @@ -229,9 +287,9 @@ A `ThirdPartyNotices.txt` file is provided in the extension's source code listin - The first time you install the extension, you'll need to execute the `run` command at least once in order to access auto-completion. - While running a code file, if you get an error saying it can't find the file, make sure you've clicked on a valid Python code file before running it. -- To open the output panel again after closing it go to VS Code menu: `View->Output`. +- To open the output panel again after closing it go to VS Code menu: `View -> Output`. - 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`. -- 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. +- 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. - When you are using the serial monitor, if you get some unusual error messages, unplug the device and reload the VS Code windows. ## License diff --git a/assets/readmeFiles/clue/check_preview_mode.gif b/assets/readmeFiles/clue/check_preview_mode.gif new file mode 100644 index 000000000..157ccc35a Binary files /dev/null and b/assets/readmeFiles/clue/check_preview_mode.gif differ diff --git a/assets/readmeFiles/clue/clue.png b/assets/readmeFiles/clue/clue.png new file mode 100644 index 000000000..11f3e276d Binary files /dev/null and b/assets/readmeFiles/clue/clue.png differ diff --git a/assets/readmeFiles/clue/open_settings.PNG b/assets/readmeFiles/clue/open_settings.PNG new file mode 100644 index 000000000..7a0387df5 Binary files /dev/null and b/assets/readmeFiles/clue/open_settings.PNG differ