SparkFun Qwiic Ultrasonic Distance Sensor  v1.1.2-5-gc1d2217
SparkFun Qwiic Ultrasonic Distance Sensor
Loading...
Searching...
No Matches
SparkFun_Qwiic_Ultrasonic_Arduino_Library.h
Go to the documentation of this file.
1/* SparkFun Ulrasonic Distance Sensor
2 *
3 * Product:
4 * * SparkFun Qwiic Ultrasonic Distance Sensor - HC-SR04 (SEN-1XXXX)
5 * * https://www.sparkfun.com/1XXXX
6 *
7 * SPDX-License-Identifier: MIT
8 *
9 * Copyright (c) 2024 SparkFun Electronics
10 */
11
12#pragma once
13
14#include "Arduino.h"
15#include "sfeQwiicUltrasonic.h"
16#include <Wire.h>
17
19{
20 public:
25 bool begin(uint8_t address = kQwiicUltrasonicDefaultAddress, TwoWire &wirePort = Wire)
26 {
27 // Setup Arudino I2C bus
28 _theI2CBus.init(wirePort, address);
29
30 // Begin the sensor
31 return sfeQwiicUltrasonic::begin(&_theI2CBus) == kSTkErrOk;
32 }
33
37 {
38 return sfeQwiicUltrasonic::isConnected() == kSTkErrOk;
39 }
40
41 private:
42 sfeTkArdI2C _theI2CBus;
43};
Definition: SparkFun_Qwiic_Ultrasonic_Arduino_Library.h:19
bool begin(uint8_t address=kQwiicUltrasonicDefaultAddress, TwoWire &wirePort=Wire)
Begins the Qwiic Ultrasonic sensor.
Definition: SparkFun_Qwiic_Ultrasonic_Arduino_Library.h:25
bool isConnected()
Checks if the Qwiic Ultrasonic sensor is connected.
Definition: SparkFun_Qwiic_Ultrasonic_Arduino_Library.h:36
Definition: sfeQwiicUltrasonic.h:38
sfeTkError_t isConnected()
Checks if the Qwiic Ultrasonic sensor is connected.
Definition: sfeQwiicUltrasonic.cpp:40
sfeTkError_t begin(sfeTkII2C *theBus=nullptr)
Begins the Qwiic Ultrasonic sensor.
Definition: sfeQwiicUltrasonic.cpp:15
const uint8_t kQwiicUltrasonicDefaultAddress
Definition: sfeQwiicUltrasonic.h:17