Serial Wombat Arduino Library

Loading...
Searching...
No Matches
SerialWombatBlink.h
Go to the documentation of this file.
1#pragma once
2/*
3 Copyright 2025 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"
32
33
51
52 class SerialWombatBlink : public SerialWombatPin
53{
54 public:
59 SerialWombatBlink(SerialWombatChip& serialWombat) :SerialWombatPin(serialWombat) {}
60
67 int16_t begin(uint8_t pin, uint8_t publicDataSource)
68 {
69 _pin = pin;
70 _pinMode = (uint8_t)PIN_MODE_BLINK;
71 return initPacketNoResponse(0, publicDataSource);
72 }
73
80 int16_t begin(uint8_t pin, SerialWombatDataSource publicDataSource)
81 {
82 _pin = pin;
83 _pinMode = (uint8_t)PIN_MODE_BLINK;
84 return initPacketNoResponse(0, (uint8_t)publicDataSource);
85 }
86
87
88 private:
89};
90
91
SerialWombat.h
PIN_MODE_BLINK
@ PIN_MODE_BLINK
(40)
Definition SerialWombat.h:296
SerialWombatDataSource
SerialWombatDataSource
A list of Serial Wombat public data sources.
Definition SerialWombat.h:65
SerialWombatBlink::begin
int16_t begin(uint8_t pin, uint8_t publicDataSource)
Initialize a pin that has been declared as Blink.
Definition SerialWombatBlink.h:67
SerialWombatBlink::begin
int16_t begin(uint8_t pin, SerialWombatDataSource publicDataSource)
Initialize a pin that has been declared as Blink.
Definition SerialWombatBlink.h:80
SerialWombatBlink::SerialWombatBlink
SerialWombatBlink(SerialWombatChip &serialWombat)
Constructor for SerialWombatBlink class.
Definition SerialWombatBlink.h:59
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition SerialWombat.h:315
SerialWombatPin::SerialWombatPin
SerialWombatPin(SerialWombatChip &serialWombatChip)
Instantiates a Serial Wombat Pin.
Definition SerialWombatPin.h:45
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:130
SerialWombatPin::_pin
uint8_t _pin
Definition SerialWombatPin.h:213
SerialWombatPin::pin
uint8_t pin()
Returns the current SW pin number. Used primarily for virtual calls by derived classes.
Definition SerialWombatPin.h:120
SerialWombatPin::_pinMode
uint8_t _pinMode
Definition SerialWombatPin.h:215