Skip to content

Commit bfe0ae2

Browse files
committed
update SPI API
1 parent a79eed3 commit bfe0ae2

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

docs/doc/en/peripheral/spi.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,19 @@ for pin, func in pin_function.items():
114114

115115
spidev = spi.SPI(spi_id, spi.Mode.MASTER, 1250000)
116116

117-
### Example of full parameter passing.
117+
### Example of full parameter passing, fully documention see API documentation.
118118
# spidev = spi.SPI(id=4, # SPI ID
119119
# mode=spi.Mode.MASTER, # SPI mode
120120
# freq=1250000, # SPI speed
121121
# polarity=0, # CPOL 0/1, default is 0
122122
# phase=0, # CPHA 0/1, default is 0
123123
# bits=8, # Bits of SPI, default is 8
124-
# cs_enable=True, # Use soft CS pin? True/False, default is False
125-
# cs='GPIOA19') # Soft cs pin number, default is 'GPIOA19'
124+
# hw_cs=-1, # use default hardware cs.
125+
# soft_cs="", # If you want use soft cs, set GPIO name,
126+
# # e.g. GPIOA19(MaixCAM), GPIO0_A2(MaixCAM2)
127+
# # you should set pinmap first by yourself.
128+
# cs_active_low=true # cs pin active low voltage level
129+
126130

127131
b = bytes(range(0, 8))
128132

docs/doc/zh/peripheral/spi.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,19 @@ for pin, func in pin_function.items():
115115

116116
spidev = spi.SPI(spi_id, spi.Mode.MASTER, 1250000)
117117

118-
### Example of full parameter passing.
118+
### Example of full parameter passing, fully documention see API documentation.
119119
# spidev = spi.SPI(id=4, # SPI ID
120120
# mode=spi.Mode.MASTER, # SPI mode
121121
# freq=1250000, # SPI speed
122122
# polarity=0, # CPOL 0/1, default is 0
123123
# phase=0, # CPHA 0/1, default is 0
124124
# bits=8, # Bits of SPI, default is 8
125-
# cs_enable=True, # Use soft CS pin? True/False, default is False
126-
# cs='GPIOA19') # Soft cs pin number, default is 'GPIOA19'
125+
# hw_cs=-1, # use default hardware cs.
126+
# soft_cs="", # If you want use soft cs, set GPIO name,
127+
# # e.g. GPIOA19(MaixCAM), GPIO0_A2(MaixCAM2)
128+
# # you should set pinmap first by yourself.
129+
# cs_active_low=true # cs pin active low voltage level
130+
127131

128132
b = bytes(range(0, 8))
129133

examples/peripheral/spi/spi_loopback.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,18 @@
2525

2626
spidev = spi.SPI(spi_id, spi.Mode.MASTER, 1250000)
2727

28-
### Example of full parameter passing.
28+
### Example of full parameter passing, fully documention see API documentation.
2929
# spidev = spi.SPI(id=4, # SPI ID
3030
# mode=spi.Mode.MASTER, # SPI mode
3131
# freq=1250000, # SPI speed
3232
# polarity=0, # CPOL 0/1, default is 0
3333
# phase=0, # CPHA 0/1, default is 0
3434
# bits=8, # Bits of SPI, default is 8
35-
# cs_enable=True, # Use soft CS pin? True/False, default is False
36-
# cs='GPIOA19') # Soft cs pin number, default is 'GPIOA19'
35+
# hw_cs=-1, # use default hardware cs.
36+
# soft_cs="", # If you want use soft cs, set GPIO name,
37+
# # e.g. GPIOA19(MaixCAM), GPIO0_A2(MaixCAM2)
38+
# # you should set pinmap first by yourself.
39+
# cs_active_low=true # cs pin active low voltage level
3740

3841
b = bytes(range(0, 8))
3942

0 commit comments

Comments
 (0)