Initial

Author: mthorley

images/bin2header.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+"""
+Python program to take any file and output a C header file (suitable
+for Arduino use) containing the same binary data that was in the file.
+
+This is particularly useful for embedding .BMP images in sketches for
+use with FTOLED.
+
+Formats the binary data nicely so you can read back values by hand if
+you ever need to.
+
+** Requirements **
+Python 3. You can download it from http://python.org
+
+** Usage **
+bin2header.py <input file> [<output file>]
+
+Output file is optional and defaults to the name of the input file,
+with the extension changed to .h.
+
+bin2header.py was written by Angus Gratton.
+Copyright 2013 Freetronics Pty Ltd.
+
+This program is free software: you can redistribute it and/or modify it under the terms
+of the version 3 GNU General Public License as published by the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program.
+If not, see <http://www.gnu.org/licenses/>.
+
+"""
+import argparse, sys, re, os.path
+
+TEMPLATE = """
+// Generated with bin2header.py by Freetronics
+// Source file name: %SOURCE%
+
+#include <stdint.h>
+
+#ifdef __AVR__
+#define _PGM_ PROGMEM
+#else
+#define _PGM_
+#endif
+
+%WARNING%
+
+static const uint8_t %ITEMNAME%[] _PGM_ = {
+%CONTENT%
+};
+
+%WARNING_FOOTER%
+"""
+
+WARNING_TEMPLATE = """
+#ifdef __AVR__
+#error The binary content is too large (>=32kb) to hold in a single array when targeting an AVR-based Arduino. This header will work on ARM-based Arduinos (Arduino Due), though.
+#else
+"""
+
+WARNING_FOOTER = """
+#endif
+"""
+
+parser = argparse.ArgumentParser(description="Process a binary file")
+parser.add_argument('input', type=argparse.FileType('rb'), help="Input binary file")
+parser.add_argument('output', type=argparse.FileType('wb'), help="Output binary file", nargs="?")
+
+def bin2header(source, destination):
+    content = source.read()
+    source_len = len(content)
+    as_hex = [ ("0x%02x" % b) for b in content ]
+    content = ""
+    offset = 0
+    for chunk in chunk_by(as_hex, 16):
+        content += "    /* 0x%04x: */ " % offset
+        content += ", ".join(chunk)
+        content += ",\n"
+        offset += 16
+    output = TEMPLATE
+    output = output.replace("%CONTENT%", content)
+    output = output.replace("%SOURCE%", sys.argv[1])
+    if source_len < 32768:
+        output = output.replace("%WARNING%", "")
+        output = output.replace("%WARNING_FOOTER%", "")
+    else:
+        output = output.replace("%WARNING%", WARNING_TEMPLATE)
+        output = output.replace("%WARNING_FOOTER%", WARNING_FOOTER)
+        print("WARNING: The binary file is too large (%dkb >= 32kb) to be compiled in this way on an AVR-based platform. It will still work on an ARM-based platforms (ie Arduino Due), though."
+              % (source_len/1024,))
+    itemname = re.sub(r'[^a-zA-Z0-9]', '_',  os.path.splitext(os.path.basename(destination.name))[0])
+    output = output.replace("%ITEMNAME%", itemname)
+    destination.write(bytes(output, 'UTF-8'))
+
+def chunk_by(seq, chunk_size):
+    """ Yield successive chunks of length chunk_size from seq. """
+    for i in range(0, len(seq), chunk_size):
+        yield seq[i:i+chunk_size]
+
+
+if __name__ == "__main__":
+    args = parser.parse_args()
+    output = args.output
+    if output is None:
+        path = os.path.splitext(args.input.name)[0] + ".h"
+        output = open(path, "wb")
+    bin2header(args.input, output)
+

images/oled7seg-0-24bit-19x25.bmp

@@ -0,0 +1,41 @@
+#ifndef _ARDUINO_FANCONTROL_H
+#define _ARDUINO_FANCONTROL_H
+
+#include <TimerOne.h>
+#include <TimerThree.h>
+#include "FanControl.h"
+
+class ArduinoFanControl : public FanControl
+{
+public:
+    // constructors
+    ArduinoFanControl(const uint8_t fans);
+
+    virtual RESULT initialise();
+    virtual RESULT setPWMForAll(const uint16_t dutyCycle);
+    virtual RESULT setPWM(const uint8_t fanid, const uint16_t dutyCycle);
+    virtual RESULT getTachCount(const uint8_t fanid, uint16_t& tachCount);
+
+private:
+    void measureTach(const uint8_t fanid, unsigned long ms);
+    float getTach(const uint8_t fanid, unsigned long ms);
+
+    uint16_t _pwmPeriod;
+  
+    // drives PWM PINs
+    // based on https://github.com/PaulStoffregen/TimerOne/blob/master/config/known_16bit_timers.h 
+    const char PIN_FAN1_T1 = 11; // Timer1
+    const char PIN_FAN2_T1 = 12; // Timer1
+    const char PIN_FAN3_T3 = 5;  // Timer3
+    const char PIN_FAN4_T3 = 3;  // Timer3
+
+    // interrupts for TACH input
+    // see https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt/
+    const char PIN_TACH1 = 21;
+    const char PIN_TACH2 = 20;
+    const char PIN_TACH3 = 19;
+    const char PIN_TACH4 = 18;
+
+};
+
+#endif

images/oled7seg-0-24bit-38x50.bmp

@@ -0,0 +1,26 @@
+#ifndef __ERR_CODES_H
+#define __ERR_CODES_H
+
+// err codes
+typedef int RESULT;
+#define RES_OK                     0
+
+// I2C for MAX
+#define ERR_BAD_TRANSMISSION      -1
+#define ERR_BAD_READ              -2
+#define ERR_BAD_PARAM             -3
+
+// DS18B
+#define ERR_FAILED_TO_READ_TEMP   -10
+#define ERR_FAILED_TO_FIND_DEVICE -11
+
+// Ethernet
+#define ERR_FAILED_TO_GET_IP_FROM_DHCP -20
+#define ERR_NO_ETHERNET_HW             -21
+#define ERR_NO_CABLE_DETECTED          -22
+
+// Fanstate
+#define ERR_FAN_NOT_OPERATIONAL -30
+#define ERR_FAN_TACH            -31
+
+#endif

images/oled7seg-1-24bit-19x25.bmp

@@ -0,0 +1,46 @@
+#ifndef _FAN_CONTROL_H
+#define _FAN_CONTROL_H
+
+#include <Arduino.h>
+#include <ArduinoLog.h>
+#include "ErrCodes.h"
+
+#define MAX_DUTY_CYCLE 100  // %
+#define MIN_DUTY_CYCLE 0
+
+// assertions
+#define ASSERT_RANGE(var, min, max, msg) if(var<min || var>max) { \
+    Log.error(F(msg)); \
+    return ERR_BAD_PARAM; \
+}
+
+#define ASSERT_RANGE_DUTY_CYCLE(var) ASSERT_RANGE( \
+    var, MIN_DUTY_CYCLE, MAX_DUTY_CYCLE, "Duty cycle is out of range")
+
+#define ASSERT_RANGE_FAN_ID(var, fans) ASSERT_RANGE(\
+    var, 1, fans, "Fanid out of range")
+
+/**
+ * Abstract base class for all Fan Control. 
+ * Sub types include Arduino and MAX31790 classes. 
+ */
+class FanControl
+{
+public:
+    FanControl(const uint8_t fans) : 
+        _fans(fans) {};
+
+    virtual RESULT initialise() = 0;
+    virtual RESULT setPWMForAll(const uint16_t dutyCycle) = 0;
+    virtual RESULT setPWM(const uint8_t fanid, const uint16_t dutyCycle) = 0;
+    virtual RESULT getTachCount(const uint8_t fanid, uint16_t& tachCount) = 0;
+
+    const uint8_t getFanCount() const {
+        return _fans;
+    };
+
+private:
+    uint8_t _fans; // total number of fans to control
+};
+
+#endif

images/oled7seg-1-24bit-38x50.bmp

@@ -0,0 +1,100 @@
+#ifndef _MAX31790_FANCONTROL_H
+#define _MAX31790_FANCONTROL_H
+
+#include "FanControl.h"
+
+// registers
+#define GLOBAL_CONFIG_REG     0x00
+#define PWM_FREQ 			  0x01
+#define FAN_CONFIG(ch)		  (0x02+(ch-1))
+#define FAN_DYNAMICS(ch) 	  (0x08+(ch-1))
+
+#define TACH_COUNT(ch)		         (0x18+(ch-1)*2)
+#define PWM_DUTY_CYCLE(ch)	         (0x30+(ch-1)*2)
+#define PWMOUT_TARGET_DUTY_CYCLE(ch) (0x40+(ch-1)*2)
+#define TACH_TARGET(ch)		         (0x50+(ch-1)*2)
+
+#define MAX_DUTY_CYCLE_SCALE 511    // range is 0-511 
+
+/**
+ * Global Configuration
+ * I2C watchdog setting 
+ */
+enum I2CWatchDogEnum 
+{
+    Disabled  = 0, 
+    FiveSec   = 1, 
+    TenSec    = 2, 
+    ThirtySec = 3
+};
+
+enum OscillatorEnum 
+{
+    Internal         = 0, 
+    External_Crystal = 1
+};
+  
+struct GlobalConfig
+{
+    GlobalConfig(
+        bool standBy_Not_Run       = 0,
+        bool not_Bus_Timeout       = 0,
+        OscillatorEnum oscillator  = OscillatorEnum::Internal,
+        I2CWatchDogEnum watchDog   = I2CWatchDogEnum::Disabled)
+    : 
+        standBy_Not_Run(standBy_Not_Run), 
+        normal_Not_Reset(0),
+        not_Bus_Timeout(not_Bus_Timeout),
+        oscillator(oscillator),
+        watchDog(watchDog) {};
+ 
+    bool            standBy_Not_Run:1;    // 0 = Run - D7
+    bool            normal_Not_Reset:1;   // 0 = Normal
+    bool            not_Bus_Timeout:1;    // 0 = Enabled
+    bool            reserved:1;
+    OscillatorEnum  oscillator:1;
+    I2CWatchDogEnum watchDog:2;       
+    bool            watchDogStatus:1;     // 1 = watchdog fault detected
+};
+
+// @TODO:
+typedef struct {
+
+} FanConfigStruct;
+
+class MAX31790 : public FanControl
+{
+public:
+
+    // constructors
+    MAX31790(const uint8_t i2cAddress, const uint8_t fans);
+
+    virtual RESULT initialise();    
+    virtual RESULT setPWMForAll(const uint16_t dutyCycle);
+    virtual RESULT setPWM(const uint8_t fanid, const uint16_t dutyCycle);
+    virtual RESULT getTachCount(const uint8_t fanid, uint16_t& tachCount);
+
+    RESULT getGlobalConfiguration(GlobalConfig& config);
+    //RESULT setGlobalConfiguration(const GlobalConfig& config);
+    //RESULT setFanConfigForAll(const FanConfigStruct& config);
+
+    // utility to scan for all i2c devices 
+    void scanForI2C();
+    
+    // accessors
+    uint8_t getDeviceAddress() {
+        return _deviceAddress;
+    };
+
+private:
+    RESULT readByte(const uint8_t address, uint8_t& result);
+    RESULT readBytes(const uint8_t address, const uint8_t n, uint8_t* result);    
+    RESULT writeByte(const uint8_t address, const uint8_t byte);
+    RESULT writeBytes(const uint8_t address, const uint8_t* bytes, const uint8_t nBytes);
+    
+    uint16_t scaleDutyCycle(const uint16_t dutyCycle) const;
+
+    uint8_t _deviceAddress; // device address - note this is 7bit
+};
+
+#endif 

images/oled7seg-2-24bit-19x25.bmp

@@ -0,0 +1,51 @@
+#include "RackTempController.h"
+#include <Ethernet.h>
+#include <ArduinoMqttClient.h>
+#include <Print.h>
+
+/**
+ * Wrapper class for MQTT and Logging framework
+ */ 
+class MqttPublisher : public Print {
+
+public:
+    MqttPublisher(EthernetClient& ethClient, const char* clientID, const char* serverIP, const uint16_t port) :
+        _mqttClient(ethClient),
+        _clientID(clientID),
+        _serverIP(serverIP),
+        _port(port) {};
+
+    void initialise();
+
+    void publish(RackState_t& rs);
+
+    void poll();
+
+    /**
+     * From Print.h
+     */
+    size_t write(uint8_t c);
+    
+private:
+    void sendMessage(const String& topic, const String& msg);
+
+    MqttClient _mqttClient;
+
+    const String   _clientID;   // client identifier
+    const String   _serverIP;   // mqtt server IP endpoint
+    const uint16_t _port;       // mqtt server port
+    String         _buf;        // log buffer    
+
+    const String topicTempRackTop  = "/device/temp/rack/top";
+    const String topicTempRackBase = "/device/temp/rack/base";
+    const String topicTempRackAve  = "/device/temp/rack/average";
+    
+    const String topicFanTopLeft   = "/device/rack/fan/topleft";
+    const String topicFanTopRight  = "/device/rack/fan/topright";
+    const String topicFanBaseLeft  = "/device/rack/fan/baseleft";
+    const String topicFanBaseRight = "/device/rack/fan/baseright";
+
+    const String topicRackLog     = "/device/rack/log";
+    const String subtopicFanError = "/error";
+    const String subtopicFanRPM   = "/rpm";
+};