Skip to content

Commit

Permalink
Update shop links in readme and getting-started page (#516)
Browse files Browse the repository at this point in the history 
* Update shop links in readme and getting-started page

* Fix header

* Update microcontroller selection in readme and getting-started page

* Add blank line

* Remove a line about recommended

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
@klaasnicolaas @coderabbitai
klaasnicolaas and coderabbitai[bot] authored Jul 2, 2024
1 parent c2f3974 commit 22c029f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 22 deletions.
17 changes: 9 additions & 8 deletions Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,15 @@ On the [documentation website](https://glow-energy.io/docs/introduction) you wil

First, fill your 🛒 or see if you already have the components below.

- One of the micro controllers
- ESP32 (recommended) - [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop]
- ESP8266 - [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop]
- Wemos D1 mini - [Banggood][wemos-d1-bg-shop] or [AliExpress][wemos-d1-ali-shop]
- [Dupont Jumpers][dupont-jumpers-shop]
Choose one of the listed microcontrollers, but keep in mind that the ESP32 is recommended.

- ESP32 (recommended) - [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) or [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop]
- ESP8266 - [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) or [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop]
- Wemos D1 mini - [AliExpress](https://s.click.aliexpress.com/e/_DFkIzM7) or [Banggood][wemos-d1-bg-shop] or [AliExpress][wemos-d1-ali-shop]
- Dupont Jumpers (female to male) - [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) or [Banggood][dupont-jumpers-shop]
- 3D printed case (see the [case](https://glow-energy.io/docs/reference/cases) folder)
- LM393 Photodiode: [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (make sure that you do not accidentally order or receive an LDR)
- LED RGB 5mm 4 pin - kathode: [Banggood][rgbled-bg-shop] or [AliExpress][rgbled-ali-shop]
- LM393 Photodiode: [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) or [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (make sure that you do not accidentally order or receive an LDR)
- LED RGB 5mm 4 pin - kathode: [AliExpress](https://s.click.aliexpress.com/e/_Dn1D0wT) or [Banggood][rgbled-bg-shop] or [AliExpress][rgbled-ali-shop]

## Contributing

Expand All @@ -66,7 +67,7 @@ Thank you for being involved! :heart_eyes:

## Disclamer

We use AliExpress / Banggood affiliate links for the components and the tools. Some Ad-blockers might block these links an thus they seem to appear broken. You will have to temporarily disable ad-blocker to open these links.
Affiliate links are used on this repository to support the Home Assistant Glow 🌟 project. Some Ad-blockers might block these links and thus they seem to appear broken. You will have to temporarily disable ad-blocker to open these links.

## License

Expand Down
28 changes: 14 additions & 14 deletions docs/docs/getting-started.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,18 @@ This page will guide you through setting up your new Home Assistant Glow. It wil

## Step 1: Hardware

To get started you need the right hardware first, fill your 🛒 or see if you already have the components below.
To get started you need the right hardware first, fill your 🛒 or see if you already have the components in house.

| Nr. | Item | | |
|:-----|:---------|:-|:-|
|**1.**| ESP32 (recommended) | [AliExpress][esp32-ali-shop] | [Banggood][esp32-bg-shop] |
|**1.**| ESP8266 | [AliExpress][esp8266-ali-shop] | [Banggood][esp8266-bg-shop] |
|**1.**| Wemos D1 mini V4.0 | [AliExpress][wemos-d1-ali-shop] | [Banggood][wemos-d1-bg-shop] |
|**2.**| Dupont Jumpers (female to female) | [AliExpress][dupont-jumpers-ali-shop] | [Banggood][dupont-jumpers-bg-shop] |
|**3.**| LM393 Photodiode | [AliExpress][photodiode-ali-shop] | [Banggood][photodiode-bg-shop] |
|**4.**| LED RGB 5mm 4 pin - kathode | [AliExpress][rgbled-ali-shop] | [Banggood][rgbled-bg-shop] |
| Nr. | Item | Shops | | |
|:-----|:---------|:-|:-|:-|
|**1.**| ESP32 (recommended) | [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) | [AliExpress][esp32-ali-shop] | [Banggood][esp32-bg-shop] |
|**1.**| ESP8266 | [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) | [AliExpress][esp8266-ali-shop] | [Banggood][esp8266-bg-shop] |
|**1.**| Wemos D1 mini V4.0 | [AliExpress](https://s.click.aliexpress.com/e/_DFkIzM7) | [AliExpress][wemos-d1-ali-shop] | [Banggood][wemos-d1-bg-shop] |
|**2.**| Dupont Jumpers (female to female) | [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) | [AliExpress][dupont-jumpers-ali-shop] | [Banggood][dupont-jumpers-bg-shop] |
|**3.**| LM393 Photodiode | [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) | [AliExpress][photodiode-ali-shop] | [Banggood][photodiode-bg-shop] |
|**4.**| LED RGB 5mm 4 pin - kathode | [AliExpress](https://s.click.aliexpress.com/e/_Dn1D0wT) | [AliExpress][rgbled-ali-shop] | [Banggood][rgbled-bg-shop] |

Obviously you do not need all 3 different types of micro controllers, but you can choose between an **ESP32** (recommended), **ESP8266** or the **Wemos D1 mini**. About the photodiode, keep in mind that there are also boards in circulation with an LDR.

### Disclamer

We use AliExpress / Banggood affiliate links for the components and the tools. Some Ad-blockers might block these links an thus they seem to appear broken. You will have to temporarily disable ad-blocker to open these links.
Obviously you do not need all 3 different types of microcontrollers, but you can choose between an **ESP32** (recommended), **ESP8266** or the **Wemos D1 mini**. About the photodiode, keep in mind that there are also boards in circulation with an LDR.

How everything should be connected can be found on the [wiring diagram](/docs/reference/diagram). Once this is done, you can proceed to step 2.

Expand Down Expand Up @@ -122,6 +118,10 @@ The last step is to print a housing, the files for this can be found on the [cas

Congratulations 🎉 You have gone successfully through everything to get started with the Home Assistant Glow 🌟 If you have any questions, please check the [FAQ page](/docs/faq) first and if you can't find the answer there, you can always ask your question on the [Github](https://github.com/klaasnicolaas/home-assistant-glow).

## Disclamer

Affiliate links are used on this website to support the Home Assistant Glow 🌟 project. Some Ad-blockers might block these links and thus they seem to appear broken. You will have to temporarily disable ad-blocker to open these links.

{/* Hardware */}
[esp32-bg-shop]: https://www.banggood.com/bang/?tt=16956_12_417111_&r=https%3A%2F%2Fnl.banggood.com%2FGeekcreit-ESP32-WiFi%2Bbluetooth-Development-Board-Ultra-Low-Power-Consumption-Dual-Cores-Pins-Unsoldered-p-1214159.html
[esp32-ali-shop]: https://tc.tradetracker.net/?c=15640&m=12&a=417111&r=&u=https%3A%2F%2Faliexpress.com%2Fitem%2F1005005970816555.html
Expand Down

0 comments on commit 22c029f

Please sign in to comment.