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

functions for interacting with Lucon Communication modules More...

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

Go to the source code of this file.

Functions

LuconHandle LUCON_NewDevice (LuconHandle conn)
 creates a LuconHandle referring to a Lucon device
LuconResult LUCON_DeviceConnect (LuconHandle device)
 Start communicating with the device.
LuconResult LUCON_DeviceDisconnect (LuconHandle device)
 Stops communication and closes the connection to the device.
LuconResult LUCON_DeviceIsConnected (LuconHandle device, int32_t forceCheck, int32_t *const isConnected)
 Check connectivity of the device with the help of a handshake.
LuconResult LUCON_DeviceSetConnectedChangedCallback (LuconHandle device, LuconVoidCallback callback)
 Set a callback function to be called when the connection status of the device changes.
LuconResult LUCON_DeviceSetRestartedCallback (LuconHandle device, LuconVoidCallback callback)
 Set a callback function to be called when the host receives a restart hint from the device.
LuconResult LUCON_DeviceRestart (LuconHandle device, int32_t restartChannels)
 Triggers a restart of the Lucon. Either only the communication module can be restarted or all modules.
LuconResult LUCON_DeviceSavePermanently (LuconHandle device, int32_t restart)
 Persistently save the current parameters of the communication module in its EEPROM.
LuconResult LUCON_DeviceGetSerialNumber (LuconHandle device, char *const strbuf, const size_t buf_len)
 Read the serial number from the communication module as a string.
LuconResult LUCON_DeviceGetMacAddress (LuconHandle device, char *const strbuf, const size_t buf_len)
 Read the MAC address from the communication module as a string.
LuconResult LUCON_DeviceGetIpAddress (LuconHandle device, char *const strbuf, const size_t buf_len)
 Read the IP address setting from the communication module as a string.
LuconResult LUCON_DeviceSetIpAddress (LuconHandle device, const char *const address)
 Set the IPv4 address of the Lucon.
LuconResult LUCON_DeviceGetSubnetMask (LuconHandle device, char *const strbuf, const size_t buf_len)
 Read the IPv4 subnet mask from the device.
LuconResult LUCON_DeviceSetSubnetMask (LuconHandle device, const char *const subnet)
 Set the subnet mask of the device.
LuconResult LUCON_DeviceGetFirmwareVersion (LuconHandle device, char *const strbuf, const size_t buf_len)
 Read the current firmware version from the device.
LuconResult LUCON_DeviceGetChannelNumbers (LuconHandle device, uint8_t *const nbrs, const size_t buf_len, size_t *numChannels)
 Read the channel numbers of the available ("online") channels from the device.
LuconResult LUCON_DeviceGetChannel (LuconHandle device, const uint32_t channelNumber, LuconHandle *ptrChannelHandle)
 Create a handle to access the channel with the given channelNumber.
LuconResult LUCON_DeviceSetChannelsToContinuousMode (LuconHandle device, const uint8_t channelNumbers[], const struct LuconContinuousModeParameters params[], size_t numChannels)
 Set the desired continuous output currents of multiple channels in one command.
LuconResult LUCON_DeviceGetInfo (LuconHandle device, char *const result, const size_t buf_len)
 Compose a descriptive string by reading key parameters from the device.

Detailed Description

functions for interacting with Lucon Communication modules