summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Van Doorn <vandoorn.nick@gmail.com>2017-11-10 08:17:24 -0800
committerNick Van Doorn <vandoorn.nick@gmail.com>2017-11-10 08:17:24 -0800
commitc199df19df6af15ea43e6e59e9212e11436753c8 (patch)
treef2048d65d760184971c82ead28e98371ad72c1cf
parentc38dc2555b4aa345df14a40ecd35112d91fc75c9 (diff)
Update readme for new prototypes
-rw-r--r--README.md60
1 files changed, 31 insertions, 29 deletions
diff --git a/README.md b/README.md
index e9de3cd..6bea0c9 100644
--- a/README.md
+++ b/README.md
@@ -11,35 +11,37 @@ The Legato serial API [`le_tty`](http://legato.io/legato-docs/latest/le__tty_8h.
## API
```c
void delay (unsigned int msecs);
-int openCameraFd ();
-void sendCommand (Camera *cam, uint8_t cmd, uint8_t args[]);
-bool runCommand (Camera *cam, uint8_t cmd, uint8_t args[], int respLen);
-uint8_t readResponse (Camera *cam, int nBytes, unsigned int timeout);
-bool verifyResponse (Camera *cam, uint8_t cmd);
-bool cameraFrameBuffCtrl (Camera *cam, uint8_t cmd);
-bool takePicture (Camera *cam);
-bool reset (Camera *cam);
-bool TVon (Camera *cam);
-bool TVOff (Camera *cam);
-uint8_t *readPicture (Camera *cam, uint8_t n);
-bool resumeVideo (Camera *cam);
-uint32_t frameLength (Camera *cam);
-char *getVersion (Camera *cam);
-uint8_t available (Camera *cam);
-uint8_t getDownsize (Camera *cam);
-bool setDownsize(Camera *cam, uint8_t newSize);
-uint8_t getImageSize (Camera *cam);
-bool setImageSize (Camera *cam, uint8_t x);
-bool getMotionDetect (Camera *cam);
-uint8_t getMotionStatus(Camera *cam, uint8_t x);
-bool motionDetected (Camera *cam);
-bool setMotionDetect (Camera *cam, bool flag);
-bool setMotionStatus (Camera *cam, uint8_t x, uint8_t d1, uint8_t d2);
-uint8_t getCompression (Camera *cam);
-bool setCompression(Camera *cam, uint8_t c);
-bool getPTZ(Camera *cam, uint16_t *w, uint16_t *h, uint16_t *wz, uint16_t *hz, uint16_t *pan, uint16_t *tilt);
-bool setPTZ(Camera *cam, uint16_t wz, uint16_t hz, uint16_t pan, uint16_t tilt);
-bool snapshotToFile (Camera *cam, char *path, uint8_t imgSize);
+LE_SHARED int openCameraFd ();
+LE_SHARED void sendCommand (Camera *cam, uint8_t cmd, uint8_t args[]);
+LE_SHARED bool runCommand (Camera *cam, uint8_t cmd, uint8_t args[], int respLen, bool flushFlag);
+LE_SHARED bool runCommandFlush (Camera *cam, uint8_t cmd, uint8_t args[], int respLen);
+LE_SHARED uint8_t readResponse (Camera *cam, unsigned int nBytes, unsigned int timeout);
+LE_SHARED void printBuffer (Camera *cam);
+LE_SHARED bool verifyResponse (Camera *cam, uint8_t cmd);
+LE_SHARED bool cameraFrameBuffCtrl (Camera *cam, uint8_t cmd);
+LE_SHARED bool takePicture (Camera *cam);
+LE_SHARED bool reset (Camera *cam);
+LE_SHARED bool TVon (Camera *cam);
+LE_SHARED bool TVOff (Camera *cam);
+LE_SHARED uint8_t *readPicture (Camera *cam, uint8_t n);
+LE_SHARED bool resumeVideo (Camera *cam);
+LE_SHARED uint32_t frameLength (Camera *cam);
+LE_SHARED char *getVersion (Camera *cam);
+LE_SHARED uint8_t available (Camera *cam);
+LE_SHARED uint8_t getDownsize (Camera *cam);
+LE_SHARED bool setDownsize(Camera *cam, uint8_t newSize);
+LE_SHARED uint8_t getImageSize (Camera *cam);
+LE_SHARED bool setImageSize (Camera *cam, uint8_t x);
+LE_SHARED bool getMotionDetect (Camera *cam);
+LE_SHARED uint8_t getMotionStatus(Camera *cam, uint8_t x);
+LE_SHARED bool motionDetected (Camera *cam);
+LE_SHARED bool setMotionDetect (Camera *cam, bool flag);
+LE_SHARED bool setMotionStatus (Camera *cam, uint8_t x, uint8_t d1, uint8_t d2);
+LE_SHARED uint8_t getCompression (Camera *cam);
+LE_SHARED bool setCompression(Camera *cam, uint8_t c);
+LE_SHARED bool getPTZ(Camera *cam, uint16_t *w, uint16_t *h, uint16_t *wz, uint16_t *hz, uint16_t *pan, uint16_t *tilt);
+LE_SHARED bool setPTZ(Camera *cam, uint16_t wz, uint16_t hz, uint16_t pan, uint16_t tilt);
+LE_SHARED bool snapshotToFile (Camera *cam, char *path, uint8_t imgSize);
```
## Typedefs