"Add a keypad to your control pages for a variety of uses."
This plugin lets you set up a keypad on your control pages and use that keypad to control devices in Indigo. The security keypad can be used for an Indigo alarm system or really any situation you can think of where you need to passcode lock an Indigo action. The dimmer lets you punch in precisely what you want the brightness to be on one or more devices dynamically. The sprinkler keypad lets you either enter a manual schedule to run now or modify a currently running schedule to add time to the zones.
NAVIGATE: Plugin Store Download | GitHub Downloads & Release Notes
__________________________________________________________________________________________________________________________________________________________________________________________
Introduction
NOTE: This plugin is NOT designed exclusively for Room-O-Matic and/or LCD Creator, the screenshots here are just examples of how I utilize this plugin. Also, no graphics come with this plugin.
With the security keypad you define what the code is and then, using your control page, you enter that code and the plugin takes actions depending on if the code was correct or not. With the dimmer control you can either pre-define which devices to control up front or do it dynamically via an action call - or both - and when you enter a number between 0 and 100 it will set the brightness of all the devices.
In both cases the plugin gives real-time feedback so that you can do everything via a single line and whatever keys you want to use on your control pages. See the example from Room-O-Matic for how I implemented these in my Indigo network.
Features
- Security Keypad
- Standard security keypad features such as auto-accepting the code after a certain number of characters, actions to take after a configurable number of bad attempts, locking out the keypad in the event of too many failures, and the ability to input one character and show a generic character on the screen (such as you enter a character but the display shows **** or ####)
- Multiple "actions" allow you to define what happens when the code is sent to the device, these "actions" can be action groups, device control or variable changes
- Actions can be configured for:
- Code successfully entered and accepted
- Each code submission that is incorrect
- Failed code after a configurable number of attempts
- Special action codes (such as hitting 911 for emergency or 999 to turn on all lights, etc)
- Dimmer Keypad
- Allows you to set the exact brightness of one or more devices either as a statically defined group of devices or a dynamically changing list of devices (allowing you to use a single keypad for all of your Indigo devices)
- Sprinkler Keypad
- Lets you create a schedule on the fly and run it immediately or add time on a zone-by-zone basis to a schedule that is currently running
Configuration and Use
Available Actions
- Send Character: Sends whatever character you choose to the plugin. Each key you define on your control page will execute this same action with a different character
- Send Devices to Dimmer: You can choose to either use pre-configured devices for the dimmer keypad or send them on the fly. This is handy if you want only a single keypad for your entire Indigo system but want to dynamically decide which device or devices to dim or brighten
- Delete Last Character: Backspace, essentially
- Process Current Code: Enter, essentially. If you don't auto-accept your codes then you'll need to send this command to tell the plugin you are done
If you want a "readout" of the display simply link your control page image to the "Current value of characters sent" state.
Security Keypad
- Security Code: The code that must be submitted to be considered successful
- Auto Accept; How many character until the device automatically submits the entered code (or 0 if you want to submit it manually via an "enter" key)
- Attempts: How many incorrect code submissions until you take action as a "fail" state
- Seconds Until Reset: How many seconds you want to give the user to enter the code in, after this time whatever has been entered already is cleared and they start over
- UI Character: Leave this blank to show the code that is being entered or put a "obfuscation" character here such as an asterisk or pound symbol
- Success / Incorrect / Fail actions:
- UI: What should be displayed in the UI when this event is raised
- Action Type: When this event is raise if you want to run an action group, control a device or change a variable
- Device/Variable/Action: The device, variable or action you want to run/change
- Action Codes 1 & 2: Special codes that when entered do their own actions. These are auto-complete codes so if you put 911 as the code then as soon as the 2nd "1" is entered this automatically executes. You can leave the codes blank if you don't want to use this.
Dimmer Keypad
- Devices: The dimmable devices in your Indigo network. This is optional as you can also define these devices via an action
- Prompt: What you want your readout to say while awaiting input for brightness
- When Devices Sent: You can choose to ignore devices added via the action, add those devices to these devices or use those devices exclusively
Sprinkler Keypad
- Sprinkler Device: Up to 3 different sprinkler devices to work with
- Prompts: What you want the UI to show when waiting for input. If a zone has a value it will show the value, if it does not then it will show the UI values you put here
- If Running: What to do if the sprinkler device you are changing the schedule for is currently running. You can choose to stop the current schedule and run your newly input schedule or you can add time to any zone and the schedule will be stopped and restarted with the new times added
Use: If you are using just a single sprinkler device then you will be prompted first for the run time for zone 1, simply use the "Send character" actions to add time and the "Next field" action to move to the next zone. Next will cycle all 8 zones and circle back to zone 1. You aren't required to enter anything for the zones, you can simply "Next" through the zones you don't care about until you get to a zone you want to change, when you do this the plugin assumes a new or added duration of zero for skipped zones.
If you are using multiple sprinkler devices you will be prompted to first choose which sprinkler you are changing, you can either use "Send character" to send 1, 2 or 3 or you can create quick buttons on your control page with keywords #dev1, #dev2 or #dev3. Once the device is selected the process is the same as if you had a single device.
Advanced
This plugin is pretty straightforward, the security keypad is a bit more advanced but also self-explanitory. If in doubt simply take all the defaults and see where it leads you.
Examples of Use
- Example: Makeshift Indigo alarm
- Device: Set up a security keypad with the code to disable your alarm and actions to take when the wrong code is entered or if someone hits special keys such as 911
- Control Page: Create a grid of 12 images for 0-9, asterisk and pound, set the action for 0-9 to be "Send character" and the character to send is the same as the key. Use asterisk and pound to link to actions for "Delete character" or "Send complete code".
- Use: When the proper code is entered your security devices are turned off and everything is good. When it is not you can do whatever your heart desires (or that Indigo allows at least) to let the world know that something is wrong.
- Example: Dynamic keypad to control the brightness of every device in your Indigo network
- Device: Set up a dimmer keypad and don't select any devices, then use the default of "Replace these devices" as the action
- Control Page: Create a grid of 12 images for 0-9, asterisk and pound, set the action for 0-9 to be "Send character" and the character to send is the same as the key. Use asterisk and pound to link to actions for "Delete character" or "Send complete code".
- Control Page: Set up some buttons to change the device configuration of the dimmer keypad as well as a client action to redirect the user to the keypad page when they tap on the control on your page to change the brightness
- Control Page: Set up a "back" button to return to the previous control page once the desired brightness has been set
- Use: On your normal control pages you have a button to change the brightness of a device, that button is configured to send a list of devices (or a single device) to the plugin so it knows which devices to control and the client action of that button redirects them to the keypad. The user punches in a number for the brightness (0 to 100 - anything over 100 will revert to 100), submits the value and all the devices will now be at that brightness
#Version|1.11#