Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

Add Library

To add a library to otStudio you need to load the relative source files in the directory:
(PATH)/bin/libs/data/otStudio/data/library
Then you need to edit the file:
(PATH)/bin/libs/config/otStudio/libraryDoc.txt
Adding the library according to the syntax.
Example:
	# Library definition file 
	# (C) 2020 Officina Turini
	#
	#   Be careful to edit this file!
	#   An incorrect compilation can cause errors in otStudio
	#   The LIB:,DIR:,MEM:,END: keywords are the only one really needed, the rest of the keywords are for documentation purposes only.
	#   FUN: and CST: keyword are used for text editor completer
	#
	# Keywords version 1.0.0 - 2020/01/08
	#
	# Keywords:
	# # This is a comment
	# LIB: Library name as the file name
	# DIR: Folder related
	# DOC: Library brief doc
	# MEM: In which memory locate the library: MI_SDRAM, MI_ASYNC, MI_DATA_A, MI_DATA_B, MI_CODE_AB, MI_CODE_C
	# REV: Library revision
	# HST: History of revision
	# AUT: Library author
	# LIC: License
	# DEP: Dependency, list of requested libraries
	# FUN: Function list also comma separated, all these names are automatically inserted in TextEditor Completer
	# CST: Define, enums, ...
	# END: End of library info
	#
	LIB:otEEprom.c
	DIR:
	DOC:EEPROM library
	MEM:MI_SDRAM
	DEP:otFPGA,otSpi,otTimer
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:EEreadStatus,EEwriteStatus,EEwriteEnable,EEread,EEreadWord,EEreadLong,EEreadDouble,EEreadString
	FUN:EEwrite,EEwriteWord,EEwriteLong,EEwriteDouble,EEwriteString
	FUN:EEreadCheck,EEreadWordCheck,EEreadLongCheck,EEreadDoubleCheck
	CST:
	END:
	#
	#
	#
	LIB:otFPGA.c
	DIR:$platform
	DOC:Sharkduino+ FPGA driver
	MEM:MI_SDRAM
	DEP:
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:FpgaInit,FpgaRegWrite,FpgaRegRead,FpgaSetPll,FpgaPllConfig,FpgaSpiSelect,FpgaSpiWrite,FpgaSpiWrite16,FpgaTimerSet
	FUN:FpgaTimerEnable,FpgaEncoderSetup,FpgaEncoderRead,FpgaEncoderClear,FpgaEventFunction,FpgaEventGate,FpgaEventSignalInvert
	FUN:FpgaEventReset,FpgaEventClearRead,FpgaEventDone,FpgaEventRead,FpgaPortPxSet,FpgaPxGet,FpgaPxPut,FpgaPCamlSet
	FUN:FpgaPCamlGet,FpgaPCamlPut,FpgaPCamhSet,FpgaPCamhGet,FpgaPCamhPut,FpgaSetCamBus,FpgaIntSource,FpgaIntClear,FpgaHiddenPort
	CST:
	END:
	#
	#
	#
	LIB:otI2cBus.c
	DIR:BF51x
	DOC:BF51x I2C bus functions
	MEM:MI_CODE_AB
	DEP:otTimer
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:I2cBusFrequency,I2cBusReset,I2cBusClrSclSda,I2cBusWrite,I2cBusRead,I2cBusWriteByte
	FUN:I2cBusReadByte,I2cBusReadBytes,I2cBusWrite16_8,I2cBusWrite16_16,I2cBusReadReg8_16
	FUN:I2cBusReadReg16_8,I2cBusReadReg16_16
	CST:
	END:
	#
	#
	#
	LIB:otMalloc.c
	DIR:
	DOC:Memory allocation functions
	MEM:MI_CODE_AB
	DEP:
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:_calloc,_initMalloc,_memFree,_free,_malloc,_realloc,_reallocf
	CST:
	END:
	#
	#
	#
	LIB:otMath.c
	DIR:
	DOC:Math library
	MEM:MI_SDRAM
	DEP:
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:cos,sin,tan,acos,asin,atan,atan2,cosh,sinh,tanh,exp,frexp,ldexp
	FUN:log,log10,modf,remainder,pow,sqrt,fmod,ceil,floor,__IsNan,sign
	FUN:fabs,signbit,isfinite,isnan,isinf
	CST:FLT_RADIX,DBL_MAX_EXP,DBL_MIN_EXP,DBL_MAX,DBL_MIN,DBL_MANT_DIG,EDOM
	CST:ERANGE,DBL_EXP_BIAS,DBL_EXP_INFNAN,HUGE_VAL,M_PI,M_2PI,M_3PI_4
	CST:M_PI_2,M_3PI_8,M_PI_4,M_PI_8,M_1_PI,M_2_PI,M_4_PI,M_E,M_LOG2E,M_LOG10E
	CST:M_LN2,M_LN10,M_SQRT2,M_1_SQRT2,M_EULER,POLYNOM1,POLYNOM2,POLYNOM3,POLYNOM4
	CST:POLYNOM5,POLYNOM6,POLYNOM7,POLYNOM8,POLYNOM9,POLYNOM10,POLYNOM11,POLYNOM12
	CST:POLYNOM13,M_LN_MAX_D,M_LN_MIN_D,DEG_TO_RAD,RAD_TO_DEG
	END:
	#
	#
	#
	LIB:otPort.c
	DIR:BF51x
	DOC:BF51x Port functions
	MEM:MI_SDRAM
	DEP:
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:PortConfig
	CST:PPF_HST,PPF_MUX,PPF_FER,PPF_DIR,PPF_INE,PPF_POL,PPF_EDG,PPF_RSE,PPF_MKA,PPF_MKB,PPF_MSA,PPF_MSB,PPF_MCA,PPF_MCB,PPF_MTA,PPF_MTB,PPF_SET,PPF_CLR,PPF_TGL,PPF
	CST:PPG_HST,PPG_MUX,PPG_FER,PPG_DIR,PPG_INE,PPG_POL,PPG_EDG,PPG_RSE,PPG_MKA,PPG_MKB,PPG_MSA,PPG_MSB,PPG_MCA,PPG_MCB,PPG_MTA,PPG_MTB,PPG_SET,PPG_CLR,PPG_TGL,PPG
	CST:PPH_HST,PPH_MUX,PPH_FER,PPH_DIR,PPH_INE,PPH_POL,PPH_EDG,PPH_RSE,PPH_MKA,PPH_MKB,PPH_MSA,PPH_MSB,PPH_MCA,PPH_MCB,PPH_MTA,PPH_MTB,PPH_SET,PPH_CLR,PPH_TGL,PPH
	END:
	#
	#
	#
	LIB:otPrintf.c
	DIR:
	DOC:Extended printf, sprintf function
	MEM:MI_SDRAM
	DEP:otSerial,otMalloc
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:printf,sprintf,vsprintf,xformat,xvformat,setStdout,stdOutLF
	CST:
	END:
	#
	#
	#
	LIB:otPrintfLite.c
	DIR:
	DOC:Lite printf, sprintf function
	MEM:MI_SDRAM
	DEP:otSerial
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:printf,sprintf,setStdout,stdOutLF
	CST:
	END:
	#
	#
	#
	LIB:otScanfLite.c
	DIR:
	DOC:Lite scanf function
	MEM:MI_SDRAM
	DEP:otSerial
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:scanf,setStdin
	CST:
	END:
	#
	#
	#
	LIB:otSD.c
	DIR:BF51x
	DOC:BF51x Secure Digital Driver
	MEM:MI_SDRAM
	DEP:otPort,otTimer
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:SdPower,SdOpen,SdClose,SdSize,SdSectorCount,SdSectorSize,SdEraseSectorSize,SdSectorErase,SdGetCID
	FUN:SdReadBlock,SdWriteBlock,SdReadMultipleBlocks,SdWriteMultipleBlocks,SdGetMaxBusWidth
	CST:
	END:
	#
	#
	#
	LIB:otSerial.c
	DIR:BF51x
	DOC:BF51x Serial library
	MEM:MI_CODE_AB
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:UartEnableSignals,UartSetBaud,UartPutChar
	FUN:UartPutBytes,UartPutString,UartGetChar
	FUN:UartCheckChar,UartReceiveService
	CST:UART0,UART1
	END:
	#
	#
	#
	LIB:otSpi.c
	DIR:BF51x
	DOC:BF51x SPI library
	MEM:MI_CODE_AB
	DEP:otFPGA
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:SpiChannel,SpiCs,SpiSet,SpiPut,SpiPutN,SpiGetN
	CST:SA_EEPROM,SA_Y6,SA_Y15,SA_LCD,SA_TOUCH,SA_ADC,SA_PGA,SA_DAC
	END:
	#
	#
	#
	LIB:otString.c
	DIR:
	DOC:String library
	MEM:MI_SDRAM
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:__isalpha,__isspace,__isupper,__ishex,__ascii2hex,__isdigit,__isblank__isprint,__isalnum
	FUN:_tolower,_toupper,_strlen,dbl2stri,_atoi,_htoi,_strcat,_strstr,_strtok,_strchop,_strlastchar
	FUN:_strcmp,_strncmp,_strchr,_strcpy,_strncpy,_reverse,_str_split,_str_leftShift,_str_simplified
	FUN:_str_field,_replace,_strEndsWith
	CST:
	END:
	#
	#
	#
	LIB:otTimer.c
	DIR:BF51x
	DOC:BF51x Timer library
	MEM:MI_CODE_AB
	REV:1.0.0
	HST:1.0.0 First release
	AUT:Manuele Turini
	LIC:GPLv3
	FUN:DelayUs,DelayMs,CoreTimerSetInterruptService,CoreTimerEnable
	FUN:TimerSetInterruptCallBack,TimerSetInterruptService,TimerSetSquareWave
	FUN:TimerSetAsCounter,TimerGetCounts,TimerEnable
	FUN:CoreGetPeripheralClock,CoreGetClock,ElapsedTimeUs,ElapsedTimeNs
	FUN:TimerRateHz,TimerRateMs
	CST:TIMER0,TIMER1,TIMER2,TIMER3,TIMER4,TIMER5,TIMER6,TIMER7
	END:
	#
	#
	#
 * 
footer
otStudio - Library Reference - (C) 2020-23 Officina Turini, All Rights Reserved
Document built with Doxygen 1.4.0