From f036b3b9045299c317587439f1e79f3182579950 Mon Sep 17 00:00:00 2001 From: Stuart McCroden Date: Thu, 1 Nov 2018 03:37:03 -0500 Subject: [PATCH] Update configuration variables style (#7284) Use the new style for configuration variables as described in #6385 for sensor.crimereports.markdown --- .../_components/sensor.crimereports.markdown | 34 ++++++++++++++----- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/source/_components/sensor.crimereports.markdown b/source/_components/sensor.crimereports.markdown index e80d504a51f..8637e53c976 100644 --- a/source/_components/sensor.crimereports.markdown +++ b/source/_components/sensor.crimereports.markdown @@ -26,14 +26,32 @@ sensor: 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. +{% configuration %} +name: + description: Custom name for the sensor. + required: true + type: string +radius: + description: Radius in meters + required: true + type: float +latitude: + description: Latitude for sensor. + required: false + default: Your home zone latitude defined in your configuration. +longitude: + description: Longitude for sensor. + required: false + default: Your home zone longitude defined in your configuration. +include: + description: List of incident types to include. See below for a list of valid incidents. + required: false + type: list +exclude: + description: List of incident types to exclude. See below for a list of valid incidents. + required: false + type: list +{% endconfiguration %} ## {% linkable_title Notes %}