2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2020 Tomas Mudrunka <harvie@github>
6 ## Permission is hereby granted, free of charge, to any person obtaining a copy
7 ## of this software and associated documentation files (the "Software"), to deal
8 ## in the Software without restriction, including without limitation the rights
9 ## to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 ## copies of the Software, and to permit persons to whom the Software is
11 ## furnished to do so, subject to the following conditions:
13 ## The above copyright notice and this permission notice shall be included in all
14 ## copies or substantial portions of the Software.
16 ## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 ## IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 ## FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 ## AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 ## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 ## OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 import sigrokdecode as srd
26 class Decoder(srd.Decoder):
30 longname = 'Digital calipers'
31 desc = 'Protocol of cheap generic digital calipers'
36 {'id': 'clk', 'name': 'CLK', 'desc': 'Serial clock line'},
37 {'id': 'data', 'name': 'DATA', 'desc': 'Serial data line'},
40 {'id': 'timeout_ms', 'desc': 'Timeout packet after X ms, 0 to disable', 'default': 10},
41 {'id': 'unit', 'desc': 'Convert units', 'default': 'keep', 'values': ('keep', 'mm', 'inch')},
42 {'id': 'changes', 'desc': 'Changes only', 'default': 'no', 'values': ('no', 'yes')},
44 tags = ['Analog/digital', 'IC', 'Sensor']
46 ('measurements', 'Measurements'),
47 ('warning', 'Warnings'),
50 ('measurements', 'Measurements', (0,)),
51 ('warnings', 'Warnings', (1,)),
59 def metadata(self, key, value):
60 if key == srd.SRD_CONF_SAMPLERATE:
61 self.samplerate = value
67 self.ss_cmd, self.es_cmd = 0, 0
71 self.out_ann = self.register(srd.OUTPUT_ANN)
73 #Switch bit order of variable x, which is l bit long
75 return int(bin(x)[2:].zfill(l)[::-1], 2)
78 self.last_measurement = None
80 clk, data = self.wait([{0: 'r'},{'skip': round(self.samplerate/1000)}])
83 #Timeout after inactivity
84 if(self.options['timeout_ms'] > 0):
85 if self.samplenum > self.es_cmd + (self.samplerate/(1000/self.options['timeout_ms'])):
87 self.put(self.ss_cmd, self.samplenum, self.out_ann, [1, ['timeout with %s bits in buffer'%(self.bits),'timeout']])
90 #Do nothing if there was timeout without rising clock edge
91 if self.matched == (False, True):
94 #Store position of last activity
95 self.es_cmd = self.samplenum
97 #Store position of first bit
99 self.ss_cmd = self.samplenum
101 #Shift in measured number
103 self.number = (self.number << 1) | (data & 0b1)
109 self.flags = (self.flags << 1) | (data & 0b1)
113 #Hooray! We got last bit of data
114 self.es_cmd = self.samplenum
118 #print(format(self.flags, '08b'));
120 negative = ((self.flags & 0b00001000) >> 3)
121 inch = (self.flags & 0b00000001)
123 number = self.bitr(self.number, 16)
125 #print(format(number, '016b'))
130 inchmm = 25.4 #how many mms in inch
134 if self.options['unit'] == 'mm':
139 if self.options['unit'] == 'inch':
140 number = round(number/inchmm,4)
143 units = "in" if inch else "mm"
145 measurement = (str(number)+units)
148 if ((self.options['changes'] == 'no') or (self.last_measurement != measurement)):
149 self.put(self.ss_cmd, self.es_cmd, self.out_ann, [0, [measurement, str(number)]])
150 self.last_measurement = measurement
152 #Prepare for next packet