Ss2 V0 Actions

Execute actions and control Ss2 V0 devices

Last updated: 2026-01-17 22:29:07
Back to Device Types

Device Selection

Please select a device to enable action execution.
Available Actions
71
Ready to execute
Device Type
Ss2 V0
Active type
Selected Device
None
Select device
Queue Status
-
System status

Disable White Led

User Land: Disable the white LED

Enable White Led

User Land: Enable the white LED

End Connection

End the connection to the device.

Fetch Update

Fetch the state of the device

Get Billing Location

Get the billing location

Parameters:

raise_exception boolean

Get Complete State

Get the complete state of the device

Get Complete State Raw

Fetch the complete state of the meter by reading each Modbus register. The only difference from get_complete_state is that it does not update the instance variables

Health Checkup

Health checkup

Modbus One Register Read

Read a single register from the Modbus device

Parameters:

device_id integer
function_code integer
register_address integer
read_back_bytes integer
timeout integer

Modbus Read Message

Read a message from the Modbus device

Parameters:

device_id integer
function_code integer
register_address integer
count integer
read_back_bytes integer
timeout integer

Modbus Read Register

Read a register from the Modbus device

Parameters:

register_addr integer
count integer

Modbus Scan2

Scan for Modbus devices

Parameters:

device_id integer
function_code integer
start_address integer
count integer
read_back_bytes integer
timeout integer

Modbus Scan

Scan for Modbus devices

Parameters:

device_id integer
function_code integer
start_address integer
count integer
read_back_bytes integer
timeout integer

Modbus Write Message

Write a message to the Modbus device

Parameters:

device_id integer
function_code integer
register_address integer
value integer
read_back_bytes integer
timeout integer

Modbus Write Register

Write a register to the Modbus device

Parameters:

modbus_device_address integer
register_addr integer
value integer
read_back_bytes integer
timeout integer

Mode Measurement

Set the mode to measurement

Mode Postpaid

Set the mode to postpaid

Mode Prepaid

Set the mode to prepaid

Mode Relay Off

Set the mode to measurement

Nic Clear Primary Network Credentials

Clear the primary network credentials

Nic Get Description

Get the description of the NIC device

Nic Get Network Details

Get the network details

Nic Get Primary Network Credentials

Get the primary network credentials

Nic Ota Update

Perform an OTA update on the NIC device

Parameters:

version_name string

Nic Restart

User Land: Restart the NIC

Nic Set Device Manfacturer Code

Set the manufacturer code of the NIC device

Parameters:

manufacturer_code integer

Nic Set Hardware Id

Sets the hardware ID of the NIC device

Parameters:

nic_hardware_id integer

Nic Switch To Primary Network

Switch to the primary network

Nic Switch To Secondary Network

Switch to the secondary network

On Device Calibrate Rtc

Calibrate RTC with current system time

On Device Forced Dg Source

On Device: Force the meter to use the DG tariff

On Device Forced Eb Source

On Device: Force the meter to use the EB tariff

On Device Forced Relay Off

On device: Force the relay to be off. The relay will always stay off.

On Device Forced Relay On

On Device: Force the relay to be on

On Device Set Active Tariff

Set the active tariff for a prepaid card

Parameters:

tariff_type integer

On Device Set Balance

Set on device balance to a given amount

On Device Set Daily Deduction

On Device: Set the daily deduction for a prepaid card

Parameters:

amount integer

On Device Set Dg Tariff

On Device: Set the DG tariff on device

Parameters:

tariff integer

On Device Set Eb Tariff

On Device: Set the EB tariff on device

Parameters:

tariff integer

On Device Set Happy Day

On Device: Set the happy day on device. The weird this is there is no way provided to read back the written value by the vendor.

Parameters:

day integer
month integer

On Device Set Happy Hour

Set the happy hour for a prepaid card

Parameters:

start integer
end integer

On Device Set Hardware Id

On Device: Set hardware ID. This Modbus command was given to us by the vendor.

Parameters:

new_device_id integer

On Device Set Max Load Dg

On Device: Set the maximum load for DG

Parameters:

max_load number

On Device Set Max Load Eb

Set the maximum load for EB

Parameters:

max_load number

On Device Set Modbus Slave Id

On Device: Set the modbus slave ID on device. WARNING: Don't use this! It would screw up the system!

Parameters:

slave_id integer

On Device Set Overload Delay Between Two Attempts

On Device: Set the overload delay between two attempts

Parameters:

interval integer

On Device Set Overload Max Attempt

Set the maximum number of overload attempts

Parameters:

count integer

On Device Set Rtc

Set RTC on device

Parameters:

year integer
month integer
day integer
hour integer
minutes integer
seconds integer

On Device Set Tariff

Set the tariff for a prepaid card

Parameters:

tariff_type integer
tariff integer

On Device Source Reset

On Device: This was called `eb_dg_reset` in the originally. It resets the forcefully set source and leaves it on the meter's sensing to determine the current source of power.

On Server Disable Prepaid Metering

On Server: Disable the prepaid metering

On Server Enable Prepaid Metering

On Server: Enable the prepaid metering

On Server Set Dual Source Tariff

Set the tariff

Parameters:

active_source string
rates object

On Server Set Flat Tariff

Set the tariff

Parameters:

rate integer

Perform Deduction

Perform a deduction

Parameters:

amount integer
db_id integer

Perform Recharge

Perform a recharge

Parameters:

db_id integer
amount integer

Send Serial Message

Send a serial message to the NIC device

Parameters:

message string
read_back_bytes integer
timeout integer

Send Serial Message Raw

Send a raw serial message to the NIC device

Parameters:

data string
read_back_bytes integer
timeout integer

Set Context Type

On Server: Set the context type.

Parameters:

context_type string

Set Ct Meter Configuration

On Server: Set the CT meter configuration.

Parameters:

ct_primary_current number
ct_secondary_current number

Set Dg Tariff

On Server: Set the DG tariff in Paise. This will then be used to compute balance on server.

Parameters:

tariff integer

Set Eb Tariff

On Server: Set the EB tariff in Paise. This will then be used to compute balance on server.

Parameters:

tariff integer

Set Happy Hour

Set the happy hour for a prepaid card

Parameters:

happy_hour array

Set Prepaid Balance

On Server: Set the prepaid balance in Paise.

Parameters:

balance integer

Set Prepaid Metering Enabled

On Server: Set the prepaid metering enabled.

Parameters:

enabled integer

Set Primary Network Credentials

Set the primary network credentials

Parameters:

ssid string
password string

Set Update Interval

Set the update interval

Parameters:

interval integer

Set Variant Details

On Server: Set the variant details.

Parameters:

specification_id integer
connection_interface string
current_direction string
number_of_phases integer
metering_board_version string
metering_firmware_version string
nic_board_version string
nic_firmware_version string
number_of_relays integer
communication_interface string
basic_meter_current number
max_meter_current number
ct_primary_current number
ct_secondary_current number
custom_build_number string

Start Connection

Start the connection to the device

Parameters:

device_id any
endpoint string

Transparent Serial Communication

Send a transparent serial communication message

Parameters:

data string
read_back_bytes integer
timeout integer

Update Packet Handler

Handle update packet from the device

Parameters:

message string
message_type string
timestamp integer