Chipkin CAS 2700 Manuel utilisateur

Toll Free: 1 866 383-1657

3381 Cambie St., #211 Vancouver, BC Canada V5Z 4R3

Chipkin™ CAS 2700 HTTP REST API

USER MANUAL

VERSION: 1

PRODUCT NUMBER: CAS‐2700

DOCUMENT REVISION: 1

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 2of 18

TABLE OF CONTENTS

TABLE OF CONTENTS .........................................................................................................................................................2

LIST OF FIGURES...................................................................................................................................................................3

LIST OF TABLES .....................................................................................................................................................................3

COPYRIGHT & TRADEMARKS..........................................................................................................................................4

DISCLAIMER ...........................................................................................................................................................................4

CONFIDENTIALITY................................................................................................................................................................4

DOCUMENT REVISION HISTORY....................................................................................................................................4

1. PREFACE ..................................................................................................................................................................................5

WELCOME...................................................................................................................................................................5

CHIPKIN .......................................................................................................................................................................5

SAFETY WARNINGS.................................................................................................................................................5

CUSTOMER SUPPORT.............................................................................................................................................5

2. CONNECTIONS .....................................................................................................................................................................7

NETWORK CONNECTIONS...................................................................................................................................7

COMUNCATION PORTS ........................................................................................................................................8

3. HTTP REST API.......................................................................................................................................................................9

CSV ................................................................................................................................................................................9

Parameters .....................................................................................................................................................9

Example - Get system information as CSV with headers. .............................................................9

Act Get Value...........................................................................................................................................................10

Parameters ...................................................................................................................................................10

Example - Get a specific data point as JSON ..................................................................................10

Example - Get all data point as JSON ................................................................................................11

Act Set Value............................................................................................................................................................12

Parameters ...................................................................................................................................................12

Write thru .....................................................................................................................................................12

Example - Set a specific data point.....................................................................................................13

Act Set........................................................................................................................................................................13

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 3of 18

Parameters ...................................................................................................................................................14

Example –Set the current time ............................................................................................................14

Act Get .......................................................................................................................................................................15

Parameters ...................................................................................................................................................15

Example –Get the current stats ...........................................................................................................15

Act Info.......................................................................................................................................................................16

Example –Get the current drivers stats.............................................................................................16

THANK YOU..............................................................................................................................................................................18

LIST OF FIGURES

Figure 3.1-1. Network Connections Block Diagram ..................................................................................................... 7

LIST OF TABLES

Table 1 - Document Revision History................................................................................................................................4

Table 2 - Communication ports...........................................................................................................................................8

Table 3 - Endpoint formats ...................................................................................................................................................9

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 4of 18

TM(TM) are trademarks of Chipkin Automation Systems

DISCLAIMER

Chipkin Automation Systems™ has limited its liability for damages incurred by the customer or its

personnel in the contractual documents pursuant to which the product is provided to the customer.

The information and specifications contained throughout this user manual are up to date at the time

of publication. Chipkin Automation Systems has used, and continues to use, its best efforts to

maintain this user manual to reflect the most current configuration of the product. Chipkin

Automation Systems reserves the right to change the contents of this user manual at any time without

notice and assumes no liability for its accuracy. In the preparation of this user manual, Chipkin

Automation Systems has incorporated, and/or compiled service information and maintenance

procedures sourced from manufacturers and vendors of parts and components used in the

manufacturing of this product. Therefore, Chipkin Automation Systems shall not be liable for

omissions or missing data. It is not the intension of this user manual to instruct service technicians in

using common sense, basic skills and

rules of service repair.

CONFIDENTIALITY

The information contained in this document is the intellectual property of Chipkin Automation

Systems and is Commercially Confidential. No part of this document may be reproduced or

transmitted in any form or by any means, electronic or mechanical, for any purpose, without the

express written permission of Chipkin Automation Systems.

DOCUMENT REVISION HISTORY

REVISION

DATE

AUTHOR

NOTE

2018-Mar-15

SWS

Document created

Table 1 - Document Revision History

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 5of 18

1. PREFACE

WELCOME

As a new owner of Chipkin Automation Systems’™ (CAS) Gateway you have joined thousands of

satisfied customers who use Chipkin’s protocol gateways, data clients and integration services to meet

their building and industrial automation requirements. Our configuration expertise in this field

combined with free BACnet and other tools ensure your success; and our customer support via phone,

email and remote desktop tools means that we’re there when you need us. Thank you for choosing

Chipkin’s products.

CHIPKIN

Chipkin offers expert solutions for your building and industrial automation requirements. We develop,

configure, install and support gateways (protocol converters), data loggers, and remote monitor and

controlling applications. Founded in October 2000, Chipkin provides expert solutions for converting

BACnet®, Modbus®, and Lonworks®—to name just a few—and enabling interfaces for HVAC, fire,

siren, intercom, lighting, transportation and fuel systems. The high-quality products we offer

(including those from other vendors) interface with Simplex™, Notifier™, McQuay™, GE™ and many

others—so you can rest assured that Chipkin will select the most appropriate solution for your

application.

SAFETY WARNINGS

The CAS Gateway User Manual provides information on how to install and configure the gateway and

is intended for engineers, project management consultants and building management services. Before

you install the device, please observe the safety warnings described in in this manual.

CUSTOMER SUPPORT

Chipkin is a small responsive company, and we live or die by the quality of our service—and with

offices in two time-zones—we can provide support when you need it. For information on sales,

service, obtaining documentation or submitting a service request, please call us toll free at 1-866-383-

1657. Thanks for choosing Chipkin’s protocol gateways, data clients and integration services to meet

your building and industrial automation requirements.

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 6of 18

SALES AND CUSTOMER SUPPORT

TOLL FREE: 1-866-383-1657

FAX: 1-416-915-4024

EMAIL: [email protected]

GENERAL

TOLL FREE: 1-866-383-1657

FAX: 1-416-915-4024

EMAIL: [email protected]

SHIPPING ADDRESS

3381 Cambie St., #211

Vancouver, BC, Canada V5Z 4R3

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 7of 18

2. CONNECTIONS

NETWORK CONNECTIONS

This block diagram lists common network connections that can monitor and control data from HTTP

devices using BACnet IP, Modbus RTU/TCP, etc.

Figure 2.1-1. Network Connections Block Diagram

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 8of 18

COMUNCATION PORTS

The Gateway uses the following ports for communication:

Protocol

Port

Notes

HTTP

TCP 80

Web server.

BACnet IP

UDP 47808

Default port, can be configured.

Modbus TCP

TCP 502

Default port, can be configured.

Syslog

UDP 514

Can be disabled.

FTP

TCP 21

Can be disabled.

Table 2 - Communication ports

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 9of 18

3. HTTP REST API

This section contains instructions on how to query the CAS Gateway CAS-2700 via the HTTP REST API.

All examples below are in JSON format.

Endpoints

The CAS Gateway supports requesting information from the system via a HTTP REST API. The

responses from the REST server can be formatted as either CSV, XML, or JSON.

Document format

Endpoint

XML - Extensible Markup Language

/bin/xml/

JSON - JavaScript Object Notation

/bin/json/

CSV –Comma Separated Values

/bin/csv/

Table 3 - Endpoint formats

CSV

The CSV endpoint has a URL parameter that can be used to turn on or off headers in the response.

Parameters

•use_headers [Optional] –Include the headers of the columns for the first row. Accepted

values are 0 for no headers, or 1 for include headers. Default: 0 (No headers)

Example - Get system information as CSV with headers.

Request:

GET /bin/csv/?act=get_value&use_headers=1 HTTP/1.1

Response

id, modified, data,

1, 0, 0,

2, 0, 0,

3, 0, 0,

4, 0, 0,

5, 0, 0,

Chipkin™ ™ CAS 2700-35 Passive REST User Manual

1-866-383-1657 Chipkin.com Page 10 of 18

6, 0, 0,

7, 0, 0,

8, 0, 0,

9, 0, 0,

10, 0, 0,

Act Get Value

Gets the current values from the database or a specific value from the database.

Endpoint: /bin/json/?act=get_value

Parameters

•id [Optional] - The offset into the database of the data point that is being requested. If the ID

is not defined, then the entire database will be returned (Get all).

•table [Optional] –The table to extra the data from. By default, primary data table is used

da_data.

Example - Get a specific data point as JSON

In this example the id parameter is specified and only a single data point will be returned.

Request:

GET /bin/json/?act=get_value&id=1 HTTP/1.1

Response

{

"query": {

"act": "get_value",

"id": "1"

"response": {

"data": [{

"data": "1001",

"id": "1",

"modified": "1346272391"

Autres manuels pour CAS 2700

Table des matières

Autres manuels Chipkin Porte

Chipkin

Chipkin CAS 2700-02 VeederRoot Manuel utilisateur

Chipkin

Chipkin CAS 2700-58 Manuel utilisateur

Chipkin

Chipkin CAS 2700 Manuel utilisateur

Chipkin

Chipkin CAS 2700-15 Manuel utilisateur

Chipkin

Chipkin CAS-2700-24 Manuel utilisateur

Chipkin

Chipkin CAS 2700-53 Manuel utilisateur

Chipkin

Chipkin BEST CAS 2700-74 Manuel utilisateur

Manuels Porte populaires d'autres marques

LST

LST M500RFE-AS Manuel utilisateur

Kinnex

Kinnex Media Gateway Manuel utilisateur

2N Telekomunikace

2N Telekomunikace 2N StarGate Manuel utilisateur

Mitsubishi Heavy Industries

Mitsubishi Heavy Industries Superlink SC-WBGW256 Manuel utilisateur

ZyXEL Communications

ZyXEL Communications ZYWALL2 ET 2WE Manuel utilisateur

Telsey

Telsey CPVA 500 - SIP Manuel utilisateur

RTA

RTA 460A-NNA4 Fiche technique

Shaw

Shaw Gateway HDPVR Manuel utilisateur

ABB

ABB VSN900 Guide de démarrage rapide

Commander

Commander Pulse Manuel utilisateur

2N Telekomunikace

2N Telekomunikace ATEUS EasyGate 501309E Manuel utilisateur

NETGEAR

NETGEAR C6300BD Manuel utilisateur

Amit

Amit CDW531AM Manuel utilisateur

HMS

HMS Netbiter EasyConnect EC150 Manuel utilisateur

Huawei

Huawei EchoLife HG620 Manuel utilisateur

AT&T

AT&T U-verse 3801 Manuel d'utilisation et d'entretien

Logic IO

Logic IO RTCU MX2 turbo Manuel utilisateur

Suttle

Suttle MediaMAX MXM-521 Manuel utilisateur