Getting Started

Welcome to the PL Console documentation website. PL Console is a cutting-edge app that aims to make data logging workflows as efficient as possible. It's cross-platform, privacy-respecting, and free to use!

Download

Downloads are available for Android, iOS, Linux, Raspberry Pi, Windows, and macOS. Find the appropriate link here.

Installation and Execution

Windows

  1. Double-click the downloaded exe installer file.
  2. Run through the installation wizard. Default options are recommended.
  3. Open the start menu, type the application name, optionally pin the program to the taskbar, and launch the app.

macOS

  1. Follow the above link to the Apple App Store.
  2. Download and install the app.
  3. Enable permissions as necessary when launching the app.

Linux / Raspberry Pi

  1. Extract the downloaded tar.gz file using tar -xf <file>.
  2. Navigate to the bin directory in the extracted folder.
  3. Execute the binary file by double-clicking it or typing the path into a terminal.
  4. It may be necessary to install Bluetooth drivers and applications. Refer to your distribution's Bluetooth / BLE documentation.

Android

  1. Follow the above link to the Google Play store.
  2. Download and install the app.
  3. Enable permissions as necessary when launching the app.

iOS

  1. Follow the above link to the App Store.
  2. Download and install the app.
  3. Enable permissions as necessary when launching the app.


Scanning

Overview

The scan page allows the application to discover and connect to nearby Bluetooth data loggers. Multiple devices can be connected simultaneously, but once connected, devices may not be individually added or removed.

Note

Bluetooth must be powered on and Bluetooth permission must be granted to the app. Mobile devices have recently added the requirement of location permission to use Bluetooth, even for apps such as this one that do not use geolocation.

Scanned devices will show up in a vertical list. Click on the device(s) you wish to Connect. To deselect all devices, click Deselect. If your device is not showing up, ensure it is powered on and close to your computer or phone.

Hint

Existing files can be opened from the scan page, bypassing the need to connect to a device.



Graphing and Realtime

Once the Graph button has been clicked, the data from the connected devices will be downloaded.

Note

It is recommended to reload logger information before downloading graphs.

Graph Interaction

Graphs automatically expand to fill their windows in the vertical axis. For the horizontal axis, two operations exist: zooming and panning.

On mobile devices, panning is achieved by sliding left and right on a graph and zooming is done with a pinching movement. If there are multiple channels or multiple loggers, vertical translation is also possible. On desktop platforms, panning is done by clicking and dragging left or right and zooming is done by scrolling or dragging the vertical right sidebar:

Mobile Desktop
Panning Horizontal slide Horizontal drag
Zooming Pinch Scroll wheel, Vertical Sidebar Drag

Hint

If your data are not visible on a downloaded graph and multiple loggers are connected, check the timestamps on the horizontal axis. The window could be very zoomed out. If this is the case, it may be better to connect one logger at a time.

Realtime Data

Clicking Realtime will load a list displaying live data from all connected loggers. It may take a few seconds for new data to arrive. In addition to viewing this data numerically, it can be viewed on the Graph page, and the graph will update every time new readings arrive. Before zooming in, first hit the Play / Pause button to pause auto-updating the graph view. Depending on the type of logger(s) connected, the realtime refresh rate will be anywhere from 2 to 10 seconds.

Saving and Transferring Files

Set a title for the graph by clicking on the title bar. Afterward, click on the Save button and create a short filename. Depending on the operating system, it may be necessary to add the .json extension to the filename (check the path after it's saved). This is saved in the default graph directory, which varies across operating systems but is generally a subfolder in the user's home folder.

Platform Accessing Files
macOS ~/Library/Containers/AppName/Documents/AppName/
Linux / RPi /home/user/AppName/
Windows C:\Users\User\AppName\
iOS Plug iPhone into Mac over USB; copy AppName dir to Desktop
Android Android/data/AppName/files/AppName/

Hint

The above file paths are rough guides only. This app is released under multiple names, so adapt AppName appropriately.

  • For Android phones, connect the phone to a desktop computer with a USB cable. The phone will ask for permission to access files. Click Allow. In the file manager on the desktop computer, click on the Android device, then navigate to the directory in the above table.
  • For iPhones, plug the phone into a Mac with the appropriate USB cable. On the Mac, open Finder. The iPhone should show up in the sidebar. Click on the Files tab. Navigate the list and locate the folder in the above table. Drag this onto the Mac's desktop. Open the copied folder and the graph files should be visible.
  • For Macs, files have to be accessed by opening Finder, clicking on Go > Go to Folder, and entering ~/Library/. From there, navigate to the above path. This location can be bookmarked in Finder's sidebar.
  • To transfer iPhone files to a Windows computer, install iTunes for Windows.
  • To transfer Android files to a Mac, install MacDroid (known to work) or OpenMTP (untested).



Preferences

Look

Changes the color scheme of the application. A wide variety of color schemes are provided. Custom color scheme files are not yet supported.

Units

Every channel captures data in a standard base unit. For example, if a logger measures temperature, it will be saved and sent in degrees Celsius. Displaying a graph or value with a different unit (e.g. degrees Fahrenheit) is done by configuring the unit for individual channel types.

Hint

Different loggers that have the same channel type (e.g. temperature) will display the same unit.

Note

Unit configuration does not apply to loggers like the process signal logger, which use custom equations in place of units.

Note

The thermocouple hot junction unit is set separately from the standard temperature unit.

Units can be set in the application preferences.

Custom Process Signal Equations

From the in-app guide:

A process signal equation is a custom transformation applied to raw voltage or current data. To set an equation, select the input range (each has its own equation bank) and an equation to change in the main list. Add a short description, the physical quantity (e.g. Pressure), and the unit abbreviation (e.g. PSI). The offset is the first transformation. It is a number added to the raw data. The multiplier is then used to amplify the data. Finally, the filter, (if enabled) sets all transformed data outside of the specified range to zero. For example, filtering for >=0.0 will produce a graph that has entirely positive values (0 notwithstanding).

These settings are in-app and are not sent to any connected devices. To use these equations on another computer or phone, it is necessary to copy over config.json, which is stored in the default graph directory.

Title Type Description
Input Range custom Controls which bank of equations to set
Short Description string A note with location, device type, range, etc.
Variable Type string The physical quantity (e.g. Pressure)
Unit Name string Abbreviated unit name (e.g. PSI)
Offset float Value added to raw data
Multiplier float Amplifies the offset data
Filter FOR custom Limits data above or below 0 if enabled


Actions

Actions, unlike Preferences, are settings that directly affect one or more connected devices. Many actions involve writing to the memory of the connected devices, so they should be used carefully.

Note

Currently the logger information is not reloaded when an action is executed so a manual reload must be performed to see the changes.

Clear, Interval, SWF

Clearing erases all existing data on all connected devices, then begins recording data. When clearing, it is necessary to set the interval, or the frequency of recording, and whether recording should stop when the memory is full (Stop When Full, SWF).

Active Channels

Setting active channels controls which of the available data channels will be recorded. This feature exists to extend logging periods or increase resolution. For example, a logger that has four channels will fill memory at one quarter the rate if only one channel is enabled. Setting this will clear existing data on the logger it is applied to.

Power Off

Powering off shuts down all connected devices. A full shutdown is only executed when the application disconnects from the affected loggers.

Calibrate

Calibration corrects sensors which drift naturally over time. See the individual product specification for details on expected drift levels.

Warning

Calibration is an advanced procedure and is not recommended for most users.

Memory Size

Memory size pertains to the number of sectors available for storing readings in flash memory. Setting this will clear all data on the loggers it applies to. This feature exists to customize the recording time or data history size.

Transmit Power

This sets the signal strength of the connected devices' transmitters. The lower the transmit power, the longer the battery will last.

Process Signal

This sets the power supply voltage, reading input range, and the power supply timing of process signal loggers. The process signal logger has an internal power supply for running various types of analog sensors. See the process signal logger product specification for more information on compatible sensors.

Thermocouple

This ensures the right equation is used for the thermocouple loggers' internal converter algorithm. It should be updated every time a new thermocouple type (K, J, etc.) is attached.

Flashlight

A convenient feature that repurposes the builtin LED as a flashlight. It switches off automatically after 5 minutes.

Action Summary

Action Effect Data
Clear Clear readings, set interval, start logging Cleared
Active Channels Set the channels to log Cleared
Power Off Save all readings and power off all devices Committed
Calibrate Zero or perform a two-point calibration -
Memory Size Customize the available logging memory Cleared
Transmit Power Set the logger's BLE signal strength -
Process Signal Set power, range, timing, and equation # -
Thermocouple Change the thermocouple type -
Flashlight Use the logger LED as a flashlight -