Code Monkey home page Code Monkey logo

sjsu-dev2's Introduction

SJSU-Dev2

Build Status Documentation Status Coverage Status Codacy Badge GitHub stars GitHub forks GitHub issues Slack Chat

Cross platform firmware framework written by students, alumni, and faculty of San Jose State University. Designed for the original purpose of helping students develop firmware for the SJTwo board.

Operating System Supported

         

Built for Ubuntu, Mac OSX, and Windows 10 WSL.

Documentation and Installation Guide

See documentation for a full guide.

Using a Prebuilt Virtual Machine

One of the easist ways to get started with SJSU-Dev2 is to use a VM with all of the software installed.

Steps to install virtual box and the virtual machine are listed below:

  1. Install virtualbox for your computer from this link: https://www.virtualbox.org/wiki/Downloads
  2. Download the usb 2.0/3.0 extensions from here, allows you to connect usb devices from your host machine into the virtual machine: https://download.virtualbox.org/virtualbox/6.0.4/Oracle_VM_VirtualBox_Extension_Pack-6.0.4.vbox-extpack
  3. Open the "Oracle_VM_VirtualBox_Extension_Pack-6.0.4.vbox-extpack" and install it into VirtualBox when prompted.
  4. Download the prebuilt virtual machine: Ubuntu SJSU-Dev.ova
  5. Open "Ubuntu SJSU-Dev.ova" and import into VirtualBox.
  6. Done!

Using the Virtual Machine

  1. Open the "Ubuntu SJSU-Dev" Virtual Machine on the left hand side.
  2. Login by entering the password "osboxes.org"
  3. To program your board, you will need to connect it to your host machine and bring it into the virtual machine by using the top menu: Devices > USB > CP2102n...
  4. At this point you can run commands like make application and make flash from within the SJSU-Dev2 folder which is located /home/osboxes/SJSU-Dev2

Quick Start Install on host machine

Setting up the environment

If you are using Windows, follow these steps to install WSL and make sure to install the Ubuntu as the linux distro. Once you have installed WSL, all instructions below for Linux should work for Windows.

To download and setup the environment, simply copy and paste this into a terminal:

git clone https://github.com/kammce/SJSU-Dev2.git && cd SJSU-Dev2 && ./setup

If you find that git is not installed on your machine follow these steps to install GIT.

Building a Project

The starter HelloWorld project can be found in the firmware/ folder along with the the firmware/examples folder which is full of examples you can run on your board. To build HelloWorld:

cd firmware/HelloWorld
make application

Programming a board

From within a project, run make flash.

Viewing Serial Output

The preferred method for communicating with a serial device is via Google Chrome, using the online serial terminal tool, Telemetry. You can also open this up on your browser using the make telemetry command in a project directory.

Burning the Bootloader (NOT AVAILABLE YET)

The Hyperload bootloader is used to rapidly quickly program the device. SJTwo and SJOne boards should both have the bootloaders pre-installed on them, but in case it is not installed, run the following from the root of the SJSU-Dev2 directory:

cd firmware/Hyperload
make burn

make burn will build the application using make bootloader and if that finishes successfully, then it will burn the bootloader to the first 64kB of the board, allowing you to use make flash later on.

Contrib

  • Khalil Estell: Creator of the SJSU-Dev2.
  • Since this repository borrows heavily form SJSU-Dev repo, the people in that contrib list are also contributors to this repository.

Special Credits

  • Mikko Bayabo: Windows surface destructive testing
  • WSL testing: Sameer Azer, Aaron Moffit, Ryan Lucus, Onyema Ude

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.