Lucon SDK 1.0.7
Loading...
Searching...
No Matches
Gefasoft.LuconV2.Abstractions.IChannel Interface Reference

Abstraction of a Lucon2 power module. More...

Inheritance diagram for Gefasoft.LuconV2.Abstractions.IChannel:
Gefasoft.LuconV2.Channel

Public Member Functions

void Restart ()
 Restart a power module.
void FactoryReset ()
 Reset all channel settings to their factory defaults.
void SavePermanently (bool restart)
 Save the current settings on the hardware.
void SetToIdle ()
 Set the output mode of the ChannelMode.Idle
ContinuousModeParameters GetContinuousModeParameters ()
 Read the active settings for mode ChannelMode.Continuous
void SetToContinuousMode (ContinuousModeParameters value)
 Apply the given settings and set the output mode to ChannelMode.Continuous
void SetToSwitchMode (SwitchModeParameters value)
 Apply the given settings and set the output mode to ChannelMode.Switch
SwitchModeParameters GetSwitchModeParameters ()
 Read the active settings for output mode ChannelMode.Switch
void SetToPulseMode (PulseModeParameters value)
 Apply the given settings and set the output mode to ChannelMode.Pulse
PulseModeParameters GetPulseModeParameters ()
 Read the active settings for output mode ChannelMode.Pulse
string GetInfo ()
 Get a descriptive string of the channel.

Properties

int VoltageOverLight [get]
 Read the actual output voltage at the moment / mV.
float ActualContinuousCurrent [get]
 Read the actual output current at the moment / mA.
float DesiredContinuousCurrent [get]
 Read the currently set desired current of continuous mode / mA.
int LastPulseVoltage [get]
 Read the voltage of the last output pulse / mV.
float LastPulseCurrent [get]
 Read the current of the last output pulse / mA.
float DesiredPulseCurrent [get]
 Read the desired output current for pulse mode / mA.
float DesiredSwitchCurrent [get]
 Get the desired output current for switch mode / mA.
int CurrentLimit [get, set]
 Read/Write the output current limit / mA.
int VoltageLimit [get, set]
 Read/Write the output voltage limit / mV.
string SerialNumber [get]
 Read the serial number of the Channel
string BootloaderVersion [get]
 Read the bootloader firmware version of the Channel.
string FirmwareVersion [get]
 Read the firmware version of the Channel
int Temperature [get]
 Read a measurement of the temperature / °C.
float SupplyVoltage [get]
 Read a measurement of the channels supply voltage / mV.
int Number [get]
 Get the channel number.
ChannelMode Mode [get]
 Read the active output mode of the channel.
OutputTriggerParams OutputTriggerParams [get, set]
 Read/Write the active parameters of the trigger output.

Detailed Description

Abstraction of a Lucon2 power module.

Member Function Documentation

◆ FactoryReset()

void Gefasoft.LuconV2.Abstractions.IChannel.FactoryReset ( )

Reset all channel settings to their factory defaults.

Implemented in Gefasoft.LuconV2.Channel.

◆ GetContinuousModeParameters()

ContinuousModeParameters Gefasoft.LuconV2.Abstractions.IChannel.GetContinuousModeParameters ( )

Read the active settings for mode ChannelMode.Continuous

Returns
The active settings.

Implemented in Gefasoft.LuconV2.Channel.

◆ GetInfo()

string Gefasoft.LuconV2.Abstractions.IChannel.GetInfo ( )

Get a descriptive string of the channel.

Attempts to read parameters from the device

Returns

Implemented in Gefasoft.LuconV2.Channel.

◆ GetPulseModeParameters()

PulseModeParameters Gefasoft.LuconV2.Abstractions.IChannel.GetPulseModeParameters ( )

Read the active settings for output mode ChannelMode.Pulse

The settings are read independent of the active mode.

Implemented in Gefasoft.LuconV2.Channel.

◆ GetSwitchModeParameters()

SwitchModeParameters Gefasoft.LuconV2.Abstractions.IChannel.GetSwitchModeParameters ( )

Read the active settings for output mode ChannelMode.Switch

The settings are read independent of the active mode.

Returns

Implemented in Gefasoft.LuconV2.Channel.

◆ Restart()

void Gefasoft.LuconV2.Abstractions.IChannel.Restart ( )

Restart a power module.

Upon restart, its settings will be initialized to the persisted settings. AnyEdge transient changes are discarded.

See also
SavePermanently

Implemented in Gefasoft.LuconV2.Channel.

◆ SavePermanently()

void Gefasoft.LuconV2.Abstractions.IChannel.SavePermanently ( bool restart)

Save the current settings on the hardware.

Persists the current settings on the channel hardware (power module). The persisted settings are used to initialize the module at any restart.

Parameters
restartIf true, the channel will be restarted after saving.

Implemented in Gefasoft.LuconV2.Channel.

◆ SetToContinuousMode()

void Gefasoft.LuconV2.Abstractions.IChannel.SetToContinuousMode ( ContinuousModeParameters value)

Apply the given settings and set the output mode to ChannelMode.Continuous

Parameters
valueThe settings to apply (required)

Implemented in Gefasoft.LuconV2.Channel.

◆ SetToIdle()

void Gefasoft.LuconV2.Abstractions.IChannel.SetToIdle ( )

Set the output mode of the ChannelMode.Idle

Implemented in Gefasoft.LuconV2.Channel.

◆ SetToPulseMode()

void Gefasoft.LuconV2.Abstractions.IChannel.SetToPulseMode ( PulseModeParameters value)

Apply the given settings and set the output mode to ChannelMode.Pulse

Parameters
value

Implemented in Gefasoft.LuconV2.Channel.

◆ SetToSwitchMode()

void Gefasoft.LuconV2.Abstractions.IChannel.SetToSwitchMode ( SwitchModeParameters value)

Apply the given settings and set the output mode to ChannelMode.Switch

Parameters
valueThe settings to apply (required)

Implemented in Gefasoft.LuconV2.Channel.

Property Documentation

◆ ActualContinuousCurrent

float Gefasoft.LuconV2.Abstractions.IChannel.ActualContinuousCurrent
get

Read the actual output current at the moment / mA.

The exact time of reading the value is unknown due to communication and processing delays.

Implemented in Gefasoft.LuconV2.Channel.

◆ BootloaderVersion

string Gefasoft.LuconV2.Abstractions.IChannel.BootloaderVersion
get

Read the bootloader firmware version of the Channel.

Example: "2.0".

Implemented in Gefasoft.LuconV2.Channel.

◆ CurrentLimit

int Gefasoft.LuconV2.Abstractions.IChannel.CurrentLimit
getset

Read/Write the output current limit / mA.

The limit (maximum current) applies to all ChannelMode

Implemented in Gefasoft.LuconV2.Channel.

◆ DesiredContinuousCurrent

float Gefasoft.LuconV2.Abstractions.IChannel.DesiredContinuousCurrent
get

Read the currently set desired current of continuous mode / mA.

The present setting is read independent of the active ChannelMode

Implemented in Gefasoft.LuconV2.Channel.

◆ DesiredPulseCurrent

float Gefasoft.LuconV2.Abstractions.IChannel.DesiredPulseCurrent
get

Read the desired output current for pulse mode / mA.

The setting is read independent of the current mode.

Implemented in Gefasoft.LuconV2.Channel.

◆ DesiredSwitchCurrent

float Gefasoft.LuconV2.Abstractions.IChannel.DesiredSwitchCurrent
get

Get the desired output current for switch mode / mA.

The setting is read independent of the current mode.

Implemented in Gefasoft.LuconV2.Channel.

◆ FirmwareVersion

string Gefasoft.LuconV2.Abstractions.IChannel.FirmwareVersion
get

Read the firmware version of the Channel

Example: "1.0.1".

Implemented in Gefasoft.LuconV2.Channel.

◆ LastPulseCurrent

float Gefasoft.LuconV2.Abstractions.IChannel.LastPulseCurrent
get

Read the current of the last output pulse / mA.

The measurement is updated by ChannelMode.Pulse and ChannelMode.Switch modes

Implemented in Gefasoft.LuconV2.Channel.

◆ LastPulseVoltage

int Gefasoft.LuconV2.Abstractions.IChannel.LastPulseVoltage
get

Read the voltage of the last output pulse / mV.

The measurement is updated by ChannelMode.Pulse and ChannelMode.Switch modes

Implemented in Gefasoft.LuconV2.Channel.

◆ Mode

ChannelMode Gefasoft.LuconV2.Abstractions.IChannel.Mode
get

Read the active output mode of the channel.

See also
SetToContinuousMode, SetToPulseMode, SetToSwitchMode, SetToIdle

Implemented in Gefasoft.LuconV2.Channel.

◆ Number

int Gefasoft.LuconV2.Abstractions.IChannel.Number
get

Get the channel number.

Returns immediately without communication to the device.

Implemented in Gefasoft.LuconV2.Channel.

◆ OutputTriggerParams

OutputTriggerParams Gefasoft.LuconV2.Abstractions.IChannel.OutputTriggerParams
getset

Read/Write the active parameters of the trigger output.

Implemented in Gefasoft.LuconV2.Channel.

◆ SerialNumber

string Gefasoft.LuconV2.Abstractions.IChannel.SerialNumber
get

Read the serial number of the Channel

Example: "220100145".

Implemented in Gefasoft.LuconV2.Channel.

◆ SupplyVoltage

float Gefasoft.LuconV2.Abstractions.IChannel.SupplyVoltage
get

Read a measurement of the channels supply voltage / mV.

Implemented in Gefasoft.LuconV2.Channel.

◆ Temperature

int Gefasoft.LuconV2.Abstractions.IChannel.Temperature
get

Read a measurement of the temperature / °C.

Implemented in Gefasoft.LuconV2.Channel.

◆ VoltageLimit

int Gefasoft.LuconV2.Abstractions.IChannel.VoltageLimit
getset

Read/Write the output voltage limit / mV.

The limit (maximum current) applies to all ChannelMode.

Implemented in Gefasoft.LuconV2.Channel.

◆ VoltageOverLight

int Gefasoft.LuconV2.Abstractions.IChannel.VoltageOverLight
get

Read the actual output voltage at the moment / mV.

The exact time of reading the value is unknown due to communication and processing delays.

Implemented in Gefasoft.LuconV2.Channel.


The documentation for this interface was generated from the following file: