A fan service

This service was implemented in firmware version 1.7.0

The following configuration is available for fans:

{
  "c":{"io":[[[9,12,14,15,13],2],[[0],6]],"l":13,"b":[[0,5]]},
  "a":[{
    "t":65,
    "0":{"r":[[15],[12],[14]]},
    "y0":[
      {"v": 1, "0":{"r":[[15,1,0.5],[12],[14,0,0.6]]} },
      {"v":33, "0":{"r":[[15,1,0.5],[12,0,0.6],[14,0,0.6]]} },
      {"v":67, "0":{"r":[[15,1],[12],[14]]} }
    ],
    "es":[{
      "t":1,
      "1":{"r":[[9]]},
      "0":{"r":[[9,1]]},
      "b":[[0]]
    }]
    }
  ]
}

This is an example of a Sonoff iFan03 ("t":65). The fan speed is controlled using GPIOs 15, 12 and 14. The button is connected to GPIO 0 and the on/off relay is connected to GPIO 9. A wildcard action ("y0") is defined to control the speed of the fan. Each step change in the value monitored by the wildcard action changes the fan control GPIO lines to adjust its speed.

A fan has two actions. The Binary Outputs "r": [ ] for each should be configured to attain the desired state.

The Speed Step option is used to define the number of speed steps the fan has. When a request is made to increment or decrement the fan speed then the next or previous step in speed will be selected.

Total of Speed Steps is defined by the "e" key contained within the service object.

Setting the Total of Speed Steps to a value of 3 gives the fan three speeds, plus stop. When viewing the fan speed from within the Home App the fan service will show speeds of 0%, 33%, 66% & 100% depending on which speed step has been selected. But internally, speeds will be 0, 1, 2 and 3.

The list of Service Notifications "m" values supported are:

See the general Service Notifications section for details of how to configure these notifications.

Binary Inputs "b" are supported by this service.

See Binary Inputs for details on how to define this mandatory option.

State inputs "f[n]" & Status Inputs "g[n]" are supported by this service. The supported list is:

Refer to State Inputs for more detail and examples.

ICMP Ping inputs "p[n]" and "q[n]" are supported by this service. The supported list is:

Refer to ICMP Ping Inputs for more detail.

Wildcard Actions "y[n]" are supported by this service. The supported list is:

Wildcard actions cam be mapped to each of the Speed Steps. For example, if a Total of 3 Speed Steps have been defined ("e":3) then wildcard actions can be set for 1, 2 and 3.

Refer to Wildcard Actions for more detail.

The Initial Lock State about Service and Physical controls.

The Initial State key is supported by this service. Refer to Initial State for details of the available values.