Merge remote-tracking branch 'origin/dev' for 3.2.0 release

emsesp · Aug 6, 2021 · 7eb1f06 · 7eb1f06
2 parents 50459a2 + 5e4f591
commit 7eb1f06
Show file tree

Hide file tree

Showing 155 changed files with 4,393 additions and 3,135 deletions.
diff --git a/.gitignore b/.gitignore
@@ -27,4 +27,4 @@ emsesp
 /interface/build
 node_modules
 /interface/.eslintcache
-
+test.sh
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,42 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [3.2.0] August 6 2021
+
+## Added
+
+- support for IPv6 (web/api/mqtt, not syslog yet) [#83](https://github.com/emsesp/EMS-ESP32/issues/83)
+- System Log in Web UI will show current time if the NTP Service is enabled [#82](https://github.com/emsesp/EMS-ESP32/issues/82)
+- Network settings for Tx-power, WiFi-bandwidth, WiFi-sleepmode [#83](https://github.com/emsesp/EMS-ESP32/issues/83)
+- optional low CPU clockrate (160 MHz) [#83](https://github.com/emsesp/EMS-ESP32/issues/83)
+- select format for enumerated values in web
+- settings for water hysteresis on/off
+- dallas sensor name editable. `sensorname` console-command, replace sensorid with a unique name [#84](https://github.com/emsesp/EMS-ESP32/issues/84)
+- 'restart' system command. Can be invoked via API with authentication. [#87](https://github.com/emsesp/EMS-ESP32/issues/87)
+- add Download button in Web UI for log
+
+## Fixed
+
+- set mode allow numbers
+- Junkers thermostat shows mode as selected by set_mode
+- HA thermostat mode if bool-format: numbers is selected
+- Web UI System Log sometimes skipped a few log messages when watching real-time
+- fix wwactivated [#89](https://github.com/emsesp/EMS-ESP32/issues/89)
+- don't show commands (like reset) as Device values in the Web or Console
+
+## Changed
+
+- removed Rx echo failures counting as incomplete telegrams. Bad telegrams show as Warning and not Errors. [#80](https://github.com/emsesp/EMS-ESP32/issues/80)
+- add upload_sec to `api/system/info` and removed # from some names to keep consistent with MQTT heartbeat
+- added debug target to PlatformIO build to help hunt down system crashes
+- enumerated values always start at zero
+- maintenance settings for time/date as extra setting
+- move api/mqtt formats to `settings`, add `enum format`
+- UI improvements for editing Dallas Sensor details
+- RESTful GET commands can also require authentication (via bearer access token) for better security
+- Updated AsyncMqttClient to 0.9.0 and ArduinoJson to 6.18.3
+- Download buttons for settings and info under the Help tab
+
 # [3.1.1] June 26 2021
 
 ## Changed

diff --git a/CHANGELOG_LATEST.md b/CHANGELOG_LATEST.md
@@ -5,5 +5,3 @@
 ## Fixed
 
 ## Changed
-
-## Removed
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,42 +24,42 @@ This document describes rules that are in effect for this repository, meant for
 
 ## Triaging of Issues/PR's
 
-1.	Any contributor to the project can participate in the triaging process, if he/she chooses to do so.
-2.	An issue that needs to be closed, either due to not complying with this policy, or for other reasons, should be closed by a contributor.
-3.	Issues that are accepted should be marked with appropriate labels.
-4.	Issues that could impact functionality for many users should be considered severe.
-5.	Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in the documentation, for reference by users.
-6.	Issues with feature requests should be discussed for viability/desirability.
-7.	Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified.
-8.	Feature requests that are not accompanied by a PR:
-    * could be closed immediately (denied).
-    * could be closed after some predetermined period of time (left as candidate for somebody to pick up).
-9.	In some cases, feedback may be requested from the issue reporter, either as additional info for clarification, additional testing, or other. If no feedback is provided, the issue may be closed by a contributor or after 40 days by the STALE bot.
+1. Any contributor to the project can participate in the triaging process, if he/she chooses to do so.
+2. An issue that needs to be closed, either due to not complying with this policy, or for other reasons, should be closed by a contributor.
+3. Issues that are accepted should be marked with appropriate labels.
+4. Issues that could impact functionality for many users should be considered severe.
+5. Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in the documentation, for reference by users.
+6. Issues with feature requests should be discussed for viability/desirability.
+7. Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified.
+8. Feature requests that are not accompanied by a PR:
+    - could be closed immediately (denied).
+    - could be closed after some predetermined period of time (left as candidate for somebody to pick up).
+9. In some cases, feedback may be requested from the issue reporter, either as additional info for clarification, additional testing, or other. If no feedback is provided, the issue may be closed by a contributor or after 40 days by the STALE bot.
 
 ## Pull requests
 
 A Pull Request (PR) is the process where code modifications are managed in GitHub.
 
 The process is straight-forward.
 
- - Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0)
- - Fork the EMS-ESP Repository [git repository](https://github.com/emsesp/EMS-ESP32).
- - Write/Change the code in your Fork for a new feature, bug fix, new sensor, optimization, etc.
- - Ensure tests work.
- - Create a Pull Request against the [**dev**](https://github.com/emsesp/EMS-ESP32/tree/dev) branch of EMS-ESP.
+- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0)
+- Fork the EMS-ESP Repository [git repository](https://github.com/emsesp/EMS-ESP32).
+- Write/Change the code in your Fork for a new feature, bug fix, new sensor, optimization, etc.
+- Ensure tests work.
+- Create a Pull Request against the [**dev**](https://github.com/emsesp/EMS-ESP32/tree/dev) branch of EMS-ESP.
 
 1. All pull requests must be done against the dev branch.
-2. Make sure code is formatting per the `.clang-format`
-3. Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
-4. Only one feature/fix should be added per PR.
-5. PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in dev - you might need to rebase and resolve conflicts.
-6. All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
-7. All pull requests should consider updates to the documentation.
-8. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
-9. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
-10. By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
-11. Pull requests that don't meet the above will be denied and closed.
-
+2. Make sure code is formatting per the `.clang-format`.
+3. Make sure any new code is clearly commented explaining what the function/logic does.
+4. Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
+5. Only one feature/fix should be added per PR.
+6. PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in dev - you might need to rebase and resolve conflicts.
+7. All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
+8. All pull requests should consider updates to the documentation.
+9. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
+10. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
+11. By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
+12. Pull requests that don't meet the above will be denied and closed.
 
 ## Semantic Commit Messages
 
@@ -92,7 +92,7 @@ More Examples:
 
 References:
 
-- https://www.conventionalcommits.org/
+- <https://www.conventionalcommits.org/>
 
 --------------------------------------
 
@@ -139,4 +139,4 @@ A __CLA__ enables a contributor to grant "inbound" rights to a project.
 
 <Other>
 <A table should be maintained for relating maintainers and components. When triaging, this is essential to figure out if someone in particular should be consulted about specific changes.>
-<A stable release cadence should be established, e.g.: every month.>
+<A stable release cadence should be established, e.g.: every month.>
diff --git a/makefile → Makefile b/makefile → Makefile
@@ -72,9 +72,9 @@ CPPFLAGS  += -g3
 CPPFLAGS  += -Os
 
 CFLAGS    += $(CPPFLAGS)
-# CFLAGS    += -Wall
-# CFLAGS    += -Wno-unused -Wno-restrict
-# CFLAGS    += -Wextra
+CFLAGS    += -Wall
+CFLAGS    += -Wno-unused -Wno-restrict
+CFLAGS    += -Wextra
 
 CXXFLAGS  += $(CFLAGS) -MMD
 

diff --git a/esp32_partition_app1984k_spiffs64k.csv b/esp32_partition_app1984k_spiffs64k.csv
@@ -1,6 +1,6 @@
-# Name,   Type, SubType, Offset,  Size, Flags
-nvs,      data, nvs,     0x9000,  0x5000,
-otadata,  data, ota,     0xe000,  0x2000,
-app0,     app,  ota_0,   0x10000, 0x1F0000,
+# Name,   Type, SubType, Offset,   Size,    Flags
+nvs,      data, nvs,     0x9000,   0x5000,
+otadata,  data, ota,     0xE000,   0x2000,
+app0,     app,  ota_0,   0x10000,  0x1F0000,
 app1,     app,  ota_1,   0x200000, 0x1F0000,
-spiffs,   data, spiffs,  0x3F0000,0x10000,
+spiffs,   data, spiffs,  0x3F0000, 0x10000,
diff --git a/esp32_partition_debug.csv b/esp32_partition_debug.csv
@@ -0,0 +1,5 @@
+# Name,   Type, SubType, Offset,  Size, Flags
+nvs,      data, nvs,     0x9000,  0x5000,
+otadata,  data, ota,     0xE000,  0x2000,
+app0,     app,  ota_0,   0x10000, 0x210000,
+spiffs,   data, spiffs,  0x220000, 0x10000,
diff --git a/interface/src/api/Env.ts b/interface/src/api/Env.ts
@@ -4,6 +4,7 @@ export const PROJECT_PATH = process.env.REACT_APP_PROJECT_PATH!;
 export const ENDPOINT_ROOT = calculateEndpointRoot('/rest/');
 export const WEB_SOCKET_ROOT = calculateWebSocketRoot('/ws/');
 export const EVENT_SOURCE_ROOT = calculateEndpointRoot('/es/');
+export const API_ENDPOINT_ROOT = calculateEndpointRoot('/api/');
 
 function calculateEndpointRoot(endpointPath: string) {
   const httpRoot = process.env.REACT_APP_HTTP_ROOT;

diff --git a/interface/src/mqtt/MqttSettingsForm.tsx b/interface/src/mqtt/MqttSettingsForm.tsx
@@ -109,7 +109,7 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
         />
         <TextField
           name="client_id"
-          label="Client ID (optional)"
+          label="Client ID"
           fullWidth
           variant="outlined"
           value={data.client_id}
@@ -159,7 +159,7 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
               value="clean_session"
             />
           }
-          label="Clean Session"
+          label="Set Clean Session"
         />
         <BlockFormControlLabel
           control={
@@ -169,7 +169,7 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
               value="mqtt_retain"
             />
           }
-          label="Retain Flag"
+          label="Use Retain Flag"
         />
         <br></br>
         <Typography variant="h6" color="primary">
@@ -184,34 +184,8 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
           onChange={handleValueChange('nested_format')}
           margin="normal"
         >
-          <MenuItem value={1}>nested on a single topic</MenuItem>
-          <MenuItem value={2}>as individual topics</MenuItem>
-        </SelectValidator>
-        <SelectValidator
-          name="dallas_format"
-          label="Dallas Sensor Payload Grouping"
-          value={data.dallas_format}
-          fullWidth
-          variant="outlined"
-          onChange={handleValueChange('dallas_format')}
-          margin="normal"
-        >
-          <MenuItem value={1}>by Sensor ID</MenuItem>
-          <MenuItem value={2}>by Number</MenuItem>
-        </SelectValidator>
-        <SelectValidator
-          name="bool_format"
-          label="Boolean Format"
-          value={data.bool_format}
-          fullWidth
-          variant="outlined"
-          onChange={handleValueChange('bool_format')}
-          margin="normal"
-        >
-          <MenuItem value={1}>"on"/"off"</MenuItem>
-          <MenuItem value={2}>true/false</MenuItem>
-          <MenuItem value={3}>1/0</MenuItem>
-          <MenuItem value={4}>"ON"/"OFF"</MenuItem>
+          <MenuItem value={1}>Nested on a single topic</MenuItem>
+          <MenuItem value={2}>As individual topics</MenuItem>
         </SelectValidator>
         <SelectValidator
           name="subscribe_format"
@@ -222,9 +196,9 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
           onChange={handleValueChange('subscribe_format')}
           margin="normal"
         >
-          <MenuItem value={0}>general device topic</MenuItem>
-          <MenuItem value={1}>individual topics, main heating circuit</MenuItem>
-          <MenuItem value={2}>individual topics, all heating circuits</MenuItem>
+          <MenuItem value={0}>General device topic</MenuItem>
+          <MenuItem value={1}>Individual topics, main heating circuit</MenuItem>
+          <MenuItem value={2}>Individual topics, all heating circuits</MenuItem>
         </SelectValidator>
         <BlockFormControlLabel
           control={
@@ -246,9 +220,9 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
             onChange={handleValueChange('ha_climate_format')}
             margin="normal"
           >
-            <MenuItem value={1}>use Current temperature (default)</MenuItem>
-            <MenuItem value={2}>use Setpoint temperature</MenuItem>
-            <MenuItem value={3}>Fix to 0</MenuItem>
+            <MenuItem value={1}>Use Current temperature</MenuItem>
+            <MenuItem value={2}>Use Setpoint temperature</MenuItem>
+            <MenuItem value={3}>Always set to 0</MenuItem>
           </SelectValidator>
         )}
         <br></br>

diff --git a/interface/src/mqtt/types.ts b/interface/src/mqtt/types.ts
@@ -34,8 +34,6 @@ export interface MqttSettings {
   publish_time_mixer: number;
   publish_time_other: number;
   publish_time_sensor: number;
-  dallas_format: number;
-  bool_format: number;
   mqtt_qos: number;
   mqtt_retain: boolean;
   ha_enabled: boolean;

diff --git a/interface/src/network/NetworkSettingsForm.tsx b/interface/src/network/NetworkSettingsForm.tsx
@@ -51,7 +51,11 @@ class NetworkSettingsForm extends React.Component<NetworkStatusFormProps> {
         ssid: selectedNetwork.ssid,
         password: '',
         hostname: props.data.hostname,
-        static_ip_config: false
+        static_ip_config: false,
+        enableIPv6: false,
+        bandwidth20: false,
+        tx_power: 20,
+        nosleep: false
       };
       props.setData(networkSettings);
     }
@@ -145,6 +149,53 @@ class NetworkSettingsForm extends React.Component<NetworkStatusFormProps> {
           onChange={handleValueChange('hostname')}
           margin="normal"
         />
+        <TextValidator
+          validators={['required', 'isNumber', 'minNumber:0', 'maxNumber:20']}
+          errorMessages={[
+            'Tx Power is required',
+            'Must be a number',
+            'Must be greater than 0dBm ',
+            'Max value is 20dBm'
+          ]}
+          name="tx_power"
+          label="WiFi Tx Power (dBm)"
+          fullWidth
+          variant="outlined"
+          value={data.tx_power}
+          type="number"
+          onChange={handleValueChange('tx_power')}
+          margin="normal"
+        />
+        <BlockFormControlLabel
+          control={
+            <Checkbox
+              value="enableIPv6"
+              checked={data.enableIPv6}
+              onChange={handleValueChange('enableIPv6')}
+            />
+          }
+          label="Enable IPv6 support"
+        />
+        <BlockFormControlLabel
+          control={
+            <Checkbox
+              value="bandwidth20"
+              checked={data.bandwidth20}
+              onChange={handleValueChange('bandwidth20')}
+            />
+          }
+          label="Use Lower WiFi Bandwidth"
+        />
+        <BlockFormControlLabel
+          control={
+            <Checkbox
+              value="nosleep"
+              checked={data.nosleep}
+              onChange={handleValueChange('nosleep')}
+            />
+          }
+          label="Disable WiFi Sleep Mode"
+        />
         <BlockFormControlLabel
           control={
             <Checkbox
@@ -153,7 +204,7 @@ class NetworkSettingsForm extends React.Component<NetworkStatusFormProps> {
               onChange={handleValueChange('static_ip_config')}
             />
           }
-          label="Static IP Config"
+          label="Use Static IPs"
         />
         {data.static_ip_config && (
           <Fragment>

diff --git a/interface/src/network/NetworkStatusForm.tsx b/interface/src/network/NetworkStatusForm.tsx
@@ -40,7 +40,22 @@ class NetworkStatusForm extends Component<NetworkStatusFormProps> {
     if (!status.dns_ip_1) {
       return 'none';
     }
-    return status.dns_ip_1 + (status.dns_ip_2 ? ',' + status.dns_ip_2 : '');
+    if (!status.dns_ip_2 || status.dns_ip_2 === '0.0.0.0') {
+      return status.dns_ip_1;
+    }
+    return status.dns_ip_1 + ', ' + status.dns_ip_2;
+  }
+  IPs(status: NetworkStatus) {
+    if (
+      !status.local_ipv6 ||
+      status.local_ipv6 === '0000:0000:0000:0000:0000:0000:0000:0000'
+    ) {
+      return status.local_ip;
+    }
+    if (!status.local_ip || status.local_ip === '0.0.0.0') {
+      return status.local_ipv6;
+    }
+    return status.local_ip + ', ' + status.local_ipv6;
   }
 
   createListItems() {
@@ -77,7 +92,7 @@ class NetworkStatusForm extends Component<NetworkStatusFormProps> {
               <ListItemAvatar>
                 <Avatar>IP</Avatar>
               </ListItemAvatar>
-              <ListItemText primary="IP Address" secondary={data.local_ip} />
+              <ListItemText primary="IP Address" secondary={this.IPs(data)} />
             </ListItem>
             <Divider variant="inset" component="li" />
             <ListItem>