ClearCore Library
Loading...
Searching...
No Matches
ClearCore.h
1/*
2 * Copyright (c) 2020 Teknic, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23#ifndef __CLEARCORE_H__
24#define __CLEARCORE_H__
25
26// Header files from the ClearCore hardware that define connectors available
27#include "AdcManager.h"
28#include "CcioBoardManager.h"
29#include "DigitalIn.h"
30#include "DigitalInAnalogIn.h"
31#include "DigitalInOut.h"
33#include "DigitalInOutHBridge.h"
34#include "EthernetManager.h"
35#include "InputManager.h"
36#include "LedDriver.h"
37#include "EncoderInput.h"
38#include "MotorDriver.h"
39#include "MotorManager.h"
40#include "SdCardDriver.h"
41#include "SerialDriver.h"
42#include "SerialUsb.h"
43#include "StatusManager.h"
44#include "SysManager.h"
45#include "SysTiming.h"
46#include "XBeeDriver.h"
47
48
49namespace ClearCore {
50
52
53// IO connectors
58
59// H-Bridge type connectors
62
63// Digital input only connectors
67
68// Analog/Digital Inputs
73
74// Motor Connectors
79
80// Serial Port connectors
84
87
90
93
95extern AdcManager &AdcMgr;
96
99
101extern XBeeDriver XBee;
102
105
108
110extern SysTiming &TimingMgr;
111
113extern SdCardDriver SdCard;
114
116extern SysManager SysMgr;
117}
118
119using namespace ClearCore;
120
121#endif // __CLEARCORE_H__
ADC Peripheral Manager for the ClearCore Board.
ClearCore Digital Input Connector class.
Connector class for analog and digital inputs.
ClearCore Digital Output Connector class.
ClearCore Analog Output Connector class.
DigitalInOutHBridge Connector class for IO4 and IO5.
ClearCore encoder input object.
ClearCore input state access.
Connector LED shift register access.
ClearCore timing profiling utility functions.
ADC Peripheral Manager for the ClearCore Board.
Definition AdcManager.h:48
ClearCore I/O Expansion Board Manager Class.
Definition CcioBoardManager.h:91
ClearCore analog input connector class.
Definition DigitalInAnalogIn.h:58
ClearCore digital input connector class.
Definition DigitalIn.h:70
ClearCore digital input/output with analog current output Connector class.
Definition DigitalInOutAnalogOut.h:53
ClearCore H-Bridge digital output connector class.
Definition DigitalInOutHBridge.h:66
ClearCore digital output connector class.
Definition DigitalInOut.h:60
ClearCore Position Sensor Decoder.
Definition EncoderInput.h:54
ClearCore Ethernet configuration manager.
Definition EthernetManager.h:56
ClearCore input state access.
Definition InputManager.h:48
ClearCore LED control class.
Definition LedDriver.h:46
ClearCore motor connector class.
Definition MotorDriver.h:79
ClearCore motor-connector manager.
Definition MotorManager.h:46
ClearCore SD card interface.
Definition SdCardDriver.h:45
ClearCore Serial UART/SPI Connector class.
Definition SerialDriver.h:55
ClearCore Serial USB Connector class.
Definition SerialUsb.h:75
ClearCore Status Register Manager class.
Definition StatusManager.h:37
ClearCore Board Supervisory System Manager.
Definition SysManager.h:58
ClearCore system timing class.
Definition SysTiming.h:87
ClearCore XBee Interface.
Definition XBeeDriver.h:45
Namespace to encompass the ClearCore board API.
Definition AdcManager.h:36
InputManager & InputMgr
Input manager.
DigitalInAnalogIn ConnectorA10
A-10 connector instance.
DigitalInOutAnalogOut ConnectorIO0
IO-0 connector instance.
DigitalInAnalogIn ConnectorA12
A-12 connector instance.
SysManager SysMgr
System manager.
Definition MotorDriver.h:59
SysTiming & TimingMgr
Timing manager.
StatusManager & StatusMgr
Status manager.
LedDriver ConnectorLed
User-driven LED instance.
MotorDriver ConnectorM2
M-2 connector instance.
AdcManager & AdcMgr
ADC module manager.
DigitalIn ConnectorDI6
DI-6 connector instance.
CcioBoardManager & CcioMgr
CCIO-8 manager.
DigitalInOut ConnectorIO3
IO-3 connector instance.
EncoderInput EncoderIn
Position Decoder.
DigitalInAnalogIn ConnectorA9
A-9 connector instance.
DigitalInOut ConnectorIO1
IO-1 connector instance.
SerialDriver ConnectorCOM0
COM-0 connector instance.
MotorDriver ConnectorM0
M-0 connector instance.
DigitalInOutHBridge ConnectorIO4
IO-4 connector instance.
MotorDriver ConnectorM1
M-1 connector instance.
SerialUsb ConnectorUsb
USB connector instance.
MotorManager & MotorMgr
Motor connector manager.
DigitalInOutHBridge ConnectorIO5
IO-5 connector instance.
SdCardDriver SdCard
SD card.
EthernetManager & EthernetMgr
Ethernet manager.
MotorDriver ConnectorM3
M-3 connector instance.
SerialDriver ConnectorCOM1
COM-1 connector instance.
XBeeDriver XBee
Xbee wireless.
DigitalInAnalogIn ConnectorA11
A-11 connector instance.
DigitalInOut ConnectorIO2
IO-2 connector instance.
DigitalIn ConnectorDI7
DI-7 connector instance.
DigitalIn ConnectorDI8
DI-8 connector instance.