Outcome

Follow this Setup Guide to achieve RS232 control of any device type that AVA OS supports over RS232.

AVA OS provides RS232 serial control only by using either the CYP CR-IPS1 or CR-IPS4 modules.

Advisory

Serial control is technical. It can be frustrating for those without experience with serial devices. AVA Support can help, but mainly with the AVA OS driver connection to the CYP device.

AVA Support cannot research, implement, or troubleshoot specific serial commands on any given target devices, nor help with how to wire the CYP to your target device.

Establishing serial control from the CYP module to the target device may require support help from the manufacturer of the target device, or from CYP.

CYP Support is at this link.

Overview

There are 3 main parts to establishing RS232 control for a device using AVA OS.

1. Physical Setup - Set up the CYP hardware and connect to the CYP unit for whatever device you aim to control, according to the manufacturers specifications.
2. CYP Setup - Establish serial control with the CYP without AVA OS.
3. AVA OS Driver Setup - Add the AVA OS driver for the CYP device type template that you loaded onto the CYP module.

Each of the above steps requires the previous steps to be successfully tested.

Quick Reference: Download device type templates from CYP RS232 Device Templates for Automation.

Physical Setup

1. Power Up the CYP Module

Connect to power using either an Ethernet connection with PoE, or using the AC adapter included with the CYP module and a standard Ethernet connection.

2. Set a Fixed IP Address

Set a DHCP reservation (preferred) or a static IP address on the CYP module.

Note the address. You use the IP address of the CYP module to access its browser interface for configuration.

3. Build the Serial Cable Connection

Control will work only if you correctly wire the physical connection between the CYP module and the target device to control.

The CYP module uses a standard Euroblock (a.k.a. “Phoenix”) connector with 5 wire terminals.

Each terminal is labeled on the CYP device.

The cable required to connect a CYP module to a target device depends on the exact model being controlled because RS232 connector interfaces vary.

A typical 9-pin connector, as shown at right, has a 9-pin male or female plug on one end, and wires labeled for transmit (Tx), receive (Rx), and Ground (G).

Do not connect the serial cable to the target device until you get to the “Test Serial Commands” section below.

CYP Setup

These instructions are written for CYP firmware 2.12C. Subsequent updates could change steps.

1. Open a Browser to the CYP Web UI

Use Google Chrome on a computer (not tablet or phone) for managing the CYP module. (AVA has seen issues using the CYP UI from Firefox on Mac OS.)

1. On a computer, direct your browser to http://{ip_address_of_cyp}
   1. Replace {ip_address_of_cyp} with device’s actual IP address.
   2. Use http:// rather than https://

2. Click the login icon.

   

3. Login using the default credentials:

   1. Username: admin
   2. Password: admin

   A successful login changes the login icon to a red icon.

2. Set the RS232 Communication Parameters

Each device controlled by a CYP module requires specific serial communication settings.

Configure these settings for each serial connection (COM port) on the CYP module.

1. Consult the target device’s documentation for its RS232 configuration parameters.

Example NAD AV Receivers state the following settings for RS232 communication:

2. In the CYP web UI, go to Console and then IP to Serial.

3. On the page titled Console - IP to Serial, click the gear icon for the COM port that will connect the target device.

   

4. Scroll down to Serial Port Setting.

   

    

5. Configure the settings according to the target device documentation, then click Apply.

Proceed only after the CYP module’s COM settings match the target device’s requirements.

3. Test Serial Commands

You can now test the serial connection by sending device commands from the CYP web UI.

1. Connect the serial cable to the target device.
    
2. Turn on the target device.
   Seriously. Humans forget.
    

3. In the CYP web UI, go to Console and then IP to Serial.
   
   If the target device outputs any kind of status data, it might already show in the Serial output field. Not all devices do, but if you see data here, it confirms that you have a working connection between the CYP module to the target device.

   

    

4. In the command line field, test a read-only command from the target device’s documentation, such as a status check. The exact command depends on your target device.
   
   The NAD AVR example provides a DSP version command as shown here on the command line, with its response in the Serial field. If the command echoes back in the TCP Server field, it indicates either an invalid command or a bad connection to the target device.

   

    

Once you have confirmed that you can send commands from the Console - IP to Serial page, you are ready to proceed.

4. Load the Template for the Target Device

You must load a template for the type of device you plan to control.

AVA OS supports a variety of serial devices. Each type of device supported by AVA OS for RS232 / Serial control has a template for the CYP, and a corresponding driver in AVA OS.

Load the template file:

1. Download the device type templates from CYP RS232 Device Templates for Automation.
2. Unzip the templates to a local folder.
3. In the CYP web UI, click the gear icon next to the red logout icon.
4. Under Backup & Restore, go to Macro & Command Configuration and click Restore.

5. Select the template file for the target device’s device type.

   

    

6. After completing the restore, go to Console then Command to verify that a list of commands has been loaded.

Proceed only after the CYP module’s Command page shows the command list for your target device type.

5. Enter the Commands for the Target Device

Configure each command name with the correct serial command according to the target device manufacturer’s specification.

Enter the Serial Commands

1. Go to Console then Command.

2. For each template command that is available on the target device, click the gear icon to edit the command.

   

3. Enter each serial command in the Command field, and set the required End Character, then click Apply.
   Do not change the Name of the command.

   

4. Go to Console > Macro, and use the ⏩ test button to verify each command.

   

Proceed only after entering and testing every command used in the template (unless a command is not supported by the target device).

AVA OS Driver Setup

Assuming that you correctly entered each of the commands for your target device, this final step is fast and easy.

1. From the Installer Settings on an AVA remote or the AVA app, go to Devices.
2. Tap Add Device.

3. Search for “CYP” followed by part of the target device type.

   

4. Select the CYP driver for your target device’s type.
5. Read the driver instructions page, then tap Next.

6. Choose the CYP device from the discovery list.
   If AVA OS does not discover the CYP device on the network, use Enter IP Address.

   

7. Finish adding the device as with any other device driver.

8. The RS232 device can now be used in AVA OS like any other device of the same type.

   

Troubleshooting

Here are some tips for common serial control issues.