[libsigrokdecode.git] / decoders / pan1321 / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

# Panasonic PAN1321 Bluetooth module protocol decoder

import sigrokdecode as srd

# ...
RX = 0
TX = 1

class Decoder(srd.Decoder):
    api_version = 1
    id = 'pan1321'
    name = 'PAN1321'
    longname = 'Panasonic PAN1321'
    desc = 'Bluetooth RF module with Serial Port Profile (SPP).'
    license = 'gplv2+'
    inputs = ['uart']
    outputs = ['pan1321']
    probes = []
    optional_probes = []
    options = {}
    annotations = [
        ['Text (verbose)', 'Human-readable text (verbose)'],
        ['Text', 'Human-readable text'],
    ]

    def __init__(self, **kwargs):
        self.cmd = ['', '']
        self.ss_block = None

    def start(self, metadata):
        # self.out_proto = self.add(srd.OUTPUT_PROTO, 'pan1321')
        self.out_ann = self.add(srd.OUTPUT_ANN, 'pan1321')

    def report(self):
        pass

    def putx(self, data):
        self.put(self.ss_block, self.es_block, self.out_ann, data)

    def handle_host_command(self, rxtx, s):
        if s.startswith('AT+JSEC'):
            pin = s[-4:]
            self.putx([0, ['Host set the Bluetooth PIN to ' + pin]])
            self.putx([1, ['PIN = ' + pin]])
        elif s.startswith('AT+JSLN'):
            name = s[s.find(',') + 1:]
            self.putx([0, ['Host set the Bluetooth name to ' + name]])
            self.putx([1, ['BT name = ' + name]])
        else:
            self.putx([0, ['Host sent unsupported command: %s' % s]])
            self.putx([1, ['Unsupported command: %s' % s]])
        self.cmd[rxtx] = ''

    def handle_device_reply(self, rxtx, s):
        if s == 'ROK':
            self.putx([0, ['Device initialized correctly']])
            self.putx([1, ['Init']])
        elif s == 'OK':
            self.putx([0, ['Device acknowledged last command']])
            self.putx([1, ['ACK']])
        elif s.startswith('ERR'):
            error = s[s.find('=') + 1:]
            self.putx([0, ['Device sent error code ' + error]])
            self.putx([1, ['ERR = ' + error]])
        else:
            self.putx([0, ['Device sent an unknown reply: %s' % s]])
            self.putx([1, ['Unknown reply: %s' % s]])
        self.cmd[rxtx] = ''

    def decode(self, ss, es, data):
        ptype, rxtx, pdata = data

        # For now, ignore all UART packets except the actual data packets.
        if ptype != 'DATA':
            return

        # If this is the start of a command/reply, remember the start sample.
        if self.cmd[rxtx] == '':
            self.ss_block = ss

        # Append a new (ASCII) byte to the currently built/parsed command.
        self.cmd[rxtx] += chr(pdata)

        # Get packets/bytes until an \r\n sequence is found (end of command).
        if self.cmd[rxtx][-1:] != '\n':
            return

        # Handle host commands and device replies.
        # We remove trailing \r\n from the strings before handling them.
        if rxtx == RX:
            self.es_block = es
            self.handle_device_reply(rxtx, self.cmd[rxtx][:-2])
        elif rxtx == TX:
            self.es_block = es
            self.handle_host_command(rxtx, self.cmd[rxtx][:-2])
        else:
            raise Exception('Invalid rxtx value: %d' % rxtx)
Commit	Line	Data
	1	##
	2	## This file is part of the libsigrokdecode project.
	3	##
	4	## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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, write to the Free Software
	18	## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	##
	20
	21	# Panasonic PAN1321 Bluetooth module protocol decoder
	22
	23	import sigrokdecode as srd
	24
	25	# ...
	26	RX = 0
	27	TX = 1
	28
	29	class Decoder(srd.Decoder):
	30	api_version = 1
	31	id = 'pan1321'
	32	name = 'PAN1321'
	33	longname = 'Panasonic PAN1321'
	34	desc = 'Bluetooth RF module with Serial Port Profile (SPP).'
	35	license = 'gplv2+'
	36	inputs = ['uart']
	37	outputs = ['pan1321']
	38	probes = []
	39	optional_probes = []
	40	options = {}
	41	annotations = [
	42	['Text (verbose)', 'Human-readable text (verbose)'],
	43	['Text', 'Human-readable text'],
	44	]
	45
	46	def __init__(self, **kwargs):
	47	self.cmd = ['', '']
	48	self.ss_block = None
	49
	50	def start(self, metadata):
	51	# self.out_proto = self.add(srd.OUTPUT_PROTO, 'pan1321')
	52	self.out_ann = self.add(srd.OUTPUT_ANN, 'pan1321')
	53
	54	def report(self):
	55	pass
	56
	57	def putx(self, data):
	58	self.put(self.ss_block, self.es_block, self.out_ann, data)
	59
	60	def handle_host_command(self, rxtx, s):
	61	if s.startswith('AT+JSEC'):
	62	pin = s[-4:]
	63	self.putx([0, ['Host set the Bluetooth PIN to ' + pin]])
	64	self.putx([1, ['PIN = ' + pin]])
	65	elif s.startswith('AT+JSLN'):
	66	name = s[s.find(',') + 1:]
	67	self.putx([0, ['Host set the Bluetooth name to ' + name]])
	68	self.putx([1, ['BT name = ' + name]])
	69	else:
	70	self.putx([0, ['Host sent unsupported command: %s' % s]])
	71	self.putx([1, ['Unsupported command: %s' % s]])
	72	self.cmd[rxtx] = ''
	73
	74	def handle_device_reply(self, rxtx, s):
	75	if s == 'ROK':
	76	self.putx([0, ['Device initialized correctly']])
	77	self.putx([1, ['Init']])
	78	elif s == 'OK':
	79	self.putx([0, ['Device acknowledged last command']])
	80	self.putx([1, ['ACK']])
	81	elif s.startswith('ERR'):
	82	error = s[s.find('=') + 1:]
	83	self.putx([0, ['Device sent error code ' + error]])
	84	self.putx([1, ['ERR = ' + error]])
	85	else:
	86	self.putx([0, ['Device sent an unknown reply: %s' % s]])
	87	self.putx([1, ['Unknown reply: %s' % s]])
	88	self.cmd[rxtx] = ''
	89
	90	def decode(self, ss, es, data):
	91	ptype, rxtx, pdata = data
	92
	93	# For now, ignore all UART packets except the actual data packets.
	94	if ptype != 'DATA':
	95	return
	96
	97	# If this is the start of a command/reply, remember the start sample.
	98	if self.cmd[rxtx] == '':
	99	self.ss_block = ss
	100
	101	# Append a new (ASCII) byte to the currently built/parsed command.
	102	self.cmd[rxtx] += chr(pdata)
	103
	104	# Get packets/bytes until an \r\n sequence is found (end of command).
	105	if self.cmd[rxtx][-1:] != '\n':
	106	return
	107
	108	# Handle host commands and device replies.
	109	# We remove trailing \r\n from the strings before handling them.
	110	if rxtx == RX:
	111	self.es_block = es
	112	self.handle_device_reply(rxtx, self.cmd[rxtx][:-2])
	113	elif rxtx == TX:
	114	self.es_block = es
	115	self.handle_host_command(rxtx, self.cmd[rxtx][:-2])
	116	else:
	117	raise Exception('Invalid rxtx value: %d' % rxtx)
	118