openapi: 3.2.0
info:
  title: Xcel Energy Smart Meter IEEE 2030.5 Device Information API
  summary: IEEE 2030.5 (SEP 2.0) REST API exposed by Itron Gen 5 Riva smart meters on the local network.
  description: IEEE 2030.5 / Smart Energy Profile 2.0 compliant API server built into Itron Gen 5 Riva smart meters deployed by Xcel Energy.
  version: '1.0'
  contact:
    name: Xcel Energy Developer Portal
    url: https://developer-apim.aws.xcelenergy.com/
  x-generated-from: documentation
  x-last-validated: '2026-05-03'
  x-standards:
  - IEEE 2030.5-2018
  - Smart Energy Profile 2.0
servers:
- url: https://{meterHost}
  description: Itron Gen 5 Riva smart meter on the local network (mTLS).
  variables:
    meterHost:
      default: 192.168.1.10
      description: Hostname or IP of the local meter device.
tags:
- name: Device Information
  description: Manufacturer, hardware, and firmware metadata for a device.
paths:
  /edev/{edevId}/di:
    get:
      operationId: getDeviceInformation
      summary: Get DeviceInformation
      description: Returns manufacturer, hardware, and firmware metadata for the EndDevice.
      tags:
      - Device Information
      security:
      - mtls: []
      parameters:
      - $ref: '#/components/parameters/EdevId'
      responses:
        '200':
          description: DeviceInformation resource.
          content:
            application/sep+xml:
              schema:
                $ref: '#/components/schemas/DeviceInformation'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DeviceInformation:
      allOf:
      - $ref: '#/components/schemas/Resource'
      - type: object
        properties:
          mfID:
            type: integer
            description: Manufacturer ID.
          mfModel:
            type: string
          mfSerNum:
            type: string
          primaryPower:
            type: integer
            description: Primary power source enum.
          secondaryPower:
            type: integer
          swActTime:
            type: integer
          swVer:
            type: string
          functionsImplemented:
            type: string
            description: Hex-encoded FunctionsImplementedType.
    Resource:
      type: object
      description: Base IEEE 2030.5 Resource type that all resources inherit from.
      properties:
        href:
          type: string
          description: Stable URI of the resource.
  parameters:
    EdevId:
      name: edevId
      in: path
      required: true
      description: Numeric identifier of an EndDevice resource.
      schema:
        type: integer
        minimum: 0
        example: 0
  securitySchemes:
    mtls:
      type: mutualTLS
      description: 'IEEE 2030.5 requires mutual TLS authentication. Clients present a device certificate whose subject contains the LFDI/SFDI used to authorize access. Plain HTTP is not permitted.

        '