Exterity AV Encoder Administrator s Guide
Notices Exterity Limited 2003-2007 This document contains information that is protected by copyright. Reproduction, adaptation, or translation without prior permission is prohibited, except as under the copyright laws. Document Reference 1300-0005-0001 Edition 1.10 Issue 4 (October 2007) Printed in UK Exterity Limited Ridge Way Hillend Industrial Park Dalgety Bay, Fife, KY11 9JD Scotland, UK http://www.exterity.co.uk Disclaimer The information contained in this document is subject to change without notice. EXTERITY LIMITED MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Exterity Limited shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material. Warranty A copy of the specific warranty terms applicable to your Exterity products and replacement parts can be obtained from Exterity. To request more information or parts, email support@exterity.co.uk Safety Notices Before installing and operating these products, please read the safety information in this manual. Products Covered By This Guide isocket AV Encoder idaptor AV Encoder tridaptor AV Encoder Trademarks Microsoft, Windows, and Windows Media Player are U.S. registered trademarks of Microsoft Corporation. in-socket Technology, Digital Simplicity and isocket are trademarks of Exterity Limited. All other trademarks are the property of their respective owners. All rights reserved. 2
Contents Contents...3 Important Safety Instructions...6 USA and Canada...6 EU and Others...7 Safety Information...7 About this Manual...8 Summary...8 Scope...8 Audience...8 Associated documentation...8 Terms and definitions...8 How this manual is organised...9 1 Device Setup...10 Connections...10 Network setup...10 Device Start-up...10 2 General Use...11 Channel Announcement...11 AV Source...11 Stream Output...11 Infra-red control of AV Source...11 3 Management Interfaces...12 IPTV Manager...12 Web Interface...12 Authentication...13 Admin Interface...14 4 Device Management...15 General...15 3
Network Settings...15 IP Address Settings...15 Audio/Video...16 Video interface...16 AV device type...16 AV synch audio shift...16 Audio volume...16 Video Format...16 Stream Properties...17 Stream type...17 Bitrate...17 Multicast Address...17 Ports...17 TTL...18 Channel Announcements...18 Channel number...18 Groups...18 Announce Local Stream...18 Remote Control...19 IR Type...19 Master IR Client...19 Management Settings...19 Web interface authentication...19 Client Access...20 Maintenance...20 TFTP server...20 Restoring factory defaults...20 Restarting the encoder...20 Upgrading the encoder firmware...21 Logging...21 5 Admin Interface...22 Serial connection settings...22 Admin interface pages...22 Main page...22 Show SW version...23 Board revision details...23 Run a shell...23 Network configuration...23 Change admin password...23 Reboot...23 4
6 Troubleshooting...24 APPENDIX A Support and contact information...25 5
Important Safety Instructions There are no instructions specifically for service personnel in this document. There are no user serviceable parts inside any Exterity product. To prevent electric shock or fire hazard, do not remove cover. Refer service to qualified service personnel. This chapter contains important safety information. If you are unsure about any of the information in the section, please contact Exterity. The lightning flash with arrowhead symbol within an equilateral triangle, is intended to alert the user to the presence of uninsulated "dangerous voltage " within the product's enclosure that may be of sufficient magnitude to constitute a risk of electric shock to persons. The exclamation point within an equilateral triangle is intended to alert the user to the presence of important operating and maintenance (servicing) instructions in the literature accompanying the product. USA and Canada 1. Read these instructions. 2. Keep these instructions. 3. Heed all warnings. 4. Follow all instructions. 5. Do not use this apparatus near water. 6. Clean only with dry cloth. 7. Do not block any ventilation openings. Install in accordance with the instructions contained in this manual. 8. Do not install near any heat sources such as radiators, heat registers, stoves, or other apparatus (including amplifiers) that produce heat. 9. Do not defeat the safety purpose of the polarized or grounding-type plug. A polarized plug has two blades with one wider than the other. A grounding type plug has two blades and a third grounding prong. The wide blade or the third prong are provided for your safety. If the provided plug does not fit into your outlet, consult an electrician for replacement of the obsolete outlet. 10. Protect the power cord from being walked on or pinched particularly at plugs, convenience receptacles, and the point where they exit from the apparatus. 11. Only use attachments/accessories specified by the manufacturer. 6
12. Use only with the cart, stand, tripod, bracket, or table specified by the manufacturer, or sold with the apparatus. When a cart is used, use caution when moving the cart/apparatus combination to avoid injury from tip-over. 13. Unplug this apparatus during lightning storms or when unused for long periods of time. 14. Refer all servicing to qualified service personnel. Servicing is required when the apparatus has been damaged in any way, such as power-supply cord or plug is damaged, liquid has been spilled or objects have fallen into the apparatus, the apparatus has been exposed to rain or moisture, does not operate normally, or has been dropped. 15. Do not expose this apparatus to dripping or splashing and ensure that no objects filled with liquids, such as vases, are placed on the apparatus. 16. To completely disconnect this apparatus from the AC Mains, disconnect the power supply cord plug from the AC receptacle. 17. The mains plug of the power supply cord shall remain readily operable. WARNING: To reduce the risk of fire or electric shock, do not expose this apparatus to rain or moisture. EU and Others Do not proceed beyond a WARNING notice until you have understood the hazardous conditions and have taken appropriate steps. Safety Information WARNING: There are no user serviceable parts inside any Exterity product. To prevent electric shock or fire hazard, do not remove cover. Refer service to qualified service personnel. WARNING: For 230/240 volt operation, be sure to use a harmonised grounded 3 conductor cord, rated 6 Amp minimum. Use a suitable cord for connection to the equipment and terminating in an IEC approved plug. This equipment relies upon a safety earth for operation, ensure that you always use a power cord with appropriate earth and that the inlet to which is inserted also has the appropriate earth. If in any doubt about the earth provision in your building consult a qualified electrician WARNING: Use only the dedicated power supply or cord supplied for your device. WARNING: The Exterity products use ventilation holes for cooling. None of the ventilation holes should be blocked. Keep all materials at least 5cm away from all the ventilation holes. WARNING: Do not expose the product to any rain or moisture. WARNING: Do not use the product near a naked flame e.g. a candle. WARNING: The operating conditions of the product should be 0 C-40 C with a Relative Humidity of 5 95%. The product should not be operated outside of these conditions. There are no user-serviceable parts inside these products. Any servicing, adjustment, maintenance, or repair must only be performed by service-trained personnel. 7
About this Manual Summary This manual explains how to set up, use and manage the Exterity AV Encoder (the encoder ). The encoder is a network device which takes an analogue signal from an AV device (e.g. a DVD player or set-top box) and outputs it as an MPEG-2 stream over an IP network. Scope This edition of the manual refers to version 1.10.x of the encoder software. The following products are covered: isocket AV Encoder idaptor AV Encoder tridaptor AV Encoder Audience This manual is intended for use by systems integrators or systems administrators who are installing and setting up Exterity products. The manual assumes that readers are familiar with installing and configuring network-based products. Associated documentation This manual should be used in conjunction with the following documents: idaptor Installation Guide tridaptor Installation Guide Terms and definitions The following terms and definitions are used in this document: DHCP Dynamic Host Configuration Protocol SAP Session Announcement Protocol TFTP Trivial File Transfer Protocol IGMP Internet Group Management Protocol RTP- Real-time Transport Protocol 8
How this manual is organised This manual is organised as follows: Section 1 Device Setup Section 2 General Use Section 3 Management Interfaces Section 4 Device Management Section 5 Admin Interface Section 6 Troubleshooting This section describes basic aspects of setting up your encoder. Please refer also to the product installation guide. This section describes the basic operation of the encoder. You can manage the encoder using the IPTV Manager, web management interface and admin interface. These are described in this section. This section provides detailed information on the configuration options available with the web management interface. This section describes how to use the serial admin interface. Review this section if you are having problems. 9
1 Device Setup The device s default configuration means it will operate out of the box without the use of the management interface. This section describes this basic setup. Connections Please refer to the product installation guide for details on power, network, AV and infra-red connections. The following assumes: 1. The device is powered on. 2. The device is attached to a multicast-enabled network. 3. The network has a DHCP server. 4. The infra-red transmitter is connected (if required). 5. The device is attached to an AV source. Network setup By default, the device requires a DHCP Server to be available on the network to assign it an IP address. Once an IP address is assigned, a static IP address can be configured via the management interface if this is desired; this would allow continued operation without a DHCP Server. Device Start-up When the device starts up, the LED will flash 4 times per second while bringing up the network link and carrying out the DHCP transactions. Once this is complete, the LED will blink once per second if a valid video source is connected. 10
2 General Use Channel Announcement AV Source The device announces its stream (channel) every 30 seconds using the SAP protocol. The information in the announcements enables client (receiver) devices to attach to the stream. SAP announcements are sent to multicast address 239.255.255.255, port 9875. The device starts streaming (transmitting an MPEG stream on the IP network) automatically when an AV source is connected, blinking its LED once per second. If an AV source is not detected the device indicates this by keeping the LED mainly on, blinking off once every two seconds. The device will automatically reboot when the AV source is disconnected or powered off. Stream Output By default the device transmits audio/video as a transport stream over UDP to the multicast address 239.192.x.y, port 49408, where x and y are the last two digits of the device s own IP address. Infra-red control of AV Source The Encoder has the ability to send infra-red remote control commands to the attached AV source. These commands are sent based on commands received over the network from IPTV Manager or an IPTV receiver. To do this it is necessary to obtain a configuration file with the remote control codes for that particular device. This functionality is illustrated in the diagram below where, for example, the remote control handset could be used to play/pause/stop the DVD player. 11
3 Management Interfaces The encoder has three management interfaces as follows: IPTV Manager Web Interface Admin Interface Note that each encoding module in a tridaptor AV Encoder is required to be configured independently. IPTV Manager The IPTV Manager is a Windows application which discovers Exterity devices on the network and uses SNMP to manage a subset of device functionality. It can also be used to start the device web interface as shown below. Note: You can also use a third-party SNMP tool to manage the encoder. Contact Exterity to obtain the Management Information Base (MIB). For more details on managing encoders with the IPTV Manager, see the associated manual. Web Interface You can manage every aspect of the encoder s functionality using the encoder s web management interface. You can display the web management interface using the IPTV Manager as shown above, or by typing the encoder IP address directly into your browser: Use the web management interface as follows: 1. When prompted, enter the correct username and password. The default login details are: Username: admin 12
Password: labrador 2. The web management interface opens in your browser: 3. Navigate through the tabs, changing settings as appropriate. Click Apply on each tab to save your changes. Section 4 Device Management describes the web management interface options in detail. Authentication You can control access to the web management interface by changing the login. To allow access to all users, click on the Authentication tab and select Allow Web Access to All Users. To allow access only to certain users by setting a password: 1. Click on the Authentication tab. 2. Select Authenticate Web Access. 3. Specify a password and click Apply. 13
Admin Interface In certain circumstances it may not be possible to manage an encoder via its web interface. For these situations a text based admin interface is provided which is available via the serial interface (marked admin on the rear panel of the unit) or via telnet. For details on use of the admin interface, see Section 5 - Admin Interface. 14
4 Device Management This section of the manual describes how to manage the encoder using the web management interface. All procedures described in this section assume that you are running the web management interface, as described in Section 3 Management Interfaces. Note: When making changes using the web management interface, click Apply to save your changes on each tab before moving to another tab, otherwise your changes will be lost. General The General tab displays hardware and software information about the device you are using and allows you to name the device and its location. To specify a name for the device: Enter the name into the Name box and click Apply. The name you specify is used to identify the device on a management station. To specify a location for the device: Type the name of a location into the location folder and click Apply. The location you specify is used by the IPTV Manager to organise devices into folders. For example, if you specify Group 1, the device appears in Location\Group 1 in the IPTV Manager. Network Settings IP Address Settings You can configure the encoder to obtain an IP address automatically using DHCP, or you can specify static addressing information, such as IP address, subnet mask and default gateway. Note: Changes to IP addressing do not take place until after the device has restarted. To configure the device to be allocated an IP address automatically: 1. Click on the Network tab. 2. Click Obtain an IP Address automatically. To configure a static IP address: 1. Click on the Network tab. 2. Click Use the properties below. 3. Specify values for IP Address, Subnet Mask, Default Gateway. 4. Click Apply. 15
Audio/Video Video interface Video Interface sets the type of video input to the device. Valid settings are Composite, RGB and S-Video. This should be set to match the type of video output from the attached AV source. To specify the video interface: 1. Click on the AV Config tab. 2. Choose an option from the Video Interface box. AV device type Set this to match the type of video source connected to the Encoder. The default setting is appropriate for most source types, but ensure that this setting is configured correctly if connecting a VCR to the Encoder. If the AV device type is set incorrectly, this can result in the Encoder being unable to lock onto the video signal. To specify the AV device type: 1. Click on the AV Config tab. 2. Choose an option from the AV Device Type box. AV synch audio shift This setting allows the lip synchronisation of the stream to be fine-tuned. A negative setting moves the audio earlier in comparison to the video, while a positive value moves the audio later. The default value of -150ms should be appropriate for most client devices, but it may on occasion be necessary to alter this setting to get better lip synchronisation. Valid values range from -250ms to 250ms. To specify the AV synch audio shift: 1. Click on the AV Config tab. 2. Enter a value between -250 and 250 in the AV synch audio shift box. Audio volume This setting allows the volume of the audio stream to be controlled. Valid values range from 0 (min volume) to 31 (max volume), with a default value of 26. Note: This setting is not available on earlier versions of the Encoder hardware. To specify the audio volume: 1. Click on the AV Config tab. 2. Enter a value between 0 and 31 in the Audio Volume box. Video Format The Encoder detects the format of the video, and supports PAL, NTSC or black and white input. The detected format is reported by the web interface in the AV Config page. 16
Stream Properties Stream type The device can be configured to send its stream in the following formats: Transport Stream/UDP, Transport Stream/RTP, Elementary Stream/RTP or Audio-only Elementary Stream/UDP. To specify the stream type: 1. Click on the Stream Props tab. 2. Choose an option in the Stream Type box. Bitrate When transmitting a transport stream, the device can be configured to send its stream with constant bitrate (CBR) or variable bitrate (VBR), and the rate at which this stream is sent can be set from 1.5Mbps to 14Mbps. The default setting is 4Mbps CBR. For best picture quality use CBR with a bitrate as high as the receiving devices can cope with (approx 8Mbps for Exterity IPTV Receivers). For best use of bandwidth use VBR and/or a lower bitrate, although this will result in degradation of picture quality. To specify the bitrate type: 1. Click on the Stream Props tab. 2. Choose an option in the Bitrate Type box. To specify the bitrate: 1. Click on the Stream Props tab. 2. Enter a value in kbps in the Bitrate Value box. Multicast Address By default the Encoder sends its stream addressed to the multicast address 239.192.x.y, where x and y are the last two digits of the device s own IP address. However, the multicast address can be changed as desired by the administrator. To specify the multicast address: 1. Click on the Stream Props tab. 2. Enter an address in the Multicast Address box. Ports By default, the stream is sent to the UDP port 49408 (with 49406 also used for the audio part of the stream if elementary streams are being used). The port(s) can be altered by the administrator as desired. To specify the ports: 1. Click on the Stream Props tab. 2. Enter values in the Video Port and Audio Port boxes. 17
TTL By default, the stream is transmitted with an IP TTL of 7. The TTL can be set to any value between 0 and 255 to allow operation across different network topologies. To specify the TTL: 1. Click on the Stream Props tab. 2. Enter a value between 0 and 255 in the TTL box. Channel Announcements The Encoder uses SAP (Session Announcement Protocol) to announce its stream (channel) to receiving devices. Included in the announcements are the name of the Encoder and the multicast address and port on which the stream is sent. The following options allow some additional information to be put into the announcements. Channel number The channel number will be used by Exterity IPTV receivers to produce an ordered list of channels. To specify the channel number: 1. Click on the Server Props tab. 2. Enter a value between 0 and 999 in the Channel Number box. Groups The available channels across a network of Exterity devices can be split into groups e.g. Sport, Children, Adult, allowing the administrator to configure receiving devices to receive only a subset of available channels. By default, an Encoder announces itself in the all group. Use the groups option to put the device into one or more specific groups. To add the device to a group: 1. Click on the Groups tab. 2. Check the box Add device to new group. 3. Enter a group name in the Add device to new group box. 4. Click Update Group Membership. To remove the device from a group: 1. Click on the Groups tab. 2. Un-check the box next to the group you want to remove. 3. Click Update Group Membership. To remove the device from every group: 1. Click on the Groups tab. 2. Un-check the box next to every group you want to remove. 3. Check the box next to all. 4. Click Update Group Membership. Announce Local Stream This option allows the administrator to turn on/off channel announcements. 18
To configure the announcement setting: 1. Click on the Server Props tab. 2. Check or un-check the Announce Local Stream box as appropriate. Remote Control In order to use the infra-red transmitter to control the AV source, it is necessary to obtain a configuration file with the remote control codes for that particular device. Contact your Systems Integrator or Reseller in order to obtain a configuration file. IR Type To download an IR config file: 1. The device uses TFTP to download new remote control config files from a TFTP server. To update the config file, first ensure that the correct TFTP server IP address is specified in the Maintenance page, and that the TFTP server is running. 2. Save the configuration file in the following directory on the TFTP server. <root>/remotes/<manufacturer>/<type>/<manufacturer>_<type>_<id>.conf For example: <root>/remotes/sony/dvd/sony_dvd_1.conf 3. Click on the Server Props tab. 4. Enter the name of the configuration file in the IR Remote Type box. 5. Click Apply. The new configuration file is downloaded automatically from the TFTP server. Master IR Client By default, any device on the network can send remote control commands to the Encoder. To allow only one device to do this, configure that device as the Master IR Client. To specify the master IR client: 1. Click on the Server Props tab. 2. Enter an IP address in the Master IR Client box. To remove the master IR client: 1. Click on the Server Props tab. 2. Enter 0.0.0.0 in the Master IR Client box. Management Settings Web interface authentication By default, a username/password pair of admin/labrador is required to gain access to the web interface. The username/password can be changed, or alternatively authentication can be turned off altogether. To allow access to all users, click on the Authentication tab and select Allow Web Access to All Users. To allow access only to certain users by setting a password: 1. Click on the Authentication tab. 19
2. Select Authenticate Web Access. 3. Specify a password and click Apply. Client Access The client table enables the Encoder to permit/deny clients access to its stream. Use the table to add a list of clients which will be permitted or denied; all other clients will be denied or permitted as appropriate. The default setting is an empty table, and to deny access to clients in the table i.e. all clients are permitted. Note: This functionality is disabled unless Elementary Streams are in use. Maintenance This section describes various maintenance tasks. It covers: Setting the TFTP server Restoring the encoder to factory default settings Rebooting the encoder Upgrading the encoder s firmware Controlling remote logging TFTP server The device uses TFTP to download new firmware releases and remote control configuration files. For this to operate correctly, the device must be configured with the IP address of the TFTP Server on the network. To specify a TFTP server IP address: 1. Click on the Maintenance tab. 2. Enter the IP address of the TFTP server in the TFTP Server box. Restoring factory defaults You can return the encoder to its factory default configuration. Note: If you restore the encoder to factory default settings, you will lose all previously saved settings. To restore the encoder factory default settings: 1. Click on the Maintenance tab. 2. Select the Return to Factory Defaults check box. Restarting the encoder You can restart the encoder at any time. To restart the encoder, click on the Maintenance tab, select Reboot and click Apply. 20
Upgrading the encoder firmware By upgrading the encoder s firmware regularly, you can ensure that you are always using the most recent encoder software. WARNING: Do not switch the encoder off while the upgrade process is running. The process takes several minutes, during which time the LED flashes slowly. To upgrade the encoder to a new version of firmware: 1. Click on the Maintenance tab. Ensure that the encoder is using the correct TFTP server address. 2. Ensure that the following firmware files are hosted correctly in the root directory of the TFTP server: isocket.bin isocketapps.bin 3. Ensure that the TFTP server is running. 4. Select Upgrade Firmware. 5. Click Apply. The firmware files will be downloaded from the TFTP server, and the device will be upgraded. This process will take several minutes. Logging You can compile and store files that provide encoder logging information. These files can be used to view historical information about encoder activity. To save device log information to a remote server, you need to install a syslog server, such as the Kiwi Enterprises Syslog Daemon. The log file can also be viewed through the management interface without the need for a syslog server. To configure remote logging: 1. Click on the Logging tab. 2. Select Local and Remote Logging. 3. In Syslog server, enter the IP address or host name of the syslog server where the log files are to be stored. 4. In Syslog port, enter the port number on the syslog server. The default value is 514. 5. For Remote logging level, select an option ranging from 0-Emergency to 7-Debug, where 0 represents the least debug information and 7 represents the most. 6. Click Apply. To view the log file: 1. Click on the Logging tab. 2. Click the Show log button, resulting in the log being displayed in a new browser window. 21
5 Admin Interface In certain circumstances it may not be possible to manage an encoder via its web interface. For these situations a text based admin interface is provided which is available via the serial interface (marked admin on the rear panel of the unit) or via telnet. Serial connection settings The serial connection is the RJ45 connector on the device marked admin. The serial port settings required are as follows: Baud rate: 115200 Data bits: 8 Parity: none Stop bits: none Flow control: none To login use username admin and password as for the web interface (default labrador). Admin interface pages Main page When successfully logged in, the main page is displayed as shown below idaptor AV Server Admin Program 1) Show SW version 2) Show board revision details 3) Run a shell 4) Network configuration 5) Change admin password 6) Reboot 7) Exit 22
Show SW version This page displays the version details of the currently running firmware Board revision details This page displays the type and revision of the device, as well as its serial number. Run a shell This allows the administrator to run a shell as admin. Network configuration These pages display the IP addressing information of the device. They also allow the administrator to set the IP address of the device. Change admin password Allows the administrator to change the admin password for the serial and web interfaces Reboot Reboots the device. 23
6 Troubleshooting Problem Possible Cause Solution Device does not appear in IPTV Manager IPTV Manager cannot communicate with device Encoder does not appear to be streaming (indicated by LED mainly on, blinking off once every two seconds). Device is definitely streaming but client (Receiver) cannot connect to stream Network connection faulty or cannot obtain IP address (indicated by LED flash four times per second) PC has firewall configured, blocking SNMP traps. PC has another application listening for SNMP traps. Network connection faulty Device has an IP address on a different subnet to the management station Device is upgrading (indicated by slow uneven LED flash) AV source not connected or powered off. Video interface setting wrong. The cabling is incorrect e.g. some SCART phono converter cables are unidirectional. Incorrectly configured client list. Check Ethernet connections or replace cable. Check that DHCP Server is running on network. Disable firewall, or open UDP port 162. Close down SNMP trap listener. See above Use a management station configured with an appropriate IP address to manage the device. Wait for upgrade to complete Check connections and power to AV source. Check video interface settings on Encoder and AV device are the same. Check cabling. Check switch on SCART phono converter cable. Check client list is configured correctly. Device continuously reboots AV Device type is wrong. Power off AV source, allowing access to management interface to check AV device type. The version number of the device is 65535.255.255 or similar. After upgrade, the device is still running the old version of firmware. The upgrade process failed. The correct firmware files are not on the TFTP Server. The TFTP Server address configured for the device is wrong The TFTP Server is not running. The TFTP Server is not configured to send files. Ensure that the isocket,bin and isocketapps.bin on the TFTP Server are both from the correct release and try to upgrade again. Put the correct files on the TFTP Server. Check that the TFTP Server address is the address of the machine the TFTP Server is running on. Start the TFTP Server. Fix the security settings on the TFTP Server. 24
APPENDIX A Support and contact information Technical Support for Exterity products is provided by authorised Systems Integrators and Resellers. Please contact your Systems Integrator or Reseller with any Support issues. 25