Eric Williams / Mbed 2 deprecated Lab3_Surveillance

Lab3_Surveillance

Dependencies:   GPS mbed

Camera_LS_Y201.h@2:ba06c987a111, 2011-10-13 (annotated)

Committer:
gtg846r
Date:
Thu Oct 13 17:42:27 2011 +0000
Revision:
2:ba06c987a111
Parent:
0:2af1e48a285d 
Revision #3...Includes phone number input

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gtg846r 0:2af1e48a285d 1 /**
gtg846r 0:2af1e48a285d 2 * =============================================================================
gtg846r 0:2af1e48a285d 3 * LS-Y201 device driver class (Version 0.0.1)
gtg846r 0:2af1e48a285d 4 * Reference documents: LinkSprite JPEG Color Camera Serial UART Interface
gtg846r 0:2af1e48a285d 5 * January 2010
gtg846r 0:2af1e48a285d 6 * =============================================================================
gtg846r 0:2af1e48a285d 7 * Copyright (c) 2010 Shinichiro Nakamura (CuBeatSystems)
gtg846r 0:2af1e48a285d 8 *
gtg846r 0:2af1e48a285d 9 * Permission is hereby granted, free of charge, to any person obtaining a copy
gtg846r 0:2af1e48a285d 10 * of this software and associated documentation files (the "Software"), to deal
gtg846r 0:2af1e48a285d 11 * in the Software without restriction, including without limitation the rights
gtg846r 0:2af1e48a285d 12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
gtg846r 0:2af1e48a285d 13 * copies of the Software, and to permit persons to whom the Software is
gtg846r 0:2af1e48a285d 14 * furnished to do so, subject to the following conditions:
gtg846r 0:2af1e48a285d 15 *
gtg846r 0:2af1e48a285d 16 * The above copyright notice and this permission notice shall be included in
gtg846r 0:2af1e48a285d 17 * all copies or substantial portions of the Software.
gtg846r 0:2af1e48a285d 18 *
gtg846r 0:2af1e48a285d 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
gtg846r 0:2af1e48a285d 20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
gtg846r 0:2af1e48a285d 21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
gtg846r 0:2af1e48a285d 22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
gtg846r 0:2af1e48a285d 23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
gtg846r 0:2af1e48a285d 24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
gtg846r 0:2af1e48a285d 25 * THE SOFTWARE.
gtg846r 0:2af1e48a285d 26 * =============================================================================
gtg846r 0:2af1e48a285d 27 */
gtg846r 0:2af1e48a285d 28
gtg846r 0:2af1e48a285d 29 #ifndef LS_Y201_H
gtg846r 0:2af1e48a285d 30 #define LS_Y201_H
gtg846r 0:2af1e48a285d 31
gtg846r 0:2af1e48a285d 32 #include "mbed.h"
gtg846r 0:2af1e48a285d 33 #include "SerialBuffered.h"
gtg846r 0:2af1e48a285d 34
gtg846r 0:2af1e48a285d 35 /**
gtg846r 0:2af1e48a285d 36 * Camera
gtg846r 0:2af1e48a285d 37 */
gtg846r 0:2af1e48a285d 38 class Camera_LS_Y201 {
gtg846r 0:2af1e48a285d 39 public:
gtg846r 0:2af1e48a285d 40
gtg846r 0:2af1e48a285d 41 /**
gtg846r 0:2af1e48a285d 42 * Create.
gtg846r 0:2af1e48a285d 43 *
gtg846r 0:2af1e48a285d 44 * @param tx Transmitter.
gtg846r 0:2af1e48a285d 45 * @param rx Receiver.
gtg846r 0:2af1e48a285d 46 */
gtg846r 0:2af1e48a285d 47 Camera_LS_Y201(PinName tx, PinName rx);
gtg846r 0:2af1e48a285d 48
gtg846r 0:2af1e48a285d 49 /**
gtg846r 0:2af1e48a285d 50 * Dispose.
gtg846r 0:2af1e48a285d 51 */
gtg846r 0:2af1e48a285d 52 ~Camera_LS_Y201();
gtg846r 0:2af1e48a285d 53
gtg846r 0:2af1e48a285d 54 /**
gtg846r 0:2af1e48a285d 55 * Error code.
gtg846r 0:2af1e48a285d 56 */
gtg846r 0:2af1e48a285d 57 enum ErrorCode {
gtg846r 0:2af1e48a285d 58 NoError = 0,
gtg846r 0:2af1e48a285d 59 UnexpectedReply,
gtg846r 0:2af1e48a285d 60 Timeout,
gtg846r 0:2af1e48a285d 61 SendError,
gtg846r 0:2af1e48a285d 62 RecvError,
gtg846r 0:2af1e48a285d 63 InvalidArguments
gtg846r 0:2af1e48a285d 64 };
gtg846r 0:2af1e48a285d 65
gtg846r 0:2af1e48a285d 66 /**
gtg846r 0:2af1e48a285d 67 * Image size.
gtg846r 0:2af1e48a285d 68 */
gtg846r 0:2af1e48a285d 69 enum ImageSize {
gtg846r 0:2af1e48a285d 70 ImageSize160x120, /**< 160x120. */
gtg846r 0:2af1e48a285d 71 ImageSize320x280, /**< 320x280. */
gtg846r 0:2af1e48a285d 72 ImageSize640x480 /**< 640x480. */
gtg846r 0:2af1e48a285d 73 };
gtg846r 0:2af1e48a285d 74
gtg846r 0:2af1e48a285d 75 /**
gtg846r 0:2af1e48a285d 76 * Reset module.
gtg846r 0:2af1e48a285d 77 *
gtg846r 0:2af1e48a285d 78 * @return Error code.
gtg846r 0:2af1e48a285d 79 */
gtg846r 0:2af1e48a285d 80 ErrorCode reset();
gtg846r 0:2af1e48a285d 81
gtg846r 0:2af1e48a285d 82 /**
gtg846r 0:2af1e48a285d 83 * Set image size.
gtg846r 0:2af1e48a285d 84 *
gtg846r 0:2af1e48a285d 85 * @param is Image size.
gtg846r 0:2af1e48a285d 86 * @return Error code.
gtg846r 0:2af1e48a285d 87 */
gtg846r 0:2af1e48a285d 88 ErrorCode setImageSize(ImageSize is);
gtg846r 0:2af1e48a285d 89
gtg846r 0:2af1e48a285d 90 /**
gtg846r 0:2af1e48a285d 91 * Take picture.
gtg846r 0:2af1e48a285d 92 *
gtg846r 0:2af1e48a285d 93 * @return Error code.
gtg846r 0:2af1e48a285d 94 */
gtg846r 0:2af1e48a285d 95 ErrorCode takePicture();
gtg846r 0:2af1e48a285d 96
gtg846r 0:2af1e48a285d 97 /**
gtg846r 0:2af1e48a285d 98 * Read jpeg file size.
gtg846r 0:2af1e48a285d 99 *
gtg846r 0:2af1e48a285d 100 * @param fileSize File size.
gtg846r 0:2af1e48a285d 101 * @return Error code.
gtg846r 0:2af1e48a285d 102 */
gtg846r 0:2af1e48a285d 103 ErrorCode readJpegFileSize(int *fileSize);
gtg846r 0:2af1e48a285d 104
gtg846r 0:2af1e48a285d 105 /**
gtg846r 0:2af1e48a285d 106 * Read jpeg file content.
gtg846r 0:2af1e48a285d 107 *
gtg846r 0:2af1e48a285d 108 * @param func A pointer to a call back function.
gtg846r 0:2af1e48a285d 109 * @return Error code.
gtg846r 0:2af1e48a285d 110 */
gtg846r 0:2af1e48a285d 111 ErrorCode readJpegFileContent(void (*func)(int done, int total, uint8_t *buf, size_t siz));
gtg846r 0:2af1e48a285d 112
gtg846r 0:2af1e48a285d 113 /**
gtg846r 0:2af1e48a285d 114 * Stop taking pictures.
gtg846r 0:2af1e48a285d 115 *
gtg846r 0:2af1e48a285d 116 * @return Error code.
gtg846r 0:2af1e48a285d 117 */
gtg846r 0:2af1e48a285d 118 ErrorCode stopTakingPictures();
gtg846r 0:2af1e48a285d 119
gtg846r 0:2af1e48a285d 120 private:
gtg846r 0:2af1e48a285d 121 SerialBuffered serial;
gtg846r 0:2af1e48a285d 122
gtg846r 0:2af1e48a285d 123 /**
gtg846r 0:2af1e48a285d 124 * Wait init end codes.
gtg846r 0:2af1e48a285d 125 *
gtg846r 0:2af1e48a285d 126 * @return Error code.
gtg846r 0:2af1e48a285d 127 */
gtg846r 0:2af1e48a285d 128 ErrorCode waitInitEnd();
gtg846r 0:2af1e48a285d 129
gtg846r 0:2af1e48a285d 130 /**
gtg846r 0:2af1e48a285d 131 * Send bytes to camera module.
gtg846r 0:2af1e48a285d 132 *
gtg846r 0:2af1e48a285d 133 * @param buf Pointer to the data buffer.
gtg846r 0:2af1e48a285d 134 * @param len Length of the data buffer.
gtg846r 0:2af1e48a285d 135 *
gtg846r 0:2af1e48a285d 136 * @return True if the data sended.
gtg846r 0:2af1e48a285d 137 */
gtg846r 0:2af1e48a285d 138 bool sendBytes(uint8_t *buf, size_t len, int timeout_us);
gtg846r 0:2af1e48a285d 139
gtg846r 0:2af1e48a285d 140 /**
gtg846r 0:2af1e48a285d 141 * Receive bytes from camera module.
gtg846r 0:2af1e48a285d 142 *
gtg846r 0:2af1e48a285d 143 * @param buf Pointer to the data buffer.
gtg846r 0:2af1e48a285d 144 * @param len Length of the data buffer.
gtg846r 0:2af1e48a285d 145 *
gtg846r 0:2af1e48a285d 146 * @return True if the data received.
gtg846r 0:2af1e48a285d 147 */
gtg846r 0:2af1e48a285d 148 bool recvBytes(uint8_t *buf, size_t len, int timeout_us);
gtg846r 0:2af1e48a285d 149
gtg846r 0:2af1e48a285d 150 /**
gtg846r 0:2af1e48a285d 151 * Wait received.
gtg846r 0:2af1e48a285d 152 *
gtg846r 0:2af1e48a285d 153 * @return True if the data received.
gtg846r 0:2af1e48a285d 154 */
gtg846r 0:2af1e48a285d 155 bool waitRecv();
gtg846r 0:2af1e48a285d 156
gtg846r 0:2af1e48a285d 157 /**
gtg846r 0:2af1e48a285d 158 * Wait idle state.
gtg846r 0:2af1e48a285d 159 *
gtg846r 0:2af1e48a285d 160 * @return True if it succeed.
gtg846r 0:2af1e48a285d 161 */
gtg846r 0:2af1e48a285d 162 bool waitIdle();
gtg846r 0:2af1e48a285d 163
gtg846r 0:2af1e48a285d 164 };
gtg846r 0:2af1e48a285d 165
gtg846r 0:2af1e48a285d 166 #endif