{"id":23511119,"url":"https://github.com/maxmsun/joey","last_synced_at":"2026-04-20T09:32:48.046Z","repository":{"id":204936774,"uuid":"399967616","full_name":"MaxMSun/Joey","owner":"MaxMSun","description":"Joey: Customizable ROS Joystick Driver for Differential-Drive Robots","archived":false,"fork":false,"pushed_at":"2021-08-26T02:16:35.000Z","size":19,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-13T17:19:34.488Z","etag":null,"topics":["differential-drive","differential-drive-robot","joystick","joystick-control","robot","robot-control","robotics","ros","ros-driver","ros-melodic","ros-noetic"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MaxMSun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-08-25T22:01:51.000Z","updated_at":"2022-09-23T20:26:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"aa90720b-678a-4a54-a4f1-c485031e026d","html_url":"https://github.com/MaxMSun/Joey","commit_stats":null,"previous_names":["muchensun/joey","maxmsun/joey"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MaxMSun/Joey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxMSun%2FJoey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxMSun%2FJoey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxMSun%2FJoey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxMSun%2FJoey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaxMSun","download_url":"https://codeload.github.com/MaxMSun/Joey/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxMSun%2FJoey/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32041367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["differential-drive","differential-drive-robot","joystick","joystick-control","robot","robot-control","robotics","ros","ros-driver","ros-melodic","ros-noetic"],"created_at":"2024-12-25T12:13:21.459Z","updated_at":"2026-04-20T09:32:48.016Z","avatar_url":"https://github.com/MaxMSun.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Joey: Customizable ROS Joystick Driver for Differential-Drive Robots\n\nJoey is a highly-customizable ROS joystick driver designed for differential-drive robots. Users are able to customize axis and buttons for linear/angular velocity, linear/angular boost(acceleration) and safety(shutdown) mode.\n\n## Install\n\n### Dependencies\n\n`Joey` depends on ROS default joystick driver, you can install it via `sudo apt install ros-\u003cdistr\u003e-joy`.\n\n### Clone and compile\n\n~~~\ncd \u003cros_workspace\u003e/src\ngit clone https://github.com/MuchenSun/Joey.git\ncd ..\ncatkin build\n~~~\n\n## Usage\n\nThe `Joey_node` ROS node will subscribe to a joystick topic (with `sensor_msgs::Joy` message) from the `joy_node` node in the `joy` package (installation step above), and publish a velocity command in the format of `geometry_msgs::Twist` on the specified topic.\n\nThere are two example launch files named \"sony\\_dualshock3.launch\" and \"logitech\\_f310.launch\" specified for two common joystick models. They are a good start for customizing your own joystick driver.\n\n### Parameters\n\n - joy\\_topic: Joystick topic to subscribe to.\n - cmd\\_topic: Control topic to publish to.\n - max\\_lin\\_vel: Maximum linear velocity allowed.\n - max\\_ang\\_vel: Maximum angular velocity allowed.\n - lin\\_boost\\_ratio: When not boosted, the maximum achievable linear velocity would be (max\\_lin\\_vel)x(lin\\_boost\\_ratio), the true maximum velocity could only be achieved with full boost.\n - ang\\_boost\\_ratio: When not boosted, the maximum achievable angular velocity would be (max\\_ang\\_vel)x(ang\\_boost\\_ratio), the true maximum velocity could only be achieved with full boost.\n - fractional\\_boost: Whether the joystick supports (for example, whether the L1/2 and R1/2 buttons support fractional input).\n - lin\\_vel\\_axis: Joystick axis for linear velocity control.\n - lin\\_boost\\_axis: Joystick axis for linear boost control.\n - ang\\_vel\\_axis: Joystick axis for angular velocity control.\n - ang\\_boost\\_axis: Joystick axis for angular boost control. \n - shutdown\\_axis: Joystick axis for enabling \"shutdown\" mode, in which all other inputs will be ignored and the driver will publish zero-velocity command.\n - recover\\_axis: Joystick axis for recovering from \"shutdown\" mode.\n\n## License\n\nThis project is licensed under GPLv3. For any question, feel free to contact Muchen Sun (sunmch15@gmail.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxmsun%2Fjoey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxmsun%2Fjoey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxmsun%2Fjoey/lists"}