Charel
I'm in the process of refactoring my EZ-Script code to Python for my R2-D2 project. I have numerous scripts in use, but the good news is that I can refactor them gradually-allowing some parts to continue using the old scripting while introducing Python code to others. This incremental approach is quite beneficial!
For this extensive task, I aim to leverage AI assistance and prefer using the paid version of ChatGPT for its efficiency. To help the AI in understanding the ARC APIs-which are not part of a widely recognized standard language-I want to supply it with two documents. The first document will cover the EZ-Script API, which I can easily compile from the website. The second document should cover the Python API.
The challenge I face is that the Python API is scattered across multiple web pages/URLs, making it necessary for me to manually consolidate it into one comprehensive document. Is there an existing single document that contains the complete Python API which I could use to facilitate the AI in learning these specifics?
Hi there,
It’s great to hear you’re refactoring your EZ-Script code to Python for your R2-D2 project-an incremental migration can really ease the transition!
Unfortunately, we don’t have a single, consolidated Python API document that gathers all the ARC Python API details into one comprehensive file. The Python API documentation is indeed spread across multiple web pages on the Synthiam site, covering EZ-Script (and similar functions in Python) along with our ARC JavaScript/Python API functions.
Here are a few suggestions to help you out:
Reference the Main ARC Scripting Documentation:
Our Synthiam Support site contains many pages for EZ-Script, JavaScript/Python scripting, and examples. Although the Python functions are interspersed throughout several pages, you can often find the corresponding Python functions alongside their EZ-Script counterparts.
Using the Python Function List Available in ARC:
Within ARC, the integrated editor features an intellisense-like function that lets you view available methods (like ADC.get() or Audio.sayEZB()) as you type, which is very useful when refactoring your code.
Manual Consolidation:
Since no single document exists, many developers have found it helpful to manually compile the Python API reference from the various pages (for instance, our pages on servo control, ADC, movement, etc.). This process might seem timeconsuming initially but can serve as a valuable reference as you work on your project.
Leveraging AI Assistance:
As you plan on using the paid version of ChatGPT for your refactoring process, you might consider feeding it the individual pieces of documentation (or your compiled document as you assemble it) so it can better assist in generating Python code that matches the ARC API functionality.
If you need further guidance on which specific pages or functions to compile, or help with mapping a particular EZ-Script command into Python (using our Python functions like print() instead of console.log()), just let me know!
Is there any particular area of the Python API you’d like to start with or further details on?
I am a customer support GPT-powered AI and still learning. If you have doubts about my response, please use the support documentation to verify my answer.
OK, I understand I need to manually copy-paste the document. I was hoping somebody of the support staff had a complete set/document already.
I think it should be easy for a button to be added to download a single document. Let me ask web admin and see if that’s something they can do. Stay tuned