Skip to content

Runes Functions

Check If Seeing Rune

  • Description: Checks if the robot is seeing a specific rune.
  • Endpoint: /api/v1/str/
  • Type of Argument: String
  • JSON Example: 
    {"command": "is_seeing", "value": "rune_id"}

Get All Runes Details

  • Description: Retrieves details on all detected runes: ID, RSSI, Angles (horizontal and vertical).
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example: 
    {"command": "get_all_runes_details"}

Check If Rune Clicked

  • Description: Checks if a rune has been clicked.
  • Endpoint: /api/v1/str/
  • Type of Argument: String
  • JSON Example: 
    {"command": "is_clicked", "value": "rune_id"}

Check If Rune Double Clicked

  • Description: Checks if a rune has been double-clicked.
  • Endpoint: `/api/v1/str/

- **Type of Argument:**String` - JSON Example: 

{"command": "is_double_clicked", "value": "rune_id"}

Check If Rune Long Pressed

  • Description: Checks if a rune has been long-pressed.
  • Endpoint: /api/v1/str/
  • Type of Argument: String
  • JSON Example: 
    {"command": "is_long_pressed", "value": "rune_id"}

Check If Rune Detected

  • Description: Checks if a rune has been detected.
  • Endpoint: /api/v1/str/
  • Type of Argument: String
  • JSON Example: 
    {"command": "is_detected", "value": "rune_id"}

Get Rune RSSI

  • Description: Retrieves the RSSI of a rune.
  • Endpoint: /api/v1/str/
  • Type of Argument: String
  • JSON Example: 
    {"command": "get_rune_rssi", "value": "rune_id"}

Get Rune Angle of Arrival

  • Description: Retrieves the angle of arrival of a rune.
  • Endpoint: /api/v1/str/
  • Type of Argument: String
  • JSON Example: 
    {"command": "get_rune_angle_of_arrival", "value": "rune_id"}

Get Clicked Runes

  • Description: Retrieves a list of all clicked runes.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example: 
    {"command": "get_clicked_runes"}

Get Double Clicked Runes

  • Description: Retrieves a list of all double-clicked runes.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example: 
    {"command": "get_double_clicked_runes"}

Get Long Pressed Runes

  • Description: Retrieves a list of all long-pressed runes.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example: 
    {"command": "get_long_pressed_runes"}

Get Detected Runes

  • Description: Retrieves a list of all detected runes.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example: 
    {"command": "get_detected_runes"}

## Associate a rune

  • Description: Associate a rune with its properties, based on the rune ID.
  • Endpoint: /api/v1/dict/
  • Type of Argument: Dict
  • JSON Example: 
    {"command": "rune_association",
 "value": {
      "rune_id": "123A",
      "virtual_id": "filled_basket",
      "label": "Filled basket",
      "description": "Blue basket filled with stickers, pins, and goodies of all kinds",
      "class": "rune_basket",
 }
}
  • Available rune types:
    • "rune_speaker"
    • "rune_handle"
    • "rune_call"
    • "rune_kiss"
    • "rune_sleeping"
    • "rune_wave"
    • "rune_mute"