diff --git a/source/_integrations/numato.markdown b/source/_integrations/numato.markdown new file mode 100644 index 00000000000..eeb95e0d5b2 --- /dev/null +++ b/source/_integrations/numato.markdown @@ -0,0 +1,211 @@ +--- +title: Numato USB GPIO Expander +description: Instructions on how to integrate a Numato GPIO expander into Home Assistant. +ha_category: + - DIY + - Binary Sensor + - Sensor + - Switch +logo: numato.png +ha_release: "0.110" +ha_iot_class: Local Push +ha_domain: numato +--- + +The `numato` integration is the base for all related GPIO platforms of the +[Numato 32 Port USB GPIO expander](https://numato.com/product/32-channel-usb-gpio-module-with-analog-inputs): + +- [Binary Sensor](#binary-sensor) +- [Sensor](#sensor) +- [Switch](#switch) + +The whole configuration of all Numato devices is located in the general setup +of this integration. The following minimalistic example configures a couple of +binary_sensor, switch and sensor ports for a single device with ID 0. + +```yaml +numato: + devices: + - id: 0 + binary_sensors: + ports: + 2: Window Livingroom Open + 3: Window Livingroom Glassbreak + 4: Doorbell + sensors: + ports: + 1: + name: Soil Moisture Ficus + switches: + ports: + 5: Relay Light Outdoor + 6: Relay Circulation Pump + 7: Door Opener +``` + +{% configuration %} +discover: + description: List of OS device files (/dev/...) to try during discovery + required: false + default: List of /dev/ttyACM0 .. /dev/ttyACM9 + type: list +devices: + description: List of Numato 32 Port USB GPIO devices. + required: true + type: list + keys: + id: + description: ID configured in the device (not the Linux device since this can change). + required: true + type: integer + binary_sensors: + description: Configuration of ports for the `binary_sensor` platform + type: map + keys: + invert_logic: + description: Whether to invert the logic, so a high voltage level is interpreted as false. + required: false + default: false + type: boolean + ports: + description: Map of port numbers to names. + required: true + type: map + keys: + "port: name": + description: The port numbers and corresponding names. + required: true + type: string + sensors: + description: Configuration of ports for the `sensor` platform + type: map + keys: + ports: + description: Map of port numbers to ADC configurations. + required: true + type: map + keys: + "port: adc_config": + description: The port number and corresponding ADC configuration. + required: true + type: map + keys: + name: + description: Name of the ADC sensor port. + required: true + type: string + source_range: + description: Range within the ADC's resolution to map values from. + required: false + default: [0, 1024] + type: list + destination_range: + description: Range to map values from the source range to in a linear fashion. + required: false + default: [0.0, 100.0] + type: list + unit: + description: Unit of the destination values. + required: false + type: string + default: \% + switches: + description: Configuration of ports for the `sensor` platform + type: map + keys: + invert_logic: + description: Whether to invert the logic, so a value of true leads to a low voltage level at the output. + required: false + default: false + type: boolean + ports: + description: Map of port numbers to names. + required: true + type: map + keys: + "port: name": + description: The port numbers and corresponding names. + required: true + type: string +{% endconfiguration %} + +## Binary Sensor + +The `numato` binary_sensor platform allows you to operate the GPIOs of your +[Numato](https://numato.com) 32 port USB GPIO expander in binary input mode. + +