Skip to content

Commit

Permalink
Remove Adafruit Magic Mirror example for now
Browse files Browse the repository at this point in the history
  • Loading branch information
helgibbons committed Oct 6, 2023
1 parent 3ba56af commit bf58a10
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 379 deletions.
30 changes: 5 additions & 25 deletions examples/magic_mirror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,27 @@
- [Magic Mirror](#magic-mirror)
- [Magic Mirror Without Wifi](#magic-mirror-without-wifi)
- [Magic Mirror (Home Assistant)](#magic-mirror-home-assistant)
- [Magic Mirror (Adafruit.io)](#magic-mirror-adafruitio)

# Micro Magic Mirror

## About

Micro Magic Mirror is a home dashboard for showing you useful information. An associated learn guide to show you how we built our Magic Mirror is coming soon!
Micro Magic Mirror is a home dashboard for showing you useful information. We're working on an associated learn guide to show you how we built our Magic Mirror.

To get online data, create a file called secrets.py containing your WiFi SSID and password, like this:

```
WIFI_SSID = "ssid_goes_here"
WIFI_PASSWORD = "password_goes_here"
```

Press the Y button to update the online data.

## Icons

Weather/wifi icons are from [Icons8](https://icons8.com), check them out!
Weather/wifi icons are from [Icons8](https://icons8.com).

## Variants

There are four variants of this example in this directory, showing various different functions. For an example that will do something out of the box without any configuring, go for `magic_mirror.py`.
There are three variants of this example in this directory, showing various different functions. For an example that will do something out of the box without any configuring, go for `magic_mirror.py`.

### Magic Mirror

Expand All @@ -48,25 +45,8 @@ This stripped down version shows how we're drawing the basic framework of our Ma

Do you automate your home with [Home Assistant](https://www.home-assistant.io/)? (if not you should try it, it's great fun). This version of Magic Mirror displays sunrise/sunset data it gets from a local Home Assistant server.

To connect to your Home Assistant, you'll need to create a token from http://homeassistant.local:8123/profile > Long Lived Access Tokens and add it to your `secrets.py` like this:
To connect to your Home Assistant, you'll need to create a token at http://homeassistant.local:8123/profile > Long Lived Access Tokens and add it to your `secrets.py` like this:
```
HOME_ASSISTANT_TOKEN = "token_goes_here"
```

Solar data is provided by the Home Assistant Sun integration. This should be installed by default.

### Magic Mirror (Adafruit.io)

[magic_mirror_adafruit_io.py](magic_mirror_adafruit_io.py)

In this version of the example, we're displaying some data stored in Adafruit.io that we've collected using [Enviro Indoor](https://shop.pimoroni.com/products/enviro-indoor) boards deployed about Pirate HQ.

⚠ As this example is connected to our feeds, it won't show any data from Adafruit if you run it as is.

To show your own data, you'll need to add your Adafruit.io username and key to `secrets.py` like this:
```
ADAFRUIT_IO_USERNAME = "username_goes_here"
ADAFRUIT_IO_KEY = "key_goes_here"
```
(and then modify the code to point at your own feeds and data)

Solar data is provided by the Home Assistant Sun integration, which should be installed by default. The example assumes your Pico W is connected to the same network as your Home Assistant server, and that your Home Assistant server is located at http://homeassistant.local:8123
Loading

0 comments on commit bf58a10

Please sign in to comment.