8000 Add additional settings to AP configuration (#215) · rjwats/esp8266-react@3ecdc27 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3ecdc27

Browse files
rjwatsLukas-Heiligenbrunner
rjwats
and
Lukas-Heiligenbrunner
authored
Add additional settings to AP configuration (#215)
* add wifi settings option to set AP visible/non visible * add add channel and max client settings Co-authored-by: lukas <lukas.heiligenbrunner@gmail.com>
1 parent e771ab1 commit 3ecdc27

File tree

5 files changed

+76
-7
lines changed

5 files changed

+76
-7
lines changed

‎factory_settings.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ build_flags =
1515
-D FACTORY_AP_PROVISION_MODE=AP_MODE_DISCONNECTED
1616
-D FACTORY_AP_SSID=\"ESP8266-React-#{unique_id}\" ; 1-64 characters, supports placeholders
1717
-D FACTORY_AP_PASSWORD=\"esp-react\" ; 8-64 characters
18+
-D FACTORY_AP_CHANNEL=1
19+
-D FACTORY_AP_SSID_HIDDEN=false
20+
-D FACTORY_AP_MAX_CLIENTS=4
1821
-D FACTORY_AP_LOCAL_IP=\"192.168.4.1\"
1922
-D FACTORY_AP_GATEWAY_IP=\"192.168.4.1\"
2023
-D FACTORY_AP_SUBNET_MASK=\"255.255.255.0\"

‎interface/src/ap/APSettingsForm.tsx

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
import React, { Fragment } from 'react';
2-
import { TextValidator, ValidatorForm, SelectValidator } from 'react-material-ui-form-validator';
2+
import { TextValidator, ValidatorForm } from 'react-material-ui-form-validator';
3+
import { range } from 'lodash';
34

45
import MenuItem from '@material-ui/core/MenuItem';
6+
import Checkbox from '@material-ui/core/Checkbox';
57
import SaveIcon from '@material-ui/icons/Save';
68

7-
import { PasswordValidator, RestFormProps, FormActions, FormButton } from '../components';
9+
import { PasswordValidator, RestFormProps, FormActions, FormButton, BlockFormControlLabel } from '../components';
810

911
import { isAPEnabled } from './APModes';
1012
import { APSettings, APProvisionMode } from './types';
1113
import { isIP } from '../validators';
14+
import { TextField } from '@material-ui/core';
1215

1316
type APSettingsFormProps = RestFormProps<APSettings>;
1417

@@ -22,17 +25,18 @@ class APSettingsForm extends React.Component<APSettingsFormProps> {
2225
const { data, handleValueChange, saveData } = this.props;
2326
return (
2427
<ValidatorForm onSubmit={saveData} ref="APSettingsForm">
25-
<SelectValidator name="provision_mode"
28+
<TextField name="provision_mode"
2629
label="Provide Access Point&hellip;"
2730
value={data.provision_mode}
2831
fullWidth
32+
select
2933
variant="outlined"
3034
onChange={handleValueChange('provision_mode')}
3135
margin="normal">
3236
<MenuItem value={APProvisionMode.AP_MODE_ALWAYS}>Always</MenuItem>
3337
<MenuItem value={APProvisionMode.AP_MODE_DISCONNECTED}>When WiFi Disconnected</MenuItem>
3438
<MenuItem value={APProvisionMode.AP_NEVER}>Never</MenuItem>
35-
</SelectValidator>
39+
</TextField>
3640
{
3741
isAPEnabled(data) &&
3842
<Fragment>
@@ -58,6 +62,43 @@ class APSettingsForm extends React.Component<APSettingsFormProps> {
5862
onChange={handleValueChange('password')}
5963
margin="normal"
6064
/>
65+
<TextField name="channel"
66+
label="Preferred Channel"
67+
value={data.channel}
68+
fullWidth
69+
select
70+
type="number"
71+
variant="outlined"
72+
onChange={handleValueChange('channel')}
73+
margin="normal">
74+
{
75+
range(1, 14).map(i => <MenuItem value={i}>{i}</MenuItem>)
76+
}
77+
</TextField>
78+
<BlockFormControlLabel
79+
control={
80+
<Checkbox
81+
value="ssid_hidden"
82+
checked={data.ssid_hidden}
83+
onChange={handleValueChange("ssid_hidden")}
84+
/>
85+
}
86+
label="Hide SSID?"
87+
/>
88+
<TextField name="max_clients"
89+
label="Max Clients"
90+
value={data.max_clients}
91+
fullWidth
92+
select
93+
type="number"
94+
variant="outlined"
95+
onChange={handleValueChange('max_clients')}
96+
margin="normal"
97+
>
98+
{
99+
range(1, 9).map(i => <MenuItem value={i}>{i}</MenuItem>)
100+
}
101+
</TextField>
61102
<TextValidator
62103
validators={['required', 'isIP']}
63104
errorMessages={['Local IP is required', 'Must be an IP address']}

‎interface/src/ap/types.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ export interface APSettings {
2121
provision_mode: APProvisionMode;
2222
ssid: string;
2323
password: string;
24+
channel: number;
25+
ssid_hidden: boolean;
26+
max_clients: number;
2427
local_ip: string;
2528
gateway_ip: string;
2629
subnet_mask: string;

‎lib/framework/APSettingsService.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ void APSettingsService::manageAP() {
4646
void APSettingsService::startAP() {
4747
Serial.println(F("Starting software access point"));
4848
WiFi.softAPConfig(_state.localIP, _state.gatewayIP, _state.subnetMask);
49-
WiFi.softAP(_state.ssid.c_str(), _state.password.c_str());
49+
WiFi.softAP(_state.ssid.c_str(), _state.password.c_str(), _state.channel, _state.ssidHidden, _state.maxClients);
5050
if (!_dnsServer) {
5151
IPAddress apIp = WiFi.softAPIP();
5252
Serial.print(F("Starting captive portal on "));

‎lib/framework/APSettingsService.h

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,26 @@
3333
#define FACTORY_AP_SUBNET_MASK "255.255.255.0"
3434
#endif
3535

36+
#ifndef FACTORY_AP_CHANNEL
37+
#define FACTORY_AP_CHANNEL 1
38+
#endif
39+
40+
#ifndef FACTORY_AP_SSID_HIDDEN
41+
#define FACTORY_AP_SSID_HIDDEN false
42+
#endif
43+
44+
#ifndef FACTORY_AP_MAX_CLIENTS
45+
#define FACTORY_AP_MAX_CLIENTS 4
46+
#endif
47+
3648
#define AP_SETTINGS_FILE "/config/apSettings.json"
3749
#define AP_SETTINGS_SERVICE_PATH "/rest/apSettings"
3850

39-
#define MANAGE_NETWORK_DELAY 10000
40-
4151
#define AP_MODE_ALWAYS 0
4252
#define AP_MODE_DISCONNECTED 1
4353
#define AP_MODE_NEVER 2
4454

55+
#define MANAGE_NETWORK_DELAY 10000
4556
#define DNS_PORT 53
4657

4758
enum APNetworkStatus { ACTIVE = 0, INACTIVE, LINGERING };
@@ -51,19 +62,27 @@ class APSettings {
5162
uint8_t provisionMode;
5263
String ssid;
5364
String password;
65+
uint8_t channel;
66+
bool ssidHidden;
67+
uint8_t maxClients;
68+
5469
IPAddress localIP;
5570
IPAddress gatewayIP;
5671
IPAddress subnetMask;
5772

5873
bool operator==(const APSettings& settings) const {
5974
return provisionMode == settings.provisionMode && ssid == settings.ssid && password == settings.password &&
75+
channel == settings.channel && ssidHidden == settings.ssidHidden && maxClients == settings.maxClients &&
6076
localIP == settings.localIP && gatewayIP == settings.gatewayIP && subnetMask == settings.subnetMask;
6177
}
6278

6379
static void read(APSettings& settings, JsonObject& root) {
6480
root["provision_mode"] = settings.provisionMode;
6581
root["ssid"] = settings.ssid;
6682
root["password"] = settings.password;
83+
root["channel"] = settings.channel;
84+
root["ssid_hidden"] = settings.ssidHidden;
85+
root["max_clients"] = settings.maxClients;
6786
root["local_ip"] = settings.localIP.toString();
6887
root["gateway_ip"] = settings.gatewayIP.toString();
6988
root["subnet_mask"] = settings.subnetMask.toString();
@@ -82,6 +101,9 @@ class APSettings {
82101
}
83102
newSettings.ssid = root["ssid"] | SettingValue::format(FACTORY_AP_SSID);
84103
newSettings.password = root["password"] | FACTORY_AP_PASSWORD;
104+
newSettings.channel = root["channel"] | FACTORY_AP_CHANNEL;
105+
newSettings.ssidHidden = root["ssid_hidden"] | FACTORY_AP_SSID_HIDDEN;
106+
newSettings.maxClients = root["max_clients"] | FACTORY_AP_MAX_CLIENTS;
85107

86108
JsonUtils::readIP(root, "local_ip", newSettings.localIP, FACTORY_AP_LOCAL_IP);
87109
JsonUtils::readIP(root, "gateway_ip", newSettings.gatewayIP, FACTORY_AP_GATEWAY_IP);

0 commit comments

Comments
 (0)
0