homeio

1export type NetworkStatus = {
2  connected: boolean;
3  iface: string | null;
4  ssid: string | null;
5  ipv4: string | null;
6  signalPercent: number | null;
7};
8
9export type WifiAccessPoint = {
10  ssid: string;
11  bssid: string | null;
12  signalPercent: number | null;
13  channel: number | null;
14  frequencyMhz: number | null;
15  security: string | null;
16};
17
18export type ConnectNetworkRequest = {
19  ssid: string;
20  password?: string;
21};
22
23export type DisconnectNetworkRequest = {
24  iface?: string;
25};
26
27export type NetworkEventType =
28  | "network.connection.changed"
29  | "network.device.state.changed";
30
31export type NetworkEvent = {
32  type: NetworkEventType;
33  timestamp: string;
34  iface: string | null;
35  ssid: string | null;
36  connected: boolean;
37  state?: string;
38  reason?: string;
39};
40
41export type NetworkServiceErrorCode =
42  | "helper_unavailable"
43  | "network_manager_unavailable"
44  | "auth_failed"
45  | "timeout"
46  | "invalid_request"
47  | "internal_error";
48
49export type NetworkInterfaceKind = "wired" | "wireless" | "vpn" | "other";
50
51/** One interface as the Monitor's Network tab shows it; null where the host has no value. */
52export type NetworkInterfaceOverview = {
53  iface: string;
54  kind: NetworkInterfaceKind;
55  up: boolean | null;
56  isDefault: boolean;
57  ip4: string | null;
58  ip4Subnet: string | null;
59  ip6: string | null;
60  mac: string | null;
61  speedMbps: number | null;
62  duplex: string | null;
63  dhcp: boolean;
64  /** Totals since the interface came up. */
65  rxBytes: number | null;
66  txBytes: number | null;
67  downloadMbps: number | null;
68  uploadMbps: number | null;
69  rxErrors: number | null;
70  txErrors: number | null;
71  rxDropped: number | null;
72  txDropped: number | null;
73};
74
75export type NetworkOverview = {
76  /** In the Docker image these are the container's interfaces, not the host's. */
77  inContainer: boolean;
78  interfaces: NetworkInterfaceOverview[];
79  gateway: string | null;
80  dnsServers: string[];
81  checkedAt: string;
82};
83