Patrice HAESAERT / Mbed 2 deprecated Tir_V40

Chrono

Dependencies:   mbed SDFileSystem

mbed_genie.h@5:e565265fdf23, 2020-04-07 (annotated)

Committer:
pathae
Date:
Tue Apr 07 12:24:23 2020 +0000
Revision:
5:e565265fdf23
Tir

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pathae 5:e565265fdf23 1 #undef GENIE_DEBUG
pathae 5:e565265fdf23 2
pathae 5:e565265fdf23 3 #define GENIE_VERSION "GenieMbed 17-Nov-2013"
pathae 5:e565265fdf23 4
pathae 5:e565265fdf23 5 // Genie commands & replys:
pathae 5:e565265fdf23 6
pathae 5:e565265fdf23 7 #define GENIE_ACK 0x06
pathae 5:e565265fdf23 8 #define GENIE_NAK 0x15
pathae 5:e565265fdf23 9
pathae 5:e565265fdf23 10 #define TIMEOUT_PERIOD 500
pathae 5:e565265fdf23 11 #define RESYNC_PERIOD 100
pathae 5:e565265fdf23 12
pathae 5:e565265fdf23 13 #define GENIE_READ_OBJ 0
pathae 5:e565265fdf23 14 #define GENIE_WRITE_OBJ 1
pathae 5:e565265fdf23 15 #define GENIE_WRITE_STR 2
pathae 5:e565265fdf23 16 #define GENIE_WRITE_STRU 3
pathae 5:e565265fdf23 17 #define GENIE_WRITE_CONTRAST 4
pathae 5:e565265fdf23 18 #define GENIE_REPORT_OBJ 5
pathae 5:e565265fdf23 19 #define GENIE_REPORT_EVENT 7
pathae 5:e565265fdf23 20
pathae 5:e565265fdf23 21 // Objects
pathae 5:e565265fdf23 22 // the manual says:
pathae 5:e565265fdf23 23 // Note: Object IDs may change with future releases; it is not
pathae 5:e565265fdf23 24 // advisable to code their values as constants.
pathae 5:e565265fdf23 25
pathae 5:e565265fdf23 26 #define GENIE_OBJ_DIPSW 0
pathae 5:e565265fdf23 27 #define GENIE_OBJ_KNOB 1
pathae 5:e565265fdf23 28 #define GENIE_OBJ_ROCKERSW 2
pathae 5:e565265fdf23 29 #define GENIE_OBJ_ROTARYSW 3
pathae 5:e565265fdf23 30 #define GENIE_OBJ_SLIDER 4
pathae 5:e565265fdf23 31 #define GENIE_OBJ_TRACKBAR 5
pathae 5:e565265fdf23 32 #define GENIE_OBJ_WINBUTTON 6
pathae 5:e565265fdf23 33 #define GENIE_OBJ_ANGULAR_METER 7
pathae 5:e565265fdf23 34 #define GENIE_OBJ_COOL_GAUGE 8
pathae 5:e565265fdf23 35 #define GENIE_OBJ_CUSTOM_DIGITS 9
pathae 5:e565265fdf23 36 #define GENIE_OBJ_FORM 10
pathae 5:e565265fdf23 37 #define GENIE_OBJ_GAUGE 11
pathae 5:e565265fdf23 38 #define GENIE_OBJ_IMAGE 12
pathae 5:e565265fdf23 39 #define GENIE_OBJ_KEYBOARD 13
pathae 5:e565265fdf23 40 #define GENIE_OBJ_LED 14
pathae 5:e565265fdf23 41 #define GENIE_OBJ_LED_DIGITS 15
pathae 5:e565265fdf23 42 #define GENIE_OBJ_METER 16
pathae 5:e565265fdf23 43 #define GENIE_OBJ_STRINGS 17
pathae 5:e565265fdf23 44 #define GENIE_OBJ_THERMOMETER 18
pathae 5:e565265fdf23 45 #define GENIE_OBJ_USER_LED 19
pathae 5:e565265fdf23 46 #define GENIE_OBJ_VIDEO 20
pathae 5:e565265fdf23 47 #define GENIE_OBJ_STATIC_TEXT 21
pathae 5:e565265fdf23 48 #define GENIE_OBJ_SOUND 22
pathae 5:e565265fdf23 49 #define GENIE_OBJ_TIMER 23
pathae 5:e565265fdf23 50 #define GENIE_OBJ_SPECTRUM 24
pathae 5:e565265fdf23 51 #define GENIE_OBJ_SCOPE 25
pathae 5:e565265fdf23 52 #define GENIE_OBJ_TANK 26
pathae 5:e565265fdf23 53 #define GENIE_OBJ_USERIMAGES 27
pathae 5:e565265fdf23 54 #define GENIE_OBJ_PINOUTPUT 28
pathae 5:e565265fdf23 55 #define GENIE_OBJ_PININPUT 29
pathae 5:e565265fdf23 56 #define GENIE_OBJ_4DBUTTON 30
pathae 5:e565265fdf23 57 #define GENIE_OBJ_ANIBUTTON 31
pathae 5:e565265fdf23 58 #define GENIE_OBJ_COLORPICKER 32
pathae 5:e565265fdf23 59 #define GENIE_OBJ_USERBUTTON 33
pathae 5:e565265fdf23 60
pathae 5:e565265fdf23 61 // Structure to store replys returned from a display
pathae 5:e565265fdf23 62
pathae 5:e565265fdf23 63 #define GENIE_FRAME_SIZE 6
pathae 5:e565265fdf23 64 struct genieFrameReportObj {
pathae 5:e565265fdf23 65 uint8_t cmd;
pathae 5:e565265fdf23 66 uint8_t object;
pathae 5:e565265fdf23 67 uint8_t index;
pathae 5:e565265fdf23 68 uint8_t data_msb;
pathae 5:e565265fdf23 69 uint8_t data_lsb;
pathae 5:e565265fdf23 70 };
pathae 5:e565265fdf23 71
pathae 5:e565265fdf23 72 /////////////////////////////////////////////////////////////////////
pathae 5:e565265fdf23 73 // The Genie frame definition
pathae 5:e565265fdf23 74 //
pathae 5:e565265fdf23 75 // The union allows the data to be referenced as an array of uint8_t
pathae 5:e565265fdf23 76 // or a structure of type genieFrameReportObj, eg
pathae 5:e565265fdf23 77 //
pathae 5:e565265fdf23 78 // genieFrame f;
pathae 5:e565265fdf23 79 // f.bytes[4];
pathae 5:e565265fdf23 80 // f.reportObject.data_lsb
pathae 5:e565265fdf23 81 //
pathae 5:e565265fdf23 82 // both methods get the same byte
pathae 5:e565265fdf23 83 //
pathae 5:e565265fdf23 84 union genieFrame {
pathae 5:e565265fdf23 85 uint8_t bytes[GENIE_FRAME_SIZE];
pathae 5:e565265fdf23 86 genieFrameReportObj reportObject;
pathae 5:e565265fdf23 87 };
pathae 5:e565265fdf23 88
pathae 5:e565265fdf23 89 #define MAX_GENIE_EVENTS 16 // MUST be a power of 2
pathae 5:e565265fdf23 90 #define MAX_GENIE_FATALS 10
pathae 5:e565265fdf23 91
pathae 5:e565265fdf23 92 struct genieEventQueueStruct {
pathae 5:e565265fdf23 93 genieFrame frames[MAX_GENIE_EVENTS];
pathae 5:e565265fdf23 94 uint8_t rd_index;
pathae 5:e565265fdf23 95 uint8_t wr_index;
pathae 5:e565265fdf23 96 uint8_t n_events;
pathae 5:e565265fdf23 97 };
pathae 5:e565265fdf23 98
pathae 5:e565265fdf23 99 typedef void (*geniePutCharFuncPtr) (uint8_t c, uint32_t baud);
pathae 5:e565265fdf23 100 typedef uint16_t (*genieGetCharFuncPtr) (void);
pathae 5:e565265fdf23 101 typedef void (*genieUserEventHandlerPtr) (void);
pathae 5:e565265fdf23 102
pathae 5:e565265fdf23 103 #define ERROR_NONE 0
pathae 5:e565265fdf23 104 #define ERROR_TIMEOUT -1 // 255 0xFF
pathae 5:e565265fdf23 105 #define ERROR_NOHANDLER -2 // 254 0xFE
pathae 5:e565265fdf23 106 #define ERROR_NOCHAR -3 // 253 0xFD
pathae 5:e565265fdf23 107 #define ERROR_NAK -4 // 252 0xFC
pathae 5:e565265fdf23 108 #define ERROR_REPLY_OVR -5 // 251 0xFB
pathae 5:e565265fdf23 109 #define ERROR_RESYNC -6 // 250 0xFA
pathae 5:e565265fdf23 110 #define ERROR_NODISPLAY -7 // 249 0xF9
pathae 5:e565265fdf23 111 #define ERROR_BAD_CS -8 // 248 0xF8
pathae 5:e565265fdf23 112
pathae 5:e565265fdf23 113 #define GENIE_LINK_IDLE 0
pathae 5:e565265fdf23 114 #define GENIE_LINK_WFAN 1 // waiting for Ack or Nak
pathae 5:e565265fdf23 115 #define GENIE_LINK_WF_RXREPORT 2 // waiting for a report frame
pathae 5:e565265fdf23 116 #define GENIE_LINK_RXREPORT 3 // receiving a report frame
pathae 5:e565265fdf23 117 #define GENIE_LINK_RXEVENT 4 // receiving an event frame
pathae 5:e565265fdf23 118 #define GENIE_LINK_SHDN 5
pathae 5:e565265fdf23 119
pathae 5:e565265fdf23 120 #define GENIE_EVENT_NONE 0
pathae 5:e565265fdf23 121 #define GENIE_EVENT_RXCHAR 1
pathae 5:e565265fdf23 122
pathae 5:e565265fdf23 123 #ifndef TRUE
pathae 5:e565265fdf23 124 #define TRUE (1==1)
pathae 5:e565265fdf23 125 #define FALSE (!TRUE)
pathae 5:e565265fdf23 126 #endif
pathae 5:e565265fdf23 127
pathae 5:e565265fdf23 128 void SetupGenie(void);
pathae 5:e565265fdf23 129 void genieAttachEventHandler (genieUserEventHandlerPtr handler);
pathae 5:e565265fdf23 130 extern bool genieDequeueEvent (genieFrame * buff);
pathae 5:e565265fdf23 131 extern bool genieEventIs (genieFrame * e, uint8_t cmd, uint8_t object, uint8_t index);
pathae 5:e565265fdf23 132 extern uint16_t genieGetEventData (genieFrame * e);
pathae 5:e565265fdf23 133 extern uint16_t genieWriteObject (uint16_t object, uint16_t index, uint16_t data);
pathae 5:e565265fdf23 134 extern uint16_t genieWriteStr (uint16_t index, char *string);
pathae 5:e565265fdf23 135 extern void genieWriteContrast (uint16_t value);
pathae 5:e565265fdf23 136