# Property of PMA Electrical Solutions, LLC.
#
# Schneider Altivar 71, embedded Modbus RTU. Exact-family sources: 1755863.03
# Integrated Modbus Manual (11/2010), defaults pp.15, timeout/freewheel
# response pp.21-22 and diagnostic summary p.30; 1755861.08 Communication
# Parameters (02/2013), CMD/LFR/ETA pp.80-95, metering pp.95-100, LFT and full
# exact-family enumeration pp.107-111, history pp.115-128. Addresses are the
# manuals' zero-based logical/PDU addresses. Keep CMI bit 9 clear so LFR/RFR
# use 0.1 Hz, and configure Fr1/Cd1 for embedded Modbus before control.

name = "Schneider Altivar 71"
vendor = "Schneider Electric"
device_type = "vfd"
verified = false
probe_register = 3201

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

[monitor]
status_word = { address = 3201, bits = { 0 = "READY_TO_SWITCH_ON", 1 = "SWITCHED_ON", 2 = "OPERATION_ENABLED", 3 = "FAULT", 4 = "VOLTAGE_ENABLED", 5 = "QUICK_STOP_N", 6 = "SWITCH_ON_DISABLED", 7 = "WARNING", 9 = "REMOTE", 10 = "TARGET_REACHED", 11 = "INTERNAL_LIMIT", 14 = "STOP_KEY", 15 = "REVERSE" } }
output_frequency = { address = 3202, signed = true, scale = 0.1, unit = "Hz" }
motor_current = { address = 3204, scale = 0.1, unit = "A" }
motor_torque = { address = 3205, signed = true, scale = 0.001, unit = "rated torque" }
mains_voltage = { address = 3207, scale = 0.1, unit = "V" }
motor_voltage = { address = 3208, unit = "V" }
motor_power = { address = 3211, signed = true, unit = "%" }

[control]
command_register = 8501
speed_register = 8502
speed_scale = 0.1
speed_unit = "Hz"
max_ref = 500.0
step_delay = 0.05
stop = [0x0006]
run_fwd = [0x0006, 0x0007, 0x000F]
run_rev = [0x0006, 0x0007, 0x080F]
reset = [0x0000, 0x0080, 0x0006]

[[control.preconditions]]
register = 8504
mask = 0x0200
expected = 0
message = "CMI bit 9 must be clear so LFR/RFR use the documented 0.1 Hz scale"

[control.watchdog]
interval_ms = 50
fault = "SLF1 Modbus communication fault"

[running_check]
register = 3201
bit = 2

[direction_check]
register = 3201
bit = 15
reverse_when_set = true

[faults]
register = 7121
history = [7200, 7201, 7202, 7203, 7204, 7205, 7206, 7207, 7208]

[faults.codes]
0 = "nOF no fault"
1 = "InF calibration error"
2 = "EEF1 control-card memory fault"
3 = "CFF incorrect configuration"
4 = "CFI invalid configuration"
5 = "SLF1 Modbus communication interruption"
6 = "ILF option-module internal-link interruption"
7 = "CnF communication-card interruption"
8 = "EPF1 external fault"
9 = "OCF overcurrent"
10 = "CrF1 precharge fault"
11 = "SPF encoder feedback loss"
12 = "AnF load slipping"
13 = "LFF2 AI2 4-20 mA loss"
14 = "PtF1 PTC1 probe open/short"
15 = "OtF1 PTC1 overtemperature"
16 = "OHF drive overtemperature"
17 = "OLF motor overload"
18 = "ObF DC bus overvoltage"
19 = "OSF mains overvoltage"
20 = "OPF1 single output phase loss"
21 = "PHF input phase loss"
22 = "USF undervoltage"
23 = "SCF1 motor short circuit"
24 = "SOF overspeed"
25 = "tnF autotuning fault"
26 = "InF1 rating error"
27 = "InF2 incompatible power board"
28 = "InF3 internal serial-link error"
29 = "InF4 manufacturing-data error"
30 = "EEF2 power-board memory fault"
31 = "SCF2 impedance short circuit"
32 = "SCF3 ground short circuit"
33 = "OPF2 three output phases lost"
34 = "COF CANopen interruption"
35 = "bLF brake control fault"
37 = "InF7 incomplete initialization"
38 = "EPF2 fieldbus external fault"
39 = "APF Controller Inside fault"
40 = "InF8 control supply fault"
41 = "brF brake feedback fault"
42 = "SLF2 PC communication interruption"
43 = "ECF encoder coupling fault"
44 = "SSF torque/current limitation"
45 = "SLF3 HMI communication interruption"
46 = "PrF power-removal safety fault"
47 = "PtF2 PTC2 probe open/short"
48 = "OtF2 PTC2 overtemperature"
49 = "PtFL LI6 PTC probe open/short"
50 = "OtFL LI6 PTC overtemperature"
51 = "InF9 current-measurement fault"
52 = "InFA input-stage fault"
53 = "InFb thermal-sensor fault"
54 = "tJF IGBT overtemperature"
55 = "SCF4 IGBT short circuit"
56 = "SCF5 motor short circuit"
57 = "SrF torque timeout"
58 = "FCF1 output contactor stuck closed"
59 = "FCF2 output contactor stuck open"
60 = "InFC time-measurement fault"
61 = "AI2F invalid AI2 signal"
62 = "EnF encoder fault"
63 = "CrF2 DC-bus thyristor charge fault"
64 = "LCF input contactor fault"
65 = "bUF braking-unit short circuit"
66 = "dCF differential-current fault"
67 = "HdF IGBT desaturation"
68 = "InF6 unrecognized option"
69 = "InFE internal CPU fault"
70 = "bOF braking-resistor overload"
71 = "LFF3 AI3 4-20 mA loss"
72 = "LFF4 AI4 4-20 mA loss"
73 = "HCF card-pairing fault"
76 = "dLF dynamic-load fault"
99 = "CSF channel-switching fault"

[connection]
summary = "Connect to the ATV71 embedded Modbus interface; no fieldbus option card is required for the documented serial path."
warnings = ["Lock out the drive/starter before opening covers or moving switches.", "Keep communications cable at least 30 cm from line and motor wiring.", "Prove read-only communication with the motor inhibited before enabling network control."]

[[connection.methods]]
id = "network_rs485"
title = "Integrated Modbus network port"
transport = "serial"
hardware = "built_in"
port = "Control-terminal Modbus network RJ45"
connector = "RJ45; pin 4 D1, pin 5 D0, pin 8 Common; pin 7 is vendor peripheral power"
adapter = "Isolated USB-to-RS-485 adapter"
cable = "VW3A8306D30 RJ45-to-stripped Modbus lead or equivalently pinned shielded twisted-pair cable"
parts = ["Isolated USB-to-RS-485 adapter", "Shielded twisted pair plus common conductor", "End termination for a multidrop bus"]
steps = ["Lock out the equipment and verify it is de-energized.", "Locate Control-terminal Modbus network RJ45.", "Wire D1, D0 and Common exactly as shown below; leave the peripheral-power pin unused.", "Route the communications cable at least 30 cm from power conductors and terminate only the two physical ends.", "Restore control power with the motor inhibited and verify a read before enabling control."]
setup = ["Configure Fr1/Cd1 for integrated Modbus.", "Match 19200 baud, 8-E-1.", "Keep CMI bit 9 clear and configure timeout/freewheel response."]
warnings = ["Do not connect adapter power to the vendor peripheral-power pin.", "Connect only the documented data and Common conductors."]
source = "Schneider 1755863.03 (11/2010), pp. 6-11 and 15-22."

[[connection.methods.wiring]]
adapter = "D1 / B / +"
device = "RJ45 pin 4 — D1"
signal = "RS-485 D1"

[[connection.methods.wiring]]
adapter = "D0 / A / -"
device = "RJ45 pin 5 — D0"
signal = "RS-485 D0"

[[connection.methods.wiring]]
adapter = "COM / signal common"
device = "RJ45 pin 8 — Common"
signal = "Signal reference"

[[connection.methods]]
id = "hmi_rs485"
title = "Front-panel Modbus HMI port"
transport = "serial"
hardware = "built_in"
port = "Front-panel Modbus HMI RJ45"
connector = "RJ45; pin 4 D1, pin 5 D0, pin 8 Common; pins 1-3 are not connected on this HMI port"
adapter = "Isolated USB-to-RS-485 adapter"
cable = "VW3A8306D30 RJ45-to-stripped Modbus lead or equivalently pinned shielded twisted-pair cable"
parts = ["Isolated USB-to-RS-485 adapter", "Shielded twisted pair plus common conductor", "End termination for a multidrop bus"]
steps = ["Lock out the equipment and verify it is de-energized.", "Locate Front-panel Modbus HMI RJ45.", "Wire D1, D0 and Common exactly as shown below; leave the peripheral-power pin unused.", "Route the communications cable at least 30 cm from power conductors and terminate only the two physical ends.", "Restore control power with the motor inhibited and verify a read before enabling control."]
setup = ["Configure Fr1/Cd1 for integrated Modbus.", "Match 19200 baud, 8-E-1.", "Keep CMI bit 9 clear and configure timeout/freewheel response."]
warnings = ["Do not connect adapter power to the vendor peripheral-power pin.", "Connect only the documented data and Common conductors."]
source = "Schneider 1755863.03 (11/2010), pp. 6-11 and 15-22."

[[connection.methods.wiring]]
adapter = "D1 / B / +"
device = "RJ45 pin 4 — D1"
signal = "RS-485 D1"

[[connection.methods.wiring]]
adapter = "D0 / A / -"
device = "RJ45 pin 5 — D0"
signal = "RS-485 D0"

[[connection.methods.wiring]]
adapter = "COM / signal common"
device = "RJ45 pin 8 — Common"
signal = "Signal reference"