Skip to content

Commit 11e5189

Browse files
doc: docs updated
1 parent 0c2f5e1 commit 11e5189

File tree

37 files changed

+1170
-350
lines changed

37 files changed

+1170
-350
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Because of the limited memory on ESP32-WROOM modules, the full functionality is
1818

1919
### Prerequisites
2020

21-
Install [esp-idf 4.2](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/index.html) on your system.
21+
Install [esp-idf 4.2.2](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/index.html) on your system.
2222

2323
### First install
2424

@@ -63,13 +63,21 @@ If this is your first install, your onboard LED should blink now. Blinking signa
6363

6464
On the Setup page you can configure your WLAN settings and an URL to download your JS main script from.
6565

66-
Please note that the script, does not need to have a main function, because its evaluated entirely.
66+
![Setup page screenshot](setup.png)
67+
### Examples
68+
69+
Please note that the Javascript OTA script, does not need to have a main function, because its evaluated entirely.
6770
That means, to print out "Hello World", you only have to include one line in your script on the webserver:
6871

6972
```js
7073
console.log("Hello world!");
7174
```
7275

76+
You can test this example by configuring this URL as "Javascript OTA":
77+
https://raw.githubusercontent.com/marcelkottmann/esp32-javascript/master/examples/example.js
78+
79+
Please see also the other example in [./examples](./examples)
80+
7381
### C/C++bindings
7482

7583
If you need to create your own C/C++ bindings for your JS code, this are the steps to perform:
@@ -127,10 +135,11 @@ You can erase the persistent flash memory, which will be equivalent to a factory
127135

128136
| Version | Compatible |
129137
| ----------------------------------------------------------------- | :--------------------: |
130-
| [4.2](https://github.com/espressif/esp-idf/releases/tag/v4.2) | :heavy_check_mark:[^1] |
131-
| [4.2.1](https://github.com/espressif/esp-idf/releases/tag/v4.2.1) | :heavy_check_mark:[^1] |
138+
| [4.2](https://github.com/espressif/esp-idf/releases/tag/v4.2) | ☑️<sup>1</sup> |
139+
| [4.2.1](https://github.com/espressif/esp-idf/releases/tag/v4.2.1) | ☑️<sup>1</sup> |
140+
| [4.2.2](https://github.com/espressif/esp-idf/releases/tag/v4.2.2) | ✅ Recommended |
132141

133-
[^1]: SSL client connections currently not working properly for ESP32-S2 devices due to esp-idf bug in 4.2.x:
142+
<sup>1</sup> SSL client connections currently not working properly for ESP32-S2 devices due to esp-idf bug in 4.2.x:
134143
https://github.com/espressif/esp-idf/pull/6998 , but can be fixed manually (see changes in PR).
135144

136145
## API

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@
77
### Modules
88

99
* ["esp32-javascript/modules/esp32-javascript/boot"](modules/_esp32_javascript_modules_esp32_javascript_boot_.md)
10+
* ["esp32-javascript/modules/esp32-javascript/chunked"](modules/_esp32_javascript_modules_esp32_javascript_chunked_.md)
1011
* ["esp32-javascript/modules/esp32-javascript/config"](modules/_esp32_javascript_modules_esp32_javascript_config_.md)
1112
* ["esp32-javascript/modules/esp32-javascript/configserver"](modules/_esp32_javascript_modules_esp32_javascript_configserver_.md)
13+
* ["esp32-javascript/modules/esp32-javascript/filelogging"](modules/_esp32_javascript_modules_esp32_javascript_filelogging_.md)
1214
* ["esp32-javascript/modules/esp32-javascript/firmware-config"](modules/_esp32_javascript_modules_esp32_javascript_firmware_config_.md)
1315
* ["esp32-javascript/modules/esp32-javascript/global"](modules/_esp32_javascript_modules_esp32_javascript_global_.md)
1416
* ["esp32-javascript/modules/esp32-javascript/http"](modules/_esp32_javascript_modules_esp32_javascript_http_.md)
1517
* ["esp32-javascript/modules/esp32-javascript/index"](modules/_esp32_javascript_modules_esp32_javascript_index_.md)
18+
* ["esp32-javascript/modules/esp32-javascript/native-ota"](modules/_esp32_javascript_modules_esp32_javascript_native_ota_.md)
1619
* ["esp32-javascript/modules/esp32-javascript/self-test"](modules/_esp32_javascript_modules_esp32_javascript_self_test_.md)
1720
* ["esp32-javascript/modules/esp32-javascript/self-test-firmware-config"](modules/_esp32_javascript_modules_esp32_javascript_self_test_firmware_config_.md)
1821
* ["esp32-javascript/modules/esp32-javascript/stringbuffer"](modules/_esp32_javascript_modules_esp32_javascript_stringbuffer_.md)

docs/classes/_esp32_javascript_modules_esp32_javascript_http_.eventemitter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
**listener**: *object*
2525

26-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:49](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L49)*
26+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:76](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L76)*
2727

2828
#### Type declaration:
2929

@@ -35,7 +35,7 @@
3535

3636
**emit**(`event`: string): *void*
3737

38-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:53](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L53)*
38+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:80](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L80)*
3939

4040
**Parameters:**
4141

@@ -51,7 +51,7 @@ ___
5151

5252
**on**(`event`: string, `cb`: function): *void*
5353

54-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:50](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L50)*
54+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:77](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L77)*
5555

5656
**Parameters:**
5757

docs/classes/_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
* [onload](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#optional-onload)
1616
* [reponseHeaders](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-reponseheaders)
1717
* [requestHeaders](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-requestheaders)
18-
* [responseText](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-responsetext)
19-
* [responseURL](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-responseurl)
20-
* [status](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-status)
21-
* [statusText](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-statustext)
18+
* [responseText](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#optional-responsetext)
19+
* [responseURL](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#optional-responseurl)
20+
* [status](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#optional-status)
21+
* [statusText](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#optional-statustext)
2222
* [url](_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md#private-optional-url)
2323

2424
### Methods
@@ -34,87 +34,87 @@
3434

3535
**method**: *string* = "GET"
3636

37-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:484](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L484)*
37+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:567](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L567)*
3838

3939
___
4040

4141
### `Optional` onerror
4242

4343
**onerror**? : *undefined | function*
4444

45-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:492](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L492)*
45+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:575](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L575)*
4646

4747
___
4848

4949
### `Optional` onload
5050

5151
**onload**? : *undefined | function*
5252

53-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:493](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L493)*
53+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:576](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L576)*
5454

5555
___
5656

5757
### `Private` `Optional` reponseHeaders
5858

5959
**reponseHeaders**? : *undefined | string*
6060

61-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:485](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L485)*
61+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:568](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L568)*
6262

6363
___
6464

6565
### `Private` `Optional` requestHeaders
6666

6767
**requestHeaders**? : *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
6868

69-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:486](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L486)*
69+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:569](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L569)*
7070

7171
___
7272

73-
### `Private` `Optional` responseText
73+
### `Optional` responseText
7474

7575
**responseText**? : *undefined | string*
7676

77-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:490](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L490)*
77+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:573](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L573)*
7878

7979
___
8080

81-
### `Private` `Optional` responseURL
81+
### `Optional` responseURL
8282

8383
**responseURL**? : *undefined | string*
8484

85-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:489](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L489)*
85+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:572](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L572)*
8686

8787
___
8888

89-
### `Private` `Optional` status
89+
### `Optional` status
9090

9191
**status**? : *undefined | number*
9292

93-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:487](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L487)*
93+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:570](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L570)*
9494

9595
___
9696

97-
### `Private` `Optional` statusText
97+
### `Optional` statusText
9898

9999
**statusText**? : *undefined | string*
100100

101-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:488](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L488)*
101+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:571](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L571)*
102102

103103
___
104104

105105
### `Private` `Optional` url
106106

107107
**url**? : *[AnchorElement](../interfaces/_esp32_javascript_urlparse_.anchorelement.md)*
108108

109-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:483](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L483)*
109+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:566](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L566)*
110110

111111
## Methods
112112

113113
### getAllResponseHeaders
114114

115115
**getAllResponseHeaders**(): *string | undefined*
116116

117-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:538](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L538)*
117+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:643](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L643)*
118118

119119
**Returns:** *string | undefined*
120120

@@ -124,7 +124,7 @@ ___
124124

125125
**open**(`method`: string, `url`: string): *void*
126126

127-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:542](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L542)*
127+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:647](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L647)*
128128

129129
**Parameters:**
130130

@@ -141,7 +141,7 @@ ___
141141

142142
**send**(`body`: string): *void*
143143

144-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:495](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L495)*
144+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:578](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L578)*
145145

146146
**Parameters:**
147147

@@ -157,7 +157,7 @@ ___
157157

158158
**setRequestHeader**(`name`: string, `value`: string): *void*
159159

160-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:569](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L569)*
160+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:662](https://github.com/marcelkottmann/esp32-javascript/blob/22ffb3d/components/esp32-javascript/modules/esp32-javascript/http.ts#L662)*
161161

162162
**Parameters:**
163163

0 commit comments

Comments
 (0)