Added more details to introduction of component (#6678)

* Added more details to introduction of component

Added more details specifically for the context of a user who may have never heard of Zillow or Zestimates to better understand what this sensor does.

* Added more clarity to the config description

* Add files via upload

* Create temp

* Delete temp

* Create temp

* Add files via upload

* Delete temp

* Update sensor.zestimate.markdown

* Delete zestimate example.png

* Fixed image embed

* ✏️ Tweaks
This commit is contained in:
fortepc 2018-10-21 05:59:46 -04:00 committed by Franck Nijhof
parent ff8a183278
commit 22c9fe9977
2 changed files with 10 additions and 4 deletions

View File

@ -13,11 +13,13 @@ ha_release: 0.65
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
The `zestimate` sensor allows one to track the Zestimate value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States.
This component adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. If you're the owner of this property, it's recommended to claim the listing and update the property information to help the information be as accurate as possible.
For example, the White House zpid is 84074482 and can be found in its Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/) For example, the White House zpid is 84074482 and can be found in its Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/)
@ -34,11 +36,11 @@ sensor:
{% configuration %} {% configuration %}
api_key: api_key:
description: The API key to access the service. description: The API key to access the service. Obtain yours using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm)
required: true required: true
type: string type: string
zpid: zpid:
description: Property IDs to track in the front end. description: Property IDs to track in the front end. Can be found in it's Zillow URL as described above. Include only the numbers, do not include the "_zpid"
required: true required: true
type: list type: list
{% endconfiguration %} {% endconfiguration %}
@ -56,3 +58,7 @@ These attributes are available:
- Address - Address
- Currency - Currency
- Amount - Amount
Example screenshot
<img src="/images/components/zestimate/zestimateexample.png" />

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB