Skip to content

Commit

Permalink
doc: add new service to ROS API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gavanderhoorn committed Aug 3, 2024
1 parent 2ecab41 commit 8ae9cd5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/ros_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ Note: this topic is only namespaced if a namespace is configured *and* `namespac

## Services

### inform_job/list

Type: [motoros2_interfaces/srv/ListInformJobs](https://github.com/Yaskawa-Global/motoros2_interfaces/blob/e6d75c5ead964542f7828171a6cff409d7aac592/srv/ListInformJobs.srv)

Retrieve the list of INFORM jobs present on the controller.

Note: this service supports a maximum of `1024` INFORM jobs.
On controllers with more jobs than this maximum, MotoROS2 will return an error to the client and the `names` field in the service response will be empty.

Please refer to the documentation embedded in the service definition for more information about service fields and general behaviour.

### read_group_io

Type: [motoros2_interfaces/srv/ReadGroupIO](https://github.com/yaskawa-global/motoros2_interfaces/blob/d6805d32714df4430f7db3d8ddc736c340ddeba8/srv/ReadGroupIO.srv)
Expand Down

0 comments on commit 8ae9cd5

Please sign in to comment.