About the Development
Development Guide
This page aims to provide AddOn developers with a learning path guide for AddOn development.
Getting Resources
Developing add-ons requires a series of resources. Here, essential resources for JAKA AddOn development are listed and will be continuously updated to facilitate developers in obtaining complete and up-to-date content.
Links to these resources will be provided again in the subsequent chapters where they are needed. This section serves as a reminder and summary.
- JAKA Virtual Machine
- AddOn Kit Packageabandoned[1]
- Demos in AddOn development templates and tutorials visit the repositoryunder development
Note
The kit package will include the latest versions of matching Apps and controllers.
Before You Start
The target reader of this tutorial should have received basic robot operation training and owned a certain level of basic development skills. They should also be familiar with JAKA's script language JKS.
In addition, knowledge of programming languages such as node-red, JavaScript, HTML5, CSS3, etc., will be even more helpful for users to develop and use AddOn effectively.
Overview of AddOn Development Tutorials
Beginner Tutorials
If you're unsure about where to start, begin by learning the following tutorials:
- Quickly understand the complete process of AddOn development in the Quick Start👈 section.
- Set up the AddOn development environment by following the steps in Setting Up AddOn Development Environment👈.
- Learn the basic process and rules of developing custom command AddOn by creating "JAKA_Command👈".
- Learn the basic process and rules of developing custom service AddOn by creating "JAKA_Serve👈".
- Learn the basic process and rules of developing custom interface AddOn by creating "JAKA_web👈".
Advanced Tutorials - Specific Cases
The purpose of beginner tutorials is to provide developers with a clear understanding of the process, so they only cover basic functionalities, lacking practical application scenarios.
Advanced tutorials are combined with specific scenario cases, allowing developers to learn about functionalities not mentioned or briefly mentioned in the beginner tutorial.
After understanding the basic development process of AddOn, you can choose a specific application case for learning. These cases include at least two out of three functionalities: custom instruction, custom service, and custom interface, collectively referred to as composite AddOn:
More cases are on the way...
Related Reference Documents
- JAKA Script👈: Scripting language used to implement custom command.
- Configuration Files👈: Field descriptions for AddOn profiles.
- JAKA App APIs👈: Provides JavaScript functions for interaction between the front end and JAKA App.
- node-red: Development platform and backend service for AddOn.
- JavaScript: Used for scripting and logic in node-red.
- Front-end Technologies: Requires a certain level of front-end technology for developing custom page plugins.
Controller versions after v1.7.1.28 come with the AddOn Kit package, which does not need to be downloaded and installed. ↩︎