API Reference Document (For Sidebar Gadget)

Got a program that plays well with SABnzbd? Share it here!

API Reference Document (For Sidebar Gadget)

Postby pieteckhart » April 30th, 2008, 10:43 am

Hi all!

Today i started coding a Windows Vista Sidebar Gadget.
it allready looks nice and displays some info.

but im wondering if there is anything like a reference document for the API. I cant find it anywhere on the site but maybe i was looking for it in the wrong place.

Attached is a screenshot of the gadget :D.

the idea is you can pause and resume the queue by  clicking on the top left icon.
the progress bars are working fine and the kb/s allso works correctly.
Im planning on adding some simple nzb upload form allso so you dont even have to use the webinterface anymore (not that i dont love the nice webinterface)

I will link the gadget here when its done. but first i could really use some sort of Documentation of API so i can see what modes i can get json/xml strings from.

Thanks,

Piet
Last edited by pieteckhart on May 3rd, 2008, 5:44 pm, edited 1 time in total.
SABnzbd+ Windows 7 Gadget
Manage your downloads from your desktop.
Download: http://eckhart.hopto.org/sabgadget/sabgadget2.gadget
Site: http://eckhart.hopto.org/sabgadget/
User avatar
pieteckhart
Release Testers
Release Testers
 
Posts: 139
Joined: April 30th, 2008, 10:34 am
Location: Netherlands

Re: API Reference Document

Postby KaiUno » April 30th, 2008, 11:33 am

Great idea! I'm willing to be your testslave on this one.
User avatar
KaiUno
Newbie
Newbie
 
Posts: 45
Joined: January 23rd, 2008, 7:56 am

Re: API Reference Document (For Sidebar Gadget)

Postby inpheaux » April 30th, 2008, 12:26 pm

pieteckhart wrote:but im wondering if there is anything like a reference document for the API. I cant find it anywhere on the site but maybe i was looking for it in the wrong place.

Right here in the new documentation. (We'll update the link on the index when 0.4.0 goes final)
User avatar
inpheaux
Administrator
Administrator
 
Posts: 697
Joined: January 16th, 2008, 10:14 pm

Re: API Reference Document (For Sidebar Gadget)

Postby kizer8 » April 30th, 2008, 3:59 pm

I would definitely be interested also.

Thanks,
Kizer
kizer8
Newbie
Newbie
 
Posts: 38
Joined: April 21st, 2008, 8:00 am

Re: API Reference Document (For Sidebar Gadget)

Postby neilt0 » May 1st, 2008, 4:53 am

Gimmee! I'm also happy to help test it out.

Suggestions:

* Include authentication
* Include access to remote machines as well as localhost
- Possibly give the option of monitoring multiple machines?
User avatar
neilt0
Full Member
Full Member
 
Posts: 120
Joined: January 22nd, 2008, 5:16 am

Re: API Reference Document (For Sidebar Gadget)

Postby KaiUno » May 3rd, 2008, 6:01 am

Talk to us Piet. How's it progressing? My µTorrent sidebar gadget is getting lonely!
User avatar
KaiUno
Newbie
Newbie
 
Posts: 45
Joined: January 23rd, 2008, 7:56 am

Re: API Reference Document (For Sidebar Gadget)

Postby pieteckhart » May 3rd, 2008, 12:42 pm

inpheaux:
thanks for the link, i needed that :D

neilt0:
it will Include authentication for sure, and i allready tested it with local and external machines.
i think you could add multiple gadgets to the sidebar and let them connect to their own source. (i dont know for sure, time will tell)

Talk to us Piet. How's it progressing? My µTorrent sidebar gadget is getting lonely!

well its going kinda slow. i ran in to some problems i cant figure out (yet). it seems to have something to do with the cache of Internet Explorer. normaly i add someting like &random=235235235 to the URL of the Request but sabnzbd will not accept this and replies with "not implemented" or something like that.

but i dont think its a show stopper ;)

oh and my uTorrent allso felt lonley thats why i started coding a little brother for him ;)

ill keep you posted. any suggestions are welcome. maybe someone has a solution for my problem.

Thanks
SABnzbd+ Windows 7 Gadget
Manage your downloads from your desktop.
Download: http://eckhart.hopto.org/sabgadget/sabgadget2.gadget
Site: http://eckhart.hopto.org/sabgadget/
User avatar
pieteckhart
Release Testers
Release Testers
 
Posts: 139
Joined: April 30th, 2008, 10:34 am
Location: Netherlands

Re: API Reference Document (For Sidebar Gadget)

Postby KaiUno » May 3rd, 2008, 12:49 pm

Here's to hoping you figure it out soon! (Too bad I can't help you in the programming department. I'm just a regular leecher.)
User avatar
KaiUno
Newbie
Newbie
 
Posts: 45
Joined: January 23rd, 2008, 7:56 am

Re: API Reference Document (For Sidebar Gadget)

Postby pieteckhart » May 3rd, 2008, 5:43 pm

http://www.sab.websijt.net/sab.gadget

who wants a treat? ;)

tell me if this works. it still is a little buggy but hell didnt want to keep you waiting :P

it will try to connect to localhost:8080 with (no user/pass). But you can change it in the settings window.

Let me know if it works!
SABnzbd+ Windows 7 Gadget
Manage your downloads from your desktop.
Download: http://eckhart.hopto.org/sabgadget/sabgadget2.gadget
Site: http://eckhart.hopto.org/sabgadget/
User avatar
pieteckhart
Release Testers
Release Testers
 
Posts: 139
Joined: April 30th, 2008, 10:34 am
Location: Netherlands

Re: API Reference Document (For Sidebar Gadget)

Postby KaiUno » May 3rd, 2008, 6:30 pm

Like a charm!

It's a little less wide than my other gadgets and the progress bar seems to just fill up rather quickly once a download starts, but that's no problem for me. Being able to keep an eye on the download speed and the pause button is all I need. The rest is pure gravy!

What are you planning to do with the arrow at the bottom? Don't seem to be doing much at all, at the moment.

Vista64 by the way, should you be interested in that.

Image

Lovely! Keep me apprised of further developments :p
User avatar
KaiUno
Newbie
Newbie
 
Posts: 45
Joined: January 23rd, 2008, 7:56 am

Re: API Reference Document (For Sidebar Gadget)

Postby neilt0 » May 4th, 2008, 6:31 am

Yes, very nice.

Some notes:

* Progress bars don't match web interface, as mentioned above, too full.
* Only 192.168.x.x IP address worked for me, not machine name or localhost.
User avatar
neilt0
Full Member
Full Member
 
Posts: 120
Joined: January 22nd, 2008, 5:16 am

Re: API Reference Document (For Sidebar Gadget)

Postby KaiUno » May 4th, 2008, 6:45 am

Weird... I can use the machine name without a problem here.
User avatar
KaiUno
Newbie
Newbie
 
Posts: 45
Joined: January 23rd, 2008, 7:56 am

Re: API Reference Document (For Sidebar Gadget)

Postby pieteckhart » May 4th, 2008, 8:43 am

What are you planning to do with the arrow at the bottom? Don't seem to be doing much at all, at the moment.


If the Queue gets to big this icons are for flipping pages.
i see the gadget is a bit to wide. i will fix this. and ill look in to the progress bar. i probeblymade an error in the calculation of the percent (me and Math dont mix  ;))

ill look in to the host name/computername/ipaddress/
i maneged to get it to work with:
localhost
127.0.0.1
computername

if it doenst work please try to ping the host name first and if you get a reply copy the IP address and try with that to make sure that nothing else is interupting
SABnzbd+ Windows 7 Gadget
Manage your downloads from your desktop.
Download: http://eckhart.hopto.org/sabgadget/sabgadget2.gadget
Site: http://eckhart.hopto.org/sabgadget/
User avatar
pieteckhart
Release Testers
Release Testers
 
Posts: 139
Joined: April 30th, 2008, 10:34 am
Location: Netherlands

Re: API Reference Document (For Sidebar Gadget)

Postby neilt0 » May 4th, 2008, 10:28 am

pieteckhart wrote:ill look in to the host name/computername/ipaddress/
i maneged to get it to work with:
localhost
127.0.0.1
computername

if it doenst work please try to ping the host name first and if you get a reply copy the IP address and try with that to make sure that nothing else is interupting



Pinged. I get what looks like IPv6 addreses back. Maybe that's the problem.
User avatar
neilt0
Full Member
Full Member
 
Posts: 120
Joined: January 22nd, 2008, 5:16 am

Re: API Reference Document (For Sidebar Gadget)

Postby pieteckhart » May 4th, 2008, 11:22 am

did you ping your own computer? or another computer in the network.
does it show up the list if you type 'net view' in a console?
or with 'nslookup myname'?

can you connect to network shares on that computer (\\computername) ?

it can be a bug in the gadget, im having some problems myself from time to time.

Thanks for testing.

btw there is an updated version with some tuned settings :)
SABnzbd+ Windows 7 Gadget
Manage your downloads from your desktop.
Download: http://eckhart.hopto.org/sabgadget/sabgadget2.gadget
Site: http://eckhart.hopto.org/sabgadget/
User avatar
pieteckhart
Release Testers
Release Testers
 
Posts: 139
Joined: April 30th, 2008, 10:34 am
Location: Netherlands

Next

Return to Third-party Addons