Giter Club home page Giter Club logo

syr-safetech-connect-api's Introduction

SYR SafeTech Connect HTTP/JSON API Documentation

syr-safetech-connect-api

This is an attempt to publicy document the fields and features of the SYR SafeTech Connect JSON API as it lacks documentation from the vendorside. The API is identical for the "Wasserwächter" from Polygonvatro / AXA, as it's mostly a labeled SYR device. Please feel free to file pull requests in case you have any additions or corrections. Most of the field descriptions are the result of trial and error or available information from other projects.

Inspired by https://github.com/thannaske/oekofen-json-documentation and partly based on the following information:

Accessing the API

The API can simply be accessed via HTTP and returns fields as JSON. Reading out most of the values requires regularly setting the "admin" or expert mode, otherwise most of the interesting fields will be returned as "ERROR: ADM".

http://{$ip}:5333/safe-tec/set/ADM/(2)f

After that, you can query all current values with

http://{$ip}:5333/safe-tec/get/all

Returned Data

Fields

Field Type Description
getSRN int Serial Number
getVer string ID and Version number, e.g. "Safe-Tech V3.53"
getMAC mac address
getAVO int w. "mL" suffix Accumulated Volume of current water tap? resets to 0
getVOL int w. "Vol[L]" prefix Total accumulated volume in Liter - main interesting measurement data
getFLO int Current Flow in own unit - can be manually scaled to L/min
getLTV int Last total tapped volume in Liter - persists until next water tapping
getBAR ??? Water pressure (unconfirmed) - returns "ERR 65535" on a Polygonvatro device identifying as "Safe-Tech V3.53"
getCEL ??? Water temperature (unconfirmed) - returns 0 on a Polygonvatro device identifying as "Safe-Tech V3.53"
getAB 1/0 State of the motor valve - 0 means closed
getCND Water conductivity or hardness - returns 0 on a Polygonvatro device identifying as "Safe-Tech V3.53"
getALA string Alarm information
getWFC string WiFi SSID
getWIP string WiFi IP Address
getWGW string WiFi Gateway IP
getWFR WiFi RSSI
getFSL Connected Floor sensor(s) Serial Numbers
getBAT float "," separator! battery voltage
getNET float "," separator! ???
getPRF int Active profile for leak detection
getPN1 string Profile 1, name
getPV1 Profile 1, max volume for leak
getPT1 Profile 1, max minutes for leak
getPF1 Profile 1, max flow l/h for leak
getPM1 1/0 micro leak detection on / off
getPR1 ???
getPB1 ???
getPA1 ???
getPW1 ???

... to be completed

Setting Values

Close the water valve (to be confirmed / tested)

http://{$ip}:5333/safe-tec/set/ab/2

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.