← Back to ratslair.com
aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 8213fafe8c2a245e91ad35651959bcfbd2d0049d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# `EZWIFI`

`EZWIFI` is an ESP32 component for setting up Wi-Fi and collecting channel state information (CSI) from received frames.

## Usage

A node is configured as either an access point (AP) or a station (STA):

	// Configure this node as an access point
	setup_softap();

	// ...or as a station
	setup_station();

	// Enable CSI collection, filtering on the sender's MAC address
	setup_csi("AA:BB:CC:DD:EE:FF");

Once running, `is_wifi_connected()` reports connection status, and `get_csi()` returns a pointer to the most recently received CSI frame.

	if (is_wifi_connected()) {
	    wifi_csi_info_t *csi = get_csi();
	}

This was originally built for a two-node presence/activity-detection system, where one node ran as AP and the other as STA.