# Property of PMA Electrical Solutions, LLC.
#
# WEG CFW100 G1 with a CFW100-CRS485 plug-in module, Modbus RTU.
# Sources:
# - WEG Modbus RTU User's Manual 10002909455/01 (03/2015), pp. 9-17:
#   serial defaults, watchdog, P680/P682/P683, and zero-offset register map.
# - WEG CFW100 Programming Manual 10008008405/04, V4.2X (11/2021):
#   quick reference pp. 0-1..0-23, faults pp. 1-1..1-6, P295 p. 6-2,
#   and reading parameters pp. 11-1..11-4.
# Drive setup: P312 selects Modbus RTU; P220/P222/P226/P227 must select
# Serial for remote mode. Set P314 nonzero; P313 defaults to 1 (ramp stop).
# Addressing: parameter Pnnn is 0-based holding register nnn.

name = "WEG CFW100 G1"
vendor = "WEG"
device_type = "vfd"
verified = false
probe_register = 680

[connection]
summary = "Install the CFW100-CRS485 plug-in module and use its terminal RS-485 interface."
warnings = ["Isolate and discharge the inverter before installing or removing the plug-in.", "The module's mini-USB carries the same RS-485/keypad signal; do not treat it as the documented computer USB path."]
[[connection.methods]]
id = "cfw100_crs485"
title = "CFW100-CRS485 terminals"
transport = "serial"
hardware = "option"
port = "Module terminals 6 RS485-B(-), 7 RS485-A(+), 8 GND"
connector = "Plug-in module control terminals"
adapter = "Isolated USB-to-RS-485 adapter"
cable = "Shielded twisted pair with optional reference conductor"
parts = ["CFW100-CRS485 module", "Small insulated screwdriver", "Module S1 termination at bus ends"]
wiring = [{ adapter = "D- / A-", device = "6, RS485-B (-)", signal = "RS-485 negative" }, { adapter = "D+ / B+", device = "7, RS485-A (+)", signal = "RS-485 positive" }, { adapter = "COM/GND", device = "8, GND", signal = "0 V reference", required = false }]
steps = ["Isolate the drive and install CFW100-CRS485.", "Land negative on terminal 6 and positive on terminal 7; use terminal 8 only when a reference is needed.", "Set both S1 switches on only at a physical bus end and route the cable away from power conductors.", "Restore power and select the isolated computer adapter."]
setup = ["Set P312 for Modbus RTU and configure P308/P310/P311.", "Select Serial in P220/P222/P226/P227 and set P314 nonzero with the desired P313 action."]
warnings = ["S1.1/S1.2 mixed positions are not allowed."]
source = "WEG 10002909455/01, pp. 7-8 and 9-17"

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

[monitor]
status_word = { address = 680, bits = { 5 = "SecondRamp", 6 = "ConfigMode", 7 = "Alarm", 8 = "MotorRunning", 9 = "GeneralEnable", 10 = "Forward", 11 = "JOG", 12 = "Remote", 13 = "Undervoltage", 15 = "Fault" } }
output_frequency = { address = 5, scale = 0.1, unit = "Hz" }
motor_current = { address = 3, scale = 0.1, unit = "A" }
dc_bus_voltage = { address = 4, unit = "V" }
output_voltage = { address = 7, unit = "V" }
motor_torque = { address = 9, signed = true, scale = 0.1, unit = "%" }
motor_speed = { address = 681, signed = true, scale = 0.01220703125, unit = "%" }
present_alarm = { address = 48 }

[control]
command_register = 682
speed_register = 683
speed_scale = 0.01220703125
speed_unit = "%"
max_ref = 100.0
step_delay = 0.05
stop = [0x0016]
run_fwd = [0x0016, 0x0017]
run_rev = [0x0012, 0x0013]
reset = [0x0016, 0x0096, 0x0016]

[control.watchdog]
interval_ms = 50
fault = "A128/F228 serial timeout (P314, if configured)"
backstop_requires_setup = true

[running_check]
register = 680
bit = 8

[direction_check]
register = 680
bit = 10
reverse_when_set = false

[faults]
register = 49
history = [50, 60, 70, 80, 81, 82]

[faults.codes]
0 = "No fault"
21 = "F021 DC-link undervoltage"
22 = "F022 DC-link overvoltage"
31 = "F031 expansion-accessory communication fault"
33 = "F033 VVW self-tuning fault"
51 = "F051 IGBT overtemperature"
70 = "F070 overcurrent or short circuit"
72 = "F072 motor overload"
78 = "F078 motor overtemperature"
79 = "F079 encoder signal fault"
80 = "F080 CPU watchdog fault"
81 = "F081 end of user memory"
82 = "F082 flash-memory-module data-transfer fault"
84 = "F084 auto-diagnosis fault"
91 = "F091 external fault"
228 = "F228 Serial communication timeout"
233 = "F233 CAN interface without power"
234 = "F234 CAN bus off"
235 = "F235 CANopen node guarding/heartbeat fault"
236 = "F236 DeviceNet master idle"
237 = "F237 DeviceNet connection timeout"
701 = "F701 remote-HMI communication fault"
709 = "F709 SoftPLC application stopped"
710 = "F710 SoftPLC application too large"
711 = "F711 SoftPLC application fault"
# F750..F799 are application-defined SoftPLC faults; their meanings are not fixed.
761 = "F761 process-variable low-level fault"
763 = "F763 process-variable high-level fault"

[rating]
register = 295
scale = 0.1
unit = "A"
label = "Inverter rated current (P295)"