Beta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.
643 matches
59 actions
smart-me
59 actions
- Account_LoginGETv1.0.0
- Add or edit a folder or a meter. To add a new folder use and empty IDPOSTv1.0.0
- Assign a folder (source) or meter to another folder (target). Can be used to create a folder structure.POSTv1.0.0
- Assign a user to a folderPOSTv1.0.0
- Beta: Gets all active virtual metersGETv1.0.0
- Beta: Gets all Meters available to activate as a Virtual Meter.GETv1.0.0
- Beta: Gets the General Information for a Meter or a FolderGETv1.0.0
- Beta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.POSTv1.0.0
- Beta: Virtual Meter API: Deactivates a Virtual Meter.POSTv1.0.0
- Calculates a virtual meter from a formula. A meter is coded as ID("METERID")GETv1.0.0
- Creates a new registration for the realtime API. The Realtime API sends you the data of the registred devices as soon as we have them on the cloud. More Information about the realtime API: https://www.smart-me.com/Description/api/realtimeapi.aspxPOSTv1.0.0
- Creates and updates the folder menu itemsPOSTv1.0.0
- Creates or updates a Custom Device or updates it's values.POSTv1.0.0
- Creates or updates a Device or updates it's values.POSTv1.0.0
- Creates or updates a subuser. To create a new user set no ID (empty)POSTv1.0.0
- Delete a subuserDELETEv1.0.0
- Deletes a folderDELETEv1.0.0
- Deletes a realtime API registration.DELETEv1.0.0
- Deletes a user to folder assignementDELETEv1.0.0
- Force a device to send the data every second (if supported). This for about 30s. Don't use this call to force a device to send the data every second for a longer time.GETv1.0.0
- Get a sub user. The user must be assigend to the user that makes this call.GETv1.0.0
- GET: api/pico/loadmanagementgroup Returns a pico load management group by it's idGETv1.0.0
- GET: api/pico/loadmanagementgroup Returns all available load management groupsGETv1.0.0
- GET: api/pico/settings Returns the settings of a pico charging station.GETv1.0.0
- Gets a Custom Device by it's IDGETv1.0.0
- Gets a Device by it's IDGETv1.0.0
- Gets a Device by it's Serial Number. The Serial is the part before the "-".GETv1.0.0
- Gets all (last) values of a deviceGETv1.0.0
- Gets all (last) values of a device The first Value found before the given Date is returned.GETv1.0.0
- Gets all available Actions of a DeviceGETv1.0.0
- Gets all Custom DevicesGETv1.0.0
- Gets all DevicesGETv1.0.0
- Gets all Devices by it's Sub Type (e.g. E-Charging Station)GETv1.0.0
- Gets all Devices for an Energy TypeGETv1.0.0
- Gets all pico charging stations for this userGETv1.0.0
- Gets all registrations for the Realtime API.GETv1.0.0
- Gets all Virtual Tariffs for a property (folder)GETv1.0.0
- Gets all virtual tariffs of a folderGETv1.0.0
- Gets all Virtual Tariffs of a userGETv1.0.0
- Gets multiple values of a device. This call needs a smart-me professional licence.GETv1.0.0
- Gets the active charging data of a pico stationGETv1.0.0
- Gets the calculation status for a virtual tariff propertyGETv1.0.0
- Gets the configuration of a smart-me device.GETv1.0.0
- Gets the consumption of a folder with a virtuall tariffs.GETv1.0.0
- Gets the folder menu items (each item might contain child items)GETv1.0.0
- Gets the informations for the user.GETv1.0.0
- Gets the last charging history for a pico stationGETv1.0.0
- Gets the settings of a folder or meterGETv1.0.0
- Gets the Values for a folder or a meterGETv1.0.0
- Gets the Values for a Meter at a given Date. The first Value found before the given Date is returned.GETv1.0.0
- M-BUS API: Adds data of a M-BUS Meter to the smart-me Cloud. Just send us the M-BUS Telegram (RSP_UD) and we will do the Rest.POSTv1.0.0
- post_api_Account_loginPOSTv1.0.0
- Set an action for the specified device.POSTv1.0.0
- Sets the configuration of a smart-me device. The device needs to be online.POSTv1.0.0
- Sets the dynamic current of a load management group or a single station.POSTv1.0.0
- Sets the Name of a Meter or a FolderPOSTv1.0.0
- Triggers user account deletion.DELETEv1.0.0
- Try to fix lock the cable of a pico. The pico must be online and a cable (without car) needs to be connected. Otherwise this will fail.POSTv1.0.0
- Updates the On/Off Switch on a device. For new implementations please use the "actions" commandPUTv1.0.0
Other/smart-me
Beta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
{
"type": "object",
"description": "Actives a virtual Meter",
"properties": {
"SerialNumber": {
"type": "string",
"description": "The Serialnumber of the Meter to activate."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
{
"type": "object",
"description": "Container Class for the Web API",
"properties": {
"ActivePower": {
"type": "number",
"format": "double",
"description": "The Actvie Power or current flow rate"
},
"ActivePowerL1": {
"type": "number",
"format": "double",
"description": "The Actvie Power Phase L1"
},
"ActivePowerL2": {
"type": "number",
"format": "double",
"description": "The Actvie Power Phase L2"
},
"ActivePowerL3": {
"type": "number",
"format": "double",
"description": "The Actvie Power Phase L3"
},
"ActivePowerUnit": {
"type": "string",
"description": "The Unit of the Active Power Value"
},
"ActiveTariff": {
"type": "integer",
"format": "int32",
"description": "The Number of the Active Tariff"
},
"AdditionalMeterSerialNumber": {
"type": "string",
"description": "An additional Meter serial number. e.g. the number of a meter a smart-me device is connected to."
},
"AnalogOutput1": {
"type": "integer",
"format": "int32",
"description": "The analog output number 1 (PWM signal) (0 - 32183)"
},
"AnalogOutput2": {
"type": "integer",
"format": "int32",
"description": "The analog output number 2 (PWM signal) (0 - 32183)"
},
"ChargingStationState": {
"type": "string",
"description": "The state of a pico charging station. (Only available for pico charging stations)",
"enum": [
"Booting",
"ReadyNoCarConnected",
"ReadyCarConnected",
"StartedWaitForCar",
"Charging",
"Installation",
"Authorize",
"Offline"
]
},
"CounterReading": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading (Total Energy used)"
},
"CounterReadingExport": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading only export"
},
"CounterReadingImport": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading only import"
},
"CounterReadingT1": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading Tariff 1"
},
"CounterReadingT2": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading Tariff 2"
},
"CounterReadingT3": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading Tariff 3"
},
"CounterReadingT4": {
"type": "number",
"format": "double",
"description": "The Meter Counter Reading Tariff 4"
},
"CounterReadingUnit": {
"type": "string",
"description": "The Unit of the Counter Reading"
},
"Current": {
"type": "number",
"format": "double",
"description": "The Current (in A)"
},
"CurrentL1": {
"type": "number",
"format": "double",
"description": "The Current Phase L1 (in A)"
},
"CurrentL2": {
"type": "number",
"format": "double",
"description": "The Current Phase L2 (in A)"
},
"CurrentL3": {
"type": "number",
"format": "double",
"description": "The Current Phase L3 (in A)"
},
"DeviceEnergyType": {
"type": "string",
"description": "The Energy Type of this device",
"enum": [
"MeterTypeUnknown",
"MeterTypeElectricity",
"MeterTypeWater",
"MeterTypeGas",
"MeterTypeHeat",
"MeterTypeHCA",
"MeterTypeAllMeters",
"MeterTypeTemperature",
"MeterTypeMBusGateway",
"MeterTypeRS485Gateway",
"MeterTypeCustomDevice",
"MeterTypeCompressedAir",
"MeterTypeSolarLog",
"MeterTypeVirtualMeter",
"MeterTypeWMBusGateway"
]
},
"DigitalInput1": {
"type": "boolean",
"description": "The digital input number 1"
},
"DigitalInput2": {
"type": "boolean",
"description": "The digital input number 2"
},
"DigitalOutput1": {
"type": "boolean",
"description": "The digital output number 1"
},
"DigitalOutput2": {
"type": "boolean",
"description": "The digital output number 2"
},
"FamilyType": {
"type": "string",
"description": "The Family Type of the device.",
"enum": [
"MeterFamilyTypeUnknown",
"MeterFamilyTypeSmartMeConnectV1",
"MeterFamiliyTypeSmartMeMeter",
"MeterFamiliyTypeSmartMeMeterWithSwitch",
"MeterFamilyTypeMBusGatewayV1",
"MeterFamilyTypeRS485GatewayV1",
"MeterFamilyTypeKamstrupModule",
"MeterFamilyTypeSmartMe3PhaseMeter80A",
"MeterFamilyTypeSmartMe3PhaseMeter32A",
"MeterFamilyTypeSmartMe3PhaseTelstarTransformer",
"MeterFamilyTypeLandisGyrModule",
"MeterFamilyTypeFnnOpticalModule",
"MeterFamilyTypeSmartMe3PhaseTelstar80AWiFi",
"MeterFamilyTypeSmartMe3PhaseTelstar80AMobile",
"MeterFamilyTypeSmartMe1PhaseMeter80AV2WiFi",
"MeterFamilyTypeSmartMe1PhaseMeter32AV2WiFi",
"MeterFamilyTypeSmartMe1PhaseMeter80AGprs",
"MeterFamilyTypeSmartMe1PhaseMeter32AGprs",
"MeterFamilyTypeWMBusGatewayV1",
"MeterFamilyTypeSmartMe3PhaseTelstarTransformerMobile",
"MeterFamilyTypeMithralHallV1",
"MeterFamilyTypeRestApiMeter",
"MeterFamilyTypeVirtualBillingMeter"
]
},
"FlowRate": {
"type": "number",
"format": "double",
"description": "The current flow rate (e.g. m3/h)"
},
"Id": {
"type": "string",
"description": "The ID of the device"
},
"MeterSubType": {
"type": "string",
"description": "The sub meter type (e.g. warmwater or coldwater)",
"enum": [
"MeterSubTypeUnknown",
"MeterSubTypeCold",
"MeterSubTypeHeat",
"MeterSubTypeChargingStation",
"MeterSubTypeElectricity",
"MeterSubTypeWater",
"MeterSubTypeGas",
"MeterSubTypeElectricityHeat",
"MeterSubTypeTemperature",
"MeterSubTypeVirtualBattery"
]
},
"Name": {
"type": "string",
"description": "The Name of the Device"
},
"PowerFactor": {
"type": "number",
"format": "double",
"description": "The Power Factor (cos phi). Range: 0 - 1"
},
"PowerFactorL1": {
"type": "number",
"format": "double",
"description": "The Power Factor (cos phi) Phase L1. Range: 0 - 1"
},
"PowerFactorL2": {
"type": "number",
"format": "double",
"description": "The Power Factor (cos phi) Phase L2. Range: 0 - 1"
},
"PowerFactorL3": {
"type": "number",
"format": "double",
"description": "The Power Factor (cos phi) Phase L3. Range: 0 - 1"
},
"Serial": {
"type": "integer",
"format": "int64",
"description": "The Serial number"
},
"SwitchOn": {
"type": "boolean",
"description": "Flag if the Switch is on on this device."
},
"SwitchPhaseL1On": {
"type": "boolean",
"description": "Flag if the Phase L1 is on on this device."
},
"SwitchPhaseL2On": {
"type": "boolean",
"description": "Flag if the Phase L2 is on on this device."
},
"SwitchPhaseL3On": {
"type": "boolean",
"description": "Flag if the Phase L3 is on on this device."
},
"Temperature": {
"type": "number",
"format": "double",
"description": "The Temperature (in degree celsius)"
},
"ValueDate": {
"type": "string",
"format": "date-time",
"description": "Time of last successful connection the the smart-me Cloud."
},
"Voltage": {
"type": "number",
"format": "double",
"description": "The Voltage (in V)"
},
"VoltageL1": {
"type": "number",
"format": "double",
"description": "The Voltage Phase L1 (in V)"
},
"VoltageL2": {
"type": "number",
"format": "double",
"description": "The Voltage Phase L2 (in V)"
},
"VoltageL3": {
"type": "number",
"format": "double",
"description": "The Voltage Phase L3 (in V)"
}
}
}