Skip to Navigation

Kipling - Windows Only

Summary

The software for the T7 is called Kipling.  It provides basic test, configuration, and self-upgrade functionality in a graphical interface.  The extent of the graphical interface is limited, since the software is intended as a basic tool.  However, ALL T7 functionality is present within the program through the use of the register tables.

  1. Download/install the LabJack software and driver bundle.
  2. LabJack Windows Driver and Software Installation Package

    49.9 MB
    2014-05-21 15:24
  3. Open the program called Kipling from the start menu.  Or open the program directly under C:\Program Files\LabJack\Applications\Kipling.exe

After Kipling detects a LabJack, it will display the serial number and communication method on the left side.  Kipling cannot configure a LabJack unless it is discovered. 

Dashboard - A Graphical View

The Dashboard tab allows for simple testing in a graphical way.  Change DIO from input to output by clicking the input button.  Or, modify the analog output voltage of the DAC lines with the arrow buttons.  Analog input values are displayed next to the analog channel number.

All of the values are updated about every half second on the dashboard page, and will continue unless the communication between the T7 and the computer is disrupted.  Find more details about the dashboard on the T7 quickstart page.

Table Views

Table views are different than the Dashboard because they provide flexibility that is difficult to achieve with a GUI.  Because the T7 is a LJM based device, all functionality is achieved through registers.  Registers have an Address, Name, Value, and Access type.  

Address - Unique identification number associated with hardware function.  There are no duplicate addresses, and it is not too difficult to find the address you want by using the Address Lookup tool.

Name - Unique identification string associated with hardware function.  In many cases the functionality of a register can be understood by the name.  

Value - The value of the register.  Values show what the register is doing, change the value to change what is happening, or what is stored.

Access - Read access is denoted with an R, and Write access is denoted with a W.  The value of the register cannot be changed if the register is read only.

The only field that can be modified by the user is the Value field, and only in cases where the register allows write access.  To modify a value, double-click the value, and the item will become highlighted.

Config

The config tab represents information about the LabJack status.  For instance, it is possible to turn off power to the WiFi module by changing the value of address 48004 to a 0.  Additionally, the default device name can be changed so that it is easier to identify.

Ethernet

The Ethernet tab represents information about the Ethernet configuration.  Notice that some registers are appended with _DEFAULT.  Default registers are writable, so this is where settings changes should be made.  

Changes to default registers take effect after a device power cycle.  Note that the DHCP register is set to 1, this means that it is currently enabled.  When DHCP is enabled, the IP address will be granted by the network and may change.

WiFi

The WiFi tab represents information about the WiFi configuration.  To change the network SSID, double-click the value field for the WIFI_SSID_DEFAULT.  The image below shows it being changed to "New_Network_Name".   Also notice that the T7 has an IP address, but the default IP is blank.  This difference is due to the fact that DHCP is enabled, and the IP address is being generated(granted) by the network.  To enable use of the default IP address in the example below, it would be necessary to first disable DHCP by changing WIFI_DHCP_DEFAULT_ENABLE to 0.

Note that the WiFi tab is greyed out on standard T7s, because wireless is a -Pro only option.  Changes to default registers take effect after a device power cycle.  Alternatively, write a value of 1 to the WIFI_APPLY_SETTINGS register, this will reboot the WiFi processor and apply new settings.

AIN

The AIN tab shows the analog inputs.  The voltage connected to each AIN is shown in the value column.  It is possible to change some other analog settings by using the appropriate register.  For instance, change the range to +- 1V by changing AIN0_RANGE to 1.

Since there are only 4 analog inputs displayed by default, it may be useful to add more registers to the view.  

Add Registers

Add registers using Tools -> Add Registers

The additional registers will now become visible in the table view of AIN.  The Add Registers window is how ALL features of the T7 are exposed, even though they may be brand-new in firmware.  Check here for obscure/unique registers, or higher-up channel numbers.

 

DAC

The DAC tab shows the analog output values. Double-click a value to change the analog output.

DIO

The DIO tab shows the Digital I/O related registers.  These registers can appear overwhelming at first glance, but do not fear!  Each value is a bit mask, so to change an I/O line, you must find the appropriate bit in the mask.  The picture below shows a change to the "digital direction" of FIO2, setting it to digital output.  The 0th bit is 0, corresponding to FIO0, and so it follows that the 1st and 2nd bit are tied to FIO1 and FIO2 respectively.  

An easy process to learn the bit masking technique is to play with the input/output buttons on the dashboard tab, and see the resulting change on the DIO bitmask tab.

DIO EF

The DIO EF tab lists registers that enable the device to perform more advanced timer & counter features. More information can be found in the Digital I/O section of the T7 datasheet.  

 

Watchdog

The Watchdog tab lists registers that enable the device to automatically recover from lost communication errors or system damage.  When enabled, the watchdog is pet every time a response to a command is transmitted.  Thus, if communication fails, the watchdog will timeout and the specified actions will occur.  The most common action is simply device reset.  For more information reference the Watchdog section of the T7 datasheet.

IO Config

The IO Configuration tab of Kipling makes it easy to configure the T7 to be used with hardware that doesn't require consistent re-configuration of it's ports and other extended features.  This tab accomplishes this by letting the user change the device's power-up settings from factory default values to values of their choice.  You can find a quick example displaying the process linked here.

Update

It is possible to update firmware using Kipling.  Simply browse for the new firmware file, and press Update Firmware.  The process takes about 30 seconds, and a new firmware version can be seen after the device resets. On T7-Pros this tab also lets you update the firmware on the device's WiFi module.  To do this you must first configure the T7 to connect to your network, select the appropriate firmware version, and then press the Update WiFi button.  

Find the latest T7 firmware on the T7 Firmware page

Kipling Updates

If there is an update available, it will be attached below.  Otherwise the latest version is in the main installer (step 1 above).

After using the main installer, you can unzip the archive attached here (if any) to get the most recent Kipling.exe file, and replace the Kipling.exe that was installed. 

Typical location is:

C:\Program Files (x86)\LabJack\Applications\kipling

 

 

Comments

#1

What are the differences between LJM and Kipling software?

The files are exactly the same size and created at exactly the same time.

#2

LJM is the library (also called driver, SDK, or API) used to talk to the T7.  Kipling is an application used to find, test, and configure the T7.  Kipling and other applications typically talk to LJM and LJM then talks to the T7.