From 319bb58fa93421283a4c0b9cbf8f474f11a1530e Mon Sep 17 00:00:00 2001
From: Sebastian Muszytowski <sebastian@muszytowski.net>
Date: Wed, 17 Feb 2016 18:29:03 +0100
Subject: add missing header information with length+type info

---
 utilities/blinkenrocket.py      | 24 +++++++++++++++++++++---
 utilities/test_blinkenrocket.py |  5 +++--
 2 files changed, 24 insertions(+), 5 deletions(-)

(limited to 'utilities')

diff --git a/utilities/blinkenrocket.py b/utilities/blinkenrocket.py
index 26d94fb..a6afe8a 100644
--- a/utilities/blinkenrocket.py
+++ b/utilities/blinkenrocket.py
@@ -104,15 +104,21 @@ class modem:
 		wav.close()
 
 class Frame( object ):
-    """ Returns the representation """
-    def getRepresentation( self ):
-        raise NotImplementedError( "Should have implemented this" )
+	""" Returns the frame information """
+	def getFrameHeader(self):
+		raise NotImplementedError("You should implement this!")
+
+	""" Returns the representation """
+	def getRepresentation(self):
+		raise NotImplementedError("Should have implemented this")
 
 class textFrame(Frame):
 	text = ""
 	speed = 0
 	delay = 0
 	direction = 0
+	# identifier as of message specification: 0001
+	identifier = 0x01
 
 	def __init__(self,text,speed=1,delay=0,direction=0):
 		self.text = text
@@ -129,12 +135,17 @@ class textFrame(Frame):
 	def setDirection(self,direction):
 		self.direction = direction if direction in [0,1] else 0
 
+	# Frame header: 4 bit type + 12 bit length
+	def getFrameHeader(self):
+		return [chr(self.identifier << 4 | len(self.text) >> 8), chr(len(self.text) & 0xFF) ]
+
 	# Header -> 4bit speed, 4 bit delay, 4 bit direction, 4 bit zero
 	def getHeader(self):
 		return [chr(self.speed << 4 | self.delay), chr(self.direction << 4 | 0x00)]
 
 	def getRepresentation(self):
 		retval = []
+		retval.extend(self.getFrameHeader())
 		retval.extend(self.getHeader())
 		retval.extend(list(self.text))
 		return retval
@@ -143,6 +154,8 @@ class animationFrame(Frame):
 	animation = []
 	speed = 0
 	delay = 0
+	# identifier as per specification: 0010	
+	identifier = 0x02
 
 	def __init__(self,animation,speed=1,delay=0):
 		self.setAnimation(animation)
@@ -161,12 +174,17 @@ class animationFrame(Frame):
 	def setDelay(self,delay):
 		self.delay = delay if delay < 16 else 0
 
+	# Frame header: 4 bit type + 12 bit length
+	def getFrameHeader(self):
+		return [chr(self.identifier << 4 | len(self.animation) >> 8), chr(len(self.animation) & 0xFF) ]
+
 	# Header -> 4bit zero, 4bit speed, 4 bit zero, 4 bit direction
 	def getHeader(self):
 		return [chr(self.speed), chr(self.delay)]
 
 	def getRepresentation(self):
 		retval = []
+		retval.extend(self.getFrameHeader())
 		retval.extend(self.getHeader())
 		retval.extend(self.animation)
 		return retval
diff --git a/utilities/test_blinkenrocket.py b/utilities/test_blinkenrocket.py
index 11d8d91..b2da0fd 100644
--- a/utilities/test_blinkenrocket.py
+++ b/utilities/test_blinkenrocket.py
@@ -105,11 +105,12 @@ class TestBlinkenrocket(unittest.TestCase):
 
   def test_addFrameText(self):
     text = textFrame("MUZY",speed=7,delay=8,direction=1)
+    self.assertEquals(text.getFrameHeader(),[chr(0x01 << 4), chr(4)])
     self.assertEquals(text.getHeader(),[chr(7 << 4 | 8),chr(1 << 4 | 0)])
-    self.assertEquals(text.getRepresentation(),[chr(7 << 4 | 8),chr(1 << 4 | 0),'M','U','Z','Y'])
+    self.assertEquals(text.getRepresentation(),[chr(0x01 << 4), chr(4),chr(7 << 4 | 8),chr(1 << 4 | 0),'M','U','Z','Y'])
     br = blinkenrocket()
     br.addFrame(text)
-    expect = [chr(0x99),chr(0x99),chr(0xA9),chr(0xA9),chr(7 << 4 | 8),chr(1 << 4 | 0),'M','U','Z','Y']
+    expect = [chr(0x99),chr(0x99),chr(0xA9),chr(0xA9),chr(0x01 << 4), chr(4),chr(7 << 4 | 8),chr(1 << 4 | 0),'M','U','Z','Y']
     self.assertEquals(br.getMessage(),expect)
 
 if __name__ == '__main__':
-- 
cgit v1.2.3