Serial Wombat Arduino Library
SerialWombatFrequencyOutput.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 Copyright 2024 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"
56 {
57 public:
63 
70  int16_t begin(uint8_t pin, uint16_t maxFrequency_Hz = 65535, uint16_t dutyCycle = 0x8000)
71  {
72  _pin = pin;
74  return initPacketNoResponse(0, dutyCycle, maxFrequency_Hz);
75  }
76 
77 
78 private:
79 };
80 
81 
82 
85 {
86 public:
88  {}
89 
90 
95  uint8_t pin()
96 {
97  return SerialWombatPin::_pin;
98 }
103  uint8_t swPinModeNumber()
104  {
106  }
107 };
108 
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:289
SerialWombatAbstractScaledOutput
SerialWombatServo, SerialWombatPWM and other proportional ouptut classes inherit from this class....
Definition: SerialWombatAbstractScaledOutput.h:62
SerialWombatFrequencyOutput_18AB
Extends the SerialWombatFrequencyOutput class with SW18AB specific functionality, including SerialWom...
Definition: SerialWombatFrequencyOutput.h:84
SerialWombatFrequencyOutput_18AB::pin
uint8_t pin()
fulfills a virtual function requirement of SerialWombatAbstractScaledOutput
Definition: SerialWombatFrequencyOutput.h:95
SerialWombat.h
SerialWombatPin
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombatPin.h:38
SerialWombatPin::_pinMode
uint8_t _pinMode
Definition: SerialWombatPin.h:164
PIN_MODE_FREQUENCY_OUTPUT
@ PIN_MODE_FREQUENCY_OUTPUT
(36)
Definition: SerialWombat.h:276
SerialWombatFrequencyOutput::begin
int16_t begin(uint8_t pin, uint16_t maxFrequency_Hz=65535, uint16_t dutyCycle=0x8000)
Initialize a pin that has been declared as FrequencyOutput.
Definition: SerialWombatFrequencyOutput.h:70
SerialWombatFrequencyOutput_18AB::swPinModeNumber
uint8_t swPinModeNumber()
fulfills a virtual function requirement of SerialWombatAbstractScaledOutput
Definition: SerialWombatFrequencyOutput.h:103
SerialWombatPin::pin
uint8_t pin()
Returns the current SW pin number. Used primarily for virtual calls by derived classes.
Definition: SerialWombatPin.h:121
SerialWombatFrequencyOutput_18AB::SerialWombatFrequencyOutput_18AB
SerialWombatFrequencyOutput_18AB(SerialWombatChip &serialWombat)
Definition: SerialWombatFrequencyOutput.h:87
SerialWombatPin::_pin
uint8_t _pin
Definition: SerialWombatPin.h:162
SerialWombatFrequencyOutput::SerialWombatFrequencyOutput
SerialWombatFrequencyOutput(SerialWombatChip &serialWombat)
Constructor for SerialWombatFrequencyOutput class.
Definition: SerialWombatFrequencyOutput.h:62
SerialWombatPin::initPacketNoResponse
int16_t initPacketNoResponse(uint8_t packetNumber, uint8_t param0=0x55, uint8_t param1=0x55, uint8_t param2=0x55, uint8_t param3=0x55, uint8_t param4=0x55)
Definition: SerialWombatPin.h:131
SerialWombatFrequencyOutput
A class representing a Serial Wombat Frequency Output.
Definition: SerialWombatFrequencyOutput.h:55