ultrasonic

Configure an ultrasonic sensor to integrate the HC-S204 ultrasonic distance sensor into your machine.

{
  "trigger_pin": "15",
  "echo_interrupt_pin": "18"
}

{
  "components": [
    {
      "name": "<your-ultrasonic-sensor-name>",
      "model": "ultrasonic",
      "api": "rdk:component:sensor",
      "attributes": {
        "trigger_pin": "<pin-number>",
        "echo_interrupt_pin": "<pin-number>"
      },
      "depends_on": []
    }
  ]
}

{
  "components": [
    {
      "name": "my-ultrasonic-sensor",
      "model": "ultrasonic",
      "api": "rdk:component:sensor",
      "attributes": {
        "trigger_pin": "15",
        "echo_interrupt_pin": "18"
      },
      "depends_on": []
    }
  ]
}

The following attributes are available for ultrasonic sensors:

AttributeTypeRequired?Description
trigger_pinstringRequiredThe GPIO number of the board’s GPIO pin that you have wired to the trigger pin of your ultrasonic sensor.
echo_interrupt_pinstringRequiredThe GPIO number of the board’s GPIO pin that you have wired to the echo pin of your ultrasonic sensor. Please note that unlike the RDK ultrasonic sensor, you must not use a named pin associated with a digital interrupt configured on your board: it will not (currently) work.
timeout_msintOptionalTime to wait in milliseconds before initiating a timeout when requesting readings from your ultrasonic sensor.
Default: 50
Max: 100