Files
allwpilib/wpilibc/wpilibC++Devices/include/Ultrasonic.h
Tyler Veness 368ad30d37 artf4107: Uniform initialization syntax introduced
Change-Id: I452b4794d757a0817589ec62b75eda7fbdd74904
2015-07-02 21:50:39 -07:00

95 lines
3.2 KiB
C++

/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2008. All Rights Reserved.
*/
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib. */
/*----------------------------------------------------------------------------*/
#pragma once
#include "SensorBase.h"
#include "Task.h"
#include "PIDSource.h"
#include "LiveWindow/LiveWindowSendable.h"
class Counter;
class DigitalInput;
class DigitalOutput;
/**
* Ultrasonic rangefinder class.
* The Ultrasonic rangefinder measures absolute distance based on the round-trip
* time
* of a ping generated by the controller. These sensors use two transducers, a
* speaker and
* a microphone both tuned to the ultrasonic range. A common ultrasonic sensor,
* the Daventech SRF04
* requires a short pulse to be generated on a digital channel. This causes the
* chirp to be
* emmitted. A second line becomes high as the ping is transmitted and goes low
* when
* the echo is received. The time that the line is high determines the round
* trip distance
* (time of flight).
*/
class Ultrasonic : public SensorBase,
public PIDSource,
public LiveWindowSendable {
public:
enum DistanceUnit { kInches = 0, kMilliMeters = 1 };
Ultrasonic(DigitalOutput *pingChannel, DigitalInput *echoChannel,
DistanceUnit units = kInches);
Ultrasonic(DigitalOutput &pingChannel, DigitalInput &echoChannel,
DistanceUnit units = kInches);
Ultrasonic(uint32_t pingChannel, uint32_t echoChannel,
DistanceUnit units = kInches);
virtual ~Ultrasonic();
void Ping();
bool IsRangeValid() const;
static void SetAutomaticMode(bool enabling);
double GetRangeInches() const;
double GetRangeMM() const;
bool IsEnabled() const { return m_enabled; }
void SetEnabled(bool enable) { m_enabled = enable; }
double PIDGet() const override;
void SetDistanceUnits(DistanceUnit units);
DistanceUnit GetDistanceUnits() const;
void UpdateTable() override;
void StartLiveWindowMode() override;
void StopLiveWindowMode() override;
std::string GetSmartDashboardType() const override;
void InitTable(ITable *subTable) override;
ITable *GetTable() const override;
private:
void Initialize();
static void UltrasonicChecker();
static constexpr double kPingTime =
10 * 1e-6; ///< Time (sec) for the ping trigger pulse.
static const uint32_t kPriority =
90; ///< Priority that the ultrasonic round robin task runs.
static constexpr double kMaxUltrasonicTime =
0.1; ///< Max time (ms) between readings.
static constexpr double kSpeedOfSoundInchesPerSec = 1130.0 * 12.0;
static Task m_task; // task doing the round-robin automatic sensing
static Ultrasonic *m_firstSensor; // head of the ultrasonic sensor list
static bool m_automaticEnabled; // automatic round robin mode
static SEMAPHORE_ID m_semaphore; // synchronize access to the list of sensors
DigitalInput *m_echoChannel;
DigitalOutput *m_pingChannel;
bool m_allocatedChannels;
bool m_enabled;
Counter *m_counter;
Ultrasonic *m_nextSensor;
DistanceUnit m_units;
ITable *m_table = nullptr;
};