Serial Wombat Arduino Library
SerialWombatHSCounter.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 Copyright 2023 Broadwell Consulting Inc.
4 
5 "Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
6 the United States. See SerialWombat.com for usage guidance.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the "Software"),
10  * to deal in the Software without restriction, including without limitation
11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12  * and/or sell copies of the Software, and to permit persons to whom the
13  * Software is furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24  * OTHER DEALINGS IN THE SOFTWARE.
25 */
26 
27 
28 #include <stdint.h>
29 #include "SerialWombat.h"
30 
31 class SerialWombat;
32 
65 {
66 public:
70  };
71 
75 
76 
82  int16_t begin(uint8_t pin, SerialWombatHSCounter::publicDataOutput publicDataOutput = publicDataOutput::FREQUENCY_ON_LTH_TRANSITION ,uint16_t framesBetweenUpdates = 100, uint16_t publicOutputDivisor = 1);
83 
84  uint32_t readCounts(bool resetCounts = false);
85 
86  int32_t readFrequency();
88  int16_t disable ();
89 
90  uint8_t pin() { return _pin; }
91  uint8_t swPinModeNumber() { return _pinMode; }
92 
93 private:
94 
95 };
SerialWombatHSCounter::disable
int16_t disable()
Disables the high speed clock output.
Definition: SerialWombatHSCounter.cpp:69
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:279
SerialWombatHSCounter::pin
uint8_t pin()
Used for inheritance.
Definition: SerialWombatHSCounter.h:90
SerialWombat.h
SerialWombatHSCounter::readCounts
uint32_t readCounts(bool resetCounts=false)
Definition: SerialWombatHSCounter.cpp:25
SerialWombatPin
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombat.h:1470
SerialWombatHSCounter::SerialWombatHSCounter
SerialWombatHSCounter(SerialWombatChip &serialWombat)
Class constructor for SerialWombatHSCounter.
Definition: SerialWombatHSCounter.cpp:3
SerialWombatHSCounter::publicDataOutput
publicDataOutput
Definition: SerialWombatHSCounter.h:67
SerialWombatPin::_pinMode
uint8_t _pinMode
Definition: SerialWombat.h:1567
SerialWombatHSCounter::readFrequency
int32_t readFrequency()
Definition: SerialWombatHSCounter.cpp:47
SerialWombatHSCounter::PULSE_COUNT
@ PULSE_COUNT
The number of pulses that have occured since initialization.
Definition: SerialWombatHSCounter.h:68
SerialWombat
This class name is depricated. Do not use for new development. Use SerialWombatChip instead.
Definition: SerialWombat.h:1455
SerialWombatHSCounter::swPinModeNumber
uint8_t swPinModeNumber()
Used for ineheritance.
Definition: SerialWombatHSCounter.h:91
SerialWombatAbstractProcessedInput
SerialWombatAnalogInput, SerialWombatPulseTimer, SerialWombatResistanceInput and others inherit from ...
Definition: SerialWombatAbstractProcessedInput.h:79
SerialWombatHSCounter
This class is used to measure the frequency or cycles of a high speed input. On the Serial Wombat 18A...
Definition: SerialWombatHSCounter.h:64
SerialWombatPin::_pin
uint8_t _pin
Definition: SerialWombat.h:1565
SerialWombatHSCounter::FREQUENCY_ON_LTH_TRANSITION
@ FREQUENCY_ON_LTH_TRANSITION
The frequency of the pulse in Hz.
Definition: SerialWombatHSCounter.h:69
SerialWombatHSCounter::begin
int16_t begin(uint8_t pin, SerialWombatHSCounter::publicDataOutput publicDataOutput=publicDataOutput::FREQUENCY_ON_LTH_TRANSITION, uint16_t framesBetweenUpdates=100, uint16_t publicOutputDivisor=1)
Initialization routine for SerialWombatHSCounter.
Definition: SerialWombatHSCounter.cpp:7