Developers Cheat Sheet¶

Docker Networking¶

Useable Ports: 49152 - 65535

MQTT¶

Broker IP: 172.16.0.2

No Authentication Required

Topic Structure

Process DataUnitsEvents

Topic:

cmtk/cmtkv1/Port[1-4]/pd

Schema:

{
    pd_name1: number | boolean | string | byte-array,
    // ...
    pd_nameN: number | boolean | string | byte-array,
    ts: string,
    valid: boolean,
}

Topic:

cmtk/cmtkv1/Port[1-4]/unit

Schema:

{
    pd_name1: string,
    // ...
    pd_nameN: string,
    ts: string
}

Topic:

cmtk/cmtkv1/Port[1-4]/event

Schema:

{
    deviceId: number,
    event: 'CONNECTED' | 'DISCONNECTED',
    ts: string,
    vendorId: number
}

InfluxDB¶

Database IP: 172.16.0.2
Database Port: 8086
Database Username: cmtk
Database Password: balluff (If it was not changed via the influx configurator api)
Database Name: balluffCMTKDatabase

Sample Queries

Get last 5 Minutes for Port 1:

SELECT * FROM \"port1\" WHERE time > now() - 5m

Get all keys:

SHOW FIELD KEYS

API¶

API IP: 172.16.0.2
API Port: 8080

No Authentication Required. All request handled as admin.

API Documentation

See API Documentation for more information about the available endpoints.