Serial Wombat Arduino Library

Loading...
Searching...
No Matches
PCB0030_Bridge.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*/
29#include "SerialWombat.h"
30
60
61 class PCB0030_Bridge : public SerialWombatChip
62{
63 public:
64 PCB0030_Bridge() : SerialWombatChip(), hBridge45(*this), hBridge67(*this), powerVoltage(*this)
65 {}
66
67 SerialWombatHBridge hBridge45, hBridge67;
68 SerialWombatAnalogInput_18AB powerVoltage;
69
70
71
72
83 int16_t begin(uint8_t i2cAddress,bool pin3IsVoltage = false, uint16_t pwmFrequency = 1000)
84 {
85 SerialWombatChip::begin(Wire, i2cAddress, true);
86
87 hBridge45.begin(4, 5, pwmFrequency,HBRIDGE_OFF_BOTH_HIGH); // Short Brake mode
88 hBridge67.begin(6, 7, pwmFrequency,HBRIDGE_OFF_BOTH_HIGH); // Short Brake mode
89 if (pin3IsVoltage)
90 {
91 powerVoltage.begin(3);
92 pin3VoltageEnable = true;
93 }
94 return (0);
95 }
96
97
109 uint16_t readPowerVoltage_mv()
110 {
111 if (pin3VoltageEnable)
112 {
113 uint32_t v = powerVoltage.readAveraged_mV();
114 v *= (8200 + 2000); // Board has an 8200 / 2000 ohm voltage divider
115 v /= 2000;
116 return ((uint16_t)v);
117 }
118 return (0);
119
120 }
121
122 private:
123 bool pin3VoltageEnable = false;
124};
125
SerialWombat.h
HBRIDGE_OFF_BOTH_HIGH
@ HBRIDGE_OFF_BOTH_HIGH
Definition SerialWombatHBridge.h:36
PCB0030_Bridge::begin
int16_t begin(uint8_t i2cAddress, bool pin3IsVoltage=false, uint16_t pwmFrequency=1000)
Initialize a PCB0030_Bridge pcb on a given I2C address.
Definition PCB0030_Bridge.h:83
PCB0030_Bridge::powerVoltage
SerialWombatAnalogInput_18AB powerVoltage
Definition PCB0030_Bridge.h:68
PCB0030_Bridge::readPowerVoltage_mv
uint16_t readPowerVoltage_mv()
Returns the voltage provided to the Bridge in mV.
Definition PCB0030_Bridge.h:109
PCB0030_Bridge::hBridge67
SerialWombatHBridge hBridge67
Definition PCB0030_Bridge.h:67
PCB0030_Bridge::hBridge45
SerialWombatHBridge hBridge45
Definition PCB0030_Bridge.h:67
PCB0030_Bridge::PCB0030_Bridge
PCB0030_Bridge()
Definition PCB0030_Bridge.h:64
SerialWombatAnalogInput_18AB
This class extends SerialWombatAnalogInput with SW18AB specific capabilities.
Definition SerialWombatAnalogInput.h:317
SerialWombatChip::SerialWombatChip
SerialWombatChip()
Definition SerialWombat.cpp:31
SerialWombatChip::begin
int16_t begin(HardwareSerial &serial, bool reset=true)
initialize a Serial Wombat chip to use a Serial Interface.
Definition SerialWombat.h:548
SerialWombatHBridge
A class representing a Serial Wombat H Bridge Output.
Definition SerialWombatHBridge.h:49