Skip to content

Commit 77ebbfb

Browse files
authored
Add an initial basic dashboard (#547)
1 parent 41d9776 commit 77ebbfb

27 files changed

+5463
-7
lines changed

dashboard/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
dist

dashboard/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Matter Dashboard
2+
3+
This is the dashboard for the Python Matter Server project. It is meant to be used for debugging and testing.
4+
5+
## Development
6+
7+
Install the dependencies:
8+
9+
```bash
10+
script/setup
11+
```
12+
13+
Run the development server:
14+
15+
```bash
16+
script/develop
17+
```
18+
19+
The dashboard will be available at [http://localhost:5010](http://localhost:5010). When you open it from localhost, it will ask you for your websocket server URL.
20+
21+
The websocket URL of the Home Assistant add-on will be something like `ws://homeassistant.local:5080`. If you are running the Python Matter Server locally, it will be `ws://localhost:5080`.
22+
23+
If you want to use the dashboard with the Python Matter Server Home Assistant add-on, you need to configure it to make the WebSocket server available on the network. Go to the [add-on info page](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_matter_server), click on Configuration. Under "Network", show disabled ports and enter the port you want to use for the WebSocket server (e.g. 5080). Then, click "save" and restart the add-on when prompted.
24+
25+
## Production build
26+
27+
The production build is generated when you run
28+
29+
```bash
30+
script/build
31+
```
32+
33+
The folder `dist/web` will contain the build that can be served by any web browser.

0 commit comments

Comments
 (0)