Releases · Lawo/ember-plus · GitHub
Welcome to Sonifex - Manufacturers of Broadcast Audio & Video Equipment for Radio & TV Studiossonifex.co.uk/registerWelcome to Sonifex - Manufacturers of Broadcast Audio & Video Equipment for Radio & TV Studios
Instruction Manual for Sonifex models including: AVN-DIO10 Audiophile Interfaces AVN GPIO LAN Transceiver, Audiophile Interfaces AVN GPIO LAN Transceiver, Interfaces AVN GPIO LAN Transceiver, GPIO LAN Transceiver, LAN Transceiver, Transceiver
Sonifex AVN-GPIO GPIO to LAN Transceiver (PTP, EMBER & UDP)
File Info : application/pdf, 16 Pages, 4.48MB
DocumentDocumentHANDBOOK Audiophile Interfaces AVN-GPIO GPIO to LAN Transceiver Manufacturers of Audio Products for AV, Installed Sound, Broadcast Radio & Broadcast TV AVN-GPIO Handbook Registration & Warranty For the latest Sonifex handbook information please visit the Sonifex website at www.sonifex.co.uk This handbook is for use with the following products: AVN-GPIO GPIO to LAN Transceiver Artwork: AW011097 © Sonifex Ltd, 2024 All Rights Reserved Revision 1.02, April 2024 Sonifex Ltd, 61, Station Road, Irthlingborough, Northants, NN9 5QE, England. Tel: +44 (0)1933 650 700 Email: sales@sonifex.co.uk Website: https://www.sonifex.co.uk Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor. Sonifex Ltd shall not be liable for any loss or damage whatsoever arising from the use of information or any error contained in this manual. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, information storage and retrieval systems, for any purpose other than the purchaser's personal use, without the express written permission of Sonifex Ltd. Unless otherwise noted, all names of companies, products and persons contained herein are part of a completely fictitious adaptation and are designed solely to document the use of Sonifex product. Made in the UK by Register Online for an Extended 2 Year Warranty Product: Serial No: www.sonifex.co.uk/register Product Warranty - 2 Year Extended As standard, Sonifex products are supplied with a 1 year back to base warranty. In order to register the date of purchase and so that we can keep you informed of any product design improvements or modificaons, it is important to complete the warranty registraon online. Addionally, if you register the product on the Sonifex website, you can increase your product warranty to 2 years. Go to the Sonifex website at: www.sonifex.co.uk/register to apply for your 2 year warranty. Sonifex Warranty & Liability Terms & Conditions 1. Definitions `the Company' means Sonifex Ltd and where relevant includes companies within the same group of companies as Sonifex Limited. `the Goods' means the goods or any part thereof supplied by the Company and where relevant includes: work carried out by the Company on items supplied by the Purchaser; services supplied by the Company; and soware supplied by the Company. `the Purchaser' means the person or organisaon who buys or has agreed to buy the Goods. `the Price' means the Price of the Goods and any other charges incurred by the Company in the supply of the Goods. `the Warranty Term' is the length of the product warranty which is usually 12 months from the date of despatch; except when the product has been registered at the Sonifex website when the Warranty Term is 24 months from the date of despatch. `the Contract' means the quotaon, these Condions of Sale and any other document incorporated in a contract between the Company and the Purchaser. This is the enre Contract between the pares relang to the subject maer hereof and may not be changed or terminated except in wring in accordance with the provisions of this Contract. A reference to the consent, acknowledgement, authority or agreement of the Company means in wring and only by a director of the Company. 2. Warranty a. The Company agrees to repair or (at its discreon) replace Goods which are found to be defecve (fair wear and tear excepted) and which are returned to the Company within the Warranty Term provided that each of the following are sasfied: i. noficaon of any defect is given to the Company immediately upon its becoming apparent to the Purchaser; ii. the Goods have only been operated under normal operang condions and have only been subject to normal use (and in parcular the Goods must have been correctly connected and must not have been subject to high voltage or to ionising radiaon and must not have been used contrary to the Company's technical recommendaons); iii. the Goods are returned to the Company's premises at the Purchaser's expense; iv. any Goods or parts of Goods replaced shall become the property of the Company; v. no work whatsoever (other than normal and proper maintenance) has been carried out to the Goods or any part of the Goods without the Company's prior wrien consent; vi. the defect has not arisen from a design made, furnished or specified by the Purchaser; vii. the Goods have been assembled or incorporated into other goods only in accordance with any instrucons issued by the Company; viii. the defect has not arisen from a design modified by the Purchaser; ix. the defect has not arisen from an item manufactured by a person other than the Company. In respect of any item manufactured by a person other than the Company, the Purchaser shall only be entled to the benefit of any warranty or guarantee provided by such manufacturer to the Company. b. In respect of computer soware supplied by the Company the Company does not warrant that the use of the soware will be uninterrupted or error free. c. The Company accepts liability: i. for death or personal injury to the extent that it results from the negligence of the Company, its employees (whilst in the course of their employment) or its agents (in the course of the agency); ii. for any breach by the Company of any statutory undertaking as to tle, quiet possession and freedom from encumbrance. 2 AVN-GPIO Handbook d. Subject to condions (a) and (c) from the me of despatch of the Goods from the Company's premises the Purchaser shall be responsible for any defect in the Goods or loss, damage, nuisance or interference whatsoever consequenal economic or otherwise or wastage of material resulng from or caused by or to the Goods. In parcular the Company shall not be liable for any loss of profits or other economic losses. The Company accordingly excludes all liability for the same. e. At the request and expense of the Purchaser the Company will test the Goods to ascertain performance levels and provide a report of the results of that test. The report will be accurate at the me of the test, to the best of the belief and knowledge of the Company, and the Company accepts no liability in respect of its accuracy beyond that set out in Condion (a). f. Subject to Condion (e) no representaon, condion, warranty or other term, express or implied (by statute or otherwise) is given by the Company that the Goods are of any parcular quality or standard or will enable the Purchaser to aain any parcular performance or result, or will be suitable for any parcular purpose or use under specific condions or will provide any parcular capacity, notwithstanding that the requirement for such performance, result or capacity or that such parcular purpose or condions may have been known (or ought to have been known) to the Company, its employees or agents. g. i. To the extent that the Company is held legally liable to the Purchaser for any single breach of contract, tort, representaon or other act or default, the Company's liability for the same shall not exceed the price of the Goods. ii. The restricon of liability in Condion (g)(i) shall not apply to any liability accepted by the Seller in Condion (c). h. Where the Goods are sold under a consumer transacon (as defined by the Consumer Transacons (Restricons on Statements) Order 1976) the statutory rights of the Purchaser are not affected by these Condions of Sale. Unpacking Your Product Each product is shipped in protecve packaging and should be inspected for damage before use. If there is any transit damage take pictures of the product packaging and nofy the carrier immediately with all the relevant details of the shipment. Packing materials should be kept for inspecon and also for if the product needs to be returned. The product is shipped with the following equipment so please check to ensure that you have all of the items below. If anything is missing, please contact the supplier of your equipment immediately. CE and UKCA conformity The products in this manual comply with the essenal requirements of the relevant UK and European health, safety and environmental protecon legislaon. The technical jusficaon file for this product is held at Sonifex Ltd. Relevant declaraons of conformity can be found at: hps://www.sonifex.co.uk/declaraons WEEE Directive Direcve 2012/19/EU of the European Parliament and of the Council of 4th July 2012 lays down measures to protect the environment and human health by prevenng or reducing the adverse impacts of the generaon and management of waste from electrical and electronic equipment (WEEE). The policy of Sonifex Ltd is to comply with all applicable laws of all jurisdicons having authority over Sonifex's business, including the WEEE direcve. Accordingly, Sonifex has implemented a rigorous program designed to ensure compliance of its products with the WEEE direcve. The latest statements can be found at: hps://www.sonifex.co.uk/company/recycling Atmosphere/Environment This apparatus should be installed in an area that is not subject to excessive temperature variaon (<0°C, >50°C), moisture, dust or vibraon. This apparatus shall not be exposed to dripping or splashing, and no objects filled with water, such as vases shall be placed on the apparatus. Item Product Unit Quanty 1 Repairs & Returns Please contact Sonifex or your supplier if you have any problems with your Sonifex product. Email technical.support@sonifex.co.uk for the repair/ upgrade/returns procedure, or for support & quesons regarding the product operaon. 3 AVN-DIO09 Handbook Contents Product Warranty - 2 Year Extended Sonifex Warranty & Liability Terms & Condions 1. Definions 2. Warranty Unpacking Your Product Repairs & Returns Conformity Safety & Installaon of Equipment WEEE Direcve Atmosphere/Environment 1. Introducon 2. Overview 3. Embedded Web Server Accessing the Web Server Help Device Informaon Device ID Host Name Friendly Name Serial Number Firmware Version DC Voltage PoE Voltage System Up Time Control Port Informaon Hardware Address Actual IP Address Actual Subnet Mask Addressing Mode Network Device Name & Security Friendly Name Password Removing Password Protecon HTTP Port Control Port Sengs Address Mode Stac IP Address Stac Subnet Mask i PTP 8 PTP General 8 i Event DSCP 8 i General DSCP 8 i TTL 9 iii Acve PTP Profile 9 iii Acve Profile 9 iii PTP Profile Configuraon 9 iii Profile 9 iv Delay Mechanism 9 iv Announce Interval 9 6 6 Announce Receipt Timeout Sync Interval Minimum Delay Request Interval 9 9 9 7 Minimum Peer Delay Request Interval 9 7 Priority One 9 7 Priority Two 9 7 PTP Domain 9 7 Slave Only 9 7 PTP Info 9 7 Port State 9 7 Master ID 9 7 Offset 9 7 Date 9 7 Time 9 7 Offset Chart 9 7 Time 9 7 Time Sengs 9 7 Display Time 9 7 Local Offset 9 7 DST Opons 9 8 Enable DST 9 8 DST Begin 9 8 DST End 9 8 DST Offset 9 8 GPIO 10 8 Input/Output Icons 10 8 Links 10 8 Adding Inputs 10 8 Physical Inputs 10 8 Normal Mode 10 4 Event Mode 10 Virtual Inputs 11 Adding Ouputs 11 Physical Outputs 11 Normal Mode 11 Trigger Mode 11 Virtual Outputs 12 Relay Outputs 12 Power 12 DC Output Source 12 System 12 Update Firmware 12 Reboot or Factory Reset 12 4. UDP Commands 13 5. Bootstrap Mode 13 Forcing Bootstrap Mode 13 Upgrading Firmware in Bootstrap mode 13 6. Maximum Cable Length Tesng 13 7. Technical Specificaons 14 AVN-DIO09 Handbook 5 AVN-GPIO Handbook AVN-GPIO Interface The AVN-GPIO unit is part of the DIO range of products which provide a convenient and elegant method of connecng legacy GPIO equipment to a network. 1. Introducon The AVN-GPIO is part of the AVN range of network interface boxes, which converts GPIO (General Purpose Inputs & Outputs) to network commands to control, and be controlled by, other equipment or soware across a standard network. There are also two `normal' GPIOs. When normal GPIOs are configured as inputs they can be set to either momentary or latching mode. When setup as outputs, they pull the signal on the GPO pin down to ground when acve. The AVN-GPIO has a voltage free relay contact that can be used to operate external equipment, and also provides 6 x DC output voltage pins that can be used to power external equipment such as signage and various sensors and actuators. When powered via PoE (Power over Ethernet) the AVN-GPIO outputs 12V at 300mA total on these pins. When powered via the DC input the AVN-GPIO provides 1A total on these pins and the voltage follows the DC input. The DC outputs are fused to prevent drawing more current than the device can provide and these fuses are automacally reset when the device is power cycled. On one side of the device is the 24-pin Phoenix style terminal block, the pinout for this connector can be seen in the image and table below. 2 Overview It has 10 configurable GPIO's, 8 of which can be used for PTP based programming, together with a relay. It provides virtual GPIO that allow the device to trigger or be triggered by other Sonifex devices on the network using virtual GPIO without the need for extra wiring (virtual GPIO communicaon occurs via the Ethernet connecon). The AVN-GPIO is a PTP (Precision Time Protocol) enabled GPIO device. IEEE1588-2008 PTPv2 is used to keep a hardware clock in sync with a PTP master, such as the AVN-GMCS Grandmaster Clock, to achieve a sub 10ns synchronisaon to the master reference. This means that the AVN-GPIO can be used to accurately mestamp input events and to trigger outputs at configured mes. The AVN-GPIO supports Default and AES67 Media profiles, and also provides a Custom profile which can be configured by the user. It is housed in a rugged aluminium box with side slots for screw-mounng and is powered by PoE (Power over Ethernet). The device is configured via a built-in webserver. This allows the configuraon of PTP as well as live monitoring of its status. A GPIO roung webpage is provided which allows physical, and virtual inputs to be routed to physical, virtual, and relay outputs. The AVN-GPIO provides a simple UDP messaging system that allows other devices on the network to query the device status informaon, for example to retrieve the me at which a change in input occurred. Custom applicaons can also be wrien to query this informaon via UDP. The device has 8 PTP enabled GPIOs - when used as inputs these can detect rising and falling edges and will generate a mestamp synced to the hardware PTP clock. This means that the recorded mestamps will be synced within 10ns of the PTP master in a correctly setup system. When setup as outputs, a signal can be generated precisely at a me chosen by you and the me at which the output toggles can be configured down to the nanosecond. Alternavely, these med GPIOs can be configured to act as `normal' GPIOs depending on your applicaon. +12V DC GPIO7 GPIO8 GROUND +12V DC GPIO9 GPIO10 GROUND RELAY NC +12V DC RELAY WIPER RELAY NO +12V DC GPIO1 GPIO2 GROUND +12V DC GPIO3 GPIO4 GROUND +12V DC GPIO5 GPIO6 GROUND 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 NC stands for Normally Closed, the default pin the relay wiper is connected to. NO stands Normally Open, the pin the relay wiper will connect to when acve. The device has 1 relay and 10 general-purpose I/Os. The 10 general-purpose I/Os can be configured as inputs or outputs. When configured as an input (acve low), the input is acve (on) when the pin is pulled to ground. When not pulled to ground the input is inacve (off). When the input pin is below 0.6V the input is acve (on), when the input pin is above 2.3V the input is inacve (off). There is an internal 3.3V pull-up so it is not required that the user provide a voltage on the input pin to turn it off, the pin can be le floang. The outputs are open-drain pulling the output pin to ground when acve. Each open collector output can sink 100mA maximum. If more current is required, the user can use the open collector output to turn on an external relay (max 24V) that is capable of passing higher currents. Fig 1-1: AVN-GPIO Front and Rear View 6 The AVN-GPIO has DC outputs, as seen in the pin-out diagram, which can be sourced from (selectable via the web UI): · System DC: this is derived from either the PoE (12V) or the supervised DC input (4 - 24V) and provides a DC output that is fused at 300 mA. · DC Input: this is derived from the supervised DC input only (4-24V) and provides a DC output that is fused at 1A. On the other side of the device there is an Ethernet port, which can be used to provide the device with PoE, and provides network connecvity allowing the device to be configured via a web browser. There is a 2.5mm locking DC inlet (Max 24V DC) which allows you to provide an alternave power source. Two status LEDs are to the top-le and top-right of the Ethernet port: the top-le LED is illuminated red when power is supplied to the device, this turns orange when a link is established. The top-right LED is illuminated green when a 100Mbps link is established, this LED is off when a 10Mbps link is established. Below the Ethernet port is the reset buon which can be used to reset the device or put the device into bootstrap mode. For more informaon on the bootstrap mode see the secon Bootstrap Mode. AVN-GPIO Handbook Help When browsing the web UI, a queson mark in a widget can be pressed to display useful help informaon. The Informaon page shows useful status informaon about the device. 3 Embedded Web Server The embedded web server can be accessed via a web browser and is the main interface for configuring, monitoring, and updang the AVN-GPIO. Accessing the Web Server 1. Connect the AVN-GPIO and your computer to the same network. 2. Ensure that the network interfaces for both devices are configured within the same IP address range. 3. Type the AVN-GPIO's IP address into the address bar of your web browser. By default, the AVN-GPIO has a stac IP address which is 192.168.0.100 with a subnet mask of 255.255.255.0. Therefore, your computer's network interface will need to be configured in the same range. For example an IP address 192.168.0.101, with a subnet mask of 255.255.255.0. The AVN-GPIOs network interface can be configured via the embedded web server and changed to a more suitable address if necessary. In the case that the IP address is unknown, the acve IP address for the network port can be found using the Sonifex Service Discovery tool, available here: hp://sonifex.co.uk/technical/soware/index.shtml#sfxsrvdisc Device Informaon Device ID Displays the type of device. Host Name Unique device name displayed on a network which can be used to access the web UI, for example with a hostname of avn-gpio-000002 you can type avn-gpio-000002.local into the address bar to access the devices web UI. Friendly Name User configurable name displayed on the web UI and virtual output adversements. Serial Number Unique device number provided by Sonifex. Firmware Version The version of firmware on the unit. The latest firmware version can be found on the Sonifex website. DC Voltage Indicates whether the DC supply is present or missing. PoE Voltage Indicates whether the PoE (Power over Ethernet) supply is present or missing. System Up Time Displays the me since the device was powered on. Control Port Informaon Hardware Address A unique MAC address provided by Sonifex. Actual IP Address The current IP address. Actual Subnet Mask The current subnet mask. Addressing Mode The current address mode, either stac or dynamic. 7 AVN-GPIO Handbook Network The network page shows the current configuraon of the control port which is used to access the device's web server. The friendly name and security opons can also be set here. Stac Subnet Mask This is the subnet mask that will be used for the port when stac address mode is selected. This value is not used when the address mode is dynamic. Stac Gateway This is the router IP address that will be used for the port when stac address mode is selected. Note If any of the network configuraon opons are changed, the unit will automacally restart to implement the new sengs. If the address mode of the control port is changed, a new connecon will need to be made once the unit has restarted and the IP address assigned via DHCP is known. Otherwise, the new page will be reloaded automacally once the restart of the unit is complete. Device Name & Security Friendly Name The friendly name idenfies the unit on the network. It is a good idea to assign a user name or locaonwhich is easily recognised by other users. The default friendly name is a combinaon of the device ID and the 7-digit product serial number, for example AVN-GPIO-1234567. The friendly name can only contain leers, numbers and hyphens but can not start or end with a hyphen. PTP The PTP (Precision Time Protocol) page displays informaon on the current PTP configuraon and status. PTPv2 is used to keep the AVN-GPIO's hardware clock in sync with a PTP master, such as the AVN-GMCS Grandmaster Clock, to achieve a sub 10ns synchronisaon to the master reference. This means that the AVN-GPIO can be used to accurately mestamp input events and to trigger outputs at configured mes. Password In order to prevent other users connected to the same network from modifying the configuraon of the device, it is possible to protect your device with a password. The password may be between 4 and 8 characters long and may only contain numbers and leers. Removing Password Protecon Password protecon can be removed from a device by clearing both the `Password' and `Retype Password' fields and clicking `Submit'. HTTP Port The HTTP port number can be set to any integer from `1024' up to and including `65535', or to `80' the default value. The value entered determines which port the web server on the device will use. When the port number is modified the unit will be restarted automacally. To view the web pages of a device with a modified port number, the port number must be specified in the address bar of the web browser aer the IP address and separated by a colon. For example, if the HTTP port of a unit is set to `1024' and the IP address of the unit is `192.168.0.100' then `hp://192.168.0.100:1024' would need to be entered into the address bar of the web browser. When the port is set to its default value of `80' a port number doesn't need to be specified when accessing the web server. The web server on the unit is adversed as an Avahi/Bonjour service so tools like Sonifex Service Discovery or avahi-browse will be able to discover the address and port number being used by the web server on the unit. Control Port Sengs Address Mode The address mode determines how the port obtains its IP address. When set to dynamic, the unit will aempt to acquire an IP address automacally from either a DHCP server or via auto configuraon if no DHCP server is found. The actual IP address will be shown on the device informaon page. When stac mode is used, the IP address and subnet mask values entered will be assigned to the port. Stac IP Address This is the IP address that will be assigned to the port when stac address mode is selected. It is important to ensure that this IP address is not currently in use on the network. This value is not used when the address mode is dynamic. PTP General Event DSCP Time crical PTP messages should be sent with a higher packet priority. Event messages include sync, delay request, peer delay request, and peer delay response messages. General DSCP These PTP messages are not mestamped. General messages include follow up, delay response, peer delay response follow up, announce, management, and signalling messages. 8 AVN-GPIO Handbook TTL Sets the Time to Live for PTP packets. This is the maximum number of hops a PTP packet can perform before being removed from the network. Acve PTP Profile Acve Profile The PTP profile that is currently acve. PTP profiles provide flexibility for different applicaons. Profile Configuraon Profile The PTP profile to be configured. Delay Mechanism The End-to-End (E2E) mechanism is the default opon and delay measurement messages are sent from the master to the slave. The Peer-to-Peer (P2P) mechanism should only be used on networks in which all switches are guaranteed to be IEEE 1588 capable - delay measurement messages are sent between peers providing beer ming accuracy. Announce Interval The me in seconds between announce messages being sent when in master mode. Offset When this device is a slave, this indicates the current difference in nanoseconds between this devices clock and the master's clock. The closer the difference is to zero the beer. Date The current date this devices PTP clock is set to. This device is normally a slave to a GPS enabled GM allowing an accurate date to be shown. Time The current me this devices PTP clock is set to. This device is normally a slave to a GPS enabled GM allowing an accurate me to be shown. Offset Chart This chart shows how the offset value previously menoned changes over me. This value should gradually move towards zero. Time The me page allows the me displayed throughout the device to be configured. The display me is used by: · The PTP page to display the current date and me. · The GPIO page to display the me at which an event occurred. · The GPIO page to configure the me at which a trigger will become acve. · In UDP messages when reporng the me at which an event occurred. Announce Receipt Timeout When in slave mode the number of missed announce messages before the device announces itself to the network, in an aempt to determine the new master device. Sync Interval The me in seconds between sync messages when in master mode. Minimum Delay Request Interval Configurable when the E2E delay mechanism is selected. The minimum me to wait between sending delay request messages in slave mode. Minimum Peer Delay Request Interval Configurable when the P2P delay mechanism is selected. The minimum me to wait between sending peer delay request messages in slave mode. Priority 1 Used by the Best Master Clock Algorithm (BMCA) to help determine the new Grand Master (GM). The device with the lowest priority 1 value will become the GM, this is normally set to 128 for master capable devices. Priority 2 If two devices have the same priority 1, clock class, clock accuracy and clock variance values, the priority 2 field is used to determine the GM. The lower value wins. PTP domain There may be mulple PTP domains on a network, set this value to determine which domain to join. Slave Only Ensure that the device remains in slave mode and never becomes a master device. PTP Info Port State Indicates whether the PTP state of the device, for example master, slave, or listening. Master ID When in slave mode indicates the ID of the PTP master the device is slave to. When in master mode this devices ID is displayed. Time Sengs Display Time Select between Internaonal Atomic Time (TAI), Coordinated Universal Time (UTC), and local me: · TAI is a connuous scale of me without leap seconds. · UTC is the primary me standard used around the world and includes leap seconds. · Local me can be used in conjuncon with an offset to display the local me, in this mode Daylight Saving Time (DST) can also be applied. Local Offset Use this opon to provide the offset required to set the local me, for example +1 hours in Germany. DST Opons Enable DST Allows Daylight Saving Time to be configured. DST Begin Determine the start date at which the DST offset will be applied for example Sun, Mar 26, 2023 1:00 AM for the UK in 2023. DST End Determine the end date at which the DST offset will be removed for example Sun, Oct 29, 2023 2:00 AM for the UK in 2023. DST Offset The hours and minutes to offset the me by when DST is acve (between the begin and end dates) for example 1 hour for the UK in 2023. 9 AVN-GPIO Handbook GPIO The GPIO page can be used to configure and monitor the inputs and outputs of the device. Adding Inputs Inputs can be added by pressing the add buon next to `INPUTS'. A new window tled `Add Input' will be displayed. The input type can be selected here - the input can be one of the following: · Physical An input driven physically by pulling the physical pin high or low. · Virtual An input driven over the network by another device. Inputs are shown to the le of the grid and outputs are shown above the grid. Clicking on a box between an input and an output creates a link, allowing an input to drive an output. Input/Output Icons When an input/output is not acve its corresponding icon is grey, when the input/output becomes acve the icon changes to green. The icon may vary depending on the configuraon of the input/output. · For normal physical inputs/outputs and virtual inputs/outputs the bulb icon is displayed: Physical Inputs When adding a physical input, it can be setup in either normal mode or event mode. · For physical inputs setup to detect rising edge events an upwards arrow is displayed: · For physical inputs setup to detect falling edge events a downwards arrow is displayed: · For physical outputs setup as triggers the clock icon is displayed: Links A link is represented by an orange box on the grid - the box becomes green when the link is acve. To add a link, click on an empty square. To configure a link, click on it - this will open the `Configure Connecon' window. Normal Mode In normal mode the input mode can be set to either momentary or latching. When momentary is selected the input must be held low to keep the input acve. In latching mode, the input will become acve when the input is pulled low and then released. The inputs have a 30 millisecond debounce period - the pin state is assumed correct if it remains the same for 30 milliseconds. Event Mode In event mode the detected direcon of the signal is selected, this is either rising or falling. When the rising direcon is selected the input detects changes from a low level to a high level. When the falling direcon is selected the input detects changes from a high level to a low level. The me at which an event occurs will be recorded and can be found by clicking on the input. When an event is captured, the input becomes acve. An example of some recorded data is shown below. In this window the input and output link connects can be seen. There is also an opon to invert the link which means that if the link would normally be off, it is instead on, and if a link would normally be on, it is instead off. The buons at the boom of the window allow the link to be deleted, or the invert changes to be applied/cancelled. The format is: Year Month Day Hour Minute Second Nanosecond 10 Virtual Inputs A virtual input uses the Ember+ control protocol to obtain the value of a Boolean parameter. This can then be used to drive outputs. AVN-GPIO Handbook The correct value to add this parameter as an input to the grid is shown in the image below. The field `Ember Address' should be set to the address of the device you would like to connect to. This device must have an Ember provider, for example an AVN-Portal could be used. The field `Ember Port' should always be set to 9000 for Sonifex devices. The Ember ID is the raw path to the value you want to connect, this can be found in Ember+ Viewer. The Ember+ Viewer can be downloaded here: hps://github.com/Lawo/ember-plus/releases In the image below the provider tree for an AVN-Portal is shown. Adding Outputs Outputs can be added by pressing the add buon next to `OUTPUTS'. A new window tled `Add Output' will be displayed. The output type can be selected here, the output can be one of the following: · Physical Used to pull a physical pin to ground when acve. · Virtual Used to drive a virtual input over the network. · Relay Creates a connecon between the common pin and normally closed pin when inacve, create a connecon between the common pin and normally open pin when acve. Physical Outputs Physical outputs can be set up in normal mode or trigger mode. In the example provider tree, the status parameter can be seen, this is a Boolean value that can be added as an input. The raw path to this parameter is 1.5.2.1.6 Normal Mode In normal mode the output will become acve when any links connected to it become acve. When acve the associated pin is pulled down to ground. Trigger Mode In trigger mode `Date', `Time', and `Nanosecond' fields become available and allow the me at which the output becomes acve to be configured. In this mode links to the output are ignored. 11 AVN-GPIO Handbook Relay Output The relay output creates a connecon between the common pin and normally closed pin when inacve, and creates a connecon between the common pin and normally open pin when acve. The relay is acve when any links connected to it become acve. Power Power related configuraon opons are displayed here. Virtual Outputs Virtual outputs use the Ember+ control protocol to drive other devices over a network. The Ember+ provider and tree informaon is adversed on the network via mDNS. This allows other Sonifex devices such as the AVN-Portal, AVN-CU, and AVN-PXH12 to automacally discover and add these virtual outputs to their own roung grid as inputs. Alternavely other devices can obtain the tree informaon directly from the AVN-GPIOs Ember+ provider. The Ember+ provider for the AVN-GPIO can be seen in Ember+ Viewer, this is shown below. DC Output Source Select between the system DC supply or the DC input supply. · The system DC supply is derived from PoE (Power over Ethernet) or DC input when a DC supply is connected. (Max current draw 300mA) · The DC input supply is a supervised version of the supply provided on the DC input. (Max current draw 1A) System The system web page is used for the following: · Updang the unit · Reboong and reseng the unit Update Firmware New versions of firmware will be released as new features are added, and when any bug fixes are completed. Click on the soware downloads link to visit the firmware downloads webpage of the Sonifex website. If an update is available for your unit, you can download it as a zipped archive file. You will need to extract the `.dwn' file from the archive which can be done in Windows by rightclicking the archive and selecng `Extract All'. You can then upload the `.dwn' file to the unit. Reboot or Factory Reset The unit can be rebooted using the reboot buon. A quick reboot can oen fix any issues with the unit and aer reboong the webpage should automacally be reloaded. The factory reset buon restores the unit to factory sengs. Restoring the factory sengs will also cause the unit to reboot. 12 AVN-GPIO Handbook 4 UDP Commands The AVN-GPIO can respond to UDP commands, in order to allow an applicaon to query status informaon. An applicaon such as Packet Sender can be used to send UDP commands: hps://packetsender.com/ The UDP command must be sent to port 31780 as this is the port the AVNGPIO listens to for UDP commands. To retrieve the me at which an event occurred, use the following command: GET:X,Y\r\n Here X is the input to be queried and Y is the event number to retrieve. For example, to fetch the event 1 on input 5 the following command would be used: GET:5,1\r\n Below shows an example of using Packet Sender to retrieve the me an event occurred. The AVN-GPIO responds with the following: GET:2023-5-25 14:28:29 672379171\r\n The me at which the event 1 occurred. Again this is in the format: Year-Month-Day Hour:Minute:Second Nanosecond 5 Bootstrap Mode In the unlikely event that power is lost during a firmware upgrade then the unit may enter `bootstrap mode'. This is a limited firmware set that allows firmware upgrades to take place to return the unit to a normal working state. `Bootstrap mode' is indicated by both primary and secondary PoE and Link LEDs flashing in unison. Firmware updates are performed using a TFTP client running on a host PC. Forcing Bootstrap Mode If you need to force the unit into bootstrap mode, this is done by pressing and holding the reset buon down for more than 5 seconds. Aer 5 seconds the front panel LEDs will start to flash slowly which indicates that the unit will be forced into bootstrap mode with a stac IP address of 192.168.0.100. If the reset buon is held for more than 10 seconds, the LEDs will flash faster which indicates that the unit will be forced into bootstrap mode with dynamic mode addressing set. The unit will now aempt to get an address from a DHCP server or fall back to a link-local IP address using Auto-IP. If the reset buon is held for more than 15 seconds, the LEDs will flash even faster and the unit will now perform a factory reset and clear all of the current configuraon sengs. Upgrading Firmware in Bootstrap Mode Once the device has been put into bootstrap mode, a TFTP client can be used to transfer firmware to it. The IP address of the device must be known - the Sonifex Service Discovery Applicaon can be used to find the IP address of the device. Many TFTP clients are available, fro example, on Microso Windows a free applicaon called TFTPD64 is available. Within TFTPD64, select the TFTP client tab, enter the device's address in the host field and 69 in the port field. Next navigate to the firmware update file (this has the .dwn file extension). The remote file field should be le blank and the block size le on default. Finally press the buon labelled `Put', the progress of the upload will then be displayed. The device will reboot and now be using the uploaded firmware. If you are sll experiencing issues, try holding the reset buon for 15 seconds to perform a factory reset. 6 Maximum Cable Length Tesng Tesng was performed using a 305 metre Cat 5 twisted pair cable and the ends of the wire were connected to increase the length of the cable. The maximum test length that could be reached was a length of 1220 metres from the input to the switch and 1220 metres back to the switch to ground. Using this test length, the input could be successfully toggled. AVN-GPIO GPI1 Cable Length = 305m / Test Length = 1220m 120 ohms CAT5 GND 120 ohms 13 AVN-GPIO Handbook 7. Technical Specification For AVN-GPIO PTP Timing Specificaons Profile Support Timing Protocol Timing Accuracy IEEE1588 Default Profile, AES67 Media Profile, and Custom Profile PTPv2 IEEE 1588-2008 PTP me stamping resoluon 8 nanoseconds Connecons Network 1 x 100 Mbit/s Ethernet (RJ45/100BASE-TX) DC Power In with Power over Ethernet (PoE) 1 x 2.5mm locking DC inlet GPIO Connector GPIO Format Centre pin posive 1 x 24-Pin Phoenix Style Terminal Block 10x GPIOs (8x PTP enabled) configurable as pull-low inputs or open collector outputs Voltage Free Relay Contact NC, NO, Wiper Relay Contacts Max Voltage 125V (AC) 30V (DC) Relay Contacts Max Current 600mA (AC) 2A (DC) Power over Ethernet Standard Class PD Power Range Typical PSE Power Usage Max PSE Power Usage IEEE 802.3af 0 0.44 W to 12.94 W 2.3W 15.4W DC Power Out (Powered by PoE) Voltage 12V DC Max Current 300mA (Fused) DC Power in Min Voltage Max Voltage Min external supply current 4V DC 24V DC 2A DC Power Out (Powered by DC input) Voltage Follows DC Input(fused) Max Current 1A (fused) UDP Interface Connecon Port 31780 Equipment Type AVN-GPIO: Physical Specificaon Dimensions (Raw) Dimensions (Boxed) Weight GPIO to LAN Transceiver (PTP, EMBER+ & UDP) 10.6cm (W) x 7.3cm (D) x 4.3cm (H) 4.2" (W) x 2.9" (D) x 1.7" (H) 17.4cm (W) x 9.5cm (D) x 5.6cm (H) 6.9" (W) x 3.7" (D) x 2.2" (H) Ne: 0.2kg Gross: 0.3kg Ne: 0.44lbs Gross' 0.66lbs 14 AVN-GPIO Handbook 15 AVN-GPIO Handbook www.sonifex.co.uk t:+44 (0)1933 650 700 sales@sonifex.co.uk www.sonifex.co.uk