Skip to content

Commit

Permalink
Update DOCS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mqxx committed Jan 14, 2024
1 parent 6c83b56 commit 943bbb5
Showing 1 changed file with 88 additions and 15 deletions.
103 changes: 88 additions & 15 deletions docs/DOCS.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,92 @@
```mermaid
classDiagram
class PortInfo {
path : string,
manufacturer : string | undefined,
serialNumber : string | undefined,
pnpId : string | undefined,
locationId : string | undefined,
productId : string | undefined,
vendorId : string | undefined
}
Class01 <|-- AveryLongClass : Cool
<<Interface>> Class01
Class09 --> C2 : Where am I?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
class Class10 {
<<service>>
int id
size()
}
class SerialOptions {
dataBits? : 5 | 6 | 7 | 8,
stopBits? : 1 | 1.5 | 2,
parity? : string,
timeout? : number,
timeoutBetween? : number
}
class Serial {
port : string,
baudrate : Baudrate | number,
options : SerialOptions
}
class open {
}
class close {
}
class read {
}
class readUntil {
}
class write {
}
class clearBufferIn {
}
class clearBufferOut {
}
class onError {
}
class onRead {
}
class onWrite {
}
class addEventListener {
}
class removeEventListener {
}
class list {
}
Serial --|> open
Serial --|> close
Serial --|> read
Serial --|> readUntil
Serial --|> write
Serial --|> clearBufferIn
Serial --|> clearBufferOut
Serial --|> onError
Serial --|> onRead
Serial --|> onWrite
Serial --|> addEventListener
Serial --|> removeEventListener
Serial --|> list
```

0 comments on commit 943bbb5

Please sign in to comment.