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
Gets the configuration of a smart-me device.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}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
{
"type": "object",
"description": "API Container class for the meter configuration",
"properties": {
"DeviceEncryptionKey": {
"type": "string",
"description": "The encryption key used to decrypt messages received from an external meter (used only for the smart-me modules)"
},
"DevicePinCode": {
"type": "string",
"description": "PIN code to enter on a external meter (e.g. for the FNN meters)"
},
"DnsUpdateState": {
"type": "string",
"description": "Configuration of the dynamic DNS service. More information: http://wiki.smart-me.com/index.php/Dynamisches_DNS",
"enum": [
"NoUpdate",
"DnsUpdatePublicIp",
"DnsUpdateInternalIp"
]
},
"EnableModbusTcp": {
"type": "boolean",
"description": "Enables or disables Modbus TCP (if the meter supports it)."
},
"Id": {
"type": "string",
"description": "The ID of the device"
},
"InputConfiguration": {
"type": "array",
"description": "The configuration for the intput outputs",
"items": {
"type": "object",
"description": "Configuration for the input of a meter (digital inputs)",
"properties": {
"Name": {
"type": "string",
"description": "The Name of the Input"
},
"Number": {
"type": "integer",
"format": "int32",
"description": "The number of the Input. (1 for Input 1)"
},
"OffText": {
"type": "string",
"description": "The visualization text for an OFF action"
},
"OnText": {
"type": "string",
"description": "The visualization text for an ON action"
},
"Type": {
"type": "string",
"description": "The Type of the output",
"enum": [
"TariffInput",
"DigitalInput"
]
}
}
}
},
"OutputConfiguration": {
"type": "array",
"description": "The configuration for the external outputs",
"items": {
"type": "object",
"description": "Configuration for the outputs of a meter (analog/digital outputs)",
"properties": {
"DigitalOutputNoConnectionAction": {
"type": "string",
"description": "The Action when the device has lost the connection",
"enum": [
"Nothing",
"TurnOff",
"TurnOn",
"SetPwmValue"
]
},
"Name": {
"type": "string",
"description": "The Name of the Output"
},
"Number": {
"type": "integer",
"format": "int32",
"description": "The number of the Output. (1 for Output 1, 2 for Output 2)"
},
"S0PulseValue": {
"type": "string",
"description": "The S0 Pulse Value",
"enum": [
"PulseValue1000Kwh",
"PulseValue10000Kwh"
]
},
"Type": {
"type": "string",
"description": "The Type of the output",
"enum": [
"ImpulseOutputActiveEnergy",
"ImpulseOutputActiveEnergyImport",
"ImpulseOutputActiveEnergyExport",
"ImpulseOutputReactiveEnergy",
"DigitalOutput",
"AnalogPwmSignalOutput",
"Disabled"
]
}
}
}
},
"ShowReactiveEnergy": {
"type": "boolean",
"description": "Shows the reactive energy values (if the meter supports it)."
},
"SwitchConfiguration": {
"type": "array",
"description": "The configuration for the phase switches",
"items": {
"type": "object",
"description": "The configuration for a phase switch",
"properties": {
"CanSwitchOff": {
"type": "boolean",
"description": "Flag if the switch can be turned off or is always on."
},
"Number": {
"type": "integer",
"format": "int32",
"description": "The number of the phase. (e.g. 1 for Phase L1)"
}
}
}
},
"UploadInterval": {
"type": "string",
"description": "Number of seconds the device will upload the data. For smaller values maybe a professional license is needed.",
"enum": [
"UploadInterval_1s",
"UploadInterval_5s",
"UploadInterval_10s",
"UploadInterval_30s",
"UploadInterval_60s",
"UploadInterval_5min",
"UploadInterval_15min",
"UploadInterval_30min",
"UploadInterval_60min",
"UploadInterval_6h",
"UploadInterval_12h",
"UploadInterval_24h"
]
}
}
}