trexprinterapi


Nametrexprinterapi JSON
Version 0.0.2 PyPI version JSON
download
home_page
SummaryProject to make API for Bresser 3D printer
upload_time2023-07-25 16:22:32
maintainer
docs_urlNone
authorChristian
requires_python>=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            This package will provide an API to connect to a trex 3d printer.
Currently its on development.


To install this package use 
```
pip install trexprinterapi
```

Than import it in your python program and initialise the Api with the following command

```
from trexprinterapi import TRexObserver
trex = TRexObserver(ip)
```

Observe that you need to specify at least the ip address. Additionally you can set the port (default 8899) and scan_intervall (default 600)

The scan_intervall should not be to small or else other programms comunicating with the printer may be disconnected.

This package is fully asyncrounus so you need to await all the methods for fetching data.

The following methods are available:

```
trex.update_server(ip:str=None, port:int=None, scan_intervall:int=None)
```
This method updates the ip address, port and scan_intervall. 

```
data = await trex.get()
data = await trex.force_get()
```
methods to fetch the data. the force_get ignores the scan_intervall and connects to the printer immediately.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "trexprinterapi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Christian",
    "author_email": "",
    "download_url": "",
    "platform": null,
    "description": "This package will provide an API to connect to a trex 3d printer.\nCurrently its on development.\n\n\nTo install this package use \n```\npip install trexprinterapi\n```\n\nThan import it in your python program and initialise the Api with the following command\n\n```\nfrom trexprinterapi import TRexObserver\ntrex = TRexObserver(ip)\n```\n\nObserve that you need to specify at least the ip address. Additionally you can set the port (default 8899) and scan_intervall (default 600)\n\nThe scan_intervall should not be to small or else other programms comunicating with the printer may be disconnected.\n\nThis package is fully asyncrounus so you need to await all the methods for fetching data.\n\nThe following methods are available:\n\n```\ntrex.update_server(ip:str=None, port:int=None, scan_intervall:int=None)\n```\nThis method updates the ip address, port and scan_intervall. \n\n```\ndata = await trex.get()\ndata = await trex.force_get()\n```\nmethods to fetch the data. the force_get ignores the scan_intervall and connects to the printer immediately.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Project to make API for Bresser 3D printer",
    "version": "0.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/Chris112358/TRex_Printer_API/issues",
        "Homepage": "https://github.com/Chris112358/TRex_Printer_API"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd4ed103c3bd5b88562c929117e6be95e0ac9aee5188916a1a47bf745c172fd4",
                "md5": "2bdeb62004139c5f38577de12d99c046",
                "sha256": "53dc3e906f6e966b6c5c71c3d3224945a57fb91ba95468d30bf2d193333f2324"
            },
            "downloads": -1,
            "filename": "trexprinterapi-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2bdeb62004139c5f38577de12d99c046",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 18760,
            "upload_time": "2023-07-25T16:22:32",
            "upload_time_iso_8601": "2023-07-25T16:22:32.925147Z",
            "url": "https://files.pythonhosted.org/packages/dd/4e/d103c3bd5b88562c929117e6be95e0ac9aee5188916a1a47bf745c172fd4/trexprinterapi-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-25 16:22:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Chris112358",
    "github_project": "TRex_Printer_API",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "trexprinterapi"
}
        
Elapsed time: 0.14495s