Skip to content

Commit bc337f8

Browse files
committed
doc dependancies
1 parent 5b24d2a commit bc337f8

File tree

7 files changed

+43
-15
lines changed

7 files changed

+43
-15
lines changed

button_abs.h

+5-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
#define buttons_abs_h
66

77

8-
#include <IoAbstraction.h>
8+
#include <taskmanager.h> // davetcc/TaskManagerIO
9+
10+
#include <IoAbstraction.h> // davetcc/ioabstraction
911
#include <IoAbstractionWire.h>
1012

1113
const int interruptPin = 3; // if motor.h stalldetect, Real interrupt for io expander USES SERIAL RX!!!
@@ -26,7 +28,7 @@ int encoderThrottleDuration = 500; // how long to defer loop for encoder waits
2628

2729
bool encoderHasPress = false;
2830
bool encoderHasHold = false;
29-
bool debug_enc = false;
31+
bool debug_enc = true;
3032

3133
volatile bool PCFInterruptFlag = false;
3234

@@ -100,7 +102,7 @@ void setEncoderAccel(HWAccelerationMode accel){
100102
void init_encoder(int encoderAPin, int encoderBPin, int encoderSWPin,uint8_t addr=0){
101103

102104
if(addr){
103-
// First we set up the switches library, giving it the task manager and tell it where the pins are located
105+
// First we set up the switches library, giving it the task manager and tell it where the pins are located
104106
// We could also of chosen IO through an i2c device that supports interrupts.
105107
// the second parameter is a flag to use pull up switching, (true is pull up).
106108
if(useInt)switches.initialiseInterrupt(ioFrom8574(0x20, interruptPin), true);
@@ -127,7 +129,6 @@ void init_encoder(int encoderAPin, int encoderBPin, int encoderSWPin,uint8_t add
127129

128130
// interrupt for any
129131
// taskManager.setInterruptCallback(onInterrupt);
130-
131132

132133
// now we add the switches, we dont want the spinwheel button to repeat, so leave off the last parameter
133134
// which is the repeat interval (millis / 20 basically) Repeat button does repeat as we can see.

dependancies.txt

+30-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,34 @@ dependancies
22

33
panstamp/thermistor
44
MajenkoLibraries/Average
5-
ug82
5+
66
jackw01/PIDAutotuner
7-
luisllamasbinaburo/Arduino-Interpolation
7+
luisllamasbinaburo/Arduino-Interpolation
8+
9+
Chris--A/PrintEx (NI)
10+
bblanchon/ArduinoStreamUtils
11+
arcao/Syslog
12+
13+
davetcc/taskmanagerio
14+
davetcc/ioabstraction
15+
16+
17+
ug82
18+
Adafruit_NeoPixel
19+
20+
bblanchon/ArduinoJson
21+
knolleary/pubsubclient
22+
23+
Mottramlabs/ESP8266-Tone-Generator
24+
<Tone_Pitches.h>
25+
<MmlMusicPWM.h> // requires #include <MmlBUZZER_MUSIC.h>
26+
27+
<Adafruit_MCP4725.h>
28+
29+
soligen2010/encoder
30+
31+
"Adafruit_MAX31855.h"
32+
<ktypelinear.h>
33+
34+
// NI #include <quickstats.h> // @todo test quickstats, add child class for container
35+
// NI #include <Statistics.h> // https://github.com/provideyourown/statistics

io_utils.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#include <Wire.h>
66

77
#ifdef ESP32
8-
#include <analogWrite.h>
8+
#include <analogWrite.h> // ERROPiX/ESP32_AnalogWrite
99
#endif
1010

1111
bool swap = false;

log_syslog.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Syslog syslog(udpClient, SYSLOG_PROTO_IETF); // SYSLOG_PROTO_BSD
1919
String logTopic = "ESP";
2020
int iteration = 1;
2121

22-
#define DEVICE_HOSTNAME "my-device"
23-
#define APP_NAME "my-app"
22+
#define DEVICE_HOSTNAME "unknown-device"
23+
#define APP_NAME "unkown-app"
2424

2525
const char* syslog_hostname;
2626
const char* syslog_appname;

serialcmd.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
#define serialcmd_h
33

44
#include <temp_logger.h>
5-
#include <motor.h>
6-
#include <ssr.h>
7-
#include <pid.h>
5+
#include <motor.h> // @todo remove
6+
#include <ssr.h> // @todo remove
7+
#include <pid.h> // @todo remove
88

99
// HardwareSerial DebugOut = Serial;
1010
// HardwareSerial DebugOut(0);

snippets.h

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
// proper rollover handling
13
if (micros () - then > some_interval)
24
{
35
// do something

storage.h

-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
#include <FS.h>
55
#include <LittleFS.h>
66

7-
8-
9-
107
void listDir(const char * dirname) {
118
Serial.printf("Listing directory: %s\n", dirname);
129

0 commit comments

Comments
 (0)