Skip to content

Commit

Permalink
Update Commands.md
Browse files Browse the repository at this point in the history
WebColor20
  • Loading branch information
sfromis authored Dec 12, 2024
1 parent 08e40db commit fbcc681
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ TCPConfig<a class="cmnd" id="tcpconfig"></a>|`<value>` = standard 3 characters m
TCPStart<a class="cmnd" id="tcpstart"></a>|Requires GPIOs `TCP Tx` and `TCP Rx` and can work with hardware or software serial. Also works with [ModBus Bridge](Modbus-Bridge.md)<BR>`<port>, [<ipaddress>]` = Start listening to port. If `<ipaddress>` is defined only allows connections from the provided IPv4 address <BR>`0` = Shut down TCP server and disconnect any existing connection<BR> Supports 2 parallel TCP connections, which can be useful if you need a terminal + a specific protocol (like XMODEM). The 3rd connection will disconnect a previous connection. The number of parallel connections is a compile-time option.
UrlFetch<a class="cmnd" id="urlfetch"></a>|`<url>`<br>Download a url (http or https) and store the content in the filesystem<br>ESP32 only
WebCanvas<x\><a class="cmnd" id="webcanvas"></a>|Configure Web GUI canvas (background) using using a color, "url" or "gradient" CSS elements. Example: `WebCanvas linear-gradient(#F02 7%,#F93,#FF4,#082,#00F,#708 93%)`
WebColor<x\><a class="cmnd" id="webcolor"></a>|Configure Web GUI colors (x = `1..19`)<BR>`#RRGGBB` = Set color for `WebColor<x>`<BR>`1` = Global text (Black)<BR>`2` = Global background (White)<BR>`3` = Form background (Greyish)<BR>`4` = Input text (Black)<BR>`5` = Input background (White)<BR>`6` = Console text (Black)<BR>`7` = Console background (White)<BR>`8` = Warning text (Red)<BR>`9` = Success text (Green)<BR>`10` = Button text (White)<BR>`11` = Button (Blueish)<BR>`12` = Button hovered over (Darker blue-ish)<BR>`13` = Restart/Reset/Delete button (Red-ish)<BR>`14` = Restart/Reset/Delete button hover (Darker red-ish)<BR>`15` = Save button (Green-ish)<BR>`16` = Save button hover (Darker greenish)<BR>`17` = Config timer tab text (White)<BR>`18` = Config timer tab background (Light grey)<br>`19` = Module title and FriendlyName text (Whiteish)<br>[User themes](WebUI#themes)
WebColor<x\><a class="cmnd" id="webcolor"></a>|Configure Web GUI colors (x = `1..19`)<BR>`#RRGGBB` = Set color for `WebColor<x>`<BR>`1` = Global text (Black)<BR>`2` = Global background (White)<BR>`3` = Form background (Greyish)<BR>`4` = Input text (Black)<BR>`5` = Input background (White)<BR>`6` = Console text (Black)<BR>`7` = Console background (White)<BR>`8` = Warning text (Red)<BR>`9` = Success text (Green)<BR>`10` = Button text (White)<BR>`11` = Button (Blueish)<BR>`12` = Button hovered over (Darker blue-ish)<BR>`13` = Restart/Reset/Delete button (Red-ish)<BR>`14` = Restart/Reset/Delete button hover (Darker red-ish)<BR>`15` = Save button (Green-ish)<BR>`16` = Save button hover (Darker greenish)<BR>`17` = Config timer tab text (White)<BR>`18` = Config timer tab background (Light grey)<br>`19` = Module title and FriendlyName text (Whiteish)<br>`20` = Button color when off (Darkest blueish)<br>[User themes](WebUI#themes)
WebPassword<a class="cmnd" id="webpassword"></a>|Show current web server password<BR>`0` = disable use of password for web UI<BR>`1` = reset password to firmware default (`WEB_PASSWORD`)<BR>`<value>` = set web UI password (32 char limit) for user `WEB_USERNAME` *(Default WEB_USERNAME = `admin`)*
WebQuery<a class="cmnd" id="webquery"></a>|Send HTTP GET, POST, PUT, and PATCH Requests<BR>`<url> <method> [<header1Name:header1Value|header2Name:header2Value...>]<body>`<BR>`<url>` = HTTP URL to query<BR>`<method>` = HTTP Request method. Must be `GET`, `POST`, `PUT`, or `PATCH`<BR>`[<header1Name:header1Value|header2Name:header2Value...>]` *(optional)* = HTTP Request Headers.<BR>`<body>` *(optional)* = HTTP Request Body. Ignored for GET requests<BR><BR>Examples<BR>`WebQuery http://www.mysite.com/api/status GET`: Simple HTTP GET Request<BR>`WebQuery http://www.mysite.com/api/update POST [Authorization:Bearer xyz|Content-Type:application/json]{"message":"body"}`: Sends POST data with an authorization header and Content-Type<br>`WebQuery http://www.mysite.com/api/set PUT {"message":"body"}`: Sends PUT request with a body, but no headers
WebRefresh<a class="cmnd" id="webrefresh"></a>|Web page refresh<BR>`1000..10000` = set refresh time in milliseconds *(default = `2345`)*
Expand Down

0 comments on commit fbcc681

Please sign in to comment.