Chipkin CAS 2700 User Manual

Http rest api
Hide thumbs Also See for CAS 2700:

Advertisement

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the CAS 2700 and is the answer not in the manual?

Questions and answers

Summary of Contents for Chipkin CAS 2700

  • Page 1 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...
  • Page 2: Table Of Contents

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual 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.
  • Page 3: List Of Figures

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual 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 ....................................
  • Page 4: Copyright & Trademarks

    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.
  • Page 5: Preface

    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.
  • Page 6 ™ CAS 2700-35 Passive REST Chipkin™ User Manual SALES AND CUSTOMER SUPPORT TOLL FREE: 1-866-383-1657 FAX: 1-416-915-4024 salesgroup1@chipkin.com EMAIL GENERAL TOLL FREE: 1-866-383-1657 FAX: 1-416-915-4024 support@chipkin.com EMAIL: SHIPPING ADDRESS 3381 Cambie St., #211 Vancouver, BC, Canada V5Z 4R3 3381 Cambie Street, #211 ©...
  • Page 7: Connections

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual 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 3381 Cambie Street, #211 ©...
  • Page 8: Comuncation Ports

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual 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.
  • Page 9: Http Rest Api

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual 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.
  • Page 10: Act Get Value

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual 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.
  • Page 11: Example - Get All Data Point As Json

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual Example - Get all data point as JSON In this example the id parameter is not specified and all the data in the database will be return in a single response. Request: GET /bin/json/?act=get_value HTTP/1.1...
  • Page 12: Act Set Value

    Not all protocols support writes, or this write thru command. Below is a list of commonly used protocols that do support this feature. Please contact Chipkin support to see if a protocol is supported.
  • Page 13: Example - Set A Specific Data Point

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual • BACnet IP • Modbus RTU • Modbus TCP • IDP600 • Eyedro • MQTT • Azure Example - Set a specific data point In this example a value will be written to a specified data point and the results will be returned via JSON.
  • Page 14: Parameters

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual Endpoint: /bin/json/?act=set Parameters • current_time [Optional] – Sets the current time on the CAS gateway. The time is in Unix EPOC time or seconds since 1970. • save [Optional] – Saves the database to disk. The only accepted value is 1.
  • Page 15: Act Get

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual "response": { "current_time": "ok" Act Get Get system information from the CAS Gateway. Endpoint: /bin/json/?act=get Parameters • type [Required] – The type of information to be retrieved. Currently only a value of “stats” is accepted.
  • Page 16: Act Info

    ™ CAS 2700-35 Passive REST Chipkin™ User Manual "Memory.Total": "4398568", "Memory.Used": "1146616", "ModbusRTU.init.success": "1", "ModbusRTU.recv.bytes": "1", "ModbusTCP.init.success": "1", "ModbusTCPClient.System.errors": "6", "ModbusTCPClient.init.success": "1", "ModbusTCPClient.task.1.read": "6", "ModbusTCPClient.task.1.read.error.fail": "6", "ModbusTCPClient.task.1.read.status": "Fail", "MultipleTCP.max.connections": "10", "Serial0.bytes.recv": "1", "Serial0.connection.count": "1", "System.drivers.success": "5", "System.freespace": "921", "System.http.drivers": "19", "System.saveDB.success": "1",...
  • Page 17 ™ CAS 2700-35 Passive REST Chipkin™ User Manual "query": { "act": "info" "response": [ "application_version": "0.780", "core_driver_version": "0.32", "core_http_version": "0.48", "title": "header" {"data": "1234569130", "title": "current_time"}, {"data": "943664","title": "available_disk_space"}, {"data": "975536","title": "total_disk_space"}, {"title": "BACnetIP","version": "0.93"}, {"title": "ModbusRTU","version": "0.19"}, {"title": "ModbusTCP","version": "0.21"}, {"title": "ModbusTCPClient","version": "0.11"},...
  • Page 18: Thank You

    With Chipkin you are buying a solution. Our configuration expertise in this field combined with free BACnet tools 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.

Table of Contents