analog_input.h

// Copyright 2021 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
 
#include "pw_chrono/system_clock.h"
#include "pw_result/result.h"
 
namespace pw::analog {
 
class AnalogInput {
 public:
  struct Limits {
    int32_t min;
    int32_t max;
  };
 
  virtual ~AnalogInput() = default;
 
  Result<int32_t> TryReadFor(chrono::SystemClock::duration timeout) {
    return TryReadUntil(chrono::SystemClock::TimePointAfterAtLeast(timeout));
  }
 
  virtual Result<int32_t> TryReadUntil(
      chrono::SystemClock::time_point deadline) = 0;
 
  virtual Limits GetLimits() const = 0;
};
 
}  // namespace pw::analog