1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
|
#if 0
Simple Skeleton - Tutorial Four
Demonstration of libindi v0.7 capabilities.
Copyright (C) 2010 Jasem Mutlaq (mutlaqja@ikarustech.com)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#endif
/** \file simpleskeleton.cpp
\brief Construct a basic INDI CCD device that demonstrates ability to define properties from a skeleton file.
\author Jasem Mutlaq
\example simpleskeleton.cpp
A skeleton file is an external XML file with the driver properties already defined. This tutorial illustrates how to create a driver from
a skeleton file and parse/process the properties. The skeleton file name is tutorial_four_sk.xml
\note Please note that if you create your own skeleton file, you must append _sk postfix to your skeleton file name.
*/
#include <memory>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <stdlib.h>
/* Our driver header */
#include "simpleskeleton.h"
/* Our simpleSkeleton auto pointer */
std::auto_ptr<SimpleSkeleton> simpleSkeleton(0);
const int POLLMS = 1000; // Period of update, 1 second.
/**************************************************************************************
** Send client definitions of all properties.
***************************************************************************************/
void ISInit()
{
static int isInit=0;
if (isInit)
return;
if (simpleSkeleton.get() == 0)
{
isInit = 1;
simpleSkeleton.reset(new SimpleSkeleton());
}
}
/**************************************************************************************
**
***************************************************************************************/
void ISGetProperties (const char *dev)
{
ISInit();
simpleSkeleton->ISGetProperties(dev);
}
/**************************************************************************************
**
***************************************************************************************/
void ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
{
ISInit();
simpleSkeleton->ISNewSwitch(dev, name, states, names, n);
}
/**************************************************************************************
**
***************************************************************************************/
void ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
{
ISInit();
simpleSkeleton->ISNewText(dev, name, texts, names, n);
}
/**************************************************************************************
**
***************************************************************************************/
void ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
{
ISInit();
simpleSkeleton->ISNewNumber(dev, name, values, names, n);
}
/**************************************************************************************
**
***************************************************************************************/
void ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
{
ISInit();
simpleSkeleton->ISNewBLOB(dev, name, sizes, blobsizes, blobs, formats, names, n);
}
/**************************************************************************************
**
***************************************************************************************/
void ISSnoopDevice (XMLEle *root)
{
INDI_UNUSED(root);
}
/**************************************************************************************
**
***************************************************************************************/
SimpleSkeleton::SimpleSkeleton()
{
}
/**************************************************************************************
**
***************************************************************************************/
SimpleSkeleton::~SimpleSkeleton()
{
}
/**************************************************************************************
** Initialize all properties & set default values.
**************************************************************************************/
bool SimpleSkeleton::initProperties()
{
DefaultDevice::initProperties();
// This is the default driver skeleton file location
// Convention is: drivername_sk_xml
// Default location is /usr/share/indi
const char *skelFileName = "/usr/share/indi/tutorial_four_sk.xml";
struct stat st;
char *skel = getenv("INDISKEL");
if (skel)
buildSkeleton(skel);
else if (stat(skelFileName,&st) == 0)
buildSkeleton(skelFileName);
else
IDLog("No skeleton file was specified. Set environment variable INDISKEL to the skeleton path and try again.\n");
// Optional: Add aux controls for configuration, debug & simulation that get added in the Options tab
// of the driver.
addAuxControls();
std::vector<INDI::Property *> *pAll = getProperties();
// Let's print a list of all device properties
for (int i=0; i < pAll->size(); i++)
IDLog("Property #%d: %s\n", i, pAll->at(i)->getName());
return true;
}
/**************************************************************************************
** Define Basic properties to clients.
***************************************************************************************/
void SimpleSkeleton::ISGetProperties(const char *dev)
{
static int configLoaded = 0;
// Ask the default driver first to send properties.
INDI::DefaultDevice::ISGetProperties(dev);
// If no configuration is load before, then load it now.
if (configLoaded == 0)
{
loadConfig();
configLoaded = 1;
}
}
/**************************************************************************************
** Process Text properties
***************************************************************************************/
bool SimpleSkeleton::ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
{
// Ignore if not ours
if (strcmp (dev, getDeviceName()))
return false;
return false;
}
/**************************************************************************************
**
***************************************************************************************/
bool SimpleSkeleton::ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
{
// Ignore if not ours
if (strcmp (dev, getDeviceName()))
return false;
INumberVectorProperty *nvp = getNumber(name);
if (!nvp)
return false;
if (isConnected() == false)
{
nvp->s = IPS_ALERT;
IDSetNumber(nvp, "Cannot change property while device is disconnected.");
return false;
}
if (!strcmp(nvp->name, "Number Property"))
{
IUUpdateNumber(nvp, values, names, n);
nvp->s = IPS_OK;
IDSetNumber(nvp, NULL);
return true;
}
return false;
}
/**************************************************************************************
**
***************************************************************************************/
bool SimpleSkeleton::ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
{
int lightState=0;
int lightIndex=0;
// ignore if not ours //
if (strcmp (dev, getDeviceName()))
return false;
if (INDI::DefaultDevice::ISNewSwitch(dev, name, states, names, n) == true)
return true;
ISwitchVectorProperty *svp = getSwitch(name);
ILightVectorProperty *lvp = getLight("Light Property");
if (isConnected() == false)
{
svp->s = IPS_ALERT;
IDSetSwitch(svp, "Cannot change property while device is disconnected.");
return false;
}
if (!svp || !lvp)
return false;
if (!strcmp(svp->name, "Menu"))
{
IUUpdateSwitch(svp, states, names, n);
ISwitch *onSW = IUFindOnSwitch(svp);
lightIndex = IUFindOnSwitchIndex(svp);
if (lightIndex < 0 || lightIndex > lvp->nlp)
return false;
if (onSW)
{
lightState = rand() % 4;
svp->s = IPS_OK;
lvp->s = IPS_OK;
lvp->lp[lightIndex].s = (IPState) lightState;
IDSetSwitch(svp, "Setting to switch %s is successful. Changing corresponding light property to %s.", onSW->name, pstateStr(lvp->lp[lightIndex].s));
IDSetLight(lvp, NULL);
}
return true;
}
return false;
}
bool SimpleSkeleton::ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
{
if (strcmp (dev, getDeviceName()))
return false;
IBLOBVectorProperty *bvp = getBLOB(name);
if (!bvp)
return false;
if (isConnected() == false)
{
bvp->s = IPS_ALERT;
IDSetBLOB(bvp, "Cannot change property while device is disconnected.");
return false;
}
if (!strcmp(bvp->name, "BLOB Test"))
{
IUUpdateBLOB(bvp, sizes, blobsizes, blobs, formats, names, n);
IBLOB *bp = IUFindBLOB(bvp, names[0]);
if (!bp)
return false;
IDLog("Received BLOB with name %s, format %s, and size %d, and bloblen %d\n", bp->name, bp->format, bp->size, bp->bloblen);
char *blobBuffer = new char[bp->bloblen+1];
strncpy(blobBuffer, ((char *) bp->blob), bp->bloblen);
blobBuffer[bp->bloblen] = '\0';
IDLog("BLOB Content:\n##################################\n%s\n##################################\n", blobBuffer);
delete [] blobBuffer;
bp->size=0;
bvp->s = IPS_OK;
IDSetBLOB(bvp, NULL);
}
return true;
}
/**************************************************************************************
**
***************************************************************************************/
bool SimpleSkeleton::Connect()
{
return true;
}
bool SimpleSkeleton::Disconnect()
{
return true;
}
const char * SimpleSkeleton::getDefaultName()
{
return "Simple Skeleton";
}
|