index :: hw

hw.rpi.sensor.sr04

HC-SR04 ultrasonic ranging module for Raspberry Pi

available since version: 0.9.8

---

information

Note: The HC-SR04 ultrasonic sensor requires a 5V power supply, but the Raspberry Pi's GPIO inputs operate at 3.3V. Therefore, you must use a level converter from 5V to 3.3V, otherwise, you could damage your Raspberry Pi!

arguments:

• TRIG_PIN a trigger pin GPIO number
  type: int
  

• ECHO_PIN an echo pin GPIO number
  type: int
  

methods:

• poll turn the sensor polling on/off
  parameters:
  • STATE poll state
    type: bool
    required: True
    

properties:

• @echo_pin (initonly) Get/set an echo pin GPIO number
  type: int
  range: 0..255
  default: 27
  

• @poll_interval Get/set poll interval
  type: int
  units: ms
  range: 10..1000
  default: 20
  

• @trig_pin (initonly) Get/set a trigger pin GPIO number
  type: int
  range: 0..255
  default: 17
  

inlets:

• single distance measure
  type: control

outlets:

• float: distance in cm
  type: control
• bang: if distance can not be measured
  type: control

keywords:

sensor ultrasonic range rpi arduino

Authors: Serge Poltavsky

License: GPL3 or later