Difference between revisions of "OPC Server"

Latest revision as of 13:49, 30 July 2024

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)
OPC UA

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.6.2
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 or 61113. This port(s) 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 stations the server can handle.

When the number of licensed stations 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.

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 AlphaCom OPC AE

A seperate ServerConfiguration Tool will be installed together with the AlphaComOPCServer.

For more details on configuration see OPC Classic for AlphaCom - Installation

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.

OPC Item tree structure:

Stentofon.AlphaCom.1
-> AlphaComOPCServer
-> AlphaGlobal
    -> Masters
-> Node1
    -> rci
        -> i{n}
    -> rco
        -> o{n}
    -> groups
        -> g{n}
    -> station{xxx}

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.

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 Note1! RCO items range needs to be configured in the OPCServerConfigurator tool Note2! Setting .setwithtime value to 0 will set rco on infinity!
rci*	UI	RO	Remote Controlled Inputs Item Subtree Sub Items: RO: .i{n}.state Where n is node RCI number in range 1..140 Note1! RCI items range needs to be configured in the OPCServerConfigurator tool Note2! RCI event update needs to be configured in AlphaPro, see alse AlphaPro OPC Config
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 Item value: Alarm Message number for playback in group. Item value for .playmsg: In the simplest form the message number as above Other optional parameters can be coded into the four bytes of I4 data type (one parameter in each byte): 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

Station Item Table

These items relates to a Zenitel Intercom station/device.

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 ASLT board present, no analog station connected 2 ASLT board present, analog station with failure 3 ASLT board present, analog station connected 16 IP (CCoIP) station/SIP User configured, but not registered 17 IP station connected but not authorized (Note: Currently not supported) 18 IP (CCoIP) station/SIP User connected and registered OK 19 IP station connected and authorized (Note: Currently not supported) 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
relatedto	BSTR	RW	Related station in connection A digit string representing the directory number of a connected station. The item is set when the station in busy, ringing or connection is established. 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 or G2000 Writing the string “null” to this item will cancel the call. Note: The value is case sensitive! Node1.station101 won't work. Use lower case values only!
callapri	UI	RO***	If station A in conversation the tag is set to the A subscriber 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. Only valid when a relatedto station is set. 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.
signaled	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	Writing “First” (case sensitive) will get the first station in queue to tag cr_iterate_station. Writing “Next” (case sensitive) will get 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	BSTR	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.
station_cos	UI	WO	Write value to change the Class of Service, valid values '1' to '16'.
output**	UI	RW	Station output item subtree. Read status of output or activate output on an IP station. 0 = Off. 1 = On. INCA stations: Output 1 - 3 Turbine Compact: Output 1 - 8 Turbine Extended: Output 1 - 10 IPARIO: Output 1 - 8
input**	UI	RO	Station input item subtree 0 = Off. 1 = On. INCA stations: Input 1 - 3 Turbine Compact: Input 1 - 8 Turbine Extended: Input 1 - 10 IPARIO: Input 1 - 8
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
customparameter1	UI	RO	Customized parameter (16 bit integer) set from the Event Handler in ICX-AlphaCom. Examples of event action strings: @*D1 M7F01 L(1)101 U0 W1200 W0 W0 W0 W0: Sends value 0x1200 for station 1/ node 1 to all nodes from all open OPC ports (61112 and 61113) The underlined parameters are not used by the OPC server, and should be set to "0". Obsolete format: @01C7 M7F01 L(1)101 U0 W1200 W0 W0 W0 W0: Sends value 0x1200 for station 1/ node 1 to node 1, port 61112 (use this format for AMC-IP software prior to 12.3.3.1) @02C4 M7F01 L(1)110 U0 W0200 W0 W0 W0 W0: Sends value 0x0200 for station 10/ node 1 to node 2, port 61113 (use this format for AMC-IP software prior to 12.3.3.1)
itemref	UI	RO	OPC Item reference (for internal use)
hwtype	UI	RO	Hardware type: 0x100 = SIP user (incl. ITSV phones) 0x101 = Dummy IP Station 0x7024 = SoftClient 0x7026 = Mixer SubChannel 0x8020 = DualDisplay station 0x8021 = INCA_Board_1 0x8022 = INCA_Board_2 0x8023 = Console station (Flush Master, IP-CROR..) 0x8024 = Desktop station 0x8026 = IP-ARIO unit 0x8121 = Turbine Compact 0x8124 = Turbine Extended 0x8169 = IP HeavyDuty, TKIE-3/4 0x8511 = Ex station 0x8630 = ENA-2100 amplifier 0x8674 = ENA-2200 amplifier
sttype	UI	RO	Station type: 0 = Illegal 1 = AlphaCom (Intercom server) 2 = RIO (Remote I/O unit with RCIs and RCOs) 3 = Control Handler (PC with call queuing features) 4 = Operator (Passive device without PING/PING, for Simple Link Layer terminal) 255 = Unknown (External computer with unspecific functionality)

(*) Reads back last written value (or default if not written to) 
(**) Items .output and .input are implemented for IP stations only.
(***) Only valid when the .relatedto station is set

Station Items and SIP Users

The OPC Station Items are designed for Zenitel (CCoIP) stations and devices. However, most OPC items are also supported when using SIP Users, including the ITSV-x video phones.

OPC Station Items that are not supported when using SIP users (including ITSV-x phones):

dialdak
dialdigits
mkey
tonetest

OPC Station Items that are partly supported:

The connect and relatedto items are used for initiating calls. The following limitations apply to these items:
- Initiate call from a Zenitel (CCoIP) station device is supported
- Initiate call from a generic SIP user is not supported
- Initiate call from an ITSV-x video phone is supported if AutoAnswer is set to Intercom/Paging only in the ITSV phone

The alarmmsg is supported if the SIP user has AutoAnswer enabled, and the AlphaPro flag Allow SIP Stations in Group Calls and as default speaker in SX Conference is enabled.

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 station type 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>31.10.2007 10:52:29<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> 31.10.2007 10:52:29 <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`