The NRGkick can be easily discovered on your local network using
multicast DNS (mDNS). Upon a discovery in the same subnet, the response provides useful information,
including the device's hostname or IP address, serial number, model type, and the status of the
available APIs.
To discover your NRGkick, search using the service type _nrgkick._tcp.
mDNS Metadata Response
The metadata returned from an mDNS discovery typically looks like this:
serial_number: The unique identifier of the NRGkick device.
model_type: Indicates the model of the NRGkick.
device_name: The name assigned to the NRGkick.
json_api_enabled: Shows if the JSON API is enabled (1 for enabled, 0 for disabled).
json_api_version: The version of the JSON API.
modbus_api_enabled: Shows if the Modbus API is enabled (1 for enabled, 0 for disabled).
modbus_api_version: The version of the Modbus API.
Choose API Type
This document provides the basic usage documentation of our local REST JSON API which allows you to interact with device configurations and status informations. If an authentication is desired, BasicAuth can be enabled within the NRGkick App.
This document provides the basic usage of our local ModBus TCP API which allows you to interact with device configurations and status informations. All registers are using the little endian format and are request-able with the Unit ID 1. Addresses must always be read with their corresponding register length. If alignment is maintained, multiple addresses can be read simultaneously.
API Endpoints
1. Device Information
Endpoint:GET /info
Following response includes identifiers such as the serial number and MAC address, which help uniquely identify the device. It also contains network details like the IP address, SSID, as well as hardware and software versions for various components of the NRGkick. This information is crucial for device management, monitoring, and troubleshooting within a networked environment.
Current Altitude in Meter (only valid if cellular-module version >= B15)
accuracy
float
Accuracy of GPS position in Meter (only valid if cellular-module version >= B15)
versions
sw_sm
string
Software version of SmartModule controller
hw_sm
string
Hardware version of the SmartModule controller
sw_ma
string
Software version of the Main controller
hw_ma
string
Hardware Version of the Main controller
sw_to
string
Software version of the Touch controller
hw_to
string
Hardware version of the Touch controller
sw_st
string
Software version of the Star controller
hw_st
string
Hardware version of the Star controller
sw_cm
string
Software version of the cellular module (only shown if cellular module is available)
raw:
general:
connector:
grid:
network:
cellular:
gps:
versions:
/info
Loading data...
2. Device Control
Endpoint:GET /control
This endpoint is used to both retrieve and set parameters related to the charging behaviour of the NRGkick. The charging power and phase count can be adjusted, and the charge can be limited by energy or paused. This endpoint is crucial for managing the operation of the NRGkick, allowing users to monitor and adjust how the device charges.
json key
data type
description
current_set
float
User-set charging current in Ampere
Range: 6.0 - rated_current (16.0A / 32.0A)
charge_pause
bool
Charge pause disabled / enabled
0 - no pause, 1 - pause
energy_limit
uint32
User-set energy-limit in Watt-hours
0 - no limit, >0 limit
phase_count
uint8
User-set maximum charge phases count
Note: Only set-able if phase-switch got enabled within the NRGkick-App. Range: 1 - 3
Loading data...
Write:
A
Wh
/control?
-
-
Wait for request...
3. Device Values
Endpoint:GET /values
This JSON provides detailed energy usage and status data, including total and current energy charged, voltage levels, power metrics across different phases, error codes, and various temperatures for specific components.
json key
data type (*raw mode)
description
energy
total_charged_energy
uint64
Total charged energy overall in Watt-hours
charged_energy
uint32
Charged energy during most recent charge in Watt-hours
powerflow
charging_voltage
float
Average of all phase-voltages in Volt
charging_current
float
Max current signaled to EV in Ampere
grid_frequency
float
Current frequency in Hertz
peak_power
float
Highest power during most recent charge in Watt
total_active_power
float
Active power of all phases combined in Watt
total_reactive_power
float
Reactive power of all phases combined in Volt-Ampere-reactive
total_apparent_power
float
Apparent power of all phases combined in Volt-Ampere
total_power_factor
float
Power factor of all phases
voltage (l1, l2, l3)
float
Voltage per phase in Volt
current (l1, l2, l3, n)
float
Current per phase and neutral conductor in Ampere
active_power (l1, l2, l3)
float
Active power per phase in Watt
reactive_power (l1, l2, l3)
float
Reactive power per phase in Volt-Ampere-reactive
apparent_power (l1, l2, l3)
float
Apparent power per phase in Volt-Ampere
power_factor (l1, l2, l3)
float
Power factor per phase
general
charging_rate
float
Charging rate with considered user defined average consumption of the EV in Kilometer per Hour
Domestic attachment pin1 temperature in Degree Celsius
domestic_plug_2
float
Domestic attachment pin2 temperature in Degree Celsius
raw:
energy:
powerflow:
general:
temperatures:
/values
Loading data...
ModBus Register
1. Device Information
The following table provides required parameters for requesting identifiers such as the serial number and MAC address, which are essential for uniquely identifying the device. It also includes network details like the IP address and SSID, as well as hardware and software versions for various components of the NRGkick. This information is vital for device management, monitoring and troubleshooting within a networked environment. Please note that all registers listed in this table are read-only.
Current Altitude in Meter (only valid if cellular-module version >= B15)
120
2
1
float
R
0x03
Accuracy of GPS position in Meter (only valid if cellular-module version >= B15)
versions
122
8
-
string16
R
0x03
Software version of SmartModule controller
130
8
-
string16
R
0x03
Hardware version of the SmartModule controller
138
8
-
string16
R
0x03
Software version of the Main controller
146
8
-
string16
R
0x03
Hardware Version of the Main controller
154
8
-
string16
R
0x03
Software version of the Touch controller
162
8
-
string16
R
0x03
Hardware version of the Touch controller
170
8
-
string16
R
0x03
Software version of the Star controller
178
8
-
string16
R
0x03
Hardware version of the Star controller
186
8
-
string16
R
0x03
Software version of the cellular module (only shown if cellular module is available)
2. Device Control
The following table provides required parameters for requesting identifiers related to the charging behavior of the NRGkick. Users can adjust the charging power and phase count, limit the charge by energy, or pause the charging process. This endpoint is essential for managing the NRGkick's operation, allowing users to monitor and control the device's charging parameters. Please note that all registers listed in this table are both readable (using function code 0x03) and writable (for single writes, use function code 0x06; for multiple writes, use function code 0x10).
address
register count
factor
data type
type
function code
description
194
1
10
uint16
R / W
0x03 / 0x06 (0x10)
User-set charging current in Ampere
Range: 6.0 - rated_current (16.0A / 32.0A)
195
1
1
uint16
R / W
0x03 / 0x06 (0x10)
Charge pause disabled / enabled
0 - no pause, 1 - pause
196
2
1
uint32
R / W
0x03 / 0x10
User-set energy-limit in Watt-hours
0 - no limit, >0 limit
198
1
1
uint16
R / W
0x03 / 0x06 (0x10)
User-set maximum charge phases count
Note: Only set-able if phase-switch got enabled within the NRGkick-App. Range: 1 - 3
3. Device Values
This table provides required parameters for requesting detailed energy usage and status data, including total and current energy charged, voltage levels, power metrics across different phases, error codes, and various temperatures for specific components. Please note that all registers listed in this table are read-only.
address
register count
factor
data type
type
function code
description
general
199
4
1
uint64
R
0x03
Total charged energy overall in Watt-hours
203
2
1
uint32
R
0x03
Charged energy during most recent charge in Watt-hours
powerflow
205
1
100
uint16
R
0x03
Average of all phase-voltages in Volt
206
1
10
uint16
R
0x03
Max current signaled to EV in Ampere
207
1
100
uint16
R
0x03
Current frequency in Hertz
208
2
1000
int32
R
0x03
Highest power during most recent charge in Watt
210
2
1000
int32
R
0x03
Active power of all phases combined in Watt
212
2
1000
int32
R
0x03
Reactive power of all phases combined in Volt-Ampere-reactive
214
2
1000
uint32
R
0x03
Apparent power of all phases combined in Volt-Ampere
216
1
1000
int16
R
0x03
Power factor of all phases combined
217
1
100
uint16
R
0x03
Voltage of phase L1 in Volt
218
1
100
uint16
R
0x03
Voltage of phase L2 in Volt
219
1
100
uint16
R
0x03
Voltage of phase L3 in Volt
220
1
1000
uint16
R
0x03
Current of phase L1 in Ampere
221
1
1000
uint16
R
0x03
Current of phase L2 in Ampere
222
1
1000
uint16
R
0x03
Current of phase L3 in Ampere
223
1
1000
uint16
R
0x03
Current of neutral conductor in Ampere
224
2
1000
int32
R
0x03
Active Power of phase L1 in Watt
226
2
1000
int32
R
0x03
Active Power of phase L2 in Watt
228
2
1000
int32
R
0x03
Active Power of phase L3 in Watt
230
2
1000
int32
R
0x03
Reactive power of phase L1 in Volt-Ampere-reactive
232
2
1000
int32
R
0x03
Reactive power of phase L2 in Volt-Ampere-reactive
234
2
1000
int32
R
0x03
Reactive power of phase L3 in Volt-Ampere-reactive
236
2
1000
uint32
R
0x03
Apparent power of phase L1 in Volt-Ampere
238
2
1000
uint32
R
0x03
Apparent power of phase L2 in Volt-Ampere
240
2
1000
uint32
R
0x03
Apparent power of phase L3 in Volt-Ampere
242
1
1000
int16
R
0x03
Power factor of phase L1
243
1
1000
int16
R
0x03
Power factor of phase L2
244
1
1000
int16
R
0x03
Power factor of phase L3
general
245
2
1
float
R
0x03
Charging rate with considered user defined average consumption of the EV in Kilometer per Hour
Domestic attachment pin1 temperature in Degree Celsius
263
1
100
int16
R
0x03
Domestic attachment pin2 temperature in Degree Celsius
Note
The mDNS discovery feature and local API access are available starting with
SmartModule version 4.0.0.0. Ensure your NRGkick is running the correct
firmware version to utilize these features.
