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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file kitsat-1.2.15.tar.gz.

File metadata

  • Download URL: kitsat-1.2.15.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for kitsat-1.2.15.tar.gz
Algorithm Hash digest
SHA256 c28626bf0605edc29b12fd86b59b66aafa1b259c165755a6920dce06b379396b
MD5 0b91813d09c27929f184e255a5ddb44c
BLAKE2b-256 675e002b1e02af0969772fde17d4f19fc022b440ab7df2c0ddf554b4e3a3f957

See more details on using hashes here.

File details

Details for the file kitsat-1.2.15-py3-none-any.whl.

File metadata

  • Download URL: kitsat-1.2.15-py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for kitsat-1.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 805242850761b1fd552a92e07bc24578ce8194d0748f21c4896c2a0c3dd9e426
MD5 35c1bab2fef30cf17035e5ca9c719693
BLAKE2b-256 b0d86b44fd306845cdc19172c941d299d76ecfffb5d3280ef6feaaf112d6f4d4

See more details on using hashes here.

Supported by

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