Lundix It SPC Bridge User Manual

Download

Page 1

SPC Bridge User Manual

Revision 1.0

Page 2

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

2 of 14

Reference

2017-111

History Record

Revision

Date

Author

Comment

1.0

Nov-2017

Lundix IT

First edition

Lundix IT Renvägen 22 S-433 70 Sävedalen Sweden [email protected]

Page 3

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

3 of 14

Reference

2017-111

Contents

1 INTRODUCTION ................................................................................................................................... 4

1.1 SPC Bridge .................................................................................................................................................................................... 4

1.2 Features ........................................................................................................................................................................................ 4

1.3 Hardware Specification .......................................................................................................................................................... 4

1.4 Terminology and Abbreviations ........................................................................................................................................ 4

2 INSTALLATION ..................................................................................................................................... 6

2.1 Installation Prerequisites ...................................................................................................................................................... 6

2.2 Installation Steps ...................................................................................................................................................................... 6

3 CONFIGURATION ................................................................................................................................. 7

3.1 IP Address .................................................................................................................................................................................... 7

3.2 Time Setting ................................................................................................................................................................................ 7

3.3 Change Administration Password ..................................................................................................................................... 7

3.4 SPC Communication (FlexC) ................................................................................................................................................ 7

3.4.1 SPC Panel FlexC Settings. ............................................................................................................................................................................................. 7

3.4.2 SPC Bridge SPC Communication Settings ............................................................................................................................................................. 8

3.5 Bridge API ................................................................................................................................................................................... 9

3.6 SPC Test Tool ........................................................................................................................................................................... 10

4 ADVANCED USERS............................................................................................................................. 11

4.1 Backup of Configuration Settings ................................................................................................................................... 11

4.2 Upgrading software .............................................................................................................................................................. 11

4.3 SSH Access ................................................................................................................................................................................ 11

5 LICENSE AGREEMENTS ................................................................................................................... 12

5.1 End-User License Agreement for SPC Bridge (EULA) ........................................................................................... 12

5.2 Open Source Software ......................................................................................................................................................... 13

5.3 Open Source Hardware ....................................................................................................................................................... 13

Page 4

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

4 of 14

Reference

2017-111

1 Introduction

1.1 SPC Bridge

SPC Bridge is a network hub for bridging Vanderbilt SPC intrusion detection system to third-party systems. The bridge converts Vanderbilt IP protocol FlexC to a REST/Websockets API that is easy to use for integration with other platforms and products. SPC Bridge can be used with any SPC panel that supports the FlexC protocol.

1.2 Features

 SPC Panel Communication using FlexC  REST and Websockets API for easy integration with third-party products.  Web based Admin GUI

1.3 Hardware Specification

Processor

400MHz, 24K MIPS

Flash

16MB

RAM

64MB

Power input

9 – 12V DC

Network

2 x 10M/100M RJ45 Connectors

WiFi

802.11 b/g/n

USB

1 x USB 2.0 host connector

Type Approval

FCC Part15 Subpart B, Subpart C, CE NB, C-Tick

1.4 Terminology and Abbreviations

Term

Description

FlexC

Vanderbilt SPC Flexible Secure Communications Protocol

Page 5

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

5 of 14

Reference

2017-111

REST API

Representational State Transfer

API

Application Programming Interface

URL

Uniform Resource Locator

WebSocket

Two-way TCP protocol RFC 6455

Page 6

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

6 of 14

Reference

2017-111

2 Installation

2.1 Installation Prerequisites

 Vanderbilt SPC panel with firmware >= 3.6 (3.6 was the first version with support for FlexC)  Network router with DHCP server enabled  Network connection between the SPC SmartBox and the SPC panel  Internet access (to be able to use time synchronization via NTP)

2.2 Installation Steps

1. Read carefully End-User License Agreement for SPC Bridge (EULA) in last section in this document. If

you do not agree to the terms of the EULA, do not install or use the SPC Bridge.

2. Connect SPC Bridge LAN port, with a regular network cable, to your network switch or router.

3. Power up the device by connecting the included power adapter to a wall socket and then to the SPC

Bridge device.

4. Wait (~2 minutes) until the SPC Bridge has fully started.

5. Login to your router and look for the IP address assigned to the SPC Bridge.

6. Open a web browser and enter the IP address of the SPC Bridge.

7. In the login window, enter Username (root) and Password (default is dragino) and you will see the

main menu.

8. You can now proceed with the configuration.

Page 7

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

7 of 14

Reference

2017-111

3 Configuration

SPC Bridge device is based on a standard Linux platform, OpenWrt, that is normally used for routers, therefore you will find many standard configuration options in the Web GUI. In this manual only configuration specific for the SPC Bridge functions is described. Most of these functions are available in the main menu – SPC Bridge. For configuration of generic OpenWrt functions please see wiki.openwrt.org .

3.1 IP Address

Default will SPC Bridge use DHCP to get an IP Address. To set a static IP Address, go to Network -> Interfaces and:

1. Select LAN – Edit.

2. In Interfaces – LAN, select Static address in the Protocol option menu

3. Click on Switch Protocol

4. In Common Configuration – General Setup fill in; IPv4 address, netmask, gateway and custom DNS

servers.

5. In DHCP Server – General Setup; check the checkbox Ignore interface.

6. Click on Save & Apply.

7. Redirect your browser to the new IP Address.

3.2 Time Setting

To set correct Timezone, go to System -> System and select Timezone in section System Properties – General Settings.

The device is as default using NTP to synchronize time. This setting is in System -> System section Time Synchronization.

3.3 Change Administration Password

The default administration password for accessing the device is dragino. Of security reasons it is highly recommended to change the password as soon as possible. Go to System -> Administration section Device Password to change the password. The same password is used in both Web GUI and for ssh access to the device.

3.4 SPC Communication (FlexC)

To setup the communication link between SPC Panel and SPC Bridge you have to configure the link in both SPC Panel and SPC Bridge ends.

3.4.1 SPC Panel FlexC Settings.

Use Vanderbilt SPC Web interface and define the FlexC communication following this instructions:

NOTE! The device has no RTC clock. During boot the device can have incorrect time. Some events

in the system log can therefore have incorrect timestamps.

Page 8

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

8 of 14

Reference

2017-111

1. Select Full Engineer mode

2. Create a specific user for the SPC Bridge communication, e.g spcbridge. User profile should be

Manager and you need also to define a web password for the user.

3. Select Communications -> FlexC -> Event Profiles. Click on Add to add a new event profile. Give the

event profile the name SPC Bridge Events and select (check) the report checkboxes for all event types. (You may consider reducing these settings later to just necessary events for the third-party application)

4. Select Communications -> FlexC -> FlexC ATS. Select Add Custom ATS and change following from

the default settings:

- ATS Name = SPC Bridge

- Event Profile = SPC Bridge Events (created in step 3)

- ATS Polling Timeout = 60 seconds

- Uncheck Generate FTC and Re-queue Events

5. Select Add ATP to FlexC RCT and change following from the default settings:

- SPT Account Code = 999

- RCT URL or IP Address = IP Address of the SPC Bridge

- ATP Category = Cat 6 [Ethernet]

6. Open Advanced ATP Settings and change following from the default settings:

- Encryption Key Mode = Fixed Encryption

- Encryption key (64 hex digits) = Your own key (must match the key in the SPC Bridge)

3.4.2 SPC Bridge SPC Communication Settings

In the SPC Bridge Web interface select SPC Bridge->SPC Communication and fill in the form according to:

Element

Description

ATP Encryption Key

ATP Encryption Key. 64 hex numbers (0-9, a-f, A-F). Must match corresponding key in SPC Panel FlexC settings.

Page 9

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

9 of 14

Reference

2017-111

SPC Account Code

ATP Account Code. Must match corresponding key in SPC Panel FlexC settings.

RCT ID

RCT Id. Must match corresponding id in SPC Panel FlexC settings.

RCT TCP Port

RCT TCP Port. Must match corresponding value in SPC Panel FlexC settings.

SPC Username and Password

Credentials for FlexC communication. User must be defined in the SPC Panel and have a corresponding web password.

3.5 Bridge API

The SPC Bridge provides a generic web service interface to the SPC panel. The main feature of this interface is to simplify SPC integration with third party applications and products such as Home and Building Automation Systems, Smartphone App’s and Web applications. The API is using HTTPS and REST principles (RESTful) for queries and commands to the SPC panel and WebSockets for reporting events from the SPC panel. HTTPS GET methods are used for queries and HTTPS PUT methods for commands. The communication is always encrypted (HTTPS)

To configure the interface, go to SPC Bridge -> Bridge API and fill in the form.

Element

Description

API Server Settings

Port

API Server IP port.

Access Control List

Access Control List (ACL) allows restrictions to be put on the list of IP addresses which have access to the API server. The ACL is a comma separated list of IP subnets, where each subnet is pre-pended by either a - or a + sign. A plus sign means allow, where a minus sign

Page 10

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

10 of 14

Reference

2017-111

means deny. If a subnet mask is omitted, such as -1.2.3.4, this means to deny only that single IP address. Subnet masks may vary from 0 to 32, inclusive

REST/Websockets Credentials

Username and Password Queries

Username and password for queries to SPC Bridge. Default username is get_user and password get_pwd.

Username and Password Commands

Username and password for commands (e.g. arm/disarm) to SPC Bridge. Default username is put_user and password put_pwd.

Username and Password Events

Username and password for websockets events from SPC Bridge. Default username is ws_user and password ws_pwd.

3.6 SPC Test Tool

To be sure that the communication between SPC Bridge and SPC panel is working properly you can use the tests provided in SPC Bridge->SPC Test Tool. In the option menu you can choose between query SPC areas, zones or the system log.

NOTE! For security reasons it is highly recommended that you set own passwords for Queries, Commands and Events access.

Page 11

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

11 of 14

Reference

2017-111

4 Advanced users

4.1 Backup of Configuration Settings

In System -> Backup / Flash Firmware, section Backup /Restore, you can save a backup copy of your settings on your PC and later use it to restore the settings.

4.2 Upgrading software

In System -> Backup / Flash Firmware, section Flash new firmware image, you can upgrade the device firmware to a new version. The firmware file should have the name dragino-spc-bridge--

vX.X.X-squashfs-sysupgrade.bin. For minor upgrades you can keep your current settings by selecting Keep settings. For major upgrades it is preferable to not keep the settings, because they can be

incompatible with the new firmware.

4.3 SSH Access

The device has as default ssh access enabled. Login using username root and same password as in the Web GUI (default dragino). The settings for the SSH access can be changed in the System -> Administration, section SSH Access.

Page 12

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

12 of 14

Reference

2017-111

5 License Agreements

5.1 End-User License Agreement for SPC Bridge (EULA)

IMPORTANT PLEASE READ THE TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT CAREFULLY BEFORE USING THE SPC BRIDGE SOFTWARE OR HARDWARE. SPC Bridge End-User License

Agreement ("EULA") is a legal agreement between you (either an individual or a single entity) and Lundix IT, Sweden, for the SPC Bridge software and hardware product(s) (referred to as the “PRODUCT”) which may also include associated software components, media, printed materials, and "online" or electronic documentation. By installing, copying, or otherwise using the PRODUCT, you agree to be bound by the terms of this EULA. This license agreement represents the entire agreement concerning the PRODUCT between you and Lundix IT (referred to as "licenser"), and it supersedes any prior proposal, representation, or understanding between the parties. If you do not agree to the terms of this EULA, do not install or use the PRODUCT. The PRODUCT is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The software is licensed, not sold.

GRANT OF LICENSE.

The PRODUCT is licensed as follows:

 The FlexC communication program is based on Vanderbilt propriety protocol FlexC and

therefore NOT open-source.

 All other software in SPC Bridge is licensed under many different open source licenses.  Backup Copies. You may make copies of the software as may be necessary for backup and

archival purposes.

DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS.

 Maintenance of Copyright Notices.

You must not remove or alter any copyright notices on any and all copies of the PRODUCT.

 Prohibition on Reverse Engineering, Decompilation, and Disassembly.

You may not reverse engineer, decompile, or disassemble the program SPC Flex Gateway.

 Support Services.

Lundix IT may provide you with support services related to the PRODUCT ("Support Services"). Any supplemental software code provided to you as part of the Support Services shall be considered part of the PRODUCT and subject to the terms and conditions of this EULA.

 Compliance with Applicable Laws.

You must comply with all applicable laws regarding use of the PRODUCT.

All title, including but not limited to copyrights, in and to the PRODUCT and any copies thereof are owned by Lundix IT or its suppliers. All title and intellectual property rights in and to the content which may be accessed through use of the PRODUCT is the property of the respective content owner and may be protected by applicable copyright or other intellectual property laws and treaties. This EULA grants you no rights to use such content. All rights not expressly granted are reserved by Lundix IT.

NO WARRANTIES

Lundix IT expressly disclaims any warranty for the PRODUCT. The PRODUCT is provided 'As Is' without any express or implied warranty of any kind, including but not limited to any warranties of merchantability, noninfringement, or fitness of a particular purpose. Lundix IT does not warrant or

Page 13

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

13 of 14

Reference

2017-111

assume responsibility for the accuracy or completeness of any information, text, graphics, links or other items contained within the PRODUCT. Lundix IT makes no warranties respecting any harm that may be caused by the transmission of a computer virus, worm, time bomb, logic bomb, or other such computer program. Lundix IT further expressly disclaims any warranty or representation to Authorized Users or to any third party.

LIMITATION OF LIABILITY

In no event shall Lundix IT be liable for any damages (including, without limitation, lost profits, business interruption, or lost information) rising out of 'Authorized Users' use of or inability to use the PRODUCT, even if Lundix IT has been advised of the possibility of such damages. In no event will Lundix IT be liable for loss of data or for indirect, special, incidental, consequential (including lost profit), or other damages based in contract, tort or otherwise. Lundix IT shall have no liability with respect to the content of the PRODUCT or any part thereof, including but not limited to errors or omissions contained therein, libel, infringements of rights of publicity, privacy, trademark rights, business interruption, personal injury, loss of privacy, moral rights or the disclosure of confidential information.

5.2 Open Source Software

The SPC Bridge software is based on OpenWrt, a Linux distribution that bundles lots of third party software, under many different licenses. Source code for OpenWrt is available on http://dev.openwrt.org.

The most frequently used licenses are:

GNU General Public License (GPL) and GNU Lesser General Public License (LGPL) version 2. These firmware images contain software licensed under the GPLv2. A copy of that license can be found at http://www.gnu.org/licenses/gpl-2.0.txt.

Apache License version 2.0. These firmware images contain software licensed under the APLv2. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Modified files carry prominent notices stating who made the changes.

MIT License. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,

INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

5.3 Open Source Hardware

The SPC Bridge hardware is based on the open source hardware Dragino, http://www.dragino.com. The Dragino hardware design is released under the Creative Commons License,

Page 14

AND ANY USE WHATSOEVER IS FORBIDDEN WITHOUT THE WRITTEN AUTHORIZATION OF LUNDIX IT.

SPC Bridge User Manual

Revision

1.0

Page

14 of 14

Reference

2017-111

https://creativecommons.org/licenses/. The modular Dragino design enables rapid development cycles for commercial products.

END OF DOCUMENT