Developers Cheat Sheet¶

Docker Networking¶

Useable Ports: 49152 - 65535

MQTT¶

Broker IP: 172.16.0.2

No Authentication Required

Topic Structure

Process DataUnitsEvents

Topic:

balluff/cmtk/master1/iolink/devices/port[1-4]/data/fromdevice

Schema:

{
    data:{
        isValid: boolean,
        items: {
        pd_name1: number | boolean | string | number[],
        // ...
        pd_nameN: number | boolean | string | number[]
        }
    },
    timestamp: string,
    type: string
}

Topic:

balluff/cmtk/master1/iolink/devices/port[1-4]/units

Schema:

{
    data: {
        pd_name1: string,
        // ...
        pd_nameN: string,
    },
    timestamp: string,
    type: string
}

Topic:

balluff/cmtk/master1/iolink/devices/port[1-4]/events

Schema:

{
    data:{
        deviceId: number,
        event: 'CONNECTED' | 'DISCONNECTED',
        vendorId: number
    }
    origin: string,
    timestamp: string,
    type: string
}

InfluxDB¶

Database Version: InfluxDB v1.x
Database Query language: InfluxQL
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
Retention Policy balluff-retention-policy
Database Connection Security: Secure (SSL/TLS) connection only, download root CA to verify

Sample Queries

Get last 5 Minutes for Port 1:

SELECT * FROM \"port1\" WHERE origin = 'master1'  AND 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.