diff --git a/Memo/Commands.md b/Memo/Commands.md index 85eb96950..fdb8771fe 100644 --- a/Memo/Commands.md +++ b/Memo/Commands.md @@ -1,308 +1,310 @@ # Direct ESP3D commands (V3.x) ## Conventions + 1 - add space to separate parameters 2 - if parameter has space add \\ in front of space to not be seen as separator 3 - json json=YES json=TRUE json=1 are paremeters to switch output to json By default output is plain text, to get json formated output -add json or json=yes after main parameters +add json or json=yes after main parameters The json format is { - cmd:"", //the id of requested command - status:"" //give if it is success or an failure - data:"" // response corresponding to answer in json format too +cmd:"", //the id of requested command +status:"" //give if it is success or an failure +data:"" // response corresponding to answer in json format too } ## Commands -* Show commands help - `[ESP] json=` -* Set/Get STA SSID - `[ESP100] json= pwd=` +- Show commands help + `[ESP] json=` + +- Set/Get STA SSID + `[ESP100] json= pwd=` -* Set STA Password - `[ESP101] json= pwd=` +- Set STA Password + `[ESP101] json= pwd=` -* Set/Get STA IP mode (DHCP/STATIC) - `[ESP102] json= pwd=` +- Set/Get STA IP mode (DHCP/STATIC) + `[ESP102] json= pwd=` -* Set/Get STA IP/Mask/GW/DNS - `[ESP103]IP= MSK= GW= DNS= json= pwd=` +- Set/Get STA IP/Mask/GW/DNS + `[ESP103]IP= MSK= GW= DNS= json= pwd=` -* Set/Get sta fallback mode which can be WIFI-AP, BT, OFF - `[ESP104] json= pwd=` +- Set/Get sta fallback mode which can be WIFI-AP, BT, OFF + `[ESP104] json= pwd=` -* Set/Get AP SSID - `[ESP105] json= pwd=` +- Set/Get AP SSID + `[ESP105] json= pwd=` -* Change AP Password - `[ESP106] json= pwd=` +- Change AP Password + `[ESP106] json= pwd=` -* Set/Get AP IP - `[ESP107] json= pwd=` +- Set/Get AP IP + `[ESP107] json= pwd=` -* Set/Get AP channel - `[ESP108] json= pwd=` +- Set/Get AP channel + `[ESP108] json= pwd=` -* Set/Get radio state which can be WIFI-STA, WIFI-AP, BT, ETH-STA, ETH-AP, OFF - `[ESP110] json= pwd=` +- Set/Get radio state which can be WIFI-STA, WIFI-AP, BT, ETH-STA, ETH-AP, OFF + `[ESP110] json= pwd=` -* Get current IP - `[ESP111]json=` +- Get current IP + `[ESP111]json=` -* Get/Set hostname - `[ESP112] json= pwd=` +- Get/Set hostname + `[ESP112] json= pwd=` -* Get /Set Boot radio state which can be ON, OFF - `[ESP114] json= pwd=` +- Get /Set Boot radio state which can be ON, OFF + `[ESP114] json= pwd=` -* Get/Set immediate network(WiFi/BT/Ethernet) state which can be ON, OFF - `[ESP115] json= pwd=` +- Get/Set immediate network(WiFi/BT/Ethernet) state which can be ON, OFF + `[ESP115] json= pwd=` -* Get/Set HTTP state which can be ON, OFF - `[ESP120] json= pwd=` +- Get/Set HTTP state which can be ON, OFF + `[ESP120] json= pwd=` -* Get/Set HTTP port - `[ESP121] json= pwd=` +- Get/Set HTTP port + `[ESP121] json= pwd=` -* Get/Set Telnet state which can be ON, OFF, CLOSE - `[ESP130] json= pwd=` +- Get/Set Telnet state which can be ON, OFF, CLOSE + `[ESP130] json= pwd=` -* Get/Set Telnet port - `[ESP131] json= pwd=` +- Get/Set Telnet port + `[ESP131] json= pwd=` -* Sync / Set / Get current time - `[ESP140] json= pwd=` +- Sync / Set / Get current time + `[ESP140] json= pwd=` -* Get/Set display/set boot delay in ms / Verbose boot - `[ESP150]pwd=` +- Get/Set display/set boot delay in ms / Verbose boot + `[ESP150]pwd=` -* Get/Set WebSocket state which can be ON, OFF - `[ESP160] json= pwd=` +- Get/Set WebSocket state which can be ON, OFF + `[ESP160] json= pwd=` -* Get/Set WebSocket port - `[ESP161] json= pwd=` +- Get/Set WebSocket port + `[ESP161] json= pwd=` -* Get/Set Camera command value / list all values in JSON/plain -label can be: light/framesize/quality/contrast/brightness/saturation/gainceiling/colorbar/awb/agc/aec/hmirror/vflip/awb_gain/agc_gain/aec_value/aec2/cw/bpc/wpc/raw_gma/lenc/special_effect/wb_mode/ae_level - `[ESP170] json= pwd=` +- Get/Set Camera command value / list all values in JSON/plain + label can be: light/framesize/quality/contrast/brightness/saturation/gainceiling/colorbar/awb/agc/aec/hmirror/vflip/awb_gain/agc_gain/aec_value/aec2/cw/bpc/wpc/raw_gma/lenc/special_effect/wb_mode/ae_level + `[ESP170] json= pwd=` -* Save frame to target path and filename (default target = today date, default name=timestamp.jpg) - `[ESP171] ` +- Save frame to target path and filename (default target = today date, default name=timestamp.jpg) + `[ESP171] ` -* Get/Set Ftp state which can be ON, OFF, CLOSE - `[ESP180] json= pwd=` +- Get/Set Ftp state which can be ON, OFF, CLOSE + `[ESP180] json= pwd=` -* Get/Set Ftp ports - `[ESP181]ctrl= active= passive= json= pwd=` +- Get/Set Ftp ports + `[ESP181]ctrl= active= passive= json= pwd=` -* Get/Set WebDav state which can be ON, OFF, CLOSE - `[ESP190] json= pwd=` +- Get/Set WebDav state which can be ON, OFF, CLOSE + `[ESP190] json= pwd=` -* Get/Set WebDav port - `[ESP191] json= pwd=` +- Get/Set WebDav port + `[ESP191] json= pwd=` -* Get/Set SD Card Status - `[ESP200] json= pwd=` - `RELEASE` will force the release of SD from ESP3D if SD is shared - `REFRESH` will refresh the SD info is available` +- Get/Set SD Card Status + `[ESP200] json= pwd=` + `RELEASE` will force the release of SD from ESP3D if SD is shared + `REFRESH` will refresh the SD info is available` -* Get/Set pin value - `[ESP201]P= V= [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255]pwd=` - - if no V= get P= value - - if V= 0/1 set INPUT_PULLUP value, but for GPIO16(ESP8266) INPUT_PULLDOWN_16 - - if PULLUP=YES set input pull up (for GPIO16(ESP8266) INPUT_PULLDOWN_16), if not set input - - if RAW=YES do not set pinmode just read value +- Get/Set pin value + `[ESP201]P= V= [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255]pwd=` + + - if no V= get P= value + - if V= 0/1 set INPUT_PULLUP value, but for GPIO16(ESP8266) INPUT_PULLDOWN_16 + - if PULLUP=YES set input pull up (for GPIO16(ESP8266) INPUT_PULLDOWN_16), if not set input + - if RAW=YES do not set pinmode just read value Note: Flash pins according chip cannot be used -* Get/Set SD card Speed factor 1 2 4 6 8 16 32 - `[ESP202]SPEED= json= pwd=` +- Get/Set SD card Speed factor 1 2 4 6 8 16 32 + `[ESP202]SPEED= json= pwd=` -* Get Sensor Value / type/Set Sensor type - `[ESP210] json= pwd=` +- Get Sensor Value / type/Set Sensor type + `[ESP210] json= pwd=` -* Output to esp screen status - `[ESP214] json= pwd=` +- Output to esp screen status + `[ESP214] json= pwd=` -* Touch Calibration +- Touch Calibration `[ESP215] json= pwd=` -* Show defined pins - `[ESP220] json= pwd=` +- Show defined pins + `[ESP220] json= pwd=` + +- Play sound + `[ESP250]F= D= json= pwd=` + Note: No parameter just play beep -* Play sound - `[ESP250]F= D= json= pwd=` - Note: No parameter just play beep +- Delay command + `[ESP290] json=pwd=` -* Delay command - `[ESP290] json=pwd=` +- Get full EEPROM settings content + `[ESP400] pwd=` + Note: do not give any passwords -* Get full EEPROM settings content - `[ESP400] pwd=` - Note: do not give any passwords +\*Set EEPROM setting + position in EEPROM, type: B(byte), I(integer/long), S(string), A(IP address / mask) + `[ESP401]P= T= V= json= pwd=` -*Set EEPROM setting - position in EEPROM, type: B(byte), I(integer/long), S(string), A(IP address / mask) - `[ESP401]P= T= V= json= pwd=` ``` - Description: Positions: - ESP_RADIO_MODE 0 //1 byte = flag - ESP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese - ESP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese - ESP_STA_IP_MODE 99 //1 byte = flag - ESP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx - ESP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx - ESP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx - ESP_BAUD_RATE 112 //4 bytes = int - ESP_NOTIFICATION_TYPE 116 //1 byte = flag - ESP_CALIBRATION 117 //1 byte = flag - ESP_AP_CHANNEL 118 //1 byte = flag - ESP_BUZZER 119 //1 byte = flag - ESP_INTERNET_TIME 120 //1 byte = flag - ESP_HTTP_PORT 121 //4 bytes = int - ESP_TELNET_PORT 125 //4 bytes = int - ESP_SERIAL_FLAG 129 //1 bytes = flag - ESP_HOSTNAME 130 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese - ESP_SENSOR_INTERVAL 164 //4 bytes = int - ESP_SETTINGS_VERSION 168 //8 bytes = 7+1 = string ESP3D + 2 digits - ESP_ADMIN_PWD 176 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese - ESP_USER_PWD 197 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese - ESP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese - ESP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese - ESP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx - ESP_BOOT_DELAY 320 //4 bytes = int - ESP_WEBSOCKET_PORT 324 //4 bytes= int - ESP_HTTP_ON 328 //1 byte = flag - ESP_TELNET_ON 329 //1 byte = flag - ESP_WEBSOCKET_ON 330 //1 byte = flag - ESP_SD_SPEED_DIV 331 //1 byte = flag - ESP_NOTIFICATION_TOKEN1 332 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese - ESP_NOTIFICATION_TOKEN2 396 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese - ESP_SENSOR_TYPE 460 //1 bytes = flag - ESP_TARGET_FW 461 //1 bytes = flag - ESP_TIMEZONE 462 //1 bytes = flag - ESP_TIME_IS_DST 463 //1 bytes = flag - ESP_TIME_SERVER1 464 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese - ESP_TIME_SERVER2 593 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese - ESP_TIME_SERVER3 722 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese - ESP_REMOTE_SCREEN 851 //1 bytes = flag - ESP_SD_MOUNT 852 //1 bytes = flag - ESP_SESSION_TIMEOUT 853 //1 bytes = flag - ESP_WEBSOCKET_FLAG 854 //1 bytes = flag - ESP_SD_CHECK_UPDATE_AT_BOOT 855//1 bytes = flag - ESP_NOTIFICATION_SETTINGS 856 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese - ESP_CALIBRATION_1 985 //4 bytes = int - ESP_CALIBRATION_2 989 //4 bytes = int - ESP_CALIBRATION_3 993 //4 bytes = int - ESP_CALIBRATION_4 997 //4 bytes = int - ESP_CALIBRATION_5 1001 //4 bytes = int - ESP_SETUP 1005 //1 byte = flag - ESP_TELNET_FLAG 1006 //1 byte = flag - ESP_BT_FLAG 1007 //1 byte = flag - ESP_SCREEEN_FLAG 1008 //1 byte = flag - ESP_FTP_CTRL_PORT 1009 //4 bytes = int - ESP_FTP_DATA_ACTIVE_PORT 1013 //4 bytes = int - ESP_FTP_DATA_PASSIVE_PORT 1017 //4 bytes = int - ESP_FTP_ON 1021 //1 byte = flag - ESP_AUTO_NOTIFICATION 1022 //1 byte = flag - ESP_VERBOSE_BOOT 1023 //1 byte = flag - ESP_WEBDAV_ON 1024 //1 byte = flag - ESP_WEBDAV_PORT 1025 //4 bytes = int - ESP_STA_DNS_VALUE 1029 //4 bytes= int - ESP_SECURE_SERIAL 1033 //1 byte = flag + Description: Positions: + ESP_RADIO_MODE 0 //1 byte = flag + ESP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese + ESP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese + ESP_STA_IP_MODE 99 //1 byte = flag + ESP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx + ESP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx + ESP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx + ESP_BAUD_RATE 112 //4 bytes = int + ESP_NOTIFICATION_TYPE 116 //1 byte = flag + ESP_CALIBRATION 117 //1 byte = flag + ESP_AP_CHANNEL 118 //1 byte = flag + ESP_BUZZER 119 //1 byte = flag + ESP_INTERNET_TIME 120 //1 byte = flag + ESP_HTTP_PORT 121 //4 bytes = int + ESP_TELNET_PORT 125 //4 bytes = int + ESP_SERIAL_FLAG 129 //1 bytes = flag + ESP_HOSTNAME 130 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese + ESP_SENSOR_INTERVAL 164 //4 bytes = int + ESP_SETTINGS_VERSION 168 //8 bytes = 7+1 = string ESP3D + 2 digits + ESP_ADMIN_PWD 176 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese + ESP_USER_PWD 197 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese + ESP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese + ESP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese + ESP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx + ESP_BOOT_DELAY 320 //4 bytes = int + ESP_WEBSOCKET_PORT 324 //4 bytes= int + ESP_HTTP_ON 328 //1 byte = flag + ESP_TELNET_ON 329 //1 byte = flag + ESP_WEBSOCKET_ON 330 //1 byte = flag + ESP_SD_SPEED_DIV 331 //1 byte = flag + ESP_NOTIFICATION_TOKEN1 332 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese + ESP_NOTIFICATION_TOKEN2 396 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese + ESP_SENSOR_TYPE 460 //1 bytes = flag + ESP_TARGET_FW 461 //1 bytes = flag + ESP_TIMEZONE 462 //1 bytes = flag + ESP_TIME_IS_DST 463 //1 bytes = flag + ESP_TIME_SERVER1 464 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese + ESP_TIME_SERVER2 593 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese + ESP_TIME_SERVER3 722 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese + ESP_REMOTE_SCREEN 851 //1 bytes = flag + ESP_SD_MOUNT 852 //1 bytes = flag + ESP_SESSION_TIMEOUT 853 //1 bytes = flag + ESP_WEBSOCKET_FLAG 854 //1 bytes = flag + ESP_SD_CHECK_UPDATE_AT_BOOT 855//1 bytes = flag + ESP_NOTIFICATION_SETTINGS 856 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese + ESP_CALIBRATION_1 985 //4 bytes = int + ESP_CALIBRATION_2 989 //4 bytes = int + ESP_CALIBRATION_3 993 //4 bytes = int + ESP_CALIBRATION_4 997 //4 bytes = int + ESP_CALIBRATION_5 1001 //4 bytes = int + ESP_SETUP 1005 //1 byte = flag + ESP_TELNET_FLAG 1006 //1 byte = flag + ESP_BT_FLAG 1007 //1 byte = flag + ESP_SCREEEN_FLAG 1008 //1 byte = flag + ESP_FTP_CTRL_PORT 1009 //4 bytes = int + ESP_FTP_DATA_ACTIVE_PORT 1013 //4 bytes = int + ESP_FTP_DATA_PASSIVE_PORT 1017 //4 bytes = int + ESP_FTP_ON 1021 //1 byte = flag + ESP_AUTO_NOTIFICATION 1022 //1 byte = flag + ESP_VERBOSE_BOOT 1023 //1 byte = flag + ESP_WEBDAV_ON 1024 //1 byte = flag + ESP_WEBDAV_PORT 1025 //4 bytes = int + ESP_STA_DNS_VALUE 1029 //4 bytes= int + ESP_SECURE_SERIAL 1033 //1 byte = flag ESP_SERIAL_BRIDGE_ON 1036 //1 byte = flag ESP_SERIAL_BRIDGE_FLAG 1037 //1 byte = flag ESP_SERIAL_BRIDGE_BAUD 1038 //4 bytes= int ``` -* Get/Set Check update at boot state which can be ON, OFF - `[ESP402] json= pwd=` +- Get/Set Check update at boot state which can be ON, OFF + `[ESP402] json= pwd=` -* Get available AP list (limited to 30) - output is JSON or plain text according parameter - `[ESP410]json= ` +- Get available AP list (limited to 30) + output is JSON or plain text according parameter + `[ESP410]json= ` -* Get current settings of ESP3D - Output is JSON or plain text according parameter - `[ESP420]json= ` +- Get current settings of ESP3D + Output is JSON or plain text according parameter + `[ESP420]json= ` -* Set ESP State - `cmd` can be `RESTART` to restart board or `RESET` to reset all setting to defaults values - `[ESP444] json= ` +- Set ESP State + `cmd` can be `RESTART` to restart board or `RESET` to reset all setting to defaults values + `[ESP444] json= ` -* Get available ESP3D list - output is JSON or plain text according parameter - `[ESP450]json= ` +- Get available ESP3D list + output is JSON or plain text according parameter + `[ESP450]json= ` -* Change admin password - `[ESP550] json= pwd=` +- Change admin password + `[ESP550] json= pwd=` -* Change user password - `[ESP555] json= pwd=` +- Change user password + `[ESP555] json= pwd=` -* Send Notification - `[ESP600]msg json= pwd=` +- Send Notification + `[ESP600]msg json= pwd=` -* Set/Get Notification settings - `[ESP610]type= T1= T2= TS= json= [pwd=]` - Get will give type and settings only, not the protected T1/T2 +- Set/Get Notification settings + `[ESP610]type= T1= T2= TS= json= [pwd=]` + Get will give type and settings only, not the protected T1/T2 -* Send Notification using URL - `[ESP620]URL= json= pwd=` +- Send Notification using URL + `[ESP620]URL= json= pwd=` -* Read / Stream / Process FS file - `[ESP700] json= pwd=` +- Read / Stream / Process FS file + `[ESP700] json= pwd=` -* Query and Control ESP700 stream - `[ESP701]action= json= pwd=` +- Query and Control ESP700 stream + `[ESP701]action= json= pwd=` -* Format ESP Filesystem - `[ESP710]FORMATFS json= pwd=` - -* Format SD Filesystem - `[ESP715]FORMATSD json= pwd=` +- Format ESP Filesystem + `[ESP710]FORMATFS json= pwd=` -* List ESP Filesystem - `[ESP720] json= pwd=` +- Format SD Filesystem + `[ESP715]FORMATSD json= pwd=` -* Action on ESP Filesystem - Action can be `rmdir` to remove empty directory / `remove` to delete file / `mkdir` to create directory / `exists` to check if file or directory exists / `create` create an empty file - `[ESP730]= json= pwd=` +- List ESP Filesystem + `[ESP720] json= pwd=` -* List SD Filesystem - `[ESP740] json= pwd=` +- Action on ESP Filesystem + Action can be `rmdir` to remove empty directory / `remove` to delete file / `mkdir` to create directory / `exists` to check if file or directory exists / `create` create an empty file + `[ESP730]= json= pwd=` -* Action on SD Filesystem - Action can be `rmdir` to remove empty directory / `remove` to delete file / `mkdir` to create directory / `exists` to check if file or directory exists / `create` create an empty file - `[ESP750]= json= pwd=` +- List SD Filesystem + `[ESP740] json= pwd=` -* List Global Filesystem - `[ESP780] json= pwd=` +- Action on SD Filesystem + Action can be `rmdir` to remove empty directory / `remove` to delete file / `mkdir` to create directory / `exists` to check if file or directory exists / `create` create an empty file + `[ESP750]= json= pwd=` -* Action on Global Filesystem - Action can be `rmdir` to remove empty directory / `remove` to delete file / `mkdir` to create directory / `exists` to check if file or directory exists / `create` create an empty file - `[ESP790]= json= pwd=` +- List Global Filesystem + `[ESP780] json= pwd=` -* FW Informations - `[ESP800]json= pwd=` +- Action on Global Filesystem + Action can be `rmdir` to remove empty directory / `remove` to delete file / `mkdir` to create directory / `exists` to check if file or directory exists / `create` create an empty file + `[ESP790]= json= pwd=` -* Get state / Set Enable / Disable Serial Communication - `[ESP900] json= pwd=` - -* Get / Set Serial Baud Rate +- FW Informations + `[ESP800]json= pwd= ` + +- Get state / Set Enable / Disable Serial Communication + `[ESP900] json= pwd=` +- Get / Set Serial Baud Rate `[ESP901] json= pwd=` -* Get state / Set Enable / Disable buzzer - `[ESP910] json= pwd=` +- Get state / Set Enable / Disable buzzer + `[ESP910] json= pwd=` -* Get state / Set state of output message clients - `[ESP920]= json= pwd=` +- Get state / Set state of output message clients + `[ESP920]= json= pwd=` -* Get state / Set Enable / Disable Serial Bridge Communication - `[ESP930] json= pwd=` -* Get / Set Serial Bridge Baud Rate +- Get state / Set Enable / Disable Serial Bridge Communication + `[ESP930] json= pwd=` +- Get / Set Serial Bridge Baud Rate `[ESP931] json= pwd=` - -* Set quiet boot if strapping pin is High - `[ESP999]QUIETBOOT pwd=` \ No newline at end of file +- Set quiet boot if strapping pin is High + `[ESP999]QUIETBOOT pwd=` diff --git a/Memo/ESP3D [ESP800] format.md b/Memo/ESP3D [ESP800] format.md index 0c9e8f0b9..ccc6503f1 100644 --- a/Memo/ESP3D [ESP800] format.md +++ b/Memo/ESP3D [ESP800] format.md @@ -4,12 +4,12 @@ can be in JSON or plain text ## Input -`[ESP800]json=yes time=2022-08-02-12-02-18 version=3.0.0-a11 setup=0` +`[ESP800] json= pwd=` * json=yes the output format * time= - to set ESP3D time using format : `YYYY`-`MM`-`DD`-`HH24`-`minutes`-`seconds` + to set ESP3D time using ISO 8601 format : `YYYY`-`MM`-`DD`T`HH`-`minutes`-`seconds` * version version of webUI * setup flag @@ -34,7 +34,6 @@ can be in JSON or plain text "WebCommunication":"Synchronous", "WebSocketIP":"192.168.2.117", "WebSocketPort":"81", - "WebSocketSubProtocol":"webui-v3", "Hostname":"esp3d", "WiFiMode":"STA", "WebUpdate":"Enabled", @@ -86,8 +85,6 @@ can be in JSON or plain text Ip address for the websocket terminal `192.168.2.117` * `WebSocketPort` Port for the web socket terminal `81` - * `WebSocketSubProtocol` (not yet implemented) - Sub protocol to be used (e.g: `webui-v3`) * `Hostname` Hostname of ESP3D or main Baord `esp3d` * `WiFiMode` @@ -96,7 +93,7 @@ can be in JSON or plain text Inform webUI the feature is available or not, can be `Enabled` or `Disabled` * `FlashFileSystem` (currently `FileSystem`, to be updated soon ) The file system used by ESP board can be `LittleFS`, `SPIFFS`, `Fat`, `none` - * `HostPath` (not yet implemented) + * `HostPath` Path where the preferences.json and index.html.gz are stored and can be updated (e.g: `www`) * `Time` Type of time support diff --git a/Memo/websocket.md b/Memo/websocket.md index f706dea6d..eef2cb327 100644 --- a/Memo/websocket.md +++ b/Memo/websocket.md @@ -10,7 +10,7 @@ there are 2 ## Terminal websocket -use subprotocol `webui-v3` (to be implemented) +use subprotocol `webui-v3` ### text mode diff --git a/config/targets/CNC/GRBL/index.js b/config/targets/CNC/GRBL/index.js index da7c09103..d50c118e8 100644 --- a/config/targets/CNC/GRBL/index.js +++ b/config/targets/CNC/GRBL/index.js @@ -95,7 +95,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "esp3d", WiFiMode: "STA", diff --git a/config/targets/CNC/GRBLHal/index.js b/config/targets/CNC/GRBLHal/index.js index 321cec965..52c5adc0c 100644 --- a/config/targets/CNC/GRBLHal/index.js +++ b/config/targets/CNC/GRBLHal/index.js @@ -96,7 +96,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "esp3d", WiFiMode: "STA", diff --git a/config/targets/Printer3D/Marlin-embedded/index.js b/config/targets/Printer3D/Marlin-embedded/index.js index 65799514f..02709ea6c 100644 --- a/config/targets/Printer3D/Marlin-embedded/index.js +++ b/config/targets/Printer3D/Marlin-embedded/index.js @@ -407,7 +407,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "esp3d", WiFiMode: "STA", diff --git a/config/targets/Printer3D/Marlin/index.js b/config/targets/Printer3D/Marlin/index.js index a62907167..0018beaf8 100644 --- a/config/targets/Printer3D/Marlin/index.js +++ b/config/targets/Printer3D/Marlin/index.js @@ -420,7 +420,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "esp3d", WiFiMode: "STA", diff --git a/config/targets/Printer3D/Repetier/index.js b/config/targets/Printer3D/Repetier/index.js index 3f615ef1f..1774114b9 100644 --- a/config/targets/Printer3D/Repetier/index.js +++ b/config/targets/Printer3D/Repetier/index.js @@ -438,7 +438,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: enableAuthentication ? "Enabled" : "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "esp3d", WiFiMode: "STA", diff --git a/config/targets/Printer3D/Smoothieware/index.js b/config/targets/Printer3D/Smoothieware/index.js index 7c9e593c1..178915a5c 100644 --- a/config/targets/Printer3D/Smoothieware/index.js +++ b/config/targets/Printer3D/Smoothieware/index.js @@ -699,7 +699,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: enableAuthentication ? "Enabled" : "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "smoothesp3d", WiFiMode: "STA", diff --git a/config/targets/SandTable/GRBL/index.js b/config/targets/SandTable/GRBL/index.js index 2d3a6a78a..1e846f7d8 100644 --- a/config/targets/SandTable/GRBL/index.js +++ b/config/targets/SandTable/GRBL/index.js @@ -86,7 +86,6 @@ const commandsQuery = (req, res, SendWS) => { Authentication: "Disabled", WebCommunication: "Synchronous", WebSocketIP: "localhost", - WebSocketSubProtocol: "webui-V3", WebSocketPort: "81", Hostname: "esp3d", WiFiMode: "STA", diff --git a/dist/CNC/GRBL/index.html.gz b/dist/CNC/GRBL/index.html.gz index 9f4f8385d..b581fbaac 100644 Binary files a/dist/CNC/GRBL/index.html.gz and b/dist/CNC/GRBL/index.html.gz differ diff --git a/dist/CNC/GRBLHal/index.html.gz b/dist/CNC/GRBLHal/index.html.gz index cf0715239..6c09bc0cf 100644 Binary files a/dist/CNC/GRBLHal/index.html.gz and b/dist/CNC/GRBLHal/index.html.gz differ diff --git a/dist/Printer3D/Marlin-embedded/index.html.gz b/dist/Printer3D/Marlin-embedded/index.html.gz index a65dd5448..c6ca05544 100644 Binary files a/dist/Printer3D/Marlin-embedded/index.html.gz and b/dist/Printer3D/Marlin-embedded/index.html.gz differ diff --git a/dist/Printer3D/Marlin/index.html.gz b/dist/Printer3D/Marlin/index.html.gz index 4b5d75f17..a6f44df8e 100644 Binary files a/dist/Printer3D/Marlin/index.html.gz and b/dist/Printer3D/Marlin/index.html.gz differ diff --git a/dist/Printer3D/Repetier/index.html.gz b/dist/Printer3D/Repetier/index.html.gz index e470e9013..cdf56b883 100644 Binary files a/dist/Printer3D/Repetier/index.html.gz and b/dist/Printer3D/Repetier/index.html.gz differ diff --git a/dist/Printer3D/Smoothieware/index.html.gz b/dist/Printer3D/Smoothieware/index.html.gz index f81a70633..205141bc2 100644 Binary files a/dist/Printer3D/Smoothieware/index.html.gz and b/dist/Printer3D/Smoothieware/index.html.gz differ diff --git a/dist/SandTable/GRBL/index.html.gz b/dist/SandTable/GRBL/index.html.gz index 9aad4a093..e64e40b5a 100644 Binary files a/dist/SandTable/GRBL/index.html.gz and b/dist/SandTable/GRBL/index.html.gz differ diff --git a/src/components/App/version.js b/src/components/App/version.js index 17503788e..7e0928fbd 100644 --- a/src/components/App/version.js +++ b/src/components/App/version.js @@ -17,7 +17,7 @@ */ import { h } from "preact" import { webUIbuild } from "../../targets" -export const webUIversion = "3.0.0-a18" +export const webUIversion = "3.0.0-a19" export const Esp3dVersion = () => ( {webUIversion}.{webUIbuild} diff --git a/src/components/Helpers/time.js b/src/components/Helpers/time.js index 4b8d0dba6..242a722d5 100644 --- a/src/components/Helpers/time.js +++ b/src/components/Helpers/time.js @@ -18,6 +18,7 @@ import { h } from "preact" function getBrowserTime() { + //ISO 8601 format string function padNumber(num, size) { const s = num.toString().padStart(size, "0") return s @@ -26,10 +27,10 @@ function getBrowserTime() { return `${d.getFullYear()}-${padNumber(d.getMonth() + 1, 2)}-${padNumber( d.getDate(), 2 - )}-${padNumber(d.getHours(), 2)}-${padNumber( + )}H${padNumber(d.getHours(), 2)}:${padNumber( d.getMinutes(), 2 - )}-${padNumber(d.getSeconds(), 2)}` + )}:${padNumber(d.getSeconds(), 2)}` } export { getBrowserTime } diff --git a/src/contexts/WsContext.js b/src/contexts/WsContext.js index abde02250..ab74c129b 100644 --- a/src/contexts/WsContext.js +++ b/src/contexts/WsContext.js @@ -212,7 +212,7 @@ const WsContextProvider = ({ children }) => { wsConnection.current = new WebSocket( `ws://${document.location.hostname}:${connectionSettings.current.WebSocketPort}${path}`, - `${connectionSettings.current.WebSocketSubProtocol}` + `webui-v3` ) wsConnection.current.binaryType = "arraybuffer"