This online document might be outdated. Please see the LucidControl Product Series PDF documentation instead.
2 Setup and Installation
The figure shows the LucidControl Digital Output Module with 4 digital outputs (DO0 ~ DO3).
All LucidControl USB IO modules have two connectors, the USB-Connector and the IO-Connector. Because of this the modules are very easy to connect and to set-up.
While the upper USB-Connector is used for interconnection with the computer, the lower IO-Connector provides the interface depending on the modules function (e.g. digital outputs or analog inputs).
The IO-Connectors of most modules have 8 terminals, two for each input or output channel. One exception is the DO4-S module which has 3 terminals per output channel and provides an IO-Connector with 12 contacts (illustrated in gray).
2.1 Interface and Interconnection
2.1.1 USB Connection
LucidControl USB IO modules are connected to the computer by using a standard USB Cable which must not extend a length of 5 m.
All modules are “bus powered” which means that the host computer supplies the module with power and there is no additional power supply necessary.
Supplying USB devices with power is not critical using a desktop computer or notebooks but it must be considered that the total power of one USB port is limited to 500 mA.
The USB ports of the Raspberry Pi® are limited to 100 mA. This means that maximum two devices can be connected to a port directly.
All LucidControl are rated at a maximum current which can be found in the module specific user manual.
Using an active USB-Hub with its own power supply allows the connection of additional devices in the case that the host is not able to supply them.
2.1.2 IO Connection
The signals applied to the IO-Connector must be compatible with the function of the module.
The correct interconnection is described in section “IO Connection” of the module specific user manual.
All contacts of the modules are protected against ESD but not necessarily against overload which is especially relevant for output modules.
If the module specific user manual does not state anything different it is under no circumstances allowed to apply voltages above 30 V or below -30 V to any terminal. This may destroy the module.
2.2 Mechanical Setup
Some text needed …
2.3 Software Setup
Setting up of LucidControl modules is very easy and described for Microsoft Window® and Linux operating systems here:
- At first ensure that no signal is applied to the IO-Connector
- Connect LucidControl USB IO module via USB with your computer
- Applies for Microsoft Windows® only:The system asks for an installation file (INF). This is not a driver but only an information file which can be found in the download section.
- That’s all. The green power LED is on and the module is ready for use.
2.3.1 Microsoft Windows®
The installation under Microsoft Windows requires the information file. Download the CDC INF File.
After installation the Windows Device Manager shows a new serial port (COM) and the module can be accessed by using this port.
Even if more than one module is connected to a computer Microsoft Windows® ensures that the same serial port number is allways assigned to the module(s) after start up.
In contradiction to the Microsoft Windows® installation the module is immediately ready on Linux after it was connected to the computer. Linux installs /dev/ttyACM devices for any module connected to the computer incrementing the succeeding number for any device starting with 0.
By default Linux cannot ensure that the same /dev/ttyACM device is assigned the same module after a restart. But as long as only one module is connected to the computer it is ensured that it is accessible via /dev/ttyACM0.
LucidIoCtrl Command line tool is able to create a permanent static link to a unique LucidControl module. This link is also present after a restart and it can also have a more meaningful device name like dev/digitalIoKitchen.
2.3.3 Installation of LucidIoCtrl Command Line Tool
The LucidIoCtrl Command Line Tool (LCLT) is a console application which gives full access to LucidControl modules. It is available for different platforms and can be found in the download section of our website.
The program consist only of one executable file which can be stored in your favorite directory.
2.3.4 Ready to Start
Once the module was installed successfully (if it was necessary at all) the green power LED is switched on and signals that the module is ready for use.
The following examples illustrate how to access a LucidControl module by using LCLT. The Identify command (see section 4.3.8) is used to request specific information of the module e.g. type, serial number, etc.
At this moment it is only important to know that the Identify command can be used to inspect all LucidControl modules and all modules provide similar information.
This example assumes that the LucidControl module is connected to comport 1.
Enter the following line in the windows prompt (console):
LucidIoCtrl –dCOM1 –i [ENTER]
This example assumes that the LucidControl module is connected to /dev/ttyACM0.
Enter the following line in the console:
LucidIoCtrl –d/dev/ttyACM0 –i [ENTER]
Result of the example
LCLT returns a console output similar to what can be seen below:
DEVICE CLASS: 1000 (DIGITAL OUTPUT 4 CHANNELS)
DEVICE TYPE: 1000 (SOLID STATE 24 V)
SERIAL NUMBER: 02000000
FIRMWARE REVISION: 0001
HARDWARE REVISION: 01
This example shows the result of the Identify command from a digital output module with 4 channels carried out as solid state relays (SSR).
In case of an error the chosen comport is probably wrong and the parameter should be revised.
LucidControl USB IO Module Content
2 LucidIoCtrl Command Line Tool