DSMR-logger gerelateerde restAPI's

informatie over de DSMR-logger

GET http://dsmr-api.local/api/v1/dev/info

Deze restAPI geeft informatie terug van de DSMR-logger

200 Succes

{"devinfo":[
    {"name": "author", "value": "Willem Aandewiel (www.aandewiel.nl)"},
    {"name": "hostname", "value": "DSMR-108"},
    {"name": "fwversion", "value": "v0.2.9 (31-01-2020)"},
    {"name": "compiled", "value": "Jan 31 2020 12:22:10"},
    {"name": "freeheap", "value": 16224, "unit": "bytes"},
    {"name": "maxfreeblock", "value": 15400, "unit": "bytes"},
    {"name": "chipid", "value": "cc6156"},
    {"name": "coreversion", "value": "2_6_3"},
    {"name": "sdkversion", "value": "2.2.1(cfd48f3)"},
    {"name": "cpufreq", "value": 80, "unit": "MHz"},
    {"name": "sketchsize", "value": 521.953, "unit": "kB"},
    {"name": "freesketchSpace", "value": 1524.000, "unit": "kB"},
    {"name": "flashchipid", "value": "00164020"},
    {"name": "flashchipsize", "value": 4.000, "unit": "MB"},
    {"name": "flashchiprealsize", "value": 4.000, "unit": "MB"},
    {"name": "flashchipspeed", "value": 80.000, "unit": "MHz"},
    {"name": "flashchipmode", "value": "DOUT"},
    {"name": "boardtype", "value": "ESP8266_GENERIC"},
    {"name": "ssid", "value": "YourWiFi"},
    {"name": "ipaddress", "value": "192.168.1.106"},
    {"name": "wifirssi", "value": -52},
    {"name": "hostname", "value": "DSMR-API"},
    {"name": "uptime", "value": "0(d):00(h):10"},
    {"name": "telegramcount", "value": 56},
    {"name": "telegramerrors", "value": 0},
    {"name": "mqttbroker", "value": "mosqitto.org:1883"},
    {"name": "mqttinterval", "value": 120},
    {"name": "mqttbroker_connected", "value": "yes"},
    {"name": "mindergas_response", "value": "countdown for sending"},
    {"name": "mindergas_status", "value": "@31|12:28 -> :0"},
    {"name": "reboots", "value": 6},
    {"name": "lastreset", "value": "Software/System restart"}
]}

Systeem Tijd

GET http://dsmr-api.local/api/vi/dev/time

Deze restAPI geeft de systeem tijd van de DSMR-logger

200 Succes

{"devtime":[
  {"name": "timestamp", "value": "201027085021S"},
  {"name": "time", "value": "2020-10-27 08:50:21"},
  {"name": "epoch", "value": 1603788623},
  {"name": "uptime", "value": "0(d)-01:22(H:m)"},
  {"name": "uptime_secs", "value": 4955, "unit": "sec"}
]}

Instellingen

GET http://dsmr-api.local/api/v1/dev/settings

Deze restAPI geeft alle, door de gebruiker muteerbare, settings terug

200 Succes

{"settings":[
  {"name": "hostname", "value":"DSMR-API", "type": "s", "maxlen": 29},
  {"name": "pre_dsmr40", "value": 0, "type": "i", "min": 0, "max": 1},
  {"name": "ed_tariff1", "value": 0.50000, "type": "f", "min": 0, "max": 10},
  {"name": "ed_tariff2", "value": 0.50000, "type": "f", "min": 0, "max": 10},
  {"name": "er_tariff1", "value": 0.50000, "type": "f", "min": 0, "max": 10},
  {"name": "er_tariff2", "value": 0.50000, "type": "f", "min": 0, "max": 10},
  {"name": "gd_tariff", "value": 0.50000, "type": "f", "min": 0, "max": 10},
  {"name": "electr_netw_costs", "value": 15.14, "type": "f", "min": 0, "max": 100},
  {"name": "gas_netw_costs", "value": 11.10, "type": "f", "min": 0, "max": 100},
  {"name": "mbus1_type", "value": 0, "type": "i", "min": 0, "max": 200},
  {"name": "mbus2_type", "value": 3, "type": "i", "min": 0, "max": 200},
  {"name": "mbus3_type", "value": 5, "type": "i", "min": 0, "max": 200},
  {"name": "mbus4_type", "value": 0, "type": "i", "min": 0, "max": 200},
  {"name": "sm_has_fase_info", "value": 1, "type": "i", "min": 0, "max": 1},
  {"name": "tlgrm_interval", "value": 5, "type": "i", "min": 2, "max": 60},
  {"name": "oled_type", "value": 1, "type": "i", "min": 0, "max": 2},
  {"name": "oled_screen_time", "value": 10, "type": "i", "min": 1, "max": 300},
  {"name": "oled_flip_screen", "value": 0, "type": "i", "min": 0, "max": 1},
  {"name": "index_page", "value":"DSMRindex.html", "type": "s", "maxlen": 49},
  {"name": "mqtt_broker", "value":"192.168.21.244", "type": "s", "maxlen": 100},
  {"name": "mqtt_broker_port", "value": 1883, "type": "i", "min": 1, "max": 9999},
  {"name": "mqtt_user", "value":"", "type": "s", "maxlen": 39},
  {"name": "mqtt_passwd", "value":"", "type": "s", "maxlen": 39},
  {"name": "mqtt_toptopic", "value":"DSMR-API", "type": "s", "maxlen": 20},
  {"name": "mqtt_interval", "value": 60, "type": "i", "min": 0, "max": 600},
  {"name": "mindergastoken", "value":"Ay76AFwQ", "type": "s", "maxlen": 20}
]}

Instellingen aanpassen

POST http://dsmr-api.local/api/v1/settings/{"name":"<settingVeld>","value":"<nieuweWaarde>"}

200

{"name":"<settingVeld>","value":"<nieuweWaarde>"}

Hieronder een opsomming van de settingsVelden:

hostname

• type: String

• maxlen: 29

• Opmerking:

  • Characters

ed_tariff1 (Geleverde Energy, tarief 1)

• type: float

• min: 0

• max: 10

• decimalen: 5

ed_tariff2 (Geleverde Energy, tarief 2)

• type: float

• min: 0

• max: 10

• Decimalen: 5

er_tariff1 (Opgewekte Energy, tarief 1)

• type: float

• min: 0

• max: 10

• Decimalen: 5

er_tariff2 (Opgewekte Energy, tarief 2)

• type: float

• min: 0

• max: 10

• Decimalen: 5

gd_tariff (Gas Geleverd)

• type: float

• min: 0

• max: 10

• Decimalen: 5

electr_netw_costs (Netwerk kosten Electra)

• type: float

• min: 0

• max: 100

• Decimalen: 2

• Opmerking:

  • Euro's per maand

gas_netw_costs (Netwerk kosten Gas)

• type: float

• min: 0

• max: 100

• Decimalen: 2

• Opmerking:

  • Euro's per maand

tlgrm_interval (telegram Interval)

• type: Integer

• min: 1

• max: 60

• Opmerking:

  • Seconden

index_page (alternatieve index.html pagina)

• type: String

• maxlen: 49

• Opmerking:

  • Characters

  • Default: DSMRindex.html

mqtt_broker (URL of IP-adres)

• type: String

• maxlen: 100

• Opmerking:

  • Characters

mqtt_broker_port

• type: Integer

• min: 0

• max: 9999

mqtt_user

• type: String

• maxlen: 39

• Opmerking:

  • Characters

mqtt_passwd

• type: String

• maxlen: 29

• Opmerking:

  • Characters

mqtt_toptopic

• type: String

• maxlen: 20

• Opmerking:

  • Characters

mqtt_interval (interval voor het versturen van MQTT berichten)

• type: Integer

• min: 0

• max: 600

• Opmerking: Seconden

  • indien '0' worden er géén berichten verstuurd

  • er wordt nooit vaker een bericht verstuurd dan tlgrm_interval

mindergastoken

• type: String

• maxlen: 20

• Opmerking:

  • Characters

  • indien korter dan 5 char's worden er geen gegevens naar mindergas.nl verstuurd