Reorganizing library structure, prep for 2.0.0

2016-07-09 21:17:37 +02:00
parent 4811eb5573
commit ba6bb915c2
1020 changed files with 5 additions and 143645 deletions
@@ -0,0 +1,101 @@
+/*
+ * The MySensors Arduino library handles the wireless radio link and protocol
+ * between your home built sensors/actuators and HA controller of choice.
+ * The sensors forms a self healing radio network with optional repeaters. Each
+ * repeater and gateway builds a routing tables in EEPROM which keeps track of the
+ * network topology allowing messages to be routed to nodes.
+ *
+ * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
+ * Copyright (C) 2013-2016 Sensnology AB
+ * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+ *
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ */
+
+#ifndef MyOTAFirmwareUpdate_h
+#define MyOTAFirmwareUpdate_h
+
+#include "MySensorsCore.h"
+
+// Size of each firmware block
+#define FIRMWARE_BLOCK_SIZE	16
+// Number of times a firmware block should be requested before giving up
+#define FIRMWARE_MAX_REQUESTS 5
+// Number of times to request a fw block before giving up
+#define MY_OTA_RETRY 5
+// Number of millisecons before re-request a fw block
+#define MY_OTA_RETRY_DELAY 500
+// Start offset for firmware in flash (DualOptiboot wants to keeps a signature first)
+#define FIRMWARE_START_OFFSET 10
+// Bootloader version
+#define MY_OTA_BOOTLOADER_MAJOR_VERSION 3
+#define MY_OTA_BOOTLOADER_MINOR_VERSION 0
+#define MY_OTA_BOOTLOADER_VERSION (MY_OTA_BOOTLOADER_MINOR_VERSION * 256 + MY_OTA_BOOTLOADER_MAJOR_VERSION)
+
+
+/// @brief FW config structure, stored in eeprom
+typedef struct {
+	uint16_t type; //!< Type of config
+	uint16_t version; //!< Version of config
+	uint16_t blocks; //!< Number of blocks
+	uint16_t crc; //!< CRC of block data
+} __attribute__((packed)) NodeFirmwareConfig;
+
+/// @brief FW config request structure
+typedef struct {
+	uint16_t type; //!< Type of config
+	uint16_t version; //!< Version of config
+	uint16_t blocks; //!< Number of blocks
+	uint16_t crc; //!< CRC of block data
+	uint16_t BLVersion; //!< Bootloader version
+} __attribute__((packed)) RequestFirmwareConfig;
+
+/// @brief FW block request structure
+typedef struct {
+	uint16_t type; //!< Type of config
+	uint16_t version; //!< Version of config
+	uint16_t block; //!< Block index
+} __attribute__((packed)) RequestFWBlock;
+
+/// @brief FW block reply structure
+typedef struct {
+	uint16_t type; //!< Type of config
+	uint16_t version; //!< Version of config
+	uint16_t block; //!< Block index
+	uint8_t data[FIRMWARE_BLOCK_SIZE]; //!< Block data
+} __attribute__((packed)) ReplyFWBlock;
+
+
+/**
+ * @brief Read firmware settings from EEPROM
+ *
+ * Current firmware settings (type, version, crc, blocks) are read into _fc
+ */
+void readFirmwareSettings();
+/**
+ * @brief Handle OTA FW update requests
+ */
+ void firmwareOTAUpdateRequest();
+/**
+ * @brief Handle OTA FW update responses
+ *
+ * This function handles incoming OTA FW packets and stores them to external flash (Sensebender)
+ */
+bool firmwareOTAUpdateProcess();
+/**
+ * @brief Validate uploaded FW CRC
+ *
+ * This function verifies if uploaded FW CRC is valid
+ */
+bool transportIsValidFirmware();
+/**
+ * @brief Present bootloader/FW information upon startup 
+ */
+void presentBootloaderInformation();
+
+#endif