Stentofon AlphaCom E Quick Start Manual
  1. Manuals
  2. Brands
  3. Stentofon Manuals
  4. Conference System
  5. AlphaCom E
  6. Quick start manual

Stentofon AlphaCom E Quick Start Manual

Hide thumbs Also See for AlphaCom E:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual
STENTOFON SDK
API – APPLICATION PROGRAMMING INTERFACE
QUICK START GUIDE
A100K10674 V.2.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the AlphaCom E and is the answer not in the manual?

Questions and answers

Related Manuals for Stentofon AlphaCom E

Summary of Contents for Stentofon AlphaCom E

  • Page 1 STENTOFON SDK API – APPLICATION PROGRAMMING INTERFACE QUICK START GUIDE A100K10674 V.2.0...

  • Page 2: Table Of Contents

    2. API DESCRIPTION ................4 2.1. General Description ..............4 2.2. DLL description .................5 2.2.1. Licensed features ............5 2.3. Communication with the AlphaCom E exchange ......5 2.4. Remote connections ..............6 2.5. Connecting to the exchange .............8 2.6. AlphaCom Data Protocol message classes ......9 2.7.

  • Page 3: Introduction

    ● A lphaWiki: The online technical documentation centre for the AlphaCom E exchange AlphaWiki can be accessed from the API help file. Users outside the STENTOFON network must have a user name and password to access AlphaWiki. Please send an e-mail to alphasupport@zenitel.com request a user name and password. 1.4. Zenitel provides an SDK to support application software developers.

  • Page 4: Api Description

    AlphaCom Data Protocol, please refer to AlphaWiki. The STENTOFON SDK API for AlphaCom E consists of a number of assemblies (DLLs) which can easily be integrated with software written in C# or VB.NET.

  • Page 5: Dll Description

    AlphaCom E network which the 3rd program subscribes to. AlphaCom Application The .dll supports the STENTOFON AlphaNet. This means that all AlphaCom E exchanges and stations in a network can be addressed by having an IP connection to just one of the AlphaCom E exchanges. Stentofon.AlphaCom.Data.dll The .dll requires Microsoft .NET 2.0.

  • Page 6: Remote Connections

    This statement gives the IP address and port number of the AlphaCom E exchange where the API will be connected to. When there are a number of AlphaCom E exchanges networked together in an AlphaNet, the API only needs the IP address or port number of one of the exchanges in the network.
  • Page 7 AlphaCom IP-address ● AlphaCom TCP/IP port nr ● Local TCP/IP port nr Can be entered in the field ‘Start parameter’. The parameters must be separated by a ‘space’. The service must be stopped and started again for the new parameters to take effect. A100K10674 V.2.0 Page 7 API - STENTOFON SDK...

  • Page 8: Connecting To The Exchange

    Connecting to the exchange The following is a code example of how to connect to a single AlphaCom E exchange or all exchanges in an AlphaNet network using a direct connection. This program will register with all exchanges in the AlphaNet and maintain the connections.

  • Page 9: Alphacom Data Protocol Message Classes

    2.6. AlphaCom Data Protocol message classes The API communicates with AlphaCom E via the AlphaCom Data Protocol. The ‘.Messages’-namespace provides classes for AlphaCom Data Protocol Messages. using Stentofon.AlphaCom.AlphaNet.Messages; 2.7. Event reports Activity inside the exchange can raise events. The following is an example.

  • Page 10: Sending Commands To Alphacom E

    All information related to an intercom station is part of an object of type StationState. The StationState class also has the methods implemented to format commands to be sent to the AlphaCom E on behalf of an intercom station. Methods where the name starts with ‘MakeCommand’, will format and store the command.

  • Page 11: Oncustomparameter Event

    AlphaCom E. An example of an action in the event handler action field @nnff M7F01 %1.ref %2.ref Wpar1 Wpar2 Wpar3 Wpar4 Wpar5 Where: nn is the node number of the AlphaCom E exchange to which the API connects. It can be any value from 0x01 to 0xfe, represented by 01 to FE...

  • Page 12: Oncustomparameter Example

    An example of the use of the OnCustomParameter event is an interface application between the AlphaCom E exchange and a CCTV system. The rest of this section assumes knowledge of the AlphaCom E and its programming tool, AlphaPro. A number of guard intercom stations are associated with monitors. A number of door intercom stations are associated with cameras.
  • Page 13 Most applications need to be able to retrieve StationState at any moment and most applications will implement structures to store this information. The Stentofon.AlphaCom.Data.dll provides a standardized method to store and retrieve StationState objects either in a MySQL database or in memory.

  • Page 14: Mail Messages

    Depending on the kind of application, these events are used for information that is important. It is recommended to either monitor all mail events or only the call request events. Supported events are: A100K10674 V.2.0 Page 14 API - STENTOFON SDK...

  • Page 15: Connect Call

    ACDP command as a parameter in Simple Link Layer format. ● Public bool SendAlphaCommand(String cmd) The statement below will set up a call between stations with directory numbers 101 and 102: ● SendAlphaExecuteCommand(“$CALL L101 L102”) A100K10674 V.2.0 Page 15 API - STENTOFON SDK...

  • Page 16: Other Available Events And Methods

    AlphaCom E exchange ● Read door open/closed status or other status signals through logical inputs under the control of the AlphaCom E exchange The API will be extended in the future when new features become available in the AlphaCom E. Suggestions for implementation of specific events and methods may be sent to alphasupport@zenitel.com.

  • Page 17: Sdk Application

    Once the Configuration dialogue is closed, click on the ‘Connect’-button. 3.2.2. Station selection and status Once the application has discovered stations it is possible to select one of those stations, show its status and perform commands on behalf of that station. A100K10674 V.2.0 Page 17 API - STENTOFON SDK...

  • Page 18: Station Commands

    _selectedStation.MakeCommandDialDigits(Digit); _client.SendAlphaCommand(_selectedStation); M-key down: _selectedStation.MakeCommandMKey(KeyPressState.Press); _client.SendAlphaCommand(_selectedStation); M-key up: _selectedStation.MakeCommandMKey(KeyPressState.Release); _client.SendAlphaCommand(_selectedStation); Clicking the C-key: _selectedStation.MakeCommandCKey(); _client.SendAlphaCommand(_selectedStation); DAK keys Clicking one of the DAK buttons will simulate pressing a DAK key on an intercom station. _selectedStation.MakeCommandDialDak(dak); _client.SendAlphaCommand(_selectedStation); A100K10674 V.2.0 Page 18 API - STENTOFON SDK...

  • Page 19: Stentofon.alphacom.example.callrequest

    Selecting a station in this dropdown menu will set up a conversation with that selected station. _selectedStation.MakeCommandCallSetup(cr.SendingStation); _client.SendAlphaCommand(_selectedStation); The call can be cancelled by double clicking the listed connection after ‘Call Connection’. _selectedStation.MakeCommandCKey(); _client.SendAlphaCommand(_selectedStation); A100K10674 V.2.0 Page 19 API - STENTOFON SDK...
  • Page 20 A100K10674 STENTOFON and VINGTOR products are developed and marketed by Zenitel Norway AS. The company’s Quality Assurance System is certified to meet the requirements in NS-EN ISO 9001:2008. Zenitel Norway AS reserves the right to modify designs and alter specifications without prior notice, in pursuance of a policy of continuous improvement. © 2010 Zenitel Norway AS.

Table of Contents