ADIS_Projects/ADIS_tinyK22_SplitFlap/source/splitflap.c

/*
#include <splitflap_flaps.h>
 * splitflap.c
 *
 *  Created on: 29.09.2022
 *      Author: jonas
 */

#include "platform.h"
#include <stdbool.h>
#include "splitflap.h"
#include "McuRTOS.h"
#include "McuULN2003.h"
#include <stdbool.h>
#include "McuWait.h"
#include "McuLog.h"
#include "lib/dict.h"
#include "McuUtility.h"

#define FLAP_QUEUE_LENGTH (5)						/* number of elements in queue */
#define FLAP_QUEUE_SELEM_SIZE (sizeof(Flap_t))      /* size of element */

/* dynamic dictionary for the letters of the dictionary */
static dict_t **splitFlapDict;
/* all letters of the splitflap in the correct order */
static Flap_t SF_Letters[] = {	" ", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K",
								"L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z",
								"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
								"!", "?", ":"};

/* function declarations */
static bool OngoingMoveMutex_Lock(SF_Handle_t instance);
static void OngoingMoveMutex_Unlock(SF_Handle_t instance);
static void SF_Task(void *pv);

/**********************/
/* INIT / DEINIT      */
/**********************/
void SF_InitConfig(void){
	splitFlapDict = dictAlloc();
	((dict_t*)splitFlapDict)->key=NULL;
	((dict_t*)splitFlapDict)->value=NULL;
	((dict_t*)splitFlapDict)->next=NULL;
	float stepsPerSegment = SPLITFLAP_STEPS_PER_SEGMENT; // do division once

	// add all splitflap flaps to the dictionary, calculating the position automatically
	// print out for debugging
	McuLog_info("Splitflap positioning data is automatically calculated:\n");
	for(int i = 0; i < SPLITFLAP_AMOUNT_OF_SEGMENTS; i ++){
		// + 0.5 so the rounding is done correctly
		int32_t position = (stepsPerSegment * (float)i + 0.5);
		addItem(splitFlapDict, SF_Letters[i], (int32_t*)position);
		McuLog_info("Letter '%s': Position %i\n", SF_Letters[i], (int)position);
	}
}

void SF_DeInitConfig(void){
	dictDealoc(splitFlapDict);
}

SF_Handle_t SF_Init(SF_Config_t* instance, int id){
	SF_t* splitflap;

#if SPLITFLAP_CONFIG_USE_FREERTOS_HEAP
	splitflap = (SF_t*)pvPortMalloc(sizeof(SF_t)); /* get a new device descriptor */
#else
	splitflap = (SF_t*)malloc(sizeof(SF_t)); /* get a new device descriptor */
#endif

	splitflap->magSensor = McuGPIO_InitGPIO(&instance->magSensorConfig);
	splitflap->motor = McuULN2003_InitMotor(&instance->motorConfig);
	splitflap->ongoingMoveMutex = xSemaphoreCreateRecursiveMutex(); 	// create mutex for ongoing move
	splitflap->flapQueue = xQueueCreate(FLAP_QUEUE_LENGTH, FLAP_QUEUE_SELEM_SIZE);  // create queue
	splitflap->id = id;
	#ifndef APP_DEBUG    // when not debugging => set to false
	splitflap->initialized = false;
#else    // when debugging => set to true
	splitflap->initialized = true;
#endif

	// check if queue was created
	if(splitflap->flapQueue == NULL){
		McuLog_error("Flap queue creation failed for Splitflap <%i>", id);
		for(;;){}
	}
	// if yes: add queue to registry
	vQueueAddToRegistry(splitflap->flapQueue, "FlapQueue");

	// check if queue was created
	if(splitflap->ongoingMoveMutex == NULL){
		McuLog_error("Ongoing Move mutex creation failed for Splitflap <%i>", id);
		for(;;){}
	}
	// if yes: add ongoing move mutex to registry
	vQueueAddToRegistry(splitflap->ongoingMoveMutex, "OngoingMoveMutex");

	// create Task for splitflap
	BaseType_t res = xTaskCreate(	SF_Task,
									"SF",
									800/sizeof(StackType_t),
									splitflap,  // no &, since otherwise pointing on parameter address! we want handle address!
									tskIDLE_PRIORITY,
									NULL);
	if(res != pdPASS) // task creation not successful?
	{
		McuLog_error("Creation of task for Splitflap <%i> failed", id);
		for(;;) {} // Endless loop
	}

	return splitflap;
}

void SF_Deinit(SF_Handle_t instance){
	vSemaphoreDelete(((SF_t*)instance)->ongoingMoveMutex);
	((SF_t*)instance)->initialized = false;
	McuULN2003_DeinitMotor(((SF_t*)instance)->motor);
	McuGPIO_DeinitGPIO(((SF_t*)instance)->magSensor);
}


/**********************/
/* PUBLIC FUNCTIONS   */
/**********************/
bool SF_MoveMotorToZeroPosition(SF_Handle_t instance, uint16_t offsetSteps){
	int numStepsMoved = 0;

	if(((SF_t*)instance)->initialized){
		McuLog_warn("Tried to initialize motor of Splitflap <%i>, but already initialized => skipping", ((SF_t*)instance)->id);
		return true;
	}

	if(OngoingMoveMutex_Lock(instance)){
		// move out of sensor
		while(SF_GetMagSensorAtZeroPosition((SF_t*)instance) == true){
			McuULN2003_IncStep(((SF_t*)instance)->motor);
			McuWait_Waitms(20);
		}

		// turn until sensor is on and not reached one full rotation already (timeout)
		while(SF_GetMagSensorAtZeroPosition((SF_t*)instance) == false && numStepsMoved < SPLITFLAP_STEPS_ONE_ROUND ){
			McuULN2003_IncStep(((SF_t*)instance)->motor);
			McuWait_Waitms(20);
			numStepsMoved++;
		}

		// offset after init
		if(numStepsMoved < SPLITFLAP_STEPS_ONE_ROUND){
			for(int i=0; i < offsetSteps; i++){
				McuULN2003_IncStep(((SF_t*)instance)->motor);
				McuWait_Waitms(20);
			}
		}
		McuULN2003_SetPos(((SF_t*)instance)->motor, 0);
		McuULN2003_PowerOff(((SF_t*)instance)->motor);

		OngoingMoveMutex_Unlock(instance);
	}

	// success if less than one rotation
	((SF_t*)instance)->initialized = (numStepsMoved < SPLITFLAP_STEPS_ONE_ROUND);

	return ((SF_t*)instance)->initialized;
}

void SF_MoveSteps(SF_Handle_t instance, uint32_t steps){
	if(((SF_t*)instance)->initialized){
		if(OngoingMoveMutex_Lock(instance)){
			// run move with acceleration & deceleration
			McuULN2003_AccelerationStart(((SF_t*)instance)->motor);
			while(steps>0){
				if(McuULN2003_StepCallback(((SF_t*)instance)->motor, true)){
					steps--;
				}
				McuWait_Waitms(1);
			}
			McuULN2003_AccelerationEnd(((SF_t*)instance)->motor);

			// Power off disables all outputs of the ULN,
			// required since it is possible that one is still active, which would result in the motor getting hot
			// no re-init is required
			McuULN2003_PowerOff(((SF_t*)instance)->motor);

			OngoingMoveMutex_Unlock(instance);
		}
	} else{
		McuLog_error("SF_MoveSteps could not be called for Splitflap <%i> because it is not initialized.", ((SF_t*)instance)->id);
	}
}

bool SF_GetMagSensorAtZeroPosition(SF_Handle_t instance){
	return McuGPIO_IsLow(((SF_t*)instance)->magSensor);
}

void SF_MoveToFlap(SF_Handle_t instance, Flap_t flap){
	if(OngoingMoveMutex_Lock(instance)){

		// get flap pos from dictonary
		int32_t flapPos = (int32_t)getItem(*splitFlapDict, flap);
		// get current motor pos
		int32_t currentPos = SF_GetMotorPosition(instance) % SPLITFLAP_STEPS_ONE_ROUND;
		// calc steps to move
		int32_t stepsToReachFlap = 0;
		// not already there
		if(flapPos != currentPos){
			if(flapPos < currentPos){
					stepsToReachFlap = SPLITFLAP_STEPS_ONE_ROUND-currentPos+flapPos;
			}else if(flapPos > currentPos){
					stepsToReachFlap = flapPos - currentPos;
			}
			SF_MoveSteps(instance, stepsToReachFlap);
		}

		OngoingMoveMutex_Unlock(instance);
	}
}

void SF_MoveToFlapAsync(SF_Handle_t instance, Flap_t flap){
	if(xQueueSendToBack(((SF_t*)instance)->flapQueue, &flap, pdMS_TO_TICKS(100)) != pdPASS){
		McuLog_error("SF_MoveToFlapAsync: Failed to add flap to queue for Splitflap <%i>", ((SF_t*)instance)->id);
	}
}

int32_t SF_GetMotorPosition(SF_Handle_t instance){
	return McuULN2003_GetPos(((SF_t*)instance)->motor);
}

/**********************/
/* INTERNAL FUNCTIONS */
/**********************/
/* voidpointer to instance of splitflap (SF_Handle_t) */
static void SF_Task(void *pv){
	// parse parameter
	SF_Handle_t instance = (SF_Handle_t)pv;
	SF_t* splitflap = (SF_t*)instance;
	Flap_t nextFlap = " ";
	McuLog_info("Splitflap: Task for Splitflap <%i> started.\n", splitflap->id);

	for(;;){
		// delay task
		vTaskDelay(pdMS_TO_TICKS(50));

		// if not initialized => Skip everything
		if(splitflap->initialized == false){
			continue;
		}

		// check if anything is in queue once (poll once, don't get item)
		if(xQueuePeek(splitflap->flapQueue, &nextFlap, 0) != pdPASS){
			/* failed to receive => queue empty */
			continue;
		}
		McuLog_info("Splitflap <%i> recognized new flap '%c' in queue to move to.", splitflap->id, nextFlap[0]);

		// new flap to move to is available
		// check if ongoing move
		if(OngoingMoveMutex_Lock(instance)){
			// now get the queue item
			if(xQueueReceive(splitflap->flapQueue, &nextFlap, 0) != pdPASS){
				/* failed to receive => queue empty but previously an iteam was there? error */
				McuLog_error("Failed to receive Queue item of Splitflap <%i>.", splitflap->id);
				OngoingMoveMutex_Unlock(instance);
				continue; // ignore & proceed
			}

			//=> execute move
			McuLog_info("Splitflap <%i> moving to flap '%c'.", splitflap->id, nextFlap[0]);
			SF_MoveToFlap(instance, nextFlap);
			McuLog_info("Splitflap <%i> move done to flap '%c'.", splitflap->id, nextFlap[0]);

			OngoingMoveMutex_Unlock(instance);
		}
	}
}


/**********************/
/* HELPERS            */
/**********************/
static bool OngoingMoveMutex_Lock(SF_Handle_t instance){
	/* aquire mutex */
	if(xSemaphoreTakeRecursive(((SF_t*)instance)->ongoingMoveMutex, pdMS_TO_TICKS(20)) != pdTRUE){
		return false; /* timeout? */
	}
	return true;
}

static void OngoingMoveMutex_Unlock(SF_Handle_t instance){
	/* give back mutex */
	if(xSemaphoreGiveRecursive(((SF_t*)instance)->ongoingMoveMutex) != pdTRUE){
		/* issue */
		McuLog_error("Could not give back ongoing move mutex for splitflap %i", ((SF_t*)instance)->id);
		for(;;);
	}
}