mirror of https://github.com/arendst/Tasmota.git
Theo Arends
parent
624ee28db3
commit
6c61cdead7
12
README.md
12
README.md
|
|
@ -15,7 +15,7 @@ If you like **Sonoff-Tasmota**, give it a star, or fork it and contribute!
|
|||
### Development
|
||||
[](https://travis-ci.org/arendst/Sonoff-Tasmota)
|
||||
|
||||
Current version is **6.1.1.x** - See [sonoff/_releasenotes.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_releasenotes.ino) for release information and [sonoff/_changelog.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_changelog.ino) for change information.
|
||||
Current version is **6.1.1.x** - See [RELEASENOTES.md](https://github.com/arendst/Sonoff-Tasmota/blob/development/RELEASENOTES.md) for release information and [sonoff/_changelog.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_changelog.ino) for change information.
|
||||
|
||||
### Disclaimer
|
||||
:warning: **DANGER OF ELECTROCUTION** :warning:
|
||||
|
|
@ -90,15 +90,6 @@ The following devices are supported:
|
|||
- [Luani HVIO board](https://luani.de/projekte/esp8266-hvio/)
|
||||
- Wemos D1 mini, NodeMcu and Ledunia
|
||||
|
||||
### Firmware Release Information
|
||||
Different firmware images are released based on Features and Sensors selection guided by code and memory usage. All versions support web based WIFI manager configuration.
|
||||
|
||||
- The Minimal version allows intermediate OTA uploads to support larger versions and does NOT change any persistent parameter. This version should **NOT be used for initial installation**.
|
||||
- The Classic version allows **initial installation** and single OTA uploads.
|
||||
- The Sonoff version removes WPS and SmartConfig configuration and allows more sensors.
|
||||
- The Sensors version removes WPS and SmartConfig configuration and allows more usefull sensors.
|
||||
- The Knx version removes WPS and SmartConfig configuration and some other features but adds KNX support.
|
||||
|
||||
#### Available Features and Sensors
|
||||
|
||||
| Feature or Sensor | sonoff | classic | minimal | knx | sensors |
|
||||
|
|
@ -188,6 +179,7 @@ You can contribute to Sonoff-Tasmota by
|
|||
#### Libraries Used
|
||||
Libraries used with Sonoff-Tasmota are:
|
||||
- [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)
|
||||
- [Adafruit CCS811](https://github.com/adafruit/Adafruit_CCS811)
|
||||
- [Adafruit SGP30](https://github.com/adafruit/Adafruit_SGP30)
|
||||
- [ArduinoJson](https://arduinojson.org/)
|
||||
- [Bosch BME680](https://github.com/BoschSensortec/BME680_driver)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
## Migration Information
|
||||
See [wiki migration path](https://github.com/arendst/Sonoff-Tasmota/wiki/Upgrade#migration-path) for instructions how to migrate to a major version. Pay attention to the following version breaks due to dynamic settings updates:
|
||||
|
||||
1. Migrate to **Sonoff-Tasmota 3.9.x**
|
||||
2. Migrate to **Sonoff-Tasmota 4.x**
|
||||
3. Migrate to **Sonoff-Tasmota 5.14**
|
||||
4. Migrate to **Sonoff-Tasmota 6.x**
|
||||
|
||||
## Release notes
|
||||
### Change in default initial configuration tool
|
||||
Firmware binary **sonoff-classic.bin** supports **WifiManager, Wps and SmartConfig** for initial configuration. The default tools is Wps.
|
||||
|
||||
To save memory space all other binaries support **WifiManager only**.
|
||||
|
||||
See _changelog.ino how to enable them again.
|
||||
- Define WIFI_CONFIG_TOOL now contains the default behaviour once a SSID has been configured.
|
||||
- If no SSID is configured making a wifi connection impossible the new define WIFI_CONFIG_NO_SSID will be used.
|
||||
- While define WIFI_CONFIG_NO_SSID is set to WIFI_WPSCONFIG in user_config.h the compiler will check for define USE_WPS and if not enabled WIFI_CONFIG_NO_SSID will default to WIFI_MANAGER using the webserver. If define USE_WEBSERVER is also not enabled WIFI_CONFIG_NO_SSID will default to WIFI_SMARTCONFIG. If define USE_SMARTCONFIG is also not enabled WIFI_CONFIG_NO_SSID will default to a new option WIFI_SERIAL allowing to enter wifi parameters to serial which is always possible.
|
||||
|
||||
## Provided Binary Downloads
|
||||
The following binary downloads have been compiled with ESP8266/Arduino library version **2.3.0**
|
||||
|
||||
- **sonoff-minimal.bin** = The Minimal version allows intermediate OTA uploads to support larger versions and does NOT change any persistent parameter. This version **should NOT be used for initial installation**.
|
||||
- **sonoff-classic.bin** = The Classic version allows **initial installation** using either WifiManager, Wps or SmartConfig.
|
||||
- **sonoff.bin** = The Sonoff version without Wps and SmartConfig configuration but adds more sensors.
|
||||
- **sonoff-BG.bin** to **sonoff-TW.bin** = The Sonoff version without Wps and SmartConfig configuration in different languages.
|
||||
- **sonoff-sensors.bin** = The Sensors version without Wps and SmartConfig configuration but adds even more useful sensors.
|
||||
- **sonoff-knx.bin** = The Knx version without Wps and SmartConfig configuration and some other features but adds KNX support.
|
||||
|
||||
See [Tasmota ESP/Arduino library version related issues](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips#20180523---relation-tasmota-and-esp8266arduino-core-version) why these files are still released using ESP/Arduino library version v2.3.0.
|
||||
|
||||
## Changelog
|
||||
Version 6.2.0 20180901
|
||||
|
||||
tbd
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
/*
|
||||
6.1.1b 20180715
|
||||
** Change default initial wifi config tool **
|
||||
Default initial wifi config tool has changed from WPS to Wifi Manager (local Access Point).
|
||||
Both WPS and Wifi Smartconfig are now optional and are disabled in user_config.h saving a massive 66k of code space.
|
||||
See _changelog.ino how to enable them again.
|
||||
Define WIFI_CONFIG_TOOL now contains the default behaviour once a SSID has been configured.
|
||||
If no SSID is configured making a wifi connection impossible the new define WIFI_CONFIG_NO_SSID will be used.
|
||||
While define WIFI_CONFIG_NO_SSID is set to WIFI_WPSCONFIG in user_config.h the compiler will check for define USE_WPS and if not enabled
|
||||
WIFI_CONFIG_NO_SSID will default to WIFI_MANAGER using the webserver. If define USE_WEBSERVER is also not enabled
|
||||
WIFI_CONFIG_NO_SSID will default to WIFI_SMARTCONFIG. If define USE_SMARTCONFIG is also not enabled
|
||||
WIFI_CONFIG_NO_SSID will default to a new option WIFI_SERIAL allowing to enter wifi parameters to serial which is always possible.
|
||||
|
||||
** Introduction _changelog.ino **
|
||||
Finally the changes can be found in a changelog where they belong. Release info will now be in _releasenotes.ino
|
||||
*/
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
|
||||
#define PARAM8_SIZE 18 // Number of param bytes (SetOption)
|
||||
|
||||
typedef union { // Restricted by MISRA-C Rule 18.4 but so usefull...
|
||||
typedef union { // Restricted by MISRA-C Rule 18.4 but so useful...
|
||||
uint32_t data; // Allow bit manipulation using SetOption
|
||||
struct { // SetOption0 .. SetOption31
|
||||
uint32_t save_state : 1; // bit 0
|
||||
|
|
@ -60,7 +60,7 @@ typedef union { // Restricted by MISRA-C Rule 18.4 bu
|
|||
};
|
||||
} SysBitfield;
|
||||
|
||||
typedef union { // Restricted by MISRA-C Rule 18.4 but so usefull...
|
||||
typedef union { // Restricted by MISRA-C Rule 18.4 but so useful...
|
||||
uint32_t data; // Allow bit manipulation using SetOption
|
||||
struct { // SetOption50 .. SetOption81
|
||||
uint32_t timers_enable : 1; // bit 0 (v6.1.1b)
|
||||
|
|
@ -371,7 +371,7 @@ struct XDRVMAILBOX {
|
|||
} XdrvMailbox;
|
||||
|
||||
#define MAX_RULES_FLAG 7 // Number of bits used in RulesBitfield (tricky I know...)
|
||||
typedef union { // Restricted by MISRA-C Rule 18.4 but so usefull...
|
||||
typedef union { // Restricted by MISRA-C Rule 18.4 but so useful...
|
||||
uint16_t data; // Allow bit manipulation
|
||||
struct {
|
||||
uint16_t system_boot : 1;
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ void KNX_CB_Action(message_t const &msg, void *arg);
|
|||
|
||||
/*********************************************************************************************\
|
||||
* [sonoff-sensors.bin]
|
||||
* Provide an image with usefull supported sensors enabled
|
||||
* Provide an image with useful supported sensors enabled
|
||||
\*********************************************************************************************/
|
||||
|
||||
#ifdef USE_SENSORS
|
||||
|
|
|
|||
|
|
@ -373,10 +373,10 @@
|
|||
//#define USE_CLASSIC // Create sonoff-classic (See sonoff_post.h for selected features)
|
||||
|
||||
/*********************************************************************************************\
|
||||
* Select usefull sensors - overrides above undefines!!
|
||||
* Select useful sensors - overrides above undefines!!
|
||||
\*********************************************************************************************/
|
||||
|
||||
//#define USE_SENSORS // Create sonoff-sensors with usefull sensors enabled (See sonoff_post.h for selected sensors)
|
||||
//#define USE_SENSORS // Create sonoff-sensors with useful sensors enabled (See sonoff_post.h for selected sensors)
|
||||
|
||||
/*********************************************************************************************\
|
||||
* Select KNX without Emulation to save space
|
||||
|
|
|
|||
Loading…
Reference in New Issue