Difference between revisions of "BeagleBoard/GSoC 2021/Micropython for BeagleConnect Freedom"

From eLinux.org
Jump to: navigation, search
Line 8: Line 8:
 
''Student'':  [https://elinux.org/User:Yadnik_Bendale Yadnik Bendale]<br>
 
''Student'':  [https://elinux.org/User:Yadnik_Bendale Yadnik Bendale]<br>
 
''Mentors'': [http://elinux.org/User:Jkridner Jason Kridner]<br>
 
''Mentors'': [http://elinux.org/User:Jkridner Jason Kridner]<br>
''Code'': https://github.com/deebot/Beaglebone-BidirectionBus<br>
+
''Code'': [[ https://github.com/micropython/micropython/tree/master/ports/zephyr|https://github.com/micropython/micropython/tree/master/ports/zephyr]]<br>
''Wiki'': http://elinux.org/BeagleBoard/GSoC/ProposalTemplate<br>
+
''Wiki'': N/A<br>
''GSoC'': [https://summerofcode.withgoogle.com/archive/2016/projects/4885400476712960/ GSoC entry]<br>
+
''GSoC'': N/A<br>
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
  
Line 26: Line 26:
 
''Primary language'':English,Hindi,Marathi<br>  
 
''Primary language'':English,Hindi,Marathi<br>  
 
''Typical work hours'': 9AM-9PM IST<br>
 
''Typical work hours'': 9AM-9PM IST<br>
''Previous GSoC participation'': Tell us why you want to participate in GSoC here. Also, provide list of URLs for any previous GSoC participation with any organizations.
+
''Previous GSoC participation'': I have a very keen interest in working in Embedded Systems and Internet of Things.Doing the Micropython for BeagleConnect Freedom project greatly intrigues and will definitely enable me to make a significant impact to the community by increasing the functionality and robustness of the BeagleConnect Freedom device.This is my first time participating in GSoC.
  
 
==About your project==
 
==About your project==
Line 38: Line 38:
 
'''Project Deliverables:'''<br>
 
'''Project Deliverables:'''<br>
 
<br>
 
<br>
'''1)Porting Micropython<br>'''
+
'''1)Porting MicroPython<br>'''
 
MicroPython is a completely free and open source software that is a lean and efficient implementation of the Python 3 programming language that includes a small subset of the Python standard library and is optimised to run on microcontrollers and in constrained environments.A few of its salient features that will be advantageous for the BeagleConnect include:<br>
 
MicroPython is a completely free and open source software that is a lean and efficient implementation of the Python 3 programming language that includes a small subset of the Python standard library and is optimised to run on microcontrollers and in constrained environments.A few of its salient features that will be advantageous for the BeagleConnect include:<br>
 
* It provides an interactive prompt (the REPL) to execute commands immediately, along with the ability to run and import scripts from the built-in filesystem. The REPL has history, tab completion, auto-indent and paste mode for a great user experience.<br>
 
* It provides an interactive prompt (the REPL) to execute commands immediately, along with the ability to run and import scripts from the built-in filesystem. The REPL has history, tab completion, auto-indent and paste mode for a great user experience.<br>
Line 61: Line 61:
 
* The first step would be creating a UF2 Port by Cloning the [https://github.com/adafruit/uf2-samdx1 Adafruit uf2-samdx1] repository followed by creating a new folder in boards/ with the particular board name.I will also refer other board files as examples for how to fill out the board files.<br>
 
* The first step would be creating a UF2 Port by Cloning the [https://github.com/adafruit/uf2-samdx1 Adafruit uf2-samdx1] repository followed by creating a new folder in boards/ with the particular board name.I will also refer other board files as examples for how to fill out the board files.<br>
 
*The next step will be cloning the Adafruit CircuitPython repository and creating a new folder with the board name.  
 
*The next step will be cloning the Adafruit CircuitPython repository and creating a new folder with the board name.  
For reference purposes i will constantly refer the Circuitpython Documentation and the forums for effective flow of the porting process.<br>
+
For reference purposes i will constantly refer the CircuitPython Documentation and the forums for effective flow of the porting process.<br>
 
'''I will test various pins and features of the board using  some hardware line  LEDs, resistors and EEPROM after each individual port.Pull requests will be generated for all the work done to the respective upstream repositories.'''<br>
 
'''I will test various pins and features of the board using  some hardware line  LEDs, resistors and EEPROM after each individual port.Pull requests will be generated for all the work done to the respective upstream repositories.'''<br>
 
<br>
 
<br>
'''3)Writing drivers in Micropython:<br>'''
+
'''3)Writing drivers in MicroPython:<br>'''
 
I will be following a general procedure as given below for writing GPIO, I2C, SPI, PWM,UART and ADC drivers for the BeagleConnect Freedom.Once done I will test it with MikroElektronika click boards,2 boards supporting each protocol to validate operation of both simultaneously as well as combined with another board using some other protocol.<br>
 
I will be following a general procedure as given below for writing GPIO, I2C, SPI, PWM,UART and ADC drivers for the BeagleConnect Freedom.Once done I will test it with MikroElektronika click boards,2 boards supporting each protocol to validate operation of both simultaneously as well as combined with another board using some other protocol.<br>
 
'''Procedure for drivers in Micropython:<br>'''
 
'''Procedure for drivers in Micropython:<br>'''
Line 114: Line 114:
 
|-
 
|-
 
| Jun 07 || Pre-work complete, Coding officially begins!
 
| Jun 07 || Pre-work complete, Coding officially begins!
*All the boards and hardware will be available to me and I will start with flashing the Zephyr RTOS on the Beagleconnect Freedom device.
+
*All the boards and hardware will be available to me and I will start with flashing the Zephyr RTOS on the BeagleConnect Freedom device.
*Complete Micropython port.
+
*Complete MicroPython port.
* Test various pins and features using Micropython and document it on my blog.
+
* Test various pins and features using MicroPython and document it on my blog.
  
 
|-
 
|-
| Jun 17 || Milestone #1||
+
| Jun 17 || Milestone #1
 
* Introductory YouTube video
 
* Introductory YouTube video
* Complete Circuitpython port.
+
* Complete CircuitPython port.
* Test various pins and features using Circuitpython and document it on my blog.
+
* Test various pins and features using CircuitPython and document it on my blog.
 
* Taking notes and feedback from my mentor regarding the progress of the porting, and address any issues if any.  
 
* Taking notes and feedback from my mentor regarding the progress of the porting, and address any issues if any.  
* By this stage I must have completed adding both Circuitpython and Micropython support to the Beagleconnect.
+
* By this stage I must have completed adding both CircuitPython and MicroPython support to the BeagleConnect.
 
|-
 
|-
 
| June 24 || Milestone #2
 
| June 24 || Milestone #2
 
* Start writing peripheral driver code from UART.
 
* Start writing peripheral driver code from UART.
 
* Complete writing UART driver code.
 
* Complete writing UART driver code.
* Implement and document working with MikroElektronika click boards using the UART Peripheral.
+
* Implement and document the working of the MikroElektronika click boards using the UART Peripheral.
 
|-
 
|-
 
| June 30 || Milestone #3
 
| June 30 || Milestone #3
 
*Complete writing I2C driver code.
 
*Complete writing I2C driver code.
*Implement and document working with MikroElektronika click boards using the I2C Peripheral.  
+
*Implement and document the working of the MikroElektronika click boards using the I2C Peripheral.  
 
|-
 
|-
 
| July 12 18:00 UTC ||
 
| July 12 18:00 UTC ||
 
* Complete writing SPI driver code.
 
* Complete writing SPI driver code.
* Implement and document working with MikroElektronika click boards using the SPI Peripheral
+
* Implement and documentthe working of the  MikroElektronika click boards using the SPI Peripheral
 
* Milestone #4, Mentors and students can begin submitting Phase 1 evaluations
 
* Milestone #4, Mentors and students can begin submitting Phase 1 evaluations
 
|-
 
|-
 
| July 16 18:00 UTC || Phase 1 Evaluation deadline
 
| July 16 18:00 UTC || Phase 1 Evaluation deadline
 
* Complete writing PWM driver code.
 
* Complete writing PWM driver code.
* Implement and document working with MikroElektronika click boards using the PWM Peripheral
+
* Implement and document the working of the  MikroElektronika click boards using the PWM Peripheral
 
|-
 
|-
 
| July 23 || Milestone #5
 
| July 23 || Milestone #5
 
* Complete writing ADC driver code.
 
* Complete writing ADC driver code.
* Implement and document working with MikroElektronika click boards using the ADC  Peripheral
+
* Implement and document the working of the  MikroElektronika click boards using the ADC  Peripheral
 
|-
 
|-
 
| July 30 || Milestone #6
 
| July 30 || Milestone #6
 
* Complete writing GPIO driver code.
 
* Complete writing GPIO driver code.
* Implement and document working with MikroElektronika click boards using the GPIO Peripheral
+
* Implement and document the working of the  MikroElektronika click boards using the GPIO Peripheral
 
|-
 
|-
 
| Aug 06 || Milestone #7
 
| Aug 06 || Milestone #7
Line 173: Line 173:
  
 
===Contingency===
 
===Contingency===
My belief has always been to ask my mentors only after giving my best towards that respective task and is definitely the way to go in open source.I have been religiously been making notes from all the resources I encounter and based on the discussions with the mentor on irc,which will also help me connect dots and help me figure my way out in any such situation.<br>
+
My belief has always been to ask my mentors only after giving my best towards that respective task and is definitely the way to go in open source.<br>
 
However in a case where I am out of resources and my mentor isn't around I will divert my focus towards documentation or towards a part of the project that is not correlated to the part I am stuck with.<br>
 
However in a case where I am out of resources and my mentor isn't around I will divert my focus towards documentation or towards a part of the project that is not correlated to the part I am stuck with.<br>
 
In such a case few references i would like to refer are:<br>
 
In such a case few references i would like to refer are:<br>
Line 182: Line 182:
  
 
===Benefit===
 
===Benefit===
If successfully completed, what will its impact be on the BeagleBoard.org community? Include quotes from BeagleBoard.org community members who can be found on http://beagleboard.org/discuss and http://bbb.io/gsocchat.
+
If completed successfully the functionality of the BeagleConnect will be greatly enhanced.It will be complete with the support of MicroPython which is used more of by the mainstream community as well as CircuitPython which is more beginner friendly and easy to use. Hence users from varied level of experience and domain knowledge will be able to take the BeagleConnectinto use,be it for hobbyist projects or for eneterprise level products.
  
 
==Misc==
 
==Misc==

Revision as of 12:20, 10 April 2021


BeagleBoard/GSoC 2021/Micropython for BeagleConnect Freedom

{{#ev:youtube|Jl3sUq2WwcY||right|BeagleLogic}} About Student: Yadnik Bendale
Mentors: Jason Kridner
Code: [[ https://github.com/micropython/micropython/tree/master/ports/zephyr%7Chttps://github.com/micropython/micropython/tree/master/ports/zephyr]]
Wiki: N/A
GSoC: N/A

Status

This project is currently just a proposal.

Proposal

I have completed all the project requirements listed on the ideas list and have opened the pull request here.

About you

IRC: Yadnik Bendale
Github: Yadnik1
School: Dwarkadas J Sanghvi College Of Engineering
Country: India
Primary language:English,Hindi,Marathi
Typical work hours: 9AM-9PM IST
Previous GSoC participation: I have a very keen interest in working in Embedded Systems and Internet of Things.Doing the Micropython for BeagleConnect Freedom project greatly intrigues and will definitely enable me to make a significant impact to the community by increasing the functionality and robustness of the BeagleConnect Freedom device.This is my first time participating in GSoC.

About your project

Project name: Micropython for BeagleConnect Freedom

Description

Introduction:
BeagleConnect is a revolutionary technology which eliminates low-level software development for IoT and IIoT applications,such as building automation, factory automation, and home automation.What sets it apart is that it eliminates the need of relying on software libraries enabling it to be used for interfacing a greater number of sensors, actuators and indicators for communicating over various networks compared to other conventional solutions.This can be achieved since it is built with fully open source software with submissions to mainline Linux and Zephyr repositories to aide in support and porting.
The BeagleConnect Freedom is based on the TI CC1352 and is the first available BeagleConnect solution which runs the Zephyr RTOS and has mikroBUS ports along with BLE and Sub-GHz radios on it.The BeagleConnect has a few technologies at the core namely IPv6 (via 6LoWPAN),Zephyr support for IEEE 802.15.4 and Greybus from Project Ara.
The goal of this project is to port Micropython and Circuitpython support along with GPIO, I2C, SPI, PWM,UART and ADC drivers support in Micropython for the BeagleConnect solution.After the porting is completed and the drivers have been inculcated,the practicality will be thoroughly tested with the help of MikroElektronika click boards of each respective protocol and documented on my blog.
Project Deliverables:

1)Porting MicroPython
MicroPython is a completely free and open source software that is a lean and efficient implementation of the Python 3 programming language that includes a small subset of the Python standard library and is optimised to run on microcontrollers and in constrained environments.A few of its salient features that will be advantageous for the BeagleConnect include:

  • It provides an interactive prompt (the REPL) to execute commands immediately, along with the ability to run and import scripts from the built-in filesystem. The REPL has history, tab completion, auto-indent and paste mode for a great user experience.
  • Highly configurable due to many compile-time configuration options
  • Code coverage at 98.4% for the core and at 96.3% for the core plus extended modules

Execution:
There is ample of documentation related to porting Micropython to the Zephyr RTOS Running on Beagleconnect. The most comprehensive guide can be found in the MicroPython port to Zephyr RTOS repository.

  • I will start with installing Zephyr SDK, getting Zephyr source code, and setting up development environment followed by configuring the environment, for example by sourcing zephyrproject/zephyr/zephyr-env.sh.
  • I will then clone the MicroPython repository into the home directory and build the Zephyr port for the BeagleConnect Freedom board like this:
 west build -b ~/micropython/ports/zephyr
  • Followed by this is I will flash it to the board and start a gdb debug session using:
 west debug

If I find any difficulty while navigating through I will rely on the Micropython repository and the Micropython forum page.
2)Porting Circuitpython:

CircuitPython is a programming language designed to simplify experimenting and learning to program on low-cost microcontroller boards.It is majorly built for Adafruit devices and has an active community base. CircuitPython is designed with education in mind. It's easy to start learning how to program and the user gets immediate feedback from the board.This will enable even a novice user to take complete advantage of the BeagleConnect Freedom device.A few of its salient features that will be advantageous for the BeagleConnect include:

  • The serial console and REPL allow for live feedback from your code and interactive programming
  • The internal storage for CircuitPython makes it great for data-logging, playing audio clips, and otherwise interacting with files.
  • There is no compiling, no downloading and no uploading needed due to which it runs immediately just after creating a file, editing the code and saving the file.

Execution:
The core code of MicroPython is shared amongst ports including CircuitPython. There is also Documentation released by Adafruit for creating ones own port.

  • The first step would be creating a UF2 Port by Cloning the Adafruit uf2-samdx1 repository followed by creating a new folder in boards/ with the particular board name.I will also refer other board files as examples for how to fill out the board files.
  • The next step will be cloning the Adafruit CircuitPython repository and creating a new folder with the board name.

For reference purposes i will constantly refer the CircuitPython Documentation and the forums for effective flow of the porting process.
I will test various pins and features of the board using some hardware line LEDs, resistors and EEPROM after each individual port.Pull requests will be generated for all the work done to the respective upstream repositories.

3)Writing drivers in MicroPython:
I will be following a general procedure as given below for writing GPIO, I2C, SPI, PWM,UART and ADC drivers for the BeagleConnect Freedom.Once done I will test it with MikroElektronika click boards,2 boards supporting each protocol to validate operation of both simultaneously as well as combined with another board using some other protocol.
Procedure for drivers in Micropython:
The BeagleConnect Freedom is based on the CC1352R Launchpad development kit,which houses the SimpleLink CC1352R wireless MCU.A structured approach for writing drivers would be

  • To first go through the memory map of the micro controller present in its datasheet.
  • After obtaining the range of memory addresses where the peripherals are located,the memory address associated with each peripheral can be obtained.
  • From the memory address the register map can be observed from where we can incur each offset address of a register which is basically a word for the microcontroller to perform a particular action.
    A sample code for the UART protocol can be seen as follows:
From machine import UART 
uart=UART(1,baudrate=9600,bits=8,parity=none,stop=1)
uart.write(b ‘\XAA’)

Here we import the UART class,we initialise an instance and we pass as constructor parameters the settings we need to configure after which we can use simple methods like read and write to get data to and from the device.
A list of constructors and methods for writing each driver can be found on the Micropython official website:
1)Universal asynchronous receiver-transmitter (UART)
2)Inter-integrated circuit(I2C)
3)Serial Peripheral Interface (SPI)
4)Pulse Width Modulation(PWM)
5)Analog to Digital Converter(ADC)
6)General-Purpose Input/Output(GPIO)
The official document by the Micopython is a great resource to refer to in general.
For maximizing micropython execution speed I will take these things into consideration for a highly optimized driver code.

Hardware requirements:
1)BeagleConnect Freedom node and gateway device
2)MikroElektronika click boards 2 each supporting each protocol
UART:

I2C

SPI

PWM

Timeline

Provide a development timeline with a milestone each of the 11 weeks and any pre-work. (A realistic timeline is critical to our selection process.)

Mar 29 Applications open, Students register with GSoC, work on proposal with mentors
Apr 13 Proposal complete, Submitted to https://summerofcode.withgoogle.com
May 17 Proposal accepted or rejected
  • Read and Research more on writing peripheral drivers and thoroughly go through the SimpleLink CC1352R wireless MCU datasheet
  • Order all the necessary hardware components
Jun 07 Pre-work complete, Coding officially begins!
  • All the boards and hardware will be available to me and I will start with flashing the Zephyr RTOS on the BeagleConnect Freedom device.
  • Complete MicroPython port.
  • Test various pins and features using MicroPython and document it on my blog.
Jun 17 Milestone #1
  • Introductory YouTube video
  • Complete CircuitPython port.
  • Test various pins and features using CircuitPython and document it on my blog.
  • Taking notes and feedback from my mentor regarding the progress of the porting, and address any issues if any.
  • By this stage I must have completed adding both CircuitPython and MicroPython support to the BeagleConnect.
June 24 Milestone #2
  • Start writing peripheral driver code from UART.
  • Complete writing UART driver code.
  • Implement and document the working of the MikroElektronika click boards using the UART Peripheral.
June 30 Milestone #3
  • Complete writing I2C driver code.
  • Implement and document the working of the MikroElektronika click boards using the I2C Peripheral.
July 12 18:00 UTC
  • Complete writing SPI driver code.
  • Implement and documentthe working of the MikroElektronika click boards using the SPI Peripheral
  • Milestone #4, Mentors and students can begin submitting Phase 1 evaluations
July 16 18:00 UTC Phase 1 Evaluation deadline
  • Complete writing PWM driver code.
  • Implement and document the working of the MikroElektronika click boards using the PWM Peripheral
July 23 Milestone #5
  • Complete writing ADC driver code.
  • Implement and document the working of the MikroElektronika click boards using the ADC Peripheral
July 30 Milestone #6
  • Complete writing GPIO driver code.
  • Implement and document the working of the MikroElektronika click boards using the GPIO Peripheral
Aug 06 Milestone #7
  • Testing various click boards with supporting same interface as well as different interfaces together.
August 10 Milestone #8
  • Taking feedback from mentors
  • Completing the documentation
  • Completion YouTube video
August 16 - 26 18:00 UTC Final week: Students submit their final work product and their final mentor evaluation
August 23 - 30 18:00 UTC Mentors submit final student evaluations

Experience and approach

I have good understanding of C,C++,Opengl and Python.I have experience working with various Develeopment Boards like a variety of Arduino,STM and Teensy boards and SBC's like Beaglebone Black,Raspberry Pi and BalenFin.
I have been consistently taking part in all the contests on Hackster.io and had also won a prize in the Deep Learning Superhero Challenge there for my work on Making a People Counter using the OPENVINO Toolkit.I have also been a part of the Swadeshi Microprocessor Challenge,where my team has entered the semi-finals for making an FPGA accelerated remote vital stats monitoring device to measure SPO2, ECG and pulse rate using a technology called remote-Plethysmography. The video for the same can be found here.
I have prior experience working under mentors in technical teams of my college. DJS Arya,the team I am a part of designs,manufactures and fabricates a canister size satellite for the Cansat Competetion,where I am responsible for the entire sensor subsystem integration,writing flight software code and data telemetry using the zigbee protocol.
I have thoroughly gone through TheOpenGLbook,Deep Learning for Computer Vision and documentation from the Khronos Group which provided me invaluable clarity towards the project.
Hence,I am confident that I will be able to complete the project in the stipulated time.

Contingency

My belief has always been to ask my mentors only after giving my best towards that respective task and is definitely the way to go in open source.
However in a case where I am out of resources and my mentor isn't around I will divert my focus towards documentation or towards a part of the project that is not correlated to the part I am stuck with.
In such a case few references i would like to refer are:
1)
2)
3)
4)

Benefit

If completed successfully the functionality of the BeagleConnect will be greatly enhanced.It will be complete with the support of MicroPython which is used more of by the mainstream community as well as CircuitPython which is more beginner friendly and easy to use. Hence users from varied level of experience and domain knowledge will be able to take the BeagleConnectinto use,be it for hobbyist projects or for eneterprise level products.

Misc

I have completed the requirements stated in the ideas page,the cross compilation task can be found here and the created the pull request can be found here

Suggestions

Is there anything else we should have asked you?