aREST Sensor


The arest sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the aREST RESTful framework.

Configuration

To use your aREST enabled device in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: arest
    resource: https://IP_ADDRESS
    monitored_variables:
      temperature:
        name: temperature
    pins:
      A0:
        name: Pin 0 analog

Configuration Variables

resource

(string)(Required)IP address and schema of the device that is exposing an aREST API, e.g., https://192.168.1.10.

name

(string)(Optional)Let you overwrite the name of the device.

Default value: aREST sensor

pins

(list)(Optional)List of pins to monitor. Analog pins need a leading A for the pin number.

pin

(list)(Required)Pin number to use.

name

(string)(Required)The name of the variable you wish to monitor.

unit_of_measurement

(string)(Optional)Defines the unit of measurement of the sensor, if any.

value_template

(template)(Optional)Defines a template to extract a value from the payload.

monitored_variables

(list)(Optional)List of exposed variables.

variable

(list)(Required)Name of the variable to monitor.

name

(string)(Optional)The name to use for the frontend.

unit_of_measurement

(string)(Optional)Defines the units of measurement of the sensor, if any.

value_template

(template)(Optional)Defines a template to extract a value from the payload.

The variables in the monitored_variables array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. Ethernet for an Arduino with Ethernet shield). In those sketches are two variables (temperature and humidity) available which will act as endpoints.

Accessing one of the endpoints (eg. http://192.168.1.10/temperature) will give you the value inside a JSON response.

{"temperature": 23, "id": "sensor01", "name": "livingroom", "connected": true}

The root will give you a JSON response that contains all variables and their current values along with some device details.

{
   "variables" : {
      "temperature" : 23,
      "humidity" : 82
   },
   "id" : "sensor01",
   "name" : "livingroom",
   "connected" : true
}

return_value contains the sensor’s data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/).

{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}