14#define LUCON_EXPORTS __declspec(dllexport)
void(* LuconHintCallback)(const char *, LuconHintLevel level, const LuconHandle caller)
Signature of a callback function to receive hints from a Lucon module.
Definition lucon_base.h:126
struct LuconObject * LuconHandle
LuconHandle A handle to an object within the Lucon SDK.
Definition lucon_base.h:110
void(* LuconVoidCallback)(const LuconHandle caller)
Signature of a callback function to receive event notifications without any argument.
Definition lucon_base.h:119
LuconSwitchModePolarity
The output polarity in switch mode.
Definition lucon_base.h:80
@ LUCON_SWITCHMODEPOLARITY_LOW_ACTIVE
The output is activated while the input signal is low.
Definition lucon_base.h:81
@ LUCON_SWITCHMODEPOLARITY_HIGH_ACTIVE
The output is activated while the input signal is high.
Definition lucon_base.h:82
LuconHintLevel
The level or severity of a hint sent by a Lucon module.
Definition lucon_base.h:55
@ LUCON_HINT_INFO
General information.
Definition lucon_base.h:57
@ LUCON_HINT_ERROR
Information about an error on the device.
Definition lucon_base.h:56
@ LUCON_HINT_DEBUG
Debug information.
Definition lucon_base.h:58
LuconTriggerSource
The source of a trigger signal.
Definition lucon_base.h:88
@ LUCON_TRIGGERSOURCE_LIGHTING_OUTPUT
The channels lighting output.
Definition lucon_base.h:90
@ LUCON_TRIGGERSOURCE_INPUT
The channels electrical trigger input.
Definition lucon_base.h:89
LuconOutputTriggerPolarity
A edge of an electrical signal (trigger signals)
Definition lucon_base.h:64
@ LUCON_OUTPUTTRIGGERPOLARITY_RISING_EDGE
Generate trigger output pulses starting with a rising edge.
Definition lucon_base.h:65
@ LUCON_OUTPUTTRIGGERPOLARITY_FALLING_EDGE
Generate trigger output pulses starting with a falling edge.
Definition lucon_base.h:66
LuconInputTriggerPolarity
The event of the trigger input signal.
Definition lucon_base.h:96
@ LUCON_INPUTTRIGGERPOLARITY_ANY_EDGE
Both signal edges: rising and falling.
Definition lucon_base.h:99
@ LUCON_INPUTTRIGGERPOLARITY_FALLING_EDGE
The signal edge falling from high to low.
Definition lucon_base.h:97
@ LUCON_INPUTTRIGGERPOLARITY_RISING_EDGE
The signal edge rising from low to high.
Definition lucon_base.h:98
LuconChannelMode
The operating modes of a channel.
Definition lucon_base.h:44
@ LUCON_MODE_SWITCH
In switch mode the output is enabled according to the trigger level.
Definition lucon_base.h:48
@ LUCON_MODE_PULSE
In pulse mode the output pulses are generated upon trigger-input events.
Definition lucon_base.h:49
@ LUCON_MODE_IDLE
In idle (none) mode, the output is always off.
Definition lucon_base.h:46
@ LUCON_MODE_CONTINUOUS
Continuous current (software) mode enables the output, applying a desired closed-loop-current.
Definition lucon_base.h:47
@ LUCON_MODE_UNKNOWN
Not a valid mode. Only to be returned by API functions to indicate a unknwon or erroneous mode.
Definition lucon_base.h:45
LuconResult
Inidcates the result of API calls.
Definition lucon_base.h:23
@ LUCON_ERR_TIMEOUT_WAITING_FOR_ANSWER
The host did not receive a valid answer to a request nor any error within the set protocol timeout.
Definition lucon_base.h:32
@ LUCON_ERR_TIMEOUT_ACQUIRING_LOCK
The host did not process the command, because a critical section is occupied by another thread and ti...
Definition lucon_base.h:33
@ LUCON_ERR_NO_CHANNEL_WITH_NUMBER
A channel with the requested channel number is not available.
Definition lucon_base.h:34
@ LUCON_ERR_UNEXPECTED_ANSWER
The host received a unexpected message instead a protocol compliant answer after its request.
Definition lucon_base.h:31
@ LUCON_ERR_NOT_CONNECTED
Communication failed because there is no connection.
Definition lucon_base.h:30
@ LUCON_ERR_INVALID_HANDLE
A LuconHandle passed as an argument was invalid (either NULL or freed by a call to LUCON_FreeHandle )
Definition lucon_base.h:26
@ LUCON_ERR_INVALID_PARAMETER
One of the parameters passed to the API was invalid, e.g. out of range.
Definition lucon_base.h:27
@ LUCON_ERR_BUFFER_TOO_SMALL
An output value exceeded the size of the provided buffer.
Definition lucon_base.h:28
@ LUCON_ERROR
A unspecific error occured.
Definition lucon_base.h:25
@ LUCON_ERR_DEVICE_ERROR
The Lucon answerd with an error.
Definition lucon_base.h:29
@ LUCON_OK
The API call was successful.
Definition lucon_base.h:24
LuconOutputTriggerType
The type of the trigger.
Definition lucon_base.h:72
@ LUCON_OUTPUTTRIGGERTYPE_TIMER_DEPENDENT
When the light is enabled the output can be set after a delay.
Definition lucon_base.h:73
@ LUCON_OUTPUTTRIGGERTYPE_DEPENDING_ON_THE_LIGHTNING_OUTPUT
dependent on the lighting output, i.e., light on = trigger on and light off = trigger off.
Definition lucon_base.h:74
void(* LuconStringCallback)(const char *message, const LuconHandle caller)
Signature of a callback function to receive strings.
Definition lucon_base.h:115
Parameters for output control of a channel in continuous mode.
Definition lucon_base.h:141
float CurrentInMilliAmpere
desired output control current / mA
Definition lucon_base.h:142
Parameters to control the trigger output of a channel.
Definition lucon_base.h:156
int32_t LuconOutputTriggerType
The type defining the output trigger type. The output trigger can either be dependent on a timer (del...
Definition lucon_base.h:160
int32_t TriggerLengthInMicroSeconds
Duration of the generated trigger-output pulse in microseconds.
Definition lucon_base.h:162
int32_t TriggerSource
The source signal used for generating output pulses.
Definition lucon_base.h:159
int32_t Enabled
Indicates, if the trigger output is enabled (0==disabled)
Definition lucon_base.h:157
int32_t OutputTriggerPolarity
The polarity of the generated output signal.
Definition lucon_base.h:158
int32_t DelayInMicroSeconds
The delay time before generating the output pulse following a TriggerSource signal in microseconds.
Definition lucon_base.h:161
Parameters defining the output control of a channel in pulse mode.
Definition lucon_base.h:131
int32_t InputTriggerPolarity
the LuconInputTriggerPolarity on which to generate a output pulse
Definition lucon_base.h:135
float CurrentInMilliAmpere
desired output control current / mA
Definition lucon_base.h:132
int32_t DelayInMicroseconds
time delay between a input trigger signal and output pulse generation / us
Definition lucon_base.h:133
int32_t LengthInMicroseconds
duration of the generated output pulses / us
Definition lucon_base.h:134
Parameters for output control of a channel in switch mdoe.
Definition lucon_base.h:148
int32_t SwitchModePolarity
The LuconSwitchModePolarity defining the output activity.
Definition lucon_base.h:150
float CurrentInMilliAmpere
Desired output control current / mA.
Definition lucon_base.h:149