File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing
2+
3+ Welcome to the DP100 WebApp project! We are happy that you are interested in contributing to this project.
4+
5+ ## Architecture
6+
7+ ### WebHID
8+
9+ This project is based on the [ WebHID] ( https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API ) API.
10+ It enables you to connect to Bluetooth or USB, like our power supply, via the browser.
11+
12+ ### Javascript & ESM
13+
14+ Since we already rely on a browser environment,
15+ we use the [ ESM] ( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules ) module system.
16+ All code is written in vanilla Javascript.
17+
18+ ### Dependencies
19+
20+ We use [ μPlot] ( https://github.com/leeoniya/uPlot ) for the graphing because it is lightweight and fast.
21+ Everything else is build via Web Components with the help of [ Lit] ( https://lit.dev/ ) .
22+
23+ ## Development
24+
25+ This project is based on the [ WebHID] ( https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API ) API.
26+ It is a work-in-progress and not feature-complete. The Modbus implementation has been reverse-engineered
27+ from the Windows library (` ATK-DP100DLL(x64)_2.0.dll ` ), which can be found as part of the official software.
28+
29+ If you want to contribute to this project, you can clone this repository and open the ` index.html ` file in your browser.
30+
31+ You will need to enable write mode on Linux, since most distributions default to read-only.
32+ You can find this and other useful tips in the [ Chrome Dev Tips] [ dev-tips ] .
33+
34+ [ dev-tips ] : https://developer.chrome.com/docs/capabilities/hid#dev-tips
Original file line number Diff line number Diff line change @@ -11,16 +11,16 @@ A browser interface for the DP100 digital power supply by Alientek.
1111
1212## Usage
1313
14- You don't need to install anything to use this webapp.
15- Just visit [ this link] ( https://johannes.maron.family/DP100-WebApp/ ) and you're good to go.
14+ Grap you DP100 power supply and connect the DP100 via it's USB-A port to your computer.
1615
17- ## Development
16+ Now, visit [ DP100 WebApp ] ( https://johannes.maron.family/DP100-WebApp/ ) and you're good to go.
1817
19- This project is based on the [ WebHID] ( https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API ) API.
20- It is a work-in-progress and not feature-complete. The Modbus implementation has been reverse-engineered
21- from the Windows library (` ATK-DP100DLL(x64)_2.0.dll ` ), which can be found as part of the official software.
18+ _ Note, not all browsers support WebHID yet and on Linux you might need to enable write mode first,
19+ see [ Contributing Guide] ( CONTRIBUTING.md ) ._
2220
23- If you want to contribute to this project, you can clone this repository and open the ` index.html ` file in your browser.
21+ ## Development & Contributing
22+
23+ We welcome contributions to this project. Please read the [ Contributing Guidelines] ( CONTRIBUTING.md ) for more information.
2424
2525## Credits
2626
You can’t perform that action at this time.
0 commit comments