Configuration

⚠️ It is recommended (and easier) to use the Homebridge/HOOBS UI plugin settings screen to configure the plugin

If you are using v6.8.0 or below, see Configuration (v6)

Required Settings

Add the following to your configuration file in the appropriate place. The following are the basic required fields.

{
   "name": "eWeLink",
   "username": "your-ewelink-username (either full phone (eg +8613185260282) or email address)",
   "password": "your-ewelink-password",
   "platform": "eWeLink"
}

⚠️ The "platform": "eWeLink" line must not be changed
It is recommended to use your main eWeLink account for the plugin (not a shared account)
You can optionally use a base64-encoded version of your password
See Connection Methods for the exception when your eWeLink credentials can be removed from the configuration in LAN mode

Optional Settings

Entry	Type	Default	Explanation
`mode`	`str`	`"auto"`	This setting defines how the plugin communicates with your devices. Options are: `"auto"` to use both LAN and Cloud mode `"wan"` to just use Cloud mode `"lan"` to just use LAN mode For further guidance, see Connection Methods.
`offlineAsNoResponse`	`bool`	`false`	Whether to mark cloud-offline accessories as 'No Response' in HomeKit. This setting has no effect if the plugin is in LAN mode and does not apply to Zigbee devices nor the DW2 sensor.
`countryCode`	`str`	`"+44"`	Override the default country code, may help with login issues for users in other regions.
`httpHost`	`str`	`""`	Override the default API host, may help with login issues for users in other regions.
`apiPort`	`int`	`0`	Port to use for the Internal API. Set to `0` to disable. Set to `1` to choose a randomly available port.
`disableDeviceLogging`	`bool`	`false`	Global logging setting for accessory status changes. If `true` then accessory status changes will not be logged. This can also be set per accessory later in the config.
`debug`	`bool`	`false`	Global logging setting for the plugin. If `true` then debug information will be added to the log. This can also be set per accessory later in the config.
`debugFakegato`	`bool`	`false`	If `true`, the included Fakegato library will debug to the log.
`disablePlugin`	`bool`	`false`	If `true`, the plugin will remove all accessories and not load the plugin on restart.
`singleDevices`	`array`	`[]`	Optional settings for single-channel switch, outlet and light switch devices. See Single Channel Devices for a further explanation about this option and configuration examples.
`multiDevices`	`array`	`[]`	Optional settings for multi-channel switch, outlet and light switch devices. See Multi Channel Devices for a further explanation about this option and configuration examples.
`lightDevices`	`array`	`[]`	Optional settings for dimmer, bulb and LED strip devices. See Light Devices for a further explanation about this option and configuration examples.
`thDevices`	`array`	`[]`	Optional settings for thermostat and TH10/16 devices. See Thermostat Devices for a further explanation about this option and configuration examples.
`fanDevices`	`array`	`[]`	Optional settings for iFan devices. See Fan Devices for a further explanation about this option and configuration examples.
`sensorDevices`	`array`	`[]`	Optional settings for DW2 and Zigbee sensor devices. See Sensor Devices for a further explanation about this option and configuration examples.
`rfDevices`	`array`	`[]`	Optional settings for RF Bridge devices. See RF Devices for a further explanation about this option and configuration examples.
`bridgeSensors`	`array`	`[]`	Optional settings for RF Bridge subdevices. See RF Bridge Sensors for a further explanation about this option and configuration examples.

Setup

Features

Help/About

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Configuration

Required Settings

Optional Settings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally