# Property of PMA Electrical Solutions, LLC.
#
# WEG CFW08 with an RS-232/RS-485 interface module, Modbus RTU.
# Source: WEG CFW08 User's Guide 0899.5242/05, software 5.2X (03/2009),
# pp. 90-91 and 127-128 (readings/watchdog), pp. 181-185 (V02/V03/V04),
# pp. 188-203 (0-based Modbus map), and pp. 141-146 (fault table).
# Drive setup: P312 = 6 selects 19200 bit/s, even parity Modbus RTU;
# P220-P231 must select Serial. P314 defaults disabled. P313 defaults to
# indication only, so commission P313 = 0 or 1 and a nonzero P314.

name = "WEG CFW08"
vendor = "WEG"
device_type = "vfd"
verified = false
probe_register = 5002

[connection]
summary = "Fit the KRS-485-CFW08 front communication/keypad module; the bare drive has no exposed RS-485 network connector."
warnings = ["Isolate the drive and allow the DC bus to discharge before removing the keypad or installing the module.", "The CFW08 manual labels the network conductors only A, B, and COM; match those names to the adapter datasheet rather than assuming A/B polarity."]
[[connection.methods]]
id = "krs485_cfw08"
title = "KRS-485-CFW08 module"
transport = "serial"
hardware = "option"
port = "KRS-485-CFW08 connector XC12: A, B, COM, and protective-earth/shield marking"
connector = "Module plug-in terminal connector"
adapter = "Isolated USB-to-RS-485 adapter with documented A/B labels"
cable = "Shielded RS-485 twisted pair with optional COM conductor"
parts = ["KRS-485-CFW08 module with keypad", "Small insulated screwdriver", "120 ohm end termination"]
wiring = [{ adapter = "A (verify adapter manual)", device = "XC12 A", signal = "RS-485 conductor A" }, { adapter = "B (verify adapter manual)", device = "XC12 B", signal = "RS-485 conductor B" }, { adapter = "COM/GND", device = "XC12 COM", signal = "RS-485 reference", required = false }, { adapter = "Cable shield", device = "XC12 protective-earth marking", signal = "Shield bond", required = false }]
steps = ["Isolate the drive, remove the standard keypad, and install KRS-485-CFW08 in its place.", "Wire the shielded pair A-to-A and B-to-B; connect COM only when required and bond the shield at the marked point.", "Terminate only the first and last device and route communication separately from power wiring.", "Restore power and select the computer RS-485 adapter."]
setup = ["Set P312 = 6 for 19200 bit/s, even-parity Modbus RTU; set a unique P308 address.", "Select Serial in P220-P231 and commission nonzero P314 plus a safe P313 timeout action."]
warnings = ["Do not use the KCS-CFW08 RS-232 module for this RS-485 guide."]
source = "WEG 0899.5242/05, pp. 158-159, 173-176, and 181-203"

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

[monitor]
status_word = { address = 5002, bits = { 8 = "RampEnable", 9 = "GeneralEnable", 10 = "Forward", 11 = "JOG", 12 = "Remote", 13 = "Undervoltage", 15 = "Fault" } }
output_frequency = { address = 5, scale = 0.01, unit = "Hz" }
motor_current = { address = 3, scale = 0.01, unit = "A" }
dc_bus_voltage = { address = 4, unit = "V" }

[control]
command_register = 5003
speed_register = 5004
speed_scale = 0.01
speed_unit = "Hz"
max_ref = 300.0
step_delay = 0.05
stop = [0x1716]
run_fwd = [0x1716, 0x1717]
run_rev = [0x1712, 0x1713]
reset = [0x9716, 0x9796, 0x9716]

[control.watchdog]
interval_ms = 50
fault = "E28 serial watchdog timeout (P313/P314 require setup)"
backstop_requires_setup = true

[running_check]
register = 5002
bit = 8

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

[faults]
register = 5002
mask = 0x00FF
history = [14]

[faults.codes]
0 = "No active error, or E00 output overcurrent when status bit 15 is set"
1 = "E01 DC-link overvoltage"
2 = "E02 DC-link undervoltage"
4 = "E04 inverter overtemperature"
5 = "E05 motor overload"
6 = "E06 external fault"
8 = "E08 CPU watchdog fault"
9 = "E09 program-memory checksum fault"
10 = "E10 keypad copy fault"
14 = "E14 self-tuning fault"
22 = "E22 serial parity/BCC fault"
24 = "E24 programming error"
25 = "E25 nonexistent variable/parameter"
26 = "E26 value out of range"
27 = "E27 write to read-only/disabled command"
28 = "E28 serial watchdog timeout"
31 = "E31 keypad connection fault"
32 = "E32 motor overtemperature"
41 = "E41 self-diagnosis fault"