Repères

Ce fichier présente les différentes Repères : Fonctions de contrôle disponible avec l’API du Bras

Toutes les fonctions de contrôle du robot sont accessible grâce à une instance de classe NiryoRobot

robot = NiryoRobot(<robot_ip_address>)

frames = frames.get_saved_dynamic_frame_list()
...

Repères : Fonctions de contrôle

Liste des sous-sections des fonctions:

Fonctions des repères

class Frames(client)[source]
get_saved_dynamic_frame_list()[source]

Obtient la liste des repères dynamiques

Exemple:

list_frame, list_desc = robot.frames.get_saved_dynamic_frame_list()
print(list_frame)
print(list_desc)
Renvoie

la liste des noms des repères dynamiques, la liste des descriptions des repères dynamiques

Type renvoyé

dictionnaire{name:description}

get_saved_dynamic_frame(frame_name)[source]

Obtient le nom, la description et la position d’un repère dynamique

Exemple:

frame = robot.frames.get_saved_dynamic_frame("default_frame")
Paramètres

frame_name (str) – nom du repère

Renvoie

Obtient le nom, la description et la position d’un repère dynamique

Type renvoyé

namedtuple(name(str), description(str), position(list[float]), orientation(list[float]))

save_dynamic_frame_from_poses(frame_name, description, pose_origin, pose_x, pose_y, belong_to_workspace=False)[source]

Créer un repère dynamiques avec 3 positions (origine, x, y)

Exemple:

pose_o = [0.1, 0.1, 0.1, 0, 0, 0]
pose_x = [0.2, 0.1, 0.1, 0, 0, 0]
pose_y = [0.1, 0.2, 0.1, 0, 0, 0]

robot.frames.save_dynamic_frame_from_poses("name", "une description test", pose_o, pose_x, pose_y)
Paramètres

  • frame_name (str) – nom du repère

  • description (str) – decription du repère

  • pose_origin (list[float] [x, y, z, roll, pitch, yaw]) – position de l’origine du repère

  • pose_x (list[float] [x, y, z, roll, pitch, yaw]) – position du point x du repère

  • pose_y (list[float] [x, y, z, roll, pitch, yaw]) – position du point y du repère

  • belong_to_workspace (boolean) – indique si le repère appartient à un espace de travail

Renvoie

status, message

Type renvoyé

(int, str)

save_dynamic_frame_from_points(frame_name, description, point_origin, point_x, point_y, belong_to_workspace=False)[source]

Créer un repère dynamique avec 3 points (origine, x, y)

Exemple:

point_o = [-0.1, -0.1, 0.1]
point_x = [-0.2, -0.1, 0.1]
point_y = [-0.1, -0.2, 0.1]

robot.frames.save_dynamic_frame_from_points("name", "une description test", point_o, point_x, point_y)
Paramètres

  • frame_name (str) – nom du repère

  • description (str) – decription du repère

  • point_origin (list[float] [x, y, z]) – point d’origine du repère

  • point_x (list[float] [x, y, z]) – point x du repère

  • point_y (list[float] [x, y, z]) – point y du repère

  • belong_to_workspace (boolean) – indique si le repère appartient à un espace de travail

Renvoie

status, message

Type renvoyé

(int, str)

edit_dynamic_frame(frame_name, new_frame_name, new_description)[source]

Modifie un repère dynamique

Exemple:

robot.frames.edit_dynamic_frame("name", "new_name", "new description")
Paramètres

  • frame_name (str) – nom du repère

  • new_frame_name (str) – nouveau nom du repère

  • new_description (str) – nouvelle description du repère

Renvoie

status, message

Type renvoyé

(int, str)

delete_saved_dynamic_frame(frame_name, belong_to_workspace=False)[source]

Supprime un repère

Exemple:

robot.frames.delete_saved_dynamic_frame("name")
Paramètres

  • frame_name (str) – nom du repère à supprimer

  • belong_to_workspace (boolean) – indique si le repère appartient à un espace de travail

Renvoie

status, message

Type renvoyé

(int, str)