spooky2 API?

[beejones]

Hi,
Very interesting project. Where did you find the spooky2 API documents?
Thanks

[pgaultier]

Well there is no documentation at all, I think @calum74 found everything by doing some reverse engineering.

I did some one my side and I found some stuff, but I'm pretty sure is knowledge is really better.

here is what I found for generatorX Pro:

Protocol is pure serial, you can communicate with the device using any serial tool.

-> data sent to device
<- data received from device

1. Handshake

-> :r90=564789132,
<- :r90=736617548,926583147.
-> :w92=819377473.
<- :ok

:r90=<num1>,
:r90=<num2>,<num3>.
:w92=<num4>.
:ok or :err

anything can be sent as but seems to be computed from ,,
if is correct response is :ok otherwise :err

2. Get generator information

-> :r02=0,
<- :r02=200.
-> :n00=$
<- :Rev201
-> :w14=0,
<- :ok

:r02=0 asks for something like revision number or the number of channels
:r02=200. answer 200 could mean revision 200 or 2 channels

:n00=$ asks for a string
:Rev201 answer is revision 201 is it firmware or hardware information

3. Starting app

-> :n00=Port 4 - Stopped
<- :ok
-> :w13=0,
<- :ok
-> :w28=0,
<- :ok
-> :w29=0,
<- :ok
-> :w24=00,
<- :ok
-> :w12=0,,
<- :ok
-> :w12=,0,
<- :ok
-> :w32=120,
<- :ok
-> :w40=0,
<- :ok
-> :w33=120,
<- :ok
-> :w40=0,
<- :ok

according of what I found in @calum74 code and what I understand :

:n00=Port 4 - Stopped write "Port 4 - Stopped" on screen
:w13=0, unknown
:w28=0, set offset 1 to 0
:w29=0, set offset 2 to 0
:w24=00, unknown
:w12=0,, unknown disable/stop channel 1 ?
:w12=,0, unknown disable/stop channel 2 ?
:w32=120, set phase 1 to 120
:w40=0, unknown commit changes ?
:w33=120, set phase 2 to 120
:w40=0, unknown commit changes ?

4. Select generator

-> :w13=0,
<- :ok
-> :w20=12,
<- :ok
-> :w14=1,
<- :ok
-> :w12=0,,
<- :ok
->:w12=,0,
<- :ok
-> :w21=25,
<- :ok

according of what I found in @calum74 code and what I understand :

:w13=0, unknown
:w20=12, unknown
:w14=1, unknown
:w12=0,, unknown
:w12=,0, unknown
:w21=25, unknown

5. Set up device

-> :w17=0,0,
<- :ok
-> :w24=0,
<- :ok
-> :w25=0,
<- :ok
-> :w15=1,1,
<- :ok
-> :w24=00,
<- :ok
-> :w32=120,
<- :ok
-> :w33=120,
<- :ok
-> :w13=0,
<- :ok
-> :w20=20,
<- :ok
-> :w28=0,
<- :ok
-> :w29=0,
<- :ok
-> :w24=00,
<- :ok
-> :w32=120,
<- :ok
-> :w40=0,
<- :ok
-> :w21=25,
<- :ok
-> :w33=120,
<- :ok
-> :w40=0,
<- :ok

according of what I found in @calum74 code and what I understand :

:w17=0,0, unknown
:w24=0, set frequency 1 to 0
:w25=0, set frequency 2 to 0
:w15=1,1, unknown
:w24=00, unknown
:w32=120, set phase 1 to 120
:w33=120, set phase 2 to 120
:w13=0, unknown
:w20=20, unknown but could be voltage ? 20V?
:w28=0, set offset 1 to 0
:w29=0, set offset 2 to 0
:w24=00, unknown
:w32=120, set phase 1 to 120
:w40=0, unknown
:w21=25, unknown
:w33=120, set phase 2 to 120
:w40=0, unknown

7. List programs in memory

-> :n01=?
<- :n01=1. Liver Function

...

-> :n30=?
<- :n30=

according of what I found in @calum74 code and what I understand :

:n01=? request name of program in slot 1
:n01=1. Liver Function program in slot 1 is "1. Liver Function"

8. Clear memory

-> :n30=
-> :n00=Port 4 - Erasing
<- :ok
-> :w96=12321,
<- :ok
-> :n00=Port 4 - Stopped
:ok

according of what I found in @calum74 code and what I understand :

:n30= unknown
:n00=Port 4 - Erasing write "Port 4 - Erasing" on screen
:w96=12321, erase data stored in memory
:n00=Port 4 - Stopped write "Port 4 - Stopped" on screen