cleanup and docs

Py_Keyboard/HID.py

@@ -1,13 +1,4 @@
-# The MIT License (MIT)
 
-#
-
-"""
-`adafruit_hid.keyboard_layout_us.KeyboardLayoutUS`
-=======================================================
-
-* Author(s): Dan Halbert
-"""
 import time
 
 
@@ -474,16 +465,20 @@ def write(self, string):
             # Write abc followed by Enter to the keyboard
             layout.write('abc\\n')
         """
+        written_codes = []
         for char in string:
             keycode = self._char_to_keycode(char)
             # If this is a shifted char, clear the SHIFT flag and press the SHIFT key.
             if keycode & self.SHIFT_FLAG:
                 keycode &= ~self.SHIFT_FLAG
-                self.writer(Keycode.SHIFT)
-            self.writer(keycode)
+                result = self.writer(Keycode.SHIFT)
+                written_codes.append(result)
+            result = self.writer(keycode)
+            written_codes.append(result)
+
 
             self.release_all()
-
+        return (written_codes)
 
     def keycodes(self, char):
         """Return a tuple of keycodes needed to type the given character.
@@ -533,6 +528,7 @@ def press(self, keycodes):
             self._add_keycode_to_report(int(keycode))
         send_report(self.report)
         Keyboard.release_all(self)
+        return self.report
 
     def writer(self, *keycodes):
 
@@ -541,6 +537,8 @@ def writer(self, *keycodes):
 
         send_report(self.report)
 
+        return self.report
+
     def release(self, *keycodes):
 
         for keycode in keycodes:
@@ -594,39 +592,13 @@ def _remove_keycode_from_report(self, keycode):
 
 
 
-# The MIT License (MIT)
-#
-# Copyright (c) 2017 Dan Halbert
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-
-"""
-`adafruit_hid.keyboard.Keyboard`
-====================================================
-
-* Author(s): Scott Shawcroft, Dan Halbert
-"""
+
 def send_report(report):
+    """ write bytes to HID device """
     with open('/dev/hidg0', 'rb+') as fd:
         fd.write(report)
 
 
 
+
 

README.md

@@ -36,12 +36,30 @@ kbd.write('ls\n')
 
 
 
+```
+
+### Editing 
+All write operations are done inside the `send_report` function inside `Py_Keyboard>HID.py`
+
+bytes written can be returned from the press and write function
+
+```python
 
 
+from Py_Keyboard.HID import Keyboard
 
+kbd = Keyboard()
 
+bytes_press = kbd.press("CONTROL ALT T")
+print(bytes_press)
+bytes_write = kbd.write('ls\n')
+print(bytes_write)
 ```
 
+### Keycodes
+Keycodes are graciously borrowed from adafruit 
+
+see documentation [here](Py_Keyboard/keycodes.py)
 
 
 ## to do