Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add friendlyName and lowLatency to interfaces #106

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add friendlyName and lowLatency to interfaces #106

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d07037
Add friendlyName and LowLatency to definitions
GazHank Jun 20, 2023
5c2ee86
Fix friendlyName for mock
GazHank Jun 20, 2023
c851878
add friednlyName to bin-repl
GazHank Jun 21, 2023
b26b0f2
add friendlyName to bin-repl
GazHank Jun 21, 2023
04423c7
Merge branch 'OS-Specific' of https://github.com/GazHank/node-serialp…
GazHank Jun 21, 2023
ab118f6
Fix optionality per review comment
GazHank Jun 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api-binding-mock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ interface CreatePortOptions {
manufacturer?: string;
vendorId?: string;
productId?: string;
friendlyName: string;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Required?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about that. Thanks for reviewing :-)

}

// Create a port and enable the echo and recording.
Expand Down
10 changes: 7 additions & 3 deletions docs/api-bindings-cpp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ interface PortInfo {
locationId: string | undefined;
productId: string | undefined;
vendorId: string | undefined;
friendlyName: string | undefined;
}

function list(): Promise<PortInfo>
Expand All @@ -78,7 +79,8 @@ const ports = await LinuxBinding.list()
// pnpId: 'usb-Arduino__www.arduino.cc__0043_752303138333518011C1-if00',
// locationId: undefined,
// productId: '0043',
// vendorId: '2341'
// vendorId: '2341',
// friendlyName: undefined
// }]
```

Expand All @@ -94,7 +96,8 @@ const ports = await WindowsBinding.list()
// pnpId: 'USB\\VID_2341&PID_0043\\752303138333518011C1',
// locationId: 'Port_#0003.Hub_#0001',
// productId: '0043',
// vendorId: '2341'
// vendorId: '2341',
// friendlyName: 'USB Serial Device (COM3)'
// }]
```

Expand All @@ -110,7 +113,8 @@ const ports = await DarwinBinding.list()
// pnpId: undefined,
// locationId: '14500000',
// productId: '0043',
// vendorId: '2341'
// vendorId: '2341',
// friendlyName: undefined
// }]
```

Expand Down
3 changes: 2 additions & 1 deletion docs/bin-repl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ globals { SerialPort, SerialPortMock, path, port }
pnpId: undefined,
locationId: '02100000',
vendorId: '2341',
productId: '8036'
productId: '8036',
friendlyName: undefined
}
]
> port.open()
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-10.x.x/api-binding-mock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ interface CreatePortOptions {
manufacturer?: string;
vendorId?: string;
productId?: string;
friendlyName: string;
}

// Create a port and enable the echo and recording.
Expand Down
10 changes: 7 additions & 3 deletions versioned_docs/version-10.x.x/api-bindings-cpp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ interface PortInfo {
locationId: string | undefined;
productId: string | undefined;
vendorId: string | undefined;
friendlyName: string | undefined;
}

function list(): Promise<PortInfo>
Expand All @@ -78,7 +79,8 @@ const ports = await LinuxBinding.list()
// pnpId: 'usb-Arduino__www.arduino.cc__0043_752303138333518011C1-if00',
// locationId: undefined,
// productId: '0043',
// vendorId: '2341'
// vendorId: '2341',
// friendlyName: undefined
// }]
```

Expand All @@ -94,7 +96,8 @@ const ports = await WindowsBinding.list()
// pnpId: 'USB\\VID_2341&PID_0043\\752303138333518011C1',
// locationId: 'Port_#0003.Hub_#0001',
// productId: '0043',
// vendorId: '2341'
// vendorId: '2341',
// friendlyName: 'USB Serial Device (COM3)'
// }]
```

Expand All @@ -110,7 +113,8 @@ const ports = await DarwinBinding.list()
// pnpId: undefined,
// locationId: '14500000',
// productId: '0043',
// vendorId: '2341'
// vendorId: '2341',
// friendlyName: undefined
// }]
```

Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-10.x.x/bin-repl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ globals { SerialPort, SerialPortMock, path, port }
pnpId: undefined,
locationId: '02100000',
vendorId: '2341',
productId: '8036'
productId: '8036',
friendlyName: undefined
}
]
> port.open()
Expand Down