|
1
|
<!doctype html>
|
|
2
|
<html lang="en">
|
|
3
|
<head>
|
|
4
|
<meta charset="utf-8">
|
|
5
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
6
|
<meta name="generator" content="pdoc 0.10.0" />
|
|
7
|
<title>usb_detector.event_listener API documentation</title>
|
|
8
|
<meta name="description" content="" />
|
|
9
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
|
|
10
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
|
|
11
|
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
|
|
12
|
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
|
13
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
|
14
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
|
15
|
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
|
|
16
|
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
|
|
17
|
</head>
|
|
18
|
<body>
|
|
19
|
<main>
|
|
20
|
<article id="content">
|
|
21
|
<header>
|
|
22
|
<h1 class="title">Module <code>usb_detector.event_listener</code></h1>
|
|
23
|
</header>
|
|
24
|
<section id="section-intro">
|
|
25
|
<details class="source">
|
|
26
|
<summary>
|
|
27
|
<span>Expand source code</span>
|
|
28
|
</summary>
|
|
29
|
<pre><code class="python">import platform
|
|
30
|
import logging
|
|
31
|
import getpass
|
|
32
|
from datetime import datetime
|
|
33
|
|
|
34
|
from .api_client import send_data
|
|
35
|
|
|
36
|
|
|
37
|
def _get_metadata() -> dict:
|
|
38
|
"""Returns metadata associated with the computer.
|
|
39
|
|
|
40
|
This metadata is sent to the server as a part
|
|
41
|
of each payload. It includes the username, hostname,
|
|
42
|
and timestamp.
|
|
43
|
|
|
44
|
:return: metadata associated with the PC
|
|
45
|
"""
|
|
46
|
logging.debug("getting computer metadata")
|
|
47
|
return {
|
|
48
|
"username": getpass.getuser(), # username
|
|
49
|
"hostname": platform.uname().node, # hostname
|
|
50
|
"timestamp": str(datetime.now()).split('.')[0] # timestamp (format: 2022-04-07 12:11:02)
|
|
51
|
}
|
|
52
|
|
|
53
|
|
|
54
|
def _send_payload_to_server(device: dict, status: str):
|
|
55
|
""" Creates a payload and calls the send_data function to send it to the server.
|
|
56
|
|
|
57
|
Each payload consists of metadata, status (connected/disconnected), and device,
|
|
58
|
which contains a vendor id, product id, and serial number.
|
|
59
|
|
|
60
|
:param device: USB device that has been detected
|
|
61
|
:param status: status of the USB device (connected/disconnected)
|
|
62
|
"""
|
|
63
|
logging.debug("payload send preparation")
|
|
64
|
|
|
65
|
# Get metadata that will be put into the payload.
|
|
66
|
payload = _get_metadata()
|
|
67
|
|
|
68
|
# Add information about the USB device.
|
|
69
|
payload["device"] = device
|
|
70
|
|
|
71
|
# Add the status of the USB device (connected/disconnected).
|
|
72
|
payload["status"] = status
|
|
73
|
|
|
74
|
# Send the payload off to the server.
|
|
75
|
send_data(payload)
|
|
76
|
|
|
77
|
|
|
78
|
def usb_connected_callback(device: dict):
|
|
79
|
"""Callback function for a connected USB device.
|
|
80
|
|
|
81
|
This function gets called whenever a USB device is
|
|
82
|
plugged into the computer (it is registered as a listener in
|
|
83
|
the USB detector). The device consists of a vendor id, product id,
|
|
84
|
and serial number.
|
|
85
|
|
|
86
|
:param device: USB device that was just plugged into the PC.
|
|
87
|
"""
|
|
88
|
logging.info(f"Device {device} has been connected")
|
|
89
|
|
|
90
|
# Create a payload and send it to the API (server).
|
|
91
|
_send_payload_to_server(device, "connected")
|
|
92
|
|
|
93
|
|
|
94
|
def usb_disconnected_callback(device: dict):
|
|
95
|
"""Callback function for a disconnected USB device.
|
|
96
|
|
|
97
|
This function gets called whenever a USB device is
|
|
98
|
disconnected from the computer (it is registered as a listener in
|
|
99
|
the USB detector). The device consists of a vendor id, product id,
|
|
100
|
and serial number.
|
|
101
|
|
|
102
|
:param device: USB device that was just disconnected from the PC.
|
|
103
|
"""
|
|
104
|
logging.info(f"Device {device} has been disconnected")
|
|
105
|
|
|
106
|
# Create a payload and send it to the API (server).
|
|
107
|
_send_payload_to_server(device, "disconnected")</code></pre>
|
|
108
|
</details>
|
|
109
|
</section>
|
|
110
|
<section>
|
|
111
|
</section>
|
|
112
|
<section>
|
|
113
|
</section>
|
|
114
|
<section>
|
|
115
|
<h2 class="section-title" id="header-functions">Functions</h2>
|
|
116
|
<dl>
|
|
117
|
<dt id="usb_detector.event_listener.usb_connected_callback"><code class="name flex">
|
|
118
|
<span>def <span class="ident">usb_connected_callback</span></span>(<span>device: dict)</span>
|
|
119
|
</code></dt>
|
|
120
|
<dd>
|
|
121
|
<div class="desc"><p>Callback function for a connected USB device.</p>
|
|
122
|
<p>This function gets called whenever a USB device is
|
|
123
|
plugged into the computer (it is registered as a listener in
|
|
124
|
the USB detector). The device consists of a vendor id, product id,
|
|
125
|
and serial number.</p>
|
|
126
|
<p>:param device: USB device that was just plugged into the PC.</p></div>
|
|
127
|
<details class="source">
|
|
128
|
<summary>
|
|
129
|
<span>Expand source code</span>
|
|
130
|
</summary>
|
|
131
|
<pre><code class="python">def usb_connected_callback(device: dict):
|
|
132
|
"""Callback function for a connected USB device.
|
|
133
|
|
|
134
|
This function gets called whenever a USB device is
|
|
135
|
plugged into the computer (it is registered as a listener in
|
|
136
|
the USB detector). The device consists of a vendor id, product id,
|
|
137
|
and serial number.
|
|
138
|
|
|
139
|
:param device: USB device that was just plugged into the PC.
|
|
140
|
"""
|
|
141
|
logging.info(f"Device {device} has been connected")
|
|
142
|
|
|
143
|
# Create a payload and send it to the API (server).
|
|
144
|
_send_payload_to_server(device, "connected")</code></pre>
|
|
145
|
</details>
|
|
146
|
</dd>
|
|
147
|
<dt id="usb_detector.event_listener.usb_disconnected_callback"><code class="name flex">
|
|
148
|
<span>def <span class="ident">usb_disconnected_callback</span></span>(<span>device: dict)</span>
|
|
149
|
</code></dt>
|
|
150
|
<dd>
|
|
151
|
<div class="desc"><p>Callback function for a disconnected USB device.</p>
|
|
152
|
<p>This function gets called whenever a USB device is
|
|
153
|
disconnected from the computer (it is registered as a listener in
|
|
154
|
the USB detector). The device consists of a vendor id, product id,
|
|
155
|
and serial number.</p>
|
|
156
|
<p>:param device: USB device that was just disconnected from the PC.</p></div>
|
|
157
|
<details class="source">
|
|
158
|
<summary>
|
|
159
|
<span>Expand source code</span>
|
|
160
|
</summary>
|
|
161
|
<pre><code class="python">def usb_disconnected_callback(device: dict):
|
|
162
|
"""Callback function for a disconnected USB device.
|
|
163
|
|
|
164
|
This function gets called whenever a USB device is
|
|
165
|
disconnected from the computer (it is registered as a listener in
|
|
166
|
the USB detector). The device consists of a vendor id, product id,
|
|
167
|
and serial number.
|
|
168
|
|
|
169
|
:param device: USB device that was just disconnected from the PC.
|
|
170
|
"""
|
|
171
|
logging.info(f"Device {device} has been disconnected")
|
|
172
|
|
|
173
|
# Create a payload and send it to the API (server).
|
|
174
|
_send_payload_to_server(device, "disconnected")</code></pre>
|
|
175
|
</details>
|
|
176
|
</dd>
|
|
177
|
</dl>
|
|
178
|
</section>
|
|
179
|
<section>
|
|
180
|
</section>
|
|
181
|
</article>
|
|
182
|
<nav id="sidebar">
|
|
183
|
<h1>Index</h1>
|
|
184
|
<div class="toc">
|
|
185
|
<ul></ul>
|
|
186
|
</div>
|
|
187
|
<ul id="index">
|
|
188
|
<li><h3>Super-module</h3>
|
|
189
|
<ul>
|
|
190
|
<li><code><a title="usb_detector" href="index.html">usb_detector</a></code></li>
|
|
191
|
</ul>
|
|
192
|
</li>
|
|
193
|
<li><h3><a href="#header-functions">Functions</a></h3>
|
|
194
|
<ul class="">
|
|
195
|
<li><code><a title="usb_detector.event_listener.usb_connected_callback" href="#usb_detector.event_listener.usb_connected_callback">usb_connected_callback</a></code></li>
|
|
196
|
<li><code><a title="usb_detector.event_listener.usb_disconnected_callback" href="#usb_detector.event_listener.usb_disconnected_callback">usb_disconnected_callback</a></code></li>
|
|
197
|
</ul>
|
|
198
|
</li>
|
|
199
|
</ul>
|
|
200
|
</nav>
|
|
201
|
</main>
|
|
202
|
<footer id="footer">
|
|
203
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
|
|
204
|
</footer>
|
|
205
|
</body>
|
|
206
|
</html>
|