# blueye.sdk
[](https://github.com/BluEye-Robotics/blueye.sdk/actions)
[](https://github.com/ambv/black)
[](https://lgtm.com/projects/g/BluEye-Robotics/blueye.sdk/context:python)
[](https://codecov.io/gh/BluEye-Robotics/blueye.sdk)
[](https://pypi.org/project/blueye.sdk/)
[](https://pypi.org/project/blueye.sdk/)
_________________
[Read Latest Documentation](https://blueye-robotics.github.io/blueye.sdk/) - [Browse GitHub Code Repository](https://github.com/BluEye-Robotics/blueye.sdk)
_________________
A Python package for remote control of the Blueye underwater drones.
## About Blueye Underwater Drones
Blueye produces and sells three models of underwater drones, the Blueye Pioneer, Blueye Pro, and Blueye X3. The Pioneer and the Pro are drones designed for inspection, while the X3 is extensible with three guest ports that allow attaching for example grippers or sonars.
Visit [blueyerobotics.com](https://www.blueyerobotics.com/products) for more information about the Blueye products.
## This SDK and the Blueye drones
A Blueye drone is normally controlled via a mobile device through the Blueye App ([iOS](https://apps.apple.com/no/app/blueye/id1369714041)/[Android](https://play.google.com/store/apps/details?id=no.blueye.blueyeapp)).
The mobile device is connected via Wi-Fi to a surface unit, and the drone is connected to the surface unit via a tether cable.
This python SDK exposes the functionality of the Blueye app through a Python object. The SDK enables remote control of a Blueye drone as well as reading telemetry data and viewing video streams. It is not meant for executing code on the drone itself.
To control the drone you connect your laptop to the surface unit Wi-Fi and run code that interfaces with the through the Python object.
Check out the [`Quick Start Guide`](https://blueye-robotics.github.io/blueye.sdk/latest/quick_start/) to get started with using the SDK.
Raw data
{
"_id": null,
"home_page": "https://www.blueyerobotics.com",
"name": "blueye-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "Blueye, Pioneer, Pro, Robotics, SDK, Software Development Kit",
"author": "Sindre Hansen",
"author_email": "sindre.hansen@blueye.no",
"download_url": "https://files.pythonhosted.org/packages/e0/89/6075abb8e0515317ee319497ec1ef2408e0f186142cae50589354127be56/blueye_sdk-2.3.0.tar.gz",
"platform": null,
"description": "# blueye.sdk\n[](https://github.com/BluEye-Robotics/blueye.sdk/actions)\n[](https://github.com/ambv/black)\n[](https://lgtm.com/projects/g/BluEye-Robotics/blueye.sdk/context:python)\n[](https://codecov.io/gh/BluEye-Robotics/blueye.sdk)\n[](https://pypi.org/project/blueye.sdk/)\n[](https://pypi.org/project/blueye.sdk/)\n_________________\n\n[Read Latest Documentation](https://blueye-robotics.github.io/blueye.sdk/) - [Browse GitHub Code Repository](https://github.com/BluEye-Robotics/blueye.sdk)\n_________________\n\nA Python package for remote control of the Blueye underwater drones.\n\n\n\n\n## About Blueye Underwater Drones\nBlueye produces and sells three models of underwater drones, the Blueye Pioneer, Blueye Pro, and Blueye X3. The Pioneer and the Pro are drones designed for inspection, while the X3 is extensible with three guest ports that allow attaching for example grippers or sonars.\nVisit [blueyerobotics.com](https://www.blueyerobotics.com/products) for more information about the Blueye products.\n\n## This SDK and the Blueye drones\nA Blueye drone is normally controlled via a mobile device through the Blueye App ([iOS](https://apps.apple.com/no/app/blueye/id1369714041)/[Android](https://play.google.com/store/apps/details?id=no.blueye.blueyeapp)).\nThe mobile device is connected via Wi-Fi to a surface unit, and the drone is connected to the surface unit via a tether cable.\n\nThis python SDK exposes the functionality of the Blueye app through a Python object. The SDK enables remote control of a Blueye drone as well as reading telemetry data and viewing video streams. It is not meant for executing code on the drone itself.\n\nTo control the drone you connect your laptop to the surface unit Wi-Fi and run code that interfaces with the through the Python object.\n\n\nCheck out the [`Quick Start Guide`](https://blueye-robotics.github.io/blueye.sdk/latest/quick_start/) to get started with using the SDK.\n",
"bugtrack_url": null,
"license": null,
"summary": "SDK for controlling a Blueye underwater drone",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://www.blueyerobotics.com",
"Repository": "https://github.com/blueye-robotics/blueye.sdk"
},
"split_keywords": [
"blueye",
" pioneer",
" pro",
" robotics",
" sdk",
" software development kit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64edc8fc3b89aca1176d775f2bae278c7932857a5acec1f18fba3ef22b8d1a62",
"md5": "914a5bd39ad1adfbb884c3e697916f4a",
"sha256": "f848c944c5bbd1dec89a75c1ea82e442519b47442dee43ff8989cd8b2d357cbc"
},
"downloads": -1,
"filename": "blueye_sdk-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "914a5bd39ad1adfbb884c3e697916f4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 1013697,
"upload_time": "2024-11-04T12:47:25",
"upload_time_iso_8601": "2024-11-04T12:47:25.305088Z",
"url": "https://files.pythonhosted.org/packages/64/ed/c8fc3b89aca1176d775f2bae278c7932857a5acec1f18fba3ef22b8d1a62/blueye_sdk-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0896075abb8e0515317ee319497ec1ef2408e0f186142cae50589354127be56",
"md5": "b0d31228522b4dbf65eba527630f62ef",
"sha256": "bdf2cdd4bcaac2891b9eb1963294d69f72ede3ce8e781c6c484bd38567f9bf53"
},
"downloads": -1,
"filename": "blueye_sdk-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b0d31228522b4dbf65eba527630f62ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 943263,
"upload_time": "2024-11-04T12:47:27",
"upload_time_iso_8601": "2024-11-04T12:47:27.114444Z",
"url": "https://files.pythonhosted.org/packages/e0/89/6075abb8e0515317ee319497ec1ef2408e0f186142cae50589354127be56/blueye_sdk-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 12:47:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "blueye-robotics",
"github_project": "blueye.sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "blueye-sdk"
}
JSON
