12.1. EtherCAT Overview¶
EtherCAT is a real-time Ethernet network protocol developed by Beckhoff Automation for communicating among multiple nodes. EtherCAT networks are formed using CAT5e cabling, where master and nodes can be directly wired together through RJ-45 ports, in a daisy chain configuration, without need for external networking switches.
Software generates master/slave configurations by loading a EtherCAT Slave Information (ESI) file. Magna-Power Electronics provides this ESI file (XML) to customers which contains identifying information, exposes functionality, and stores settings.
Magna-Power Electronics has implemented and tested the basic EtherCAT protocol and Ethernet over EtherCAT. Additional protocols over EtherCAT (e.g., CANopen over EtherCAT (CoE), File Access over EtherCAT) may work, but have not been tested, and therefore are not supported.
12.2. Physical Interface¶
Fig. 12.1 Rear interface¶
12.2.1. Ethernet Ports¶
The ALx Series has two RJ-45 Ethernet ports on the rear of the unit for EtherCAT communications, shown in Rear interface labeled ETHERCAT. Either port may be used, with the other port acting as a passthrough for other EtherCAT devices.
12.2.2. LED Codes¶
In the rear of the ALx Series is a communications interface with two exposed bi-color LEDs. The LED labeled RUN indicates status of the EtherCAT device and the one labeled ERR indicates EtherCAT communication errors, as shown in Rear interface. Status is indicated using colors and blink patterns, as shown in the tables below.
State |
Description |
|---|---|
Off |
No power or initializing |
Green |
Online, operational state |
Green, flashing |
Online, pre-operational state |
Green, 1 flash |
Online, safe-operational state |
Red |
Fatal error |
State |
Description |
|---|---|
Off |
No power or no error |
Red, flashing |
Invalid configuration |
Red, 1 flash |
Unsolicited state change |
Red, 2 flashes |
Sync manager watchdog timeout |
Red |
Application controller failure |
The RJ-45 Ethernet port has one LED that indicates the status of the Ethernet connection. Link and activity status is indicated using and blink patterns, as shown in the table below.
State |
Description |
|---|---|
Off |
No link |
Green |
Link sensed, no activity detected |
Green, flashing |
Link sensed, activity detected |
12.3. Data Objects¶
12.3.1. Process Data Objects (PDOs)¶
PDOs are real-time data frequently sent to and from connected Magna-Power Electronics devices. When describing PDO traffic, it is referenced with respect to the EtherCAT slave device. For example, Transmit PDOs (TxPDO) are transmitted from the slave and are read-only, while Receive PDOs (RxPDO) transmits variables to the slave and have write access. Measurement reads would be mapped in the TxPDO Mapping, whereas set points would be in the RxPDO Mapping.
12.3.2. Service Data Objects (SDOs)¶
SDOs are messages sent on request and have no timing expectations. SDOs are intended for non-real-time communications, as they must wait for the network to respond, and are typically used for reporting status, changing operating modes, and etc. RxSDOs variables should not be used to update values already part of a PDO, as they are updated regularly, and the values would be overwritten by the RxPDO.
12.4. EtherCAT State Machine¶
The master controls slaves by following the EtherCAT state machine. Slaves can transition between four states: Init, Pre-Operational, Safe-Operational, Operational. In each state configuration checks are made and types of communications opened. The transition between states are diagramed in EtherCAT state machine. Allowed communications in each is described in Allowed protocols for each state. Devices enter the Init when first switched-on and reaches Operational under normal conditions
Fig. 12.2 EtherCAT state machine¶
State |
RxSDO/TxSDO |
TxPDO |
RxPDO |
|---|---|---|---|
Init |
|||
Pre-Operational |
✓ |
||
Safe-Operational |
✓ |
✓ |
|
Operational |
✓ |
✓ |
✓ |
12.5. Development using TwinCAT¶
Communication was tested with Magna-Power Electronics devices using software called TwinCAT 3 (version 3.1), which enables a personal computer to communicate over EtherCAT and act as a PLC master. Software is available for download on the Beckhoff Automation website using the link.
A dedicated EtherCAT network is needed, segregated from the local TCP/IP network, as the two protocols are not compatible. In the examples, a separate network interface card (NIC) was installed just for EtherCAT communications. Specifically, an INTEL 8255x based NIC, as recommended by Beckhoff for real-time communications and compatibility with TwinCAT 3 software.
After installing the NIC and TwinCAT 3 follow the Windows driver installation guide on the Beckhoff website so that NIC is treated as a TwinCAT network adapter.
12.5.1. Project Configuration¶
A project file stores connection settings for each EtherCAT device which helps with application development for multi-device networks. The following steps walks through creating a project — the same used in the examples section.
Open the TwinCAT XAE Shell (TcXaeShell) application and create a new project by clicking File > New > Project and select TwinCAT XAE Project (XML format).
Download the Magna-Power Electronics ESI file below, save to the TwinCAT installation directory (default is C:/TwinCAT/3.1/Config/Io/EtherCAT).
Magna-Power Electronics ESI File
The Restart TwinCAT (Config Mode), Toggle Free Run State, and Show Online Data buttons should all be pressed, as shown in Fig. 12.3.
Fig. 12.3 Project running configuration¶
Navigate from the top to TwinCAT > Show Realtime Ethernet Compatible Devices. There are three possible scenarios:
If a TwinCAT adapter was already installed, it will appear under Installed and ready to use devices(realtime capable) tree. No additional setup is needed, as shown.
If a TwinCAT adapter is available but not installed, it will appear under Compatible devices tree. Select the desired network adapter and press the Install button, which makes it appear in Installed and ready to use devices(realtime capable) tree.
If a TwinCAT adapter is unavailable the Compatible devices tree will be empty, which indicates computer was unable to detect a compatible NIC.
Fig. 12.4 Adapter installation¶
In the Solution Explorer panel expand the I/O in the project tree. Right click on Devices and select Add New Item.
Fig. 12.5 Add new device¶
In the Insert Device window, select EtherCAT Master.
Under the devices tree Device 1 (EtherCAT) should be visible. Right click on the device and select Scan. If the Magna-Power Electronics device is found, called Box 1 (Anybus CompactCom 40 EtherCAT) will be added as a BLANK to Device
Verify device configuration by double clicking on Box 1 and selecting the Online tab. If successful, the field labeled Current State will show OP, indicating the Operational state.
Fig. 12.6 Operation status online tab¶
12.5.2. PDO Communication¶
TcXaeShell provides a couple options for reading PDOs
In Box 1 - Transmit PDO Mapping, PDO variables are listed. Select a variable and open to the Online tab to see that variable plotted in time.
Fig. 12.7 Graphing of a PDO varaible¶
Selecting Box 1 a list all PDOs are presented. Note that WcState, InputToggle, State, and AdsAddr are TwinCAT specific variables and can be ignored.
Fig. 12.8 PDO variable listing¶
TcXaeShell provides a couple options for writing PDOs
In Solution Explorer click the desired variable in Box 1 - Receive PDO Mapping and open the Variable tab.
The same can be accomplished by right clicking on the variable and selecting Online tab and the Write button, which also graphs the value over time.
Fig. 12.9 Writing PDO from the Online tab¶
The Set Value Dialog provides entry using multiple number formats. On change, all the fields will update such that numbers are equivalent. Write value dialog shows equivalent fields for a Float value of 3.7588999. Based what the PDO/SDO variable represents, users may elect to use integer number formats (Dec, Hex, or Binary) instead. Note that byte ordering is swapped for Hex versus Binary.
Fig. 12.10 Write value dialog¶
12.5.3. SDO Communication¶
SDO variables are listed in Box 1 and accessed by entering the CoE - Online tab. The variables listed in table form are extensive and some time is needed for them to load. To write to an SDO, double click on a variable in the table to open the Set Value Dialog window. Only variables with Flags RW (read/write) can be written to. Variables that are RO (read-only) or a PDO cannot be written to.
Fig. 12.11 SDO CoE - Online tab¶
12.6. Standard Object Dictionary¶
The physical interface to an EtherCAT network is performed with an industrial communication module installed internal to the ALx Series. The module supports CANopen over EtherCAT and complies with draft specification of CiA 301. The specification calls for services and standard data object implementations outlined in the reference material below. The data objects reside in allocated address space shown in Data object dictionary
Network Interface Appendix Anybus CompactCom EtherCAT Doc.Id. HMSI-168-65
Index |
Object |
|---|---|
0x0000 |
Not used |
0x0001-0x001F |
Static data types |
0x0020-0x003F |
Complex data types |
0x0040-0x005F |
Manufacturer specific complex data types |
0x0060-0x007F |
Device Profile specific static data types |
0x0080-0x009F |
Device Profile specific complex data types |
0x00A0-0x0FFF |
Reserved for further use |
0x1000-0x1FFF |
Communication profile area |
0x2000-0x5FFF |
Manufacturer specific profile area |
0x6000-0x9FFF |
Standardised device profile area |
0xA000-0xBFFF |
Standardised interface profile area |
0xC000-0xFFFF |
Reserved for further use |
12.7. Manufacturer Specific Instances Listing¶
ECAT Command |
Write Index |
Read Index |
Description |
|---|---|---|---|
Operation Commands |
|||
N/A |
0x200B |
Returns the value of the Questionable Status register |
|
N/A |
0x200C |
Returns the value of the Operation Status register |
|
N/A |
0x200D |
Status Register |
|
0x2011 |
0x2012 |
Enables or disables the DC input based on parameter setting |
|
Measurement Commands |
|||
N/A |
0x2101 |
Measures and returns the average current at the sense location |
|
N/A |
0x2102 |
Measures and returns the average voltage at the sense location |
|
N/A |
0x2103 |
Measures and returns the instantaneous DC power at sense location |
|
N/A |
0x2104 |
Measures and returns the instantaneous resistance at sense location |
|
Setpoint Commands |
|||
0x2201 |
0x2202 |
Sets the current set-point |
|
0x2203 |
0x2204 |
Sets the voltage set-point |
|
0x2205 |
0x2206 |
Sets the power set-point |
|
0x2207 |
0x2208 |
Sets the resistance set-point |
|
Trip Commands |
|||
0x2301 |
0x2302 |
Sets the over current trip (OCT) set-point |
|
0x2303 |
0x2304 |
Sets the over voltage trip (OVT) set-point |
|
0x2305 |
0x2306 |
Sets the over power trip (OPT) set-point |
|
0x2307 |
0x2308 |
Sets the under voltage trip (UVT) set-point |
|
Slew Commands |
|||
0x2401 |
0x2402 |
Sets the rising slew rate for current when in current regulation state |
|
0x2403 |
0x2404 |
Sets the rising slew rate for voltage when in voltage regulation state |
|
0x2405 |
0x2406 |
Sets the rising slew rate for power when in power regulation state |
|
0x2407 |
0x2408 |
Sets the rising slew rate for resistance when in resistance regulation state |
|
0x2409 |
0x240A |
Sets the falling slew rate for current when in current regulation state |
|
0x240B |
0x240C |
Sets the falling slew rate for voltage when in voltage regulation state |
|
0x240D |
0x240E |
Sets the falling slew rate for power when in power regulation |
|
0x240F |
0x2410 |
Sets the falling slew rate for resistance when in resistance regulation state |
|
Control Commands |
|||
0x2503 |
0x2504 |
Sets the control mode |
|
Function Generator Commands |
|||
0x2601 |
0x2602 |
Sets the desired function for the integrated function generator |
|
0x2603 |
0x2604 |
Sets the amplitude for the sinusoid function |
|
0x2605 |
0x2606 |
Sets the DC offset from zero for the sinusoid function’s midline |
|
0x2607 |
0x2608 |
Sets the period for the sinusoid function |
|
0x2609 |
0x260A |
Sets the low level amplitude for the square function |
|
0x260B |
0x260C |
Sets the high level amplitude for the square function |
|
0x260D |
0x260E |
Sets the period that the square function remains at the low level amplitude |
|
0x260F |
0x2610 |
Sets the period that the square function remains at the high level amplitude |
|
0x2611 |
0x2612 |
Sets the low level amplitude for the step function |
|
0x2613 |
0x2614 |
Sets the high level amplitude for the step function |
|
0x2615 |
0x2616 |
Sets the low level amplitude for the ramp function |
|
0x2617 |
0x2618 |
Sets the high level amplitude for the ramp function |
|
0x2619 |
0x261A |
Sets the period for the ramp function to transition from low to high level amplitude |
|
0x261B |
0x261C |
Sets the period for the ramp function to transition from high to low level amplitude |
|
Configuration Commands |
|||
0x2701 |
N/A |
Restores the factory EEPROM data |
|
0x2703 |
0x2702 |
Locks and unlocks the product from configuration and set-point changes |
|
0x2706 |
0x2707 |
Configures the sense location and automated compensation values |
|
0x2708 |
0x2709 |
Changes the communication protocol |
|
0x270A |
0x270B |
Sets the setpoint source |
|
0x270C |
0x270D |
Changes the MagnaLINK mode to allow for standalone or master-slave configuration |
|
0x270E |
N/A |
Reinitialize all connected slaves |
|
0x270F |
0x2710 |
Sets the cooling mode |
12.8. Manufacturer Specific Process Data Objects¶
12.8.1. Operation Commands¶
12.8.2. StatusRegQ¶
This command queries the Status Register. This read-only register holds the live (unlatched) operation status of the MagnaLOAD electronic load. Issuing a query does not clear the register. The register location and definitions are subject to change after any firmware release to accommodate new features. The Questionable Register is a subset of the status register and does not change between firmware updates. The present bit assignments are shown in the table below.
- Access
RO
- Data Format
32-bit Integer
Status Register 0
Bit |
Name |
Description |
|---|---|---|
0 |
standby |
output is in standby |
1 |
live |
output is active |
2 |
solenoidStatus |
aux power solenoid is open |
3 |
nonhalt2 |
available |
4 |
overCurrTrip |
over current trip |
5 |
overVoltTrip |
over voltage trip |
6 |
overPwrTrip |
over power trip |
7 |
remoteSenseLoss |
remote sense voltage outside of acceptable bounds |
8 |
underVoltTrip |
under voltage trip |
9 |
shutdown |
target is creating a shutdown condition |
10 |
linPwrLim |
power across linear modules exceed ratings |
11 |
resPwrLim |
power across resistors exceed ratings |
12 |
bootFailure |
one or multiple target did not boot up |
13 |
bootState |
one or more targets are waiting to boot |
14 |
phaseCurr |
rated phase current exceeded |
15 |
comm |
communications are corrupted |
16 |
overCurrProtect |
terminal current exceeded product rating |
17 |
overVoltProtect |
terminal voltage exceeded product rating |
18 |
tempRLin |
linear module exceeded temperature |
19 |
blownFuse |
fuse is blown on the auxiliary power supply |
20 |
interlock |
interlock open |
21 |
haltUserClear |
available |
22 |
maintenance |
maintenance |
23 |
tempDMod |
diode modules exceeded temperature |
24 |
incompatibleSysConfig |
incompatible system configuration |
25 |
stackOverflow |
exceeded firmware stack |
26 |
lineFault |
line fault analog/digital inputs |
27 |
tempRMod |
resistor module exceeded temperature |
28 |
belowRatedMinVolt |
below minimum voltage rating(28) |
29 |
outOfRegulation |
out of regulation, unexpected currents measured |
30 |
targetUpgrade |
mainctrl upgrading other targets |
31 |
haltSelfClear |
available |
Status Register 1
Bit |
Name |
Description |
|---|---|---|
0 |
phaseLoss |
one or more phase missing |
1 |
blownFuseInput |
input fuse blown on fuse/emi filter |
2 |
fanLockedRotor |
one or more fan’s rotor has locked |
3 |
notUsed29 |
available |
4 |
tempPwrMod |
power processing module temperature fault |
5 |
tempOutputMod |
output filter module temperature fault |
6 |
tempOutputCap |
output capacitors temperature fault |
7 |
tempTransformer |
transformer exceeded temperature fault |
8 |
notUsed26 |
available |
9 |
notUsed27 |
available |
10 |
notUsed28 |
available |
11 |
notUsed1 |
available |
12 |
notUsed2 |
available |
13 |
notUsed3 |
available |
14 |
notUsed4 |
available |
15 |
notUsed5 |
available |
16 |
invalidSysRating |
invalid system rating |
17 |
fwVersConflict |
firmware version conflict |
18 |
notUsed8 |
available |
19 |
notUsed9 |
available |
20 |
notUsed10 |
available |
21 |
notUsed11 |
available |
22 |
notUsed12 |
available |
23 |
notUsed13 |
available |
24 |
notUsed14 |
available |
25 |
notUsed15 |
available |
26 |
notUsed16 |
available |
27 |
notUsed17 |
available |
28 |
notUsed18 |
available |
29 |
notUsed19 |
available |
30 |
notUsed20 |
available |
31 |
notUsed21 |
available |
12.8.3. Measurement Commands¶
12.8.4. MeasCurrQ¶
This query commands the MagnaLOAD electronic load to measure and return the average current through the DC terminals.
- Access
RO
- Data Format
32-bit Floating Point Number
12.8.5. MeasVoltQ¶
This query commands commands the MagnaLOAD electronic load to measure and return the average voltage at the DC terminals. If the remote sense function is used and engaged, this command returns the voltage measured at the sense terminals.
- Access
RO
- Data Format
32-bit Floating Point Number
12.8.6. Setpoint Commands¶
12.8.7. SetpointCurr¶
This command programs the current set-point that the MagnaLOAD electronic load will regulate to when operating in constant current mode.
- Access
RW
- Data Format
32-bit Floating Point Number
12.8.8. SetpointVolt¶
This command programs the voltage set-point, in volts, which the MagnaLOAD electronic load will regulate to when operating in constant voltage mode.
- Access
RW
- Data Format
32-bit Floating Point Number
12.9. Manufacturer Specific Service Data Objects¶
12.9.1. Operation Commands¶
12.9.1.1. StatusQuesQ¶
This command queries and returns the values of the Questionable Register. This read-only register holds the live (unlatched) questionable statuses of the MagnaLOAD electronic load. Issuing this query does not clear the register. The bit configuration of the Questionable Register is shown in the table below.
- Index
0x200B
- Access
RO
- Data Format
32-bit Integer
Questionable Register
Bit |
Weight |
Abbreviation |
Description |
|---|---|---|---|
0 |
1 |
OVP |
over voltage protection, hard fault |
1 |
2 |
OCT |
over current trip, soft fault |
2 |
4 |
OVT |
over voltage trip, soft fault |
3 |
8 |
OPT |
over power trip, soft fault |
4 |
16 |
OCP |
over current protection, hard fault |
5 |
32 |
OTP |
over temperature protection, hard fault |
6 |
64 |
RSL |
remote sense loss, soft fault |
7 |
128 |
SFLT |
soft fault, the ord value of all soft faults |
8 |
256 |
HFLT |
hard fault, the ord value of all hard faults |
9 |
512 |
ILOC |
interlock open, soft fault |
10 |
1024 |
IPL |
input power loss fault, hard fault |
11 |
2048 |
ADIF |
analog or digital input fault, hard fault |
12.9.1.2. StatusOperQ¶
This command queries and returns the values of the Operation Register. This read-only register holds the live (unlatched) operation statuses of the MagnaLOAD electronic load. Issuing this query does not clear the register. The bit configuration of the Operation Register is shown in the table below.
- Index
0x200C
- Access
RO
- Data Format
32-bit Integer
Operation Register
Bit |
Weight |
Abbreviation |
Description |
|---|---|---|---|
0 |
1 |
STBY |
standby |
1 |
2 |
EN |
enabled |
2 |
4 |
RSEN |
remote sense |
3 |
8 |
LOCK |
front panel locked |
4 |
16 |
CC |
constant current regulation, regulation status |
5 |
32 |
CV |
constant voltage regulation, regulation status |
6 |
64 |
CR |
constant resistance regulation, regulation status |
7 |
128 |
CP |
constant power regulation, regulation status |
12.9.1.3. StatusRegQ¶
This command queries the Status Register. This read-only register holds the live (unlatched) operation status of the MagnaLOAD electronic load. Issuing a query does not clear the register. The register location and definitions are subject to change after any firmware release to accommodate new features. The Questionable Register is a subset of the status register and does not change between firmware updates. The present bit assignments are shown in the table below.
- Index
0x200D
- Access
RO
- Data Format
32-bit Integer
Status Register 0
Bit |
Name |
Description |
|---|---|---|
0 |
standby |
output is in standby |
1 |
live |
output is active |
2 |
solenoidStatus |
aux power solenoid is open |
3 |
nonhalt2 |
available |
4 |
overCurrTrip |
over current trip |
5 |
overVoltTrip |
over voltage trip |
6 |
overPwrTrip |
over power trip |
7 |
remoteSenseLoss |
remote sense voltage outside of acceptable bounds |
8 |
underVoltTrip |
under voltage trip |
9 |
shutdown |
target is creating a shutdown condition |
10 |
linPwrLim |
power across linear modules exceed ratings |
11 |
resPwrLim |
power across resistors exceed ratings |
12 |
bootFailure |
one or multiple target did not boot up |
13 |
bootState |
one or more targets are waiting to boot |
14 |
phaseCurr |
rated phase current exceeded |
15 |
comm |
communications are corrupted |
16 |
overCurrProtect |
terminal current exceeded product rating |
17 |
overVoltProtect |
terminal voltage exceeded product rating |
18 |
tempRLin |
linear module exceeded temperature |
19 |
blownFuse |
fuse is blown on the auxiliary power supply |
20 |
interlock |
interlock open |
21 |
haltUserClear |
available |
22 |
maintenance |
maintenance |
23 |
tempDMod |
diode modules exceeded temperature |
24 |
incompatibleSysConfig |
incompatible system configuration |
25 |
stackOverflow |
exceeded firmware stack |
26 |
lineFault |
line fault analog/digital inputs |
27 |
tempRMod |
resistor module exceeded temperature |
28 |
belowRatedMinVolt |
below minimum voltage rating(28) |
29 |
outOfRegulation |
out of regulation, unexpected currents measured |
30 |
targetUpgrade |
mainctrl upgrading other targets |
31 |
haltSelfClear |
available |
Status Register 1
Bit |
Name |
Description |
|---|---|---|
0 |
phaseLoss |
one or more phase missing |
1 |
blownFuseInput |
input fuse blown on fuse/emi filter |
2 |
fanLockedRotor |
one or more fan’s rotor has locked |
3 |
notUsed29 |
available |
4 |
tempPwrMod |
power processing module temperature fault |
5 |
tempOutputMod |
output filter module temperature fault |
6 |
tempOutputCap |
output capacitors temperature fault |
7 |
tempTransformer |
transformer exceeded temperature fault |
8 |
notUsed26 |
available |
9 |
notUsed27 |
available |
10 |
notUsed28 |
available |
11 |
notUsed1 |
available |
12 |
notUsed2 |
available |
13 |
notUsed3 |
available |
14 |
notUsed4 |
available |
15 |
notUsed5 |
available |
16 |
invalidSysRating |
invalid system rating |
17 |
fwVersConflict |
firmware version conflict |
18 |
notUsed8 |
available |
19 |
notUsed9 |
available |
20 |
notUsed10 |
available |
21 |
notUsed11 |
available |
22 |
notUsed12 |
available |
23 |
notUsed13 |
available |
24 |
notUsed14 |
available |
25 |
notUsed15 |
available |
26 |
notUsed16 |
available |
27 |
notUsed17 |
available |
28 |
notUsed18 |
available |
29 |
notUsed19 |
available |
30 |
notUsed20 |
available |
31 |
notUsed21 |
available |
12.9.1.4. Input¶
This command enables or disables the MagnaLOAD electronic load input. The state of a disabled input is a high impedance condition.
- Index
0x2011
- Access
RW
- Data Format
Boolean
- Index
0x2012
- Access
RO
- Data Format
Boolean
12.9.2. Measurement Commands¶
12.9.2.1. MeasCurrQ¶
This query commands the MagnaLOAD electronic load to measure and return the average current through the DC terminals.
- Index
0x2101
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.2.2. MeasVoltQ¶
This query commands commands the MagnaLOAD electronic load to measure and return the average voltage at the DC terminals. If the remote sense function is used and engaged, this command returns the voltage measured at the sense terminals.
- Index
0x2102
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.2.3. MeasPwrQ¶
This query commands commands the MagnaLOAD electronic load to measure and return the average power at the DC terminals.
- Index
0x2103
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.2.4. MeasResQ¶
This query commands commands the MagnaLOAD electronic load to measure and return the average power at the DC terminals.
- Index
0x2104
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.3. Setpoint Commands¶
12.9.3.1. SetpointCurr¶
This command programs the current set-point that the MagnaLOAD electronic load will regulate to when operating in constant current mode.
- Index
0x2201
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2202
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.3.2. SetpointVolt¶
This command programs the voltage set-point, in volts, which the MagnaLOAD electronic load will regulate to when operating in constant voltage mode.
- Index
0x2203
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2204
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.3.3. SetpointPwr¶
This command programs the power set-point, in watts, which the MagnaLOAD electronic load will regulate to when operating in constant power mode.
- Index
0x2205
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2206
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.3.4. SetpointRes¶
This command programs the resistance set-point, in ohms, which the MagnaLOAD electronic load will regulate to when operating in constant resistance mode.
- Index
0x2207
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2208
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.4. Trip Commands¶
12.9.4.1. OverTripCurr¶
This command programs the over current trip (OCT) set-point. If the input current exceeds the over current trip set-point for multiple samples, the input is disconnected and an OCT fault is indicated.
- Index
0x2301
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2302
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.4.2. OverTripVolt¶
This command programs the over voltage trip (OVT) set-point. If the input voltage exceeds the over voltage trip set-point for multiple samples, the input is disconnected and an OVT fault is indicated.
- Index
0x2303
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2304
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.4.3. OverTripPwr¶
This command programs the over power trip (OPT) set-point. If the input power exceeds the over power trip set-point for multiple sample, the input is disconnected and an OPT fault is indicated.
- Index
0x2305
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2306
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.4.4. UnderTripVolt¶
This command programs the under voltage trip (UVT) set-point. If the input voltage falls below the under voltage trip set-point for multiple samples, the input is disconnected and an UVT fault is indicated.
- Index
0x2307
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2308
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5. Slew Commands¶
12.9.5.1. RiseRampCurr¶
This command sets the current slew rate for increasing current transitions while in constant current regulation. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x2401
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2402
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.2. RiseRampVolt¶
This command sets the voltage slew rate for increasing voltage transitions while in constant voltage regulation. The units for voltage slew rate are volts per millisecond. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x2403
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2404
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.3. RiseRampPwr¶
This command sets the power slew rate for increasing power transitions while in constant power regulation. The units for power slew rate are watts per millisecond. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x2405
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2406
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.4. RiseRampRes¶
This command sets the resistance slew rate for increasing resistance transitions while in constant resistance regulation. The units for resistance slew rate are ohms per millisecond. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x2407
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2408
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.5. FallRampCurr¶
This command sets the current slew rate for decreasing current transitions while in constant current regulation. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x2409
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x240A
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.6. FallRampVolt¶
This command sets the voltage slew rate for decreasing voltage transitions while in constant voltage regulation. The units for voltage slew rate are volts per millisecond. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x240B
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x240C
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.7. FallRampPwr¶
This command sets the power slew rate for decreasing power transitions while in constant power regulation. The units for power slew rate are watts per millisecond. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x240D
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x240E
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.5.8. FallRampRes¶
This command sets the resistance slew rate for decreasing resistance transitions while in constant resistance regulation. The units for resistance slew rate are ohms per millisecond. MAXimum sets the slew to the fastest possible rate. MINimum sets the slew to the slowest rate. Slew rates less than the minimum value are set to MINimum. Slew rate settings less than the minimum value are set to MINimum. Slew rate settings greater than the maximum value are set to MAXimum.
- Index
0x240F
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2410
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.6. Control Commands¶
12.9.6.1. ControlMode¶
This command configures the MagnaLOAD electronic load’s control mode. Control Modes provides more information about the various options.
- Index
0x2503
- Access
RW
- Data Format
16-bit Integer
- Index
0x2504
- Access
RO
- Data Format
16-bit Integer
12.9.7. Function Generator Commands¶
12.9.7.1. FuncType¶
This command selects the desired function for the integrated function generator, which is active when the product’s set point source is set to function generator.
- Index
0x2601
- Access
RW
- Data Format
16-bit Integer
- Index
0x2602
- Access
RO
- Data Format
16-bit Integer
12.9.7.2. FuncSinAmpl¶
This command sets the amplitude (Adc) for the sinusoid function when the set point source is set to 1 (function generator) and the function type is set to 0 (sinusoid).
- Index
0x2603
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2604
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.3. FuncSinOff¶
This command sets the DC offset from zero (Adc) for the sinusoid function midline when the set point source is set to 1 (function generator) and the function type is set to 0 (sinusoid).
- Index
0x2605
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2606
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.4. FuncSinPrd¶
This command sets the period (milliseconds) for the sinusoid function when the set point source is set to 1 (function generator) and the function type is set to 0 (sinusoid). The sinusoid’s period is the length of one full cycle.
- Index
0x2607
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2608
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.5. FuncSquLoLevel¶
This command sets the low level amplitude for the square function when the set point source is set to 1 (function generator) and the function type is set to 1 (square).
- Index
0x2609
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x260A
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.6. FuncSquHiLevel¶
This command sets the high level amplitude for the square function when the set point source is set to 1 (function generator) and the function type is set to 1 (square).
- Index
0x260B
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x260C
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.7. FuncSquLoPrd¶
This command sets the period/duration (milliseconds) that the square function remains at the low level amplituide when the set point source is set to 1 (function generator) and the function type is set to 1 (square).
- Index
0x260D
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x260E
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.8. FuncSquHiPrd¶
This command sets the period/duration (milliseconds) that the square function remains at the low level amplituide when the set point source is set to 1 (function generator) and the function type is set to 1 (square).
- Index
0x260F
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2610
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.9. FuncStepLoLevel¶
This command sets the low level amplitude for the step function when the set point source is set to 1 (function generator) and the function type is set to 2 (step).
- Index
0x2611
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2612
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.10. FuncStepHiLevel¶
This command sets the high level amplitude for the step function when the set point source is set to 1 (function generator) and the function type is set to 2 (step).
- Index
0x2613
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2614
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.11. FuncRampLoLevel¶
This command sets the low level amplitude for the ramp function when the set point source is set to 1 (function generator) and the function type is set to 3 (ramp).
- Index
0x2615
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2616
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.12. FuncRampHiLevel¶
This command sets the high level amplitude for the ramp function when the set point source is set to 1 (function generator) and the function type is set to 3 (ramp).
- Index
0x2617
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x2618
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.13. FuncRampRisePrd¶
This command sets the period/duration (milliseconds) for the ramp function to transition from the low level amplitude to the high level amplitude when the set point source is set to 1 (function generator) and the function type is set to 3 (ramp).
- Index
0x2619
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x261A
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.7.14. FuncRampFallPrd¶
This command sets the period/duration (milliseconds) for the ramp function to transition from the high level amplitude to the low level amplitude when the set point source is set to 1 (function generator) and the function type is set to 3 (ramp).
- Index
0x261B
- Access
RW
- Data Format
32-bit Floating Point Number
- Index
0x261C
- Access
RO
- Data Format
32-bit Floating Point Number
12.9.8. Configuration Commands¶
12.9.8.1. FactoryRestore¶
This command performs a factory restore to default EPROM values. Both Soft Restore and Hard Restore are available through command parameters.
- Index
0x2701
- Access
RW
- Data Format
16-bit Integer
12.9.8.2. Lock¶
This command configures the MagnaLOAD electronic load’s lock state. While locked, the stop button is the only functional button on the front panel. See Lock for more details on how lock works and how behaves relative to other locking inputs (front panel and digital input).
- Index
0x2703
- Access
RW
- Data Format
Boolean
- Index
0x2702
- Access
RO
- Data Format
Boolean
12.9.8.3. SenseMode¶
This command configures where the MagnaLOAD electronic load senses voltage. The sense location also effects how power and resistance are calculated. Local sensing monitors the directly across the output terminals. Remote sensing, as described in Remote Sense Connection, measures across the terminal JS2. This external connection can be used to improve regulation at the point of load, as is needed for example, in compensating voltage drops caused by wire resistance.
- Index
0x2706
- Access
RW
- Data Format
16-bit Integer
- Index
0x2707
- Access
RO
- Data Format
16-bit Integer
12.9.8.4. CommProt¶
This command changes the command protocol of the MagnaLOAD electronic load.
- Index
0x2708
- Access
RW
- Data Format
16-bit Integer
- Index
0x2709
- Access
RO
- Data Format
16-bit Integer
12.9.8.5. SetSource¶
The command selects and routes different set points sources to the digital controller. Operation of this feature is described in Set Point Source. By default, the source is set to local (value 0), where set points originating from the front panel or communication interfaces are routed to the ALx Series digital control. When the source is set to function generator (value 1), set points are generated internally, by a periodic function generator block. When external analog input (value 3) is set, the voltage(s) applied to the rear connector are converted into set points.
- Index
0x270A
- Access
RW
- Data Format
16-bit Integer
- Index
0x270B
- Access
RO
- Data Format
16-bit Integer
12.9.8.6. MagnaLinkMode¶
This command changes the MagnaLINK mode to allow for standalone or master-slave configurations.
- Index
0x270C
- Access
RW
- Data Format
16-bit Integer
- Index
0x270D
- Access
RO
- Data Format
16-bit Integer
12.9.8.7. MagnaLinkReinit¶
This command should be used to reinitialize system ratings when a slave is added or removed from a master-slave configuration.
- Index
0x270E
- Access
RW
- Data Format
16-bit Integer
12.9.8.8. CoolingMode¶
This command configures the MagnaLOAD electronic load’s cooling mode. In Automatic Cooling mode (value 0), the cooling output is regulated automatically based on internal operating conditions. In Maximum Cooling mode (value 1), the cooling output is forced on at full capacity. When queried, the command returns two comma-separated values: the configured cooling mode followed by the current solenoid state (0 = OFF, 1 = ON) on water-cooled units, or 0 on air-cooled units.
- Index
0x270F
- Access
RW
- Data Format
16-bit Integer
- Index
0x2710
- Access
RO
- Data Format
16-bit Integer