FastSim
◎ 中文
← Server REST API  /  control
HTTPv1

Control & kinematics

Current Server Control & kinematics surface; paths, methods, status codes and handler signatures come directly from 0.8.4 source.

Source packages/fastsim-plugin-server/src/fastsim_plugin_server/application.py
submit_joint_pathcontrol_statecontrol_targetssubmit_physical_trackskinematics_descriptorsolve_kinematics_ik

Endpoints 6

POST/api/v1/control/joint-pathssubmit_joint_path
202dict[str, object]

Submit joint path

Handlersubmit_joint_path
Signatureasync submit_joint_path(payload: JointPathRequest, idempotency_key: _RequiredIdempotencyHeader, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2644
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/control/joint-paths \
  -H 'Content-Type: application/json' \
  -d @request.json
GET/api/v1/control/statecontrol_state
200dict[str, object]

Control state

Handlercontrol_state
Signatureasync control_state(timeout_s: _QueryTimeout=None) -> JSONResponse
SourceL2623
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/control/state
GET/api/v1/control/targetscontrol_targets
200dict[str, object]

Control targets

Handlercontrol_targets
Signatureasync control_targets() -> JSONResponse
SourceL2613
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/control/targets
POST/api/v1/control/trackssubmit_physical_tracks
202dict[str, object]

Submit physical tracks

Handlersubmit_physical_tracks
Signatureasync submit_physical_tracks(payload: PhysicalTracksRequest, idempotency_key: _RequiredIdempotencyHeader, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2685
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/control/tracks \
  -H 'Content-Type: application/json' \
  -d @request.json
GET/api/v1/kinematics/descriptorkinematics_descriptor
200dict[str, object]

Kinematics descriptor

Handlerkinematics_descriptor
Signatureasync kinematics_descriptor() -> JSONResponse
SourceL2727
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/kinematics/descriptor
POST/api/v1/kinematics/iksolve_kinematics_ik
200dict[str, object]

Solve kinematics ik

Handlersolve_kinematics_ik
Signatureasync solve_kinematics_ik(payload: KinematicsIkRequest) -> JSONResponse
SourceL2740
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/kinematics/ik \
  -H 'Content-Type: application/json' \
  -d @request.json