buttplug 2.1.5

Buttplug Intimate Hardware Control Library
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

syntax = "proto3";
package handyplug;

/*
[
  {
    "Ok": {
      "Id": 1
    }
  }
]
*/

message Ok {
    uint32 Id = 1;
}

/*
[
  {
    "Error": {
      "Id": 1,
      "ErrorMessage": "Server received invalid JSON.",
      "ErrorCode": 3
    }
  }
]
*/

message Error {
    uint32 Id = 1;
    string ErrorMessage = 2;
    int32 ErrorCode = 3;
}

/*
[
  {
    "Ping": {
      "Id": 1
    }
  }
]
*/

message Ping {
    uint32 Id = 1;
}

/*
[
  {
    "RequestServerInfo": {
      "Id": 1,
      "ClientName": "Test Client",
      "MessageVersion": 1
    }
  }
]
*/

message RequestServerInfo {
  uint32 Id = 1;
  string ClientName = 2;
  uint32 MessageVersion = 3;
}

/*
[
  {
    "ServerInfo": {
      "Id": 1,
      "ServerName": "Test Server",
      "MessageVersion": 1,
      "MaxPingTime": 100
    }
  }
]
*/

message ServerInfo {
  uint32 Id = 1;
  string ServerName = 2;
  uint32 MessageVersion = 3;
  uint32 MaxPingTime = 4;
}

/*
[
  {
    "LinearCmd": {
      "Id": 1,
      "DeviceIndex": 0,
      "Vectors": [
        {
          "Index": 0,
          "Duration": 500,
          "Position": 0.3
        },
        {
          "Index": 1,
          "Duration": 1000,
          "Position": 0.8
        }
      ]
    }
  }
]
*/

message LinearCmd {
    uint32 Id = 1;
    uint32 DeviceIndex = 2;
    message Vector {
        uint32 Index = 1;
        uint32 Duration = 2;
        double Position = 3;
    }
    repeated Vector Vectors = 3;
}

message Message {
    oneof Message {
        /* Status Messages */
        Ok Ok = 100;
        Error Error = 101;
        Ping Ping = 102;
        /* Handshake Messages */
        RequestServerInfo RequestServerInfo = 200;
        ServerInfo ServerInfo = 201;
        /* Generic Device Messages */
        LinearCmd LinearCmd = 403;
    }
}

message Payload { 
    repeated Message Messages = 1;
}