SCP/SCP.h at development · houseos/SCP · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
secure-control-protocol
This is the central header file for the secure-control-protocol.

SPDX-License-Identifier: GPL-3.0-or-later

Copyright (C) 2018 Benjamin Schilling
*/

#ifndef SCP_h
#define SCP_h

#include <ESP8266WiFi.h>
#include <WiFiClient.h>
#include <ESP8266WiFiMulti.h>
#include <ESP8266WebServer.h>
#include "ScpDeviceID.h"
#include "ScpDeviceName.h"
#include "ScpPassword.h"
#include "ScpCrypto.h"
#include "ScpResponseFactory.h"
#include "ScpEepromController.h"

#include "ScpDebug.h"

class SCP
{
public:
  /**
   * @brief Construct a new SCP object
   *
   */
  SCP();

  /**
   * @brief
   *
   * @param deviceType The type of device
   * @param actions String containing a list of ',' separated actions
   */
  void init(String deviceType, String controlActions, String measureActions);

  /**
   * @brief
   *
   */
  void handleClient();

  void registerControlFunction(std::function<void(String)> fun);
  void registerMeasureFunction(std::function<double(String)> fun);

private:
  ScpPassword scpPassword;
  ScpDeviceID scpDeviceID;
  ScpDeviceName scpDeviceName;
  ScpCrypto scpCrypto;
  ScpResponseFactory scpResponseFactory;
  ScpEepromController scpEepromController;
  ScpDebug scpDebug;

  String deviceID = "";
  String deviceType = "";
  ESP8266WebServer *server;
  ESP8266WiFiMulti wifiMulti;
  String DEFAULT_PW = "1234567890123456";
  // List of supported actions, separated by ','
  String measureActions;
  String controlActions;

  std::function<void(String)> controlFunction;
  std::function<double(String)> measureFunction;

  // Helpers
  bool isDeviceIdValid(String devId);

  bool isNVCNValid(String nvcn);

  // HTTP Endpoints
  /**
   * @brief
   *
   */
  void handleSecureControl();

  /**
   * @brief
   *
   */
  void handleDiscoverHello();

  /**
   * @brief
   *
   */
  void handleSecurityFetchNVCN();

  /**
   * @brief
   *
   */
  void handleNotFound();
  // HTTP Error Methods

  /**
   * @brief
   *
   */
  void sendMalformedPayload();

  // State Handling

  /**
   * @brief
   *
   */
  void provisioningMode();

  /**
   * @brief
   *
   */
  void controlMode();
};

#endif