ChipChop Support Forum
Log in
Log out
Join the forum
My Details
REPLIES: 4
VIEWS: 229
BACK
REPLY TO THIS POST
viva amigo
18 Jan 2024
API clarification?
Hi guys, I think this is a question for Gizmo directly but maybe someone else knows.

I'll try to explain my slight confusion. I've been using ChipChop for 6/7 months now and it works perfectly for my micro controller automation projects so now I am thinking of going one level up and making something for a desktop machine (office automation)

Now, I don't know if this is a mistake but I've been looking through the docs/api pages and what I don't get is the API documentation. Basically after you pass the bits about uuid, server uri etc the rest bears no resemblance to the API "commands" you use in arduino library? I mean zero, zilch, just some stuff about hashing & sockets and nothing else.

When you look at the "all_functions.ino" in the library examples, there is a loot more commands so I can't figure out what am I supposed to use? Is the documentation out of date and what is there is some old stuff and has actually anyone used anything else than Arduino?

Thank you in advance



Arduino Geek
18 Jan 2024

Good question

In theory ChipChop has 3 APIs 😱🙈

1. The Dev Console - technically you could call it a visual API that handles f* knows what mumojumbo settings of the cloud engine for your devices. As far as I know there is no other public interface and I think that's the biggest one.

2. The Library API - that's all the different "commands" you are mentioning, this "API" is actually just an interface to the next one (point 3) and that's what is confusing you
These commands are not listed anywhere on the website, you have to look directly in the "all_functions.ino".
I remember that the library page (https://chipchop.io/api_docs/chipchop-arduino-library) used to say that it's all self explanatory and to look inside the code.

3. Public API (device connections) - that's what you have found in the Docs & API pages. It's very small and that's all you need to write your own "library" to connect to chipchop. The point 2 and it's "commands" is just a bunch of shortcuts to make your life easier to use this API.
You can use whatever language you want as long as you can use websockets and follow the guidelines of this api you are good to go. You can probably just look at the c++ library code as a reference (if you understand it) and just build your own.

what language are you thinking of using?



Son1cb00m
18 Jan 2024

you sure it's ok to do that if it's for commercial use
viva amigo
18 Jan 2024

@Son1cb00m -> I wouldn't call what I'm trying to do a commercial application. Yes it's for my business but I am a one man corporation - CEO & janitor all in one with high tech factory in my shed! I'm not going to sell something with it, I just want to use this nice piece of tech to make my life slightly easier.

I mean, if any problems/objections let me know, ok?

@Arduino Geek -> thanks for the info, I think I understand what you are saying. The "Arduino Library" is just a convenience, right? So, the api in the docs is what you need to talk "directly" with your chipchop account and that's it!?

I think I'm still going to "dissect" the library 💪

I was thinking of trying Electron to make a little app with JS that calls through the shell some apple automator scripts for automation on my desktop.

thnx
foo-bar
18 Jan 2024

@Viva Amigo Don't worry bro, you are good with what you want to do. I've made a thing that was directly for business and G personally helped me with it, it's just being reasonable and not taking the piss.

If you are going to use Electron that's Node inside, afaik there's already a beta lib for Node.js. not sure why it's not published but I would send G an email and ask