_______________________________________________ KP-Series Keypanel and Expansion Panel Firmware _______________________________________________ These are the release notes for the firmware for the KP-Series keypanels. This firmware supports all KP-Series keypanels, including the EKP-4016. ____________________________ Boot Loader and Client Image ____________________________ The firmware is structured in two parts: The boot loader and the client image. On power-up, the boot loader looks for a valid client image. If present, control is passed to it; otherwise, the boot loader remains in control. The firmware consists of the following files: - KP-Series_boot.mot - Boot loader, downloadable from AZedit - KP-Series_client_z.mot - Client image (compressed), downloadable from AZedit You can force the keypanel to remain in the boot loader, even if a valid client image is present, by holding the right-most key (#16 on a KP-5032, the CWW key on a KP-4016) down and the key next to it (#15 / Mic Mute) up while the panel is being powered on. While in the boot loader, the panel will display a message that it needs a download. The panel will communicate with the matrix (serially), and will accept downloads; nothing else will work. There will be no audio; the talk and listen keys, the keypad, and the shaft encoders will all be non-functional. The boot loader will also accept downloads via its Ethernet connection from the FWUT (Firmware Upload Tool). You can download a new boot loader image while the keypanel is running in boot loader mode. You can also enable downloading of a new boot loader image while the keypanel is running the client image. Press and hold both shaft encoders, then enter the Menus by pressing the Menu key, and then release the shaft encoders. The Service menu will now have a new menu item called Boot Code. This menu shows the current boot loader version, and offers a checkable menu item called Allow Download. Checking this option allows you to download a new boot loader via AZedit. If an EKP-4016 is connected, and it contains a different client image than the main panel, then the keypanel's client image is automatically transferred to the EKP. The EKP will display a Firmware Download icon, but will otherwise remain fully functional. The transfer takes a couple of minutes, after which the EKP will reprogram its flash and restart. Other components (boot loader, FPGA, fonts, etc.) are also transferred from the main panel to the EKP automatically, as necessary. If an EKP ends up with a client image that is corrupt or not present, it will enter the boot loader, which behaves the same as on the main panel, except that it expects to communicate with a main panel, and not the intercom. ___________________ Saved Configuration ___________________ The keypanel saves various settings to configuration flash. On start-up, it looks for a valid configuration; if it finds one, it uses this to determine the initial configuration. If there is no (valid) saved configuration, it starts up with the factory default configuration. Normally, if you make changes to the configuration via the menus, the changes are not saved to flash. The configuration is saved to flash in the following circumstances: - If you select Menu | Save Config - If you select a menu option that prompts you to save changes and restart (e.g. changing the displayed alpha size) - If AZedit makes changes to the configuration The keypanel can be restored to the factory default configuration by selecting Reset Config from the Service menu. If you do this, the changes are not written to flash; to save the changes, you must select Menu | Save Config. _________________________ Open Control Architecture _________________________ Version 2.0.0 introduces support for the Open Control Architecture (OCA) platform. This version, and all future versions, must be used in conjunction with OMI version 6.x.x. In general, OMNEO devices with firmware supporting OCA must be paired with other OCA compatible devices. ____________________ IPedit Compatibility ____________________ KP-Series version 2.3.0 and later require IPedit version 3.5.0 or later. ______________ Change History ______________ Version 2.3.3 (CRC = 2a42) ========================== * Added new IPedit command: Reset authentication If a user (logged in with Admin permissions) holds down Shift+Ctrl while right-clicking the keypanel device in the catalog on the left-hand side, the pop-up context menu now includes the item "Reset Authentication Table". This commands requires IPedit v3.6.2 or later. * Added security for various commands The following operations have been re-implemented so that they are more secure, and difficult to spoof: - Clear channel statistics - Tear down channel(s) - Reboot device - Enable telnet These commands now require IPedit v3.6.2 or later. * Added security features for compliance with California Senate Bill 327 For new devices, authentication must now be configued when first connecting to the device. This is necessary for compliance with California Law, re: SB327: An act to add Title 1.81.26 (commencing with Section 1798.91.04) to Part 4 of Division 3 of the California Civil Code, relating to information privacy. No change needs to be made to existing devices when this version of firmware is downloaded; however, if the authentication table is reset, or a factory reset is performed on the device, it will then enter the state where it requires authentication to be configured. IPedit: With IPedit v3.6.2 or later, IPedit will switch to the Authentication tab, and display a message notifying the user of this requirement. Until authentication has been configured, the device will not allow any changes to be made; and IPedit (v3.6.2 or later) will switch to read-only mode. With earlier versions of IPedit, no notification will be displayed, but the device will still refuse to accept any changes until authentication has been configured. * Added Open Source software component information Open Source software information (OSS components used and the corresponding license text) can be uploaded by typing in the device's IP address in any browser such as Firefox, Chrome, or Edge. Version 2.3.2 (CRC = 003a) ========================== * Fixed various tally problems In several scenarios, it was possible for a tally generated on a KP-Series keypanel to get stuck on. Fixed. * Support extended headset volume range when adjusting volumes in real time When version 2.2.2 introduced an extended headset volume range, AZedit was updated to show the extended range on the keypanel configuration dialog. However, when adjusting the headset volume in real time from AZedit, only the original volume range was shown. Fixed. Version 2.3.1 (CRC = c514) ========================== * Remote alphas could be included in local scroll list If the keypanel was connected to a system with older firmware that doesn't support trunking of 255 intercoms (e.g. MCII-e v2.9.2 or earlier, or any DBX system), remote alphas could get added to the local scroll list. Fixed. * Fixed key tally problems In several different scenarios, a keypanel might continue to display a key tally once the tally condition had been cleared. Fixed. Version 2.3.0 (CRC = 674a) ========================== * Added support for Dante Domain Manager * Added Line Echo Cancellation (LEC) option to headsets A new Line Echo Canceller (LEC) feature has been added on the headsets to minimize electro-acoustic coupling of the headset speakers into the headset microphone at high volume output levels. This feature also acts to reduce crosstalk coupling from headset output to headset microphone input. The LEC function may be programmed on either Front Headset or Rear headset --- but not both simultaneously. The default configuration for Headset LEC is 'Auto' which enables the feature on the active headset with priority. Headset LEC can also be disabled if desired. NOTE: The existing Headset LEC algorithm is optimized for single headphone operation or operation where both LEFT and RIGHT headphone outputs are the same (dual mono). Headset LEC will be less effective with true stereo operation where LEFT and RIGHT headphones have different audio. * Fixed possible issue in fail-safe handling Under certain conditions, the OMNEO module would not restore the fail-safe image when using the Firmware Upload Tool. Fixed. * Fix: Restore listen key state to previous state after turning on to adjust volume * Fix: Audio could get muted when converting keypanel between OMNEO and RVON firmware * Fix: Improved handling of SHIFT+key to toggle listen keys on pushbutton panels * Fix: Key volume display could get stuck on during mirroring operation * Fix: Clear key options for UPG keys didn't work if UPG was not a Panel Swap trigger Version 2.2.4 (CRC = 119c) ========================== * Fixed tally handling for Japanese systems If a caller presses a talk key for a short time (e.g. 4 seconds), the incoming call tally would stop as soon as the talk key was released. Fixed. Now the tally lasts for as long as the talk key is held, or for the programmed incoming call tally duration, whichever is longer. Version 2.2.3 (CRC = 4c1c) ========================== * Fix: Normalization of headset output gain affected application if Priority Call volumes The normalization of the headset output gains was applied before testing for minimum headset output gains for priority calls which could result in a louder than expected minumum headset output for priority calls. This has been corrected. Version 2.2.2 (CRC = ed47) ========================== * Normalization of headset output gain across all RTS keypanel types During the definition of the KP Series panel audio performance, RTS received requests from customers to increase the output power level of the Front and Rear headsets. With the release of the KP series panels, approximately 14dB more output level is available on the headsets compared to prior panels such as the KP-32 and CLD panels. Although the output level was increased, the graphical headset volume indication on the KP series display was not changed. For this reason, the graphical rendering on the front display for headset volume adjustment on the KP series panel looks exactly like the CLD panels -- even though the absolute levels are 14 dB different. To increase awareness of this difference in headset levels and increased volume, both AZedit and the graphical rendering of headset volume on the KP series panels are being increased to show the true output range of up to +24dB above our traditional nominal (0dB) level. Version 2.2.1 (CRC = 7c6f) ========================== * For a specific set of KP Series models, a new Mic Compensation EQ preset is automatically applied to panel microphone inputs. The new preset is intended to normalize the panel mic levels such that the transmission levels are equivalent to historic KP-32 panel levels. The net change is that the panel microphone level is increased 8 to 10 dB and the high frequency response is increased to match the KP-32 levels. The panels impacted by this Mic Compensation change are: - Revisions 2 and 3 of all rack mount KP-5032 panels (both lever key and pushbutton) - Revision 2 of all rack mount KP-4016 and KP-3016 panels If a panel is affected by this change, you will be able to see the Mic Compensation EQ preset in the Audio Options | Advanced | Filters | Equalization | Inputs | Front Mic menu. The preset can be changed or disabled, but will be selected and enabled by default. In addition, the default use of the Noise Reduction filter is changed for all KP series family panels except for Revision 1 panels. Specifically, the default on headset microphones is changed to 'Rumble Reduction'. The default on panel microphones is changed to either 'Mic Compensation' (per the above revision listing) or 'Rumble Reduction' for all other panel revisions (including future revisions). Version 2.2.0 (CRC = 6221) ========================== * Fix: In some cases, when an OMNEO connection was being established the connection failed and the keypanel had to be rebooted for the connection to come up. * Fix: If the bootloader of an EKP-4016PB was downgraded to v1.2.3 or older, the panel became inoperable. In this version, panels will not download bootloader v1.2.3 or older to prevent this issue. * Fix: In IPedit, when the Destination Device Name was cleared, the channel configuration still showed an IP address. Version 2.1.4 (CRC = 4aa7) ========================== * Fix: AEC menu now available even in panels that don't have a rear mic, like the KP-3016, so that you can disable AEC on the front mic if desired. * Fix: Holding on a listen key, and then pressing a talk key would cause the talk key press to be treated as a listen key. This has been fixed. * Fix: When pre-amp output mode is disabled, the mic inputs are not mixed to the pre- amp output, but other sources may still be mixed. In this case, pressing mic mute would mute the other sources to the pre-amp output. This has been fixed. * Fix: When licensed for 8 OMNEO inputs, keypanel would only accept connections for up to 5 unique OMI devices. This has been fixed. Version 2.1.2 (CRC = c440) ========================== * Added menu option to disable Acoustic Echo Canceller * Changed text of warning icon for improved clarity If the client firmware is incompatible with the Audio FPGA version, a warning icon is shown on the left side of the keypanel's display. The text of this icon was changed to "Incompatible Audio FPGA" instead of "Incompatible FPGA Image" to better distinguish which of the two FPGAs is incompatible. Version 2.1.1 (CRC = 9512) ========================== * Version string now uses "PB" instead of "P" to identify Push Button panels (e.g. "KP-5032PB"). * Fixed PAGE button handling on KP-3016 and DKP-3016 panels Hitting the PAGE button would put the panel in LSTN mode (treating talk key presses as listen key presses), rather than putting it in graphical page mode. Fixed. Version 2.1.0 (CRC = 492f) ========================== * Added support for DKP-3016 and DKP-3016W panels. * Added support for pushbutton variants of KP-Series panels. * Added support for IPedit to enable/disable AIO mode (requires IPedit V3.4.0). * New icon to indicate when panel is in AIO mode. * Download of new bootloader firmware image is always allowed (no need to enable). * LLDP network issue could cause panel to crash. Fixed. * Did not respond correctly to IPedit teardown channel request. Fixed. * Factory fresh keypanels would crash shortly after startup. Fixed. * Bad EKP icon was never removed once displayed on an EKP. Fixed. * Bad Power icon was never displayed on an EKP. Fixed. Version 2.0.2 (CRC = e5f1) ========================== * FPGA version is now included in the versions string * The channel connection status of Dante audio streams created by third party software is now shown in IPedit. * Activity LEDs on Ethernet RJ-45 ports didn't blink for 10/100 Mbps links. Fixed. * Improved tally handling for Japanese systems For Japanese systems, a short keypress could result in a very short (2 seconds or less) incoming call tally. Fixed. * In some cases, offers were not shown in the OMNEO Offers menu. Fixed. * In some cases, enabling AIO mode via the menus was unreliable. Fixed. * In rare instances, the display of key assignments was corrupted. Fixed. Version 2.0.1 (CRC = 132b) ========================== * Supports the Open Control Architecture (OCA) platform. See compatibility section above. * RSTP support can now be enabled or disabled from IPedit. * Supports configurable receiver latency for each channel, via IPedit. * Audio channels can be torn down via IPedit. Version 1.2.2 (CRC = 84b8) ========================== * Improved Acoustic Echo Canceller performance * Display icons to indicate what licensed features are available The keypanel displays a small "C" icon (black text on a gold background) if it has a license for the Control feature package, and a small "A" icon if it has a license for the Audio feature package. * When mirroring, Display | Panel ID now shows target panel's ID If the supervisor panel selected the Panel ID menu item, it would show the supervisor's port information. Fixed. Now it shows information about the target's port. * Bug fix: Panel lost license In rare instances, at start-up, the keypanel could lose its license(s), requiring the license(s) to be downloaded again. Fixed. Version 1.2.0 (CRC = 3c11) ========================== ** NOTE: LICENSING ** If a feature description below is followed by (L), it is a licensed feature. A valid license that enables the feature must be downloaded to the keypanel in order to enable that feature. Although a panel must be licensed in order to record a voice message, a panel does not require a license in order to leave a voice message. Although a panel must be licensed in order to initiate a mirror operation ("take over another panel"), a panel does not require a license in order to be mirrored by another panel. * Added voice messaging (L) A panel can be put in AFK (Away From Keypanel) mode by hitting Shift-AFK (0-2). When a panel is in AFK mode, normal calls to the panel will receive an indication (chime and tally) that the target panel is AFK. The user can leave a voice message by hitting Shift (0) and then turning on a talk key. If the target panel is AFK, and there is an available voice message buffer, the caller can leave a voice message of up to 30 seconds. A count-down timer is displayed on the talk key. The voice message is terminated when the 30-second limit is hit, or if the caller turns off the talk key. Voice messages can be reviewed and played back by hitting Shift-VM (0-8) to access the Voice Messages menu. In the Voice Message menu: - Pressing the call-waiting key will call the panel that left the currently selected message - Shift-CLR deletes the currently selected message A message is retained until the panel is reset or the user deletes the message. The Voice Message menu is not accessible unless there is at least 1 recorded voice message. * Added keypanel mirroring (L) A new service menu item, "Mirror", allows the user to select a target panel to be controlled. During the mirror operation, the supervisor panel (the one initiating the operation) displays the state of the target panel (key on/off states, key assignments, volume settings, key options, etc.), and the supervisor can update any of these settings. Once the mirror operation is terminated, the target panel maintains the new settings, while the supervisor panel reverts to its configuration (from before the start of the mirror operation). During the mirror operation, all audio to/from the target panel is reproduced at the supervisor's panel. Incoming calls to the supervisor's panel are blocked, and the caller receives a "do not interrupt" (busy) tally. If the target panel's footswitch is enabled, this will also be mirrored at the supervisor's panel. If the supervisor's panel does not have a footswitch, Shift-MicSel can be used as a footswitch. During the mirror operation, the target keypanel's keypad is disabled, as is the call-waiting clear key. In order for a panel to access the Mirror menu and initiate a mirror operation, the "Enable Keypanel Mirroring" Option must be set for that panel. (In AZedit, on the keypanel view, click the Edit button and select the Advanced tab). * AZedit can upload, edit, and download the keypanel's configuration (L) All of the keypanel's local configuration data (key options, mic selection, audio mixing, GPIO assignments, etc.) can be uploaded and downloaded. AZedit can upload the settings, make changes, send the changes, save the keypanel configuration to file, and send saved changes to the keypanel. In addition, the following can be adjusted in real time from AZedit, by right-clicking in the Port Status area on the keypanel view: - Headset transfer state - Mic mute status - AFK status - Tone generator The following can be adjusted in real time from AZedit, by clicking the speaker icon (to the right of the Edit button on the keypanel view) and selecting the Keypanel tab: - Speaker and headset output volumes - Matrix Input, OMNEO Input, and Aux Input volumes * Support additional OMNEO inputs 3-8 (L) * Support additional compression ratios (4:1, 5:1, and 6:1) (L) * Noise gate threshold is configurable (L) * 5-Band equalizer is configurable (L) When equalization is selected for an input or output, you can select one of 4 presets (Default, Hiss Reduction, Noise Reduction, Rumble Reduction). You can then adjust the following: - The low-end and high-end cutoff filter frequencies - The gain of each individual band. * A customized graphical screen saver can be downloaded to the panel from AZedit. (L) * Customized chimes can be downloaded from AZedit. (L) * Added new CWW options A new Service menu item, CWW, allows limiting number of CWW entries. It also supports a new CWW mode "Select New Call" that automatically highlights (selects) new calls added to the CWW (so that you can reply without having to scroll to the new call). A modified option, "Select If Idle", only selects the new call if the CWW was hidden, or if you haven't interacted with the CWW for 5 seconds. (This prevents having the highlighted entry move if you had just recently talked to a different caller, for instance). The default option is "Don't Select" which retains the historical behaviour where new calls get inserted at the top, but the highlight remains on the last selected call. * Fixed handling of Reset Vols If the panel is configured for always-on display of listen key volumes, and you select Menu | Audio Options | Key Volumes | Reset, some keys might end up showing the old volume, even though it is reset to 0dB. Fixed. (This problem would typically only occur if you have 2 or more duplicate assignments on the panel.) * Added debouncing to the keypad keys On some panels, it was possible for some of the keypad keys to generate multiple "press" events from a single button push. Fixed. * Fixed copying of Assignment Group members If you requested the members of an Assignment Group, and then tried to copy one of the members to a talk key, the copy would fail. Fixed. * Added support for the KP-3016 and KP-3016A keypanels. One version of firmware works across the board for all KP-Series keypanels, including the EKP-4016. Version 1.1.1 (CRC = 5331) ========================== * Added support for DKP-4016 and DKP-4016W keypanels One version of firmware works across the board for all KP-Series keypanels, including the EKP-4016. Version 1.0.5 (CRC = 4a16) ========================== * Domain names entered in IPedit were being truncated to 31 characters. Fixed. * Chime durations of 5 minutes weren't being handled properly. Fixed. * Added SNMP support * Allow access to hidden menu items, even if passwords are enabled Hidden menu items (e.g. display FPGA version) can be accessed by pressing and holding both shaft encoders and then hitting the Menu button. However, this didn't work if menu passwords were enabled. Fixed. * Fixed display of components in FWUT In the Firmware Upload Tool, if the option "Show All Components" is selected, the FWUT might not show all the components correctly. Fixed. Version 1.0.3 (CRC = 1a35) ========================== * Mic Mute key can be configured as momentary The Mic Mute key can now be set to any of the following: - Disabled - Momentary (mute while held) - Toggled (push-on / push-off). * If adjustment of the matrix input volume control was disabled, then the matrix input would not be mixed (i.e. you would not hear it at all). Fixed. This also applies to the Aux Inputs. * Default minimum volume for matrix input changed to -6dB If the minimum volume was set to Mute, it will now be changed to -6dB (but can be changed through the menus). If the minimum volume has been changed to anything else, it is not touched. * Tone output level corrected When the tone generator was enabled, the tone output level was always +9dB, and did not change if the panel output level was adjusted. Fixed. Now, the tone output level is correct, and tracks the configured output level. * Could not set key assignment colors for remote intercoms. Fixed. * Expansion panel did not indicate progress when downloading icons. Fixed. Version 1.0.2 (CRC = c9c1) ========================== * Initial release