docs and comments

Author: sasilva1998

README.md

@@ -1,2 +1,36 @@
 # uPy-genpy
+
+This is a little similar implementation of `genpy` for uPy. In order to use rosserial with it, having messages classes. For that and automation purposes, this package has been done so that this classes can be done easily. This has been done to be used with [uPy rosserial](https://github.com/FunPythonEC/uPy-rosserial).
+
+## Features
+
+- [x] uPy files gen with publish availability
+- [ ] uPy files gen with subscribe availability
+- [ ] Actions
+- [ ] Services
+
+## Installation
+In order to use this package the folder `ugenpy` from `src` must be copied to the flash memory. I strongly recommend using [rshell](https://github.com/dhylands/rshell) for this task. 
+
+There is also a folder called `std_msgs` which has all default `*.msg` files, this folder can also be copied or any other folder with the wanted message types. For memory purposes not all the `msg` files in that folder must be copied, only the ones that are going to be used.
+
+>Note: Soon this will be available to be installed with upip.
+
+## Usage
+
+Suppose there is already the dir `std_msgs/ColorRGB.msg` and we want to create the uPy file for it, then a script like below can be run:
+
+``` python
+from ugenpy.message import MessageGenerator
+msg=MessageGenerator('std_msgs/ColorRGBA.msg')
+msg.create_message()
+```
+
+You could verify it has been created with the following:
+``` python
+import os
+os.listdir('std_msgs')
+```
+=======
 Here everything needed in order to generate the python files for message usage can be found.
+>>>>>>> 73de94b4ea4c44f58ebda99e238657cef2698260

src/ugenpy/message.py

@@ -1,5 +1,9 @@
 from . import md5
 
+"""
+Message class copied from:
+https://github.com/ros/genpy
+"""
 class Message(object):
 
     __slots__ = ['_connection_header']
@@ -25,13 +29,20 @@ def __init__(self, *args, **kwds):
                 else:
                     setattr(self, k, None)
 
+"""
+Since a Python file with the message class is nedeed
+this class is responsible about writing that file
+"""
 class MessageGenerator(object):
 
     def __init__(self, addr):
 
         self.addr=addr
 
+    # method to create message
     def create_message(self):
+
+        #struct primitive data types and default types
         def_types={'bool':'<B', 'byte':'<b', 'char':'<B', 'float32':'<f', 'float64':'<d', 'int8':'<b', 'int16':'<h', 'int32':'<i', 
         'int64':'<q', 'string':'<I%ss', 'uint8':'<B', 'uint16':'<H', 'uint32':'<I', 'uint64':'<Q'}
 
@@ -87,10 +98,9 @@ def __init__(self, *args, **kwds):
                 if args or kwds:
                     super({}, self).__init__(*args, **kwds)\n""".format(slots, slots_type, script_name)    
         script.write(initdef)
-        print(len(slots))
-        print(slots_type)
 
-        
+
+        #asigning self attributes        
         for i in range(0,len(data)-1):
             temp=[data[i].split(' ')[0],data[i].split(' ')[1]]
             if 'bool' in temp[0]:
@@ -101,8 +111,6 @@ def __init__(self, *args, **kwds):
                 val='0.'
             else:
                 val='0'
-            
-            
             script.write("""
                     if self.{} is None:
                         self.{} = {}""".format(temp[0], temp[0], val))
@@ -115,6 +123,7 @@ def _get_types(self):
             def serialize(self, buff):
                 try:""")
 
+        #serialization part
         for i in range(0,len(data)-1):
             temp=data[i].split(' ')[1]
             if 'string' in data[i].split(' ')[0]:
@@ -128,5 +137,4 @@ def serialize(self, buff):
         script.write("""
                 except Exception as e:
                     print(e)""")
-
-        script.close()
+        script.close()

tests/colorrgba.py

@@ -0,0 +1,3 @@
+from ugenpy.message import MessageGenerator
+msg=MessageGenerator('std_msgs/ColorRGBA.msg')
+msg.create_message()