sinusoidal 0.8.0

The official SDK to write rust apps for the Sinusoidal Systems Digital Measurement Platform
Documentation 
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

syntax = "proto3";

package sinusoidal.control_api;

// App requests
message Request {
  oneof request {
    RequestRegister register = 1;
  }
}

// Framework responses
message Response {
  oneof response {
    ResponseError error       = 1;
    ResponseRegister register = 2;
  }
}

// Framework events
message Event {
  oneof event {
    EventShutdown shutdown = 1;
    EventNewSettings new_settings = 2;
  }
}

// -- Server Errors -------------------------------------------------------

message ResponseError {
  ErrorType error = 1;
  string reason   = 2;
}

enum ErrorType {
  GenericError  = 0;
  StreamIdError = 1;
  RegisterError = 2;
}


// -- Register ------------------------------------------------------------

// Register with the name of the app. Should be unique!
message RequestRegister {
}

message ResponseRegister {
  string name = 1;
  string input_streams = 2;
  string settings = 3;
}


// -- EventShutdown -------------------------------------------------------

message EventShutdown {
}

// -- EventNewSettings ----------------------------------------------------

message EventNewSettings {
  string new_settings = 1;
}

// -- Common Types --------------------------------------------------------

message SvStreamId {
  uint32 appid   = 1;
  string svid    = 2;
  bool simulated = 3;
};

message AppStreamId {
  string app_name   = 1;
  string stream_name = 2;
};

message SysStreamId {
  SysStream stream = 1;
};

enum SysStream {
  Time = 0;
};

message GooseStreamId {
  string go_id = 1;
}

message StreamId {
  oneof stream_id {
    SvStreamId sv_stream   = 1;
    AppStreamId app_stream = 2;
    SysStreamId sys_stream = 3;
    GooseStreamId goose_stream = 4;
  };
};

// Qualified trigger id
// Currently only to generate the Erlang type `trigger_id`. Not used in messages.
message TriggerId {
  string trigger_id = 1;
};