]>
Commit | Line | Data |
---|---|---|
d8f6e041 | 1 | ## |
50985c20 | 2 | ## This file is part of the libsigrok project. |
d8f6e041 ML |
3 | ## |
4 | ## Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li> | |
5 | ## | |
6 | ## This program is free software: you can redistribute it and/or modify | |
7 | ## it under the terms of the GNU General Public License as published by | |
8 | ## the Free Software Foundation, either version 3 of the License, or | |
9 | ## (at your option) any later version. | |
10 | ## | |
11 | ## This program is distributed in the hope that it will be useful, | |
12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | ## GNU General Public License for more details. | |
15 | ## | |
16 | ## You should have received a copy of the GNU General Public License | |
17 | ## along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | ## | |
19 | ||
20 | from functools import partial | |
21 | from fractions import Fraction | |
1cad2115 ML |
22 | from .lowlevel import * |
23 | from . import lowlevel | |
d8f6e041 ML |
24 | import itertools |
25 | ||
9bbd6a6a ML |
26 | __all__ = ['Error', 'Context', 'Driver', 'Device', 'Session', 'Packet', 'Log', |
27 | 'LogLevel', 'PacketType', 'Quantity', 'Unit', 'QuantityFlag'] | |
d8f6e041 ML |
28 | |
29 | class Error(Exception): | |
30 | ||
31 | def __str__(self): | |
32 | return sr_strerror(self.args[0]) | |
33 | ||
34 | def check(result): | |
35 | if result != SR_OK: | |
36 | raise Error(result) | |
37 | ||
38 | def config_key(name): | |
39 | if not name.lower() == name: | |
40 | raise AttributeError | |
41 | key_name = "SR_CONF_" + name.upper() | |
42 | return getattr(lowlevel, key_name) | |
43 | ||
44 | def gvariant_to_python(value): | |
45 | type_string = g_variant_get_type_string(value) | |
46 | if type_string == 't': | |
47 | return g_variant_get_uint64(value) | |
48 | if type_string == 'b': | |
49 | return g_variant_get_bool(value) | |
50 | if type_string == 'd': | |
51 | return g_variant_get_double(value) | |
52 | if type_string == 's': | |
53 | return g_variant_get_string(value, None) | |
54 | if type_string == '(tt)': | |
55 | return Fraction( | |
56 | g_variant_get_uint64(g_variant_get_child_value(value, 0)), | |
57 | g_variant_get_uint64(g_variant_get_child_value(value, 1))) | |
1cad2115 | 58 | raise NotImplementedError( |
d8f6e041 ML |
59 | "Can't convert GVariant type '%s' to a Python type." % type_string) |
60 | ||
61 | def python_to_gvariant(value): | |
62 | if isinstance(value, int): | |
63 | return g_variant_new_uint64(value) | |
64 | if isinstance(value, bool): | |
65 | return g_variant_new_boolean(value) | |
66 | if isinstance(value, float): | |
67 | return g_variant_new_double(value) | |
68 | if isinstance(value, str): | |
69 | return g_variant_new_string(value) | |
70 | if isinstance(value, Fraction): | |
71 | array = new_gvariant_ptr_array(2) | |
1e2bd8af ML |
72 | gvariant_ptr_array_setitem(array, 0, |
73 | g_variant_new_uint64(value.numerator)) | |
74 | gvariant_ptr_array_setitem(array, 1, | |
75 | g_variant_new_uint64(value.denominator)) | |
d8f6e041 ML |
76 | result = g_variant_new_tuple(array, 2) |
77 | delete_gvariant_ptr_array(array) | |
78 | return result | |
1cad2115 | 79 | raise NotImplementedError( |
d8f6e041 ML |
80 | "Can't convert Python '%s' to a GVariant." % type(value)) |
81 | ||
82 | def callback_wrapper(session, callback, device_ptr, packet_ptr): | |
83 | device = session.context._devices[int(device_ptr.this)] | |
84 | packet = Packet(session, packet_ptr) | |
85 | callback(device, packet) | |
86 | ||
87 | class Context(object): | |
88 | ||
89 | def __init__(self): | |
90 | context_ptr_ptr = new_sr_context_ptr_ptr() | |
91 | check(sr_init(context_ptr_ptr)) | |
92 | self.struct = sr_context_ptr_ptr_value(context_ptr_ptr) | |
93 | self._drivers = None | |
94 | self._devices = {} | |
95 | self.session = None | |
96 | ||
97 | def __del__(self): | |
98 | sr_exit(self.struct) | |
99 | ||
100 | @property | |
101 | def drivers(self): | |
102 | if not self._drivers: | |
103 | self._drivers = {} | |
104 | driver_list = sr_driver_list() | |
105 | for i in itertools.count(): | |
106 | driver_ptr = sr_dev_driver_ptr_array_getitem(driver_list, i) | |
107 | if driver_ptr: | |
108 | self._drivers[driver_ptr.name] = Driver(self, driver_ptr) | |
109 | else: | |
110 | break | |
111 | return self._drivers | |
112 | ||
113 | class Driver(object): | |
114 | ||
115 | def __init__(self, context, struct): | |
116 | self.context = context | |
117 | self.struct = struct | |
118 | self._initialized = False | |
119 | ||
120 | @property | |
121 | def name(self): | |
122 | return self.struct.name | |
123 | ||
124 | def scan(self): | |
125 | if not self._initialized: | |
126 | check(sr_driver_init(self.context.struct, self.struct)) | |
127 | self._initialized = True | |
128 | devices = [] | |
129 | device_list = sr_driver_scan(self.struct, None) | |
130 | device_list_item = device_list | |
131 | while device_list_item: | |
132 | ptr = device_list_item.data | |
133 | device_ptr = gpointer_to_sr_dev_inst_ptr(ptr) | |
134 | devices.append(Device(self, device_ptr)) | |
135 | device_list_item = device_list_item.next | |
136 | g_slist_free(device_list) | |
137 | return devices | |
138 | ||
139 | class Device(object): | |
140 | ||
141 | def __new__(cls, driver, struct): | |
142 | address = int(struct.this) | |
143 | if address not in driver.context._devices: | |
144 | device = super(Device, cls).__new__(cls, driver, struct) | |
145 | driver.context._devices[address] = device | |
146 | return driver.context._devices[address] | |
147 | ||
148 | def __init__(self, driver, struct): | |
149 | self.driver = driver | |
150 | self.struct = struct | |
151 | ||
152 | def __getattr__(self, name): | |
153 | key = config_key(name) | |
154 | data = new_gvariant_ptr_ptr() | |
155 | try: | |
156 | check(sr_config_get(self.driver.struct, key, data, self.struct)) | |
157 | except Error as error: | |
0021b077 | 158 | if error.errno == SR_ERR_NA: |
1cad2115 | 159 | raise NotImplementedError( |
d8f6e041 ML |
160 | "Device does not implement %s" % name) |
161 | else: | |
162 | raise AttributeError | |
163 | value = gvariant_ptr_ptr_value(data) | |
164 | return gvariant_to_python(value) | |
165 | ||
166 | def __setattr__(self, name, value): | |
167 | try: | |
168 | key = config_key(name) | |
169 | except AttributeError: | |
170 | super(Device, self).__setattr__(name, value) | |
171 | return | |
172 | check(sr_config_set(self.struct, key, python_to_gvariant(value))) | |
173 | ||
174 | @property | |
175 | def vendor(self): | |
176 | return self.struct.vendor | |
177 | ||
178 | @property | |
179 | def model(self): | |
180 | return self.struct.model | |
181 | ||
182 | @property | |
183 | def version(self): | |
184 | return self.struct.version | |
185 | ||
186 | class Session(object): | |
187 | ||
188 | def __init__(self, context): | |
189 | assert context.session is None | |
190 | self.context = context | |
191 | self.struct = sr_session_new() | |
192 | context.session = self | |
193 | ||
194 | def __del__(self): | |
195 | check(sr_session_destroy()) | |
196 | ||
197 | def add_device(self, device): | |
198 | check(sr_session_dev_add(device.struct)) | |
199 | ||
200 | def add_callback(self, callback): | |
201 | wrapper = partial(callback_wrapper, self, callback) | |
202 | check(sr_session_datafeed_python_callback_add(wrapper)) | |
203 | ||
204 | def start(self): | |
205 | check(sr_session_start()) | |
206 | ||
207 | def run(self): | |
208 | check(sr_session_run()) | |
209 | ||
210 | def stop(self): | |
211 | check(sr_session_stop()) | |
212 | ||
213 | class Packet(object): | |
214 | ||
215 | def __init__(self, session, struct): | |
216 | self.session = session | |
217 | self.struct = struct | |
218 | self._payload = None | |
219 | ||
220 | @property | |
221 | def type(self): | |
9bbd6a6a | 222 | return PacketType(self.struct.type) |
d8f6e041 ML |
223 | |
224 | @property | |
225 | def payload(self): | |
226 | if self._payload is None: | |
227 | pointer = self.struct.payload | |
9bbd6a6a | 228 | if self.type == PacketType.LOGIC: |
d8f6e041 ML |
229 | self._payload = Logic(self, |
230 | void_ptr_to_sr_datafeed_logic_ptr(pointer)) | |
9bbd6a6a | 231 | elif self.type == PacketType.ANALOG: |
15574a3c ML |
232 | self._payload = Analog(self, |
233 | void_ptr_to_sr_datafeed_analog_ptr(pointer)) | |
d8f6e041 | 234 | else: |
1cad2115 | 235 | raise NotImplementedError( |
d8f6e041 ML |
236 | "No Python mapping for packet type %ѕ" % self.struct.type) |
237 | return self._payload | |
238 | ||
239 | class Logic(object): | |
240 | ||
241 | def __init__(self, packet, struct): | |
242 | self.packet = packet | |
243 | self.struct = struct | |
244 | self._data = None | |
245 | ||
246 | @property | |
247 | def data(self): | |
248 | if self._data is None: | |
249 | self._data = cdata(self.struct.data, self.struct.length) | |
250 | return self._data | |
251 | ||
15574a3c ML |
252 | class Analog(object): |
253 | ||
254 | def __init__(self, packet, struct): | |
255 | self.packet = packet | |
256 | self.struct = struct | |
257 | self._data = None | |
258 | ||
259 | @property | |
260 | def num_samples(self): | |
261 | return self.struct.num_samples | |
262 | ||
c2ec42ce UH |
263 | @property |
264 | def mq(self): | |
9bbd6a6a | 265 | return Quantity(self.struct.mq) |
c2ec42ce UH |
266 | |
267 | @property | |
268 | def unit(self): | |
9bbd6a6a | 269 | return Unit(self.struct.unit) |
c2ec42ce UH |
270 | |
271 | @property | |
272 | def mqflags(self): | |
9bbd6a6a | 273 | return QuantityFlag.set_from_mask(self.struct.mqflags) |
c2ec42ce | 274 | |
15574a3c ML |
275 | @property |
276 | def data(self): | |
277 | if self._data is None: | |
278 | self._data = float_array.frompointer(self.struct.data) | |
279 | return self._data | |
280 | ||
816aed6c UH |
281 | class Log(object): |
282 | ||
816aed6c UH |
283 | @property |
284 | def level(self): | |
9bbd6a6a | 285 | return LogLevel(sr_log_loglevel_get()) |
816aed6c UH |
286 | |
287 | @level.setter | |
288 | def level(self, l): | |
9bbd6a6a | 289 | check(sr_log_loglevel_set(l.id)) |
816aed6c UH |
290 | |
291 | @property | |
292 | def domain(self): | |
293 | return sr_log_logdomain_get() | |
294 | ||
295 | @domain.setter | |
296 | def domain(self, d): | |
297 | check(sr_log_logdomain_set(d)) | |
298 | ||
9bbd6a6a ML |
299 | class EnumValue(object): |
300 | ||
301 | _enum_values = {} | |
302 | ||
303 | def __new__(cls, id): | |
304 | if cls not in cls._enum_values: | |
305 | cls._enum_values[cls] = {} | |
306 | if id not in cls._enum_values[cls]: | |
307 | value = super(EnumValue, cls).__new__(cls) | |
308 | value.id = id | |
309 | cls._enum_values[cls][id] = value | |
310 | return cls._enum_values[cls][id] | |
311 | ||
312 | class LogLevel(EnumValue): | |
313 | pass | |
314 | ||
315 | class PacketType(EnumValue): | |
316 | pass | |
317 | ||
318 | class Quantity(EnumValue): | |
319 | pass | |
320 | ||
321 | class Unit(EnumValue): | |
322 | pass | |
323 | ||
324 | class QuantityFlag(EnumValue): | |
325 | ||
326 | @classmethod | |
327 | def set_from_mask(cls, mask): | |
328 | result = set() | |
329 | while mask: | |
330 | new_mask = mask & (mask - 1) | |
331 | result.add(cls(mask ^ new_mask)) | |
332 | mask = new_mask | |
333 | return result | |
334 | ||
d8f6e041 | 335 | for symbol_name in dir(lowlevel): |
9bbd6a6a ML |
336 | for prefix, cls in [ |
337 | ('SR_LOG_', LogLevel), | |
338 | ('SR_DF_', PacketType), | |
339 | ('SR_MQ_', Quantity), | |
340 | ('SR_UNIT_', Unit), | |
341 | ('SR_MQFLAG_', QuantityFlag)]: | |
342 | if symbol_name.startswith(prefix): | |
343 | name = symbol_name[len(prefix):] | |
344 | value = getattr(lowlevel, symbol_name) | |
345 | setattr(cls, name, cls(value)) |