Updated Configuration Procedure for New Devices (markdown)

Michael Ingraham 2019-04-18 14:32:55 -04:00
parent 817f3bcefe
commit 69c8499efc
1 changed files with 5 additions and 7 deletions

@ -2,15 +2,15 @@
If your device is not a built-in module listed in the module configuration menu, a [user contributed device template](https://blakadder.github.io/templates/) ([explanation](Templates)) may be available. Otherwise, follow this procedure for configuring your device. If your device is not a built-in module listed in the module configuration menu, a [user contributed device template](https://blakadder.github.io/templates/) ([explanation](Templates)) may be available. Otherwise, follow this procedure for configuring your device.
If your device is similar to the existing module it is best to use that as a starting point. When you're not sure which module is suitable for your device, use Generic module (18). Once you have selected the module type and saved the configuration, return the the module type configuration dialog. If your device is similar to the existing module it is best to use that as a starting point. When you're not sure which module is suitable for your device, use Generic module (18). Once you have selected the module type and saved the configuration, return to the module type configuration dialog.
1. Set every GPIO (excluding, at first, "dedicated" GPIO such as Tx/Rx & GPIO0/GPIO2, etc.) each assigned to one of the available `RelayX` relays. 1. Set every GPIO (excluding, at first, "dedicated" GPIO such as Tx/Rx & GPIO0/GPIO2, etc.) each assigned to one of the available `Relay<x>` relays.
_a._ Save the configuration. Once the device reboots, use the web GUI virtual buttons to find which of the buttons assigned to GPIO actually control relays and LEDs on the device. _a._ Save the configuration. Once the device reboots, use the web GUI virtual buttons to find which of the buttons assigned to GPIO actually control relays and LEDs on the device.
- If you are unable to control some of the relays or LEDs on the device, they may be attached to the "dedicated" GPIO. Set those GPIO to an unused `RelayX` and repeat step _1a_. - If you are unable to control some of the relays or LEDs on the device, they may be attached to the "dedicated" GPIO. Set those GPIO to an unused `Relay<x>` and repeat step _1a_.
_b._ Once you have found which GPIO control which relays and LEDs, set these "active" GPIO to associate them with the corresponding `RelayX` or `LEDX`. Proper operation may dictate the use regular or inverted (`RelayXi`/`LEDXi`) settings. _b._ Once you have found which GPIO control which relays and LEDs, set these "active" GPIO to associate them with the corresponding `Relay<x>` or `LED<x>`. Proper operation may dictate the use regular or inverted (`Relay<x>i`/`LED<x>i`) settings.
2. Now, set every remaining GPIO (excluding, once again, remaining "dedicated" like Tx/Rx & GPIO0/GPIO2, etc.) to `Switch`es. 2. Now, set every remaining GPIO (excluding, once again, remaining "dedicated" like Tx/Rx & GPIO0/GPIO2, etc.) to `Switch`es.
@ -20,7 +20,7 @@ If your device is similar to the existing module it is best to use that as a sta
- If none of the GPIO change state, then configure the "dedicated" GPIO and retry. - If none of the GPIO change state, then configure the "dedicated" GPIO and retry.
_c._ Once you have found which GPIO are connected to each button, change the GPIO setting in the configuration to a `ButtonX`. You may need to determine whether the internal pull-up is used or not. If so, select `ButtonX`_**n**_. _**n**_ indicates no pull-up or normally-closed. _c._ Once you have found which GPIO are connected to each button, change the GPIO setting in the configuration to a `Button<x>`. You may need to determine whether the internal pull-up is used or not. If so, select `Button<x>`_**n**_. _**n**_ indicates no pull-up or normally-closed.
- See [Using a physical pushbutton with single press, double press, and hold](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#16-using-an-external-button-with-single-press---double-press-and-hold) to control multiple devices with one button. - See [Using a physical pushbutton with single press, double press, and hold](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#16-using-an-external-button-with-single-press---double-press-and-hold) to control multiple devices with one button.
@ -31,5 +31,3 @@ If your device is similar to the existing module it is best to use that as a sta
4. Once the device reboots, your device hardware is configured for use. 4. Once the device reboots, your device hardware is configured for use.
5. Since you have now configured a device not previously known to the TASMOTA user base, you may want to [export the template](https://github.com/arendst/Sonoff-Tasmota/wiki/Templates#exporting-your-template) and contribute it to the [templates database](https://blakadder.github.io/templates/). 5. Since you have now configured a device not previously known to the TASMOTA user base, you may want to [export the template](https://github.com/arendst/Sonoff-Tasmota/wiki/Templates#exporting-your-template) and contribute it to the [templates database](https://blakadder.github.io/templates/).