Rail

API Documentation: [cpp] [python] [.NET] [CCA] [REST]

The Rail entity provides power control to connected devices on some modules. Check the module datasheet to determine if the module has this capability.

the Rail entity controls power provided to downstream devices, it has the ability to enable and disable power, can read voltage on the rail, and provides current consumption information on some modules. There are additional capabilities that certain modules provide which enhance basic power delivery through Kelvin sensing, or by bringing online separate power management functionality.

Certain modules may provide more than one power rail. These are independently controlled and can be accessed via the entity index.

---

Rail Control

The USB-C-Switch Pro provides a fixed 5V power output rail that can be enabled or disabled. The rail provides voltage and current monitoring capabilities for the external power output.

Rail Enable/Disable

The rail can be enabled or disabled using the following APIs:

stem.rail[0].setEnable() [cpp] [python] [.NET] [LabVIEW]

stem.rail[0].getEnable() [cpp] [python] [.NET] [LabVIEW]

Voltage and Current Monitoring

The rail provides real-time voltage and current measurements:

stem.rail[0].getVoltage(µV) [cpp] [python] [.NET] [LabVIEW]

stem.rail[0].getCurrent(µA) [cpp] [python] [.NET] [LabVIEW]

stem.rail[0].getPower(mW) [cpp] [python] [.NET] [LabVIEW]

where voltage is in microvolts (µV), current is in microamperes (µA), and power is in milliwatts (mW).

The USB-C-Switch Pro has one rail (index 0) that provides a fixed 5V output with monitoring capabilities.