Skip to main content

A terminal client which can be used to control remote instruments using the INDI protocol.

Project description

indipyconsole

This indipyconsole package provides a (linux only) terminal client, which connects to an INDI server, allowing you to view and control your instrument from a terminal session.

INDI defines a protocol for the remote control of instruments.

INDI - Instrument Neutral Distributed Interface.

See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface

The INDI protocol defines the format of the data sent, such as light, number, text, switch or BLOB (Binary Large Object). The client is general purpose, taking the format of switches, numbers etc., from the protocol.

indipyconsole can be installed from Pypi:

https://pypi.org/project/indipyconsole

Or if you use uv, it can be loaded and run with:

uvx indipyconsole

The client can be run from a virtual environment with

indipyconsole [options]

Note, this package has no dependencies other than the Python standard library and if the source files are copied to your machine, it can be run without a virtual environment with

python3 -m indipyconsole [options]

The package help is:

usage: indipyconsole [options]

Console client to communicate to an INDI service.

options:
  -h, --help                show this help message and exit
  -p PORT, --port PORT      Port of the INDI server (default 7624).
  --host HOST               Hostname/IP of the INDI server (default localhost).
  -b BLOBS, --blobs BLOBS   Optional folder where BLOB's will be saved.
  --loglevel LOGLEVEL       Enables logging, value 1, 2, 3 or 4.
  --logfile LOGFILE         File where logs will be saved
  --version                 show program's version number and exit

The BLOB's folder can also be set from within the session.
Setting loglevel and logfile should only be used for brief
diagnostic purposes, the logfile could grow very big.
loglevel:1 Information and error messages only, no exception trace.
The following levels enable exception traces in the logs
loglevel:2 As 1 plus xml vector tags without members or contents,
loglevel:3 As 1 plus xml vectors and members - but not BLOB contents,
loglevel:4 As 1 plus xml vectors and all contents

This terminal should work with any INDI service, however associated packages by the same author are:

indipyserver

https://github.com/bernie-skipole/indipyserver

https://pypi.org/project/indipyserver

https://indipyserver.readthedocs.io

indipydriver

https://github.com/bernie-skipole/indipydriver

https://pypi.org/project/indipydriver

https://indipydriver.readthedocs.io

indipyweb

https://github.com/bernie-skipole/indipyweb

https://pypi.org/project/indipyweb

indipyterm

A further package indipyterm is also available, by the same author, which you may prefer.

indipyterm can run on other OS's apart from Linux, and gives a more attractive terminal output, however it depends on third party libraries.

indipyconsole uses the Python standard library curses package, which is only available on Linux.

The main purpose of indipyconsole is to provide an indipendent client, without dependencies.

https://github.com/bernie-skipole/indipyterm

https://pypi.org/project/indipyterm

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

indipyconsole-0.0.3.tar.gz (67.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

indipyconsole-0.0.3-py3-none-any.whl (75.0 kB view details)

Uploaded Python 3

File details

Details for the file indipyconsole-0.0.3.tar.gz.

File metadata

  • Download URL: indipyconsole-0.0.3.tar.gz
  • Upload date:
  • Size: 67.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for indipyconsole-0.0.3.tar.gz
Algorithm Hash digest
SHA256 6e1b4f1359d650174cb8b0d1e1c3c503daf698f84a0f79f417d34e066c1011ab
MD5 ac22695f7c3e955d972abb7734a3df28
BLAKE2b-256 104cc2faa3efae400464bf07bef130cf689244b00f9c8f6643359442894f6ade

See more details on using hashes here.

File details

Details for the file indipyconsole-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: indipyconsole-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 75.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for indipyconsole-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 10902d336f8461b6170da60e7680eae81c63997e58483c42050b9a4482c22db9
MD5 26c6c028a231bcb226546e1b3176feb3
BLAKE2b-256 2bab4b1079c55db6c61e83ed5410e8b07fea359fd802f40cd1b128f53dbdcc09

See more details on using hashes here.

Supported by

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