PDA

View Full Version : "hello world" app / sdk???



Phillip Kerman
2004-08-14, 20:03
> I have been looking all over for some sort of a "hello world"
> app and / or sdk of how to write a plugin. I have some good
> ideas for plugins but I need to understand not only how perl
> works (I am a c++ and java developer), but how slim server
> works from an sdk standpoint,
>
> So reports I have read on the net say "well the server is
> open source, so there is your sdk..." What a CROCK! Does
> anyone have any good idea where I can find some detailed
> specs on I/O and such???
>


Yeah, I recall when I asked for the APIs the answer was that it was all in
the comments of the code. That's not the same. I don't want to sound like
I'm griping--I mean, it takes work to write up such documentation. Does
sorceforge not offer some wiki-manner of people adding to and producing
documentation? Just looking for a way to make this easy.

Also, maybe the server is based on some other software that has existing
documentation. Or... what design patterns are used?

Granted, I haven't walked through the code let alone touched Perl... but I
think I can help in a similar manner as Anthony because we're coming in from
the outside on this.

One tiny addition, I don't think it's necessary to document Perl... just the
server itself. I think it's reasonable to expect one has resources to learn
Perl elsewhere.

Thanks,
Phillip

anthony webb
2004-08-14, 20:43
Great points Philip. I hope that someone can/will take the lead and give us
at least a starting point. I am a bright guy and it wouldn't take much more
than a little push. I am positive that I can pick up pearl, main problme I
would have in just diving into the slim code (I've looked at a couple of the
plugins) is that I have not a clue as to what stuff is pearl functions, slim
functions, where things are being called from, what they are referencing,
etc.

I imagine that developer docs would be a priority, ESPECIALLY with the new
display. They have this contest to see who can write the best plugin, yet
give you no tools to get started. How in the world am I going to write a
plugin to really do something cool with the new display without any api or
docs?

I am not complaining, or bashing on slim, and obviously there ARE people out
there who have gotten familiar enough with the code to get out and do some
stuff. But the number of plugins out there is evidence that the developers
are hindered by a lack of docs. I expected to find TONS of plugins and cool
stuff, but I haven't found many plugins at all.

I'm not slinging mud at all and I will offer to be part of the solution and
try to start some docs if someone can just get us going to where we can at
least have a start...

Thanks,
Anthony

----- Original Message -----
From: "Phillip Kerman" <lists (AT) phillipkerman (DOT) com>
To: "'Slim Devices Discussion'" <discuss (AT) lists (DOT) slimdevices.com>
Sent: Saturday, August 14, 2004 9:03 PM
Subject: [slim] "hello world" app / sdk???


> > I have been looking all over for some sort of a "hello world"
> > app and / or sdk of how to write a plugin. I have some good
> > ideas for plugins but I need to understand not only how perl
> > works (I am a c++ and java developer), but how slim server
> > works from an sdk standpoint,
> >
> > So reports I have read on the net say "well the server is
> > open source, so there is your sdk..." What a CROCK! Does
> > anyone have any good idea where I can find some detailed
> > specs on I/O and such???
> >
>
>
> Yeah, I recall when I asked for the APIs the answer was that it was all in
> the comments of the code. That's not the same. I don't want to sound
like
> I'm griping--I mean, it takes work to write up such documentation. Does
> sorceforge not offer some wiki-manner of people adding to and producing
> documentation? Just looking for a way to make this easy.
>
> Also, maybe the server is based on some other software that has existing
> documentation. Or... what design patterns are used?
>
> Granted, I haven't walked through the code let alone touched Perl... but I
> think I can help in a similar manner as Anthony because we're coming in
from
> the outside on this.
>
> One tiny addition, I don't think it's necessary to document Perl... just
the
> server itself. I think it's reasonable to expect one has resources to
learn
> Perl elsewhere.
>
> Thanks,
> Phillip
>
>

kdf
2004-08-16, 14:30
Quoting anthony webb <ievolve (AT) hotmail (DOT) com>:


> I am not complaining, or bashing on slim, and obviously there ARE people out
> there who have gotten familiar enough with the code to get out and do some
> stuff. But the number of plugins out there is evidence that the developers
> are hindered by a lack of docs. I expected to find TONS of plugins and cool
> stuff, but I haven't found many plugins at all.
>
> I'm not slinging mud at all and I will offer to be part of the solution and
> try to start some docs if someone can just get us going to where we can at
> least have a start...

All the docs available are part of the Help section in the slimserver under
Technical Information. There is information there (albeit often slightly
behind current bleeding edge) covering artwork handling, web interface
parameters for skins, the command-line interface, accessing the XML skin and
XPL interface, Plugins, custom button mapping, generic Input Modes, Fonts and
the hardware communication protocol.

If you have questions, the developers list is a great way to get specific
questions resolved. Any ommissions you feel should be added to the docs:
Updates are always welcome.

-kdf