# Property of PMA Electrical Solutions, LLC.
#
# Legacy Benshaw RSi SG Series VFD. Primary source: Benshaw publication
# 890046-00-01, "RSi SG Series VFD User Manual", communications chapter 9
# printed pp. 9-1 through 9-9. The chapter publishes direct hexadecimal
# protocol addresses; unlike GM2/H2/S, no -1 conversion applies here.
#
# Setup: DRV03 command source=Int485, DRV04 frequency source=Int485, I/O91
# baud=3 9600, I/O92 lost-command action and I/O93 timeout=1.0 s. I/O92
# defaults None, so set Free-Run or Stop before serial control.

name = "Benshaw RSi SG"
vendor = "Benshaw"
device_type = "vfd"
verified = false
probe_register = 0x0000 # drive model; manual identifies SG as value 4

[connection]
summary = "The RSi SG has a built-in RS-485/Modbus terminal interface."
warnings = []

[[connection.methods]]
id = "built_in_rs485"
title = "Built-in RS-485 terminals"
transport = "serial"
hardware = "built_in"
port = "Control terminals C+, C-, and CM"
connector = "Three control-terminal positions"
adapter = "Isolated USB-to-RS-485 adapter, 2-wire half-duplex"
cable = "Shielded twisted-pair RS-485 cable, 120 ohm nominal impedance"
parts = ["Isolated two-wire RS-485 adapter", "Shielded twisted-pair RS-485 cable, 120 ohm nominal impedance"]
steps = ["Lock out line and control power, wait the vendor-specified discharge time, and verify the DC bus is de-energized before opening a cover or landing conductors.", "Land the positive and negative data conductors exactly as shown; connect the cable shield or signal common only where the method identifies it.", "Route the communications cable away from motor and mains conductors. Terminate the two physical ends of a long multidrop trunk only.", "Restore control power with the motor area clear, configure the drive from its keypad, then verify identity and read-only monitor data before enabling remote control."]
setup = ["Set DRV03=Int485, DRV04=Int485, I/O91=3 for 9600, and set I/O92/I/O93 communication-loss behavior."]
warnings = ["RS-485 A/B naming is not consistent between manufacturers. Follow the + and - signal mapping in this guide, not the letter printed on an unfamiliar adapter.", "Do not use protective earth as the data return unless the vendor drawing explicitly calls for it."]
source = "Benshaw 890046-00-01 RSi SG User Manual, printed pp. 3-18 to 3-19 (terminal wiring) and chapter 9 pp. 9-1 to 9-9 (setup)"

[[connection.methods.wiring]]
adapter = "Adapter D+ / +"
device = "C+"
signal = "RS-485 data positive"
required = true

[[connection.methods.wiring]]
adapter = "Adapter D- / -"
device = "C-"
signal = "RS-485 data negative"
required = true

[[connection.methods.wiring]]
adapter = "Adapter signal ground / shield"
device = "CM"
signal = "Signal reference or shield drain"
required = false

[serial]
baudrate = 9600
parity = "N"
stopbits = 1

[monitor]
motor_current = { address = 0x0009, scale = 0.1, unit = "A" }
output_frequency = { address = 0x000A, scale = 0.01, unit = "Hz" }
output_voltage = { address = 0x000B, unit = "V" }
dc_voltage = { address = 0x000C, scale = 0.1, unit = "V" }
output_power = { address = 0x000D, scale = 0.1, unit = "kW" }
status_word = { address = 0x000E, bits = { 0 = "STOPPED", 1 = "RUNNING_FWD", 2 = "RUNNING_REV", 3 = "FAULT_TRIP", 4 = "ACCELERATING", 5 = "DECELERATING", 6 = "FREQUENCY_ARRIVAL", 7 = "DC_OPERATION", 8 = "STOPPING", 10 = "BRAKE_OPEN", 11 = "FWD_CMD", 12 = "REV_CMD", 13 = "START_SOURCE_COMMS", 14 = "FREQUENCY_SOURCE_COMMS" } }

# 0x0006 bits are edge commands: 0 stop, 1 forward, 2 reverse, 3 reset.
[control]
command_register = 0x0006
speed_register = 0x0005
speed_scale = 0.01
speed_unit = "Hz"
max_ref = 120.0
step_delay = 0.05
stop = [0x0000, 0x0001]
run_fwd = [0x0000, 0x0002]
run_rev = [0x0000, 0x0004]
reset = [0x0000, 0x0008, 0x0000]

[control.watchdog]
backstop_requires_setup = true
interval_ms = 500
fault = "LOR lost-command indication (requires I/O92 Free-Run or Stop; I/O93 timeout)"

[faults]
register = 0x000F
bitfield = true
bits = { 0 = "OVERCURRENT_1", 1 = "OVERVOLTAGE", 2 = "EXTERNAL_A", 3 = "EMERGENCY_STOP_BX", 4 = "LOW_VOLTAGE", 6 = "GROUND_FAULT", 7 = "INVERTER_OVERHEAT", 8 = "MOTOR_OVERHEAT", 9 = "OVERLOAD", 10 = "HARDWARE_DIAGNOSIS", 12 = "OVERCURRENT_2", 13 = "OPTION_ERROR", 14 = "OUTPUT_PHASE_OPEN", 15 = "INVERTER_OVERLOAD" }

[rating]
register = 0x0001
label = "drive capacity code"

# No [running_check]: forward/reverse are distinct bits. No broad parameter
# ranges because the parameter space includes the active serial configuration.