<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Swagger UI Local</title>
  <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
</head>
<body>
  <div id="swagger-ui"></div>

  <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
  <script>
    window.onload = function() {
      const ui = SwaggerUIBundle({
        spec: {
  "openapi": "3.0.0",
  "info": {
    "title": "Communication Module Gateway API",
    "description": "API to interact with connected communication module's through the gateway.",
    "version": "1.1.1"
  },
  "servers": [
    {
      "url": "http://200.194.172.146:5000/{imei}",
      "description": "CommModule-specific API endpoint",
      "variables": {
        "imei": {
          "default": "IMEI",
          "description": "Unique identifier of the modem"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Use the following credentials: Username: perseus Password: So2#S_STot5V6#ho&5*I\n"
      }
    }
  },
  "paths": {
    "/cm/reboot": {
      "put": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Reboot communication module",
        "description": "Sends a command to reboot the device's communication module.",
        "operationId": "rebootCommModule",
        "responses": {
          "200": {
            "description": "Successful reboot command",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "ok"
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/soc": {
      "get": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Battery state of charge",
        "description": "Retrieves the current battery charge level of the device.",
        "operationId": "getBatterySoC",
        "responses": {
          "200": {
            "description": "Current battery charge percentage",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "80%"
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/force_wd": {
      "put": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Force watchdog trigger",
        "description": "Forces the watchdog to act on the communication module.",
        "operationId": "forceWatchdog",
        "responses": {
          "200": {
            "description": "Watchdog successfully triggered",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "ok"
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/memory/erase": {
      "put": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Erase flash memory",
        "description": "Erase flash memory. It may take a few minutes, but once the memory has been erased, the comm module will restart.",
        "operationId": "eraseMemory",
        "responses": {
          "200": {
            "description": "Requested to erase flash memory",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "It may take a few minutes, but once the memory has been erased, the comm module will restart."
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/memory/verify": {
      "get": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Check the flash memory operation",
        "description": "The communication module will write to a specific memory location and read it to validate operation.",
        "operationId": "verifyMemory",
        "responses": {
          "200": {
            "description": "Status of flash memory",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "success": {
                    "summary": "Memory is working",
                    "value": "Memory OK"
                  },
                  "failure": {
                    "summary": "Memory failed",
                    "value": "Memory failure"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/logs": {
      "get": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Comm Module Engineering logs",
        "description": "Export Comm Module engineering logs in csv format.",
        "operationId": "engineeringLogs",
        "responses": {
          "200": {
            "description": "All content of engineering logs",
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/position": {
      "get": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Information about GPS",
        "description": "The GPS is synchronized every 15 minutes, this endpoint will read the information from the last synchronization.",
        "operationId": "gpsInfo",
        "responses": {
          "200": {
            "description": "GPS information",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "GNSSDate": {
                      "type": "string",
                      "example": "08/29/2025"
                    },
                    "GNSSTime_UTC": {
                      "type": "string",
                      "example": "12:51:51"
                    },
                    "Lat": {
                      "type": "number",
                      "format": "float",
                      "example": -25.447563
                    },
                    "Long": {
                      "type": "number",
                      "format": "float",
                      "example": -49.242901
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/install/pass": {
      "post": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Install passkey",
        "description": "Installs a passkey into the communication module.",
        "operationId": "installPasskey",
        "requestBody": {
          "required": true,
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Installation successful",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "OK"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Wrong Length or Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "wrongLength": {
                    "value": "Bad Request Wrong Length"
                  },
                  "error": {
                    "value": "Bad Request Error"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/install/chain": {
      "post": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Install certificate chain",
        "description": "Installs a certificate chain into the communication module.",
        "operationId": "installChain",
        "requestBody": {
          "required": true,
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Installation successful",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "OK"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid input",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "invalidChain": {
                    "value": "Bad Request Invalid chain"
                  },
                  "invalidCert": {
                    "value": "Bad Request Certificate invalid"
                  },
                  "error": {
                    "value": "Bad Request Error"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/cm/power": {
      "get": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Get Power flow control",
        "description": "Endpoint to get the power status.",
        "operationId": "getPowerFlow",
        "responses": {
          "200": {
            "description": "Current battery charge percentage",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "powerFromLV": {
                    "value": "Communication module is receiving power from the Low Voltage Board."
                  },
                  "powerToLV": {
                    "value": "Communication module is powering the Low Voltage Board."
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Error in get power status",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "example": "Incorrect power mode."
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Communication Module"
        ],
        "summary": "Put Power flow control",
        "description": "Endpoint to change the power status, receive power from the Low Voltage Board, or power the Low Voltage Board.",
        "operationId": "putPowerFlow",
        "requestBody": {
          "required": true,
          "content": {
            "text/plain": {
              "schema": {
                "type": "string",
                "enum": [
                  "Power to LV",
                  "Power from LV"
                ],
                "example": "Power to LV"
              },
              "examples": {
                "commMode": {
                  "summary": "The communication module will power the Low Voltage Board.",
                  "value": "Power to LV"
                },
                "lowVoltageMode": {
                  "summary": "The communication module will receive power from the Low Voltage Board.",
                  "value": "Power from LV"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful power mode switching",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "Power mode changed."
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Error in power change",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "errorChange": {
                    "value": "Error in change power mode."
                  },
                  "incorrectPowerMode": {
                    "value": "Incorrect power mode."
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/rtdata/np": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get RT Data NP",
        "description": "Retrieve Realtime Data – Nameplate Information. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvRtDataNp",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/config/data": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Config Data",
        "description": "Configuration Parameters Retrieval. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvConfigData",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/fw/info": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Firmware Info",
        "description": "Firmware Information Retrieval. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvFwInfo",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/config/name": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Config Name",
        "description": "Device Name Retrieval. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvConfigName",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Set Config Name",
        "description": "TS3 Device Name Update. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "setLvConfigName",
        "requestBody": {
          "required": true,
          "content": {
            "text/plain": {
              "schema": {
                "type": "string",
                "example": "Device-001"
              },
              "examples": {
                "TS3Name": {
                  "summary": "Base unit name",
                  "value": "Device-001"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Timeout waiting for device response"
                }
              }
            }
          }
        }
      }
    },
    "/lv/logs/sec": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Security Logs",
        "description": "Retrieve all Security Log File Events. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvLogsSec",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/logs/eng": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Engineering Log File Events",
        "description": "Retrieve all Engineering Log File Events. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvLogsEng",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/logs/trip": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Trip Log File Events",
        "description": "Retrieve all Trip Log File Events. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvLogsTrip",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/rtdata/vars": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get RT Data Variables",
        "description": "Retrieve Realtime Data – Variables. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvRtDataVars",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/rtdata/stats": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get RT Data Statistics",
        "description": "Retrieve Realtime Data – Statistics. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvRtDataStats",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/time/data": {
      "get": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Get Time Data",
        "description": "Retrieve Timestamp. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "getLvTimeData",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/event/notify": {
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Comm Module Event Notification Event",
        "description": "The payload must also comply with the ICD. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "notifyLvEvent",
        "requestBody": {
          "required": true,
          "content": {
            "text/plain": {
              "schema": {
                "type": "string",
                "example": "CommModuleBatteryStatus::discharging,47"
              },
              "examples": {
                "batteryStatus": {
                  "summary": "Comm Module’s charging status and battery level",
                  "value": "CommModuleBatteryStatus::discharging,47"
                },
                "ledEvent": {
                  "summary": "Request TS3 to enable/disable RED/GREEN LED suppression",
                  "value": "sCommModuleSuppressLED::enable"
                },
                "errorEvent": {
                  "summary": "Notify TS3 of Comm Module error condition",
                  "value": "CommModuleError::set,General error"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sucesso - de acordo com o ICD do comando"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Timeout waiting for device response"
                }
              }
            }
          }
        }
      }
    },
    "/lv/sec/mode/disabled": {
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Set Security Mode to Disabled",
        "description": "Set Security Mode. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "setLvSecModeDisabled",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/sec/mode/certauth": {
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Set Security Mode to Certificate Authentication",
        "description": "Set Security Mode. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "setLvSecModeCertAuth",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "uploadChainFirst": {
                    "value": "Before doing so, upload the chain certificate via /cm/install/chain"
                  },
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/sec/mode/passauth": {
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Set Security Mode to Passauth",
        "description": "Set Security Mode. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "setLvSecModePassAuth",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "uploadPassFirst": {
                    "value": "Before doing so, upload the pass key via /cm/install/pass"
                  },
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/trstor/root": {
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Install Root Certificate",
        "description": "Put Root Certificate to TS3. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "installLvTrstorRoot",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "uploadChainFirst": {
                    "value": "Before doing so, upload the chain certificate via /cm/install/chain"
                  },
                  "certifiedModeError": {
                    "value": "It is not possible to perform the operation in certified mode. Switch to unsecured mode or PSK_AUTH."
                  },
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Delete Root Certificate",
        "description": "Delete Root Certificate From TS3. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "deleteLvTrstorRoot",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "certifiedModeError": {
                    "value": "It is not possible to perform the operation in certified mode. Switch to unsecured mode or PSK_AUTH."
                  },
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/lv/trstor/pass": {
      "put": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Install Pass Key",
        "description": "Put Passkey to TS3. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "installLvTrstorPass",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "uploadPassFirst": {
                    "value": "Before doing so, upload the pass key via /cm/install/pass"
                  },
                  "passAuthModeError": {
                    "value": "It is not possible to perform the operation in pass auth mode. Switch to unsecured mode or CERT_AUTH."
                  },
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Low Voltage Board"
        ],
        "summary": "Delete Pass Key",
        "description": "Delete Passkey from TS3. If the command is executed successfully, the return will follow the command's ICD.",
        "operationId": "deleteLvTrstorPass",
        "responses": {
          "200": {
            "description": "Success - according to the command's ICD"
          },
          "400": {
            "description": "Error",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "passAuthModeError": {
                    "value": "It is not possible to perform the operation in pass auth mode. Switch to unsecured mode or CERT_AUTH."
                  },
                  "coapError": {
                    "value": "CoAP error"
                  },
                  "coapNack": {
                    "value": "CoAP NACK"
                  },
                  "coapNotConnected": {
                    "value": "CoAP not connected"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Device connection issues",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "notConnected": {
                    "value": {
                      "error": "Device not connected"
                    }
                  },
                  "disconnectedDuringRequest": {
                    "value": {
                      "error": "Device disconnected during request"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Timeout waiting for device response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "example": {
                    "error": "Timeout waiting for device response"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
},
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis
        ],
        layout: "BaseLayout"
      })
      window.ui = ui
    }
  </script>
</body>
</html>
