jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update purpleair.markdown to include instructions to get an API key (#27852)

Browse Source 
* Update purpleair.markdown to include instructions to get an API key

Add instructions on how to create a Purple Air API Key needed to enable the integration.  Addresses ttps://github.com/home-assistant/core/issues/93663

* Apply suggestions from code review

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Erik Nygren 2023-07-05 01:49:44 -04:00 committed by GitHub
parent 107efe7016
commit 1373254c55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/_integrations/purpleair.markdown
View File

@ -29,6 +29,21 @@ Remove Sensor:
description: Untrack a sensor.
{% endconfiguration_basic %}
## Creating an API key
To add this integration, you need a (free) Purple Air API Key. A new account currently comes with 1 million free points. After that, you need to buy additional points to continue to use the API. The current plugin uses ~30K points/day. The 1 million points last about a month. A lack of points will trigger API errors until you buy more points.
Detailed instructions are at [https://community.purpleair.com/t/creating-api-keys/3951]([https://community.purpleair.com/t/creating-api-keys/3951]) but in summary you:
* Create an account at https://develop.purpleair.com/ (which uses Single Sign-On through a Google account).
* On the ['keys'](https://develop.purpleair.com/keys) page press the "plus" button to create an API key. Leave the defaults of **Read** and **Enabled**.
* Go to the ['projects'](https://develop.purpleair.com/projects) page and select the edit (pencil) button on the listed Project. Add points (for example 1,000,000), then select **Update**.
* Go back to the ['keys'](https://develop.purpleair.com/keys) page and copy the API key. It will be a value like XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX.
* Paste that API key into the **API Key** field when creating the integration in Home Assistant.
Note that if you are using your own sensor, it will need to be set to **Public** to be visible.
## Creating an AQI Rating from Raw Particulate Data
The PurpleAir API does not provide AQI data; therefore, the integration does not create