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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Wrapers for pyserial classes to log read and write data."""
from __future__ import annotations
from contextvars import ContextVar
import logging
import textwrap
from typing import TYPE_CHECKING
import serial
from pw_console.widgets.event_count_history import EventCountHistory
if TYPE_CHECKING:
from _typeshed import ReadableBuffer
_LOG = logging.getLogger('pw_console.serial_debug_logger')
def _log_hex_strings(data: bytes, prefix=''):
"""Create alinged hex number and character view log messages."""
# Make a list of 2 character hex number strings.
hex_numbers = textwrap.wrap(data.hex(), 2)
hex_chars = [
('<' + str(b.to_bytes(1, byteorder='big')) + '>')
.replace("<b'\\x", '', 1) # Remove b'\x from the beginning
.replace("<b'", '', 1) # Remove b' from the beginning
.replace("'>", '', 1) # Remove ' from the end
.rjust(2)
for b in data
]
# Replace non-printable bytes with dots.
for i, num in enumerate(hex_numbers):
if num == hex_chars[i]:
hex_chars[i] = '..'
hex_numbers_msg = ' '.join(hex_numbers)
hex_chars_msg = ' '.join(hex_chars)
_LOG.debug(
'%s%s',
prefix,
hex_numbers_msg,
extra=dict(
extra_metadata_fields={
'msg': hex_numbers_msg,
'view': 'hex',
}
),
)
_LOG.debug(
'%s%s',
prefix,
hex_chars_msg,
extra=dict(
extra_metadata_fields={
'msg': hex_chars_msg,
'view': 'chars',
}
),
)
BANDWIDTH_HISTORY_CONTEXTVAR = ContextVar(
'pw_console_bandwidth_history',
default={
'total': EventCountHistory(interval=3),
'read': EventCountHistory(interval=3),
'write': EventCountHistory(interval=3),
},
)
class SerialWithLogging(serial.Serial): # pylint: disable=too-many-ancestors
"""pyserial with read and write wrappers for logging."""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.pw_bps_history = BANDWIDTH_HISTORY_CONTEXTVAR.get()
def read(self, size: int = 1) -> bytes:
data = super().read(size)
self.pw_bps_history['read'].log(len(data))
self.pw_bps_history['total'].log(len(data))
if len(data) > 0:
prefix = 'Read %2d B: ' % len(data)
_LOG.debug(
'%s%s',
prefix,
data,
extra=dict(
extra_metadata_fields={
'mode': 'Read',
'bytes': len(data),
'view': 'bytes',
'msg': str(data),
}
),
)
_log_hex_strings(data, prefix=prefix)
# Print individual lines
for line in data.decode(
encoding='utf-8', errors='ignore'
).splitlines():
_LOG.debug(
'%s',
line,
extra=dict(
extra_metadata_fields={
'msg': line,
'view': 'lines',
}
),
)
return data
def write(self, data: ReadableBuffer) -> None:
if isinstance(data, bytes) and len(data) > 0:
self.pw_bps_history['write'].log(len(data))
self.pw_bps_history['total'].log(len(data))
prefix = 'Write %2d B: ' % len(data)
_LOG.debug(
'%s%s',
prefix,
data,
extra=dict(
extra_metadata_fields={
'mode': 'Write',
'bytes': len(data),
'view': 'bytes',
'msg': str(data),
}
),
)
_log_hex_strings(data, prefix=prefix)
# Print individual lines
for line in data.decode(
encoding='utf-8', errors='ignore'
).splitlines():
_LOG.debug(
'%s',
line,
extra=dict(
extra_metadata_fields={
'msg': line,
'view': 'lines',
}
),
)
super().write(data)
|
