Serial Wombat Arduino Library
serialWombatProtectedOutput.h
Go to the documentation of this file.
1 #pragma once
2 #include "SerialWombat.h"
7 typedef enum
8 {
12 } PO_COMPARE_t;
13 
14 
44 {
45 public:
52  void begin(uint8_t pin, uint8_t monitoredPin);
59  void configure(PO_COMPARE_t compareMode, uint16_t compareValue, uint8_t debounceTime, SerialWombatPinState_t activeState, SerialWombatPinState_t safeState);
62  bool isInSafeState();
64  void makeInput();
70  void digitalWrite(uint8_t state);
71 
72 private:
73  SerialWombat& _sw;
74  uint8_t _pin = 255;
75  uint8_t _monitoredPin = 255;
76  PO_COMPARE_t _compareMode = PO_FAULT_IF_NOT_EQUAL;
77  uint8_t _debounceTime = 0;
78  SerialWombatPinState_t _safeState = SW_INPUT;
79  SerialWombatPinState_t _activeState = SW_INPUT;
80  uint16_t _compareValue;
81 };
82 
PO_FAULT_IF_NOT_EQUAL
@ PO_FAULT_IF_NOT_EQUAL
Definition: serialWombatProtectedOutput.h:9
SerialWombatProtectedOutput::isInSafeState
bool isInSafeState()
Queries the Serial Wombat to see if the protected output has entered safe mode due to a fault.
Definition: serialWombatProtectedOutput.cpp:31
PO_FAULT_IF_FEEDBACK_LESS_THAN_EXPECTED
@ PO_FAULT_IF_FEEDBACK_LESS_THAN_EXPECTED
Definition: serialWombatProtectedOutput.h:10
SerialWombat.h
SerialWombatProtectedOutput::begin
void begin(uint8_t pin, uint8_t monitoredPin)
Definition: serialWombatProtectedOutput.cpp:8
SerialWombatProtectedOutput::digitalWrite
void digitalWrite(uint8_t state)
Turn off the protection features and make the protected pin an unprotected output.
Definition: serialWombatProtectedOutput.cpp:42
PO_COMPARE_t
PO_COMPARE_t
Definition: serialWombatProtectedOutput.h:7
SerialWombatPinState_t
SerialWombatPinState_t
Definition: SerialWombat.h:11
SW_INPUT
@ SW_INPUT
Definition: SerialWombat.h:15
SerialWombat
Definition: SerialWombat.h:72
PO_FAULT_IF_FEEDBACK_GREATER_THAN_EXPECTED
@ PO_FAULT_IF_FEEDBACK_GREATER_THAN_EXPECTED
Definition: serialWombatProtectedOutput.h:11
SerialWombatProtectedOutput::configure
void configure(PO_COMPARE_t compareMode, uint16_t compareValue, uint8_t debounceTime, SerialWombatPinState_t activeState, SerialWombatPinState_t safeState)
Definition: serialWombatProtectedOutput.cpp:14
SerialWombatProtectedOutput::makeInput
void makeInput()
Turn off protection features and make the protected pin an input.
Definition: serialWombatProtectedOutput.cpp:37
SerialWombatProtectedOutput::SerialWombatProtectedOutput
SerialWombatProtectedOutput(SerialWombat &serialWombat)
Constructor for SerialWombatProtectedOutput.
Definition: serialWombatProtectedOutput.cpp:3
SerialWombatProtectedOutput
Combine and input and output pin for a protected output.
Definition: serialWombatProtectedOutput.h:43