API Descriptions: Electricity Meter

Below bodies of responses to requests to the given URLs are presented, including the .well-known/core URL.

Response to GET /.well-known/core

• /
  • rt = http://schema.org/EntryPoint
• /energyValue
  • rt = http://external/doc#EnergyValue

Response to GET /

{
  "@context": "http://external/doc#",
  "@id": "coap://0.0.0.0/",
  "@type": "EnergyMeterDevice",
  "identifier": "e9704",
  "label": { "@value": "Energy Meter Device", "@language": "en" },
  "location": {
    "@type": "Place",
    "label": "1010"
  },
  "temperature": "/energyValue"
}

PUT Request to /

{
  "@context": "coap://external/doc#",
  "@type": "doc:EnergyMeterDevice",
  "location": {
    "@type": "Place",
    "label": "301"
  }
}

Response to GET http://external/doc

{
  "@context": [
    "https://w3id.org/semiot/device/commoncontext#",
    { "doc": "http://external/doc#" }
  ],
  "@id": "doc:ApiDocumentation",
  "@type": "ApiDocumentation",
  "supportedClass": [
    {
      "@id": "doc:EnergyMeterDevice",
      "subClassOf": "Device",
      "supportedProperty": {
        "property": "location",
        "writable": "true",
        "label": "Location"
      },
      "supportedProperty": {
        "property": "label",
        "writable": "false",
        "label": "Label"
      },
      "supportedOperation": {
        "method": "PUT",
        "expects": "doc:EnergyMeterDevice",
        "returns": "doc:EnergyMeterDevice"
      }
    },
    {
      "@id": "doc:EnergyValue",
      "@type": "Link",
      "range": {
        "@id": "doc:EnergyValue",
        "subClassOf": "QuantitativeValue",
        "label": "Energy (Wh)"
      }
    }
  ]
}

Response to GET /energyValue

{
  "@context": "coap://external/doc#",
  "@type": "doc:EnergyValue",
  "value": "230",
  "unitCode": "Wh"
}