| Name | indipyterm JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A terminal client which can be used to control remote instruments using the INDI protocol. |
| upload_time | 2025-02-14 11:11:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
indi
client
astronomy
instrument
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# indipyterm
You may have Python programs implementing some form of data collection or control and wish to remotely operate such an instrument.
An associated package 'indipydriver' can be used to take your data, organise it into a data structure defined by the INDI protocol, and serve it on a port.
This indipyterm package provides a terminal client, which connects to the port, allowing you to view and control your instrument from a terminal session.
It can be installed from Pypi with:
pip install indipyterm
indipydriver and indipyterm communicate with the INDI protocol.
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.
The client can be run from a virtual environment with
indipyterm [options]
or with
python3 -m indipyterm [options]
The package help is:
usage: indipyterm [options]
Terminal client to communicate to an INDI service.
options:
-h, --help show this help message and exit
--port PORT Port of the INDI server (default 7624).
--host HOST Hostname/IP of the INDI server (default localhost).
--blobfolder BLOBFOLDER Optional folder where BLOB's will be saved.
--version show program's version number and exit
A typical session would look like:
and showing one device:
The package can be installed from:
https://pypi.org/project/indipyterm
If installed from Pypi, then dependencies will automatically be pulled and installed, these are:
indipyclient - which generates and parses the INDI protocol.
textual - a library used to generate terminal interfaces.
Plus other packages which textual calls upon.
The indipydriver package which can be used to create instrument control, and serve the INDI protocol is available at:
https://pypi.org/project/indipydriver
https://github.com/bernie-skipole/indipydriver
https://indipydriver.readthedocs.io
With example driver scripts at:
https://github.com/bernie-skipole/inditest
The indipyclient package contains classes which may be useful if you want to create your own client or client script:
https://pypi.org/project/indipyclient
https://github.com/bernie-skipole/indipyclient
https://indipyclient.readthedocs.io
Raw data
{
"_id": null,
"home_page": null,
"name": "indipyterm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "indi, client, astronomy, instrument",
"author": null,
"author_email": "Bernard Czenkusz <bernie@skipole.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/fe/1d/5b0735f2724190eed820e558abe3aeef31b1fef99f697d631933dea6fa39/indipyterm-0.1.0.tar.gz",
"platform": null,
"description": "# indipyterm\n\nYou may have Python programs implementing some form of data collection or control and wish to remotely operate such an instrument.\n\nAn associated package 'indipydriver' can be used to take your data, organise it into a data structure defined by the INDI protocol, and serve it on a port.\n\nThis indipyterm package provides a terminal client, which connects to the port, allowing you to view and control your instrument from a terminal session.\n\nIt can be installed from Pypi with:\n\npip install indipyterm\n\nindipydriver and indipyterm communicate with the INDI protocol.\n\nINDI - Instrument Neutral Distributed Interface.\n\nSee https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface\n\nThe 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.\n\nThe client can be run from a virtual environment with\n\nindipyterm [options]\n\nor with\n\npython3 -m indipyterm [options]\n\nThe package help is:\n\n usage: indipyterm [options]\n\n Terminal client to communicate to an INDI service.\n\n options:\n -h, --help show this help message and exit\n --port PORT Port of the INDI server (default 7624).\n --host HOST Hostname/IP of the INDI server (default localhost).\n --blobfolder BLOBFOLDER Optional folder where BLOB's will be saved.\n\n --version show program's version number and exit\n\nA typical session would look like:\n\n\n\nand showing one device:\n\n\n\nThe package can be installed from:\n\nhttps://pypi.org/project/indipyterm\n\nIf installed from Pypi, then dependencies will automatically be pulled and installed, these are:\n\nindipyclient - which generates and parses the INDI protocol.\n\ntextual - a library used to generate terminal interfaces.\n\nPlus other packages which textual calls upon.\n\nThe indipydriver package which can be used to create instrument control, and serve the INDI protocol is available at:\n\nhttps://pypi.org/project/indipydriver\n\nhttps://github.com/bernie-skipole/indipydriver\n\nhttps://indipydriver.readthedocs.io\n\nWith example driver scripts at:\n\nhttps://github.com/bernie-skipole/inditest\n\nThe indipyclient package contains classes which may be useful if you want to create your own client or client script:\n\nhttps://pypi.org/project/indipyclient\n\nhttps://github.com/bernie-skipole/indipyclient\n\nhttps://indipyclient.readthedocs.io\n",
"bugtrack_url": null,
"license": null,
"summary": "A terminal client which can be used to control remote instruments using the INDI protocol.",
"version": "0.1.0",
"project_urls": {
"Source": "https://github.com/bernie-skipole/indipyterm"
},
"split_keywords": [
"indi",
" client",
" astronomy",
" instrument"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cebea0a2d9c1b89370724f60ee54b655f6168ec97fa3d7aa7294681ac71512cf",
"md5": "f9d6dfff7c9c0ba5fb1d3ef2c4b9d8f2",
"sha256": "226d767a3d014c5acddecaef9d7fc82eb647326389e90aea3c2d2a45f1f9203d"
},
"downloads": -1,
"filename": "indipyterm-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9d6dfff7c9c0ba5fb1d3ef2c4b9d8f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19689,
"upload_time": "2025-02-14T11:11:36",
"upload_time_iso_8601": "2025-02-14T11:11:36.132505Z",
"url": "https://files.pythonhosted.org/packages/ce/be/a0a2d9c1b89370724f60ee54b655f6168ec97fa3d7aa7294681ac71512cf/indipyterm-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fe1d5b0735f2724190eed820e558abe3aeef31b1fef99f697d631933dea6fa39",
"md5": "34975437b3804b3de2a21a61224998a1",
"sha256": "129c69c1f989b4788f4db5ef8fe7fc8516bd3f236b1189b4c6aa12592b6cd32a"
},
"downloads": -1,
"filename": "indipyterm-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "34975437b3804b3de2a21a61224998a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16818,
"upload_time": "2025-02-14T11:11:39",
"upload_time_iso_8601": "2025-02-14T11:11:39.199937Z",
"url": "https://files.pythonhosted.org/packages/fe/1d/5b0735f2724190eed820e558abe3aeef31b1fef99f697d631933dea6fa39/indipyterm-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-14 11:11:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bernie-skipole",
"github_project": "indipyterm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "indipyterm"
}
