Robert Woodard > Astro-SkyX-0.07 > Astro::SkyX

Download:
Astro-SkyX-0.07.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.07   Source  

NAME ^

Astro::SkyX - Perl extension for communications with The SkyX Scripting Engine Version 10.2.0 (Build 6519 and later). This module converts perl object oriented function calls to java script objects supported by The SkyX.

SYNOPSIS ^

  use Astro::SkyX;
  my $obj = Astro::SkyX->new();
  #connect to SkyX program:
  $Skysock = $obj->connect('localhost','3040');
  #Connect to Telescope, unpark and find home:
  $obj->sky6RASCOMTele->Connect();
  $obj->Wait(60); # Wait 60 seconds before continuing.
  $obj->sky6RASCOMTele->Unpark();
  print "Finding Home...\n";
  $obj->sky6RASCOMTele->FindHome();
  print "Home.\n";

DESCRIPTION ^

  The SkyX perl module allows a programmer to interact with the
SkyX scripting engine. Syntax is very close to the Java script
syntax documented in the Software Bisque Script TheSkyX Documentation.

Example:

  /* Java Script */
  sky6RASCOMTele.Connect();

  becomes

  $obj->sky6RASCOMTele->Connect();

  The return value is the output from the Java Script engine in The SkyX.

  Reading properties is similiar:

  $obj->sky6RASCOMTele->GetAzAlt();
  print "Alt is " . $obj->sky6RASCOMTele->dAlt . "\n";;
  print "Az is " . $obj->sky6RASCOMTele->dAz . "\n";;

  Setting property values are a little different than the java script method. Instead of:

  ImageLink.scale = .84;

  use:

  $obj->ImageLink->scale(.84); 

  That simple...

EXPORT

None by default.

SEE ALSO ^

 There is class specific documentation for any odd things that had to
be kludged. perldoc Astro::SkyX::Classname to see it.

AUTHOR ^

Robert Woodard, <kayak.man@gmail.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2013 by Robert Woodard

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.12.3 or, at your option, any later version of Perl 5 you may have available.

There are restrictions on commercial use of the SkyX scripting engine. Please see the Software Bisque End User License Agreement prior to using this module in a commercial setting.

syntax highlighting: