From f2b53a6d5336b6b51821b2e9b026e95d3b3c3f75 Mon Sep 17 00:00:00 2001 From: rjwats Date: Tue, 7 Jul 2020 00:13:38 +0100 Subject: [PATCH] Consistency fixes (#167) Minor consistency fixes from @proddy's comments --- README.md | 5 +++-- factory_settings.ini | 4 ++-- interface/package-lock.json | 6 +++--- interface/package.json | 2 +- interface/src/SignIn.tsx | 10 +++++----- interface/src/ap/APSettingsForm.tsx | 4 ++-- .../src/authentication/AuthenticatedRoute.tsx | 2 +- .../src/authentication/Authentication.ts | 20 +++++++++---------- .../src/components/FullScreenLoading.tsx | 2 +- interface/src/components/RestController.tsx | 4 ++-- interface/src/project/DemoInformation.tsx | 6 +++--- .../src/security/SecuritySettingsForm.tsx | 2 +- src/LightStateService.cpp | 6 +++--- src/LightStateService.h | 2 +- 14 files changed, 38 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index e40168d..9b3354b 100644 --- a/README.md +++ b/README.md @@ -279,7 +279,7 @@ const theme = createMuiTheme({ main: '#666', }, info: { - main: blueGrey[900] + main: blueGrey[500] }, warning: { main: orange[500] @@ -303,7 +303,7 @@ You can replace the app icon is located at ['interface/public/app/icon.png'](int ### Changing the app name -The app name displayed on the login page and on the menu bar can be modified by editing the REACT_APP_NAME property in ['interface/.env'](interface/.env) +The app name displayed on the sign in page and on the menu bar can be modified by editing the REACT_APP_NAME property in ['interface/.env'](interface/.env) ```ini REACT_APP_NAME=Funky IoT Project @@ -641,6 +641,7 @@ Configure the WiFi SSID and password manually: esp8266React.getWiFiSettingsService()->update([&](WiFiSettings& wifiSettings) { wifiSettings.ssid = "MyNetworkSSID"; wifiSettings.password = "MySuperSecretPassword"; + return StateUpdateResult::CHANGED; }, "myapp"); ``` diff --git a/factory_settings.ini b/factory_settings.ini index 6ef5ae7..5f7494f 100644 --- a/factory_settings.ini +++ b/factory_settings.ini @@ -6,8 +6,8 @@ build_flags = -D FACTORY_WIFI_HOSTNAME=\"esp-react\" ; Access point settings - -D FACTORY_AP_SSID=\"ESP8266-React\" - -D FACTORY_AP_PASSWORD=\"esp-react\" + -D FACTORY_AP_SSID=\"ESP8266-React\" ; 1-64 characters + -D FACTORY_AP_PASSWORD=\"esp-react\" ; 8-64 characters -D FACTORY_AP_PROVISION_MODE=AP_MODE_DISCONNECTED ; User credentials for admin and guest user diff --git a/interface/package-lock.json b/interface/package-lock.json index deeaa5b..c7d43fe 100644 --- a/interface/package-lock.json +++ b/interface/package-lock.json @@ -8553,9 +8553,9 @@ } }, "notistack": { - "version": "0.9.16", - "resolved": "https://registry.npmjs.org/notistack/-/notistack-0.9.16.tgz", - "integrity": "sha512-+q1KKj2XkU+mKnbp9PbVkRLSLfVYnPJGi+MHT+N9Pm3nZUMVtbjDFodwdv/RoEldvkXKCROnecayUFMwLOiIQA==", + "version": "0.9.17", + "resolved": "https://registry.npmjs.org/notistack/-/notistack-0.9.17.tgz", + "integrity": "sha512-nypTN6sEe+q98wMaxF/UwatA1yAq948+bZOo9JKYR+tU65DW0ipWyx8DseJ3UJYvb6VDD+Fqo83qwayQ46bEEA==", "requires": { "clsx": "^1.1.0", "hoist-non-react-statics": "^3.3.0" diff --git a/interface/package.json b/interface/package.json index 33331e9..eb4c77c 100644 --- a/interface/package.json +++ b/interface/package.json @@ -18,7 +18,7 @@ "lodash": "^4.17.15", "mime-types": "^2.1.25", "moment": "^2.26.0", - "notistack": "^0.9.16", + "notistack": "^0.9.17", "react": "^16.13.1", "react-dom": "^16.13.1", "react-dropzone": "^11.0.1", diff --git a/interface/src/SignIn.tsx b/interface/src/SignIn.tsx index 85cf031..e4df446 100644 --- a/interface/src/SignIn.tsx +++ b/interface/src/SignIn.tsx @@ -11,7 +11,7 @@ import {PasswordValidator} from './components'; import { PROJECT_NAME, SIGN_IN_ENDPOINT } from './api'; const styles = (theme: Theme) => createStyles({ - loginPage: { + signInPage: { display: "flex", height: "100vh", margin: "auto", @@ -20,7 +20,7 @@ const styles = (theme: Theme) => createStyles({ flexDirection: "column", maxWidth: theme.breakpoints.values.sm }, - loginPanel: { + signInPanel: { textAlign: "center", padding: theme.spacing(2), paddingTop: "200px", @@ -81,7 +81,7 @@ class SignIn extends Component { if (response.status === 200) { return response.json(); } else if (response.status === 401) { - throw Error("Invalid login details."); + throw Error("Invalid credentials."); } else { throw Error("Invalid status code: " + response.status); } @@ -100,8 +100,8 @@ class SignIn extends Component { const { username, password, processing } = this.state; const { classes } = this.props; return ( -
- +
+ {PROJECT_NAME} { margin="normal" /> ); } Authentication.storeLoginRedirect(location); - enqueueSnackbar("Please log in to continue.", { variant: 'info' }); + enqueueSnackbar("Please sign in to continue.", { variant: 'info' }); return ( ); diff --git a/interface/src/authentication/Authentication.ts b/interface/src/authentication/Authentication.ts index 015098e..4c87493 100644 --- a/interface/src/authentication/Authentication.ts +++ b/interface/src/authentication/Authentication.ts @@ -5,8 +5,8 @@ import { Features } from '../features/types'; import { getDefaultRoute } from '../AppRouting'; export const ACCESS_TOKEN = 'access_token'; -export const LOGIN_PATHNAME = 'loginPathname'; -export const LOGIN_SEARCH = 'loginSearch'; +export const SIGN_IN_PATHNAME = 'signInPathname'; +export const SIGN_IN_SEARCH = 'signInSearch'; /** * Fallback to sessionStorage if localStorage is absent. WebView may not have local storage enabled. @@ -17,23 +17,23 @@ export function getStorage() { export function storeLoginRedirect(location?: H.Location) { if (location) { - getStorage().setItem(LOGIN_PATHNAME, location.pathname); - getStorage().setItem(LOGIN_SEARCH, location.search); + getStorage().setItem(SIGN_IN_PATHNAME, location.pathname); + getStorage().setItem(SIGN_IN_SEARCH, location.search); } } export function clearLoginRedirect() { - getStorage().removeItem(LOGIN_PATHNAME); - getStorage().removeItem(LOGIN_SEARCH); + getStorage().removeItem(SIGN_IN_PATHNAME); + getStorage().removeItem(SIGN_IN_SEARCH); } export function fetchLoginRedirect(features: Features): H.LocationDescriptorObject { - const loginPathname = getStorage().getItem(LOGIN_PATHNAME); - const loginSearch = getStorage().getItem(LOGIN_SEARCH); + const signInPathname = getStorage().getItem(SIGN_IN_PATHNAME); + const signInSearch = getStorage().getItem(SIGN_IN_SEARCH); clearLoginRedirect(); return { - pathname: loginPathname || getDefaultRoute(features), - search: (loginPathname && loginSearch) || undefined + pathname: signInPathname || getDefaultRoute(features), + search: (signInPathname && signInSearch) || undefined }; } diff --git a/interface/src/components/FullScreenLoading.tsx b/interface/src/components/FullScreenLoading.tsx index 43a34fe..d08d904 100644 --- a/interface/src/components/FullScreenLoading.tsx +++ b/interface/src/components/FullScreenLoading.tsx @@ -23,7 +23,7 @@ const FullScreenLoading = () => {
- Loading … + Loading…
) diff --git a/interface/src/components/RestController.tsx b/interface/src/components/RestController.tsx index 4b32508..c9751c6 100644 --- a/interface/src/components/RestController.tsx +++ b/interface/src/components/RestController.tsx @@ -84,11 +84,11 @@ export function restController>(endpointUrl: } throw Error("Invalid status code: " + response.status); }).then(json => { - this.props.enqueueSnackbar("Changes successfully applied.", { variant: 'success' }); + this.props.enqueueSnackbar("Update successful.", { variant: 'success' }); this.setState({ data: json, loading: false }); }).catch(error => { const errorMessage = error.message || "Unknown error"; - this.props.enqueueSnackbar("Problem saving: " + errorMessage, { variant: 'error' }); + this.props.enqueueSnackbar("Problem updating: " + errorMessage, { variant: 'error' }); this.setState({ data: undefined, loading: false, errorMessage }); }); } diff --git a/interface/src/project/DemoInformation.tsx b/interface/src/project/DemoInformation.tsx index 7beff19..2b9967b 100644 --- a/interface/src/project/DemoInformation.tsx +++ b/interface/src/project/DemoInformation.tsx @@ -8,16 +8,16 @@ class DemoInformation extends Component { return ( - This simple demo project allows you to control the blink speed of the built-in LED. + This simple demo project allows you to control the built-in LED. It demonstrates how the esp8266-react framework may be extended for your own IoT project. - It is recommended that you keep your project interface code under the 'project' directory. + It is recommended that you keep your project interface code under the project directory. This serves to isolate your project code from the from the rest of the user interface which should simplify merges should you wish to update your project with future framework changes. - The demo project interface code is stored in the interface/project directory: + The demo project interface code is stored in the 'interface/src/project' directory: diff --git a/interface/src/security/SecuritySettingsForm.tsx b/interface/src/security/SecuritySettingsForm.tsx index 1d3ac37..991b400 100644 --- a/interface/src/security/SecuritySettingsForm.tsx +++ b/interface/src/security/SecuritySettingsForm.tsx @@ -35,7 +35,7 @@ class SecuritySettingsForm extends React.Component { /> - If you modify the JWT Secret, all users will be logged out. + The JWT secret is used to sign authentication tokens. If you modify the JWT Secret, all users will be signed out. diff --git a/src/LightStateService.cpp b/src/LightStateService.cpp index e0d3d7a..8169622 100644 --- a/src/LightStateService.cpp +++ b/src/LightStateService.cpp @@ -21,8 +21,8 @@ LightStateService::LightStateService(AsyncWebServer* server, AuthenticationPredicates::IS_AUTHENTICATED), _mqttClient(mqttClient), _lightMqttSettingsService(lightMqttSettingsService) { - // configure blink led to be output - pinMode(BLINK_LED, OUTPUT); + // configure led to be output + pinMode(LED_PIN, OUTPUT); // configure MQTT callback _mqttClient->onConnect(std::bind(&LightStateService::registerConfig, this)); @@ -40,7 +40,7 @@ void LightStateService::begin() { } void LightStateService::onConfigUpdated() { - digitalWrite(BLINK_LED, _state.ledOn ? LED_ON : LED_OFF); + digitalWrite(LED_PIN, _state.ledOn ? LED_ON : LED_OFF); } void LightStateService::registerConfig() { diff --git a/src/LightStateService.h b/src/LightStateService.h index f8b3059..e9c9a9c 100644 --- a/src/LightStateService.h +++ b/src/LightStateService.h @@ -7,7 +7,7 @@ #include #include -#define BLINK_LED 2 +#define LED_PIN 2 #define PRINT_DELAY 5000 #define DEFAULT_LED_STATE false