# MujocoAR
A Python package that allows the retrieval of iOS ARKit data from a connected iOS device using MuJoCo.
## Installation
You can install the package using pip:
```bash
pip install mujoco_ar
```
## Usage
Here's an example of how to use MujocoAR in your Python project:
### Basic Setup (without MuJoCo cameras)
```python
from mujoco_ar import MujocoARConnector
# Initialize the connector with your desired parameters
connector = MujocoARConnector(ar_frequency=20)
# Start the connector
connector.start()
# Get latest AR data (after connecting the iOS device, check guide below)
data = get_latest_data() # {"position": (3,1), "rotation": (3,3), "grasp": bool}
```
### Setup with a MuJoCo camera
```python
from mujoco_ar import MujocoARConnector
# Initialize the connector with your desired parameters
connector = MujocoARConnector(
mujoco_model=my_model,
mujoco_data=my_data,
camera_name='my_camera',
camera_frequency=10,
)
# Start the connector
connector.start()
# Get latest AR data (after connecting the iOS device, check guide below)
data = get_latest_data() # {"position": (3,1), "rotation": (3,3), "grasp": bool}
```
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Author
Omar Rayyan (olr7742@nyu.edu)
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/mujocoar",
"name": "mujoco-controller",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Omar Rayyan",
"author_email": "olr7742@nyu.edu",
"download_url": "https://files.pythonhosted.org/packages/e1/bc/5208d8aa90eb3678b3348740f345cdc24255db31515f4a1f6785f7c9e162/mujoco_controller-0.4.0.tar.gz",
"platform": null,
"description": "\n# MujocoAR\n\nA Python package that allows the retrieval of iOS ARKit data from a connected iOS device using MuJoCo.\n\n## Installation\n\nYou can install the package using pip:\n\n```bash\npip install mujoco_ar\n```\n\n## Usage\n\nHere's an example of how to use MujocoAR in your Python project:\n\n### Basic Setup (without MuJoCo cameras)\n\n```python\nfrom mujoco_ar import MujocoARConnector\n\n# Initialize the connector with your desired parameters\nconnector = MujocoARConnector(ar_frequency=20)\n\n# Start the connector\nconnector.start()\n\n# Get latest AR data (after connecting the iOS device, check guide below)\ndata = get_latest_data() # {\"position\": (3,1), \"rotation\": (3,3), \"grasp\": bool}\n```\n\n### Setup with a MuJoCo camera\n\n```python\nfrom mujoco_ar import MujocoARConnector\n\n# Initialize the connector with your desired parameters\nconnector = MujocoARConnector(\n mujoco_model=my_model, \n mujoco_data=my_data, \n camera_name='my_camera',\n camera_frequency=10,\n)\n\n# Start the connector\nconnector.start()\n\n# Get latest AR data (after connecting the iOS device, check guide below)\ndata = get_latest_data() # {\"position\": (3,1), \"rotation\": (3,3), \"grasp\": bool}\n```\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Author\n\nOmar Rayyan (olr7742@nyu.edu)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A connector to receive position and rotation data from a connected application.",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/mujocoar"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbb8c01deff50afa633f37c20b3a54eb1c0e532bf667ac7f7a9e10f9e4bfc76f",
"md5": "547722c1a9a485a03b334f444b805a4a",
"sha256": "a7cb0630df99843aa34041458ab08e366a1e770513731d32f35c52f621fe3bf0"
},
"downloads": -1,
"filename": "mujoco_controller-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "547722c1a9a485a03b334f444b805a4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6994,
"upload_time": "2024-08-03T17:44:00",
"upload_time_iso_8601": "2024-08-03T17:44:00.301322Z",
"url": "https://files.pythonhosted.org/packages/bb/b8/c01deff50afa633f37c20b3a54eb1c0e532bf667ac7f7a9e10f9e4bfc76f/mujoco_controller-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1bc5208d8aa90eb3678b3348740f345cdc24255db31515f4a1f6785f7c9e162",
"md5": "3b545947ff689d33c93365d30251754f",
"sha256": "feda9938b4aba840c384633eff37771e9ff24eae26dc50f56bffdc45fccab59f"
},
"downloads": -1,
"filename": "mujoco_controller-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "3b545947ff689d33c93365d30251754f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4100,
"upload_time": "2024-08-03T17:44:03",
"upload_time_iso_8601": "2024-08-03T17:44:03.338870Z",
"url": "https://files.pythonhosted.org/packages/e1/bc/5208d8aa90eb3678b3348740f345cdc24255db31515f4a1f6785f7c9e162/mujoco_controller-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-03 17:44:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "mujocoar",
"github_not_found": true,
"lcname": "mujoco-controller"
}
JSON
