christian b / 4dGENIE

Mbed 4dGenie class

Dependents:   Genie_Test 039847382-S3_DS1621_and_LCD_V1

This is a work in progress.

4dGenie class to use with 4dLCD screens that are using the genie environment.

There are still some rare occasions where the 4dLCD might crash, for now i have no solution to this except doing a reset of the 4dLCD.

Please make sure to have the most up to date PmmC loaded on the screen.

usage example :

Mbed4dGenie test program

#include "mbed.h"
#include "mbed_genie.h"

DigitalOut myled(LED1);
/*
    The Mbed4dGenie class requires 3 parameters
    1 - Tx pin
    2 - Rx pin
    3 - Reset pin
*/
Mbed4dGenie lcd4d(PTE0,PTE1,PTB9);



int main() {
    int temp = 0;
printf("Mbed Genie demo \n\r");
lcd4d.Start();


 /*
 for example, in this loop we increment the thermometer0 object from 0 to 100
 */
 
    while(1) {
        if(temp >= 100)
        {
            temp = -1;
        }
        else
        {
            temp++;
        }

        lcd4d.genieWriteObject(GENIE_OBJ_LED_DIGITS,1,temp);

        myled = 1;
        wait(0.05);
        myled = 0;
        wait(0.05);
    }
}

mbed_genie.h

Committer:
chris215
Date:
2014-02-23
Revision:
2:f283764fe9b7
Parent:
1:95e0e194a412
Child:
3:11c49c49cd1a

File content as of revision 2:f283764fe9b7:

#undef  GENIE_DEBUG

#define GENIE_VERSION   "GenieMbed 17-Nov-2013"

// Genie commands & replys:

#define GENIE_ACK       0x06
#define GENIE_NAK       0x15

#define TIMEOUT_PERIOD  500
#define RESYNC_PERIOD   100

#define GENIE_READ_OBJ          0
#define GENIE_WRITE_OBJ         1
#define GENIE_WRITE_STR         2
#define GENIE_WRITE_STRU        3
#define GENIE_WRITE_CONTRAST    4
#define GENIE_REPORT_OBJ        5
#define GENIE_REPORT_EVENT      7

// Objects
//  the manual says:
//      Note: Object IDs may change with future releases; it is not
//      advisable to code their values as constants.

#define GENIE_OBJ_DIPSW         0
#define GENIE_OBJ_KNOB          1
#define GENIE_OBJ_ROCKERSW      2
#define GENIE_OBJ_ROTARYSW      3
#define GENIE_OBJ_SLIDER        4
#define GENIE_OBJ_TRACKBAR      5
#define GENIE_OBJ_WINBUTTON     6
#define GENIE_OBJ_ANGULAR_METER 7
#define GENIE_OBJ_COOL_GAUGE    8
#define GENIE_OBJ_CUSTOM_DIGITS 9
#define GENIE_OBJ_FORM          10
#define GENIE_OBJ_GAUGE         11
#define GENIE_OBJ_IMAGE         12
#define GENIE_OBJ_KEYBOARD      13
#define GENIE_OBJ_LED           14
#define GENIE_OBJ_LED_DIGITS    15
#define GENIE_OBJ_METER         16
#define GENIE_OBJ_STRINGS       17
#define GENIE_OBJ_THERMOMETER   18
#define GENIE_OBJ_USER_LED      19
#define GENIE_OBJ_VIDEO         20
#define GENIE_OBJ_STATIC_TEXT   21
#define GENIE_OBJ_SOUND         22
#define GENIE_OBJ_TIMER         23
#define GENIE_OBJ_SPECTRUM      24
#define GENIE_OBJ_SCOPE         25
#define GENIE_OBJ_TANK          26
#define GENIE_OBJ_USERIMAGES    27
#define GENIE_OBJ_PINOUTPUT     28
#define GENIE_OBJ_PININPUT      29
#define GENIE_OBJ_4DBUTTON      30
#define GENIE_OBJ_ANIBUTTON     31
#define GENIE_OBJ_COLORPICKER   32
#define GENIE_OBJ_USERBUTTON    33

// Structure to store replys returned from a display

#define     GENIE_FRAME_SIZE    6
struct genieFrameReportObj {
    uint8_t     cmd;
    uint8_t     object;
    uint8_t     index;
    uint8_t     data_msb;
    uint8_t     data_lsb;
};
 
/////////////////////////////////////////////////////////////////////
// The Genie frame definition
//
// The union allows the data to be referenced as an array of uint8_t
// or a structure of type genieFrameReportObj, eg
//
//  genieFrame f;
//  f.bytes[4];
//  f.reportObject.data_lsb
//
//  both methods get the same byte
//
union genieFrame {
    uint8_t             bytes[GENIE_FRAME_SIZE];
    genieFrameReportObj reportObject;
};

#define MAX_GENIE_EVENTS    16  // MUST be a power of 2
#define MAX_GENIE_FATALS    10

struct genieEventQueueStruct {
    genieFrame  frames[MAX_GENIE_EVENTS];
    uint8_t     rd_index;
    uint8_t     wr_index;
    uint8_t     n_events;
};

typedef void        (*geniePutCharFuncPtr)      (uint8_t c, uint32_t baud);
typedef uint16_t    (*genieGetCharFuncPtr)      (void);
typedef void        (*genieUserEventHandlerPtr) (void);

#define ERROR_NONE          0
#define ERROR_TIMEOUT       -1  // 255  0xFF
#define ERROR_NOHANDLER     -2  // 254  0xFE
#define ERROR_NOCHAR        -3  // 253  0xFD
#define ERROR_NAK           -4  // 252  0xFC
#define ERROR_REPLY_OVR     -5  // 251  0xFB
#define ERROR_RESYNC        -6  // 250  0xFA
#define ERROR_NODISPLAY     -7  // 249  0xF9
#define ERROR_BAD_CS        -8  // 248  0xF8

#define GENIE_LINK_IDLE         0
#define GENIE_LINK_WFAN         1 // waiting for Ack or Nak
#define GENIE_LINK_WF_RXREPORT  2 // waiting for a report frame
#define GENIE_LINK_RXREPORT     3 // receiving a report frame
#define GENIE_LINK_RXEVENT      4 // receiving an event frame
#define GENIE_LINK_SHDN         5

#define GENIE_EVENT_NONE    0
#define GENIE_EVENT_RXCHAR  1

#ifndef        TRUE
#define        TRUE        (1==1)
#define        FALSE        (!TRUE)
#endif

void            SetupGenie(void);
void            genieAttachEventHandler     (genieUserEventHandlerPtr handler);
extern bool     genieDequeueEvent           (genieFrame * buff);
extern bool     genieEventIs                (genieFrame * e, uint8_t cmd, uint8_t object, uint8_t index);
extern uint16_t genieGetEventData           (genieFrame * e); 
extern uint16_t genieWriteObject            (uint16_t object, uint16_t index, uint16_t data);
extern uint16_t genieWriteStr               (uint16_t index, char *string);
extern void     genieWriteContrast          (uint16_t value);

class Mbed4dGenie{
    public:
    Mbed4dGenie(PinName TxPin,PinName RxPin);
    void genieAttachEventHandler (genieUserEventHandlerPtr handler);
    
    uint8_t _genieGetchar(void);
    void _geniePutchar (uint8_t c);
    uint16_t _genieGetLinkState (void);
    void _genieSetLinkState (uint16_t newstate);
    bool _genieEnqueueEvent (uint8_t * data);
    uint16_t genieWriteStrU (uint16_t index, char *string);
    uint16_t genieWriteStr (uint16_t index, char *string);
    int _genieWriteStrX (uint16_t code, uint16_t index, char *string);
    void genieWriteContrast (uint16_t value);
    uint16_t genieWriteObject (uint16_t object, uint16_t index, uint16_t data);
    void _genieWaitForIdle (void);
    bool genieDequeueEvent(genieFrame * buff);
    uint16_t genieGetEventData (genieFrame * e);
    bool genieEventIs(genieFrame * e, uint8_t cmd, uint8_t object, uint8_t index);
    void _geniePushLinkState (uint8_t newstate);
    void _geniePopLinkState (void);
    void _genieFlushSerialInput(void);
    void _handleError (void);
    void _genieFlushEventQueue(void);
    bool GenieReadable(void);
    uint16_t genieDoEvents (void);
    
    private:
    void RxIrqHandler(void);   
    Serial _screen;
    Timer _t;
    //////////////////////////////////////////////////////////////
    // Pointer to the user's event handler function
    //
    genieUserEventHandlerPtr _genieUserHandler;
    //////////////////////////////////////////////////////////////
    // A structure to hold up to MAX_GENIE_EVENTS events receive
    // from the display
    //
    genieEventQueueStruct _genieEventQueue;
    //////////////////////////////////////////////////////////////
    // Simple 5-deep stack for the link state, this allows 
    // genieDoEvents() to save the current state, receive a frame,
    // then restore the state
    //
    uint8_t _genieLinkStates[5];
    //
    // Stack pointer
    //
    uint8_t     *_genieLinkState;
    //////////////////////////////////////////////////////////////
    // Number of mS the genieGetChar() function will wait before
    // giving up on the display
    int _genieTimeout;
    //////////////////////////////////////////////////////////////
    // Global error variable
    int _genieError;
    uint8_t rxframe_count;
    };