# Property of PMA Electrical Solutions, LLC.
#
# WEG SSW7000 medium-voltage soft starter over Modbus RTU, using the exact
# SSW7000 RS485-01 kit (WEG 10051957). No low-voltage SSW map is reused.
#
# Sources — WEG primary documentation:
#   10001039049 / 01, "SSW7000 Manual do Usuario Modbus RTU":
#     RS485-01 hardware ....................................... pp. 8-10
#     serial defaults, link-loss response ..................... pp. 11-13
#     P0680 status / P0682 serial command words ............... pp. 13-15
#     0-based parameter mapping ............................... pp. 19-22
#     A128/F228 serial timeout ................................ p. 27
#   10001038255 / 07, "SSW7000 Programming Manual" V1.7X:
#     parameter summary and scales ............................ pp. 10-26
#     complete fault/alarm table .............................. pp. 28-43
#     P0001-P0021 readings .................................... pp. 122-126
#     P0900-P0990 fault history ............................... pp. 129-133
#
# ADDRESSING: the SSW7000 Modbus manual defines zero offset; parameter Pnnnn
# is holding-register address nnnn. All addresses here are already 0-based.
#
# DRIVE-SIDE SETUP: install RS485-01; set P0220/P0229/P0230 so Serial/USB owns
# the active command source. Set P0308 to a nonzero node address, and confirm
# P0310/P0311 framing. The SSW can ACK P0682 while another source owns control.
#
# LINK LOSS: P0314 defaults 0.0 (disabled), while P0313 defaults Inactive. A
# silent controller can therefore leave the motor energized. Set P0314 to a
# nonzero time and P0313 = 1 (ramp stop), 2 (general disable), or 5 (F228)
# before arming. P0313 actions write P0682 automatically and only work when
# Serial/USB actually owns the commands.
#
# No speed reference or run_rev is provided. Although the SSW7000 publishes a
# direction bit for engineered reversing systems, it does not make this an
# ordinary bidirectional drive; reversal depends on external power hardware.

name = "WEG SSW7000"
vendor = "WEG"
device_type = "soft_starter"
verified = false
probe_register = 680

[connection]
summary = "Install the exact SSW7000 RS485-01 kit 10051957 and wire its XC7 connector."
warnings = ["Medium-voltage equipment requires the site's qualified-person lockout, grounding, and arc-flash procedure before access.", "Do not reuse a low-voltage SSW communication kit or pinout."]
[[connection.methods]]
id = "rs485_01_10051957"
title = "SSW7000 RS485-01 kit"
transport = "serial"
hardware = "option"
port = "XC7 pins 1 A-Line(-), 2 B-Line(+), 3 GND, 4 Ground/shield"
connector = "4-way plug-in XC7"
adapter = "Isolated USB-to-RS-485 adapter suitable for the installation environment"
cable = "Shielded industrial RS-485 twisted pair with optional reference"
parts = ["WEG RS485-01 kit 10051957", "Kit mounting hardware", "S1 endpoint termination"]
wiring = [{ adapter = "D- / A-", device = "XC7-1 A-Line (-)", signal = "RS-485 negative" }, { adapter = "D+ / B+", device = "XC7-2 B-Line (+)", signal = "RS-485 positive" }, { adapter = "COM/GND", device = "XC7-3 GND", signal = "0 V reference", required = false }, { adapter = "Cable shield", device = "XC7-4 Ground", signal = "Shield bond", required = false }]
steps = ["Apply the facility's MV lockout/grounding procedure and verify the equipment safe.", "Install RS485-01 10051957 and locate XC7.", "Wire XC7-1 negative, XC7-2 positive, optional reference to XC7-3, and shield to XC7-4; enable S1 only at a bus end.", "Restore all barriers, release the equipment under site procedure, and select the serial adapter."]
setup = ["Set P0308 node and P0310/P0311 framing.", "Set P0220/P0229/P0230 so Serial/USB owns commands, and configure nonzero P0314 plus a stopping/tripping P0313 action."]
warnings = ["Only qualified MV personnel should perform the physical work.", "P0313/P0314 defaults do not stop on link loss."]
source = "WEG 10001039049/01, pp. 8-13 and 19-22"

# P0310 default 0 = 9600; P0311 default 3 = no parity, 2 stop bits.
[serial]
baudrate = 9600
parity = "N"
stopbits = 2

[monitor]
status_word = { address = 680, bits = { 0 = "MotorRunning", 1 = "GeneralEnabled", 2 = "JOG", 3 = "Accelerating", 4 = "RestartDelay", 5 = "FullVoltage", 6 = "Alarm", 7 = "Decelerating", 8 = "Remote", 9 = "DCBraking", 10 = "Reversing", 11 = "CCW", 12 = "BypassClosed", 13 = "ConfigurationMode", 14 = "PowerPresent", 15 = "Fault" } }
starter_current = { address = 1, scale = 0.1, unit = "%" }
motor_current_percent = { address = 2, scale = 0.1, unit = "%" }
motor_current = { address = 3, scale = 0.1, unit = "A" }
line_voltage = { address = 4, unit = "V" }
line_frequency = { address = 5, scale = 0.1, unit = "Hz" }
output_voltage = { address = 7, unit = "V" }
motor_torque = { address = 9, scale = 0.1, unit = "%" }
motor_thermal = { address = 50, scale = 0.1, unit = "%" }

[control]
command_register = 682
step_delay = 0.05
# P0682 bits 0 Run, 1 General Enable, 4 Remote; direction remains clockwise.
stop = [0x0012]
run_fwd = [0x0012, 0x0013]
# Reset bit7 is pulsed with Run clear throughout.
reset = [0x0012, 0x0092, 0x0012]

[control.watchdog]
interval_ms = 50
fault = "A128/F228 serial communication timeout (P0314; action P0313)"
backstop_requires_setup = true

[running_check]
register = 680
bit = 0

# P0020 present fault; P0900, P0910 ... P0990 are the ten prior fault codes.
[faults]
register = 20
history = [900, 910, 920, 930, 940, 950, 960, 970, 980, 990]

[faults.codes]
0 = "No active fault"
1 = "F001 motor supply voltage imbalance"
2 = "F002 motor supply undervoltage"
3 = "F003 phase loss at start"
5 = "F005 motor overload thermal class"
10 = "F010 control-board C1 fault"
11 = "F011 ground fault by current"
12 = "F012 ground fault by voltage"
13 = "F013 open fuse"
15 = "F015 motor not connected"
16 = "F016 motor supply overvoltage"
40 = "F040 C1-C2 serial communication fault"
42 = "F042 CPU watchdog fault"
44 = "F044 arc detected"
51 = "F051 R-U arm SCR undertemperature"
52 = "F052 S-V arm SCR undertemperature"
53 = "F053 T-W arm SCR undertemperature"
54 = "F054 R-U arm SCR overtemperature"
55 = "F055 S-V arm SCR overtemperature"
56 = "F056 T-W arm SCR overtemperature"
57 = "F057 R-U arm SCR failure"
58 = "F058 S-V arm SCR failure"
59 = "F059 T-W arm SCR failure"
62 = "F062 starting time exceeded"
63 = "F063 locked rotor at end of start"
64 = "F064 SCR overload"
65 = "F065 motor undercurrent at full voltage"
66 = "F066 motor overcurrent at full voltage"
67 = "F067 inverted phase sequence at start"
70 = "F070 control-power undervoltage"
71 = "F071 bypass contact open"
74 = "F074 current imbalance at full voltage"
75 = "F075 frequency out of range"
76 = "F076 undercurrent before bypass closing"
77 = "F077 bypass contact closed"
78 = "F078 motor undertorque"
79 = "F079 motor overtorque"
80 = "F080 motor underpower"
81 = "F081 motor overpower"
82 = "F082 parameter-copy fault"
84 = "F084 auto-diagnosis fault"
91 = "F091 external fault"
99 = "F099 invalid current offset"
101 = "F101 motor overtemperature channel 1"
102 = "F102 motor overtemperature channel 2"
103 = "F103 motor overtemperature channel 3"
104 = "F104 motor overtemperature channel 4"
105 = "F105 motor overtemperature channel 5"
106 = "F106 motor overtemperature channel 6"
107 = "F107 motor overtemperature channel 7"
108 = "F108 motor overtemperature channel 8"
109 = "F109 motor-temperature channel 1 broken cable"
110 = "F110 motor-temperature channel 2 broken cable"
111 = "F111 motor-temperature channel 3 broken cable"
112 = "F112 motor-temperature channel 4 broken cable"
113 = "F113 motor-temperature channel 5 broken cable"
114 = "F114 motor-temperature channel 6 broken cable"
115 = "F115 motor-temperature channel 7 broken cable"
116 = "F116 motor-temperature channel 8 broken cable"
117 = "F117 motor-temperature channel 1 short circuit"
118 = "F118 motor-temperature channel 2 short circuit"
119 = "F119 motor-temperature channel 3 short circuit"
120 = "F120 motor-temperature channel 4 short circuit"
121 = "F121 motor-temperature channel 5 short circuit"
122 = "F122 motor-temperature channel 6 short circuit"
123 = "F123 motor-temperature channel 7 short circuit"
124 = "F124 motor-temperature channel 8 short circuit"
126 = "F126 IOE-04 access error"
140 = "F140 phase loss during current-transformer test"
141 = "F141 motor not connected during current-transformer test"
142 = "F142 R-U current-transformer test fault"
143 = "F143 S-V current-transformer test fault"
144 = "F144 T-W current-transformer test fault"
145 = "F145 safe-sectioning fault"
151 = "F151 flash-memory module fault"
161 = "F161 incompatible PLD firmware"
162 = "F162 incompatible C1-C2 firmware"
228 = "F228 serial communication timeout"
229 = "F229 Anybus offline"
230 = "F230 Anybus access error"
701 = "F701 disconnected HMI (SoftPLC)"
750 = "F750 SoftPLC user fault"
751 = "F751 SoftPLC user fault"
752 = "F752 SoftPLC user fault"
753 = "F753 SoftPLC user fault"
754 = "F754 SoftPLC user fault"
755 = "F755 SoftPLC user fault"
756 = "F756 SoftPLC user fault"
757 = "F757 SoftPLC user fault"
758 = "F758 SoftPLC user fault"
759 = "F759 SoftPLC user fault"
760 = "F760 SoftPLC user fault"
761 = "F761 SoftPLC user fault"
762 = "F762 SoftPLC user fault"
763 = "F763 SoftPLC user fault"
764 = "F764 SoftPLC user fault"
765 = "F765 SoftPLC user fault"
766 = "F766 SoftPLC user fault"
767 = "F767 SoftPLC user fault"
768 = "F768 SoftPLC user fault"
769 = "F769 SoftPLC user fault"
770 = "F770 SoftPLC user fault"
771 = "F771 SoftPLC user fault"
772 = "F772 SoftPLC user fault"
773 = "F773 SoftPLC user fault"
774 = "F774 SoftPLC user fault"
775 = "F775 SoftPLC user fault"
776 = "F776 SoftPLC user fault"
777 = "F777 SoftPLC user fault"
778 = "F778 SoftPLC user fault"
779 = "F779 SoftPLC user fault"
780 = "F780 SoftPLC user fault"
781 = "F781 SoftPLC user fault"
782 = "F782 SoftPLC user fault"
783 = "F783 SoftPLC user fault"
784 = "F784 SoftPLC user fault"
785 = "F785 SoftPLC user fault"
786 = "F786 SoftPLC user fault"
787 = "F787 SoftPLC user fault"
788 = "F788 SoftPLC user fault"
789 = "F789 SoftPLC user fault"
790 = "F790 SoftPLC user fault"
791 = "F791 SoftPLC user fault"
792 = "F792 SoftPLC user fault"
793 = "F793 SoftPLC user fault"
794 = "F794 SoftPLC user fault"
795 = "F795 SoftPLC user fault"
796 = "F796 SoftPLC user fault"
797 = "F797 SoftPLC user fault"
798 = "F798 SoftPLC user fault"
799 = "F799 SoftPLC user fault"

# [parameters] is intentionally absent. The SSW7000 parameter space interleaves
# reset/load/save commands, network identity, command words, and configuration;
# broad ranges would make restore unsafe without a per-parameter allowlist.