Getting Started with Machinechat

Pages
Contributors: Ell C
Favorited Favorite 0

Introduction

The SparkFun OpenLog Artemis (without IMU) is an open source data logger that comes preprogrammed to automatically log GPS, serial data, and various pressure, humidity, and distance data as well as the ability to expand out to any number of our Qwiic sensors. This makes it ideal for data collection, but what about data display? In comes Machinechat and JEDI One!

Machinechat's JEDI One provides an easy-to-use, customizable, one stop dashboard solution for IoT data collection, transformation, visualization, and reporting. Built-in HTTP and TCP servers allow you to start collecting data from sensors and devices in minutes, and custom plug-ins allow you to collect data from virtually any sensor or device. In addition, a fully integrated and self-contained MQTT broker makes it easy to integrate any MQTT based device or sensor. No need to set up a separate broker or use Azure or AWS for MQTT. Just configure and go!

Required Materials

To get started, you really only need the SparkFun OpenLog Artemis (without IMU) and a Jedi One License, but you can also get going with any of these kits:

SparkFun OpenLog Data Collector with Machinechat - Environmental Monitoring

SparkFun OpenLog Data Collector with Machinechat - Environmental Monitoring

KIT-20683
$144.95
SparkFun OpenLog Data Collector with Machinechat - Air Quality Monitoring

SparkFun OpenLog Data Collector with Machinechat - Air Quality Monitoring

KIT-20684
$149.95
SparkFun OpenLog Data Collector with Machinechat - Base Kit

SparkFun OpenLog Data Collector with Machinechat - Base Kit

KIT-20673
$124.95

Suggested Reading

If you aren't familiar with the Qwiic system, we recommend reading here for an overview.

Qwiic Connect System

We would also recommend taking a look at the following tutorials if you aren't familiar with them. Depending on which kit you have, or which Qwiic board(s) you are planning to use, you may want to read through their respective Hookup Guides as well.

I2C

An introduction to I2C, one of the main embedded communications protocols in use today.

Connectivity of the Internet of Things

An overview of the different protocols that can be used for the development of Internet of Things (IoT)-based projects.

Introduction to MQTT

An introduction to MQTT, one of the main communication protocols used with the Internet of Things (IoT).

OpenLog Artemis Hookup Guide

How to use and re-program the OpenLog Artemis, an open source datalogger. The OLA comes preprogrammed to automatically log data. The OLA can also record serial data, analog voltages, or readings from external Qwiic-enabled I2C devices. Some of these Qwiic-enabled devices include GPS/GNSS modules, pressure, altitude, humidity, temperature, air quality, environment, distance, and weight sensors.

Software Installation

Machinechat has a number of installation packages, depending on your platform. For this guide, we're using the JEDIOne PC Mac installation on Windows. The button below will redirect you to the Jedi Download page:

Go ahead and download the correct installation package for your platform.

Jedi One download page


Extract your installation install, and click on that mcjedi executable and you should see the MachineChat server start running. It should look something like this:

Command window with the machine chat exe running

Logging In

Once you've got the server running, you can view your dashboard in your web browser. To navigate to your dashboard, you'll need to go to http://<ipaddress>:9123/ - if you are running your web browser on the same machine as your server, you can simply type in http://127.0.0.1:9123/.

When logging into JEDI One for the first time, you'll use "admin" as both the login and the password. Once you've logged in for the first time, you'll be prompted to change your password for future use. More details can be found here: Log in to JEDI One for the first time.

Initial login page showing user id as admin and password as admin

Having a hard time seeing the details? Click the image for a closer look.

Firmware

In order to use the OpenLog Artemis with MachineChat, you'll need to make sure your OpenLog Artemis board has Firmware v2.4 or later. If you don't know what version you have on your OpenLog Artemis, go ahead and plug in your board and open a Serial Monitor on the correct port. The data that spits out will tell you what version you are running:

COM8 serial port monitor shows output from the Artemis OpenLog and the version number is highlighted

Having a hard time seeing the details? Click the image for a closer look.

If you DO need to update your firmware, the stable version 2.4 can be found here or by clicking the button below:


Instructions on how to update the firmware are included in the OpenLog Artemis Hookup Guide.

OpenLog Artemis Hookup Guide

August 20, 2020

How to use and re-program the OpenLog Artemis, an open source datalogger. The OLA comes preprogrammed to automatically log data. The OLA can also record serial data, analog voltages, or readings from external Qwiic-enabled I2C devices. Some of these Qwiic-enabled devices include GPS/GNSS modules, pressure, altitude, humidity, temperature, air quality, environment, distance, and weight sensors.

There's a lot of really great information in this tutorial, but if you want to skip all that and go directly to the "Updating Firmware" section, feel free to click the button below:

Configuring Your Dashboard

Once you're logged into Machine chat, you should be able to click on Settings -> Data Collectors and the OpenLogSerial will be listed. Go ahead and click on that Edit Collector button.

WebBrowser open to home page and Data Collectors Page open. OpenLogSerial shows up and the Edit Collector button is the blue button with the pencil

Having a hard time seeing the details? Click the image for a closer look.


You may need to change some settings - verify that you've got the correct Serial Port selected, and set the rest of the settings as so:

  • Baud Rate (115200)
  • Data Bits (8)
  • Parity (No parity)
  • Stop Bits (One Stop Bit)
  • Record Delimiter (Newline)
  • Time Stamp at Server
  • Is After Line (selected) and text entry should be Content-Type: text/csv.

Settings are filled in for the OpenLogSerial Data Collector

Having a hard time seeing the details? Click the image for a closer look.

Once you've checked all the above, go ahead and click Save at the bottom of the page.

You'll be redirected back to the Data Collectors page; if the OpenLog Collector is disabled, click on the green Enable Collector icon.

Enable the Collector by clicking on thge Green Button

Having a hard time seeing the details? Click the image for a closer look.

If you click the Edit Collector button again, you should be able to scroll down and see the variables and data that are being collected from the OpenLog Artemis. These are the variables we'll use to create dashboard views!

In the Edit Collectors window, scroll all the way down and you should see variables from the ArtemisOpenLog

Having a hard time seeing the details? Click the image for a closer look.

Displaying Data

Now we get to do the fun stuff!

Go to Data Dashboard, and click on the Orange ADD CHART Button.

Data Dashboard and Add Chart are highlighted

Having a hard time seeing the details? Click the image for a closer look.

Go ahead and fill in as you see fit. You'll need to click on the green plus button to add a Data Source:

Filling in the information we want

Having a hard time seeing the details? Click the image for a closer look.

Click on the Green Plus button to the right of Data Sources to add your Data Source for your Data Table and then click ADD:

Add the DataSource to the table

Having a hard time seeing the details? Click the image for a closer look.

Make sure you've got this page filled out to your satisfaction, and then click the green "ADD" button.

Add Data Source information filled out

Having a hard time seeing the details? Click the image for a closer look.

Aaaaand VOILA!

Data Dashboard shows the variable and the Data we just added

Having a hard time seeing the details? Click the image for a closer look.

Take some time to poke around - you can add charts and data as you see fit - including data from Qwiic breakout boards. Here's a System Dashboard with some of the data from our Environmental and Air Quality sensors:

Image showing Temp, Humidity, Altitude, Pressure, and VOC Index Widgets

Having a hard time seeing the details? Click the image for a closer look.

Troubleshooting

Troubleshooting the Artemis OpenLog

The Artemis OpenLog Hookup Guide has a wonderful section on troubleshooting this board. If you need help with your Artemis OpenLog, head over to the [OpenLog Artemis Hookup Guide] (https://learn.sparkfun.com/tutorials/openlog-artemis-hookup-guide) or click on the button below to be redirected directly to the Troubleshooting and FAQ section of the hookup guide:

Troubleshooting MachineChat

MachineChat has its own Troubleshooting and Support channel - click the button below to be redirected to their website:

Resources and Going Further

Now that you've got the basics down, it's time to expand! Check out some of our Qwiic Environmental Sensors, Qwiic Distance Sensors, or Other Qwiic Sensors!

MachineChat has some wonderful resources - check out some of the following:

Need inspiration? Check out some of our Qwiic or other Artemis projects!

Qwiic Keypad Hookup Guide

If you are tired of taking up GPIO pins, wiring a bunch of pull up resistors, and using firmware that scans the keys taking up valuable processing time... check out the new Qwiic Keypad.

Qwiic Scale Hookup Guide

Create your own digital scale quickly and easily using the Qwiic Scale!

SparkFun 9DoF IMU (ICM-20948) Breakout Hookup Guide

How to use the SparkFun 9DoF ICM-20948 breakout board for your motion sensing projects. This breakout is ideal for wearable sensors and IoT applications.

Designing with the SparkFun Artemis

Let's chat about layout and design considerations when using the Artemis module.

Hookup Guide for the SparkFun RedBoard Artemis Nano

Get started with the powerful RedBoard Artemis Nano

SparkFun expLoRaBLE Hookup Guide

Check out our latest LoRaWAN development board with Bluetooth capabilities! With this guide, we'll get you passing data to The Things Network in no time.

Getting Started with the MyoWare® 2.0 Muscle Sensor Ecosystem

The MyoWare® 2.0 Muscle Sensor, an Arduino-compatible, all-in-one electromyography (EMG) sensor from Advancer Technologies. In this tutorial, we will go over the features and related shields to connect the sensor to a muscle group.