---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
  projectIndex: https://api.net2grid.com/llms.txt
---

# /opticalsmartbridge/status

Returns information about the connection between a SmartBridge and a smart meter, given the fact that they are connected directly using an optical probe.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NET2GRID Customer Engagement API",
    "description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
    "version": "13.6.0"
  },
  "servers": [
    {
      "url": "http://api.net2grid.docker",
      "description": "API server"
    }
  ],
  "paths": {
    "/v2/opticalsmartbridge/status": {
      "get": {
        "tags": [
          "Registration"
        ],
        "summary": "/opticalsmartbridge/status",
        "description": "Returns information about the connection between a SmartBridge and a smart meter, given the fact that they are connected directly using an optical probe.",
        "operationId": "v2getOpticalSmartbridgeStatus",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpticalSmartbridgeStatusResponseDTO"
                },
                "examples": {
                  "GetOpticalSmartbridgeStatusResponse": {
                    "$ref": "#/components/examples/GetOpticalSmartbridgeStatusResponse"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request\n    <br/>113: Gateway not found.\n    <br/>152: User does not have a valid household object.\n    <br/>153: No valid meter found for user.\n    <br/>405: Gateway is off-line.\n    <br/>408: Cannot connect to gateway.\n    <br/>999: Unspecified error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ElectricityOpticalSmartbridgeDTO": {
        "properties": {
          "electricity": {
            "$ref": "#/components/schemas/OpticalSmartbridgeDTO"
          },
          "timestamp": {
            "description": "Timestamp of response in ISO-8601 format.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "OpticalSmartbridgeDTO": {
        "properties": {
          "current_status": {
            "description": "The current status of the meter:\n\n- CONNECTED_WITH_METER: The SmartBridge is successfully connected to the meter and receives meter data.\n- CONNECTED_WRONG_METER_SERIAL: The SmartBridge is connected to the wrong meter.\n- VERIFYING_PIN: The automatic process of unlocking the meter using the PIN code is in progress.\n- PIN_FAILED: The meter unlock process has failed.\n- DISCONNECTED: The SmartBridge lost its connection to the meter. The user should check if the optical probe is properly attached to the meter.\n- NO_METER_DETECTED: The SmartBridge has never connected to the meter directly using the optical probe.\n- UNKNOWN_ERROR: An unexpected error has occurred. If the problem persists, the user should contact customer support.",
            "type": "string",
            "enum": [
              "CONNECTED_WITH_METER",
              "CONNECTED_WRONG_METER_SERIAL",
              "VERIFYING_PIN",
              "PIN_FAILED",
              "DISCONNECTED",
              "NO_METER_DETECTED",
              "UNKNOWN_ERROR"
            ]
          },
          "meter_id_read": {
            "description": "The meter ID reported by the gateway.",
            "type": "string"
          },
          "meter_id_provisioned": {
            "description": "The customer's meter ID.",
            "type": "string"
          },
          "pin_entry_mode": {
            "description": "The actions/modes that can unlock the meter and enable it.</br>1. optical: The meter can be unlocked via the optical interface of the SmartBridge without any user intervention. </br>2. manual_push_button: The meter can be unlocked via manual user intervention, using the relevant button(s) on the meter itself. </br>3. manual_torch: The meter can be unlocked by the end user, via light signals from a torch or a flashlight. </br>4. NA: The meter doesn't have to be unlocked or this feature is irrelevant to the existing meter. </br>5. unknown: The unlocking procedure of the meter is unknown to NET2GRID. </br>",
            "type": "string",
            "enum": [
              "optical",
              "manual_push_button",
              "manual_torch",
              "NA",
              "unknown"
            ]
          },
          "pincode": {
            "description": "The pincode that is set and reported by the gateway.",
            "type": "string"
          },
          "key_retries": {
            "description": "The number of completed attempts to unlock the meter automatically, via the optical interface. The device will\nperform up to seven automatic unlocks before it stops.",
            "type": "string"
          },
          "meter_unlocked": {
            "description": "Signifies whether the meter is unlocked or not.",
            "type": "boolean"
          },
          "last_successful_meter_connection_timestamp": {
            "description": "A successful meter connection means the SmartBridge has at least once parsed meter data successfully via the\noptical direct setup. This timestamp corresponds to the last energy measurement retrieved from the meter via\nthe optical direct setup. null will be returned when there was no successful meter connection via this setup in\nthe past. Helps distinguish between onboarding and troubleshooting scenarios. The timestamp is in ISO-8601\nformat.",
            "type": "string",
            "format": "date-time"
          }
        },
        "type": "object"
      },
      "OpticalSmartbridgeStatusResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "data": {
            "$ref": "#/components/schemas/ElectricityOpticalSmartbridgeDTO"
          }
        },
        "type": "object"
      },
      "ErrorDTO": {
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "error": {
            "$ref": "#/components/schemas/ErrorDTO"
          }
        },
        "type": "object"
      }
    },
    "examples": {
      "GetOpticalSmartbridgeStatusResponse": {
        "summary": "Optical Meter Status response.",
        "value": {
          "status": "ok",
          "data": {
            "electricity": {
              "current_status": "CONNECTED_WITH_METER",
              "meter_id_read": "1DZG0044037253",
              "meter_id_provisioned": "1DZG0044037253",
              "pin_entry_mode": "optical",
              "pincode": "1234",
              "key_retries": 0,
              "meter_unlocked": true
            },
            "timestamp": "2023-01-20T08:45:39+01:00"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "bearerFormat": "JWT",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "Registration"
    }
  ],
  "x-explorer-enabled": false
}
```