diff --git a/docs/en/flash.md b/docs/en/flash.md index b07b42e9..a2e33832 100644 --- a/docs/en/flash.md +++ b/docs/en/flash.md @@ -1,6 +1,6 @@ Adafruit provides a really nice [firmware flashing tutorial](https://learn.adafruit.com/building-and-running-micropython-on-the-esp8266/flash-firmware). Below you'll find just the basics for the two popular tools esptool and NodeMCU Flasher. -!!! note "Note:" +!!! attention Keep in mind that the ESP8266 needs to be [put into flash mode](#putting-device-into-flash-mode) before you can flash a new firmware! @@ -52,7 +52,7 @@ If upgrading from [SPIFFS](https://github.com/pellepl/spiffs) version 0.3.2 to 0 ## Upgrading from SDK 0.9.x Firmware -!!! note "Note:" +!!! important It goes without saying that you shouldn't expect your NodeMCU 0.9.x Lua scripts to work error-free on a more recent firmware. Most notably Espressif changed the `socket:send` operation to be asynchronous i.e. non-blocking. See [API documentation](modules/net.md#netsocketsend) for details. diff --git a/docs/en/modules/dht.md b/docs/en/modules/dht.md index f6636648..a5b4bc8a 100644 --- a/docs/en/modules/dht.md +++ b/docs/en/modules/dht.md @@ -24,7 +24,7 @@ Read all kinds of DHT sensors, including DHT11, 21, 22, 33, 44 humidity temperat - `temp_dec` temperature decimal - `humi_dec` humidity decimal -!!! note "Note:" +!!! note If using float firmware then `temp` and `humi` are floating point numbers. On an integer firmware, the final values have to be concatenated from `temp` and `temp_dec` / `humi` and `hum_dec`. @@ -67,7 +67,7 @@ Read DHT11 humidity temperature combo sensor. - `temp_dec` temperature decimal - `humi_dec` humidity decimal -!!! note "Note:" +!!! note If using float firmware then `temp` and `humi` are floating point numbers. On an integer firmware, the final values have to be concatenated from `temp` and `temp_dec` / `humi` and `hum_dec`. @@ -90,7 +90,7 @@ Read all kinds of DHT sensors, except DHT11. - `temp_dec` temperature decimal - `humi_dec` humidity decimal -!!! note "Note:" +!!! note If using float firmware then `temp` and `humi` are floating point numbers. On an integer firmware, the final values have to be concatenated from `temp` and `temp_dec` / `humi` and `hum_dec`. diff --git a/docs/en/modules/http.md b/docs/en/modules/http.md index e0377939..04df0bb0 100644 --- a/docs/en/modules/http.md +++ b/docs/en/modules/http.md @@ -5,7 +5,7 @@ Basic HTTP *client* module that provides an interface to do GET/POST/PUT/DELETE over HTTP(S), as well as customized requests. Due to the memory constraints on ESP8266, the supported page/body size is limited by available memory. Attempting to receive pages larger than this will fail. If larger page/body sizes are necessary, consider using [`net.createConnection()`](net.md#netcreateconnection) and stream in the data. -!!! note "Note:" +!!! attention It is **not** possible to execute concurrent HTTP requests using this module. Starting a new request before the previous has completed will result in undefined behavior. Use [`node.task.post()`](https://nodemcu.readthedocs.io/en/master/en/modules/node/#nodetaskpost) in the callbacks of your calls to start subsequent calls if you want to chain them (see [#1258](https://github.com/nodemcu/nodemcu-firmware/issues/1258)). diff --git a/docs/en/modules/node.md b/docs/en/modules/node.md index ebafaccb..7989d708 100644 --- a/docs/en/modules/node.md +++ b/docs/en/modules/node.md @@ -90,7 +90,7 @@ Enters deep sleep mode, wakes up when timed out. The maximum sleep time is 4294967295us, ~71 minutes. This is an SDK limitation. Firmware from before 05 Jan 2016 have a maximum sleeptime of ~35 minutes. -!!! note "Note:" +!!! caution This function can only be used in the condition that esp8266 PIN32(RST) and PIN8(XPD_DCDC aka GPIO16) are connected together. Using sleep(0) will set no wake up timer, connect a GPIO to pin RST, the chip will wake up by a falling-edge on pin RST. @@ -179,7 +179,7 @@ print("NodeMCU "..majorVer.."."..minorVer.."."..devVer) Submits a string to the Lua interpreter. Similar to `pcall(loadstring(str))`, but without the single-line limitation. -!!! note "Note:" +!!! attention This function only has an effect when invoked from a callback. Using it directly on the console **does not work**. @@ -252,7 +252,7 @@ node.led(0) Redirects the Lua interpreter output to a callback function. Optionally also prints it to the serial console. -!!! note "Note:" +!!! caution Do **not** attempt to `print()` or otherwise induce the Lua interpreter to produce output from within the callback function. Doing so results in infinite recursion, and leads to a watchdog-triggered restart. diff --git a/docs/en/modules/pcm.md b/docs/en/modules/pcm.md index 82a49915..6c3c1d73 100644 --- a/docs/en/modules/pcm.md +++ b/docs/en/modules/pcm.md @@ -14,7 +14,7 @@ The external filter circuit is shown in the following schematic. Note that the v ![low-pass filter](../../img/sigma_delta_audiofilter.png "low-pass filter for sigma-delta driver") -!!! note "Note:" +!!! important This driver shares hardware resources with other modules. Thus you can't operate it in parallel to the `sigma delta`, `perf`, or `pwm` modules. They require the sigma-delta generator and the hw_timer, respectively. diff --git a/docs/en/modules/rtcfifo.md b/docs/en/modules/rtcfifo.md index 7c02213a..489cb57b 100644 --- a/docs/en/modules/rtcfifo.md +++ b/docs/en/modules/rtcfifo.md @@ -9,7 +9,7 @@ The rtcfifo module implements a first-in,first-out storage intended for sensor r - Values are limited to 16 bits of precision, but have a separate field for storing an E-n multiplier. This allows for high fidelity even when working with very small values. The effective range is thus 1E-7 to 65535. - Sensor names are limited to a maximum of 4 characters. -!!! note "Important:" +!!! important This module uses two sets of RTC memory slots, 10-20 for its control block, and a variable number of slots for samples and sensor names. By default these span 32-127, but this is configurable. Slots are claimed when [`rtcfifo.prepare()`](#rtcfifoprepare) is called. diff --git a/docs/en/modules/rtctime.md b/docs/en/modules/rtctime.md index 0f834f69..ea175c0c 100644 --- a/docs/en/modules/rtctime.md +++ b/docs/en/modules/rtctime.md @@ -15,7 +15,7 @@ To enable this module, it needs to be given a reference time at least once (via Note that while the rtctime module can keep time across deep sleeps, it *will* lose the time if the module is unexpectedly reset. -!!! note "Important:" +!!! important This module uses RTC memory slots 0-9, inclusive. As soon as [`rtctime.set()`](#rtctimeset) (or [`sntp.sync()`](sntp.md#sntpsync)) has been called these RTC memory slots will be used. diff --git a/docs/en/modules/switec.md b/docs/en/modules/switec.md index 062eb3f9..42b86d97 100644 --- a/docs/en/modules/switec.md +++ b/docs/en/modules/switec.md @@ -26,7 +26,7 @@ is on the step. Then this point can be set as zero. It is important not to let t run into the endstops during normal operation as this will make the pointing inaccurate. This module does not enforce any range limiting. -!!! note "Note:" +!!! important This module uses the hardware timer interrupt and hence it cannot be used at the same time as the PWM module. Both modules can be compiled into the same firmware image, but an application can only use one. It may be possible for an application to alternate between `switec` and `pwm`, but care must be taken. diff --git a/docs/en/modules/wifi.md b/docs/en/modules/wifi.md index 3039d0a5..cb705d54 100644 --- a/docs/en/modules/wifi.md +++ b/docs/en/modules/wifi.md @@ -157,7 +157,7 @@ Intended for use with SmartConfig apps, such as Espressif's [Android & iOS app]( Only usable in `wifi.STATION` mode. -!!! note "Note:" +!!! important SmartConfig is disabled by default and can be enabled by setting `WIFI_SMART_ENABLE` in [`user_config.h`](https://github.com/nodemcu/nodemcu-firmware/blob/dev/app/include/user_config.h#L96) before you build the firmware.