Bläddra i källkod

Change a number of default values

Marcel Stör 8 år sedan
förälder
incheckning
bcbf49f275
5 ändrade filer med 28 tillägg och 24 borttagningar
  1. 3 5
      README.md
  2. 2 3
      app/include/user_config.h
  3. 18 14
      app/include/user_modules.h
  4. 4 0
      docs/en/build.md
  5. 1 2
      docs/en/upload.md

+ 3 - 5
README.md

@@ -64,7 +64,7 @@ The following sections explain some of the options you have if you want to [buil
 
 ### Select Modules
 
-Disable modules you won't be using to reduce firmware size and free up some RAM. The ESP8266 is quite limited in available RAM and running out of memory can cause a system panic. 
+Disable modules you won't be using to reduce firmware size and free up some RAM. The ESP8266 is quite limited in available RAM and running out of memory can cause a system panic. The default configuration is designed to run on all ESP modules including the 512 KB modules like ESP-01 and only includes general purpose interface modules which require at most two GPIO pins.
 
 Edit `app/include/user_modules.h` and comment-out the `#define` statement for modules you don't need. Example:
 
@@ -89,8 +89,8 @@ Identify your firmware builds by editing `app/include/user_version.h`
 
 ### Set UART Bit Rate
 
-The initial baud rate at boot time is 9600bps. You can change this by
-editing `BIT_RATE_DEFAULT`  in `app/include/user_config.h`:
+The initial baud rate at boot time is 115200bps. You can change this by
+editing `BIT_RATE_DEFAULT` in `app/include/user_config.h`:
 
 ```c
 #define BIT_RATE_DEFAULT BIT_RATE_115200
@@ -103,5 +103,3 @@ To enable runtime debug messages to serial console edit `app/include/user_config
 ```c
 #define DEVELOP_VERSION
 ```
-
-`DEVELOP_VERSION` changes the startup baud rate to 74880bps.

+ 2 - 3
app/include/user_config.h

@@ -21,9 +21,8 @@
 #ifdef DEVELOP_VERSION
 #define NODE_DEBUG
 #define COAP_DEBUG
-#define BIT_RATE_DEFAULT BIT_RATE_74880
 #else
-#define BIT_RATE_DEFAULT BIT_RATE_9600
+#define BIT_RATE_DEFAULT BIT_RATE_115200
 #endif /* DEVELOP_VERSION */
 
 
@@ -54,7 +53,7 @@
 #define NO_INTR_CODE inline
 #endif
 
-#define CLIENT_SSL_ENABLE
+//#define CLIENT_SSL_ENABLE
 //#define MD2_ENABLE
 #define SHA2_ENABLE
 

+ 18 - 14
app/include/user_modules.h

@@ -13,21 +13,25 @@
 
 #ifndef LUA_CROSS_COMPILER
 
+// The default configuration is designed to run on all ESP modules including the 512 KB modules like ESP-01 and only
+// includes general purpose interface modules which require at most two GPIO pins.
+// See https://github.com/nodemcu/nodemcu-firmware/pull/1127 for discussions.
+// New modules should be disabled by default and added in alphabetical order.
 #define LUA_USE_MODULES_ADC
 //#define LUA_USE_MODULES_AM2320
 //#define LUA_USE_MODULES_APA102
 #define LUA_USE_MODULES_BIT
 //#define LUA_USE_MODULES_BMP085
 //#define LUA_USE_MODULES_BME280
-#define LUA_USE_MODULES_CJSON
-#define LUA_USE_MODULES_COAP
-#define LUA_USE_MODULES_CRYPTO
+//#define LUA_USE_MODULES_CJSON
+//#define LUA_USE_MODULES_COAP
+//#define LUA_USE_MODULES_CRYPTO
 #define LUA_USE_MODULES_DHT
-#define LUA_USE_MODULES_ENCODER
+//#define LUA_USE_MODULES_ENCODER
 //#define LUA_USE_MODULES_ENDUSER_SETUP // USE_DNS in dhcpserver.h needs to be enabled for this module to work.
 #define LUA_USE_MODULES_FILE
 #define LUA_USE_MODULES_GPIO
-#define LUA_USE_MODULES_HTTP
+//#define LUA_USE_MODULES_HTTP
 //#define LUA_USE_MODULES_HX711
 #define LUA_USE_MODULES_I2C
 //#define LUA_USE_MODULES_MDNS
@@ -36,24 +40,24 @@
 #define LUA_USE_MODULES_NODE
 #define LUA_USE_MODULES_OW
 //#define LUA_USE_MODULES_PERF
-#define LUA_USE_MODULES_PWM
-#define LUA_USE_MODULES_RC
+//#define LUA_USE_MODULES_PWM
+//#define LUA_USE_MODULES_RC
 //#define LUA_USE_MODULES_ROTARY
-#define LUA_USE_MODULES_RTCFIFO
-#define LUA_USE_MODULES_RTCMEM
-#define LUA_USE_MODULES_RTCTIME
+//#define LUA_USE_MODULES_RTCFIFO
+//#define LUA_USE_MODULES_RTCMEM
+//#define LUA_USE_MODULES_RTCTIME
 //#define LUA_USE_MODULES_SIGMA_DELTA
-#define LUA_USE_MODULES_SNTP
+//#define LUA_USE_MODULES_SNTP
 #define LUA_USE_MODULES_SPI
 //#define LUA_USE_MODULES_STRUCT
 #define LUA_USE_MODULES_TMR
-#define LUA_USE_MODULES_TSL2561
-#define LUA_USE_MODULES_U8G
+//#define LUA_USE_MODULES_TSL2561
+//#define LUA_USE_MODULES_U8G
 #define LUA_USE_MODULES_UART
 //#define LUA_USE_MODULES_UCG
 #define LUA_USE_MODULES_WIFI
 //#define LUA_USE_MODULES_WS2801
-#define LUA_USE_MODULES_WS2812
+//#define LUA_USE_MODULES_WS2812
 
 
 #endif  /* LUA_CROSS_COMPILER */

+ 4 - 0
docs/en/build.md

@@ -1,5 +1,9 @@
 There are essentially three ways to build your NodeMCU firmware: cloud build service, Docker image, dedicated Linux environment (possibly VM).
 
+**Building manually**
+
+Note that the *default configuration in the C header files* (`user_config.h`, `user_modules.h`) is designed to run on all ESP modules including the 512 KB modules like ESP-01 and only includes general purpose interface modules which require at most two GPIO pins.
+
 ## Cloud Build Service
 NodeMCU "application developers" just need a ready-made firmware. There's a [cloud build service](http://nodemcu-build.com/) with a nice UI and configuration options for them.
 

+ 1 - 2
docs/en/upload.md

@@ -1,7 +1,6 @@
 As with [flashing](flash.md) there are several ways to upload code from your computer to the device.
 
-Note that the NodeMCU serial interface uses 9600 bps at boot time. To increase the speed after booting, issue `uart.setup(0,115200,8,0,1,1)`. ESPlorer will do this automatically when changing the speed in the dropdown list.
-If the device panics and resets at any time, errors will be written to the serial interface at 115200 bps.
+Note that the NodeMCU serial interface uses 115200bps at boot time. To change the speed after booting, issue `uart.setup(0,9600,8,0,1,1)`. ESPlorer will do this automatically when changing the speed in the dropdown list. If the device panics and resets at any time, errors will be written to the serial interface at 115200 bps.
 
 # ESPlorer