Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ruanhaishen
Nodemcu Firmware
Commits
52ed168c
Commit
52ed168c
authored
May 13, 2017
by
devsaurus
Browse files
fix gpio doc, refer to gpio overview from module docs
parent
209bde60
Changes
6
Show whitespace changes
Inline
Side-by-side
docs/en/modules/dht.md
View file @
52ed168c
...
@@ -15,7 +15,7 @@ Read DHT11 humidity temperature combo sensor.
...
@@ -15,7 +15,7 @@ Read DHT11 humidity temperature combo sensor.
`dht.read11(pin)`
`dht.read11(pin)`
#### Parameters
#### Parameters
`pin`
0~33,
IO index
`pin`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
-
`status`
as defined in Constants
-
`status`
as defined in Constants
...
@@ -45,7 +45,7 @@ Read DHT21/22/33/43 and AM2301/2302/2303 humidity temperature combo sensors.
...
@@ -45,7 +45,7 @@ Read DHT21/22/33/43 and AM2301/2302/2303 humidity temperature combo sensors.
`dht.read2x(pin)`
`dht.read2x(pin)`
#### Parameters
#### Parameters
`pin`
0~33,
IO index
`pin`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
-
`status`
as defined in Constants
-
`status`
as defined in Constants
...
...
docs/en/modules/gpio.md
View file @
52ed168c
...
@@ -57,7 +57,7 @@ Read digital GPIO pin value.
...
@@ -57,7 +57,7 @@ Read digital GPIO pin value.
`gpio.read(pin)`
`gpio.read(pin)`
#### Parameters
#### Parameters
`pin`
pin to read,
0 ~ 33 I/O index
`pin`
pin to read,
see
[
GPIO Overview
](
#gpio-overview
)
#### Returns
#### Returns
0 = low, 1 = high
0 = low, 1 = high
...
@@ -70,13 +70,13 @@ Establish or clear a callback function to run on interrupt for a GPIO.
...
@@ -70,13 +70,13 @@ Establish or clear a callback function to run on interrupt for a GPIO.
`gpio.trig(pin, type [, callback])`
`gpio.trig(pin, type [, callback])`
#### Parameters
#### Parameters
-
`pin`
0 ~ 33 I/O index
-
`pin`
, see
[
GPIO Overview
](
#gpio-overview
)
-
`type`
trigger type, one of
-
`type`
trigger type, one of
-
`INTR_UP`
for trigger on rising edge
-
`
gpio.
INTR_UP`
for trigger on rising edge
-
`INTR_DOWN`
for trigger on falling edge
-
`
gpio.
INTR_DOWN`
for trigger on falling edge
-
`INTR_UP_DOWN`
for trigger on both edges
-
`
gpio.
INTR_UP_DOWN`
for trigger on both edges
-
`INTR_LOW`
for trigger on low level
-
`
gpio.
INTR_LOW`
for trigger on low level
-
`INTR_HIGH`
for trigger on high level
-
`
gpio.
INTR_HIGH`
for trigger on high level
-
`callback`
optional function to be called when trigger fires, trigger is disabled when omitted. Parameters are:
-
`callback`
optional function to be called when trigger fires, trigger is disabled when omitted. Parameters are:
-
`pin`
-
`pin`
-
`level`
-
`level`
...
@@ -91,11 +91,11 @@ Configuring wake-from-sleep-on-GPIO-level.
...
@@ -91,11 +91,11 @@ Configuring wake-from-sleep-on-GPIO-level.
`gpio.wakeup(pin, level)`
`gpio.wakeup(pin, level)`
#### Parameters
#### Parameters
-
`pin`
0 ~ 33 I/O index
-
`pin`
, see
[
GPIO Overview
](
#gpio-overview
)
-
`level`
wake-up level, one of
-
`level`
wake-up level, one of
-
`INTR_NONE`
to disable wake-up
-
`
gpio.
INTR_NONE`
to disable wake-up
-
`INTR_LOW`
for wake-up on low level
-
`
gpio.
INTR_LOW`
for wake-up on low level
-
`INTR_HIGH`
for wake-up on high level
-
`
gpio.
INTR_HIGH`
for wake-up on high level
#### Returns
#### Returns
`nil`
`nil`
...
@@ -108,8 +108,8 @@ Set digital GPIO pin value.
...
@@ -108,8 +108,8 @@ Set digital GPIO pin value.
`gpio.write(pin, level)`
`gpio.write(pin, level)`
#### Parameters
#### Parameters
-
`pin`
pin to write,
0 ~ 33 I/O index
-
`pin`
pin to write,
see
[
GPIO Overview
](
#gpio-overview
)
-
`level`
`gpio.HIGH`
or
`gpio.LOW`
-
`level`
1 or 0
#### Returns
#### Returns
`nil`
`nil`
docs/en/modules/i2c.md
View file @
52ed168c
...
@@ -83,8 +83,8 @@ Initialize the I²C interface for master mode.
...
@@ -83,8 +83,8 @@ Initialize the I²C interface for master mode.
####Parameters
####Parameters
-
`id`
interface id
-
`id`
interface id
-
`pinSDA`
0~33,
IO index
-
`pinSDA`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`pinSCL`
0-33,
IO index
-
`pinSCL`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`speed`
bit rate in Hz, positive integer
-
`speed`
bit rate in Hz, positive integer
-
`i2c.SLOW`
for 100000 Hz, max for
`i2c.SW`
-
`i2c.SLOW`
for 100000 Hz, max for
`i2c.SW`
-
`i2c.FAST`
for 400000 Hz
-
`i2c.FAST`
for 400000 Hz
...
@@ -196,8 +196,8 @@ Initialize the I²C interface for slave mode.
...
@@ -196,8 +196,8 @@ Initialize the I²C interface for slave mode.
#### Parameters
#### Parameters
-
`id`
interface id,
`i2c.HW0`
or
`i2c.HW1`
-
`id`
interface id,
`i2c.HW0`
or
`i2c.HW1`
-
`slave_config`
table containing slave configuration information
-
`slave_config`
table containing slave configuration information
-
`sda`
0~33,
IO index
-
`sda`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`scl`
0-33,
IO index
-
`scl`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`addr`
slave address (7bit or 10bit)
-
`addr`
slave address (7bit or 10bit)
-
`10bit`
enable 10bit addressing with
`true`
, use 7bit with
`false`
(optional, defaults to
`false`
is omitted)
-
`10bit`
enable 10bit addressing with
`true`
, use 7bit with
`false`
(optional, defaults to
`false`
is omitted)
-
`rxbuf_len`
length of receive buffer (optional, defaults to 128 if omitted)
-
`rxbuf_len`
length of receive buffer (optional, defaults to 128 if omitted)
...
...
docs/en/modules/ow.md
View file @
52ed168c
...
@@ -55,7 +55,7 @@ Stops forcing power onto the bus. You only need to do this if you used the 'powe
...
@@ -55,7 +55,7 @@ Stops forcing power onto the bus. You only need to do this if you used the 'powe
`ow.depower(pin)`
`ow.depower(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
`nil`
`nil`
...
@@ -71,7 +71,7 @@ Reads a byte.
...
@@ -71,7 +71,7 @@ Reads a byte.
`ow.read(pin)`
`ow.read(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
byte read from slave device
byte read from slave device
...
@@ -83,7 +83,7 @@ Reads multi bytes.
...
@@ -83,7 +83,7 @@ Reads multi bytes.
`ow.read_bytes(pin, size)`
`ow.read_bytes(pin, size)`
#### Parameters
#### Parameters
-
`pin`
0~33, I/O index
-
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`size`
number of bytes to be read from slave device (up to 256)
-
`size`
number of bytes to be read from slave device (up to 256)
#### Returns
#### Returns
...
@@ -96,7 +96,7 @@ Performs a 1-Wire reset cycle.
...
@@ -96,7 +96,7 @@ Performs a 1-Wire reset cycle.
`ow.reset(pin)`
`ow.reset(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
-
`1`
if a device responds with a presence pulse
-
`1`
if a device responds with a presence pulse
...
@@ -109,7 +109,7 @@ Clears the search state so that it will start from the beginning again.
...
@@ -109,7 +109,7 @@ Clears the search state so that it will start from the beginning again.
`ow.reset_search(pin)`
`ow.reset_search(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
`nil`
`nil`
...
@@ -121,7 +121,7 @@ Looks for the next device.
...
@@ -121,7 +121,7 @@ Looks for the next device.
`ow.search(pin)`
`ow.search(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
`rom_code`
string with length of 8 upon success. It contains the rom code of slave device. Returns
`nil`
if search was unsuccessful.
`rom_code`
string with length of 8 upon success. It contains the rom code of slave device. Returns
`nil`
if search was unsuccessful.
...
@@ -136,7 +136,7 @@ Issues a 1-Wire rom select command. Make sure you do the `ow.reset(pin)` first.
...
@@ -136,7 +136,7 @@ Issues a 1-Wire rom select command. Make sure you do the `ow.reset(pin)` first.
`ow.select(pin, rom)`
`ow.select(pin, rom)`
#### Parameters
#### Parameters
-
`pin`
0~33, I/O index
-
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`rom`
string value, len 8, rom code of the slave device
-
`rom`
string value, len 8, rom code of the slave device
#### Returns
#### Returns
...
@@ -204,7 +204,7 @@ Sets a pin in onewire mode.
...
@@ -204,7 +204,7 @@ Sets a pin in onewire mode.
`ow.setup(pin)`
`ow.setup(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
`nil`
`nil`
...
@@ -216,7 +216,7 @@ Issues a 1-Wire rom skip command, to address all on bus.
...
@@ -216,7 +216,7 @@ Issues a 1-Wire rom skip command, to address all on bus.
`ow.skip(pin)`
`ow.skip(pin)`
#### Parameters
#### Parameters
`pin`
0~33, I/O index
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
#### Returns
#### Returns
`nil`
`nil`
...
@@ -228,7 +228,7 @@ Sets up the search to find the device type `family_code`. The search itself has
...
@@ -228,7 +228,7 @@ Sets up the search to find the device type `family_code`. The search itself has
`ow.target_search(pin, family_code)`
`ow.target_search(pin, family_code)`
#### Parameters
#### Parameters
-
`pin`
0~33, I/O index
-
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`family_code`
byte for family code
-
`family_code`
byte for family code
#### Returns
#### Returns
...
@@ -244,7 +244,7 @@ Writes a byte. If `power` is 1 then the wire is held high at the end for parasit
...
@@ -244,7 +244,7 @@ Writes a byte. If `power` is 1 then the wire is held high at the end for parasit
`ow.write(pin, v, power)`
`ow.write(pin, v, power)`
#### Parameters
#### Parameters
-
`pin`
0~33, I/O index
-
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`v`
byte to be written to slave device
-
`v`
byte to be written to slave device
-
`power`
1 for wire being held high for parasitically powered devices
-
`power`
1 for wire being held high for parasitically powered devices
...
@@ -261,7 +261,7 @@ Writes multi bytes. If `power` is 1 then the wire is held high at the end for pa
...
@@ -261,7 +261,7 @@ Writes multi bytes. If `power` is 1 then the wire is held high at the end for pa
`ow.write_bytes(pin, buf, power)`
`ow.write_bytes(pin, buf, power)`
#### Parameters
#### Parameters
-
`pin`
0~33,
IO index
-
`pin`
IO index
, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`buf`
string to be written to slave device
-
`buf`
string to be written to slave device
-
`power`
1 for wire being held high for parasitically powered devices
-
`power`
1 for wire being held high for parasitically powered devices
...
...
docs/en/modules/sigma-delta.md
View file @
52ed168c
...
@@ -59,7 +59,7 @@ Routes the sigma-delta channel to the specified pin. Target prescale and duty va
...
@@ -59,7 +59,7 @@ Routes the sigma-delta channel to the specified pin. Target prescale and duty va
#### Parameters
#### Parameters
- `
channel
` 0~7, sigma-delta channel index
- `
channel
` 0~7, sigma-delta channel index
- `
pin
`
0~33,
IO index
- `
pin
` IO index
, see [GPIO Overview](gpio.md#gpio-overview)
#### Returns
#### Returns
`
nil
`
`
nil
`
...
...
docs/en/modules/ws2812.md
View file @
52ed168c
...
@@ -18,7 +18,7 @@ Send data to up to 8 led strip using its native format which is generally Green,
...
@@ -18,7 +18,7 @@ Send data to up to 8 led strip using its native format which is generally Green,
#### Parameters
#### Parameters
Variable number of tables, each describing a single strip. Required elements are:
Variable number of tables, each describing a single strip. Required elements are:
-
`pin`
0 ~ 33, I/O index
-
`pin`
IO index, see
[
GPIO Overview
](
gpio.md#gpio-overview
)
-
`data`
payload to be sent to one or more WS2812 like leds through GPIO2
-
`data`
payload to be sent to one or more WS2812 like leds through GPIO2
Payload type could be:
Payload type could be:
...
@@ -316,6 +316,3 @@ The concatenated buffer.
...
@@ -316,6 +316,3 @@ The concatenated buffer.
```
```
ws2812.write({pin = 4, data = buffer1 .. buffer2})
ws2812.write({pin = 4, data = buffer1 .. buffer2})
```
```
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