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

function to manage connections to Lucon light controllers More...

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

Go to the source code of this file.

Functions

LuconHandle LUCON_NewUdpConnection (const char *const raddr, uint16_t lport, const char *const laddr)
 New UDP connection.
LuconHandle LUCON_NewRs232Connection (const char *const name, uint32_t baudRate)
 New RS232 serial-port connection.
LuconHandle LUCON_NewFakeConnection ()
 Creates a new fake connection, which may be used for simulation / testing without real hardware.
LuconResult LUCON_ConnectionSetTimeouts (LuconHandle handle, uint32_t timeout)
 Set custom timeouts for awaiting answers from the device to sent commands. SetTimeouts works only while the connection is closed!
LuconResult LUCON_ConnectionSetHintCallback (LuconHandle handle, const LuconHintCallback callback)
 Set a function to be called, when a hint message is received from the Lucon device.
LuconResult LUCON_ConnectionSetReadCallback (LuconHandle handle, const LuconStringCallback callback)
 Set a callback function to be executed after the connection received data from the device.
LuconResult LUCON_ConnectionSetWriteCallback (LuconHandle handle, const LuconStringCallback callback)
 Set a callback function to be executed after data was sent over the connection given by handle.
LuconResult LUCON_ConnectionOpen (LuconHandle handle)
 Open the connection to the device. Once opened, the connection listens for incoming messages and may be used for communication.
LuconResult LUCON_ConnectionClose (LuconHandle handle)
 Close a opened connection.
LuconResult LUCON_ConnectionIsOpened (LuconHandle handle, int32_t *isOpened)
 Checks whether the connection is opened and ready for communication.
LuconResult LUCON_ConnectionSendCommand (LuconHandle handle, const char *const cstring, const char *strbuf, size_t buf_len)
 Send the given string over the connection and checks for a device response.
LuconResult LUCON_ConnectionGetInfo (LuconHandle handle, const char *result, size_t buf_len)
 Write a zero-terminated C string with a description of a connection into the result buffer.

Detailed Description

function to manage connections to Lucon light controllers