From df604080f553b4007ff865a53133573515a31c49 Mon Sep 17 00:00:00 2001
From: Nick Van Doorn <vandoorn.nick@gmail.com>
Date: Thu, 9 Nov 2017 09:03:48 -0800
Subject: Remove confusing typedef

---
 README.md | 48 +++++++++++++++++++++---------------------------
 1 file changed, 21 insertions(+), 27 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 47d41f7..e9de3cd 100644
--- a/README.md
+++ b/README.md
@@ -10,53 +10,47 @@ The Legato serial API [`le_tty`](http://legato.io/legato-docs/latest/le__tty_8h.
 
 ## API
 ```c
-void delay (unsigned int secs);
+void delay (unsigned int msecs);
 int openCameraFd ();
-void sendCommand (Camera *cam, byte cmd, byte args[]);
-bool runCommand (Camera *cam, byte cmd, byte args[], int respLen);
-int readResponse (Camera *cam, int nBytes, int timeout);
-bool verifyResponse (Camera *cam, byte cmd);
-bool cameraFrameBuffCtrl (Camera *cam, byte cmd);
+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);
-size_t bufferToFile (Camera *cam, char *path);
 bool reset (Camera *cam);
 bool TVon (Camera *cam);
 bool TVOff (Camera *cam);
-byte *readPicture (Camera *cam);
+uint8_t *readPicture (Camera *cam, uint8_t n);
 bool resumeVideo (Camera *cam);
 uint32_t frameLength (Camera *cam);
 char *getVersion (Camera *cam);
-byte available (Camera *cam);
-byte getDownsize (Camera *cam);
-bool setDownsize(Camera *cam, int newSize);
-int getImageSize (Camera *cam);
-bool setImageSize (Camera *cam, int size);
+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);
-byte getMotionStatus(Camera *cam, byte x);
+uint8_t getMotionStatus(Camera *cam, uint8_t x);
 bool motionDetected (Camera *cam);
-bool setMotionDetect (bool flag);
-bool setMotionStatus (byte x, byte d1, byte d2);
-byte getCompression (Camera *cam);
-bool setCompression(Camera *cam, byte c);
+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);
 ```
 
 ## Typedefs
 
-### byte
-```c
-typedef uint8_t byte;
-```
-
 ### Camera
 ```c
 typedef struct {
   int fd; // file descriptor for the serial port
-  byte serialNum; // camera serial number
-  byte buff[BUFF_SIZE]; // byte array to store camera data
-  int bufferLen; // current length of data in buffer
+  uint8_t serialNum; // camera serial number
+  uint8_t buff[BUFF_SIZE]; // uint8_t array to store camera data
+  uint8_t bufferLen; // current length of data in buffer
   uint16_t frameptr;
 } Camera;
-
 ```
-- 
cgit v1.2.3