Device Setup

<< Back to Room SetupOn to Activity Setup >> On the Devices page you can add, edit, and remove devices and their commands.

Adding a Device

Click on the Add New Device link to add a device. After retrieving the current list of manufacturers from RedEye’s online code database, the Add a Device dialog box will appear. Add Device BrowserFirst, choose your manufacturer from the list. If you do not see the manufacturer you need, you can click on the Add link to create a new one; however, if you add a manufacturer there will not be any command codes in our database for you to download, so you will have to create each command for the device manually. If you are looking for command codes for a particular manufacturer, please contact ThinkFlood support for assistance. Next, please select a device type from the list. In addition to aiding in the database search for command codes, the device type is useful when creating button layouts for new activities. If you are using a RedEye Pro, you will need to select a port assignment for your new device. Your choice of port type determines how the application will search for command codes. If you pick an infrared port, then RedEye will search for infrared codes; if you pick a serial port, then RedEye will search for serial codes, and so forth.[1] Once you have added the device, you can change the port assignment to another port of the same type, but you cannot change the device to a different port type. For example, if you pick an infrared port I1 now, you can change to any of the other infrared ports (I2 through I8) later, but you cannot change to a serial port (S1 or S2). Finally, you will need to enter a Display Name. RedEye uses the display name to present your device throughout the application, so this should be a user-friendly name such as “TV” or “Blu-Ray player.” If you enter a Model Name, RedEye will use the model information you provide to filter the database for closely matching infrared codes when possible. The device Description is simply additional information that appears below the display name in certain parts of the application. Once you have provided the above information, click on the Find Infrared Codes button to search for codes that match your criteria. If the database does not contain any possible matches, RedEye will create an empty device onto which you can manually add commands. In the event that there are possible matches in the database, the dialog box will expand to display those matches along the right-hand side. You can change your selections along the left, but if you change anything other than the name or description, RedEye will re-run your database search.

 Add Device Codeset Browser

Matching sets of codes appear sorted with the most frequently used sets at the top. Click on any codeset to expand. The application will load a handful of Preview Commands onto your RedEye unit for testing – simply click on any of the buttons at the top of the codeset to see if they work with your equipment. You can also scan through the entire Command List to see if the commands match what you need for your device. Click on other codesets in the list to test them. Once you have found a good match for your device, click on the Save This Device button to download the full set of codes and create your device. At this point you will see your new device appear in the list of devices on this page. You can make changes or continue adding devices as needed. However, your new device and subsequent changes are not yet saved, so please make sure that you click on the Save Changes button before you navigate away from the page.

Editing a Device

When you click on the Device section you will see a list of existing devices. Click on any device in this list to expand and edit its details.

Device Setup Browser

Name and Description

You can change the name and description for your device simply by typing directly into the text boxes provided. As with all device changes on this page, you need to click on the Save Changes button at the bottom of the screen when you are done. If you need to discard your modifications, you can click on the Cancel Changes button to reload the page with the data currently stored in your RedEye unit.

Manufacturer, Model Name, and Type

The Manufacturer, Model Name, and Type fields display the information that you entered when adding the device. These values are set when the device is added, and you cannot change them later.

Port

On the RedEye Pro you can change the port to which a device is assigned as long as the type of port (infrared, serial, etc) remains the same. Please bear in mind that if you have defined rooms on your RedEye Pro and you change a device port, that device may not appear on the same room(s) as before until you also modify the port assignment for your room(s). Editing Port Settings To edit the settings for the port to which a device is attached, click on the Edit Port Settings hyperlink. There are different settings for different types of ports, so the dialog box that appears over the page will vary depending on the type of the port to which the device is connected. Audio Port SettingsFor infrared ports, there are two basic settings: port Mode, and Power Level. Infrared ports are dual purpose – they can either send out infrared commands, or they can trigger off of sensor input. To switch between functions, simply select the desired mode and click the OK button.[2] When an infrared port is in infrared out mode, you can adjust the power level used to transmit infrared signals. This gain control can eliminate the need for a separate connecting block in many cases. To change the power level, simply slide the bar to the left (for lower power) or to the right (for higher power). Click OK and then Save Changes to test – the power level does not adjust dynamically as you slide. You have full control over serial port configuration through the serial port settings dialog. Baud Rate sets the communication speed for the serial port. RedEye Pro supports baud rates from 300 bps up to 230.4 kbps. By default it is set to 9600 bps, a common rate for many RS-232 devices. Serial Port Settings BrowserWord Length determines the size of each data frame, usually 8 bits. Parity indicates whether to add an extra bit to each word for error checking, and if so, how to detect errors. The default is not to include a parity bit. Strip 8th Bit indicates whether to discard the last (most significant) bit in the data frame. The default is to include all 8 bits in the frame. Stop Bits indicates how many stop bits appear at the end of each frame. The default is 1. Flow Control determines whether to coordinate transmission events on the data line. The default is no flow control, but software (Xon/Xoff) and hardware (RTS/CTS) options are also available. Echo Input refers to RedEye Pro’s behavior when it receives input data from the device being controlled. If this switch is enabled, then RedEye Pro will parrot back all data it receives. While this is a useful feature when typing data on an interactive terminal, echoed data can cause problems when two computers are speaking directly to one another; as a result, the default setting for this switch is off. In the Advanced Settings section you can enter any additional “stty" arguments. These arguments are always added to the end of the arguments generated by the other field. Practically speaking this means that you can override any of the earlier arguments, and therefore have full control over RS-232 configuration. For documentation on stty, please visit http://www.freebsd.org/cgi/man.cgi?query=stty. If you are editing an IP device, you can configure the connection between your RedEye and the device using the IP port settings dialog. Protocol determines the type of IP communication to use. Currently the options are User Datagram Protocol (UDP), Transmission Control Protocol (TCP), and Hypertext Transfer Protocol (HTTP). Changing the protocol fundamentally changes the communication mechanism used for the port. Because UDP and TCP employ the same basic messaging process within the RedEye software, you can modify them without too much concern. However, when switching to or from HTTP, you will need to update your port and command scripts for the device. You can learn more about scripting for IP devices in the RedEye Advanced Programming Manual. Host Name is the IP address or network host name of the device you would like to control. Port Number is the IP port number to which you will connect on the device. This number is assigned by the device you are controlling and is different than the port ID used internally by your RedEye unit. Path is an optional file path on the controlled device which you can specify here for convenience. Typically path is only used with HTTP, and may vary from request to request. Editing the Port Script For serial ports and infrared ports set to sensor mode, you can edit the port control script by clicking on the Edit Port Script hyperlink. Doing so opens a script editor in a new browser tab or window. Scripting is outside the scope of this manual; you can read more about port control scripts in the RedEye Advanced Programming Manual.

Command Setup BrowserEditing Commands

Along the right-hand side of the device information is a list of commands for the device. Click on any command name in the list to edit the command, or click on the green “play” button to test command playback. When editing a command, the Command Setup dialog box appears on top of the page. Type in the appropriate text boxes to edit the Name or Description for your command. The Type field displays the command type, and Toggles? indicates whether the command will toggle between different values (e.g., on and off) each time it is sent. Neither of these values is editable once the command has been created. If you wish to choose the command icon, you can choose a new one from the Icon list.

Toggle Values

For (infrared) toggle commands, the Command Setup dialog appears double wide, and toggle values appear along the right-hand side. Command Toggle Values BrowserFor each toggle value, you can specify a Name and a Description. You can also choose an Icon from the list. To add a new toggle value, click on the Add New Toggle Value link. You can reorder toggle values by dragging the handle (Handle Icon Activities). Click on the “X” button (Delete Icon) to delete.

Infrared Commands

If an infrared command is not functioning as you expect, you can capture a new control signal by clicking on the Capture New Control Signal button. The Test Signal button is useful in verifying that the new control signal is working properly. Command URL is a unique URL that other applications can use to invoke the command on your RedEye unit.

Script Command BrowserScripted Commands

In the case of scripted commands, you can click on the Edit Script button to edit the command script. The Test Script button executes the command for verification.

Deleting a Command

Once you have opened the Command Setup dialog, you can delete the command by clicking on the Delete Command button. As with other changes, the command is not actually removed until you click on the Save Changes button; if you accidentally delete a command, you can simply click Cancel Changes or close the browser page.

Adding a Command

When you click on the Add New Command hyperlink, the Add a Command dialog appears. The exact format of the Add a Command dialog differs slightly depending on whether the command uses infrared or a script.

Infrared Commands

In order to add an infrared command, you will need the original remote control for your device in hand. For RedEye (WiFi): Place the remote control about 3 to 6 inches from the front of your RedEye unit, as shown in the illustration at right. For RedEye Pro: Point the remote control about 3 to 6 inches in front of the RedEye Pro and about 2 inches just to the right of the “R” badge. Next, click on the Capture Control Signal to put your RedEye unit in a “learning” state. From this point you have about 30 seconds to press the appropriate button on your remote control. Once the RedEye device has captured the signal, the processing screen will disappear and you will be able to save the command. Once you have captured a control signal, you can test it by pressing the Test Control Signal button. If the signal does not work properly, you can re-capture the command by pressing the button and starting over again. Tips for capturing control signals:
  • Position the remote control no closer than 2 inches from your RedEye, and no farther than 10 or 12 inches. Try to keep the remote control level with your RedEye, rather than at an angle.
  • Quickly press and release the button on your remote control. Often we have a tendency to press and hold remote control buttons to make sure that they register, but if your remote control is the proper distance from your RedEye, you need not do so. One quick button press makes it more likely to capture a clean signal from the remote.
  • Avoid otherwise interacting with your RedEye unit (for example, from another controller) while it is in learning mode.
Next, please choose a command type from the Type list. The command type describes the nature of a command. When properly assigned, the RedEye application can use this information to create intelligent button layouts and manage the devices you use for different activities. You cannot change command type settings once the command is created, so please take a minute to consider your best options here. If you cannot find a command type appropriate to the command that you are creating, you can use the command type Other, although we recommend using this option sparingly, as the RedEye application cannot determine how to make use of commands without a specific type. The Toggles? checkbox allows you to indicate whether the command is “discrete” — that is, whether the command produces the same result every time you send it — or whether it “toggles” across a list of possible values. Because infrared remote control signals are a one-way street — your controller can only send signals, it does not receive responses — we recommend using discrete signals whenever possible. When Toggles? is checked, a Toggle Values section appears at the right-hand side of the page. Trying to decide whether to use a toggle command or not? Let’s consider how the power button works. If your remote control uses discrete commands, you will have two power buttons: one to turn on the power, and one to turn it off. Whenever you press the Power On button, the device will power up. If the device is already powered up when you press the Power On button, pressing the button again does nothing. By contrast, if you have a control that uses a power toggle button, you will have a single button. Whenever you press the button, the device switches from off to on or vice versa. Consider what happens when we try to make your remote control “smart” — for example, by controlling multiple devices as part of an activity. When you launch the “Watch TV” activity, you want the television to turn on. If your controller has a discrete Power On command it sends that signal, the TV turns on, and life is good. However, if your controller uses a toggling Power command, it needs to know whether the TV is already on to determine whether to send the Power command. If someone presses the power button on the front of the TV instead of using the remote control, then the remote control loses track, and may mistakenly turn off the TV when it should remain on. Although many manufacturers provide discrete commands for their devices, sometimes you may not have access to them. If you are going to use the command to launch an activity — such as will be the case with toggling Power and Input commands — it is probably worthwhile to deal with the hassle of making these toggle commands. However, in other cases in which you will not use the command to launch an activity — for example, with a Mute command — it is simpler to treat the command as one that does not toggle. Enter a Name and (optionally) a Description for your command. This information is visible in many different parts of the RedEye application. Choose an Icon from the list to determine how buttons created using this command will display by default. If none of the icons seems appropriate, you can choose Text Only to display the name of the command instead of an icon. If you are creating a toggle command, the Toggle Values section defines the list of values through which the device cycles when the command is transmitted. As a result, the order of toggle values matters — it should match the order that your equipment uses when the original remote button is pressed. Click on a toggle value to edit its Name, Description, or Icon; or tap on Add New Toggle Value to create one. The name and icon are visible when you use toggle buttons in your activities. You can reorder toggle values by dragging the handle (Handle Icon Activities). Click on the “X” button (Delete Icon) to delete. This section does not appear if the Toggles? checkbox is left unchecked. When you are finished configuring your new command, click the OK button. As with other changes on the Devices page, you will need to click the Save Changes button before you navigate away in order to make your changes permanent. If you need to undo, you can click on the Cancel Changes button. Add Command Infrared Toggle Browser

Scripted Commands

RS-232 and relay devices use scripts for their commands rather than infrared signals. In order to add these commands, you will need documentation provided by the device manufacturer – particularly in the case of RS-232 devices. For more information on writing scripts for RedEye, please review the RedEye Advanced Programming Manual. Enter a Name and (optionally) a Description for your command. This information is visible in many different parts of the RedEye application. Add Command Script BrowserChoose an Icon from the list to determine how buttons created using this command will display by default. If none of the icons seems appropriate, you can choose Text Only to display the name of the command instead of an icon. Click on the Edit Script button to write a script for your command. RedEye includes a template to get you started, but you will need to provide the text or other data as required by the device control specification available from the device manufacturer. You can click on the Test Script button to verify that your script is working. When you are finished, click the OK button. As with other changes on the Devices page, you will need to click the Save Changes button before you navigate away in order to make your changes permanent. If you need to undo, you can click on the Cancel Changes button.

Duplicating a Command

Rather than starting from scratch with each new command, sometimes it can be helpful to duplicate an existing command and make small modifications from there. To duplicate a command, click on the Duplicate icon () within the command list. RedEye will create an exact copy of the command and open up the Add a Command dialog so that you can make changes before saving.

Testing a Command

Although you can test your commands from the Add a Command and Command Setup dialogs, you can also test them directly from the command list using the Test button ().

Laying Out Device Controls

You can create a custom control layout for your device by clicking on the grid icon (), located on the right-hand side of the page, across from the device name. The process for editing a device layout is the same as for Editing Activity Layouts.

Deleting Devices

If you wish to delete a device, simply click on the red “X” button (Delete Icon) to the right of that one you wish to remove. Remember to click the Save Changes button when you are finished – or click Cancel Changes if you did not mean to delete the device.

[1] Currently our online code database contains only infrared command codes, so if you choose a serial port, you will need to add commands manually for now. We will be adding serial drivers and other types of codes in the near future.
[2] Please note that in sensor input mode, infrared ports emit a constant 5V. In order to avoid burning out LEDs on infrared flasher cables, we recommend disconnecting any flasher cables from the port before switching the mode to sensor input.
<< Back to Room SetupOn to Activity Setup >>