Skip to content

Commit fe51e07

Browse files
committed
Started to add components
1 parent bd1d7c1 commit fe51e07

8 files changed

Lines changed: 39 additions & 4 deletions

File tree

docs/components/Arduino/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Arduino"
3+
sidebar_position: 2
4+
---
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "BH1750"
3+
sidebar_position: 1
4+
---
5+
6+
[View test code](https://github.com/WeatherStack/SensorTesting/blob/main/BH1750/) •
7+
[View ESP Component](https://components.espressif.com/components/espressif/bh1750) •
8+
[View sensor](/docs/supported-sensors/BH1750/)

docs/components/ESP-IDF/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "ESP-IDF"
3+
sidebar_position: 1
4+
---
5+
6+
## Supported ESP-IDF component libraries

docs/components/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Components"
3+
sidebar_position: 6
4+
---

docs/getting-started.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,6 @@ Before beginning to set up WeatherStack, it's recommended to read the [supported
3535
It is also recommended to read into how WeatherStack works, and how to set it up, by reading the [WeatherStack overview](/docs/overview/) page.
3636
:::
3737

38-
The first step to setting up WeatherStack is to choose what you're going to be running it with.
38+
The first step to setting up WeatherStack is to choose what you're going to be running it with.
39+
40+
You're going to be writing the software for the ESP32, but don't worry, this will guide you through and make it easier for you.

docs/supported-sensors/BH1750/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ sidebar_position: 1
77
This specifically uses the GY-302 module (**which I recommend, since it's eaiser to connect to an ESP32**), which is a breakout board for the BH1750 sensor. This sensor is used to measure ambient light levels in lux.
88

99
[View test code](https://github.com/WeatherStack/SensorTesting/blob/main/BH1750/) •
10-
[View ESP Component](https://components.espressif.com/components/espressif/bh1750)
10+
[View ESP Component](https://components.espressif.com/components/espressif/bh1750) •
11+
[View ESP-IDF Library](/docs/components/ESP-IDF/BH1750/)
1112

1213
### Sensor Overview
1314
Below are two pictures of the GY-302 BH1750 Light Intensity Module, and the Adafruit BH1750 Ambient Light Sensor. The GY-302 is a cheaper alternative to the Adafruit sensor, but both work well.

docs/supported-sensors/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ sidebar_position: 1
66
This page contains the links to all of the sensors that have been tested and implemented in WeatherStack.
77
If you'd like to **suggest a sensor**, please open a discussion on the GitHub Organisation.
88

9+
Each of these sensors will have a component library that you will need to use to be able to use the sensor.
10+
Most of the sensors that are marked as implemented will have a component library for both ESP-IDF **and** Arduino.
11+
However, some many not. It is important to check.
12+
13+
Browse components: [ESP-IDF](/docs/components/ESP-IDF/)[Arduino](/docs/components/Arduino/)
14+
915
## Sensor implementation table meaning
1016

1117
The following are the possible sensor statuses:

docusaurus.config.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,13 @@ const config: Config = {
104104
title: 'Docs',
105105
items: [
106106
{
107-
label: 'Tutorial',
108-
to: '/docs/intro',
107+
label: 'Getting Started',
108+
to: '/docs/getting-started',
109109
},
110+
{
111+
label: 'Supported Sensors',
112+
to: '/docs/supported-sensors',
113+
}
110114
],
111115
},
112116
{

0 commit comments

Comments
 (0)