Skip to main content

CLI and python library for communicating with the Kitsat educational satellite

Project description

Kitsat python library and CLI

Overview

Kitsat python is a Python CLI and library for communicating with the Kitsat educational satellite manufactured by Arctic Astronautics Ltd.

Installation

Use the package manager pip to install kitsat_python

pip install kitsat

Additional installation steps

To access the USB port at ie. /dev/ttyS0 on Linux, you might have to add your user to dialout group with this command:

sudo usermod -a -G dialout <your_user_name>

And log off and on again.

Usage

This package offers a CLI and a Python library for operating the satellite. The cli can be run from a terminal with the command

kitsat_cli

A list of commands for the cli can be found in the directory docs

For using the library, here is a sample script that connects to a satellite on port /dev/ttyACM0, pings the satellite and prints its response. More example scripts can be found in the directory examples

from kitsat import Modem

mod = Modem()
mod.connect('/dev/ttyACM0')
mod.write('ping')
print(mod.read())

mod.disconnect()

Contributors

License

GNU GPLv3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kitsat-1.2.15.tar.gz (3.5 MB view hashes)

Uploaded Source

Built Distribution

kitsat-1.2.15-py3-none-any.whl (3.9 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page