EdgeX-API doc
  • EdgeX Foundry Background
  • Getting Started
    • Install
    • UI Console
      • V1.0
      • V1.1
    • Experiencing EdgeX
  • Edge to Cloud
    • Azure
    • AWS
    • Aliyun
  • Edge to Edge
    • MQTT Export Service
    • MQTT Import Service
    • Grafana Dashboard Connection
  • Industrial SDK Setup
  • Device Connection
    • Configuration
    • Programming Basics
    • EdgeX Version
    • Platform
      • System Information
      • RF
    • Cold Chain
      • G1 Sensor
      • Gateway
    • Printer
    • Scanner SDK
    • Battery
    • IP Camera
    • SNMP
    • Modbus
    • Medical Cart
  • Advanced Services APIs
    • EdgeX Service Layers
    • Core Data Service APIs
    • Meta Data Service APIs
    • Command Service APIs
    • Alarm Service APIs
  • Edge AI
    • Face Detection
    • Facial Recognition
  • Edge to WISE-PaaS
    • Smart Pump Station Solution
    • Cloud Cold Chain Solution
    • Integration with WISE-PaaS
  • Edge to Cloud(for Delhi only)
    • Azure
    • AWS
  • Retail Utility
    • OPOS Manager
  • Medical Utility
    • AMiS Link
  • Vertical Utility
    • Self-Diagnostics
    • System Diagnostics
    • DeviceChecking / Kiosk
    • DeviceChecking / Server
    • Device Diagnostic Dashboard
    • Windows Lockdown/ Kiosk
    • Retail System Manager
    • Scanner Utility
  • Application Cases
    • Smart Warehouse
    • Smart Kiosk
    • Demo Video
Powered by GitBook
On this page
  • Content
  • Battery support list
  • Battery API List
  • Installation
  • Battery data display in DeviceOn Server
  • Device and command supported
  • System Requirements
  • Setting Serial Port Number
  • Command List
  • Service-Information
  • WorkingStatusText (GET)
  • Batterypack (GET)
  • IPS420S-MCU
  • Battery_DCinStatus (GET)
  • Battery_AlertStatus (GET)
  • Battery_AlertPercentage (GET)
  • IPS420S-Battery

Was this helpful?

  1. Device Connection

Battery

PreviousScanner SDKNextIP Camera

Last updated 1 year ago

Was this helpful?

Content

  • Battery support list

  • Installation

  • Device and command supported

  • Command List

Battery support list

Battery API List

Installation

  1. Please ensure already installed EdgeX SDK first

  2. Decompress the power device service zip file and copy the power device service folder into C:\Advantech\EdgeX\DeviceService\

3. Modify the correct COM Port in \res\application.ini if the battery module is connected via RS232

Battery data display in DeviceOn Server

Device and command supported

Please refer to the device service configuration and programming in the previous sections first

Retail Service is an EdgeX device service and gets Peripheral information.

System Requirements

Operating system:

  • Windows 10 x86/x64

Device Service

  • IPS420S Serial Port

  • Port : 49983

Setting Serial Port Number

NOTE : Edit exist application.ini and modify SerialPort for IPS420S

path : ./IPS420SBattery/res/application.ini

Command List

Service-Information

version (GET)

Get the IPS420S Service Version

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/ds_IPS420S-Service-Information/version or http://localhost:49983/api/v1/device/name/ds_IPS420S-Service-Information/version

WorkingStatusText (GET)

Get the IPS420S Service WorkingStatus String

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/ds_IPS420S-Service-Information/WorkingStatusText or http://localhost:49983/api/v1/device/name/ds_IPS420S-Service-Information/WorkingStatusText

Batterypack (GET)

Get a number of batteries pack for IPS420S.

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/ds_IPS420S-Service-Information/batterypack or http://localhost:49983/api/v1/device/name/ds_IPS420S-Service-Information/batterypack

Description

IPS420S-MCU

Battery_FirmwareVersion (GET)

Get the IPS420S Battery Firmware Version

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_FirmwareVersion or http://localhost:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_FirmwareVersion

Battery_DCinStatus (GET)

Get the IPS420S Battery DCin Status

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_FirmwareVersion or http://localhost:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_FirmwareVersion

Description

Battery_AlertStatus (GET)

Get the IPS420S Battery Alert Status

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_AlertStatus or http://localhost:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_AlertStatus

Battery_AlertPercentage (GET)

Get the IPS420S Battery Alert Percentage

Restful API : http://IPS420S-Service-IP:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_AlertPercentage or http://localhost:49983/api/v1/device/name/Battery-IPS420S-MCU/Battery_AlertPercentage

IPS420S-Battery

IPS420S-Battery

Battery_RawData (GET)

Get the IPS420S Battery RawData.

Restful API : http://IPS420SService-IP:49983api/v1/device/name/Battery-IPS420S-01/RawData or http://localhost:49983/api/v1/device/name/Battery-IPS420S-01/RawData

JSON Format