JavaScriptNexus
diff --git a/Collapse file
‎packages/spi/src/spi.ts‎
Copy file name to clipboardExpand all lines: packages/spi/src/spi.ts
+31-1Lines changed: 31 additions & 1 deletion b/Collapse file
‎packages/spi/src/spi.ts‎
Copy file name to clipboardExpand all lines: packages/spi/src/spi.ts
+31-1Lines changed: 31 additions & 1 deletion
diff --git a/Collapse file
‎website/docs/developer/servers/spi.mdx‎
Copy file name to clipboardExpand all lines: website/docs/developer/servers/spi.mdx
+40-3Lines changed: 40 additions & 3 deletions
Display the source diff
Display the rich diff b/Collapse file
‎website/docs/developer/servers/spi.mdx‎
Copy file name to clipboardExpand all lines: website/docs/developer/servers/spi.mdx
+40-3Lines changed: 40 additions & 3 deletions
Display the source diff
Display the rich diff
@@ -1,10 +1,25 @@
 import * as ds from "@devicescript/core"
 
+/**
+ * SPI configuration options
+ */
 export interface SPIConfig {
+    /**
+     * MISO pin
+     */
     miso?: ds.InputPin
+    /**
+     * MOSI pin
+     */
     mosi?: ds.OutputPin
+    /**
+     * SCK pin
+     */
     sck?: ds.OutputPin
     mode?: number
+    /**
+     * Clock speed in Hz
+     */
     hz?: number
 }
 
@@ -23,6 +38,10 @@ function pinNum(p: ds.Pin) {
     return p ? p.gpio : -1
 }
 
+/**
+ * Configure the SPI bus
+ * @param cfg a set of configuration options
+ */
 export function spiConfigure(cfg: SPIConfig) {
     ;(ds as DsSpi).spiConfigure(
         pinNum(cfg.miso),
@@ -33,17 +52,28 @@ export function spiConfigure(cfg: SPIConfig) {
     )
 }
 
+/**
+ * Write a buffer to the SPI bus
+ */
 export async function spiWrite(buf: Buffer) {
     await (ds as DsSpi).spiXfer(buf, null)
 }
 
+/**
+ * Reads a buffer from the SPI bus
+ */
 export async function spiRead(numbytes: number) {
     const r = Buffer.alloc(numbytes)
     await (ds as DsSpi).spiXfer(null, r)
     return r
 }
 
-export async function spiXfer(buf: Buffer) {
+/**
+ * Transfers a buffer to and from the SPI bus
+ * @param buf buffer to send
+ * @returns buffer received of the same size
+ */
+export async function spiTransfer(buf: Buffer) {
     const r = Buffer.alloc(buf.length)
     await (ds as DsSpi).spiXfer(buf, r)
     return r
 
@@ -5,8 +5,45 @@ sidebar_position: 101
 
 # SPI
 
-:::info
+SPI [builtin package](/developer/packages) that exposes functions to read, write, transfer buffers over SPI.
 
-TODO
+## `spiConfigure`
 
-:::
+The `spiConfigure` function is used to configure the SPI bus. It takes the pin configuration, frequency and mode.
+
+```ts
+import { spiConfigure } from "@devicescript/spi"
+
+await spiConfigure({})
+```
+
+## `spiRead`
+
+The `spiRead` function is used to read a buffer from the SPI bus.
+
+```ts
+import { spiRead } from "@devicescript/spi"
+
+const res = await spiRead(8) // read 8 bytes
+```
+
+## `spiWrite`
+
+The `spiWrite` function is used to write a buffer to the SPI bus.
+
+```ts
+import { spiWrite } from "@devicescript/spi"
+
+await spiWrite(hex`abcd`)
+```
+
+## `spiTransfer`
+
+The `spiTransfter` function is used to write and read buffers from and to the SPI bus.
+The read buffer has the same length as the write buffer.
+
+```ts
+import { spiTransfer } from "@devicescript/spi"
+
+const res = await spiTransfer(hex`abcd`)
+```