Installation Guide CMS SMARTCOM Abstract

Transcription

1 Installation Guide CMS SMARTCOM T100367E Rev. RC 1(18) Installation Guide CMS SMARTCOM Abstract This document describes the installation and configuration of the CMS smartcom process. A basic knowledge of the CMS system and configuration is needed (see T100192) for the understanding of this document. TABLE OF CONTENTS 1 INTRODUCTION GENERAL GETTING STARTED SMART FIRMWARE UPDATE CUSTOMISED FOX HELP FILES REFERENCE MANUAL GENERAL DECT IP (WiFi) General HANDSETS ALERT TYPES MESSAGES IN QUEUE BASE STATUS BASE FIRMWARE FOX HELP TRACE DECT VERSUS WIFI TROUBLESHOOTING MESSAGES NOT RECEIVED IN HANDSET DELETE OR CHANGE MESSAGE ARE NOT RECOGNISED BY THE HANDSET SUPERVISION FEATURE 1 (COMSTATUS) Units Values FEATURE 2 (RFPSTATUS) Units Values FEATURE 3 (RFPSYNCSTATUS) Units Values ABBREVIATIONS DOCUMENT HISTORY... 18

2 Installation Guide CMS SMARTCOM T100367E Rev. RC 2(18) 1 Introduction 1.1 General The smartcom process is an interface for the COBS SMART products as for example the SMART AP and the SMART1 handsets. A smartcom process communicates with the SMART AP base station and/or directly with the SMART1 handsets over WiFi. The communication interface enables the CMS to send and receive messages to and from a handset as well as supervising the base stations. SMART1 handset DECT Alarm/Messaging Voice WiFi Provisioning and Alarm/Messaging SMART AP DECT Base WiFi Access Point SMART Manager CMS SMARTCOM process There can be many smartcom processes in a CMS where each smartcom process communicates with one SMART DECT system.

3 Installation Guide CMS SMARTCOM T100367E Rev. RC 3(18) 2 Getting Started As an example we will configure a smartcom to communicate with a SMART AP with IP address Register a SMART1 handset with local (extension) number 205 in the SMART AP. Make sure that the SMART1 handset has the Messaging Service and FOX Messenger apps installed. Configure a smartcom process named SMARTCOM and add a license (see T100192). Enter the IP address, , of the SMART AP as Master Address. (Any of the SMART AP bases can be used as master) Leave the other fields as they are (default). Press the Save button. Restart the CMS. Now the communication status should indicate that the communication is up with the primary SMART AP. Click on the Handset tab in the top menu.

4 Installation Guide CMS SMARTCOM T100367E Rev. RC 4(18) You should now see all the handsets registered in the SMART AP. In this example we have 16 handsets registered in the base.

5 Installation Guide CMS SMARTCOM T100367E Rev. RC 5(18) Enter the address SMARTCOM/205 and the Alert Type 7 and press the Send Message button. The handset shall now receive the text TESTMESSAGE and beep with the Accept Tone.

6 Installation Guide CMS SMARTCOM T100367E Rev. RC 6(18) 3 SMART Firmware Update The SMART AP and the SPEAK handsets updates its firmware (and images) using a tftp server. The CMS can act as a tftp server for this purpose and then the firmware/image files are uploaded to the CMS using the SMARTCOM process. First enable the tftp server in the CMS under CONFIG->FTP/TFPT. In the SMART AP select the CMS as update server. Enter LhFwuLarge (default) as firmware path. Enter image (default) as terminal file path for updating the SPEAK images. Under the SMARTCOM process configuration select Firmware. Upload the SMART AP firmware under Base FW, SPEAK firmware under SPEAK Handset FW and SPEAK Images under Images. The firmware file names must not be changed as it contains information so the SMART AP will download the correct file from the CMS. Example: 8663_v0370_b0004.fwu 8663 is the SMART AP model number (8630 is the SPEAK model number). v0370 indicates it is version 370 (3.70) b0004 indicates version branch 4 NOTE! All SMARTCOM processes share the same tftp server on the CMS. So if you have several SMARTCOM processes in the same CMS they will show the same firmware updates. 4 Customised FOX Help files The FOX Messenger has a Help button that can be configured to open a website with user help information. The SMARTCOM process has a built in webserver and a default website with the FOX Help. The website can be exported and modified using a text editor and then uploaded again. This makes it very easy to create a customised help page for the FOX Messenger. The easiest way to create your own customised help is to edit the html files via an ftp client. The html root directory is: SMARTCOM/htdocs where SMARTCOM is the process name. When you have finalized the help website, then export it from the SMARTCOM->FOX Help. You will then get a compressed file that can be imported in the SMARTCOM processes. Another solution is to export the default website. Open the tar file and edit the html files to customise the help information. Compress the files again end import it to the SMARTCOM process.

7 Installation Guide CMS SMARTCOM T100367E Rev. RC 7(18) 5 Reference manual 5.1 General DECT Communication Status This is the current communication status. Down No communication with the SMART AP. Primary Communication is up with the primary SMART AP Alternative Communication is up with the alternative SMART AP Unknown The CMS is busy updating the status information, refresh the web page. Enable DECT Interface Check this to use DECT for sending/receiving messages to/from the SMART1 handsets. NOTE! If only WiFi is used then uncheck this to optimise performance. Master Address This is the IP address to the primary SMART AP master. Any of the SMART AP bases can be used as master. Alternative Master Address This is the IP address to the alternative SMART AP master. Any of the SMART AP bases can be used as alternative master. Base Port

8 Installation Guide CMS SMARTCOM T100367E Rev. RC 8(18) This is the port number that the SMART AP bases use for messaging IP (WiFi) Enable IP (WiFi) Interface Check this to use WiFi for sending/receiving messages to/from the SMART1 handsets. NOTE! If only DECT is used then uncheck this to optimise performance. Port This is the port number that the CMS will listen on for SMART1 messaging (also configured in the SMART Manager). Poll Interval (s) (0=no poll) This is the interval in seconds that the SMART1 handsets will poll the CMS. Shorter interval will give better reliability but shorter battery lifetime General No of Retransmissions to Handset This is the number of retransmission of a message to a handset if message not received. Retransmission Interval (s) This is the interval between retransmissions to a handset. No of Broadcast (DECT only) Retransmissions This is the number of retransmissions of a broadcast messages. Broadcast (DECT only) Retransmission Interval (s) This is the interval between broadcast retransmissions. Destination Address for PPSTATUS Messages (events) This is the address to which all PP Status messages form a handset will be sent. It is normally the process name of the ppstatus process in the CMS. Remove all char except 0-9, * and # from callback If this option is checked then the CMS will remove all character except 0-9, # and * from the callback number. In some special cases the callback number may contain other characters specific to certain applications and these cannot be handled by some PBX s. Default AlertType: The Alert Type used for an incoming message without alert type specified. 5.2 Handsets This is a list of all handsets detected in the SMART AP s and/or registered directly over WiFi.

9 Installation Guide CMS SMARTCOM T100367E Rev. RC 9(18) Address (LocalNo) This is the address of the handset, this is the same as localno and SIP extension number. Base The handset is registered on This is the base that the handset is currently registered on. As the SMART AP s are load balancing the handsets between them all handsets are not registered in the same SMART AP. Handset WiFi IP Address This is the IP address if the handset has directly registered itself over WiFi. 5.3 Alert Types The alert types define how the message shall be indicated in the handset. By default there are 10 alert types 0 9.

10 Installation Guide CMS SMARTCOM T100367E Rev. RC 10(18) Additional Alert Types can be added pressing Add New Alert Types. To edit the Alert Type click on the Alert Type No. As an example we will use the Alert Type 0 but the parameters are the same for all the 10 alert types, only the values differ.

11 Installation Guide CMS SMARTCOM T100367E Rev. RC 11(18) Alert Type This is the Alert Type Number. This number is a parameter in the incoming message that refers to this Alert Type. Name This name is only used in the web user interface and can be set to an arbitrary text. For a description of the other alert type parameters see chapter Fel! Hittar inte referenskälla.. NOTE! The behaviour of the different settings may change between software versions of FOX Messenger app.! Alert Pattern This is the how the tone in the handset shall sound. Continuous Internal Ring Cadence External Ring Cadence Alarm Signal Continuous ring signal. Similar to a PBX internal ringing signal (Not Used in FOX Messenger) Similar to a PBX external ringing signal (Not Used in FOX Messenger) Special Alarm signal (Alert Tone is ignored) Alert Tone This is the Alert tone in the handset.

12 Installation Guide CMS SMARTCOM T100367E Rev. RC 12(18) Silence Tone 1 Tone 2 Tone 3 Tone 4 Tone 5 Tone 6 Tone 7 Tone 8 Tone 9 Tone in PP Vibrate Key Click Key Beep Accept Tone Error Tone Not Used in FOX Messenger Tone Length Here you set for how long (0-255s) the Alert tone will sound. Not applicable for the following Alert Tones: Silence Key Click Key Beep Accept Tone Error Tone Display Timeout Here you set for how long (0-255s) the text message will be shown in the handset display. If it is set to 0 then the message will remain in the handset display until it is replaced by another text. Save Message in Handset Stack If this box is checked then the message will be stored in the handset mail stack memory, if not the message will only be shown in the handset display and not stored in the mail stack. Alert Always If this box is checked then the Alert Tone will break through Silent Mode in the handset. If Alarm Alert Pattern is chosen and this box checked then the Alarm signal will also break through an ongoing call. Vibrate With Tone If this box is checked then the vibrator will be activated together with the alert tone. Not applicable for the following alert tones: Key Click Key Beep Accept Tone Error Tone Vibrate Always Not used in the FOX Messenger Hide Callback If this option is checked then the supplied callback number will never be shown, though it will be called when pressing hook key. Disable Erase Option in Message Option Menu If this option is checked then Erase option in the message options menu will be disabled. Action This is the how the handset shall act when receiving the message:

13 Installation Guide CMS SMARTCOM T100367E Rev. RC 13(18) New Message Save Message as a new message. Change First Message With AlarmId Change the first existing message with the same AlarmId 1. If there is no existing message with the same AlarmId 1 then the message will be ignored. Delete First Message With AlarmId Delete the first existing message with the same AlarmId 1. Delete All Messages With AlarmId Delete all messages with this AlarmId Delete All Messages Delete all messages in handset. New/Replace Message With AlarmId Handle message as new message and delete any existing messages with same AlarmId Status Message Not treated as text message in handset. Change First Message and Replace All Messages With AlarmId Change the first message with this AlarmId and delete all other messages with the same AlarmId. 1 AlarmId is sent from for example the ALARM, OIP or WEBPAGE processes. Icon This is the Icon displayed when a new message is received. The Icons are numbered from 1 to 255. Note: All icons may not be available in all handsets. Icon Colour This is the background colour of the Icon. The colour is defined by a number between 0 and 255. Example: Red 192 Green 16 Blue 79 White 255 Yellow 248 Grey 109 Font Size If this is set to Large then the message text will be displayed with a larger font. Text Background Colour This is the background colour of the text in the message list. The colour is selected as the Icon Colour above. Text Colour This is the colour, black or white, of the text in the message list. LED Colour Red If this option is checked then the red LED will be used. LED Colour Green If this option is checked then the green LED will be used. LED Colour Blue If this option is checked then the blue LED will be used. LED Behaviour This defines how the LED will be used. On LED s selected above will be lit. Flashing Slow On/Off LED s selected above will be flashing slowly. Flashing Fast On/Off LED s selected above will be flashing fast. Flashing Slow Switching The LED will be switching slowly between the colours selected above. Flashing Slow Switching The LED will be switching fast between the colours selected above Add/Edit Custom Menu Add or edit custom menus sent to the handset together with this message.

14 Installation Guide CMS SMARTCOM T100367E Rev. RC 14(18) Add Menu Add a menu sent to the handset together with this message. Number This defines the order the menus are presented in the handset. Text: This is the menu text (1-20 characters) that will be presented in the handset. If this field is empty then the menu will not be displayed in the handset and for a change message leaving this field empty will remove the existing menu with this number in the handset. Type This defines the possible replies to the menu. Static: The reply from the handset is sent with an initiator indicating the menu number and message alarmid. Dynamic: It is also possible for the user to key in arbitrary information that will be sent together with the reply. The information is sent in the ackdata field that can be used by an external application via OIP, a webpage application or in the ppstatus process. Broadcast Exclude parameters from a broadcast message. As the broadcast message uses a low speed transmission channel, excluding message parameters that are not needed will improve the time to deliver a broadcast message. 5.4 Messages in Queue All messages that are placed in the internal message queue in the smartcom process are shown here. This could for example be messages not reached the handset and therefore wait for a retransmission. If there is no communication with the Wireless Server all messages will be queued up and shown here until the message timeout expires. 5.5 Base Status This page shows the status for the base stations and repeaters.

15 Installation Guide CMS SMARTCOM T100367E Rev. RC 15(18) Number This is the base radio number (RPN). Address This is the base station IP address. Status This is the communication (between the CMS and base) status of the base station. Unknown Up Down The status is unknown (not updated) The base is up. The base is down. Radio Sync This is the base radio sync. Primary Up Searching LAN Assisted Lost and Busy Lost and Free Running Unknown Primary sync source In sync Searching for sync source LAN Assisted sync (Not LAN sync) Lost sync, with active calls Temporarily lost sync, free running Sync status unknown

16 Installation Guide CMS SMARTCOM T100367E Rev. RC 16(18) 5.6 Base Firmware Upload Base SW to CMS TFPT server Select the SMART AP base station firmware file that shall be uploaded and click on upload. NOTE! Do not change the name of the firmware file! Base SW available on CMS TFTP server List of all firmware files uploaded to the CMS. All SMARTCOM processes in the CM share the same tftp server directory. 5.7 FOX Help Web server for FOX Help Select the port number and the LAN interface that the FOX Help web server shall be using. Import/Export FOX Help website to/from the CMS The FOX Help website can be exported/imported as a compressed file containing all the html files.

17 Installation Guide CMS SMARTCOM T100367E Rev. RC 17(18) Delete website Deletes the entire FOX Help website. After a restart the default website is created. 5.8 Trace These are activated trace levels for the process. Contact COBS support for more information on tracing. 6 DECT versus WiFi The messages can be sent to the SMART1 handset over DECT and/or over WiFi. Broadcast messages are not available using WiFi, they are always sent over DECT. If both DECT and WiFi is enabled then messages will first be sent over DECT and if not received then the first retransmission will be done over WiFi, if still not received then the second retransmission will be done over DECT again and so on. IMPORTANT! If only DECT is used then the WiFi interface must be disabled in both the CMS and the handset (via SMART Manager. And if only WiFi is used then the DECT interface must be disabled in both the CMS and the handset (via SMART Manager). 7 Troubleshooting 7.1 Messages not received in handset Check that Messaging service and FOX Messenger apps are installed and running in the handset. 7.2 Delete or change message are not recognised by the handset Check that any succeeding change or delete message has the same or lower priority than the original message. Otherwise the change or delete message may be prioritised and sent before the original message. 8 Supervision All supervision are done in a separate process, the supervisor, see T for more information on how to configure supervision. 8.1 Feature 1 (comstatus) This supervision feature monitors the status of the communication with the DECT Master (or Alternative Master). The default feature name is comstatus Units The DECT Master is always unit number 1. The default unit name is smartcom Values Value Default name Description 0 unknown The status is unknown (not updated) 1 primary up Communication with the Master SMART AP is up 2 down Communication is down 3 alt up Communication with the Alternative Master SMART AP is up 8.2 Feature 2 (rfpstatus) This supervision feature monitors the communication status of a base station (communication between the CMS and the base).

18 Installation Guide CMS SMARTCOM T100367E Rev. RC 18(18) The default feature name is rfpstatus Units The unit number (1-255) is the base station id+1 (unit number 0 is not valid). This means that the base with id 255 cannot be supervised. The default unit name is rfp Values Value Default name Description 0 unknown The status is unknown (not updated) 1 up The base communication is up 2 down The base communication down 8.3 Feature 3 (rfpsyncstatus) This supervision feature monitors the radio synchronisation status of a base station. The default feature name is rfpsyncstatus Units The unit number (1-255) is the base station id+1 (unit number 0 is not valid). This means that the base with id 255 cannot be supervised. The default unit name is rfp Values Value Default name Description 0 unknown The status is unknown (not updated) 1 up The radio is up 2 down The radio is down (not in sync) 3 master The radio is up and this base is primary sync master. 9 Abbreviations In this document the following abbreviations are used. SMART AP MN PP RFP Dect base station Message Node Portable Part / Handset Radio Fixed Part / Base station 10 Document History RA First edition RB Added FOX Help and Base Firmware RC Revised Firmware chapter to include SPEAK support.