release notes - arcturusnetworks.com · a demo setup guide provides documentation for the demo...

PROPRIETARY AND CONFIDENTIAL – RELEASED UNDER LICENSE 1

Release Notes

DATE October 15, 2008

HARDWARE uC53281-EVM rev 1.2 (MCF53281)

DEPENDENCIES Device must be running software version 1.0.2r223 Reset to factory defaults required after software upgrade

BINARY FILES Firmware Binaries (with MD5 header checksum - for webUI upload): pmd5x-11d224 – uC5329 rev 1.1 pmd5x-12d224 – uC53281-EVM rev 1.2 (PCF53281) pmd5x-120224 – uC53281-EVM rev 1.2 (MCF53281) Firmware Binaries (without MD5 header checksum - for TFTP or serial upload): partx-11d224 – uC5329 rev 1.1 partx-12d224 – uC53281-EVM rev 1.2 (PCF53281) partx-120224 – uC53281-EVM rev 1.2 (MCF53281)

SOFTWARE VERSONS

1.0.2-r224

RELEASE TYPE Beta Firmware – Engineering Release for Testing

DEVICE SETTINGS DEFAULT

LAN IP ADDRESS DHCP CLIENT

USER LOGIN admin

USER PASSWORD admin

OTHER

IMPORTANT NOTE – VERIFY PROCESSOR VERSION: MCF53281 SOFTWARE WILL NOT RUN ON PCF53281 PROCESSOR PARTS – DEVICE WILL BECOME INOPERABLE!

[email protected] +1 416 621 0125

Arcturus empower embedded. [email protected]

+1 416 621 0125


1. SUMMARY This firmware load (PRERELEASE) is the current load under test and includes the following major improvements from the previous release. (see detail section for more information)

1. DHCP Client Functionality, Link-Local Addressing and LINK State Detect 2. Boot To Static Mode Using Buttons 3. Restore Network and Password Mode Using Buttons 4. Advanced VoCoder Support 5. Broadcast and Mass Notification Software Module 6. Broadcast and Mass Notification Demo 7. Record and Play Messages 8. AMP Enable / Disable 9. Preconfiguration of Codec during Start up 10. SIP OPTIONS Method 11. Save and Restore Configuration 12. SYSLOG Update 13. Speed Dial – Feature Codes 14. Enhanced LED and GPIO Functions 15. Voice and Media Middleware API Enhancements

2. INSTALLATION INSTRUCTIONS Three firmware files have been provided pmd50, pmd51, pmd52. To install: 1. unzip files. 2. log into the device web page by following the instructions in the Getting Started Guide

2.1. connect device to network with DHCP 2.2. press button 3 to hear IP address of device through headset 2.3. enter IP address into URL line of web browser 2.4. login: admin / password: admin

3. select the ADMIN tab page 4. select FIRMWARE 5. repeat until all three files are uploaded (pmd50,pmd51, pmd52).

3. DETAIL

3.1 DHCP Client Functionality The DHCP client application has been upgraded to (version information was not available at time of release, please contact [email protected]) including support for persistent DUID information to enable the device to request a consistent IP address. DHCP client functionality is enabled by default. At runtime the device will boot with the interface provisioned to the last known IP address. If the device has not previously obtained an IP address, the factory default address of 192.168.154.1 will be used. Enabled by default, the DHCP client will attempt to renew the last known IP address, if the last

mailto:[email protected]


know IP address cannot be renewed the DHCP client will broadcast for a lease. When a lease is obtained, the interface will be reconfigured and the management middleware will propagate the change to the rest of the system. If no DHCP lease is acquired, the interface will remain provisioned with the last known or factory IP address and the DHCP client will continue to broadcast for a lease every 5 minutes.

Support ARP Probe

The ARP Probe function is used by the DHCP client to determine if any other device on the network is using the same IP address. The function sets/resets "noarp" in the dhcpc configuration file from supplied documentation (dhcpcd.conf.5) and disables IPv4LL. This feature may need to be disabled on some discontiguous networks that use proxy ARPing. In this environment ARP probe requests my receive responses from devices on separate networks resulting in DHCP client failing to maintain a lease.

IPv4LL (Link Local Addressing)

The IPv4LL function supports the link-local method for obtaining an IP address in circumstances where a DHCP server is not available. When enabled the function will check for a DHCP server and failing the discovery will use the IPv4LL method. This method will select an IPv4LL address (169.254.x.x) and check to see if another device is using it. After ensuring the address is available, the device will assign the address to the interface. IPv4LL is useful if the device is frequently moving to different networks or is being connected directly to a PC or used on a network with no DHCP server. IPv4LL is a method supported by most PC machines (windows/apple/linux). Enabling and disabling this function sets/resets "noipv4ll" in the dhcpc configuration file. The function of the DHCP client and IPv4LL are linked. Under the condition where IPv4LL is disabled and DHCP client is enabled and a DHCP address cannot be obtained. The DHCP client will use the last IP address it received to provision the interface. In this case disabling IPv4LL is useful to ensure the interface maintains a consistent IP address.

LINK State Detect

LINK detect alerts the DHCP client application to any changes in the physical layer link state of the Ethernet interface. When an Ethernet cable is connected and the LINK state us up (carrier) the Ethernet physical interface will signal the DHCP client to expire it’s lease timers and renegotiate a lease.

3.2 Boot to Static IP address Mode Using Buttons A function has been added that enables the device to boot into static IP address mode. The factory IP address of 192.168.154.1 will be used as the default IP address if the device has not previously received a DHCP lease or has not been previously been configured. If the device has a previous IP address or has been configured, the device will use this address as the static address. This function could be useful to help diagnose and overcome incompatibilities between DHCP servers and clients as well as to assist with configuration on networks that do not have DHCP server available or when configuring on a closed network (such as a direct connection to a PC). The boot to static mode can be enabled by holding the GPIO button 3 (SW3) for 6 seconds after pressing reset. LED 5 (above GPIO button 4) will blink in response to the held state. After the device has completed it’s boot cycle the IP address may be obtained using the normal procedure to announce the IP address using the voice response function (pressing button GPIO 3). NOTE: Boot to static mode is not available on release candidate.


3.3 Restore Network and Password Mode Using Buttons A function has been added that restores the device password and network settings to factory default. This function can be used to recover the device if the password has been lost or if the web UI has become un-routable. The restore function can be enabled by holding the GPIO button 1 (SW1) button for 6 seconds after pressing reset. LED 5 (above GPIO button 4) will blink in response to the held state. The restore function will reset the following parameters back to the factory default setting, as described below:

Parameter Factory Default (restore setting)

Network Interface DHCP Enable

Username admin

Password admin

3.4 Advanced VoCoder Support Two additional voCoders have been integrated and are configurable under the management middleware and webUI. iLBC iLBC (Internet Low Bit Rate Codec) Is a low bit rate VoCoder that supports fixed data rates of 13.33 kbit/s for 30 ms frames with an 8KHz sample rate. iLBC uses linear predictive coding and packet loss concealment to offer a higher basic quality and better response to packet loss than G.729 with a similar CPU load. iLBC is defined in RFC 3951 and subject to the GIPS iLBC Freeware Public License. G.722 G.722 is a ITU defined wideband vocoder that require a sample rate of 16KHz and a bit rate 64kbit/s. It offers significant audio quality improvements over narrow band, near toll quality and toll quality audio codecs and is suitable for back ground music and public address applications. Note that the current codec support by the uC53281 module (LM4930) supports fixed sample rates of 8KHz only and is NOT compatible with this vocoder. For applications using G.722, support for the LM4931 codec supporting 16KHz is available. Contact Arcturus support for more information.

3.5 Broadcast and Mass Notification Software Module A new software module has been included that supports broadcast RTP suitable for mass notification application such as intercom and paging devices. This module is documented in the VMM_Broadcast_Module.pdf and includes the features described below.

Up to 99 configurable broadcast audio groups – one group per multicast broadcast

Disable / Send / Listen / Send and Listen configurable parameters per group

Definable command packet port number

Definable command packet multicast address

Definable multicast address and port numbers per broadcast group

Definable Caller-ID and Caller-Name

Definable broadcast priority types

Definable vocoder payload type including sample rate and packet length (ptime)

Definable auto answer settings for listen parameters

Definable delay for auto answer setting


Highly configurable alert tones including length, type, cadence, frequency, modulation and gain

Tone synchronization

Basic configuration integrated through web UI

Advanced configuration available in .conf file

Complete demo using LCD GUI application

VoIP Middleware Command integration using AT command API

Page function assignable to GPIO through speed dial configuration

Automatic keep alives, late arrival pick up, dropped call terminations

3.6 Broadcast and Mass Notification Demo To help demonstrate the capabilities of the broadcast software module a preloaded demo has been built into software release version r224 and greater. The demo uses LCD and mouse click-to-call capability to illustrate a voice enabled alarm panel situated on campus with two (2) buildings and (4) four paging zones. A demo setup guide provides documentation for the demo (VMM_Broadcast_Module_Demo.pdf) and supports the following features:

LCD-to-VGA Daughter Card Support

LCD GUI using Nano-X

Pointing Device Support

Serial Mouse with Button Support

2 Station / Speed Dial Buttons

Click-to-call capability with support for: o Pop up Key Pad o Mute, Hold with indicators o Hangup, Answer o Alarm Button o Registration Status o Command API Output o 4 Broadcast Zones

3 Levels of Hierarchy

Extensible up to 99 groups

Individual permission (send and listen) per group, per device

The demo application is available in source code and can be modified freely, it is located in the distribution.

3.7 Record and Play Messages The middleware supports a play and record function for the creation, storage and playback of local announcements. The location of the announcements is defined under the digit map. If no file is present, no audio will be played. The file format is G.711 ulaw audio, with a sample rate of 8KHz.

The default action from digit map is described below. Files located in /usr/etc can be compiled in.

Files located in /var are recorded and played from the RAM file system. Locations can be changed to

support persistent storage.

Announcements Stored in firmware

Feature Code Default Digit Map Action Description

**770: { announce("/usr/etc/user_file0.ul"); } Play /usr/etc/user_file0.ul











Announcements Stored in RAM


**780: { recfile("/var/recfile0"); } Record to /var/recfile0



**783 { recfile("/var/recfile3"); } Record to /var/recfile3







Announcements Played From RAM


**790: { playfile("/var/recfile0"); } Play /var/recfile0










3.8 AMP Enable / Disable An enhancement has been made to signal external amplifiers. The middleware will now signal on-hook and off-hook states using PM1 (GPIO_PWM1). This may be used to turn on and off external speaker amplifies or signal line control for mass notification systems. A hardware reference design is available from the support site for an intercom daughter card that supports this configuration and is suitable for double gang wall enclosures. This GPIO signal is also connected to R_LED of the Ethernet Connector, this can be used as a visual off-hook state indicator.


3.9 Preconfiguration of Codec During Startup The LM4930 codec requires initialization to mute any noise on the I2C lines from entering the internal amplifier during an uninitialized state. Since the I2C support is not initialized until the OS is running the codec may produce undesirable crackling noise prior to being initialized. To overcome this, the software now initializes the codec to a known state in the bootloader prior to continuing initialization. The codec is then reconfigured by the OS as the I2C is initialized and the audio subsystem started.

3.10 SIP OPTIONS Method The middleware now support the OPTIONS method for basic OPTIONS support as defined by the SIP RFC. When requested the middleware will provide a list of capabilities in response to an OPTIONS request.

3.11 Speed Dials – Feature Codes The middleware now supports the use of “**” and “#” feature codes in the speed dial settings this expands the use of the GPIO functions to dial speed dials as well as the API capability to trigger broadcasts or announce IP address etc. Some limitations include the use of call transfers and other “in-call” or flash-hook based features. It should be noted that this may change the way speed dials have previously been used to support “exceptions” in call-blocking rules. The digitmap can be disabled and enabled along with speed dial capability by using the /ADVANCED/FEATURE MAGIC /DIGITMAP SETTINGS, under the web UI. The digit map is configurable in the source distribution, refer to the VMM_Developers_Guide.pdf for more information.

3.12 Save and Restore Configuration The middleware now supports a save and restore configuration function from the Web UI. The feature is located under the /ADMIN tab page. The save function copies changes made to the MIB database into a plain text file and saves to a location defined by the web browser. The restore function enables the selection of the file through the web browser and uploads the file into the device. The restoration process does not delete any configuration information first and will over write only the same changes made from the persistent database of the device the backup came from. This method currently allows for additive changes, but may be changed to support an environment overwrite. It is recommended to ensure all default settings are taken into account when creating generic restore templates. A reset is required to instantiate the database.

3.13 SYSLOG Update The syslog mechanism has been updated to the current busybox 1.10.1 implementation. This was done to address shared and non-shared memory problems across platforms as well as noted instabilities.

3.14 Enhanced LED and GPIO Functions The LED visual indicators have been changed to provide clearer state information. The LEDs function in the following states

State LEDs

Bootloader Initializing 2(sw1) OFF


3(sw2) OFF

4(sw3) OFF

5(sw4) OFF

Kernel Launched 2(sw1) OFF

3(sw2) OFF

4(sw3) OFF

5(sw4) SOLID

Userland Launched 2(sw1) OFF

3(sw2) OFF

4(sw3) OFF

5(sw4) SLOW BLINK

No Account / Trying To Register 2(sw1) OFF

3(sw2) OFF

4(sw3) OFF

5(sw4) FAST BLINK

Registered 2(sw1) OFF

3(sw2) OFF

4(sw3) OFF

5(sw4) SOLID

Call In Progress 2(sw1) OFF

3(sw2) OFF

4(sw3) OFF

5(sw4) Heartbeat

Firmware Uploading to RAM ALL LEDS Chase 2-5

Firmware Writing to Flash ALL LEDS Chase 5-2

Reset after Firmware ALL LEDS All Blink Tandem

3.15 Voice and Media Middleware API Enhancements The Voice and Media API has been extended to support bi-directional communication with the telephony application (phoned) to signal resets and provide return messages for the status of the application. Phoned may be required to reset due to other related system components, the API will now report this, enabling applications to act as necessary.

API Command Action Description API Return Signals

atR force reset Forces the application to terminate immediately. The application will then restart and reload its configuration file

[OK] [Terminated]

[ERROR: DOWN] [OK: UP]

atr signal reset Signals the application to restart and reload the configuration file as soon as the application has been on-hook for a minimum of 30 seconds

[OK]

[ERROR: DOWN] [OK: UP]

API Return Signals Description Note

[Terminated] Application Terminated The return [Terminated] is sent from the application to the default console UART to indicate it is terminating


[ERROR: DOWN]

Application Down The signal indicates that the application is currently down.

[OK: UP] Application is ready The signal indicates the application has completed a reset and is ready for commands


4. FEATURE OPERATION

Digit Map/Dial Plan Definitions

Digit Map Keys Pressed Last Action Result

*nn Timer or Pound Dials Out

*nnn… Timer or Pound Dials Out

#n Timer or Pound Dials Out

11nn Timer or Pound Dials Out

0 Timer or Pound Dials Out

00 Timer or Pound Dials Out

(2-9)11 Immediate Dials Out

nn Timer or Pound Dials Out

(1-9)nnn… Timer or Pound Dials Out

011nn… Timer or Pound Dials Out

(2-9)nn-nnnn Timer or Pound Dials Out

(2-9)nn-nnn-nnnn Immediate Dials Out

0(2-9)nn-nnnn Timer or Pound Dials Out

0(2-9)nn-nnn-nnnn Timer or Pound Dials Out

1nnn-nnn-nnnn Immediate Dials Out

[1…9] 1 Digit Entered Pound Key Speed Dials

NOTE: THE LOCALLY SUPPORTED VSC TABLE BELOW SUPERCEDES DIGITMAP

IVR Commands

Code Description Action/Note

[**00] Announces the current phone number.

[**69] Announces the caller-ID from the last caller.

*69 local IVR support disabled in this build

[**98] Announces the WAN IP Address In the even the device has not received a DHCP lease, the device will produce a “placeholder” consisting of the last least received.

[**99] Announces the LAN IP Address Use the LAN IP to access Web UI

[**ADMIN] [1] <IPaddress> [#]

Initial Provisioning Address Enter * delimited IP address of provisioning server followed by pound key


Locally Supported Vertical Service Codes

Code Description

[*123 / *98]

Connect to voicemail (where available)

[**67] Outgoing Caller-ID Block (per call)

[**82] Enable Outgoing Caller-ID (per call override block from webUI)

[*70] Call Waiting Disable for current call

[*78] Do Not Disturb – Enable

[*79] Do Not Disturb – Disable

[*77] Reject Anonymous Calls – Enable (per session feature)

[*87] Reject Anonymous Calls – Disable

[**77<0..9>] Plays file <0..9> located in { announce("/usr/etc/user_file<0..9>.ul"); }

[**30<0..99>] Broadcast on channel <0..99>

[Flash], [#90], <transfer number>

Unattended Call Transfer. See detailed instructions below

[Flash], [#91], <transfer number>

Attended Call Transfer. See detailed instructions below

BUSY [**5] Redials busy number at 30 second intervals for 20 minutes. Successful call completion will ring the local phone. See instructions below.

Unattended Call Transfer: 1. During a live call press FLASH 2. Wait for dial tone, press #90 3. Wait for dial tone, dial destination number 4. Wait for announcement, hang up phone Attended Call Transfer: 1. During a live call press FLASH 2. Wait for dial tone, press #91 3. Wait for dial tone, dial third party 4. Announce call to third party 5. hang up to complete the transfer Redial on Busy: 1. Upon receiving a busy signal, dial **5 2. Wait for confirmation tone 3. Hang-up Redials busy number at 30 second intervals for 20 minutes. Successful call completion will ring the local phone.

Admin Codes

Code Description Action/Note

[**ADMIN] Enables Admin Mode


Initial Provisioning via telephone Handset

Enter * delimited IP address of provisioning server followed by pound key


Reset to factory defaults Resets the device to factory default state


Command Line VoIP Middleware API

Code Description Action/Note atcmd /atemul0 Enables Command Mode Attaches to SIP instance 0 atcmd AT command emulator. Attaches

emulator to console or terminal atemul<0> atemul device_id AT emulator daemon attach

command. Attaches emulator to to

SIP instance device_id

ata ata off hook – answer atd atd nnnnnnn

atd n# dials nnnnnnn

dials speed dial n # special terminator key ath ath Hangup atf atf flash hook att att n generates DTMF tone atR Force reset of telephony

application Forces the application to terminate immediately. The application will then restart and reload its configuration file

atr Signal reset of telephony application

Signals the application to restart and reload the configuration file as soon as the application has been on-hook for a minimum of 30 seconds

ats91=<0..6>

ats91 0 is mute, 6 is max. - query using ats91 (return value is +1)

Persistent TX (microphone) level

ats92=<0..6>


Persistent RX (speaker) level

ats93=<0..6>


Non-persistent TX (microphone) level

ats94=<0..6>


Non-persistent RX (speaker) level

ats99 ats99 status query of attached SIP instance Returns; 0 – Line is not provisioned / Network NOT Available 1 – Line is REGISTERED 2 – Line is trying to REGISTER / Network Available

ats100 ats100 Hardware Revision ats101 ats101 Software Revision ats102 ats102 HostName ats103 ats103 Serial Number ats104 ats104 query for status of MWI (message

waiting indicator) 0 – OFF


1 – ON Q Q quit emulator application and return

to prompt

Return State Description

RING Incoming Call Incoming Call <no caller ID>

RING

DATE=mmdd

TIME=hhmm

NMBR=nnnnnnnnnnn

NAME=TEXT

Incoming Call / Call Display Incoming call with caller ID

CONNECT Outgoing Call Call is connected / Audio OK Command Event Acknowledgment Response NO CARRIER Call In Progress Call Terminated BUSY Outgoing Call Destination Busy RINGING Outgoing Call Ringing at Destination (callee) ERROR WAIT Incoming Call While

CONNECTED Call Waiting

WAIT

DATE=mmdd

TIME=hhmm

NMBR=nnnnnnnnnnn

NAME=TEXT

Incoming Call While CONNECTED

Call Waiting with caller ID

OK: UP Application ready The signal indicates the application has completed a reset and is ready for commands

ERROR: DOWN Application down The signal indicates that the application is currently down.

GOODBYE Exit Exit of VoIP AT Command Set


Release Notes

Note Description Comment

1 Build Release Verification This build was initially tested for DEMONSTRATION PURPOSES ONLY using the VONAGE network

2 VoIP Accounts Page Fields The Following Fields MUST be completed: Phone Number / UID Authenticated User Authenticated Password Domain Realm SIP Proxy with port number eg xxx.xxx.xx.xx:5060 SIP Port RTP/ LAN Feature Magic:

3 DNS Required A valid and reachable DNS is required for the proper operation of this device.

4 Reset Button (GPIO-1) The reset button will reset the GUI password and LAN network settings when held in for 6 seconds during power cycle.

5 Speed Dials / Digit Map Override

Speed dials may be used to override the digit map and call blocking.

6 Telnet Enabled on engineering releases

7 IM features Send File, Share Whiteboard and Transfer Whiteboard SIP messages not supported for Nortel MCS. IM Not supported under Vonage

8 Watchdog Watchdog reset not enabled on engineering releases - device will halt on exception

9 Syslog Verbose logging enabled on engineering releases

10 Firmware Upload Blank Status Page During Firmware Upgrade due to timeout or network lease delay

FOR TECHNICAL SUPPORT PLEASE CONTACT:

ARCTURUS NETWORKS [email protected] SUBJECT TO CHANGE

release notes - arcturusnetworks.com · a demo setup guide provides documentation for the demo...

Documents