Skip to content

Commit

Permalink
first attempt at using github actions to build Pages website
Browse files Browse the repository at this point in the history
  • Loading branch information
idcrook committed Feb 8, 2025
1 parent ea27bc3 commit 7fda99e
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
source: ./docs/
destination: ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
Expand Down
Binary file added docs/assets/HA_Dashboard_seedomatic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 70 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Yet Another Home Assistant Temperatue Monitor

Use Raspberry Pi Pico W and micropython to add temperature sensors to your Home Assitant setup.

![Home Asssitant Dashboard with temperature sensors](assets/HA_Dashboard_seedomatic.png)

# Installation

## Micropython and libraries

Usually you'll start with the [latest micropython for Pico W][latest_micropython].

On your workstation, you will also want [`mpremote`][mpremote]

The README goes into this. There is `mip_install.py` that relies on `secrets.py` being properly configured (see [Config](#config) below) and copied to Pico W.

## Hardware Setup

### DS18B20

DS18B20 1-Wire sensors are `3.3 V`. Fortunately, the Pico W has a regulated `3.3 V` output that can be used.

### I2C

TODO: I2C like BME280 or SSD1306 OLED.


## Test

There are assorted micropython scripts name `test_AREA.py`

```
moremote run test_ds18b20.py
```

## Config

There are example files intended to be used as configuration templates.

- `config.py`
- `device.py`
- `def-secrets.py` -> `secrets.py`

Since I may have more than one `picow` in use, I like to have local corresponding device files, e.g., `device-picow1.py`


```shell
mpremote fs cp secrets.py :
mpremote fs cp config.py :
mpremote fs cp device-picow1.py :device.py

# testing them out
mpremote run main.py
```

## Running

Micropython auto-runs a file named `main.py` in the top-level directory. Assuming it has been configured and tested, can just copy to device.

```
mpremote fs cp main.py :
# Power cycle or otherwise reset, and it should start up automatically.
mpremote repl
```


[latest_micropython]: https://micropython.org/download/RPI_PICO_W/
[mpremote]: https://docs.micropython.org/en/latest/reference/mpremote.html

0 comments on commit 7fda99e

Please sign in to comment.