7.x Developer Guide

Symphony Hardware Interface SDK7.x

Developer Guide

Contents

Contents

Introduction......................................................................................................................................3Getting started.......................................................................................................................3Sample.................................................................................................................................. 3

Interfaces.........................................................................................................................................4IHardwareSystem.................................................................................................................. 4IHardwareSystemFactory...................................................................................................... 5IStatePersister....................................................................................................................... 6

Classes............................................................................................................................................8HardwareSystemType........................................................................................................... 8HardwareSystemConfiguration..............................................................................................8HardwareSystemConfigurationField......................................................................................9HardwareNode.................................................................................................................... 10HardwareNodeType............................................................................................................ 11LRangeDescription.............................................................................................................. 12HardwareCommand............................................................................................................ 12HardwareEventType............................................................................................................13HardwareState.....................................................................................................................13LocationDetails.................................................................................................................... 14HardwareEventArgs............................................................................................................ 14HardwareStateEventArgs.................................................................................................... 15HardwareStatusEventArgs.................................................................................................. 15

Enumerations................................................................................................................................ 17HardwareSystemStatus.......................................................................................................17HardwareStateType.............................................................................................................17HardwareEventTypeCategory............................................................................................. 17

Delegates...................................................................................................................................... 19HardwareEventReceivedHandler........................................................................................ 19HardwareStateChangedHandler......................................................................................... 19HardwareStatusChangedHandler........................................................................................19

Basic system initialization flow..................................................................................................... 20

Trobleshooting...............................................................................................................................21

Legal information.......................................................................................................................... 22

Symphony Hardware Interface SDK Developer Guide 2

Introduction

Introduction

The Symphony Hardware Interface SDK is a collection of .NET interfaces that can integrate hardwaresystems (for example, access control systems, I/O devices, and intrusion detection systems) with theSymphony Server.

Using the Symphony Hardware Interface SDK to integrate a hardware system with the Symphony Serverenables the following functionality:

• System configuration• Device status• Alarms• Commands

Getting started

1. Create a new .NET assembly DLL that includes an implementation of the IHardwareSystem andIHardwareSystemFactory interfaces in Core.Interface.HardwareSystemFactory.dll.

2. Put the new Core.Interface.HardwareSystemFactory.dll in the Symphony Serverinstallation folder.

The Symphony Server automatically loads the DLL and the functionality is available on the Integrationspage in the Symphony Server configuration interface.

Related referenceBasic system initialization flow on page 20

SampleThe HardwareSystemSample project is a sample of a hardware system integration.

The sample project consists of an implementation of the IHardwareSystem interface. The sample project canhelp you become familiar with the interface and you can use it as a template to for a new hardware systemproject.


Interfaces

Interfaces

IHardwareSystemThis interface defines the properties and methods that the Hardware System needs to implement to fullyintegrate with the Symphony Server.

Namespace

Core.Interface.HardwarePack.System

Properties

Name Type Description

Id string • The unique identifier of the systeminstance

• Set by the IHardwareSytemFactory fromSymphony Server

Type HardwareSystemType • The hardware system type

Status HardwareSystemStatus • The current status of the system

Nodes IEnumarable<HardwareNode> • Nodes tree that exists in the system• Thread safety: best practice to

synchronize access to this propertybetween the hardware system and theSymphony Server

• Write to nodes when the status is notConnected and do not write to nodes whenthe status is Connected

Events


EventsReceived HardwareEventReceivedHandler • Notification that an event has occurred(node and system level)

StateChanged HardwareStateChangedHandler • Notification that a state of a node haschanged

StatusChanged HardwareStatusChangedHandler • Notification that the status of the systemhas changed


Interfaces

Methods

Name Description Parameters Returns

Connect • The SymphonyServer calls Connectafter creating thehardware systeminstance

NA NA

GetState • Returns the state of anode

string nodeId

• The node ID toget the statefrom

HardwareState

The state of the noderequested

Send Command • Sends the command string nodeId

• The nodeto send thecommand to

string commandId

• The commandto send

NA

Extension methods


GetAllNodes • Returns all nodes inthe system as a flatlist

NA IEnumerable<HardwareNode>

GetUniqueNodeTypes • Returns all distinctnode types availablein the system

NA IEnumerable<HardwareNodeType>

IHardwareSystemFactoryThis interface defines the properties and methods that the Hardware System Factory needs to implementto fully integrate with the Symphony Server.

Namespace



Interfaces

Properties


Type HardwareSystemType • The hardware system typethat this factory creates

Methods


Create • Creates a newhardware systeminstance

string systemId

• The unique ID that the SymphonyServer allocates to the system

• The IHardwareSystem on page4.Id property for the createdsystem instance has this value

string settingsXml

• An XML string that holds theconfiguration settings of thesystem

• For more informationon configuration, seeHardwareSystemConfiguration onpage 8

IStatePersister Data

• An instance of IStatePersisterthat can save data to andload data from the SymphonyDatabase

NA

IStatePersisterThis interface defines the methods that a hardware system can use to persist data in the SymphonyDatabase. The data is saved even after the system is disposed, and can be loaded when the system isinitialized.


Interfaces

Namespace

Core.Interface.HardwarePack.Data

Methods


Load • Load the data thatwas saved in theSymphony Database

NA string

Save • Save data inSymphony Database

• Data links to thesystem ID.

string data

• The data to be savedin the SymphonyDatabase

NA


Classes

Classes

HardwareSystemTypeThis class represent the data of a system type that is used for enumerating system types and defining theconfiguration fields. This class is a property of IHardwareSystem on page 4 and IHardwareSystemFactoryon page 5 interfaces.

Namespace


Properties


Id string • The identifier of the hardwaresystem type

Name string • The name of the hardwaresystem type

• This name appears onthe Integrations page inthe Symphony Serverconfiguration interface

Configuration HardwareSystemConfiguration on

page 8

• The configuration details usedto generate user interfaces forediting the settings XML

• Set to null to use a basic textbox to edit settings XML

HardwareSystemConfigurationThis class defines the configuration details used to generate the user interfaces for editing the settingsXML of a hardware system.

Namespace


Properties


TemplateXml string • A settings XML with no valuesor with default values


Classes


Fields HardwareSystemConfigurationField

on page 9[]

• The definitions of the fieldsthat are included in theconfiguration

Details string[] • An array of field IDs that areconcatenated to generatesummary details

HardwareSystemConfigurationFieldThis class defines the configuration fields used in HardwareSystemConfiguration on page 8.

Namespace


Properties


Id string • The identifier for the field

Selector string • The selector to determine thelocation of field's XML elementin the settingsXml

• See https://api.jquery.com/category/selectors/

Type string • The field data type• All optional data types are

const members of this class• Includes:

• TypeString• TypeNumber• TypeBoolean• TypePassword• TypeIPAddress

DefaultValue string • The field default value

MinimumNumber int • The minimum number usingTypeNumber

• Null if not used

MaximumNumber int • The maximum number usingTypeNumber


Label string • The displayed label of the field


https://api.jquery.com/category/selectors/

https://api.jquery.com/category/selectors/

Classes


Row int • The field’s row in theconfiguration UI

Column int • The field’s column in theconfiguration UI

IsRequired bool • Is the field required

HardwareNodeThis class represents a hardware node in the system. A hardware node can represent a device, controller,input/output point, sensor, etc. The hardware node can have events triggered on, report its status, andsend commands.

Namespace

Core.Interface.HardwarePack.Node

Properties


Id string • The unique identifier of thenode

• Used in all node relatedoperations (for example, sendcommand, trigger event)

Name string • The display name of the node

Type HardwareNodeType on page 11 • The type of the node• Defines the events/

commands/states it supports

Parent HardwareNode • The parent node in the nodestree

Children List<HardwareNode> • The list of child nodes in thenodes tree

LocationRangeDescription LRangeDescription on page 12 • The location description of thenode

• Only for nodes that cansupport location based events



Classes


System IHardwareSystem • The system that the node ispart of

Methods


AddChild • Adds a child node• Updates Parent

property of the childand Children propertyof the current node

HardwareNode child none

HardwareNodeTypeThis class represents a Hardware Node type. It defines the states/events/commands that the nodes fromthis type supports.

Namespace


Properties


Id string • The unique identifier of theNode Type

Name string • The display name of the type

AvailableEventTypes List<HardwareEventType on page

13>

• A list of the events that thenode type supports

AvailableCommands List<HardwareCommand on page

12>

• A list of the commands thatthe node type supports

AvailableStates List<HardwareState on page 13> • A list of the states that thenode type supports

AccessGrantedEventTypes List<HardwareEventType on page

13>

• Only for Access Control typeof nodes

• A list of the events that thenode type supports thatrepresent Access Grantedevents



Classes


AccessDeniedEventTypes List<HardwareEventType on page

13>

• Only for Access Control typeof nodes

• A list of the events that thenode type supports thatrepresent Access Deniedevents


LRangeDescriptionThis class defines properties and methods that the hardware system needs to implement to fully integratewith the Symphony Server.

Namespace


Properties


Start uint • The start of the range

End uint • The end of the range

HardwareCommandThis class represents the hardware command data.

Namespace


Properties


Id string • The unique identifier of thecommand

• Used when sendingcommands)

Name string • The display name of thecommand


Classes


RequiredStates IEnumarable<HardwareState on

page 13>

• If this collection is not empty,the command is only availablewhen node state is one ofthese states.

• If this collection is empty, thecommand is always availableregardless of node state.

HardwareEventTypeThis class represents the hardware event type data.

Namespace


Properties


Id string • A unique Identifier of the event

Name string • The display name of the event

Category HardwareEventTypeCategory on

page 17

• The category of the event

HardwareStateThis class represents the hardware state data.

Namespace


Properties


Id string • A unique Identifier of the state

Name string • The display name of the state

Type HardwareStateType on page 17 • The type of the state

AlarmLocationDetails IEnumerable<LocationDetails on

page 14>

• A collection of locations detailswhere there are alarms (recentnon active, or currently active)


Classes

LocationDetailsThis class represents a location where there is currently an alarm (recently inactive or currently active).

Namespace


Properties

Name Type

DistancFromStartPoint float? • Distance from the start of therange

• Null if not available

Latitude float? • Absolute latitudinal position• Null if not available

Longitude float? • Absolute longitudinal position• Null if not available

Altitude float? • Absolute altitude• Null if not available

IsActive bool • Is the alarm currently active

HardwareEventArgsThis class defines the arguments that are sent on a hardware system event when triggered.

Namespace

Core.Interface.HardwarePack.Event

Properties


NodeId string • Node identifier the event istriggered on

NodeName string • Node name the event istriggered on

UserId long • The id of the user thattriggered the event


UserDescription string • The description of the userthat triggered the event



Classes


UserImageName string • The name of the user imagethat triggered the event


UserImageData byte[] • The user image that triggeredthe event


Location LocationDetails on page 14 • The location of the event• Null if not used

SystemId string • The system identifier the eventis triggered from

UtcTime DateTime • The time (in UTC) when theevent occurs

HardwareStateEventArgsThis class defines the arguments that are sent on a hardware system state change when a node statechanges.

Namespace


Properties


NodeId string • The identifier of the node forwhich the state changes

NodeName string • The name of the node forwhich the state changes

State HardwareState on page 13 • The new state of the node

SystemId string • The identifier of the hardwaresystem to which the node is apart

UtcTime datetime • The time (in UTC) when thestate changes

HardwareStatusEventArgsThis class defines the arguments that are sent when the status of the hardware system changes.

Namespace



Classes

Properties


Status HardwareSystemStatus on page

17

• The new status of thehardware system

SystemId string • The hardware system identifier

UtcTime datetime • The time (in UTC) when thestatus changes


Enumerations

Enumerations

HardwareSystemStatusThis enumeration defines the possible statuses of the hardware system.

Namespace


Values

Name Description

Error • The hardware system is in an unrecoverableerror state

• The Symphony Server disposes and recreatesthe system

Initialized • The hardware system is initialized and waitingfor a connection request

Connecting • The hardware system is in the process ofconnecting

Connected • The hardware system is connected

HardwareStateTypeThis enumeration defines the possible state types of the hardware node.

Namespace


Values

Name Description

Normal • The state is the normal state

Warning • The state is a warning state

Alert • The state is an alert state

HardwareEventTypeCategoryThis enumeration defines properties and methods that a hardware system needs to implement to fullyintegrate with the Symphony Server.


Enumerations

Namespace


Values

Name Description

Default • The default category

PIDS • The PIDS intrusion detection system category

AccessGranted • The access granted category• Used for access control systems

AccessDenied • The access denied category• Used for access control systems


Delegates

Delegates

HardwareEventReceivedHandlerThis delegate represents the method that handles an event received from a hardware system.

Namespace


Parameters


e HardwareEventArgs • An object that contains thearguments of the event

HardwareStateChangedHandlerThis delegate represents the method that handles a node state change event received from a hardwaresystem.

Namespace


Parameters


e HardwareStateEventArgs • An object that contains thearguments of the node statechange event

HardwareStatusChangedHandlerThis delegate represents the method that handles a system status event received from a hardware system.

Namespace


Parameters


e HardwareStatusEventArgs • An object that contains thearguments of the systemstatus event


Basic system initialization flow

Basic system initialization flow

Related tasksGetting started on page 3


Trobleshooting

Trobleshooting

Log files

The log files for the library can be found in the configured log folder. The file format for the log files isis-yymmdd_n.txt.


Legal information

Legal information

Copyright © 2021 Senstar Corporation and/or its Licensor(s). All rights reserved.

This material is for informational purposes only. Senstar makes no warranties, express, implied orstatutory, as to the information in this document.

Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rightsunder copyright, no part of this document may be reproduced, stored in or introduced into a retrievalsystem, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, orotherwise), or for any purpose, without the express written permission of Senstar Corporation

Senstar may have patents, patent applications, trademarks, copyrights, or other intellectual property rightscovering subject matter in this document. Except as expressly provided in any written license agreementfrom Senstar, the furnishing of this document does not give you any license to these patents, trademarks,copyrights, or other intellectual property.

Senstar and the Senstar logo are registered trademarks of Senstar Corporation.

All other trademarks are the property of their respective owners.


Date post:	26-Nov-2021
Category:	Documents
Upload:	others
View:	4 times
Download:	0 times

7.x Developer Guide

Documents