OPC Server
From Zenitel Wiki
Contents
Description
The AlphaCom OPC[1] Server implements the following OPC standards:
- OPC Data Access (OPC DA V2/V3)
- OPC Alarm & Events (OPC AE V1.1)
The Server is running on the Microsoft .NET framework, and OPC Core Components must be installed on the PC running the server.
Prerequisites:
- .NET Framework 4.0, 2.0 or 1.1
- OPC Foundation OPC Core Components or Advosol OPC Core Components for 32-bit/64-bit operation
The OPC Server communicates with the AlphaCom over the TCP/IP protocol on the TCP port 61112. This port must be opened in the Filter settings in AlphaWeb.
For the server to operate an API License has to be supplied to the AlphaCom. In an AlphaNet each exchange must have its own API license. When the OPC server initiates contact with the AlphaCom node, the node will report back the number of licensed station the server can handle.
When the number of licenses station for a node is reached it will stop registering more stations. Tags for the number of stations registered and the number of licensed status can be found in the item tree for each node.
For step by step instructions, see Installation of AlphaCom OPC Server
Server Configuration
The Server is very much self configured, but some parameters needs to be supplied during installation.
The one required parameter for the OPC Server is the IP address of AlphaCom it will be connected to. The following parameters are optional:
In an AlphaNet the Server needs to know for which nodes it shall build the OPC DA item tree from. This node list will also be used to filter which events are reported. If no node list is supplied the server will by default only handle the local node it is directly connected to. If a DA-Client application is set-up with one or more master stations, these should be added to a “Master Station List”. The Client can then use the unique ID from the list to refer to a Master station. For OPC AE all AlphaCom Events for a station can be individual configured. See also AlphaComOPC AE
A seperate ServerConfiguration Tool will be install together with the AlphaComOPCServer.
For more details on configuration see Installation of AlphaCom OPC Server
OPC Data Access
The OPC Server will at startup ask the AlphaCom for a list of all Stations with their current status. If AlphaNet nodes are configured, these stations will also be asked for. The Server will build an OPC item tree for these stations. The access path for a specific station will be a node number and directory number. Each station will have multiple items defining different properties of that station.
Example of OPC Item tree:
Stentofon.AlphaCom.1 --> AlphaComOPCServer --> AlphaGlobal --> Masters --> Node1 --> rci -- >i{n} --> rco --> o{n} --> groups --> g{n} --> station{xxx}
Station Item Table
These items relates to a AlphaCom station. Root DA Item is node{nn}.station{xxx} where nn is the AlphaNet node number and xxx is a station directory number, i.e node1.station101
| Item Name | Data Type | Access | Description |
|---|---|---|---|
| busy | UI | RO | Station Busy state: 0 = Free, 1 = Busy |
| mailqueue | UI | RO | Station mail queue state: 0 = no mail, 1 = mail queue |
| linestate | UI | RO | Line State:
0 Board not present 1 SLI board present, no station 2 SLI board present, station with failure 3 Station connected to SLI board 16 IP station configured, not connected 17 IP station connected but not authorized 18 IP station connected and registered OK, auth not required 19 IP station connected and authorized 20 IP station connected but no license available |
| tonetest | UI | RO | 0 = Tone test OK, 1 = Failed. (valid from AlphaSys v 11.1.3.2) |
| operational | UI | RO | 0 – the station is not operational, 1 – the station is operational |
| phyno | UI | RO | Station Physical number |
| text | BSTR | RO | Station display text, maximum 16 characters |
| related_to | UI | RW | Related station in connection
A digit string representing the directory number of a connected station. Only set if the station is in active connection. Writing a valid directory number to this item will setup a call between the stations. The format of the station reference is the OPC access path of the related station, example: node1.station101 An AlphaCom Station reference format is also accepted for local and global numbers, example: L(1)101 G2000 Writing the string “null” to this item will cancel the call.<br\ > Note 1: The value is case sensitive! Node1.station101 won't work. Use lower case values, only! |
| callapri | UI | RO*** | If station A in conversation the the tag is set to the A subcriber priority.
If station B in conversation set to 0. Call Priorities: 1=Low 2=Medium(normal) 3=High 4=Alarm |
| callmode | UI | RO*** | The Call Mode describing the .relatedto connection. Set for both A-Station and B-Station.
Call Mode: 0=No access 1=Open call 2=Private call 3=Busy 4=Connected |
| alarmmsg | UI | RW* | Set up (or disconnect) an ASVP Alarm message to a single station. The command $ALRM is sent to the AlphaCom. Uses Volume and handset override. |
| signalled | UI | RO | Set to true for signalling to the client that the station needs some kind of attention.
An AlphaCom call request sent from this station triggers this state. When the call request is removed this state will be reset. |
| connect | UI | RW | Used to connect to this station from a pre-configured “Master station”. A list of master stations can be programmed, and referenced to by its unique ID (1-100).
Writing a ‘0’ will cancel the active connection. |
| synchronized | UI | RW | If this variable reads a ‘1’ the station information, and the stations call request queue should be in sync with the AlphaCom.
If the event based synchronization is not trusted it is possible to write a ‘0’ to the “synchronized” item. All states and queue for this station will then be refreshed from the AlphaCom. |
| cr_queue_length | UI | RO | The length of this stations Call Request Queue. |
| cr_iterate_station | BSTR | RO | The ID (OPC station tag format) of the active station during a iteration process |
| cr_iterate_command | BSTR | RW | “First” gets the first station in queue to tag cr_iterate_station. “Next” gets the next station in the queue. If no more stations after a “Next” cr_iterate_station is set to “eol” |
| cr_delete_command | BSTR | RW | If a valid station ID is written to this tag and it exist in the queue list a $DELETE_MAIL is sent to the AlphaCom. |
| dialdigits | UI4 | RW* | Simulates Dialing the supplied digits on the station. Up to nine digits are supported through the UI4 varibale. One or more DIAL_DIGITS messages can be used in sequence. The digits are interpreted in the current station state, i.e. dialing both from idle and during connection. |
| dialdak | UI | RW* | Dial DAK key on a station (DAK 1-100) |
| ckey | UI | RW* | Write value '1' -> Order station to press C key. Note: C-key has no key-press/key-release operation " |
| mkey | UI | RW* | Write value '1' -> Order station to press M-key. Write value '0' -> Order station to release M-key. |
| output** | UI | RW | Station output item subtree
.output.1: 0 = off, 1 = on |
| input** | UI | RO | Station input item subtree
.input.1: 0 = off, 1 = on |
| rco | BSTR | RW | Station RCO bitmap
Obsolete (Removed in 5.0.0.0) - Please use .output |
| rci | UI | RO | Station RCI bitmap
Obsolete (Removed in 5.0.0.0) - Please use .input |
| customparamter1 | UI | RO | OPC Item reference (for internal use)
The parameter will enable sending of a custom parameter (16 bit int) from the evnethandler programmed in AlphaPro. Sending value 0x1200 to node1 port 61112, station 101: @01C7 M7F01 L(1)101 U0 W1200 W0 W0 W0 W0 Sending value 0x0200 to node2 port 61113, station 110: @01C4 M7F01 L(1)110 U0 W0200 W0 W0 W0 W0 |
| itemref | UI | RO | OPC Item reference (for internal use) |
(*) Reads back last written value (or default if not written to) (**) Only implemented for IP substations with three outputs, and three inputs. (***) Only valid when the .relatedto station is set
Node Item Table
These items relates to a AlphaCom node in an AlphaNet. Root DA Item is node{nn} where nn is the AlphaNet node number, i.e node1
| Item Name | Data Type | Access | Description |
|---|---|---|---|
| NodeStatus | UI | RO |
Node status reported from the AlphaCom 0 – No node connection 1 – Node connection OK 4 – No OPC license 6 – Overlapping registration of same OPC device from different nodes |
| ResponseTime | UI | RO | When connection OK the Ping return time from OPC server to node. |
| StationsAdded | UI | RO | 0 – No stations added, probably no license or some other error, 1 – Stations has been successfully added |
| AddedMessage | BSTR | RO | A detailed status on the station add process |
| NumberOfStations | UI | RO | The number of stations added to this node tag tree. |
| StationLicenseCount | UI | RO | The number of stations licensed for this node. |
| rco* | UI | RW | Remote Controlled Outputs Item Subtree
Sub Items: RW: .o{n}.state
WO: .o{n}.setwithtime
WO: .o{n}.setvalue
Where n is node RCO number in range 1..500 |
| rci* | UI | RO | Remote Controlled Inputs Item Subtree
Sub Items: RO: .i{n}.state
Where n is node RCI number in range 1..140 |
| groups | UI | RW | Local station Groups
Sub Items: RW: .g{n}.playmsg -> Play an alarm message to group (with optional parameters). Sends $GM command to AlphaCom.
RW: .g{n}.stopmsg -> Stop alarm message playing to group. Sends $GMS command to AlphaCom.
RW: .g{n}.alarmmsg -> Simplified start/stop alarm message playing to group (write 0 to stop playing). Sends $ALRM command to AlphaCom. Uses Volume and handset override.
Where n is node Group number in range 1..250 byte1, {n}: n -> Announcement message for playback in group.
byte2, {n}*0x100: n -> SVP Message repetitions 0-255. 0 or unspecified means 1 repetition. 255 means repeat indefinitely (use .stopmsg to stop)
byte3, {n}*0x10000: n -> Gong type. 1 = no gong. 255 or unspecified = use gong type of group.
byte4, {n}*0x1000000: n -> Group call priority, default 0 = use priority of group call.
Examples: .playmsg = 0x2 -> Play Alarm message number 2 (No repetition and use group gong and priority ) .playmsg = 0x302 -> Play Alarm message number 2, with 3 repetitions .playmsg = 0x10302 -> Play Alarm message number 2, with 3 repetitions, using no gong .playmsg = 0x2ff0302 -> Play Alarm message number 2, with 3 repetitions, use gong type of group, and priority 2 .stopmsg = 0x2 -> Stop Playing Message number two Note1! Group items range needs to be configured in the OPCServerConfigurator tool |
(*)Note! RCI/RCO states are updated on state changes, but are not synchronized at OPC Server startup
OPC Server Item Table
These items relates to the OPC Server. Root DA Item is AlphaComOPCServer
| Item Name | Data Type | Access | Description |
|---|---|---|---|
| Version | BSTR | RO | The AlphaComOPCServer Version (1st release is 4.0.0.0) |
| TCPConnected | UI | RO | 0 - No TCP connection, 1 - TCP connection with AlphaCom is established. |
| AlphaIPAddress | UI | RO | The IP address of the connected AlphaCom |
| AlphaTCPPort | UI | RO | The port of the IP connection |
| PingTime | UI | RO | The application-level Ping time in milliseconds (monitored each 5th second) |
| NumberOfNodes | UI | RO | Number of AlphaCom nodes the OPC Server is registered with. |
| NumberOfStations | UI | RO | The total number of stations registered by the OPC Server |
| LicenseCode | ?? | RO | Obsolete (To be removed) |
| LicenseStatus | ?? | RO | Obsolete (To be removed) |
Global Item Table
These items relates to the Master stations defined in the OPC Server. Root DA Item is AlphaGlobal
| Item Name | Data Type | Access | Description |
|---|---|---|---|
| Masters.NN | UI | RO | A list of the configured Master stations.
When using the nodeXX.stationYY.connect item listed above, the numeric ID from this list has to be used. |
OPC Alarm & Events
A set of AlphaCom events can be sources for OPC AE Events. The OPC event type, state, severity and message text can be configured for each AlphaCom Event.
AlphaCom Event table
| AlphaCom Event Name | Description/Parameters |
|---|---|
| CallStatus | A Call Initiated from Station A to Station B, with time, priority, and call mode. |
| StationConnect | A Call connection with connection time and reference. |
| StationDisconnect | A call disconnection with time, reference and duration. |
| CallReject | The Call was not accepted (Disconnect without a Connect) with time |
| CallRequest | A Call Request with Receiving Station, Sending Station, mail tag, priority, mail text and time. |
| RequestRemoved | A Call Request Removed with Receiving Station, and mail tag |
| StationOK | Station Up and OK with station type details. (sent when a station with failure is back up) |
| StationFail | Station Failure with details. |
| StationSignaled | The station has sent a Call Request (Requires Attention) |
| StationSignalHandled | The sent Call Request has been handled (removed from receiving queue) |
For each of the above AlphaCom Event sources the following OPC AE parameters can be configured:
OPC Event parameter table
| OPC AE parameter | Description |
|---|---|
| Type | The OPC Event type, possible values:
Simple Condition NoEvent |
| Source Name | A string with the event source name. This will be appended to the access path of the station, example: node1.station1.{sourcename}
The same sourcename can be used for multiple AlphaCom events, but then they need to be of the same type. Typically the same name will be used for two condition events with the Alarm/Normal state. |
| Severity | The Event severity in the range 1..1000 |
| Condition State | The state to set for a condition event:
Alarm Normal |
| Message Text | A Set of pre-defined formats or a custom format with possible parameter insertion. |
OPC Event message format
The event message format is configurable from the ServerConfiguration Tool. A set of predefined formats is defined but the OPC integrator can also choose to use a customable format.
Note that the OPC server reads the configuration at startup. If you change the Event Message format the OPC server needs to be restarted for the changes to take effect. Restart the OPC server by stopping all OPC clients, and start them again.
| Format | Description/Example |
|---|---|
| OneLine | Message formatted in a single line humane readable with most of the message information
StationConnect: (Node 3, DirNo 1001)->(Node 3, DirNo 1000) at 31.10.2007 10:52:29, Ref:100 |
| Detailed | A multiline format with all information in a message.
AlphaNet Message: Station Connect Connection at time: 31.10.2007 10:52:29 Connection Ref: 100 Station A: Node 3, DirNo 1001 Station B: Node 3, DirNo 1000 |
| Short | A very short message with little information (i.e for STATION_STATE only the directory number is presented).
(Node 3, DirNo 1001)->(Node 3, DirNo 1000) |
| XML | Detailed information in a XML format with no formatting (line shifts, indenting etc).
<ALPHAMSG TYPE=StationConnect><STATION_A><NODE>3</NODE><DIRNO>1001</DIRNO></STATION_A><STATION_B><NODE>3</NODE><DIRNO>1000</DIRNO></STATION_B><REF>100</REF></ALPHAMSG> |
| XMLPretty | Same as above, but with line formatting.
<ALPHAMSG TYPE=StationConnect>
<STATION_A>
<NODE>3</NODE>
<DIRNO>1001</DIRNO>
</STATION_A>
<STATION_B>
<NODE>3</NODE>
<DIRNO>1000</DIRNO>
</STATION_B>
<REF>100</REF>
</ALPHAMSG>
|
| Custom | Customable strings.
Format string: “Call Connect {0}->{1} at {2}, ref={3}” Call Connect Node 3, DirNo 1001->Node 3, DirNo 1000 at 31.10.2007 10:52:29, ref=100 |