{"id":19534073,"url":"https://github.com/foxglove/rosmsg","last_synced_at":"2025-04-26T14:34:51.502Z","repository":{"id":46331530,"uuid":"380057884","full_name":"foxglove/rosmsg","owner":"foxglove","description":"ROS 1 and ROS 2 message definition parser","archived":false,"fork":false,"pushed_at":"2024-04-24T21:15:42.000Z","size":219,"stargazers_count":10,"open_issues_count":0,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-05-01T19:13:01.959Z","etag":null,"topics":["browser","idl","msg","nearley","nodejs","parser","ros","ros2","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foxglove.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-24T21:48:43.000Z","updated_at":"2024-06-18T18:19:17.287Z","dependencies_parsed_at":"2023-01-18T17:10:15.904Z","dependency_job_id":"eb41cd23-dc1f-4911-b69f-83f01468d1bd","html_url":"https://github.com/foxglove/rosmsg","commit_stats":{"total_commits":49,"total_committers":8,"mean_commits":6.125,"dds":0.5510204081632653,"last_synced_commit":"70e009e59a4165307cc1d6a671c3ba2edc1fa1e7"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxglove%2Frosmsg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxglove%2Frosmsg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxglove%2Frosmsg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foxglove%2Frosmsg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foxglove","download_url":"https://codeload.github.com/foxglove/rosmsg/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251001305,"owners_count":21520923,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["browser","idl","msg","nearley","nodejs","parser","ros","ros2","typescript"],"created_at":"2024-11-11T02:12:16.624Z","updated_at":"2025-04-26T14:34:51.439Z","avatar_url":"https://github.com/foxglove.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @foxglove/rosmsg\n\n\u003e [!IMPORTANT]\n\u003e This package has moved to https://github.com/foxglove/ros-typescript.\n\n\u003e _ROS1 and ROS2 message definition parser_\n\n[![npm version](https://img.shields.io/npm/v/@foxglove/rosmsg.svg?style=flat)](https://www.npmjs.com/package/@foxglove/rosmsg)\n\n## Introduction\n\n[The Robot Operating System (ROS)](https://www.ros.org/) defines a simplified message description language for describing data types. This library parses those message definitions and can round trip them back into a canonical string format suitable for checksum generation. The parsed definitions are useful for serialization or deserialization when paired with other libraries.\n\nThis library supports both [ROS1](http://wiki.ros.org/msg) and [ROS 2](https://docs.ros.org/en/galactic/Concepts/About-ROS-Interfaces.html) message definitions.\n\n## ROS 1 Definition Usage\n\n```Typescript\nimport { parse, stringify } from \"@foxglove/rosmsg\";\n\nconst definitionStr = `# geometry_msgs/Pose\ngeometry_msgs/Point position\ngeometry_msgs/Quaternion orientation\n\n===\nMSG: geometry_msgs/Point\nfloat64 x\nfloat64 y\nfloat64 z\n\n===\nMSG: geometry_msgs/Quaternion\nfloat64 x\nfloat64 y\nfloat64 z\nfloat64 w`;\n\nconst messageDefinition = parse(definitionStr);\n\n// print the parsed message definition structure\nconsole.log(JSON.stringify(messageDefinition, null, 2));\n```\n\nPrints:\n\n```JSON\n[\n  {\n    \"definitions\": [\n      {\n        \"type\": \"geometry_msgs/Point\",\n        \"isArray\": false,\n        \"name\": \"position\",\n        \"isComplex\": true\n      },\n      {\n        \"type\": \"geometry_msgs/Quaternion\",\n        \"isArray\": false,\n        \"name\": \"orientation\",\n        \"isComplex\": true\n      }\n    ]\n  },\n  {\n    \"name\": \"geometry_msgs/Point\",\n    \"definitions\": [\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"x\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"y\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"z\",\n        \"isComplex\": false\n      }\n    ]\n  },\n  {\n    \"name\": \"geometry_msgs/Quaternion\",\n    \"definitions\": [\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"x\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"y\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"z\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"w\",\n        \"isComplex\": false\n      }\n    ]\n  }\n]\n```\n\n## ROS 2 Definition Usage\n\n```Typescript\nimport { parse, stringify } from \"@foxglove/rosmsg\";\n\nconst definitionStr = `# geometry_msgs/msg/Pose\ngeometry_msgs/msg/Point position\ngeometry_msgs/msg/Quaternion orientation\n\n===\nMSG: geometry_msgs/msg/Point\nfloat64 x\nfloat64 y\nfloat64 z\n\n===\nMSG: geometry_msgs/msg/Quaternion\nfloat64 x\nfloat64 y\nfloat64 z\nfloat64 w`;\n\nconst messageDefinition = parse(definitionStr, {ros2: true});\n\n// stringify(messageDefinition) will return a canonical string, similar to\n// _definitionStr_\n// print the parsed message definition structure\nconsole.log(JSON.stringify(messageDefinition, null, 2));\n```\n\nPrints:\n\n```JSON\n[\n  {\n    \"definitions\": [\n      {\n        \"type\": \"geometry_msgs/msg/Point\",\n        \"isArray\": false,\n        \"name\": \"position\",\n        \"isComplex\": true\n      },\n      {\n        \"type\": \"geometry_msgs/msg/Quaternion\",\n        \"isArray\": false,\n        \"name\": \"orientation\",\n        \"isComplex\": true\n      }\n    ]\n  },\n  {\n    \"name\": \"geometry_msgs/msg/Point\",\n    \"definitions\": [\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"x\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"y\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"z\",\n        \"isComplex\": false\n      }\n    ]\n  },\n  {\n    \"name\": \"geometry_msgs/msg/Quaternion\",\n    \"definitions\": [\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"x\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"y\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"z\",\n        \"isComplex\": false\n      },\n      {\n        \"type\": \"float64\",\n        \"isArray\": false,\n        \"name\": \"w\",\n        \"isComplex\": false\n      }\n    ]\n  }\n]\n```\n\n## ROS 2 IDL Support\n\nSee (`@foxglove/ros2idl-parser`)[https://github.com/foxglove/omgidl/packages/ros2idl-parser] for our implementation of `ros2idl` schema support.\n\n## License\n\n@foxglove/rosmsg is licensed under the [MIT License](https://opensource.org/licenses/MIT).\n\n## Releasing\n\n1. Run `yarn version --[major|minor|patch]` to bump version\n2. Run `git push \u0026\u0026 git push --tags` to push new tag\n3. GitHub Actions will take care of the rest\n\n## Stay in touch\n\nJoin our [Slack channel](https://foxglove.dev/slack) to ask questions, share feedback, and stay up to date on what our team is working on.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoxglove%2Frosmsg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoxglove%2Frosmsg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoxglove%2Frosmsg/lists"}