Skip to content

Commit 66a81d5

Browse files
authored
Merge pull request #164 from MallocArray/documentation_updates
Update Documentation
2 parents 881a840 + 5d21427 commit 66a81d5

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ ESPHome yaml files for AirGradient devices to maintain the research and accuracy
1010

1111
## [Calibration](/calibration.md)
1212

13+
## [Packages](/packages.md)
14+
15+
List of available packages to customize your device and gain additional features
16+
1317
## Breaking Changes
1418

1519
* 5.0.0 is a major version upgrade as switching to esp-idf is not fully supported via OTA. Highly recommend doing one USB flash of 5.0.0 and later to the AirGradient ONE and OpenAir devices to reformat the storage to support esp-idf. Future updates can be done Over-The-Air without issue.
@@ -67,5 +71,4 @@ Many added features can be found in HomeAssistant by going to Settings>Devices a
6771

6872
More features are planned to be added to this repo
6973

70-
- [X] PMS5003 model specific correction algorithms
7174
- [ ] Deprecate Extended Life packages and use a substitution to allow for adjusting update_interval

configuration.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

3-
If all original sensors (PMS5003, Senseair S8, SHT4x) are connected, configuration files should be ready for use.
3+
If all original sensors (PMS5003, Senseair S8, SHT4x) are connected, configuration files should be ready for use. To prevent the LED bar from flashing on boot, it is disabled by default. Once added to Home Assistant, toggle the "LED Strip" switch to enable the bar.
44

55
If some sensors are not installed, comment or remove the associated sections under `packages:`
66

@@ -16,6 +16,13 @@ wifi:
1616
password: 123456123456
1717
```
1818
19+
To use IPv6, add the following to the main YAML file for your device
20+
21+
```yaml
22+
network:
23+
enable_ipv6: true
24+
```
25+
1926
# Modification
2027
2128
### Using local packages
@@ -59,10 +66,12 @@ After extensive discussion on the [AirGradient forum](https://forum.airgradient.
5966
6067
# Home Assistant Automation
6168
62-
Pairing ESPHome with Home Assistant opens a multitude of opportunities to create custom actions tailored to your liking
69+
Pairing ESPHome with Home Assistant opens a multitude of opportunities to create custom actions tailored to your liking.
6370
6471
## Disable Display and LED based on time
6572
73+
Enabling the "Blank Page" switch will disable output on the display. It is not necessary to turn off any existing pages, and disabling all pages will result in the device rebooting
74+
6675
1. In Home Assistant, navigate to Settings>Automations and scenes
6776
2. Click "Create Automation" button, then "Create new automation"
6877
1. When

0 commit comments

Comments
 (0)