Introduction to Sparky CLI

Sparky is the "hard working reliable data dog" that can run on any platform, integrates with any sensor that writes log files, and will relay your sensor data to your cloud dashboard. The Sparky CLI is easy to install, works on macOS, Windows, and Linux, and offers you a range of functionality to make your developer experience with FarmHub better.

With the Sparky CLI, you can:

• Consolidate all your sensor data into a single cloud dashboard
• Import your historical log files from your sensors
• Setup a MQTT broker to forward data to your dashboard
• Manage your SSL certificates and sensor configuration without code

Concepts

Sources

A Source is essentially any log directory on your machine. Most sensors write log files to a single directory and sparky monitors those directories for changes and sends those changes to your dashboard.

Setting up a source only takes a minute and really only needs to be done once. Once it's configured sparky will handle the rest.

For more information check out Sources

Targets

A Target is the sensor you created on your cloud dashboard. By importing the sensor you're essentially downloading all the technical requirements for sending your data to the cloud without code!

For more information check out Targets

Links

A Link is basically the "line" drawn between two things. In this case a link tells sparky what data to work with and were it should go. It says, "this source data needs to go to this target notebook on my dashboard."

For more information check out Links