Project

pipark

0.0
The project is in a healthy, maintained state
Pea-brained control of Raspberry Pi's
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies
 Project Readme

GitHubRubyGemsDocumentationHistory

Pipark

A Ruby library for pea-brained control of Raspberry Pi's.

Installing

Pipark is available as a gem. You can simply install it with:

gem install pipark

Pipark has no dependencies outside the Ruby Standard Library.

Pipark is tested on Raspbian and MacOS systems with Ruby 2.7 or newer. It may work on other platforms or with older versions of Ruby.

Prerequisites

There are no extra steps needed to use Pipark directly on your Raspberry Pi.

To access a Raspberry Pi via the network, Pipark uses SSH, and your Raspberry Pi needs to be set up for passwordless SSH access.

If you can enter ssh <ip address> or ssh <hostname> in a terminal to login to your Raspberry Pi, without the need to enter a password or anything else, you are all set.

See this guide for configuring passwordless SSH access.

Quick start

While logged in to your Raspberry Pi, find out its model:

this_pi = Pipark.host('localhost')
=> Pipark::Host "localhost"
this_pi.model
=> "Raspberry Pi 3 Model B Plus Rev 1.3"

Shortcut:

Pipark.localhost.model
=> "Raspberry Pi 3 Model B Plus Rev 1.3"

For a Raspberry Pi you can access via the network (using passwordless SSH):

that_pi = Pipark.host('thatpi.local') # use hostname or IP address
=> Pipark::Host "thatpi.local"
that_pi.model
=> "Raspberry Pi 3 Model A Plus Rev 1.0"
that_pi.cpu_temperature
=> 48850

License

See the included LICENSE.txt file.