decoders/pwm/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2014 Torsten Duwe <duwe@suse.de>
   5 ## Copyright (C) 2014 Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com>
   6 ##
   7 ## This program is free software; you can redistribute it and/or modify
   8 ## it under the terms of the GNU General Public License as published by
   9 ## the Free Software Foundation; either version 2 of the License, or
  10 ## (at your option) any later version.
  11 ##
  12 ## This program is distributed in the hope that it will be useful,
  13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ## GNU General Public License for more details.
  16 ##
  17 ## You should have received a copy of the GNU General Public License
  18 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  19 ##
  20
  21 import sigrokdecode as srd
  22
  23 class Decoder(srd.Decoder):
  24     api_version = 3
  25     id = 'pwm'
  26     name = 'PWM'
  27     longname = 'Pulse-width modulation'
  28     desc = 'Analog level encoded in duty cycle percentage.'
  29     license = 'gplv2+'
  30     inputs = ['logic']
  31     outputs = ['pwm']
  32     channels = (
  33         {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
  34     )
  35     options = (
  36         {'id': 'polarity', 'desc': 'Polarity', 'default': 'active-high',
  37             'values': ('active-low', 'active-high')},
  38     )
  39     annotations = (
  40         ('duty-cycle', 'Duty cycle'),
  41         ('period', 'Period'),
  42     )
  43     annotation_rows = (
  44          ('duty-cycle', 'Duty cycle', (0,)),
  45          ('period', 'Period', (1,)),
  46     )
  47     binary = (
  48         ('raw', 'RAW file'),
  49     )
  50
  51     def __init__(self):
  52         self.ss_block = self.es_block = None
  53         self.num_cycles = 0
  54
  55     def metadata(self, key, value):
  56         if key == srd.SRD_CONF_SAMPLERATE:
  57             self.samplerate = value
  58
  59     def start(self):
  60         self.out_ann = self.register(srd.OUTPUT_ANN)
  61         self.out_binary = self.register(srd.OUTPUT_BINARY)
  62         self.out_average = \
  63             self.register(srd.OUTPUT_META,
  64                           meta=(float, 'Average', 'PWM base (cycle) frequency'))
  65
  66     def putx(self, data):
  67         self.put(self.ss_block, self.es_block, self.out_ann, data)
  68
  69     def putp(self, period_t):
  70         # Adjust granularity.
  71         if period_t == 0 or period_t >= 1:
  72             period_s = '%.1f s' % (period_t)
  73         elif period_t <= 1e-12:
  74             period_s = '%.1f fs' % (period_t * 1e15)
  75         elif period_t <= 1e-9:
  76             period_s = '%.1f ps' % (period_t * 1e12)
  77         elif period_t <= 1e-6:
  78             period_s = '%.1f ns' % (period_t * 1e9)
  79         elif period_t <= 1e-3:
  80             period_s = '%.1f μs' % (period_t * 1e6)
  81         else:
  82             period_s = '%.1f ms' % (period_t * 1e3)
  83
  84         self.put(self.ss_block, self.es_block, self.out_ann, [1, [period_s]])
  85
  86     def putb(self, data):
  87         # TODO Are these ss/es specs appropriate? It's the same value,
  88         # which represents a mere period counter, not sample numbers.
  89         # Probably should be:
  90         # self.put(self.ss_block, self.es_block, self.out_binary, data)
  91         self.put(self.num_cycles, self.num_cycles, self.out_binary, data)
  92
  93     def decode(self):
  94         average = 0
  95
  96         # Wait for an "active" edge (depends on config). This starts
  97         # the first full period of the inspected signal waveform.
  98         self.wait({0: 'f' if self.options['polarity'] == 'active-low' else 'r'})
  99         self.first_samplenum = self.samplenum
 100
 101         # Keep getting samples for the period's middle and terminal edges.
 102         # At the same time that last sample starts the next period.
 103         while True:
 104
 105             # Get the next two edges. Setup some variables that get
 106             # referenced in the calculation and in put() routines.
 107             start_samplenum = self.samplenum
 108             pins = self.wait({0: 'e'})
 109             end_samplenum = self.samplenum
 110             pins = self.wait({0: 'e'})
 111             self.ss_block = start_samplenum
 112             self.es_block = self.samplenum
 113
 114             # Calculate the period, the duty cycle, and its ratio.
 115             period = self.samplenum - start_samplenum
 116             duty = end_samplenum - start_samplenum
 117             ratio = float(duty / period)
 118
 119             # Report the duty cycle in percent.
 120             percent = float(ratio * 100)
 121             self.putx([0, ['%f%%' % percent]])
 122
 123             # Report the duty cycle in the binary output.
 124             self.putb([0, bytes([int(ratio * 256)])])
 125
 126             # Report the period in units of time.
 127             period_t = float(period / self.samplerate)
 128             self.putp(period_t)
 129
 130             # Update and report the new duty cycle average.
 131             self.num_cycles += 1
 132             average += percent
 133             self.put(self.first_samplenum, self.es_block, self.out_average,
 134                      float(average / self.num_cycles))