diff --git a/source/_components/sma.markdown b/source/_components/sma.markdown index 4b440b9f8f4..af30b3b28f5 100644 --- a/source/_components/sma.markdown +++ b/source/_components/sma.markdown @@ -12,22 +12,36 @@ redirect_from: The `sma` sensor will poll a [SMA](http://www.sma-solar.com/) [(US)](http://www.sma-america.com/) solar inverter and present the values as sensors (or attributes of sensors) in Home Assistant. -This sensor uses the web interface and in order to use it you have to be able to connect to the solar inverter from your favorite web browser. +This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser. ## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yaml entry (http) sensor: - platform: sma host: IP_ADDRESS_OF_DEVICE password: YOUR_SMA_PASSWORD sensors: - current_consumption: [total_consumption] - pv_power: - total_yield: + - current_consumption + - total_consumption + - pv_power + - total_yield + +# Example configuration.yaml entry (https) +sensor: + - platform: sma + host: IP_ADDRESS_OF_DEVICE + ssl: true + verify_ssl: false + password: YOUR_SMA_PASSWORD + sensors: + - current_consumption + - total_consumption + - pv_power + - total_yield ``` {% configuration %} @@ -55,50 +69,10 @@ group: default: user type: string sensors: - description: A list of sensors that will be added. The value of the list can include a list of sensor names that will be used as attributes. + description: A list of sensors that will be added. Refer to the table in the Sensors section below. If not specified all the sensors in the library will be added. required: false default: All sensors type: list - keys: - pv_power: - description: Current power generated by the inverter (W). - pv_gen_meter: - description: Total kWh generated to date (kWh) - total_yield: - description: Total power yield from solar installation (kWh). - daily_yield: - description: The yield for today (Wh) - - current_consumption: - description: Power that you are currently drawing, depending on your installation it can be a combination of the inverter and the grid (W). - total_consumption: - description: Total power consumption (kWh). - - grid_power_supplied: - description: Power supplied (W) - grid_power_absorbed: - description: Power absorbed (W) - grid_total_yield: - description: Total power fom the grid (kWh) - grid_total_absorbed: - description: Total power supplied to the grid - - grid_power: - description: Power supplied by the grid (W) - frequency: - description: Grid frequency (W) - voltage_l1: - description: Voltage for phase 1 (V) - voltage_l2: - description: Voltage for phase 2 (V) - voltage_l2: - description: Voltage for phase 3 (V) - - status: - description: Status of the solar plant. - - your-custom-sensor: - description: Any sensor name defined in the `custom:` section custom: description: A dictionary of custom sensor key values and units. required: false @@ -117,16 +91,36 @@ custom: required: false default: 1 type: float + path: + description: A custom JMESpath to extract the sensor value (typically not required, advanced use only). + required: false + type: string {% endconfiguration %} -You can create composite sensors, where the sub-sensors will be attributes of the main sensor. E.g., +## Sensors -```yaml - sensors: - - current_power: [total_power, total_consumption] -``` +Sensors available in the library: -The SMA WebConnect module supports a wide variety of sensors, and not all these have been mapped to standard sensors. Custom sensors can be defined by using the `custom` section of the configuration. You will need: A sensor name (no spaces), the SMA sensor key and the unit +| name | Unit | Description | +|--------------|------|:-------------------------------------------| +| pv_power | W | Current power generated by the inverter. | +| pv_gen_meter | kWh | Total kWh generated to date. | +| total_yield | kWh | Total power yield from a solar installation. | +| daily_yield | Wh | The solar plant's yield for today. ! +| current_consumption | W | Power that you are currently drawing, depending on your installation it can be a combination of the inverter and the grid. | +| total_consumption | kWh | Total power consumption. | +| grid_power_supplied | W | Power supplied. | +| grid_power_absorbed | W | Power absorbed. | +| grid_total_yield | kWh | Total power from the grid. | +| grid_total_absorbed | Wh | Total power supplied to the grid +| grid_power | W | Power supplied by the grid. | +| frequency | Hz | Grid frequency. | +| voltage_l1 | V | Voltage for phase 1. | +| voltage_l2 | V | Voltage for phase 2. | +| voltage_l2 | V | Voltage for phase 3. | +| status | | Status of the solar plant. | + +The SMA WebConnect module supports a wide variety of sensors, and not all these have been mapped in the `pysma` library. Custom sensors can be defined by using the `custom` section of the configuration. You will need: A sensor name (no spaces), the SMA sensor key and the unit. Example: