home-assistant.io/source/_components/sensor.crimereports.markdown
Fabian Affolter 95546aa3fc
Move to Network category (#6181)
* Move to Network category

* Update category and other fixes
2018-09-03 10:48:27 +02:00

2.6 KiB

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, logo, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer ha_category logo ha_release ha_iot_class
page Crime Reports Instructions on how to integrate CrimeReports.com into Home Assistant. 2017-02-16 11:00 true false true true Social crimereports.png 0.42 Cloud Polling

The crimereports sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to Crime Reports. Your regional emergency services may or may not report data. The sensor only counts incidents from the current day.

{% linkable_title Configuration %}

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.

sensor:
  - platform: crimereports
    name: <any name>
    radius: <your radius>

Configuration options for the Crime Reports Sensor:

  • 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.

{% linkable_title Notes %}

{% linkable_title Area %}

Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone.

{% linkable_title Incident Types %}

You can explicitly include or exclude incident types. Specifying includes restricts the incidents to those types. Specifying excludes will return all incident types except those specified.

These incident types are available:

  • Alarm
  • Arson
  • Assault
  • Assault with Deadly Weapon
  • Breaking & Entering
  • Community Policing
  • Death
  • Disorder
  • Drugs
  • Emergency
  • Family Offense
  • Fire
  • Homicide
  • Kidnapping
  • Liquor
  • Missing Person
  • Other
  • Other Sexual Offense
  • Pedestrian Stop
  • Proactive Policing
  • Property Crime
  • Property Crime Commercial
  • Property Crime Residential
  • Quality of Life
  • Robbery
  • Sexual Assault
  • Sexual Offense
  • Theft
  • Theft from Vehicle
  • Theft of Vehicle
  • Traffic
  • Vehicle Recovery
  • Vehicle Stop
  • Weapons Offense

{% linkable_title Events %}

The crimealerts sensor fires a crimealerts_incident event when a new incident is detected, including the type, description, time, location, and coordinates of the incident.