-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme and add contributing guide
- Loading branch information
Showing
2 changed files
with
41 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Contributing | ||
|
||
Welcome to the DP100 WebApp project! We are happy that you are interested in contributing to this project. | ||
|
||
## Architecture | ||
|
||
### WebHID | ||
|
||
This project is based on the [WebHID](https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API) API. | ||
It enables you to connect to Bluetooth or USB, like our power supply, via the browser. | ||
|
||
### Javascript & ESM | ||
|
||
Since we already rely on a browser environment, | ||
we use the [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) module system. | ||
All code is written in vanilla Javascript. | ||
|
||
### Dependencies | ||
|
||
We use [μPlot](https://github.com/leeoniya/uPlot) for the graphing because it is lightweight and fast. | ||
Everything else is build via Web Components with the help of [Lit](https://lit.dev/). | ||
|
||
## Development | ||
|
||
This project is based on the [WebHID](https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API) API. | ||
It is a work-in-progress and not feature-complete. The Modbus implementation has been reverse-engineered | ||
from the Windows library (`ATK-DP100DLL(x64)_2.0.dll`), which can be found as part of the official software. | ||
|
||
If you want to contribute to this project, you can clone this repository and open the `index.html` file in your browser. | ||
|
||
You will need to enable write mode on Linux, since most distributions default to read-only. | ||
You can find this and other useful tips in the [Chrome Dev Tips][dev-tips]. | ||
|
||
[dev-tips]: https://developer.chrome.com/docs/capabilities/hid#dev-tips |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters