readme update

This commit is contained in:
Oliver Cullis 2024-09-04 16:09:39 +02:00
parent 3642acf17f
commit 9312f51bd2

View File

@ -1,3 +1,11 @@
# Code for TMP117 + Pico W Temperature Measurement System
A "global_config.json" file is required for the code to run. Here, all the settings are defined. An example is given in "example_global_config.json".
This code is indended to run on a Pico W running Micropython.
## To run on a Pico W:
- Download this repository and copy these files onto the Micropython filesystem via USB (this can be accomplished using Thonny, the VSCode extension "MicroPico" etc).
- Write a "global_config.json" file (see the example for a template), which defines various settings, I2C buses, and connected sensors.
- Once the microcontroller is reset, the main.py file will execute and the code will run.
To work on this code, you will need a Micropython editor. I recommend VSCode + MicroPico extension written by paulober (GitHub).