API Docs | demafy

TransOpt MQTT API 1.0.0 documentation

TransOpt MQTT API 1.0.0

This API defines the MQTT topics and payloads used for client interactions with the TransOpt platform.

It covers certificate signing, data aggregation for energy management, and bidirectional optimization control.

Servers

mqtt.example.com:1883mqttmqttBroker

Operations

SUB transopt/{clientid}/signup/cert/csr
CSR for client certificate signup

Operation IDreceiveCsr
clientid
required
string
uid: clientid
Unique client identifier
- #Signup
Accepts the following message:
Certificate Signing RequestCSRRequest
CSR payload for certificate registration.
object
csr
string
Base64-encoded CSR

Additional properties are allowed.
Examples
{ "csr": "string" }

This example has been generated automatically.
PUB transopt/{clientid}/aggregate/demand
Client's demand aggregation

Operation IDpublishDemandAggregation
clientid
required
string
uid: clientid
Unique client identifier
- #Aggregation
Accepts the following message:
Demand AggregationDemandAggregation
Aggregated demand information.
object
timestamp
string
format: date-time
demand_kW
number
Additional properties are allowed.
Examples
{ "timestamp": "2019-08-24T14:15:22Z", "demand_kW": 0 }

This example has been generated automatically.
PUB transopt/{clientid}/aggregate/pv
Client's PV production aggregation

Operation IDpublishPVAggregation
clientid
required
string
uid: clientid
Unique client identifier
- #Aggregation
Accepts the following message:
PV Production AggregationPVAggregation
Aggregated PV production information.
object
timestamp
string
format: date-time
production_kW
number
Additional properties are allowed.
Examples
{ "timestamp": "2019-08-24T14:15:22Z", "production_kW": 0 }

This example has been generated automatically.
PUB transopt/{clientid}/opt/upstream
Optimized upstream values sent by client

Operation IDpublishUpstreamOptimization
clientid
required
string
uid: clientid
Unique client identifier
- #Optimization
Accepts the following message:
Upstream OptimizationUpstreamOptimization
Upstream optimization values sent by client.
object
timestamp
string
format: date-time
value
number
Additional properties are allowed.
Examples
{ "timestamp": "2019-08-24T14:15:22Z", "value": 0 }

This example has been generated automatically.
SUB transopt/{clientid}/opt/downstream
Optimization commands sent to client

Operation IDreceiveDownstreamOptimization
clientid
required
string
uid: clientid
Unique client identifier
- #Optimization
Accepts the following message:
Downstream OptimizationDownstreamOptimization
Downstream optimization commands to client.
object
timestamp
string
format: date-time
target_value
number
Additional properties are allowed.
Examples
{ "timestamp": "2019-08-24T14:15:22Z", "target_value": 0 }

This example has been generated automatically.

Messages

#1Certificate Signing RequestCSRRequest
CSR payload for certificate registration.
object
csr
string
Base64-encoded CSR

Additional properties are allowed.
#2Demand AggregationDemandAggregation
Aggregated demand information.
object
timestamp
string
format: date-time
demand_kW
number
Additional properties are allowed.
#3PV Production AggregationPVAggregation
Aggregated PV production information.
object
timestamp
string
format: date-time
production_kW
number
Additional properties are allowed.
#4Upstream OptimizationUpstreamOptimization
Upstream optimization values sent by client.
object
timestamp
string
format: date-time
value
number
Additional properties are allowed.
#5Downstream OptimizationDownstreamOptimization
Downstream optimization commands to client.
object
timestamp
string
format: date-time
target_value
number
Additional properties are allowed.

TransOpt MQTT API 1.0.0

Servers

Operations

SUB transopt/{clientid}/signup/cert/csr

Examples

This example has been generated automatically.

PUB transopt/{clientid}/aggregate/demand

Examples

This example has been generated automatically.

PUB transopt/{clientid}/aggregate/pv

Examples

This example has been generated automatically.

PUB transopt/{clientid}/opt/upstream

Examples

This example has been generated automatically.

SUB transopt/{clientid}/opt/downstream

Examples

This example has been generated automatically.

Messages