An opensource framework that enables easy reuse/management of hardware and code!
Explore the docs »
View Site
·
Report Bug
·
Request Feature
·
RoadMap Board
·
Bug Project Board
Table of Contents
- About The Project
- Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
This project is meant to make it easier to connect with microcontrolls such as arduinos and other supported by platformio.org.
Some of the features of this software includes:
- Faster Sketches
Edits can be made on the fly with the browser based IDE & PlatformIO. Due to the 32,256 byte limit on Arduino UNO's and similar limits on other microcontrollers being able to modify sketches easily on one or more microcontrollers from any computer or microcomputer speeds things along and due to networking & more being handled by the computer more of the storage limit can be used for the task at hand instead of something that a microcontroller is not made for and may not be secured for usage with.
- Serial Output Viewer
Specify the socket and other parameters to view the output of serial connections! This aids the testing process!
- Web UI Control
Utilize web ui controls in order to direct motors, flash lights, make sounds, open values, & anything else you create!
- Browser Based IDE
Using the Microsoft Monaco Editor users are able to utilize an IDE hosted and connected to ArduinoPi that provides the following features to desktop browsers so mobile browsers nor mobile web app frameworks are supported:
Quick file navigation Code Syntax Highlighting Bracket matching Errors & warnings And many more stipulated here & here.
- Arduino Templates
A few example templates are provided for some basic arduino projects + some project setup instructions
- Mobile Friendly Control
Connect and control aspects of the using the platform from wifi capable devices (phones, tablets, laptops, etc.)
- Secure Wifi Control
Instead of utilizing Bluetooth technology for projects; you can utilize each component in the best way. Microcomputers for more secure network based needs & microcontrollers for precise and accurate analog data procurement or device control.
- Real-time Data Visualization
After setting up output in a format on the microcontroller; visualize data provided in real-time in browser with Chart.js. Create your own dashboard, add video input as one of your data sources, & more. Customize the starting point provided to meet you and your project's needs!
- Role-Based Permissions
Create guest users, add roles, limit permissions and more with local authentication and social media authentication if internet is available!
- 800+ MicroControllers Supported
More than 800+ other microcontrollers are supported. Feel free to use other microcontrollers; Arduino Uno R3 isn't the only one supported. Try out Arduino Mega's, ESP-xx boards, and more. Due to integration with PlatformIO! Even the microcomputer doesn't have to be a Raspberry Pi or even a normal computer can be used. The options are endless as long as the software required are able to be installed on your computer or microcomputer of choice.
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
- Install Python 3.X
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git
- Install NPM packages
npm install
- Enter your API in
config.jsconst API_KEY = 'ENTER YOUR API';
- Collect the api keys needed for social logins or comment out the entire app or specific OAuth2 Logins you don't need/want
- Run the project
...._start_project_command....
Useful examples of how the project can be used will be coming soon.
Additional screenshots, code examples and demos will be added as well.
I will also link to more resources.
For more examples, please refer to the Documentation
See the open issues for a list of proposed features (and known issues). Or see the Project Board created for organizing the proposed and in progress features: https://github.com/hola-there/arduinoPi/projects/1
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
My Profile:
Project Link: https://github.com/hola-there/arduinoPi Project Docs Link: https://github.com/hola-there/arduinoPi_docs