Lucon SDK 1.0.7
Loading...
Searching...
No Matches
lucon_channel.h File Reference

functions to manage connections to Lucon channels (also known as power modules) More...

#include <stdint.h>
#include <stdbool.h>
#include "lucon_base.h"

Go to the source code of this file.

Functions

LuconHandle LUCON_NewChannel (LuconHandle conn, const unsigned char channelNr)
 creates a new LuconHandle referring to a Lucon channel
LuconResult LUCON_ChannelFactoryReset (LuconHandle channel)
 Reset all channel settings to their factory defaults.
LuconResult LUCON_ChannelSavePermanently (LuconHandle channel, int32_t restart)
 Save the current settings on the hardware.
LuconResult LUCON_ChannelRestart (LuconHandle channel)
 Restart a power module.
LuconResult LUCON_ChannelGetDesiredContinuousCurrent (LuconHandle channel, float *result)
 Read the currently set desired current of continuous mode / mA.
LuconResult LUCON_ChannelGetActualContinuousCurrent (LuconHandle channel, float *result)
 Read the actual output current at the moment / mA.
LuconResult LUCON_ChannelGetVoltageOverLight (LuconHandle channel, int32_t *result)
 Read the actual output voltage at the moment / mV.
LuconResult LUCON_ChannelGetLastPulseVoltage (LuconHandle channel, int32_t *result)
 Read the voltage of the last output pulse / mV.
LuconResult LUCON_ChannelGetLastPulseCurrent (LuconHandle channel, float *result)
 Read the current of the last output pulse / mA.
LuconResult LUCON_ChannelGetDesiredPulseCurrent (LuconHandle channel, float *result)
 Read the desired output current for pulse mode / mA.
LuconResult LUCON_ChannelGetDesiredSwitchCurrent (LuconHandle channel, float *result)
 Get the desired output current for switch mode / mA.
LuconResult LUCON_ChannelGetCurrentLimit (LuconHandle channel, int32_t *result)
 Read the output current limit / mA.
LuconResult LUCON_ChannelGetVoltageLimit (LuconHandle channel, int32_t *result)
 Read the output voltage limit / mV.
LuconResult LUCON_ChannelGetMode (LuconHandle channel, LuconChannelMode *result)
 Read the active output mode of the channel.
LuconResult LUCON_ChannelGetOutputTriggerParams (LuconHandle channel, struct LuconOutputTriggerParams *result)
 Read the active parameters of the channels trigger output.
LuconResult LUCON_ChannelSetOutputTriggerParams (LuconHandle channel, const struct LuconOutputTriggerParams *const value)
 Set the parameters for a channels trigger output.
LuconResult LUCON_ChannelSetCurrentLimit (LuconHandle channel, const int64_t value)
 Set the maximum output current limit for all modes / mA.
LuconResult LUCON_ChannelSetVoltageLimit (LuconHandle channel, const int64_t value)
 Set the maximum output voltage limit applicable to all modes / mA.
LuconResult LUCON_ChannelGetSerialNumber (LuconHandle channel, char *strbuf, const size_t buf_len)
 Read the serial number of a channel (power module).
LuconResult LUCON_ChannelGetBootloaderVersion (LuconHandle channel, char *strbuf, const size_t buf_len)
 Get a channels bootloader firmaware version.
LuconResult LUCON_ChannelGetFirmwareVersion (LuconHandle channel, char *strbuf, const size_t buf_len)
 Read the firmware version of a channel.
LuconResult LUCON_ChannelGetTemperature (LuconHandle channel, int32_t *result)
 Read a measurement of the temperature of a channel / °C.
LuconResult LUCON_ChannelGetSupplyVoltage (LuconHandle channel, int32_t *result)
 Read a measurement of the channels supply voltage / mV.
LuconResult LUCON_ChannelGetNumber (LuconHandle channel, uint8_t *result)
 Get the channel number.
LuconResult LUCON_ChannelSetToIdle (LuconHandle channel)
 Set the output mode of the channel to LUCON_MODE_IDLE.
LuconResult LUCON_ChannelGetContinuousModeParams (LuconHandle channel, struct LuconContinuousModeParameters *const result)
 Read the active settings for mode LUCON_MODE_CONTINUOUS.
LuconResult LUCON_ChannelSetToContinuousMode (LuconHandle channel, const struct LuconContinuousModeParameters *const settings)
 Apply the given settings and set the output mode of the channel to LUCON_MODE_CONTINUOUS.
LuconResult LUCON_ChannelSetToSwitchMode (LuconHandle channel, const struct LuconSwitchModeParameters *const settings)
 Apply the given settings and set the output mode of the channel to LUCON_MODE_SWITCH.
LuconResult LUCON_ChannelGetSwitchModeParams (LuconHandle channel, struct LuconSwitchModeParameters *const result)
 Read the active settings for output mode LUCON_MODE_SWITCH.
LuconResult LUCON_ChannelSetToPulseMode (LuconHandle channel, const struct LuconPulseModeParameters *settings)
 Apply the settings to a channel and set its output to LUCON_MODE_PULSE.
LuconResult LUCON_ChannelGetPulseModeParams (LuconHandle channel, struct LuconPulseModeParameters *const result)
 Read the active settings for output mode LUCON_MODE_PULSE.
LuconResult LUCON_ChannelGetInfo (LuconHandle channel, char *const strbuf, const size_t buf_len)
 Write a zero-terminated C string with a description of a channel into the result buffer.

Detailed Description

functions to manage connections to Lucon channels (also known as power modules)