diff options
| author | James Haggerty <james@gruemail.com> | 2022-10-11 21:19:55 +1100 |
|---|---|---|
| committer | James Haggerty <james@gruemail.com> | 2022-10-11 21:19:55 +1100 |
| commit | 96e575a5d5c4b165f184a9d651cff7030c7fec57 (patch) | |
| tree | 146d1e2d164e394e3e8de2cd23ea6563afe2ee2b /README.md | |
| parent | 95f2f25ee68d2c7bd1f55f74d425153a9aa4d36d (diff) | |
| download | Sensor-Watch-96e575a5d5c4b165f184a9d651cff7030c7fec57.tar.gz Sensor-Watch-96e575a5d5c4b165f184a9d651cff7030c7fec57.tar.bz2 Sensor-Watch-96e575a5d5c4b165f184a9d651cff7030c7fec57.zip | |
Mention movement in the README (and link to website)
I know this is mostly going to be in the website, but I was initially
confused about how to get things going, and it seemed worth
having some simple 'getting started' here.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -1,7 +1,7 @@ The Sensor Watch ================ -The Sensor Watch is a board replacement for the classic Casio F-91W wristwatch. It is powered by a Microchip SAM L22 microcontroller with built-in segment LCD controller. You can write your own programs for the watch using the provided watch library, program the watch over USB using the built-in UF2 bootloader, and then install the board in your existing watch case to run your own software on your wrist. +The [Sensor Watch](https://www.sensorwatch.net) is a board replacement for the classic Casio F-91W wristwatch. It is powered by a Microchip SAM L22 microcontroller with built-in segment LCD controller. You can write your own programs for the watch using the provided watch library, program the watch over USB using the built-in UF2 bootloader, and then install the board in your existing watch case to run your own software on your wrist.  @@ -47,8 +47,29 @@ Getting code on the watch ------------------------- The watch library in this repository is very work-in-progress, but it should allow you to get started. To create a new project, copy the “starter-project” folder in the apps folder, and write your code in the app.c file. -You will need to install [the GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads/) to build projects for the watch. The watch library has been tested with the `9-2019-q4-major` version and the `10.3-2021.07` versions. +You will need to install [the GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads/) to build projects for the watch. The watch library has been tested with the `9-2019-q4-major` version and the `10.3-2021.07` versions. If you're using Debian or Ubuntu, it should be sufficient to `apt install gcc-arm-none-eabi`. To build your project, open your terminal and navigate to the project's `make` folder, then type `make`. To install the project onto your Sensor Watch board, plug the watch into your USB port and double tap the tiny Reset button on the back of the board. You should see the LED light up red and begin pulsing. (If it does not, make sure you didn’t plug the board in upside down). Once you see the “WATCHBOOT” drive appear on your desktop, type `make install`. This will convert your compiled program to a UF2 file, and copy it over to the watch. + +Using the Movement framework +---------------------------- +If you just want to make minor modifications and use existing code, start with the `movement` directory. You can build the default watch firmware with: + +``` +cd movement/make +make +``` + +Then copy `movement/make/build/watch.uf2` to your watch. If you'd like to modify which faces are built, see `movement_config.h`. + +You may want to test out changes in the emulator first. To do this, you'll need to install [emscripten](https://emscripten.org/), then run: + +``` +cd movement/make +emmake make +python3 -m http.server 8000 -d build +``` + +Finally, visit [watch.html](http://localhost:8000/watch.html) to see your work. |