From bc650ec6f80277020aee69874d9d6493820dbe38 Mon Sep 17 00:00:00 2001 From: happyleavesaoc Date: Sat, 8 Apr 2017 20:46:46 -0400 Subject: [PATCH] Update sensor.crimereports.markdown --- .../_components/sensor.crimereports.markdown | 31 ++++++------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/source/_components/sensor.crimereports.markdown b/source/_components/sensor.crimereports.markdown index 03cfec3675f..4ffaf65dd88 100644 --- a/source/_components/sensor.crimereports.markdown +++ b/source/_components/sensor.crimereports.markdown @@ -13,41 +13,28 @@ ha_release: 0.42 ha_iot_class: "Cloud Polling" --- -The `crimereports` sensor allows one to track reported incidents occurring in a Home Assistant zone. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. +The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. ## Configuration -To enable this sensor, add the following lines to your `configuration.yaml`. Your `zone` should be of sufficient size to capture incidents in your area. Your `home` zone is probably too small. +To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. ```yaml -zone: - - name: neighborhood - latitude: - longitude: - radius: - sensor: - platform: crimereports - zone: neighborhood + name: + radius: ``` Configuration options for the Crime Reports Sensor: -- **zone** (*Required*): The zone to monitor. +- **name** (*Required*): Name the sensor whatever you want. +- **radius** (*Required*): Radius in meters. +- **latitude** (*Optional*): Defaults to your home zone latitude. +- **longitude** (*Optional*): Defaults to your home zone longitude. - **include** (*Optional*): List of incident types to include. - **exclude** (*Optional*): List of incident types to exclude. -- **update_inverval** (*Optional*): Minimum time interval between updates. Default is 30 minutes. Supported formats: - - `update_interval: 'HH:MM:SS'` - - `update_interval: 'HH:MM'` - - Time period dictionary, e.g.: -
update_interval:
-        # At least one of these must be specified:
-        days: 0
-        hours: 0
-        minutes: 3
-        seconds: 30
-        milliseconds: 0
-    
+ ## Notes