Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lagerdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Control and monitor battery simulator Nets (Keithley 2281S) through the Lager CLI for battery simulation and testing.

​
Syntax

lager battery [OPTIONS] [NETNAME] COMMAND [ARGS]...

​
Global Options

OptionDescription
--box TEXTLagerbox name or IP address
--helpShow help message and exit

​
Commands

CommandDescription
modeSet or read battery simulation mode (static/dynamic)
setInitialize battery simulator mode
socSet or read state of charge (%)
vocSet or read open circuit voltage (V)
batt-fullSet or read fully charged voltage (V)
batt-emptySet or read fully discharged voltage (V)
capacitySet or read battery capacity (Ah)
current-limitSet or read max charge/discharge current (A)
ovpSet or read over-voltage protection (V)
ocpSet or read over-current protection (A)
modelSet or read battery model
stateGet comprehensive battery state
enableEnable battery simulator output
disableDisable battery simulator output
clearClear all protection trip conditions
clear-ovpClear OVP trip condition
clear-ocpClear OCP trip condition
tuiLaunch interactive terminal UI

​
Listing Battery Nets

When invoked with only --box and no subcommand, lists all battery nets on the Lager Box: 
lager battery --box my-lager-box

​
Command Reference

​
mode

Set or read battery simulation mode type. 
lager battery NETNAME mode [static|dynamic] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • [static|dynamic] - Mode type (omit to read current mode)
Options:
  • --box TEXT - Lagerbox name or IP
Examples: 
# Read current mode
lager battery batt1 mode --box my-lager-box

# Set static mode
lager battery batt1 mode static --box my-lager-box

​
set

Initialize battery simulator mode. Prepares the instrument for battery simulation. 
lager battery NETNAME set [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP

​
soc

Set or read battery state of charge in percent. 
lager battery NETNAME soc [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - State of charge percentage (0-100), omit to read
Options:
  • --box TEXT - Lagerbox name or IP
Examples: 
# Read current SOC
lager battery batt1 soc --box my-lager-box

# Set SOC to 80%
lager battery batt1 soc 80 --box my-lager-box

​
voc

Set or read battery open circuit voltage in volts. 
lager battery NETNAME voc [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - Open-circuit voltage (volts), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
batt-full

Set or read battery fully charged voltage in volts. 
lager battery NETNAME batt-full [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - Voltage at 100% SOC (volts), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
batt-empty

Set or read battery fully discharged voltage in volts. 
lager battery NETNAME batt-empty [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - Voltage at 0% SOC (volts), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
capacity

Set or read battery capacity limit in amp-hours. 
lager battery NETNAME capacity [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - Battery capacity (Ah), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
current-limit

Set or read maximum charge/discharge current in amps. 
lager battery NETNAME current-limit [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - Maximum current limit (amps), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
ovp

Set or read over-voltage protection limit in volts. 
lager battery NETNAME ovp [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - OVP limit (volts), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
ocp

Set or read over-current protection limit in amps. 
lager battery NETNAME ocp [VALUE] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • VALUE - OCP limit (amps), omit to read
Options:
  • --box TEXT - Lagerbox name or IP

​
model

Set or read battery model preset. 
lager battery NETNAME model [PARTNUMBER] [OPTIONS]
Arguments:
  • NETNAME - Name of the battery Net
  • PARTNUMBER - Battery model (e.g., 18650, nimh, lead-acid), omit to read
Options:
  • --box TEXT - Lagerbox name or IP
Supported Models:
  • 18650 - Standard lithium-ion cell
  • nimh - Nickel-metal hydride
  • lead-acid - Lead acid battery
  • Custom part numbers from your battery library

​
state

Get comprehensive battery state including all current settings and measurements. 
lager battery NETNAME state [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP
Example Output: 
Battery State:
  Mode: static
  SOC: 80%
  VOC: 3.7V
  Voltage Range: 3.0V - 4.2V
  Capacity: 2.5Ah
  Current Limit: 1.5A
  OVP: 4.5V
  OCP: 2.0A
  Output: Enabled

​
enable

Enable battery simulator output. 
lager battery NETNAME enable [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP
  • --yes - Skip confirmation prompt

​
disable

Disable battery simulator output. 
lager battery NETNAME disable [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP
  • --yes - Skip confirmation prompt

​
clear

Clear all protection trip conditions (OVP and OCP). 
lager battery NETNAME clear [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP

​
clear-ovp

Clear over-voltage protection trip condition. 
lager battery NETNAME clear-ovp [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP

​
clear-ocp

Clear over-current protection trip condition. 
lager battery NETNAME clear-ocp [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP

​
tui

Launch interactive terminal UI for real-time monitoring and control. 
lager battery NETNAME tui [OPTIONS]
Options:
  • --box TEXT - Lagerbox name or IP
TUI Features:
  • Real-time voltage/current display
  • SOC adjustment slider
  • Enable/disable controls
  • Protection status indicators
  • Keyboard navigation

​
Examples

# List all battery nets
lager battery --box my-lager-box

# Configure a Li-ion cell simulation
lager battery batt1 batt-full 4.2 --box my-lager-box
lager battery batt1 batt-empty 3.0 --box my-lager-box
lager battery batt1 capacity 2.5 --box my-lager-box
lager battery batt1 current-limit 1.5 --box my-lager-box

# Set protection limits
lager battery batt1 ovp 4.5 --box my-lager-box
lager battery batt1 ocp 2.0 --box my-lager-box

# Set initial state and enable
lager battery batt1 soc 80 --box my-lager-box
lager battery batt1 enable --yes --box my-lager-box

# Check battery status
lager battery batt1 state --box my-lager-box

# Read current SOC
lager battery batt1 soc --box my-lager-box

# Clear protection faults
lager battery batt1 clear --box my-lager-box

# Use a preset model
lager battery batt1 model 18650 --box my-lager-box

# Launch interactive UI
lager battery batt1 tui --box my-lager-box

# Disable when done
lager battery batt1 disable --yes --box my-lager-box

​
Supported Hardware

InstrumentDescription
Keithley 2281SBattery Simulator with dynamic modeling

​
Notes

  • All value commands (soc, voc, ovp, etc.) read the current value when called without an argument
  • Use --yes flag to skip confirmation prompts for enable/disable
  • Protection limits help prevent damage during testing
  • SOC can be set from 0-100% for realistic battery simulation
  • The state command provides a comprehensive view of all settings
  • Mode can be static (fixed parameters) or dynamic (SOC-based modeling)
  • The TUI allows concurrent CLI access while monitoring

​
See Also