Skip to content

Commit 8a13f02

Browse files
deadprogramdeadprogram
committed
docs/reference: regenerate machine package docs using TinyGo 0.27.0
Signed-off-by: deadprogram <[email protected]>
1 parent 71861bc commit 8a13f02

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+2969
-60
lines changed

‎content/docs/reference/microcontrollers/circuitplay-bluefruit.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ The [Adafruit Circuit Playground Bluefruit](https://www.adafruit.com/product/433
4343
| `SPI0_SCK_PIN` | `P0_19` | |
4444
| `SPI0_SDO_PIN` | `P0_21` | |
4545
| `SPI0_SDI_PIN` | `P0_23` | |
46+
| `PDM_CLK_PIN` | `P0_17` | |
47+
| `PDM_DIN_PIN` | `P0_16` | |
4648

4749
## Machine Package Docs
4850

‎content/docs/reference/microcontrollers/m5stamp-c3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [M5Stamp-C3](https://docs.m5stack.com/en/core/stamp_c3) is a development boa
1111
| --------- | ------------- | ----- |
1212
| GPIO | YES | YES |
1313
| UART | YES | YES |
14-
| SPI | YES | Not yet |
14+
| SPI | YES | YES |
1515
| I2C | YES | Not yet |
1616
| ADC | YES | Not yet |
1717
| PWM | YES | Not yet |

‎content/docs/reference/microcontrollers/machine/arduino-mega1280.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,8 @@ const (
274274
```go
275275
var (
276276
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
277+
ErrClockRNG = errors.New("machine: RNG Clock Error")
278+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
277279
ErrInvalidInputPin = errors.New("machine: invalid input pin")
278280
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
279281
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -594,6 +596,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
594596

595597

596598

599+
## type PDMConfig
600+
601+
```go
602+
type PDMConfig struct {
603+
Stereo bool
604+
DIN Pin
605+
CLK Pin
606+
}
607+
```
608+
609+
610+
611+
612+
613+
597614
## type PWM
598615

599616
```go

‎content/docs/reference/microcontrollers/machine/arduino-mega2560.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,8 @@ var (
332332
```go
333333
var (
334334
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
335+
ErrClockRNG = errors.New("machine: RNG Clock Error")
336+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
335337
ErrInvalidInputPin = errors.New("machine: invalid input pin")
336338
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
337339
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -639,6 +641,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
639641

640642

641643

644+
## type PDMConfig
645+
646+
```go
647+
type PDMConfig struct {
648+
Stereo bool
649+
DIN Pin
650+
CLK Pin
651+
}
652+
```
653+
654+
655+
656+
657+
658+
642659
## type PWMConfig
643660

644661
```go

‎content/docs/reference/microcontrollers/machine/arduino-mkr1000.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,8 @@ const (
333333
```go
334334
var (
335335
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
336+
ErrClockRNG = errors.New("machine: RNG Clock Error")
337+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
336338
ErrInvalidInputPin = errors.New("machine: invalid input pin")
337339
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
338340
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -439,6 +441,15 @@ func EnableHID(txHandler func(), rxHandler func([]byte), setupHandler func(usb.S
439441
EnableHID enables HID. This function must be executed from the init().
440442

441443

444+
### func EnableJoystick
445+
446+
```go
447+
func EnableJoystick(txHandler func(), rxHandler func([]byte), setupHandler func(usb.Setup) bool, hidDesc []byte)
448+
```
449+
450+
EnableJoystick enables HID. This function must be executed from the init().
451+
452+
442453
### func EnableMIDI
443454

444455
```go
@@ -883,6 +894,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
883894

884895

885896

897+
## type PDMConfig
898+
899+
```go
900+
type PDMConfig struct {
901+
Stereo bool
902+
DIN Pin
903+
CLK Pin
904+
}
905+
```
906+
907+
908+
909+
910+
911+
886912
## type PWMConfig
887913

888914
```go
@@ -1433,7 +1459,8 @@ UARTParity is the parity setting to be used for UART communication.
14331459

14341460
```go
14351461
type USBDevice struct {
1436-
initcomplete bool
1462+
initcomplete bool
1463+
InitEndpointComplete bool
14371464
}
14381465
```
14391466

‎content/docs/reference/microcontrollers/machine/arduino-mkrwifi1010.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,8 @@ var (
386386
```go
387387
var (
388388
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
389+
ErrClockRNG = errors.New("machine: RNG Clock Error")
390+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
389391
ErrInvalidInputPin = errors.New("machine: invalid input pin")
390392
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
391393
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -492,6 +494,15 @@ func EnableHID(txHandler func(), rxHandler func([]byte), setupHandler func(usb.S
492494
EnableHID enables HID. This function must be executed from the init().
493495

494496

497+
### func EnableJoystick
498+
499+
```go
500+
func EnableJoystick(txHandler func(), rxHandler func([]byte), setupHandler func(usb.Setup) bool, hidDesc []byte)
501+
```
502+
503+
EnableJoystick enables HID. This function must be executed from the init().
504+
505+
495506
### func EnableMIDI
496507

497508
```go
@@ -936,6 +947,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
936947

937948

938949

950+
## type PDMConfig
951+
952+
```go
953+
type PDMConfig struct {
954+
Stereo bool
955+
DIN Pin
956+
CLK Pin
957+
}
958+
```
959+
960+
961+
962+
963+
964+
939965
## type PWMConfig
940966

941967
```go
@@ -1486,7 +1512,8 @@ UARTParity is the parity setting to be used for UART communication.
14861512

14871513
```go
14881514
type USBDevice struct {
1489-
initcomplete bool
1515+
initcomplete bool
1516+
InitEndpointComplete bool
14901517
}
14911518
```
14921519

‎content/docs/reference/microcontrollers/machine/arduino-nano.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ const (
180180
```go
181181
var (
182182
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
183+
ErrClockRNG = errors.New("machine: RNG Clock Error")
184+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
183185
ErrInvalidInputPin = errors.New("machine: invalid input pin")
184186
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
185187
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -497,6 +499,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
497499

498500

499501

502+
## type PDMConfig
503+
504+
```go
505+
type PDMConfig struct {
506+
Stereo bool
507+
DIN Pin
508+
CLK Pin
509+
}
510+
```
511+
512+
513+
514+
515+
516+
500517
## type PWM
501518

502519
```go

‎content/docs/reference/microcontrollers/machine/arduino-nano33.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,8 @@ SPI1 is connected to the NINA-W102 chip on the Arduino Nano 33.
389389
```go
390390
var (
391391
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
392+
ErrClockRNG = errors.New("machine: RNG Clock Error")
393+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
392394
ErrInvalidInputPin = errors.New("machine: invalid input pin")
393395
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
394396
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -495,6 +497,15 @@ func EnableHID(txHandler func(), rxHandler func([]byte), setupHandler func(usb.S
495497
EnableHID enables HID. This function must be executed from the init().
496498

497499

500+
### func EnableJoystick
501+
502+
```go
503+
func EnableJoystick(txHandler func(), rxHandler func([]byte), setupHandler func(usb.Setup) bool, hidDesc []byte)
504+
```
505+
506+
EnableJoystick enables HID. This function must be executed from the init().
507+
508+
498509
### func EnableMIDI
499510

500511
```go
@@ -939,6 +950,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
939950

940951

941952

953+
## type PDMConfig
954+
955+
```go
956+
type PDMConfig struct {
957+
Stereo bool
958+
DIN Pin
959+
CLK Pin
960+
}
961+
```
962+
963+
964+
965+
966+
967+
942968
## type PWMConfig
943969

944970
```go
@@ -1489,7 +1515,8 @@ UARTParity is the parity setting to be used for UART communication.
14891515

14901516
```go
14911517
type USBDevice struct {
1492-
initcomplete bool
1518+
initcomplete bool
1519+
InitEndpointComplete bool
14931520
}
14941521
```
14951522

‎content/docs/reference/microcontrollers/machine/arduino-zero.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,8 @@ const (
361361
```go
362362
var (
363363
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
364+
ErrClockRNG = errors.New("machine: RNG Clock Error")
365+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
364366
ErrInvalidInputPin = errors.New("machine: invalid input pin")
365367
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
366368
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -467,6 +469,15 @@ func EnableHID(txHandler func(), rxHandler func([]byte), setupHandler func(usb.S
467469
EnableHID enables HID. This function must be executed from the init().
468470

469471

472+
### func EnableJoystick
473+
474+
```go
475+
func EnableJoystick(txHandler func(), rxHandler func([]byte), setupHandler func(usb.Setup) bool, hidDesc []byte)
476+
```
477+
478+
EnableJoystick enables HID. This function must be executed from the init().
479+
480+
470481
### func EnableMIDI
471482

472483
```go
@@ -911,6 +922,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
911922

912923

913924

925+
## type PDMConfig
926+
927+
```go
928+
type PDMConfig struct {
929+
Stereo bool
930+
DIN Pin
931+
CLK Pin
932+
}
933+
```
934+
935+
936+
937+
938+
939+
914940
## type PWMConfig
915941

916942
```go
@@ -1461,7 +1487,8 @@ UARTParity is the parity setting to be used for UART communication.
14611487

14621488
```go
14631489
type USBDevice struct {
1464-
initcomplete bool
1490+
initcomplete bool
1491+
InitEndpointComplete bool
14651492
}
14661493
```
14671494

‎content/docs/reference/microcontrollers/machine/arduino.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ const (
180180
```go
181181
var (
182182
ErrTimeoutRNG = errors.New("machine: RNG Timeout")
183+
ErrClockRNG = errors.New("machine: RNG Clock Error")
184+
ErrSeedRNG = errors.New("machine: RNG Seed Error")
183185
ErrInvalidInputPin = errors.New("machine: invalid input pin")
184186
ErrInvalidOutputPin = errors.New("machine: invalid output pin")
185187
ErrInvalidClockPin = errors.New("machine: invalid clock pin")
@@ -497,6 +499,21 @@ WriteByte is a no-op: the null serial doesn't write bytes.
497499

498500

499501

502+
## type PDMConfig
503+
504+
```go
505+
type PDMConfig struct {
506+
Stereo bool
507+
DIN Pin
508+
CLK Pin
509+
}
510+
```
511+
512+
513+
514+
515+
516+
500517
## type PWM
501518

502519
```go

0 commit comments

Comments
 (0)