Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ruanhaishen
Nodemcu Firmware
Commits
ebcf6b77
Commit
ebcf6b77
authored
Jan 07, 2016
by
devsaurus
Browse files
fix delimiters after list
parent
f2babb9c
Changes
8
Show whitespace changes
Inline
Side-by-side
docs/en/modules/file.md
View file @
ebcf6b77
...
@@ -49,6 +49,7 @@ Format the file system. Completely erases any existing file system and writes a
...
@@ -49,6 +49,7 @@ Format the file system. Completely erases any existing file system and writes a
####See also
####See also
-
`file.remove()`
-
`file.remove()`
__
_
__
_
## file.list()
## file.list()
...
@@ -147,6 +148,7 @@ When done with the file, it must be closed using `file.close()`.
...
@@ -147,6 +148,7 @@ When done with the file, it must be closed using `file.close()`.
####See also
####See also
- `
file.close()
`
- `
file.close()
`
- `
file.readline()
`
- `
file.readline()
`
___
___
## file.close()
## file.close()
...
@@ -171,6 +173,7 @@ Closes the open file, if any.
...
@@ -171,6 +173,7 @@ Closes the open file, if any.
```
```
####See also
####See also
- `
file.open()
`
- `
file.open()
`
___
___
## file.readline()
## file.readline()
...
@@ -197,6 +200,7 @@ File content in string, line by line, include EOL('\n'). Return `nil` when EOF.
...
@@ -197,6 +200,7 @@ File content in string, line by line, include EOL('\n'). Return `nil` when EOF.
- `
file.open()
`
- `
file.open()
`
- `
file.close()
`
- `
file.close()
`
- `
file.read()
`
- `
file.read()
`
___
___
## file.writeline()
## file.writeline()
...
@@ -224,6 +228,7 @@ Write a string to the open file and append '\n' at the end.
...
@@ -224,6 +228,7 @@ Write a string to the open file and append '\n' at the end.
####See also
####See also
- `
file.open()
`
- `
file.open()
`
- `
file.readline()
`
- `
file.readline()
`
___
___
## file.read()
## file.read()
...
@@ -256,6 +261,7 @@ File content in string, or nil when EOF.
...
@@ -256,6 +261,7 @@ File content in string, or nil when EOF.
####See also
####See also
- `
file.open()
`
- `
file.open()
`
- `
file.readline()
`
- `
file.readline()
`
___
___
## file.write()
## file.write()
...
@@ -283,6 +289,7 @@ Write a string to the open file.
...
@@ -283,6 +289,7 @@ Write a string to the open file.
####See also
####See also
- `
file.open()
`
- `
file.open()
`
- `
file.writeline()
`
- `
file.writeline()
`
___
___
## file.flush()
## file.flush()
...
@@ -310,6 +317,7 @@ Flushes any pending writes to the file system, ensuring no data is lost on a res
...
@@ -310,6 +317,7 @@ Flushes any pending writes to the file system, ensuring no data is lost on a res
```
```
####See also
####See also
- `
file.close()
`
- `
file.close()
`
___
___
## file.seek()
## file.seek()
Sets and gets the file position, measured from the beginning of the file, to the position given by offset plus a base specified by the string whence.
Sets and gets the file position, measured from the beginning of the file, to the position given by offset plus a base specified by the string whence.
...
@@ -339,4 +347,5 @@ The resulting file position, or `nil` on error.
...
@@ -339,4 +347,5 @@ The resulting file position, or `nil` on error.
```
```
####See also
####See also
- `
file.open()
`
- `
file.open()
`
__
_
__
_
docs/en/modules/gpio.md
View file @
ebcf6b77
...
@@ -41,6 +41,7 @@ gpio.mode(0, gpio.OUTPUT)
...
@@ -41,6 +41,7 @@ gpio.mode(0, gpio.OUTPUT)
####See also
####See also
-
`gpio.read()`
-
`gpio.read()`
-
`gpio.write()`
-
`gpio.write()`
__
_
__
_
## gpio.read()
## gpio.read()
...
@@ -62,6 +63,7 @@ gpio.read(0)
...
@@ -62,6 +63,7 @@ gpio.read(0)
```
```
####See also
####See also
-
`gpio.mode()`
-
`gpio.mode()`
__
_
__
_
## gpio.write ()
## gpio.write ()
...
@@ -87,6 +89,7 @@ gpio.write(pin, gpio.HIGH)
...
@@ -87,6 +89,7 @@ gpio.write(pin, gpio.HIGH)
####See also
####See also
-
`gpio.mode()`
-
`gpio.mode()`
-
`gpio.read()`
-
`gpio.read()`
__
_
__
_
## gpio.trig()
## gpio.trig()
...
@@ -126,6 +129,7 @@ gpio.trig(pin, "down", pin1cb)
...
@@ -126,6 +129,7 @@ gpio.trig(pin, "down", pin1cb)
```
```
####See also
####See also
-
`gpio.mode()`
-
`gpio.mode()`
__
_
__
_
## gpio.serout()
## gpio.serout()
...
...
docs/en/modules/node.md
View file @
ebcf6b77
...
@@ -189,6 +189,7 @@ This function is only available if the firmware was compiled with DEVKIT_VERSION
...
@@ -189,6 +189,7 @@ This function is only available if the firmware was compiled with DEVKIT_VERSION
```
```
####See also
####See also
-
`node.led()`
-
`node.led()`
__
_
__
_
## node.led() --deprecated
## node.led() --deprecated
...
@@ -215,6 +216,7 @@ This function is only available if the firmware was compiled with DEVKIT_VERSION
...
@@ -215,6 +216,7 @@ This function is only available if the firmware was compiled with DEVKIT_VERSION
####See also
####See also
-
`node.key()`
-
`node.key()`
__
_
__
_
## node.input()
## node.input()
...
@@ -241,6 +243,7 @@ Submit a string to the Lua interpreter. Similar to `pcall(loadstring(str))`, but
...
@@ -241,6 +243,7 @@ Submit a string to the Lua interpreter. Similar to `pcall(loadstring(str))`, but
####See also
####See also
-
`node.output()`
-
`node.output()`
__
_
__
_
## node.output()
## node.output()
...
@@ -291,10 +294,12 @@ Redirects the Lua interpreter output to a callback function. Optionally also pri
...
@@ -291,10 +294,12 @@ Redirects the Lua interpreter output to a callback function. Optionally also pri
```
```
####See also
####See also
-
`node.input()`
-
`node.input()`
__
_
__
_
## node.readvdd33() --deprecated, moved to adc.readvdd33()
## node.readvdd33() --deprecated, moved to adc.readvdd33()
####See also
####See also
-
`adc.readvdd33()`
-
`adc.readvdd33()`
__
_
__
_
## node.compile()
## node.compile()
...
@@ -393,4 +398,5 @@ node.compile('bigstuff.lua')
...
@@ -393,4 +398,5 @@ node.compile('bigstuff.lua')
####See also
####See also
- `
node.compile()
`
- `
node.compile()
`
__
_
__
_
docs/en/modules/rtcfifo.md
View file @
ebcf6b77
...
@@ -43,6 +43,7 @@ rtcfifo.prepare({storage_begin=21, storage_end=128}) -- Use RTC slots 19 and up
...
@@ -43,6 +43,7 @@ rtcfifo.prepare({storage_begin=21, storage_end=128}) -- Use RTC slots 19 and up
```
```
####See also
####See also
-
`rtcfifo.ready()`
-
`rtcfifo.ready()`
__
_
__
_
## rtcfifo.ready()
## rtcfifo.ready()
...
@@ -64,6 +65,7 @@ end
...
@@ -64,6 +65,7 @@ end
```
```
####See also
####See also
- `rtcfifo.prepare()`
- `rtcfifo.prepare()`
___
___
## rtcfifo.put()
## rtcfifo.put()
...
@@ -156,4 +158,5 @@ rtcfifo.dsleep_until_sample(0) -- deep sleep until it's time to take the next sa
...
@@ -156,4 +158,5 @@ rtcfifo.dsleep_until_sample(0) -- deep sleep until it's time to take the next sa
```
```
####See also
####See also
- `rtctime.dsleep_aligned()`
- `rtctime.dsleep_aligned()`
___
___
docs/en/modules/rtcmem.md
View file @
ebcf6b77
...
@@ -34,6 +34,7 @@ val1, val2 = rtcmem.read32(42, 2) -- Read the values in slots 42 and 43
...
@@ -34,6 +34,7 @@ val1, val2 = rtcmem.read32(42, 2) -- Read the values in slots 42 and 43
```
```
####See also
####See also
-
`rtcmem.write32()`
-
`rtcmem.write32()`
__
_
__
_
## rtcmem.write32()
## rtcmem.write32()
...
@@ -59,4 +60,5 @@ rtcmem.write32(42, 2, 5, 7) -- Store the values 2, 5 and 7 into slots 42, 43 and
...
@@ -59,4 +60,5 @@ rtcmem.write32(42, 2, 5, 7) -- Store the values 2, 5 and 7 into slots 42, 43 and
```
```
####See also
####See also
-
`rtcmem.read32()`
-
`rtcmem.read32()`
__
_
__
_
docs/en/modules/rtctime.md
View file @
ebcf6b77
...
@@ -44,6 +44,7 @@ rtctime.set(1436430589, 0) -- Set time to 2015 July 9, 18:29:49
...
@@ -44,6 +44,7 @@ rtctime.set(1436430589, 0) -- Set time to 2015 July 9, 18:29:49
```
```
####See also
####See also
-
`sntp.sync()`
-
`sntp.sync()`
__
_
__
_
## rtctime.get()
## rtctime.get()
...
@@ -66,6 +67,7 @@ sec, usec = rtctime.get()
...
@@ -66,6 +67,7 @@ sec, usec = rtctime.get()
```
```
####See also
####See also
-
`rtctime.set()`
-
`rtctime.set()`
__
_
__
_
## rtctime.dsleep()
## rtctime.dsleep()
...
...
docs/en/modules/sntp.md
View file @
ebcf6b77
...
@@ -40,4 +40,5 @@ sntp.sync('192.168.0.1',
...
@@ -40,4 +40,5 @@ sntp.sync('192.168.0.1',
```
```
####See also
####See also
-
`rtctime.set()`
-
`rtctime.set()`
__
_
__
_
docs/en/modules/tmr.md
View file @
ebcf6b77
...
@@ -40,6 +40,7 @@ tmr.start(0)
...
@@ -40,6 +40,7 @@ tmr.start(0)
```
```
####See also
####See also
-
`tmr.alarm()`
-
`tmr.alarm()`
__
_
__
_
## tmr.unregister()
## tmr.unregister()
...
@@ -62,6 +63,7 @@ tmr.unregister(0)
...
@@ -62,6 +63,7 @@ tmr.unregister(0)
```
```
####See also
####See also
-
`tmr.register()`
-
`tmr.register()`
__
_
__
_
## tmr.start()
## tmr.start()
...
@@ -85,6 +87,7 @@ if not tmr.start(0) then print("uh oh") end
...
@@ -85,6 +87,7 @@ if not tmr.start(0) then print("uh oh") end
-
`tmr.register()`
-
`tmr.register()`
-
`tmr.stop()`
-
`tmr.stop()`
-
`tmr.unregister()`
-
`tmr.unregister()`
__
_
__
_
## tmr.stop()
## tmr.stop()
...
@@ -107,6 +110,7 @@ if not tmr.stop(2) then print("timer 2 not stopped, not registered?") end
...
@@ -107,6 +110,7 @@ if not tmr.stop(2) then print("timer 2 not stopped, not registered?") end
-
`tmr.register()`
-
`tmr.register()`
-
`tmr.stop()`
-
`tmr.stop()`
-
`tmr.unregister()`
-
`tmr.unregister()`
__
_
__
_
## tmr.interval()
## tmr.interval()
...
@@ -173,6 +177,7 @@ if not tmr.alarm(0, 5000, tmr.ALARM_SINGLE, function() print("hey there") end) t
...
@@ -173,6 +177,7 @@ if not tmr.alarm(0, 5000, tmr.ALARM_SINGLE, function() print("hey there") end) t
-
`tmr.register()`
-
`tmr.register()`
-
`tmr.start()`
-
`tmr.start()`
-
`tmr.unregister()`
-
`tmr.unregister()`
__
_
__
_
## tmr.now()
## tmr.now()
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment