WiFiReader.hpp

/*******************************************************************************
 * Copyright (c) 2020, 2023  Carnegie Mellon University and Miraikan
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *******************************************************************************/

#ifndef WIFIREADER_HPP_
#define WIFIREADER_HPP_

#include "WiFi.h"
#include "esp_wifi.h"  // NOLINT
#include <SPI.h>
#include "SensorReader.h"

// maximum number of channels
#define MAX_CHANNEL (13)

// 11 ch in US, 13 ch in other countries
#define DEFAULT_N_CHANNEL (11)

// typical WiFi SSID beacon is 102.4 ms
#define DEFAULT_SCAN_DURATION (105)

// need some interval if you want to transport via WiFi
#define DEFAULT_SCAN_INTERVAL (5)

// maximum wait cycle
// if you have APs in 3 channels in your environment, the maximum wait time is like
// (3*DEFAULT_MAX_SKIP)*(DEFAULT_SCAN_DURATION+SCAN_INTERVAL) = (3*14)*105 = 42*105 =
#define DEFAULT_MAX_SKIP (14)

// maximum queue size, ignore if exceeds
#define MAX_WAITING (128)

// verbosity
#define DEFAULT_VERBOSITY (true)

#define PARAM_TIMEOUT (100)


class WiFiReader: public SensorReader {
  int max_skip = DEFAULT_MAX_SKIP;
  int n_channel = DEFAULT_N_CHANNEL;
  int scan_duration = DEFAULT_SCAN_DURATION;
  int scan_interval = DEFAULT_SCAN_INTERVAL;
  bool verbose = DEFAULT_VERBOSITY;
  // vewrbose_change : boolean -> int
  int verbose_int = verbose;

  bool isScanning = false;
  uint32_t scanningStart = 0;
  int channel = 0;
  int skip[MAX_CHANNEL];
  int count[MAX_CHANNEL];
  int aps[MAX_CHANNEL];
  uint32_t lastseen[MAX_CHANNEL];
  char buf[256];

  // BSSID=17, SSID=32, CH=2, RSSI=4, sec=10, nsec=10, commas=5, total 80 + margin 20
  char msg_buf[MAX_WAITING][100];
  int waiting = 0;
  int all_zero_count = 0;

  void showScanStatus();
  void (* callback_)(char *);

  void handleScan();
  void checkQueue();
  void checkZeroScan(int maximum);

public:
  explicit WiFiReader(cabot::Handle & ch);
  void init(void (* callback)(char *));
  void init();
  void set_data(char * data);
  void update();
};


#endif  // WIFIREADER_HPP_