Lucon SDK 1.0.7
Loading...
Searching...
No Matches
Gefasoft.LuconV2.Channel Class Reference

Implements IChannel by wrapping the Lucon C API. More...

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

Public Member Functions

void Restart ()
 Restart a power module.Upon restart, its settings will be initialized to the persisted settings. AnyEdge transient changes are discarded.
void FactoryReset ()
 Reset all channel settings to their factory defaults.
void 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.
void SetToIdle ()
 Set the output mode of the ChannelMode.Idle
ContinuousModeParameters GetContinuousModeParameters ()
 Read the active settings for mode ChannelMode.Continuous
Returns
The active settings.

void SetToContinuousMode (ContinuousModeParameters value)
 Apply the given settings and set the output mode to ChannelMode.Continuous
Parameters
valueThe settings to apply (required)

void SetToSwitchMode (SwitchModeParameters value)
 Apply the given settings and set the output mode to ChannelMode.Switch
Parameters
valueThe settings to apply (required)

SwitchModeParameters GetSwitchModeParameters ()
 Read the active settings for output mode ChannelMode.SwitchThe settings are read independent of the active mode.
void SetToPulseMode (PulseModeParameters value)
 Apply the given settings and set the output mode to ChannelMode.Pulse
Parameters
value

PulseModeParameters GetPulseModeParameters ()
 Read the active settings for output mode ChannelMode.PulseThe settings are read independent of the active mode.
string GetInfo ()
 Get a descriptive string of the channel.Attempts to read parameters from the device
Public Member Functions inherited from Gefasoft.LuconV2.Infrastructure.InteropObject
void Dispose ()
 Dispose the object and free all related resources.

Properties

int 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.
float 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.
float DesiredContinuousCurrent [get]
 Read the currently set desired current of continuous mode / mA.The present setting is read independent of the active ChannelMode
int LastPulseVoltage [get]
 Read the voltage of the last output pulse / mV.The measurement is updated by ChannelMode.Pulse and ChannelMode.Switch modes
float LastPulseCurrent [get]
 Read the current of the last output pulse / mA.The measurement is updated by ChannelMode.Pulse and ChannelMode.Switch modes
float DesiredPulseCurrent [get]
 Read the desired output current for pulse mode / mA.The setting is read independent of the current mode.
float DesiredSwitchCurrent [get]
 Get the desired output current for switch mode / mA.The setting is read independent of the current mode.
int CurrentLimit [get, set]
 Read/Write the output current limit / mA.The limit (maximum current) applies to all ChannelMode
int VoltageLimit [get, set]
 Read/Write the output voltage limit / mV.The limit (maximum current) applies to all ChannelMode.
ChannelMode Mode [get]
 Read the active output mode of the channel.
See also
SetToContinuousMode, SetToPulseMode, SetToSwitchMode, SetToIdle

OutputTriggerParams OutputTriggerParams [get, set]
 Read/Write the active parameters of the trigger output.
string SerialNumber [get]
 Read the serial number of the ChannelExample: "220100145".
string BootloaderVersion [get]
 Read the bootloader firmware version of the Channel.Example: "2.0".
string FirmwareVersion [get]
 Read the firmware version of the ChannelExample: "1.0.1".
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.Returns immediately without communication to the device.

Additional Inherited Members

Protected Member Functions inherited from Gefasoft.LuconV2.Infrastructure.InteropObject
virtual void Dispose (bool disposing)
 implements the standard pattern for IDisposable

Detailed Description

Implements IChannel by wrapping the Lucon C API.

Member Function Documentation

◆ FactoryReset()

void Gefasoft.LuconV2.Channel.FactoryReset ( )

Reset all channel settings to their factory defaults.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ GetContinuousModeParameters()

ContinuousModeParameters Gefasoft.LuconV2.Channel.GetContinuousModeParameters ( )

Read the active settings for mode ChannelMode.Continuous

Returns
The active settings.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ GetInfo()

string Gefasoft.LuconV2.Channel.GetInfo ( )

Get a descriptive string of the channel.Attempts to read parameters from the device

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ GetPulseModeParameters()

PulseModeParameters Gefasoft.LuconV2.Channel.GetPulseModeParameters ( )

Read the active settings for output mode ChannelMode.PulseThe settings are read independent of the active mode.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ GetSwitchModeParameters()

SwitchModeParameters Gefasoft.LuconV2.Channel.GetSwitchModeParameters ( )

Read the active settings for output mode ChannelMode.SwitchThe settings are read independent of the active mode.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ Restart()

void Gefasoft.LuconV2.Channel.Restart ( )

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

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SavePermanently()

void Gefasoft.LuconV2.Channel.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.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SetToContinuousMode()

void Gefasoft.LuconV2.Channel.SetToContinuousMode ( ContinuousModeParameters value)

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

Parameters
valueThe settings to apply (required)

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SetToIdle()

void Gefasoft.LuconV2.Channel.SetToIdle ( )

Set the output mode of the ChannelMode.Idle

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SetToPulseMode()

void Gefasoft.LuconV2.Channel.SetToPulseMode ( PulseModeParameters value)

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

Parameters
value

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SetToSwitchMode()

void Gefasoft.LuconV2.Channel.SetToSwitchMode ( SwitchModeParameters value)

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

Parameters
valueThe settings to apply (required)

Implements Gefasoft.LuconV2.Abstractions.IChannel.

Property Documentation

◆ ActualContinuousCurrent

float Gefasoft.LuconV2.Channel.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.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ BootloaderVersion

string Gefasoft.LuconV2.Channel.BootloaderVersion
get

Read the bootloader firmware version of the Channel.Example: "2.0".

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ CurrentLimit

int Gefasoft.LuconV2.Channel.CurrentLimit
getset

Read/Write the output current limit / mA.The limit (maximum current) applies to all ChannelMode

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ DesiredContinuousCurrent

float Gefasoft.LuconV2.Channel.DesiredContinuousCurrent
get

Read the currently set desired current of continuous mode / mA.The present setting is read independent of the active ChannelMode

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ DesiredPulseCurrent

float Gefasoft.LuconV2.Channel.DesiredPulseCurrent
get

Read the desired output current for pulse mode / mA.The setting is read independent of the current mode.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ DesiredSwitchCurrent

float Gefasoft.LuconV2.Channel.DesiredSwitchCurrent
get

Get the desired output current for switch mode / mA.The setting is read independent of the current mode.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ FirmwareVersion

string Gefasoft.LuconV2.Channel.FirmwareVersion
get

Read the firmware version of the ChannelExample: "1.0.1".

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ LastPulseCurrent

float Gefasoft.LuconV2.Channel.LastPulseCurrent
get

Read the current of the last output pulse / mA.The measurement is updated by ChannelMode.Pulse and ChannelMode.Switch modes

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ LastPulseVoltage

int Gefasoft.LuconV2.Channel.LastPulseVoltage
get

Read the voltage of the last output pulse / mV.The measurement is updated by ChannelMode.Pulse and ChannelMode.Switch modes

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ Mode

ChannelMode Gefasoft.LuconV2.Channel.Mode
get

Read the active output mode of the channel.

See also
SetToContinuousMode, SetToPulseMode, SetToSwitchMode, SetToIdle

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ Number

int Gefasoft.LuconV2.Channel.Number
get

Get the channel number.Returns immediately without communication to the device.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ OutputTriggerParams

OutputTriggerParams Gefasoft.LuconV2.Channel.OutputTriggerParams
getset

Read/Write the active parameters of the trigger output.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SerialNumber

string Gefasoft.LuconV2.Channel.SerialNumber
get

Read the serial number of the ChannelExample: "220100145".

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ SupplyVoltage

float Gefasoft.LuconV2.Channel.SupplyVoltage
get

Read a measurement of the channels supply voltage / mV.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ Temperature

int Gefasoft.LuconV2.Channel.Temperature
get

Read a measurement of the temperature / °C.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ VoltageLimit

int Gefasoft.LuconV2.Channel.VoltageLimit
getset

Read/Write the output voltage limit / mV.The limit (maximum current) applies to all ChannelMode.

Implements Gefasoft.LuconV2.Abstractions.IChannel.

◆ VoltageOverLight

int Gefasoft.LuconV2.Channel.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.

Implements Gefasoft.LuconV2.Abstractions.IChannel.


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