basic type definitions
More...
#include <stdint.h>
#include <stdbool.h>
Go to the source code of this file.
|
|
#define | LUCON_EXPORTS __declspec(dllexport) |
| | Marks symbols exported by the library.
|
|
| typedef struct LuconObject * | LuconHandle |
| | LuconHandle A handle to an object within the Lucon SDK.
|
|
typedef void(* | LuconStringCallback) (const char *message, const LuconHandle caller) |
| | Signature of a callback function to receive strings.
|
|
typedef void(* | LuconVoidCallback) (const LuconHandle caller) |
| | Signature of a callback function to receive event notifications without any argument.
|
| typedef void(* | LuconHintCallback) (const char *, LuconHintLevel level, const LuconHandle caller) |
| | Signature of a callback function to receive hints from a Lucon module.
|
|
typedef struct LuconPulseModeParameters | LuconPulseModeParameters |
| | Parameters defining the output control of a channel in pulse mode.
|
|
typedef struct LuconContinuousModeParameters | LuconContinuousModeParameters |
| | Parameters for output control of a channel in continuous mode.
|
|
typedef struct LuconSwitchModeParameters | LuconSwitchModeParameters |
| | Parameters for output control of a channel in switch mdoe.
|
|
typedef struct LuconOutputTriggerParams | LuconOutputTriggerParams |
| | Parameters to control the trigger output of a channel.
|
|
| enum | LuconResult {
LUCON_OK = 1
, LUCON_ERROR = -1
, LUCON_ERR_INVALID_HANDLE = -2
, LUCON_ERR_INVALID_PARAMETER = -3
,
LUCON_ERR_BUFFER_TOO_SMALL = -4
, LUCON_ERR_DEVICE_ERROR = -5
, LUCON_ERR_NOT_CONNECTED = -101
, LUCON_ERR_UNEXPECTED_ANSWER = -201
,
LUCON_ERR_TIMEOUT_WAITING_FOR_ANSWER = -202
, LUCON_ERR_TIMEOUT_ACQUIRING_LOCK = -203
, LUCON_ERR_NO_CHANNEL_WITH_NUMBER = -300
} |
| | Inidcates the result of API calls. More...
|
| enum | LuconChannelMode {
LUCON_MODE_UNKNOWN = -1
, LUCON_MODE_IDLE = 0
, LUCON_MODE_CONTINUOUS =2
, LUCON_MODE_SWITCH =3
,
LUCON_MODE_PULSE =4
} |
| | The operating modes of a channel. More...
|
| enum | LuconHintLevel { LUCON_HINT_ERROR = 1
, LUCON_HINT_INFO = 2
, LUCON_HINT_DEBUG = 3
} |
| | The level or severity of a hint sent by a Lucon module. More...
|
| enum | LuconOutputTriggerPolarity { LUCON_OUTPUTTRIGGERPOLARITY_RISING_EDGE = 0
, LUCON_OUTPUTTRIGGERPOLARITY_FALLING_EDGE = 1
} |
| | A edge of an electrical signal (trigger signals) More...
|
| enum | LuconOutputTriggerType { LUCON_OUTPUTTRIGGERTYPE_TIMER_DEPENDENT = 0
, LUCON_OUTPUTTRIGGERTYPE_DEPENDING_ON_THE_LIGHTNING_OUTPUT = 1
} |
| | The type of the trigger. More...
|
| enum | LuconSwitchModePolarity { LUCON_SWITCHMODEPOLARITY_LOW_ACTIVE = 0
, LUCON_SWITCHMODEPOLARITY_HIGH_ACTIVE = 1
} |
| | The output polarity in switch mode. More...
|
| enum | LuconTriggerSource { LUCON_TRIGGERSOURCE_INPUT = 0
, LUCON_TRIGGERSOURCE_LIGHTING_OUTPUT = 1
} |
| | The source of a trigger signal. More...
|
| enum | LuconInputTriggerPolarity { LUCON_INPUTTRIGGERPOLARITY_FALLING_EDGE = 0
, LUCON_INPUTTRIGGERPOLARITY_RISING_EDGE = 1
, LUCON_INPUTTRIGGERPOLARITY_ANY_EDGE = 2
} |
| | The event of the trigger input signal. More...
|
◆ LuconChannelMode
The operating modes of a channel.
The mode defines the switching behavior of the channels output.
| Enumerator |
|---|
| LUCON_MODE_UNKNOWN | Not a valid mode. Only to be returned by API functions to indicate a unknwon or erroneous mode.
|
| LUCON_MODE_IDLE | In idle (none) mode, the output is always off.
|
| LUCON_MODE_CONTINUOUS | Continuous current (software) mode enables the output, applying a desired closed-loop-current.
|
| LUCON_MODE_SWITCH | In switch mode the output is enabled according to the trigger level.
|
| LUCON_MODE_PULSE | In pulse mode the output pulses are generated upon trigger-input events.
|
◆ LuconHintLevel
The level or severity of a hint sent by a Lucon module.
| Enumerator |
|---|
| LUCON_HINT_ERROR | Information about an error on the device.
|
| LUCON_HINT_INFO | General information.
|
| LUCON_HINT_DEBUG | Debug information.
|
◆ LuconInputTriggerPolarity
The event of the trigger input signal.
| Enumerator |
|---|
| LUCON_INPUTTRIGGERPOLARITY_FALLING_EDGE | The signal edge falling from high to low.
|
| LUCON_INPUTTRIGGERPOLARITY_RISING_EDGE | The signal edge rising from low to high.
|
| LUCON_INPUTTRIGGERPOLARITY_ANY_EDGE | Both signal edges: rising and falling.
|
◆ LuconOutputTriggerPolarity
A edge of an electrical signal (trigger signals)
| Enumerator |
|---|
| LUCON_OUTPUTTRIGGERPOLARITY_RISING_EDGE | Generate trigger output pulses starting with a rising edge.
|
| LUCON_OUTPUTTRIGGERPOLARITY_FALLING_EDGE | Generate trigger output pulses starting with a falling edge.
|
◆ LuconOutputTriggerType
The type of the trigger.
| Enumerator |
|---|
| LUCON_OUTPUTTRIGGERTYPE_TIMER_DEPENDENT | When the light is enabled the output can be set after a delay.
|
| LUCON_OUTPUTTRIGGERTYPE_DEPENDING_ON_THE_LIGHTNING_OUTPUT | dependent on the lighting output, i.e., light on = trigger on and light off = trigger off.
|
◆ LuconResult
Inidcates the result of API calls.
The result of the current threads latest call to an API function can be queried with LUCON_GetLastApiResult()
| Enumerator |
|---|
| LUCON_OK | The API call was successful.
|
| LUCON_ERROR | A unspecific error occured.
|
| LUCON_ERR_INVALID_HANDLE | A LuconHandle passed as an argument was invalid (either NULL or freed by a call to LUCON_FreeHandle )
|
| LUCON_ERR_INVALID_PARAMETER | One of the parameters passed to the API was invalid, e.g. out of range.
|
| LUCON_ERR_BUFFER_TOO_SMALL | An output value exceeded the size of the provided buffer.
|
| LUCON_ERR_DEVICE_ERROR | The Lucon answerd with an error.
|
| LUCON_ERR_NOT_CONNECTED | Communication failed because there is no connection.
|
| LUCON_ERR_UNEXPECTED_ANSWER | The host received a unexpected message instead a protocol compliant answer after its request.
|
| 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.
|
| LUCON_ERR_TIMEOUT_ACQUIRING_LOCK | The host did not process the command, because a critical section is occupied by another thread and timed out while entering it.
|
| LUCON_ERR_NO_CHANNEL_WITH_NUMBER | A channel with the requested channel number is not available.
|
◆ LuconSwitchModePolarity
The output polarity in switch mode.
| Enumerator |
|---|
| LUCON_SWITCHMODEPOLARITY_LOW_ACTIVE | The output is activated while the input signal is low.
|
| LUCON_SWITCHMODEPOLARITY_HIGH_ACTIVE | The output is activated while the input signal is high.
|
◆ LuconTriggerSource
The source of a trigger signal.
| Enumerator |
|---|
| LUCON_TRIGGERSOURCE_INPUT | The channels electrical trigger input.
|
| LUCON_TRIGGERSOURCE_LIGHTING_OUTPUT | The channels lighting output.
|