Skip to content

Commit 2c306dd

Browse files
committed
feat: Add demo image to README and improve formatting in type definitions
1 parent 670e166 commit 2c306dd

File tree

3 files changed

+34
-32
lines changed

3 files changed

+34
-32
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Serviceberry responds to location requests at the hostname `https://serviceberry
1212
Currently, Serviceberry only offically supports Linux machines, iOS devices; and has only been confirmed to support [BeaconDB](https://beacondb.net/). See the todo for current progress.
1313

1414

15+
![serviceberry-tauri-gui](assets/serviceberry-demo.png)
16+
1517
## Prerequisites
1618

1719
### Linux Packages
@@ -58,7 +60,7 @@ Ensure you have setup the exclsuion in the correct zone by listing your active z
5860
2. Download the latest release
5961
3. Install all the system packages
6062
4. Set the `geo.provider.network.url` in `about:config` to `https://serviceberry-<your-username>.local/request`
61-
5. Give the binary Wifi capability permissions `sudo setcap cap_net_admin+ep target/debug/serviceberry-gui`
63+
5. Give the binary Wifi capability permissions `sudo setcap cap_net_admin+ep target/debug/serviceberry-gui` -- you may need to run as root if this doesn't work
6264
6. Watch logs for sucessful location
6365

6466
## Contributing

assets/serviceberry-demo.png

136 KB
Loading

src/lib/types.ts

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
export type WifiEntry = {
2-
ssid: string | null;
3-
bssid: string; // MAC address as string
4-
age?: number; // ms, optional
5-
channel_info: {
6-
frequency_mhz: number;
7-
channel: number | null;
8-
bandwidth_mhz?: number;
9-
};
10-
radioType: string[]; // array of PHY type strings
11-
signalStrength: number;
12-
wifi_security: {
13-
version: string | null;
14-
group_cipher?: string | null;
15-
pairwise_ciphers?: string[];
16-
auth_suites?: string[];
17-
mfp?: string | null;
18-
};
19-
capabilities?: string[];
2+
ssid: string | null;
3+
bssid: string; // MAC address as string
4+
age?: number; // ms, optional
5+
channel_info: {
6+
frequency_mhz: number;
7+
channel: number | null;
8+
bandwidth_mhz?: number;
9+
};
10+
radioType: string[]; // array of PHY type strings
11+
signalStrength: number;
12+
wifi_security: {
13+
version: string | null;
14+
group_cipher?: string | null;
15+
pairwise_ciphers?: string[];
16+
auth_suites?: string[];
17+
mfp?: string | null;
18+
};
19+
capabilities?: string[];
2020
};
2121

2222
export type BtEntry = {
23-
name: string | null;
24-
address: string;
25-
rssi: number | null;
26-
uuids: string[];
27-
lastSeen?: number; // timestamp in ms
23+
name: string | null;
24+
address: string;
25+
rssi: number | null;
26+
uuids: string[];
27+
lastSeen?: number; // timestamp in ms
2828
};
2929

3030
export type LogItem = {
31-
id: string;
32-
ts: string;
33-
level: "info" | "warn" | "error" | "debug";
34-
msg: string;
31+
id: string;
32+
ts: string;
33+
level: "info" | "warn" | "error" | "debug";
34+
msg: string;
3535
};
3636

3737
export type AppSettings = {
38-
logLevel: "info" | "warn" | "error" | "debug";
39-
testMode: boolean;
40-
showVisualization: boolean;
41-
visualizationBand: "2.4GHz" | "5GHz";
38+
logLevel: "info" | "warn" | "error" | "debug";
39+
testMode: boolean;
40+
showVisualization: boolean;
41+
visualizationBand: "2.4GHz" | "5GHz";
4242
};

0 commit comments

Comments
 (0)