X-Git-Url: https://git.ucc.asn.au/?p=tpg%2Fopendispense2.git;a=blobdiff_plain;f=src%2Fserver%2Fhandler_coke.c;h=b9a9cf3271bbbd6e0a30e8441d7eee1ef165855b;hp=79d0a4697b2bdb4218a43cf119bb7d2a6e84c26e;hb=6d657891a5410b7d93cc90f376a3ef27b72b20f6;hpb=135e5ad4cc018ec05d1118e4d40be5c51db3f293 diff --git a/src/server/handler_coke.c b/src/server/handler_coke.c index 79d0a46..b9a9cf3 100644 --- a/src/server/handler_coke.c +++ b/src/server/handler_coke.c @@ -11,35 +11,35 @@ * - Remember, the coke machine echoes your text back to you! */ #include "common.h" +#include "../common/config.h" #include #include -#include -#include -#include -#include #include #include +#include +#include +#include -#define READ_TIMEOUT 2 // 2 seconds for ReadChar -#define TRACE_COKE 1 +#define MIN_DISPENSE_PERIOD 2 +#define COKE_RECONNECT_RATELIMIT 2 -#if TRACE_COKE -# define TRACE(v...) do{printf("%s: ",__func__);printf(v);}while(0) -#else -# define TRACE(...) -#endif +// === CONSTANTS === +const int ciCoke_MinPeriod = 5; +const int ciCoke_DropBitBase = 1024; +const int ciCoke_StatusBitBase = 16; // === IMPORTS === // === PROTOTYPES === int Coke_InitHandler(); - int Coke_int_GetSlotStatus(char *Buffer, int Slot); -void Coke_int_UpdateSlotStatuses(void); int Coke_CanDispense(int User, int Item); int Coke_DoDispense(int User, int Item); - int Writef(const char *Format, ...); - int WaitForColon(); - int ReadLine(int len, char *output); + int Coke_int_ConnectToPLC(void); + int Coke_int_GetSlotFromItem(int Item, int bDispensing); + int Coke_int_IsSlotEmpty(int Slot); + int Coke_int_DropSlot(int Slot); +static int _ReadBit(int BitNum, uint8_t *Value); +static int _WriteBit(int BitNum, uint8_t Value); // === GLOBALS === tHandler gCoke_Handler = { @@ -48,338 +48,223 @@ tHandler gCoke_Handler = { Coke_CanDispense, Coke_DoDispense }; -char *gsCoke_SerialPort = "/dev/ttyS0"; - int giCoke_SerialFD; -regex_t gCoke_StatusRegex; - int gaCoke_CachedStatus[7]; -pthread_mutex_t gCoke_Mutex = PTHREAD_MUTEX_INITIALIZER; +const char *gsCoke_ModbusAddress = "130.95.13.73"; +modbus_t *gCoke_Modbus; time_t gtCoke_LastDispenseTime; +time_t gtCoke_LastReconnectTime; + int gbCoke_DummyMode = 1; + int giCoke_NextCokeSlot = 0; // == CODE === int Coke_InitHandler() { - CompileRegex(&gCoke_StatusRegex, "^slot\\s+([0-9]+)\\s+([^:]+):([a-zA-Z]+)\\s*", REG_EXTENDED); - - printf("Connecting to coke machine on '%s'\n", gsCoke_SerialPort); - - giCoke_SerialFD = InitSerial(gsCoke_SerialPort, 9600); - if( giCoke_SerialFD == -1 ) { - fprintf(stderr, "ERROR: Unable to open coke serial port ('%s')\n", gsCoke_SerialPort); + // Configuable dummy/blank mode (all dispenses succeed) + // TODO: Find a better way of handling missing/invalid options + if( Config_GetValueCount("coke_dummy_mode") > 0 ) + { + gbCoke_DummyMode = Config_GetValue_Bool("coke_dummy_mode", 0); + if(gbCoke_DummyMode == -1) gbCoke_DummyMode = 0; } - else { - int i; - for( i = 0; i < 7; i ++ ) - gaCoke_CachedStatus[i] = -1; - // Reset the slot names. - // - Dunno why this is needed, but the machine plays silly - // sometimes. - Writef("n0 Slot0\n"); - if( !WaitForColon() ) - { - Writef("n1 Slot1\n"); - WaitForColon(); - Writef("n2 Slot2\n"); - WaitForColon(); - Writef("n3 Slot3\n"); - WaitForColon(); - Writef("n4 Slot4\n"); - WaitForColon(); - Writef("n5 Slot5\n"); - WaitForColon(); - Writef("n6 Coke\n"); - - Coke_int_UpdateSlotStatuses(); - } - else - fprintf(stderr, "Coke machine timed out.\n"); + + // Open modbus + if( !gbCoke_DummyMode ) + { + Coke_int_ConnectToPLC(); } - - AddPeriodicFunction(Coke_int_UpdateSlotStatuses); - + return 0; } -int Coke_int_GetSlotStatus(char *Buffer, int Slot) +int Coke_CanDispense(int UNUSED(User), int Item) { - regmatch_t matches[4]; - int ret; - char *status; + int slot; - // Parse status response - ret = RunRegex(&gCoke_StatusRegex, Buffer, sizeof(matches)/sizeof(matches[0]), matches, "Bad Response"); - if( ret ) { - return -1; - } + // Check for 'dummy' mode + if( gbCoke_DummyMode ) + return 0; - // Get slot status - Buffer[ matches[3].rm_eo ] = '\0'; - status = &Buffer[ matches[3].rm_so ]; - - TRACE("Machine responded slot %i status '%s'\n", Slot, status); + // Get slot + slot = Coke_int_GetSlotFromItem(Item, 0); + if(slot < 0) return -1; - if( strcmp(status, "full") == 0 ) { - gaCoke_CachedStatus[Slot] = 0; // 0: Avaliiable - return 0; - } - else { - gaCoke_CachedStatus[Slot] = 1; // 1: Empty - return 1; - } + return Coke_int_IsSlotEmpty(slot); } /** - * \brief Update the status of all coke slots - * \note Uses goto to reduce the chance of the lock being kept + * \brief Actually do a dispense from the coke machine */ -void Coke_int_UpdateSlotStatuses(void) +int Coke_DoDispense(int UNUSED(User), int Item) { - int i, len; - char tmp[40]; - - if( giCoke_SerialFD == -1 ) return ; - - pthread_mutex_lock(&gCoke_Mutex); - - while( ReadLine(sizeof tmp, tmp) >= 0 ) ; - TRACE("send d7\n"); - Writef("d7\r\n"); // Update slot statuses - if( WaitForColon() ) goto ret; - TRACE("send s\n"); - Writef("s\r\n"); - do { - i = ReadLine(sizeof tmp, tmp); // Read back what we just said - if( i == -1 ) { - TRACE("Eat read failed"); - goto ret; - } - } while(tmp[0] != ':' && tmp[1] != 's'); + int slot; + // Check for 'dummy' mode + if( gbCoke_DummyMode ) + return 0; + + // Get slot + slot = Coke_int_GetSlotFromItem(Item, 1); + if(slot < 0) return -1; - for( i = 0; i <= 6; i ++ ) + // Make sure there are not two dispenses within n seconds + if( time(NULL) - gtCoke_LastDispenseTime < ciCoke_MinPeriod ) { - // Read until non-blank line - while( (len = ReadLine(sizeof tmp, tmp)) == 0 ) ; - if( len == -1 ) { - TRACE("Read failed on slot %i\n", i); - goto ret; // I give up :( + int delay = ciCoke_MinPeriod - (time(NULL) - gtCoke_LastDispenseTime); + Debug_Debug("Waiting for %i seconds (rate limit)", delay); + sleep( delay ); + Debug_Debug("wait done"); + } + gtCoke_LastDispenseTime = time(NULL); + + return Coke_int_DropSlot(slot); +} + +// --- INTERNAL FUNCTIONS --- +int Coke_int_ConnectToPLC(void) +{ + // Ratelimit + if( time(NULL) - gtCoke_LastReconnectTime < COKE_RECONNECT_RATELIMIT ) + return -1; + + if( !gCoke_Modbus ) + { + gCoke_Modbus = modbus_new_tcp(gsCoke_ModbusAddress, 502); + if( !gCoke_Modbus ) + { + perror("coke - modbus_new_tcp"); + gtCoke_LastReconnectTime = time(NULL); + return 1; } - TRACE("tmp = '%s'\n", tmp); - Coke_int_GetSlotStatus(tmp, i); } - // Eat blank line - len = ReadLine(sizeof tmp, tmp); - if( len == -1 ) { - TRACE("Read failed on blank line\n"); + else { + // Preven resource leaks + modbus_close(gCoke_Modbus); + } + Debug_Notice("Connecting to coke PLC machine on '%s'\n", gsCoke_ModbusAddress); + + if( modbus_connect(gCoke_Modbus) ) + { + gtCoke_LastReconnectTime = time(NULL); + perror("coke - modbus_connect"); + modbus_free(gCoke_Modbus); + gCoke_Modbus = NULL; + return 1; } - TRACE("Updated\n"); - -ret: - pthread_mutex_unlock(&gCoke_Mutex); + return 0; } -int Coke_CanDispense(int UNUSED(User), int Item) +int Coke_int_GetSlotFromItem(int Item, int bDispensing) { - // Sanity please - if( Item < 0 || Item > 6 ) return -1; // -EYOURBAD - - // Can't dispense if the machine is not connected - if( giCoke_SerialFD == -1 ) - return -2; + if( Item < 0 || Item > 6 ) return -1; + + // Non-coke slots + if( Item < 6 ) + return Item; - return gaCoke_CachedStatus[Item]; + // Iterate though coke slots and find the first one with a drink avaliable + // `giCoke_NextCokeSlot` ensures that the slots rotate + for( int i = 0; i < 4; i ++ ) + { + int slot = 6 + (i + giCoke_NextCokeSlot) % 4; + if( !Coke_int_IsSlotEmpty(slot) ) + { + if(bDispensing) { + giCoke_NextCokeSlot ++; + if(giCoke_NextCokeSlot == 4) giCoke_NextCokeSlot = 0; + } + return slot; // Drink avaliable + } + } + + // Coke is empty! + // - Return 6, even if it's empty, the checks elsewhere will avoid problems + return 6; } -/** - * \brief Actually do a dispense from the coke machine - */ -int Coke_DoDispense(int UNUSED(User), int Item) +int Coke_int_IsSlotEmpty(int Slot) { - char tmp[32]; - int ret, len; + uint8_t status; - // Sanity please - if( Item < 0 || Item > 6 ) return -1; + if( Slot < 0 || Slot > 9 ) return -1; - // Can't dispense if the machine is not connected - if( giCoke_SerialFD == -1 ) - return -2; - - // Make sure there are not two dispenses within n seconds - if( time(NULL) - gtCoke_LastDispenseTime < 10 ) + errno = 0; + if( _ReadBit(ciCoke_StatusBitBase + Slot, &status) ) { - printf("Wait %li seconds?\n", 10 - (time(NULL) - gtCoke_LastDispenseTime)); - sleep( 10 - (time(NULL) - gtCoke_LastDispenseTime) ); - printf("wait done\n"); + perror("Coke_int_IsSlotEmpty - modbus_read_bits"); + return -2; } - - // LOCK - pthread_mutex_lock(&gCoke_Mutex); - - TRACE("flushing input\n"); - - // Wait for prompt - ret = 0; - while( WaitForColon() && ret < 3 ) + return status == 0; +} + +int Coke_int_DropSlot(int Slot) +{ + uint8_t res; + + if(Slot < 0 || Slot > 9) return -1; + + // Check if a dispense is in progress + if( _ReadBit(ciCoke_DropBitBase + Slot, &res) ) { - // Flush the input buffer - char tmpbuf[512]; - read(giCoke_SerialFD, tmpbuf, sizeof(tmpbuf)); - TRACE("sending 'd7'\n"); - Writef("d7\r\n"); - ret ++; + perror("Coke_int_DropSlot - modbus_read_bits#1"); + return -2; } - if( ret == 3 ) + if( res != 0 ) { - TRACE("timed out\n"); - pthread_mutex_unlock(&gCoke_Mutex); + // Manual dispense in progress return -1; } - TRACE("sending 'd%i'\n", Item); // Dispense - Writef("d%i\r\n", Item); - - // Read empty lines and echo-backs - do { - ret = ReadLine(sizeof(tmp)-1, tmp); - if( ret == -1 ) { - pthread_mutex_unlock(&gCoke_Mutex); - return -1; - } - TRACE("read %i '%s'\n", ret, tmp); - } while( ret == 0 || tmp[0] == ':' || tmp[0] == 'd' ); - - WaitForColon(); // Eat up rest of response - - TRACE("done\n"); - - // TODO: Regex instead? - if( strcmp(tmp, "ok") == 0 ) { - // We think dispense worked - // - The machine returns 'ok' if an empty slot is dispensed, even if - // it doesn't actually try to dispense (no sound) - ret = 0; + if( _WriteBit(ciCoke_DropBitBase + Slot, 1) ) + { + perror("Coke_int_DropSlot - modbus_write_bit"); + return -2; } - else { - printf("Coke_DoDispense: Machine returned unknown value '%s'\n", tmp); - ret = -1; + + // Check that it started + usleep(1000); // 1ms + if( _ReadBit(ciCoke_DropBitBase + Slot, &res) ) + { + perror("Coke_int_DropSlot - modbus_read_bits#2"); + return -2; } - - TRACE("Updating slot status\n"); - - // Update status - WaitForColon(); - Writef("s%i\r\n", Item); - len = ReadLine(sizeof tmp, tmp); - if(len == -1) gaCoke_CachedStatus[Item] = -1; - Coke_int_GetSlotStatus(tmp, Item); + if( res == 0 ) { - char buf[512]; - read(giCoke_SerialFD, buf, 512); // Flush + // Oops!, no drink + Log_Error("Drink dispense failed, bit lowered too quickly"); + Debug_Notice("Drink dispense failed, bit lowered too quickly"); + return 1; } - - gtCoke_LastDispenseTime = time(NULL); - - // Release and return - pthread_mutex_unlock(&gCoke_Mutex); - //return ret; - // HACK!!! return 0; } -char ReadChar() +int _ReadBit(int BitNum, uint8_t *Value) { - fd_set readfs; - char ch = 0; - int ret; - struct timeval timeout; - - timeout.tv_sec = READ_TIMEOUT; - timeout.tv_usec = 0; - - FD_ZERO(&readfs); - FD_SET(giCoke_SerialFD, &readfs); - - ret = select(giCoke_SerialFD+1, &readfs, NULL, NULL, &timeout); - if( ret == 0 ) return 0; // Timeout - if( ret != 1 ) { - printf("ReadChar: select return %i\n", ret); + errno = 0; + if( !gCoke_Modbus && Coke_int_ConnectToPLC() ) + return -1; + if( modbus_read_bits( gCoke_Modbus, BitNum, 1, Value) >= 0 ) return 0; - } - - ret = read(giCoke_SerialFD, &ch, 1); - if( ret != 1 ) { - printf("ReadChar: ret != 1 (%i)\n", ret); + if( Coke_int_ConnectToPLC() ) + return -1; + if( modbus_read_bits( gCoke_Modbus, BitNum, 1, Value) >= 0 ) return 0; - } - - return ch; -} - -int Writef(const char *Format, ...) -{ - va_list args; - int len; - - va_start(args, Format); - len = vsnprintf(NULL, 0, Format, args); - va_end(args); - - { - char buf[len+1]; - va_start(args, Format); - vsnprintf(buf, len+1, Format, args); - va_end(args); - - #if DEBUG - printf("Writef: %s", buf); - #endif - - return write(giCoke_SerialFD, buf, len); - } - -} - -int WaitForColon() -{ - fd_set readfs; - char ch = 0; - - FD_SET(giCoke_SerialFD, &readfs); - - while( (ch = ReadChar()) != ':' && ch != 0); - - if( ch == 0 ) return -1; // Timeout - - return 0; + return -1; } -int ReadLine(int len, char *output) +int _WriteBit(int BitNum, uint8_t Value) { - char ch; - int i = 0; - - for(;;) - { - ch = ReadChar(); - - if( i < len ) - output[i++] = ch; - - if( ch == '\0' ) { - break; - } - if( ch == '\n' || ch == '\r' ) { - if( i < len ) - output[--i] = '\0'; - break; - } - } - - if( !ch ) return -1; - return i; + errno = 0; + if( !gCoke_Modbus && Coke_int_ConnectToPLC() ) + return -1; + if( modbus_write_bit( gCoke_Modbus, BitNum, Value != 0 ) >= 0 ) + return 0; + // Error case + if( Coke_int_ConnectToPLC() ) + return -1; + if( modbus_write_bit( gCoke_Modbus, BitNum, Value != 0 ) >= 0 ) + return 0; + return -1; } -