Dataplicity Developer Hub

Dataplicity Documentation

Here you'll find announcements for new features and comprehensive guides to help you integrate Dataplicity into your Raspberry Pi projects.

Get Started    

Remotely access Pi system stats

Use ScoutRealtime to remotely access a beautiful view of your Pi system stats

In this example we use Wormhole to remotely access critical system stats from a remote web browser. We'll be installing ScoutRealtime - which is a nicer looking web version of HTOP. The system stats are available from anywhere, without port forwarding, as long as your Pi has internet access.

Pre-requisites

This example assumes you have already followed the steps to Host a website from your Pi. If you have not, we recommend you start there as it guides you through the process of installing the Dataplicity Agent and activating Wormhole for your Pi.

Make sure to free up port 80

If you have been going through other tutorials for wormhole you might have an application or a service already running on port 80. Make sure that nothing is running on port 80 prior to following the instructions in this article.

Install ScoutRealtime

Scout is packaged as a Ruby "Gem", which means we first need to install the package containing the Ruby programming language.

sudo apt-get install ruby

Next, install the scout_realtime gem.

sudo gem install scout_realtime

Kudos to the ScoutRealtime guys! That's about as easy an installation as it gets.

Start the web service

At this point, Scout is installed and is ready to launch.

For Wormhole to work, when launching Scout we must instruct Scout to bind on HTTP port 80 instead of its default port.

sudo scout_realtime --port 80

See the stats

In your web browser, go to your device Wormhole URL using the link at the top of the device page inside your Dataplicity account, and you should now see Scout running.

Awesome :) Stunning, right?

Security considerations

Don't forget that when you switch on Wormhole you're placing the web service hosted on your Pi directly on the wider internet. That's actually the point, but what it means is that you need to take special care over what you put online.

In this case ScoutRealtime opens port 80 on your Pi and does not by default require a password to view. Wormhole listens only on localhost, and as such it is not necessary to open these ports directly from your Pi to the wider world. Therefore we recommend that you close these ports. If your system stats constitute private information it would be advisable to place the webserver behind NGINX and enable HTTP authentication (i.e. a password).

We've put together some basic tips for Securing Wormhole - well worth a read.

Remotely access Pi system stats


Use ScoutRealtime to remotely access a beautiful view of your Pi system stats

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.