ubx.c 215 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965
  1. /*
  2. * ubxproto
  3. * Copyright (c) 2014, Alexey Edelev aka semlanik, All rights reserved.
  4. *
  5. * This library is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU Lesser General Public
  7. * License as published by the Free Software Foundation; either
  8. * version 3.0 of the License, or (at your option) any later version.
  9. *
  10. * This library is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. * Lesser General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU Lesser General Public
  16. * License along with this library.
  17. *
  18. * Additionally to GNU Lesser General Public License you MUST NOT
  19. * static link this library and MUST add link to author
  20. * and source of this library in your application.
  21. *
  22. * Actual LGPL text https://www.gnu.org/licenses/lgpl.html
  23. *
  24. * File: ubx.c
  25. */
  26. #include "ubxmessage.h"
  27. #include "ubx.h"
  28. #include "malloc.h"
  29. #include "memory.h"
  30. void fletcherChecksum(unsigned char* buffer, int size, unsigned char* checkSumA, unsigned char* checkSumB)
  31. {
  32. int i = 0;
  33. *checkSumA = 0;
  34. *checkSumB = 0;
  35. for(; i < size; i++)
  36. {
  37. *checkSumA += buffer[i];
  38. *checkSumB += *checkSumA;
  39. }
  40. }
  41. void completeMsg(struct UBXMsgBuffer* buffer, int payloadSize)
  42. {
  43. unsigned char* checkSumA = (unsigned char*)(buffer->data + UBX_HEADER_SIZE + payloadSize);
  44. unsigned char* checkSumB = (unsigned char*)(buffer->data + UBX_HEADER_SIZE + payloadSize + 1);
  45. fletcherChecksum((unsigned char*)(buffer->data + sizeof(UBX_PREAMBLE)), payloadSize + 4, checkSumA, checkSumB);
  46. }
  47. void initMsg(struct UBXMsg* msg, int payloadSize, enum UBXMessageClass msgClass, enum UBXMessageId msgId)
  48. {
  49. msg->preamble = htobe16(UBX_PREAMBLE);
  50. msg->hdr.msgClass = msgClass;
  51. msg->hdr.msgId = msgId;
  52. msg->hdr.length = payloadSize;
  53. }
  54. struct UBXMsgBuffer createBuffer(int payloadSize)
  55. {
  56. struct UBXMsgBuffer buffer = {0, 0};
  57. buffer.size = UBX_HEADER_SIZE + payloadSize + UBX_CHECKSUM_SIZE;
  58. buffer.data = malloc(buffer.size);
  59. memset(buffer.data, 0, buffer.size);
  60. return buffer;
  61. }
  62. struct UBXMsgBuffer getAID_ALPSRV(struct UBXMsg* clientMgs, const struct UBXAlpFileInfo *fileInfo)
  63. {
  64. int requestedAlpSize = (clientMgs->payload.AID_ALPSRV.size << 1);
  65. if(fileInfo->dataSize < (clientMgs->payload.AID_ALPSRV.offset + requestedAlpSize))
  66. {
  67. requestedAlpSize = fileInfo->dataSize - clientMgs->payload.AID_ALPSRV.offset - 1;
  68. }
  69. int alpMsgSize = sizeof(struct UBXAID_ALPSRV);
  70. int payloadSize = alpMsgSize + requestedAlpSize;
  71. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  72. struct UBXMsg* msg = (struct UBXMsg*) buffer.data;
  73. if(requestedAlpSize < 0)
  74. {
  75. return buffer;
  76. }
  77. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALPSRV);
  78. msg->payload.AID_ALPSRV.idSize = clientMgs->payload.AID_ALPSRV.idSize;
  79. msg->payload.AID_ALPSRV.type = clientMgs->payload.AID_ALPSRV.type;
  80. msg->payload.AID_ALPSRV.offset = clientMgs->payload.AID_ALPSRV.offset;
  81. msg->payload.AID_ALPSRV.size = clientMgs->payload.AID_ALPSRV.size;
  82. msg->payload.AID_ALPSRV.fileId = fileInfo->fileId;
  83. msg->payload.AID_ALPSRV.dataSize = requestedAlpSize;
  84. msg->payload.AID_ALPSRV.id1 = clientMgs->payload.AID_ALPSRV.id1;
  85. msg->payload.AID_ALPSRV.id2 = clientMgs->payload.AID_ALPSRV.id2;
  86. msg->payload.AID_ALPSRV.id3 = clientMgs->payload.AID_ALPSRV.id3;
  87. memcpy(buffer.data + UBX_HEADER_SIZE + alpMsgSize, fileInfo->alpData + msg->payload.AID_ALPSRV.offset, requestedAlpSize);
  88. completeMsg(&buffer, payloadSize);
  89. return buffer;
  90. }
  91. struct UBXMsgBuffer getCFG_MSG_POLL(enum UBXMessageClass msgClass, enum UBXMessageId msgId)
  92. {
  93. int payloadSize = sizeof(struct UBXCFG_MSG_POLL);
  94. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  95. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  96. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_MSG);
  97. msg->payload.CFG_MSG_POLL.msgClass = msgClass;
  98. msg->payload.CFG_MSG_POLL.msgId = msgId;
  99. completeMsg(&buffer, payloadSize);
  100. return buffer;
  101. }
  102. struct UBXMsgBuffer getCFG_MSG_RATE(enum UBXMessageClass msgClass, enum UBXMessageId msgId, UBXU1_t rate)
  103. {
  104. int payloadSize = sizeof(struct UBXCFG_MSG_RATE);
  105. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  106. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  107. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_MSG);
  108. msg->payload.CFG_MSG_RATE.msgClass = msgClass;
  109. msg->payload.CFG_MSG_RATE.msgId = msgId;
  110. msg->payload.CFG_MSG_RATE.rate = rate;
  111. completeMsg(&buffer, payloadSize);
  112. return buffer;
  113. }
  114. struct UBXMsgBuffer getCFG_MSG_RATES(enum UBXMessageClass msgClass, enum UBXMessageId msgId, UBXU1_t rate[])
  115. {
  116. int payloadSize = sizeof(struct UBXCFG_MSG_RATES);
  117. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  118. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  119. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_MSG);
  120. msg->payload.CFG_MSG_RATES.msgClass = msgClass;
  121. msg->payload.CFG_MSG_RATES.msgId = msgId;
  122. memcpy(msg->payload.CFG_MSG_RATES.rate, rate, 6*sizeof(u_int8_t));
  123. completeMsg(&buffer, payloadSize);
  124. return buffer;
  125. }
  126. struct UBXMsgBuffer getCFG_RST(int mode, UBXU2_t mask)
  127. {
  128. int payloadSize = sizeof(struct UBXCFG_RST);
  129. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  130. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  131. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RST);
  132. msg->payload.CFG_RST.resetMode = mode;
  133. msg->payload.CFG_RST.navBBRMask = mask;
  134. completeMsg(&buffer, payloadSize);
  135. return buffer;
  136. }
  137. struct UBXMsgBuffer getCFG_RST_OPT(int mode, enum UBXBBRSpecialSets special)
  138. {
  139. int payloadSize = sizeof(struct UBXCFG_RST);
  140. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  141. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  142. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RST);
  143. msg->payload.CFG_RST.resetMode = mode;
  144. msg->payload.CFG_RST.navBBRMask = special;
  145. completeMsg(&buffer, payloadSize);
  146. return buffer;
  147. }
  148. struct UBXMsgBuffer getCFG_TP5_POLL_OPT(enum UBXCFGTimepulses tpIdx)
  149. {
  150. int payloadSize = sizeof(struct UBXCFG_TP5_POLL_OPT);
  151. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  152. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  153. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_TP5);
  154. msg->payload.CFG_TP5_POLL_OPT.tpIdx = tpIdx;
  155. completeMsg(&buffer, payloadSize);
  156. return buffer;
  157. }
  158. struct UBXMsgBuffer getCFG_TP5(enum UBXCFGTimepulses tpIdx, UBXI2_t antCableDelay, UBXI2_t rfGroupDelay,
  159. UBXU4_t freqPeriod, UBXU4_t freqPeriodLock, UBXU4_t pulseLenRatio,
  160. UBXU4_t pulseLenRatioLock, UBXU4_t userConfigDelay, UBXU4_t flags)
  161. {
  162. int payloadSize = sizeof(struct UBXCFG_TP5);
  163. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  164. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  165. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_TP5);
  166. msg->payload.CFG_TP5.tpIdx = tpIdx;
  167. msg->payload.CFG_TP5.antCableDelay = antCableDelay;
  168. msg->payload.CFG_TP5.rfGroupDelay = rfGroupDelay;
  169. msg->payload.CFG_TP5.freqPeriod = freqPeriod;
  170. msg->payload.CFG_TP5.freqPeriodLock = freqPeriodLock;
  171. msg->payload.CFG_TP5.pulseLenRatio = pulseLenRatio;
  172. msg->payload.CFG_TP5.pulseLenRatioLock = pulseLenRatioLock;
  173. msg->payload.CFG_TP5.userConfigDelay = userConfigDelay;
  174. msg->payload.CFG_TP5.flags = flags;
  175. completeMsg(&buffer, payloadSize);
  176. return buffer;
  177. }
  178. struct UBXMsgBuffer getAID_ALM_POLL()
  179. {
  180. int payloadSize = sizeof(struct UBXAID_ALM_POLL);
  181. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  182. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  183. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALP);
  184. completeMsg(&buffer, payloadSize);
  185. return buffer;
  186. }
  187. struct UBXMsgBuffer getAID_ALM_POLL_OPT(UBXU1_t svid)
  188. {
  189. int payloadSize = sizeof(struct UBXAID_ALM_POLL_OPT);
  190. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  191. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  192. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALP);
  193. msg->payload.AID_ALM_POLL_OPT.svid = svid;
  194. completeMsg(&buffer, payloadSize);
  195. return buffer;
  196. }
  197. struct UBXMsgBuffer getAID_ALM(UBXU4_t svid, UBXU4_t week)
  198. {
  199. int payloadSize = sizeof(struct UBXAID_ALM);
  200. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  201. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  202. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALM);
  203. msg->payload.AID_ALM.svid = svid;
  204. msg->payload.AID_ALM.week = week;
  205. completeMsg(&buffer, payloadSize);
  206. return buffer;
  207. }
  208. struct UBXMsgBuffer getAID_ALM_OPT(UBXU4_t svid, UBXU4_t week, UBXU4_t dwrd[8])
  209. {
  210. int payloadSize = sizeof(struct UBXAID_ALM_OPT);
  211. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  212. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  213. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALM);
  214. msg->payload.AID_ALM_OPT.svid = svid;
  215. msg->payload.AID_ALM_OPT.week = week;
  216. memcpy(msg->payload.AID_ALM_OPT.dwrd, dwrd, 8*sizeof(UBXU4_t));
  217. completeMsg(&buffer, payloadSize);
  218. return buffer;
  219. }
  220. struct UBXMsgBuffer getAID_ALP_POLL(UBXU4_t predTow,
  221. UBXU4_t predDur,
  222. UBXI4_t age,
  223. UBXU2_t predWno,
  224. UBXU2_t almWno,
  225. UBXU1_t svs)
  226. {
  227. int payloadSize = sizeof(struct UBXAID_ALP_POLL);
  228. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  229. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  230. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALP);
  231. msg->payload.AID_ALP_POLL.predTow = predTow;
  232. msg->payload.AID_ALP_POLL.predDur = predDur;
  233. msg->payload.AID_ALP_POLL.age = age;
  234. msg->payload.AID_ALP_POLL.predWno = predWno;
  235. msg->payload.AID_ALP_POLL.almWno = almWno;
  236. msg->payload.AID_ALP_POLL.svs = svs;
  237. completeMsg(&buffer, payloadSize);
  238. return buffer;
  239. }
  240. struct UBXMsgBuffer getAID_ALP_END()
  241. {
  242. int payloadSize = sizeof(struct UBXAID_ALP_END);
  243. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  244. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  245. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALP);
  246. msg->payload.AID_ALP_END.dummy = 0xAA;
  247. completeMsg(&buffer, payloadSize);
  248. return buffer;
  249. }
  250. struct UBXMsgBuffer getAID_ALP(UBXU2_t* chunk, int chunkSize)
  251. {
  252. int payloadSize = sizeof(struct UBXAID_ALP) + chunkSize;
  253. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  254. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  255. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_ALP);
  256. memcpy(&(msg->payload) + sizeof(struct UBXAID_ALP), chunk, chunkSize);
  257. completeMsg(&buffer, payloadSize);
  258. return buffer;
  259. }
  260. struct UBXMsgBuffer getAID_AOP_POLL()
  261. {
  262. int payloadSize = sizeof(struct UBXAID_AOP_POLL);
  263. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  264. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  265. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_AOP);
  266. completeMsg(&buffer, payloadSize);
  267. return buffer;
  268. }
  269. struct UBXMsgBuffer getAID_AOP_POLL_OPT(UBXU1_t svid)
  270. {
  271. int payloadSize = sizeof(struct UBXAID_AOP_POLL_OPT);
  272. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  273. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  274. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_AOP);
  275. msg->payload.AID_AOP_POLL_OPT.svid = svid;
  276. completeMsg(&buffer, payloadSize);
  277. return buffer;
  278. }
  279. struct UBXMsgBuffer getAID_AOP(UBXU1_t svid, UBXU1_t data[59])
  280. {
  281. int payloadSize = sizeof(struct UBXAID_AOP);
  282. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  283. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  284. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_AOP);
  285. msg->payload.AID_AOP.svid = svid;
  286. memcpy(msg->payload.AID_AOP.data, data, 59*sizeof(UBXU1_t));
  287. completeMsg(&buffer, payloadSize);
  288. return buffer;
  289. }
  290. struct UBXMsgBuffer getAID_AOP_OPT(UBXU1_t svid, UBXU1_t data[59], UBXU1_t optional0[48], UBXU1_t optional1[48], UBXU1_t optional2[48])
  291. {
  292. int payloadSize = sizeof(struct UBXAID_AOP_OPT);
  293. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  294. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  295. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_AOP);
  296. msg->payload.AID_AOP_OPT.svid = svid;
  297. memcpy(msg->payload.AID_AOP_OPT.data, data, 59*sizeof(UBXU1_t));
  298. memcpy(msg->payload.AID_AOP_OPT.optional0, optional0, 48*sizeof(UBXU1_t));
  299. memcpy(msg->payload.AID_AOP_OPT.optional1, optional1, 48*sizeof(UBXU1_t));
  300. memcpy(msg->payload.AID_AOP_OPT.optional2, optional2, 48*sizeof(UBXU1_t));
  301. completeMsg(&buffer, payloadSize);
  302. return buffer;
  303. }
  304. struct UBXMsgBuffer getAID_DATA_POLL()
  305. {
  306. int payloadSize = sizeof(struct UBXAID_DATA_POLL);
  307. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  308. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  309. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_DATA);
  310. completeMsg(&buffer, payloadSize);
  311. return buffer;
  312. }
  313. struct UBXMsgBuffer getAID_EPH_POLL()
  314. {
  315. int payloadSize = sizeof(struct UBXAID_EPH_POLL);
  316. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  317. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  318. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_EPH);
  319. completeMsg(&buffer, payloadSize);
  320. return buffer;
  321. }
  322. struct UBXMsgBuffer getAID_EPH_POLL_OPT(UBXU1_t svid)
  323. {
  324. int payloadSize = sizeof(struct UBXAID_EPH_POLL_OPT);
  325. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  326. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  327. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_EPH);
  328. msg->payload.AID_EPH_POLL_OPT.svid = svid;
  329. completeMsg(&buffer, payloadSize);
  330. return buffer;
  331. }
  332. struct UBXMsgBuffer getAID_EPH(UBXU4_t svid, UBXU4_t how)
  333. {
  334. int payloadSize = sizeof(struct UBXAID_EPH);
  335. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  336. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  337. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_EPH);
  338. msg->payload.AID_EPH.svid = svid;
  339. msg->payload.AID_EPH.how = how;
  340. completeMsg(&buffer, payloadSize);
  341. return buffer;
  342. }
  343. struct UBXMsgBuffer getAID_EPH_OPT(UBXU4_t svid, UBXU4_t how, UBXU4_t sf1d[8], UBXU4_t sf2d[8], UBXU4_t sf3d[8])
  344. {
  345. int payloadSize = sizeof(struct UBXAID_EPH_OPT);
  346. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  347. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  348. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_EPH);
  349. msg->payload.AID_EPH_OPT.svid = svid;
  350. msg->payload.AID_EPH_OPT.how = how;
  351. memcpy(msg->payload.AID_EPH_OPT.sf1d, sf1d, 8*sizeof(UBXU4_t));
  352. memcpy(msg->payload.AID_EPH_OPT.sf2d, sf2d, 8*sizeof(UBXU4_t));
  353. memcpy(msg->payload.AID_EPH_OPT.sf3d, sf3d, 8*sizeof(UBXU4_t));
  354. completeMsg(&buffer, payloadSize);
  355. return buffer;
  356. }
  357. struct UBXMsgBuffer getAID_HUI_POLL()
  358. {
  359. int payloadSize = sizeof(struct UBXAID_HUI_POLL);
  360. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  361. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  362. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_HUI);
  363. completeMsg(&buffer, payloadSize);
  364. return buffer;
  365. }
  366. struct UBXMsgBuffer getAID_HUI(UBXI4_t health, UBXR4_t utcA0, UBXR4_t utcA1,
  367. UBXI4_t utcTOW, UBXI2_t utcWNT, UBXI2_t utcLS,
  368. UBXI2_t utcWNF, UBXI2_t utcDN, UBXI2_t utcLSF,
  369. UBXI2_t utcSpare, UBXR4_t klobA0, UBXR4_t klobA1,
  370. UBXR4_t klobA2, UBXR4_t klobA3, UBXR4_t klobB0,
  371. UBXR4_t klobB1, UBXR4_t klobB2, UBXR4_t klobB3,
  372. UBXX2_t flags)
  373. {
  374. int payloadSize = sizeof(struct UBXAID_HUI);
  375. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  376. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  377. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_HUI);
  378. msg->payload.AID_HUI.health = health;
  379. msg->payload.AID_HUI.utcA0 = utcA0;
  380. msg->payload.AID_HUI.utcA1 = utcA1;
  381. msg->payload.AID_HUI.utcTOW = utcTOW;
  382. msg->payload.AID_HUI.utcWNT = utcWNT;
  383. msg->payload.AID_HUI.utcLS = utcLS;
  384. msg->payload.AID_HUI.utcWNF = utcWNF;
  385. msg->payload.AID_HUI.utcDN = utcDN;
  386. msg->payload.AID_HUI.utcLSF = utcLSF;
  387. msg->payload.AID_HUI.utcSpare = utcSpare;
  388. msg->payload.AID_HUI.klobA0 = klobA0;
  389. msg->payload.AID_HUI.klobA1 = klobA1;
  390. msg->payload.AID_HUI.klobA2 = klobA2;
  391. msg->payload.AID_HUI.klobA3 = klobA3;
  392. msg->payload.AID_HUI.klobA0 = klobB0;
  393. msg->payload.AID_HUI.klobA1 = klobB1;
  394. msg->payload.AID_HUI.klobA2 = klobB2;
  395. msg->payload.AID_HUI.klobA3 = klobB3;
  396. msg->payload.AID_HUI.flags = flags;
  397. completeMsg(&buffer, payloadSize);
  398. return buffer;
  399. }
  400. struct UBXMsgBuffer getAID_INI_POLL()
  401. {
  402. int payloadSize = sizeof(struct UBXAID_INI_POLL);
  403. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  404. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  405. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_INI);
  406. completeMsg(&buffer, payloadSize);
  407. return buffer;
  408. }
  409. struct UBXMsgBuffer getAID_INI(UBXI1_t ecefXOrLat,
  410. UBXI1_t ecefYOrLat,
  411. UBXI1_t ecefZOrLat,
  412. UBXU1_t posAcc,
  413. UBXI1_t tmCfg,
  414. UBXU2_t wnoOrDate,
  415. UBXU4_t towOrDate,
  416. UBXI4_t towNs,
  417. UBXU4_t tAccMS,
  418. UBXU4_t tAccNS,
  419. UBXI4_t clkDOrFreq,
  420. UBXU4_t clkDAccOrFreqAcc,
  421. UBXX4_t flags)
  422. {
  423. int payloadSize = sizeof(struct UBXAID_INI);
  424. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  425. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  426. initMsg(msg, payloadSize, UBXMsgClassAID, UBXMsgIdAID_INI);
  427. msg->payload.AID_INI.ecefXOrLat = ecefXOrLat;
  428. msg->payload.AID_INI.ecefYOrLat = ecefYOrLat;
  429. msg->payload.AID_INI.ecefZOrLat = ecefZOrLat;
  430. msg->payload.AID_INI.posAcc = posAcc;
  431. msg->payload.AID_INI.tmCfg = tmCfg;
  432. msg->payload.AID_INI.wnoOrDate = wnoOrDate;
  433. msg->payload.AID_INI.towOrDate = towOrDate;
  434. msg->payload.AID_INI.towNs = towNs;
  435. msg->payload.AID_INI.tAccMS = tAccMS;
  436. msg->payload.AID_INI.tAccNS = tAccNS;
  437. msg->payload.AID_INI.clkDOrFreq = clkDOrFreq;
  438. msg->payload.AID_INI.clkDAccOrFreqAcc = clkDAccOrFreqAcc;
  439. msg->payload.AID_INI.flags = flags;
  440. completeMsg(&buffer, payloadSize);
  441. return buffer;
  442. }
  443. struct UBXMsgBuffer getCFG_ANT(UBXX2_t flags, struct UBXANTPins pins)
  444. {
  445. int payloadSize = sizeof(struct UBXCFG_ANT);
  446. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  447. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  448. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_ANT);
  449. msg->payload.CFG_ANT.flags = flags;
  450. msg->payload.CFG_ANT.pins = pins;
  451. completeMsg(&buffer, payloadSize);
  452. return buffer;
  453. }
  454. struct UBXMsgBuffer getCFG_ANT_POLL()
  455. {
  456. int payloadSize = sizeof(struct UBXCFG_ANT_POLL);
  457. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  458. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  459. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_ANT);
  460. completeMsg(&buffer, payloadSize);
  461. return buffer;
  462. }
  463. struct UBXMsgBuffer getCFG_CFG(UBXX4_t clearMask, UBXX4_t saveMask, UBXX4_t loadMask)
  464. {
  465. int payloadSize = sizeof(struct UBXCFG_CFG);
  466. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  467. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  468. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_CFG);
  469. msg->payload.CFG_CFG.clearMask = clearMask;
  470. msg->payload.CFG_CFG.saveMask = saveMask;
  471. msg->payload.CFG_CFG.loadMask = loadMask;
  472. completeMsg(&buffer, payloadSize);
  473. return buffer;
  474. }
  475. struct UBXMsgBuffer getCFG_CFG_OPT(UBXX4_t clearMask, UBXX4_t saveMask, UBXX4_t loadMask, UBXX1_t deviceMask)
  476. {
  477. int payloadSize = sizeof(struct UBXCFG_CFG_OPT);
  478. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  479. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  480. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_CFG);
  481. msg->payload.CFG_CFG_OPT.clearMask = clearMask;
  482. msg->payload.CFG_CFG_OPT.saveMask = saveMask;
  483. msg->payload.CFG_CFG_OPT.loadMask = loadMask;
  484. msg->payload.CFG_CFG_OPT.deviceMask = deviceMask;
  485. completeMsg(&buffer, payloadSize);
  486. return buffer;
  487. }
  488. struct UBXMsgBuffer getCFG_DAT_IN(UBXR8_t majA, UBXR8_t flat, UBXR4_t dX, UBXR4_t dY, UBXR4_t dZ, UBXR4_t rotX, UBXR4_t rotY, UBXR4_t rotZ, UBXR4_t scale)
  489. {
  490. int payloadSize = sizeof(struct UBXCFG_DAT_IN);
  491. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  492. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  493. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_CFG);
  494. msg->payload.CFG_DAT_IN.majA = majA;
  495. msg->payload.CFG_DAT_IN.flat = flat;
  496. msg->payload.CFG_DAT_IN.dX = dX;
  497. msg->payload.CFG_DAT_IN.dY = dY;
  498. msg->payload.CFG_DAT_IN.dZ = dZ;
  499. msg->payload.CFG_DAT_IN.rotX = rotX;
  500. msg->payload.CFG_DAT_IN.rotY = rotY;
  501. msg->payload.CFG_DAT_IN.rotZ = rotZ;
  502. msg->payload.CFG_DAT_IN.scale = scale;
  503. completeMsg(&buffer, payloadSize);
  504. return buffer;
  505. }
  506. struct UBXMsgBuffer getCFG_DAT_POLL()
  507. {
  508. int payloadSize = sizeof(struct UBXCFG_DAT_POLL);
  509. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  510. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  511. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_DAT);
  512. completeMsg(&buffer, payloadSize);
  513. return buffer;
  514. }
  515. struct UBXMsgBuffer getCFG_GNSS_POLL()
  516. {
  517. int payloadSize = sizeof(struct UBXCFG_GNSS_POLL);
  518. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  519. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  520. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_GNSS);
  521. completeMsg(&buffer, payloadSize);
  522. return buffer;
  523. }
  524. struct UBXMsgBuffer getCFG_GNSS(UBXU1_t msgVer,
  525. UBXU1_t numTrkChHw,
  526. UBXU1_t numTrkChUse,
  527. UBXU1_t numConfigBlocks,
  528. struct UBXCFG_GNSS_PART* gnssPart,
  529. int gnssPartCount)
  530. {
  531. int payloadSize = sizeof(struct UBXCFG_GNSS) + gnssPartCount*sizeof(struct UBXCFG_GNSS_PART);
  532. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  533. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  534. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_GNSS);
  535. msg->payload.CFG_GNSS.msgVer = msgVer;
  536. msg->payload.CFG_GNSS.numTrkChHw = numTrkChHw;
  537. msg->payload.CFG_GNSS.numTrkChUse = numTrkChUse;
  538. msg->payload.CFG_GNSS.numConfigBlocks = numConfigBlocks;
  539. memcpy(&(msg->payload.CFG_GNSS) + sizeof(struct UBXCFG_GNSS), gnssPart, gnssPartCount*sizeof(struct UBXCFG_GNSS_PART));
  540. completeMsg(&buffer, payloadSize);
  541. return buffer;
  542. }
  543. struct UBXMsgBuffer getCFG_INF_POLL(UBXU1_t protocolId)
  544. {
  545. int payloadSize = sizeof(struct UBXCFG_INF_POLL);
  546. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  547. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  548. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_INF);
  549. msg->payload.CFG_INF_POLL.protocolId = protocolId;
  550. completeMsg(&buffer, payloadSize);
  551. return buffer;
  552. }
  553. struct UBXMsgBuffer getCFG_INF(struct UBXCFG_INF_PART* infPart, int infPartCount)
  554. {
  555. int payloadSize = sizeof(struct UBXCFG_INF) + sizeof(struct UBXCFG_INF_PART)*infPartCount;
  556. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  557. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  558. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_INF);
  559. memcpy(&(msg->payload.CFG_INF) + sizeof(struct UBXCFG_INF), infPart, infPartCount*sizeof(struct UBXCFG_INF_PART));
  560. completeMsg(&buffer, payloadSize);
  561. return buffer;
  562. }
  563. struct UBXMsgBuffer getCFG_ITFM_POLL()
  564. {
  565. int payloadSize = sizeof(struct UBXCFG_ITFM_POLL);
  566. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  567. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  568. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_ITFM);
  569. completeMsg(&buffer, payloadSize);
  570. return buffer;
  571. }
  572. struct UBXMsgBuffer getCFG_ITFM(struct UBXITFMConfig config,
  573. struct UBXITFMConfig2 config2)
  574. {
  575. int payloadSize = sizeof(struct UBXCFG_ITFM);
  576. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  577. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  578. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_ITFM);
  579. msg->payload.CFG_ITFM.config = config;
  580. msg->payload.CFG_ITFM.config2 = config2;
  581. completeMsg(&buffer, payloadSize);
  582. return buffer;
  583. }
  584. struct UBXMsgBuffer getCFG_LOGFILTER_POLL()
  585. {
  586. int payloadSize = sizeof(struct UBXCFG_LOGFILTER_POLL);
  587. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  588. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  589. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_LOGFILTER);
  590. completeMsg(&buffer, payloadSize);
  591. return buffer;
  592. }
  593. struct UBXMsgBuffer getCFG_LOGFILTER(UBXU1_t version,
  594. UBXX1_t flags,
  595. UBXU2_t minIterval,
  596. UBXU2_t timeThreshold,
  597. UBXU2_t speedThreshold,
  598. UBXU4_t positionThreshold)
  599. {
  600. int payloadSize = sizeof(struct UBXCFG_LOGFILTER);
  601. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  602. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  603. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_LOGFILTER);
  604. msg->payload.CFG_LOGFILTER.version = version;
  605. msg->payload.CFG_LOGFILTER.flags = flags;
  606. msg->payload.CFG_LOGFILTER.minIterval = minIterval;
  607. msg->payload.CFG_LOGFILTER.timeThreshold = timeThreshold;
  608. msg->payload.CFG_LOGFILTER.speedThreshold = speedThreshold;
  609. msg->payload.CFG_LOGFILTER.positionThreshold = positionThreshold;
  610. completeMsg(&buffer, payloadSize);
  611. return buffer;
  612. }
  613. struct UBXMsgBuffer getCFG_NAV5_POLL()
  614. {
  615. int payloadSize = sizeof(struct UBXCFG_NAV5_POLL);
  616. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  617. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  618. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NAV5);
  619. completeMsg(&buffer, payloadSize);
  620. return buffer;
  621. }
  622. struct UBXMsgBuffer getCFG_NAV5(UBXX2_t mask,
  623. enum UBXNAV5Model dynModel,
  624. enum UBXNAV5FixMode fixMode,
  625. UBXI4_t fixedAlt,
  626. UBXU4_t fixedAltVar,
  627. UBXI1_t minElev,
  628. UBXU2_t pDop,
  629. UBXU2_t tDop,
  630. UBXU2_t pAcc,
  631. UBXU2_t tAcc,
  632. UBXU1_t staticHoldThresh,
  633. UBXU1_t dgpsTimeOut,
  634. UBXU1_t cnoThreshNumSVs,
  635. UBXU1_t cnoThresh)
  636. {
  637. int payloadSize = sizeof(struct UBXCFG_NAV5);
  638. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  639. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  640. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NAV5);
  641. msg->payload.CFG_NAV5.mask = mask;
  642. msg->payload.CFG_NAV5.dynModel = dynModel;
  643. msg->payload.CFG_NAV5.fixMode = fixMode;
  644. msg->payload.CFG_NAV5.fixedAlt = fixedAlt;
  645. msg->payload.CFG_NAV5.fixedAltVar = fixedAltVar;
  646. msg->payload.CFG_NAV5.minElev = minElev;
  647. msg->payload.CFG_NAV5.pDop = pDop;
  648. msg->payload.CFG_NAV5.tDop = tDop;
  649. msg->payload.CFG_NAV5.pAcc = pAcc;
  650. msg->payload.CFG_NAV5.tAcc = tAcc;
  651. msg->payload.CFG_NAV5.staticHoldThresh = staticHoldThresh;
  652. msg->payload.CFG_NAV5.dgpsTimeOut = dgpsTimeOut;
  653. msg->payload.CFG_NAV5.cnoThreshNumSVs = cnoThreshNumSVs;
  654. msg->payload.CFG_NAV5.cnoThresh = cnoThresh;
  655. msg->payload.CFG_NAV5.reserved2 = 0;
  656. msg->payload.CFG_NAV5.reserved3 = 0;
  657. msg->payload.CFG_NAV5.reserved4 = 0;
  658. completeMsg(&buffer, payloadSize);
  659. return buffer;
  660. }
  661. struct UBXMsgBuffer getCFG_NAVX5_POLL()
  662. {
  663. int payloadSize = sizeof(struct UBXCFG_NAVX5_POLL);
  664. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  665. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  666. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NAVX5);
  667. completeMsg(&buffer, payloadSize);
  668. return buffer;
  669. }
  670. struct UBXMsgBuffer getCFG_NAVX5(UBXU2_t version,
  671. UBXX2_t mask1,
  672. UBXU1_t minSVs,
  673. UBXU1_t maxSVs,
  674. UBXU1_t minCNO,
  675. UBXU1_t iniFix3D,
  676. UBXU2_t wknRollover,
  677. UBXU1_t usePPP,
  678. UBXU1_t aopCFG,
  679. UBXU1_t aopOrbMaxErr)
  680. {
  681. int payloadSize = sizeof(struct UBXCFG_NAVX5);
  682. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  683. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  684. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NAVX5);
  685. msg->payload.CFG_NAVX5.version = version;
  686. msg->payload.CFG_NAVX5.mask1 = mask1;
  687. msg->payload.CFG_NAVX5.reserved0 = 0;
  688. msg->payload.CFG_NAVX5.reserved1 = 0;
  689. msg->payload.CFG_NAVX5.reserved2 = 0;
  690. msg->payload.CFG_NAVX5.minSVs = minSVs;
  691. msg->payload.CFG_NAVX5.maxSVs = maxSVs;
  692. msg->payload.CFG_NAVX5.minCNO = minCNO;
  693. msg->payload.CFG_NAVX5.reserved5 = 0;
  694. msg->payload.CFG_NAVX5.iniFix3D = iniFix3D;
  695. msg->payload.CFG_NAVX5.reserved6 = 0;
  696. msg->payload.CFG_NAVX5.reserved7 = 0;
  697. msg->payload.CFG_NAVX5.reserved8 = 0;
  698. msg->payload.CFG_NAVX5.wknRollover = wknRollover;
  699. msg->payload.CFG_NAVX5.reserved9 = 0;
  700. msg->payload.CFG_NAVX5.reserved10 = 0;
  701. msg->payload.CFG_NAVX5.reserved11 = 0;
  702. msg->payload.CFG_NAVX5.usePPP = usePPP;
  703. msg->payload.CFG_NAVX5.aopCFG = aopCFG;
  704. msg->payload.CFG_NAVX5.reserved12 = 0;
  705. msg->payload.CFG_NAVX5.reserved13 = 0;
  706. msg->payload.CFG_NAVX5.aopOrbMaxErr = aopOrbMaxErr;
  707. msg->payload.CFG_NAVX5.reserved14 = 0;
  708. msg->payload.CFG_NAVX5.reserved15 = 0;
  709. msg->payload.CFG_NAVX5.reserved3 = 0;
  710. msg->payload.CFG_NAVX5.reserved4 = 0;
  711. completeMsg(&buffer, payloadSize);
  712. return buffer;
  713. }
  714. struct UBXMsgBuffer getCFG_NMEA_POLL()
  715. {
  716. int payloadSize = sizeof(struct UBXCFG_NMEA_POLL);
  717. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  718. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  719. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NMEA);
  720. completeMsg(&buffer, payloadSize);
  721. return buffer;
  722. }
  723. struct UBXMsgBuffer getCFG_NMEA(UBXX1_t filter,
  724. UBXU1_t nmeaVersion,
  725. UBXU1_t numSV,
  726. UBXX1_t flags,
  727. UBXX4_t gnssToFilter,
  728. enum UBXNMEASVNumbering svNumbering,
  729. enum UBXNMEATalkerIds mainTalkerId,
  730. enum UBXNMEAGSVTalkerIds gsvTalkerId)
  731. {
  732. int payloadSize = sizeof(struct UBXCFG_NMEA);
  733. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  734. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  735. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NMEA);
  736. msg->payload.CFG_NMEA.filter = filter;
  737. msg->payload.CFG_NMEA.nmeaVersion = nmeaVersion;
  738. msg->payload.CFG_NMEA.numSV = numSV;
  739. msg->payload.CFG_NMEA.flags = flags;
  740. msg->payload.CFG_NMEA.gnssToFilter = gnssToFilter;
  741. msg->payload.CFG_NMEA.svNumbering = svNumbering;
  742. msg->payload.CFG_NMEA.mainTalkerId = mainTalkerId;
  743. msg->payload.CFG_NMEA.gsvTalkerId = gsvTalkerId;
  744. msg->payload.CFG_NMEA.reserved = 0;
  745. completeMsg(&buffer, payloadSize);
  746. return buffer;
  747. }
  748. struct UBXMsgBuffer getCFG_NVS(UBXX4_t clearMask,
  749. UBXX4_t saveMask,
  750. UBXX4_t loadMask,
  751. UBXX1_t deviceMask)
  752. {
  753. int payloadSize = sizeof(struct UBXCFG_NVS);
  754. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  755. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  756. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_NVS);
  757. msg->payload.CFG_NVS.clearMask = clearMask;
  758. msg->payload.CFG_NVS.saveMask = saveMask;
  759. msg->payload.CFG_NVS.loadMask = loadMask;
  760. msg->payload.CFG_NVS.deviceMask = deviceMask;
  761. completeMsg(&buffer, payloadSize);
  762. return buffer;
  763. }
  764. struct UBXMsgBuffer getCFG_PM2_POLL()
  765. {
  766. int payloadSize = sizeof(struct UBXCFG_PM2_POLL);
  767. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  768. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  769. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_PM2);
  770. completeMsg(&buffer, payloadSize);
  771. return buffer;
  772. }
  773. struct UBXMsgBuffer getCFG_PM2(struct UBXCFG_PM2Flags flags, UBXU4_t updatePeriod, UBXU4_t searchPeriod, UBXU4_t gridOffset, UBXU2_t onTime, UBXU2_t minAcqTime)
  774. {
  775. int payloadSize = sizeof(struct UBXCFG_PM2);
  776. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  777. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  778. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_PM2);
  779. msg->payload.CFG_PM2.flags = flags;
  780. msg->payload.CFG_PM2.updatePeriod = updatePeriod;
  781. msg->payload.CFG_PM2.searchPeriod = searchPeriod;
  782. msg->payload.CFG_PM2.gridOffset = gridOffset;
  783. msg->payload.CFG_PM2.onTime = onTime;
  784. msg->payload.CFG_PM2.minAcqTime = minAcqTime;
  785. completeMsg(&buffer, payloadSize);
  786. return buffer;
  787. }
  788. struct UBXMsgBuffer getCFG_PRT_POLL()
  789. {
  790. int payloadSize = sizeof(struct UBXCFG_PRT_POLL);
  791. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  792. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  793. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_PRT);
  794. completeMsg(&buffer, payloadSize);
  795. return buffer;
  796. }
  797. struct UBXMsgBuffer getCFG_PRT_POLL_OPT(UBXU1_t portId)
  798. {
  799. int payloadSize = sizeof(struct UBXCFG_PRT_POLL_OPT);
  800. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  801. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  802. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_PRT);
  803. msg->payload.CFG_PRT_POLL_OPT.portId = portId;
  804. completeMsg(&buffer, payloadSize);
  805. return buffer;
  806. }
  807. struct UBXMsgBuffer getCFG_PRT_UART()
  808. {
  809. //TODO
  810. struct UBXMsgBuffer buffer = createBuffer(0);
  811. return buffer;
  812. }
  813. struct UBXMsgBuffer getCFG_PRT_USB()
  814. {
  815. //TODO
  816. struct UBXMsgBuffer buffer = createBuffer(0);
  817. return buffer;
  818. }
  819. struct UBXMsgBuffer getCFG_PRT_SPI()
  820. {
  821. //TODO
  822. struct UBXMsgBuffer buffer = createBuffer(0);
  823. return buffer;
  824. }
  825. struct UBXMsgBuffer getCFG_PRT_DDC()
  826. {
  827. //TODO
  828. struct UBXMsgBuffer buffer = createBuffer(0);
  829. return buffer;
  830. }
  831. struct UBXMsgBuffer getCFG_RATE_POLL()
  832. {
  833. int payloadSize = sizeof(struct UBXCFG_RATE_POLL);
  834. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  835. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  836. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RATE);
  837. completeMsg(&buffer, payloadSize);
  838. return buffer;
  839. }
  840. struct UBXMsgBuffer getCFG_RATE(UBXU2_t measRate, UBXU2_t navRate, UBXU2_t timeRef)
  841. {
  842. int payloadSize = sizeof(struct UBXCFG_RATE);
  843. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  844. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  845. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RATE);
  846. msg->payload.CFG_RATE.measRate = measRate;
  847. msg->payload.CFG_RATE.navRate = navRate;
  848. msg->payload.CFG_RATE.timeRef = timeRef;
  849. completeMsg(&buffer, payloadSize);
  850. return buffer;
  851. }
  852. struct UBXMsgBuffer getCFG_RINV(UBXX1_t flags, UBXU1_t* data, int dataSize)
  853. {
  854. int payloadSize = sizeof(struct UBXCFG_RINV) + dataSize*sizeof(UBXU1_t);
  855. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  856. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  857. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RINV);
  858. msg->payload.CFG_RINV.flags = flags;
  859. memcpy(&(msg->payload.CFG_RINV) + sizeof(struct UBXCFG_RINV), data, dataSize*sizeof(UBXU1_t));
  860. completeMsg(&buffer, payloadSize);
  861. return buffer;
  862. }
  863. struct UBXMsgBuffer getCFG_RINV_POLL()
  864. {
  865. int payloadSize = sizeof(struct UBXCFG_RINV_POLL);
  866. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  867. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  868. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RINV);
  869. completeMsg(&buffer, payloadSize);
  870. return buffer;
  871. }
  872. struct UBXMsgBuffer getCFG_RXM(UBXU1_t lpMode)
  873. {
  874. int payloadSize = sizeof(struct UBXCFG_RXM);
  875. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  876. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  877. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RXM);
  878. msg->payload.CFG_RXM.reserved1 = 8;
  879. msg->payload.CFG_RXM.lpMode = lpMode;
  880. completeMsg(&buffer, payloadSize);
  881. return buffer;
  882. }
  883. struct UBXMsgBuffer getCFG_RXM_POLL()
  884. {
  885. int payloadSize = sizeof(struct UBXCFG_RXM_POLL);
  886. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  887. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  888. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_RXM);
  889. completeMsg(&buffer, payloadSize);
  890. return buffer;
  891. }
  892. struct UBXMsgBuffer getCFG_SBAS(UBXX1_t mode, UBXX1_t usage, UBXU1_t maxSBAS, UBXX1_t scanmode2, UBXX4_t scanmode1)
  893. {
  894. int payloadSize = sizeof(struct UBXCFG_SBAS);
  895. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  896. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  897. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_SBAS);
  898. msg->payload.CFG_SBAS.mode = mode;
  899. msg->payload.CFG_SBAS.usage = usage;
  900. msg->payload.CFG_SBAS.maxSBAS = maxSBAS;
  901. msg->payload.CFG_SBAS.scanmode2 = scanmode2;
  902. msg->payload.CFG_SBAS.scanmode1 = scanmode1;
  903. completeMsg(&buffer, payloadSize);
  904. return buffer;
  905. }
  906. struct UBXMsgBuffer getCFG_SBAS_POLL()
  907. {
  908. int payloadSize = sizeof(struct UBXCFG_SBAS_POLL);
  909. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  910. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  911. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_SBAS);
  912. completeMsg(&buffer, payloadSize);
  913. return buffer;
  914. }
  915. struct UBXMsgBuffer getCFG_TP5_POLL()
  916. {
  917. int payloadSize = sizeof(struct UBXCFG_TP5_POLL);
  918. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  919. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  920. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_TP5);
  921. completeMsg(&buffer, payloadSize);
  922. return buffer;
  923. }
  924. struct UBXMsgBuffer getCFG_USB_POLL()
  925. {
  926. int payloadSize = sizeof(struct UBXCFG_USB_POLL);
  927. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  928. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  929. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_USB);
  930. completeMsg(&buffer, payloadSize);
  931. return buffer;
  932. }
  933. struct UBXMsgBuffer getCFG_USB(UBXU2_t vendorId,
  934. UBXU2_t productId,
  935. UBXU2_t powerConsumption,
  936. UBXX2_t flags,
  937. UBXCH_t* vendorString,
  938. UBXCH_t* productString,
  939. UBXCH_t* serialNumber)
  940. {
  941. int payloadSize = sizeof(struct UBXCFG_USB);
  942. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  943. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  944. initMsg(msg, payloadSize, UBXMsgClassCFG, UBXMsgIdCFG_USB);
  945. msg->payload.CFG_USB.vendorId = vendorId;
  946. msg->payload.CFG_USB.productId = productId;
  947. msg->payload.CFG_USB.reserved1 = 0;
  948. msg->payload.CFG_USB.reserved2 = 1;
  949. msg->payload.CFG_USB.powerConsumption = powerConsumption;
  950. msg->payload.CFG_USB.flags = flags;
  951. int vendorStringSize = strlen(vendorString)>32?32:strlen(vendorString);
  952. memcpy(msg->payload.CFG_USB.vendorString, vendorString, vendorStringSize);
  953. int productStringSize = strlen(productString)>32?32:strlen(productString);
  954. memcpy(msg->payload.CFG_USB.productString, productString, productStringSize);
  955. int serialNumberSize = strlen(serialNumber)>32?32:strlen(serialNumber);
  956. memcpy(msg->payload.CFG_USB.serialNumber, serialNumber, serialNumberSize);
  957. completeMsg(&buffer, payloadSize);
  958. return buffer;
  959. }
  960. struct UBXMsgBuffer getLOG_CREATE(UBXX1_t logCfg, UBXU1_t logSize, UBXU4_t userDefinedSize)
  961. {
  962. int payloadSize = sizeof(struct UBXLOG_CREATE);
  963. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  964. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  965. initMsg(msg, payloadSize, UBXMsgClassLOG, UBXMsgIdLOG_CREATE);
  966. msg->payload.LOG_CREATE.version = 0;
  967. msg->payload.LOG_CREATE.logCfg = logCfg;
  968. msg->payload.LOG_CREATE.reserved = 0;
  969. msg->payload.LOG_CREATE.logSize = logSize;
  970. msg->payload.LOG_CREATE.userDefinedSize = userDefinedSize;
  971. completeMsg(&buffer, payloadSize);
  972. return buffer;
  973. }
  974. struct UBXMsgBuffer getLOG_ERASE()
  975. {
  976. int payloadSize = sizeof(struct UBXLOG_ERASE);
  977. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  978. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  979. initMsg(msg, payloadSize, UBXMsgClassLOG, UBXMsgIdLOG_ERASE);
  980. completeMsg(&buffer, payloadSize);
  981. return buffer;
  982. }
  983. struct UBXMsgBuffer getLOG_FINDTIME_IN(UBXU2_t year, UBXU1_t month, UBXU1_t day, UBXU1_t hour, UBXU1_t minute, UBXU1_t second)
  984. {
  985. int payloadSize = sizeof(struct UBXLOG_FINDTIME_IN);
  986. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  987. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  988. initMsg(msg, payloadSize, UBXMsgClassLOG, UBXMsgIdLOG_FINDTIME);
  989. msg->payload.LOG_FINDTIME_IN.version = 0;
  990. msg->payload.LOG_FINDTIME_IN.type = 0;
  991. msg->payload.LOG_FINDTIME_IN.year = year;
  992. msg->payload.LOG_FINDTIME_IN.month = month;
  993. msg->payload.LOG_FINDTIME_IN.day = day;
  994. msg->payload.LOG_FINDTIME_IN.hour = hour;
  995. msg->payload.LOG_FINDTIME_IN.minute = minute;
  996. msg->payload.LOG_FINDTIME_IN.second = second;
  997. completeMsg(&buffer, payloadSize);
  998. return buffer;
  999. }
  1000. struct UBXMsgBuffer getLOG_INFO_POLL()
  1001. {
  1002. int payloadSize = sizeof(struct UBXLOG_INFO_POLL);
  1003. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1004. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1005. initMsg(msg, payloadSize, UBXMsgClassLOG, UBXMsgIdLOG_INFO);
  1006. completeMsg(&buffer, payloadSize);
  1007. return buffer;
  1008. }
  1009. struct UBXMsgBuffer getLOG_RETRIEVE(UBXU4_t startNumber,
  1010. UBXU4_t entryCount,
  1011. UBXU1_t version)
  1012. {
  1013. int payloadSize = sizeof(struct UBXLOG_RETRIEVE);
  1014. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1015. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1016. initMsg(msg, payloadSize, UBXMsgClassLOG, UBXMsgIdLOG_RETRIEVE);
  1017. msg->payload.LOG_RETRIEVE.startNumber = startNumber;
  1018. msg->payload.LOG_RETRIEVE.entryCount = entryCount;
  1019. msg->payload.LOG_RETRIEVE.version = version;
  1020. completeMsg(&buffer, payloadSize);
  1021. return buffer;
  1022. }
  1023. struct UBXMsgBuffer getLOG_STRING()
  1024. {
  1025. int payloadSize = sizeof(struct UBXLOG_STRING);
  1026. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1027. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1028. initMsg(msg, payloadSize, UBXMsgClassLOG, UBXMsgIdLOG_STRING);
  1029. completeMsg(&buffer, payloadSize);
  1030. return buffer;
  1031. }
  1032. struct UBXMsgBuffer getMON_VER_POLL()
  1033. {
  1034. int payloadSize = sizeof(struct UBXMON_VER_POLL);
  1035. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1036. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1037. initMsg(msg, payloadSize, UBXMsgClassMON, UBXMsgIdMON_VER);
  1038. completeMsg(&buffer, payloadSize);
  1039. return buffer;
  1040. }
  1041. struct UBXMsgBuffer getRXM_ALM_POLL()
  1042. {
  1043. int payloadSize = sizeof(struct UBXRXM_ALM_POLL);
  1044. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1045. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1046. initMsg(msg, payloadSize, UBXMsgClassRXM, UBXMsgIdRXM_ALM);
  1047. completeMsg(&buffer, payloadSize);
  1048. return buffer;
  1049. }
  1050. struct UBXMsgBuffer getRXM_ALM_POLL_OPT(UBXU1_t svid)
  1051. {
  1052. int payloadSize = sizeof(struct UBXRXM_ALM_POLL_OPT);
  1053. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1054. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1055. initMsg(msg, payloadSize, UBXMsgClassRXM, UBXMsgIdRXM_ALM);
  1056. msg->payload.RXM_ALM_POLL_OPT.svid = svid;
  1057. completeMsg(&buffer, payloadSize);
  1058. return buffer;
  1059. }
  1060. struct UBXMsgBuffer getRXM_EPH_POLL()
  1061. {
  1062. int payloadSize = sizeof(struct UBXRXM_EPH_POLL);
  1063. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1064. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1065. initMsg(msg, payloadSize, UBXMsgClassRXM, UBXMsgIdRXM_EPH);
  1066. completeMsg(&buffer, payloadSize);
  1067. return buffer;
  1068. }
  1069. struct UBXMsgBuffer getRXM_EPH_POLL_OPT(UBXU1_t svid)
  1070. {
  1071. int payloadSize = sizeof(struct UBXRXM_EPH_POLL_OPT);
  1072. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1073. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1074. initMsg(msg, payloadSize, UBXMsgClassRXM, UBXMsgIdRXM_ALM);
  1075. msg->payload.RXM_ALM_POLL_OPT.svid = svid;
  1076. completeMsg(&buffer, payloadSize);
  1077. return buffer;
  1078. }
  1079. struct UBXMsgBuffer getRXM_PMREQ(UBXU4_t duration, UBXX4_t flags)
  1080. {
  1081. int payloadSize = sizeof(struct UBXRXM_PMREQ);
  1082. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1083. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1084. initMsg(msg, payloadSize, UBXMsgClassRXM, UBXMsgIdRXM_PMREQ);
  1085. msg->payload.RXM_PMREQ.duration = duration;
  1086. msg->payload.RXM_PMREQ.flags = flags;
  1087. completeMsg(&buffer, payloadSize);
  1088. return buffer;
  1089. }
  1090. struct UBXMsgBuffer getRXM_SVSI(UBXU4_t iTOW,
  1091. UBXI2_t week,
  1092. UBXU1_t numVis,
  1093. UBXU1_t numSV,
  1094. struct UBXRXM_SVSI_PART* svsiPart,
  1095. int svsiPartCount)
  1096. {
  1097. int payloadSize = sizeof(struct UBXRXM_SVSI) + svsiPartCount*sizeof(struct UBXRXM_SVSI_PART);
  1098. struct UBXMsgBuffer buffer = createBuffer(payloadSize);
  1099. struct UBXMsg* msg = (struct UBXMsg*)buffer.data;
  1100. initMsg(msg, payloadSize, UBXMsgClassRXM, UBXMsgIdRXM_SVSI);
  1101. msg->payload.RXM_SVSI.iTOW = iTOW;
  1102. msg->payload.RXM_SVSI.week = week;
  1103. msg->payload.RXM_SVSI.numVis = numVis;
  1104. msg->payload.RXM_SVSI.numSV = numSV;
  1105. memcpy(&(msg->payload.RXM_SVSI) + sizeof(struct UBXRXM_SVSI), svsiPart, svsiPartCount*sizeof(struct UBXRXM_SVSI_PART));
  1106. completeMsg(&buffer, payloadSize);
  1107. return buffer;
  1108. }
  1109. /*!
  1110. * \defgroup Functions
  1111. */
  1112. /*!
  1113. * \defgroup Enumerations
  1114. */
  1115. /*!
  1116. * \defgroup Types
  1117. */
  1118. /*! \addtogroup Enumerations
  1119. * @{
  1120. */
  1121. /*!
  1122. * \enum UBXMessageClass
  1123. * \brief UBXMessageClass is a grouping of messages which are related to each other.
  1124. * The following table lists all the current message classes.
  1125. * \var UBXMsgClassNAV
  1126. * Navigation Results: Position, Speed, Time, Acc, Heading, DOP, SVs used
  1127. * \var UBXMsgClassRXM
  1128. * Receiver Manager Messages: Satellite Status, RTC Status
  1129. * \var UBXMsgClassINF
  1130. * Information Messages: Printf-Style Messages, with IDs such as Error, Warning, Notice
  1131. * \var UBXMsgClassACK
  1132. * Ack/Nack Messages: as replies to CFG Input Messages
  1133. * \var UBXMsgClassCFG
  1134. * Configuration Input Messages: Set Dynamic Model, Set DOP Mask, Set Baud Rate, etc.
  1135. * \var UBXMsgClassMON
  1136. * Monitoring Messages: Comunication Status, CPU Load, Stack Usage, Task Status
  1137. * \var UBXMsgClassAID
  1138. * AssistNow Aiding Messages: Ephemeris, Almanac, other A-GPS data input
  1139. * \var UBXMsgClassTIM
  1140. * Timing Messages: Time Pulse Output, Timemark Results
  1141. * \var UBXMsgClassLOG
  1142. * Logging Messages: Log creation, deletion, info and retrieval
  1143. * \var UBXMsgClassInvalid
  1144. * Default invalid message class
  1145. */
  1146. /*!
  1147. * \enum UBXMessageId
  1148. * \brief UBXMessageId is a type of messages
  1149. * \var UBXMsgIdACK_NACK
  1150. * Message Acknowledged
  1151. * \var UBXMsgIdACK_ACK
  1152. * Message Not-Acknowledged
  1153. *
  1154. * \var UBXMsgIdAID_ALM
  1155. * GPS Aiding Almanac Data
  1156. * \var UBXMsgIdAID_ALPSRV
  1157. * AlmanacPlus data
  1158. * \var UBXMsgIdAID_ALP
  1159. * ALP file data transfer
  1160. * \var UBXMsgIdAID_AOP
  1161. * AssistNow Autonomous data
  1162. * \var UBXMsgIdAID_DATA
  1163. * GPS Initial Aiding Data
  1164. * \var UBXMsgIdAID_EPH
  1165. * GPS Aiding Ephemeris Data
  1166. * \var UBXMsgIdAID_HUI
  1167. * GPS Health, UTC and ionosphere parameters
  1168. * \var UBXMsgIdAID_INI
  1169. * Aiding position, time, frequency, clock drift
  1170. * \var UBXMsgIdAID_REQ
  1171. * Sends a poll (AID-DATA) for all GPS Aiding Data
  1172. *
  1173. * \var UBXMsgIdCFG_ANT
  1174. * Antenna Control Settings
  1175. * \var UBXMsgIdCFG_CFG
  1176. * Clear, Save and Load configurations
  1177. * \var UBXMsgIdCFG_DAT
  1178. * Datum Setting
  1179. * \var UBXMsgIdCFG_GNSS
  1180. * GNSS system configuration
  1181. * \var UBXMsgIdCFG_INF
  1182. * Information message configuration
  1183. * \var UBXMsgIdCFG_ITFM
  1184. * Jamming/Interference Monitor configuration.
  1185. * \var UBXMsgIdCFG_LOGFILTER
  1186. * Data Logger Configuration
  1187. * \var UBXMsgIdCFG_MSG
  1188. * Message Configuration
  1189. * \var UBXMsgIdCFG_NAV5
  1190. * Navigation Engine Settings
  1191. * \var UBXMsgIdCFG_NAVX5
  1192. * Navigation Engine Expert Settings
  1193. * \var UBXMsgIdCFG_NMEA
  1194. * NMEA protocol configuration
  1195. * \var UBXMsgIdCFG_NVS
  1196. * Clear, Save and Load non-volatile storage data
  1197. * \var UBXMsgIdCFG_PM2
  1198. * Extended Power Management configuration
  1199. * \var UBXMsgIdCFG_PRT
  1200. * Ports Configuration
  1201. * \var UBXMsgIdCFG_RATE
  1202. * Navigation/Measurement Rate Settings
  1203. * \var UBXMsgIdCFG_RINV
  1204. * Contents of Remote Inventory
  1205. * \var UBXMsgIdCFG_RST
  1206. * Reset Receiver / Clear Backup Data Structures
  1207. * \var UBXMsgIdCFG_RXM
  1208. * RXM configuration
  1209. * \var UBXMsgIdCFG_SBAS
  1210. * SBAS Configuration
  1211. * \var UBXMsgIdCFG_TP5
  1212. * Time Pulse Parameters
  1213. * \var UBXMsgIdCFG_USB
  1214. * USB Configuration
  1215. *
  1216. * \var UBXMsgIdINF_DEBUG
  1217. * ASCII String output, indicating debug output
  1218. * \var UBXMsgIdINF_ERROR
  1219. * ASCII String output, indicating an error
  1220. * \var UBXMsgIdINF_NOTICE
  1221. * ASCII String output, with informational contents
  1222. * \var UBXMsgIdINF_TEST
  1223. * ASCII String output, indicating test output
  1224. * \var UBXMsgIdINF_WARNING
  1225. * ASCII String output, indicating a warning
  1226. *
  1227. * \var UBXMsgIdLOG_CREATE
  1228. * Create Log File
  1229. * \var UBXMsgIdLOG_ERASE
  1230. * Erase Logged Data
  1231. * \var UBXMsgIdLOG_FINDTIME
  1232. * Find the index of the first log entry <= given time
  1233. * \var UBXMsgIdLOG_INFO
  1234. * Log information
  1235. * \var UBXMsgIdLOG_RETRIEVEPOS
  1236. * Position fix log entry
  1237. * \var UBXMsgIdLOG_RETRIEVESTRING
  1238. * Byte string log entry
  1239. * \var UBXMsgIdLOG_RETRIEVE
  1240. * Request log data
  1241. * \var UBXMsgIdLOG_STRING
  1242. * Store arbitrary string in on-board Flash memory
  1243. *
  1244. * \var UBXMsgIdMON_HW2
  1245. * Extended Hardware Status
  1246. * \var UBXMsgIdMON_HW
  1247. * Hardware Status
  1248. * \var UBXMsgIdMON_IO
  1249. * I/O Subsystem Status
  1250. * \var UBXMsgIdMON_MSGPP
  1251. * Message Parse and Process Status
  1252. * \var UBXMsgIdMON_RXBUF
  1253. * Receiver Buffer Status
  1254. * \var UBXMsgIdMON_RXR
  1255. * Receiver Status Information
  1256. * \var UBXMsgIdMON_TXBUF
  1257. * Transmitter Buffer Status
  1258. * \var UBXMsgIdMON_VER
  1259. * Receiver/Software Version
  1260. *
  1261. * \var UBXMsgIdNAV_AOPSTATUS
  1262. * AssistNow Autonomous Status
  1263. * \var UBXMsgIdNAV_CLOCK
  1264. * Clock Solution
  1265. * \var UBXMsgIdNAV_DGPS
  1266. * DGPS Data Used for NAV
  1267. * \var UBXMsgIdNAV_DOP
  1268. * Dilution of precision
  1269. * \var UBXMsgIdNAV_POSECEF
  1270. * Position Solution in ECEF
  1271. * \var UBXMsgIdNAV_POSLLH
  1272. * Geodetic Position Solution
  1273. * \var UBXMsgIdNAV_PVT
  1274. * Navigation Position Velocity Time Solution
  1275. * \var UBXMsgIdNAV_SBAS
  1276. * SBAS Status Data
  1277. * \var UBXMsgIdNAV_SOL
  1278. * Navigation Solution Information
  1279. * \var UBXMsgIdNAV_STATUS
  1280. * Receiver Navigation Status
  1281. * \var UBXMsgIdNAV_SVINFO
  1282. * Space Vehicle Information
  1283. * \var UBXMsgIdNAV_TIMEGPS
  1284. * GPS Time Solution
  1285. * \var UBXMsgIdNAV_TIMEUTC
  1286. * UTC Time Solution
  1287. * \var UBXMsgIdNAV_VELECEF
  1288. * Velocity Solution in ECEF
  1289. * \var UBXMsgIdNAV_VELNED
  1290. * Velocity Solution in NED
  1291. *
  1292. * \var UBXMsgIdRXM_ALM
  1293. * GPS Constellation Almanac Data
  1294. * \var UBXMsgIdRXM_EPH
  1295. * GPS Constellation Ephemeris Data
  1296. * \var UBXMsgIdRXM_PMREQ
  1297. * Requests a Power Management task
  1298. * \var UBXMsgIdRXM_RAW
  1299. * Raw Measurement Data
  1300. * \var UBXMsgIdRXM_SFRB
  1301. * Subframe Buffer
  1302. * \var UBXMsgIdRXM_SVSI
  1303. * SV Status Info
  1304. *
  1305. * \var UBXMsgIdTIM_TM2
  1306. * Time mark data
  1307. * \var UBXMsgIdTIM_TP
  1308. * Time Pulse Timedata
  1309. * \var UBXMsgIdTIM_VRFY
  1310. * Sourced Time Verification
  1311. *
  1312. * \var UBXMsgIdInvalid
  1313. * Default invalid message identificator
  1314. */
  1315. /*!
  1316. * \enum UBXResetMode
  1317. * \brief UBXResetMode describes possible reset modes
  1318. * for #UBXCFG_RST message.
  1319. * \var UBXHardwareReset
  1320. * Hardware reset (Watchdog) immediately
  1321. * \var UBXControlledReset
  1322. * Controlled Software reset
  1323. * \var UBXControlledResetGNSSOnly
  1324. * Controlled Software reset (GNSS only)
  1325. * \var UBXHardwareResetAfterShutdown
  1326. * Hardware reset (Watchdog) after
  1327. * \var UBXControlledGNSSStop
  1328. * Controlled GNSS stop
  1329. * \var UBXControlledGNSSStart
  1330. * Controlled GNSS start
  1331. */
  1332. /*!
  1333. * \enum UBXBBRSpecialSets
  1334. * \brief UBXBBRSpecialSets implements special sets for
  1335. * #UBXCFG_RST message.
  1336. * \var UBXBBRHotstart
  1337. * Hotstart
  1338. * \var UBXBBRWarmstart
  1339. * Warmstart
  1340. * \var UBXBBRColdstart
  1341. * Coldstart
  1342. */
  1343. /*!
  1344. * \enum UBXBBRMask
  1345. * \brief UBXBBRMask implements members for BBR(built-in battery-backed RAM) bitmask
  1346. * for #UBXCFG_RST message.
  1347. * \var UBXBBReph
  1348. * Ephemeris
  1349. * \var UBXBBRalm
  1350. * Almanac
  1351. * \var UBXBBRhealth
  1352. * Health
  1353. * \var UBXBBRklob
  1354. * Klobuchar parameters
  1355. * \var UBXBBRpos
  1356. * Position
  1357. * \var UBXBBRclkd
  1358. * Clock Drift
  1359. * \var UBXBBRosc
  1360. * Oscillator Parameter
  1361. * \var UBXBBRutc
  1362. * UTC Correction + GPS Leap Seconds Parameters
  1363. * \var UBXBBRrtc
  1364. * RTC
  1365. * \var UBXBBRsfdr
  1366. * SFDR Parameters
  1367. * \var UBXBBRvmon
  1368. * SFDR Vehicle Monitoring Parameters
  1369. * \var UBXBBRtct
  1370. * TCT Parameters
  1371. * \var UBXBBRaop
  1372. * Autonomous Orbit Parameters
  1373. */
  1374. /*!
  1375. * \enum UBXHUIFlags
  1376. * \brief UBXHUIFlags implements HUI flags bitmask
  1377. * for #UBXAID_HUI message.
  1378. * \var UBXHUIHealthValid
  1379. * Healthmask field in this message is valid
  1380. * \var UBXHUIUTCValid
  1381. * UTC parameter fields in this message are valid
  1382. * \var UBXHUIKlobValid
  1383. * Klobuchar parameter fields in this message are valid
  1384. */
  1385. /*!
  1386. * \enum UBXINItmCfg
  1387. * \brief UBXINItmCfg implements Time mark configuration bitmask
  1388. * for #UBXAID_INI message.
  1389. * \var UBXINIfEdge
  1390. * Use falling edge (default rising)
  1391. * \var UBXINItm1
  1392. * Time mark on extint 1 (default extint 0)
  1393. * \var UBXINIf1
  1394. * Frequency on extint 1 (default extint 0)
  1395. */
  1396. /*!
  1397. * \enum UBXINIFlags
  1398. * \brief UBXINIFlags implements INI flags bitmask
  1399. * for #UBXAID_INI message.
  1400. * \var UBXINIpos
  1401. * Position is valid
  1402. * \var UBXINItime
  1403. * Time is valid
  1404. * \var UBXINIclockD
  1405. * Clock drift data contains valid clock drift, must not be set together with clockF
  1406. * \var UBXINItp
  1407. * Use time pulse
  1408. * \var UBXINIclockF
  1409. * Clock drift data contains valid frequency, must not be set together with clockD
  1410. * \var UBXINIlla
  1411. * Position is given in lat/long/alt (default is ECEF)
  1412. * \var UBXINIaltInv
  1413. * Altitude is not valid, in case lla was set
  1414. * \var UBXINIprevTm
  1415. * Use time mark received before AID-INI message (default uses mark received after message)
  1416. * \var UBXINIutc
  1417. * Time is given as UTC date/time (default is GPS wno/tow)
  1418. */
  1419. /*!
  1420. * \enum UBXANTFlags
  1421. * \brief UBXANTFlags implements ANT flags bitmask
  1422. * for #UBXCFG_ANT message.
  1423. * \var UBXANTsvcs
  1424. * Enable Antenna Supply Voltage Control Signal
  1425. * \var UBXANTscd
  1426. * Enable Short Circuit Detection
  1427. * \var UBXANTocd
  1428. * Enable Open Circuit Detection
  1429. * \var UBXANTpdwnOnSCD
  1430. * Power Down Antenna supply if Short Circuit is detected. (only in combination with Bit 1)
  1431. * \var UBXANTrecovery
  1432. * Enable automatic recovery from short state
  1433. */
  1434. /*!
  1435. * \enum UBXCFGMask
  1436. * \brief UBXCFGMask implements CFG flags bitmask
  1437. * for #UBXCFG_CFG message and #UBXCFG_NVS.
  1438. * \var UBXCFGioPort
  1439. * Port Settings\n
  1440. * \note #UBXCFG_CFG only
  1441. * \var UBXCFGmsgConf
  1442. * Message Configuration\n
  1443. * \note#UBXCFG_CFG only
  1444. * \var UBXCFGinfMsg
  1445. * INF Message Configuration\n
  1446. * \note#UBXCFG_CFG only
  1447. * \var UBXCFGnavConf
  1448. * Navigation Configuration\n
  1449. * \note#UBXCFG_CFG only
  1450. * \var UBXCFGrxmConf
  1451. * Receiver Manager Configuration\n
  1452. * \note#UBXCFG_CFG only
  1453. * \var UBXCFGrinvConf
  1454. * Remote Inventory Configuration\n
  1455. * \note#UBXCFG_CFG only
  1456. * \var UBXCFGantConf
  1457. * Antenna Configuration\n
  1458. * \note#UBXCFG_CFG only
  1459. * \var UBXCFGalm
  1460. * GPS Almanac data\n
  1461. * \note#UBXCFG_NVS only
  1462. * \var UBXCFGaopConf
  1463. * AOP data\n
  1464. * \note#UBXCFG_NVS only
  1465. */
  1466. /*!
  1467. * \enum UBXCFGMask
  1468. * \brief UBXCFGMask implements CFG flags bitmask
  1469. * for #UBXCFG_CFG message and #UBXCFG_NVS.
  1470. * Mask selects the devices for #UBXCFG_CFG
  1471. * and #UBXCFG_NVS commands.
  1472. * \var UBXCFGdevBBR
  1473. * built-in battery-backed RAM
  1474. * \var UBXCFGdevFlash
  1475. * external flash memory
  1476. * \var UBXCFGdevEEPROM
  1477. * external EEPROM
  1478. * \var UBXCFGdevSpiFlash
  1479. * external SPI Flash
  1480. */
  1481. /*!
  1482. * \enum UBXCFGTimepulses
  1483. * \brief UBXCFGTimepulses contains possible timepulse
  1484. * selections for #UBXCFG_TP5 message.
  1485. * \var UBXCFGTimepulse
  1486. * TIMEPULSE selection
  1487. * \var UBXCFGTimepulse2
  1488. * TIMEPULSE2 selection
  1489. */
  1490. /*!
  1491. * \enum UBXCFGTimepulseFlags
  1492. * \brief UBXCFGTimepulseFlags implements timepulse flags
  1493. * for #UBXCFG_TP5 message.
  1494. * \var UBXCFGTimepulseActive
  1495. * if set enable time pulse; if pin assigned to another function, other function takes precedence
  1496. * \var UBXCFGTimepulseLockGpsFreq
  1497. * if set synchronize time pulse to GPS as soon as GPS time is valid, otherwise use local clock
  1498. * \var UBXCFGTimepulseLockedOtherSet
  1499. * if set use 'freqPeriodLock' and 'pulseLenRatioLock' as soon as GPS time is valid and 'freqPeriod' and
  1500. * 'pulseLenRatio' if GPS time is invalid,
  1501. * if flag is cleared 'freqPeriod' and 'pulseLenRatio' used regardless of GPS time
  1502. * \var UBXCFGTimepulseIsFreq
  1503. * if set 'freqPeriodLock' and 'freqPeriod' interpreted as frequency, otherwise interpreted as period
  1504. * \var UBXCFGTimepulseIsLenght
  1505. * if set 'pulseLenRatioLock' and 'pulseLenRatio' interpreted as pulse length, otherwise interpreted as duty cycle
  1506. * \var UBXCFGTimepulseAlignToTow
  1507. * align pulse to top of second (period time must be integer fraction of 1s)
  1508. * \var UBXCFGTimepulsePolarity
  1509. * pulse polarity:\n
  1510. * 0 = falling edge at top of second\n
  1511. * 1 = rising edge at top of second
  1512. * \var UBXCFGTimepulseGridUTSGPS
  1513. * timegrid to use:\n
  1514. * 0 = UTC\n
  1515. * 1 = GPS
  1516. */
  1517. /*!
  1518. * \enum UBXCFGProtocolIds
  1519. * \brief UBXCFGProtocolIds
  1520. * Protocol Identifiers, identifying the output
  1521. * protocol for #UBXCFG_INF.
  1522. * \var UBXProtocol
  1523. * UBX Protocol
  1524. * \var UBXNMEAProtocol
  1525. * NMEA Protocol
  1526. */
  1527. /*!
  1528. * \enum UBXGNSSIds
  1529. * \brief UBXGNSSIds
  1530. * GNSS identificators used for #UBXCFG_GNSS in #UBXCFG_GNSS_PART
  1531. * \var UBXGPS
  1532. * GPS
  1533. * \var UBXSBAS
  1534. * SBAS
  1535. * \var UBXQZSS
  1536. * QZSS
  1537. * \var UBXGLONASS
  1538. * GLONASS
  1539. */
  1540. /*!
  1541. * \enum UBXCFGInfMsgMask
  1542. * \brief UBXCFGInfMsgMask implements
  1543. * bit mask, saying which information messages are enabled on each I/O port
  1544. * \var UBXInfError
  1545. * Error
  1546. * \var UBXInfWarning
  1547. * Warning
  1548. * \var UBXInfNotice
  1549. * Notice
  1550. * \var UBXInfDebug
  1551. * Debug
  1552. * \var UBXInfTest
  1553. * Test
  1554. */
  1555. /*!
  1556. * \enum UBXITFMAntSetting
  1557. * \brief UBXITFMAntSetting implements possible antenna settings for
  1558. * #UBXCFG_ITFM in UBXCFG_ITFM::config2 part.
  1559. * \var UBXITFMAntUnknown
  1560. * Unknown
  1561. * \var UBXITFMAntPassive
  1562. * Passive
  1563. * \var UBXITFMAntActive
  1564. * Active
  1565. */
  1566. /*!
  1567. * \enum UBXLOGFILTERFlags
  1568. * \brief UBXLOGFILTERFlags implements log filter flags bitmask for
  1569. * #UBXCFG_LOGFILTER
  1570. * \var UBXLOGFILTERRecordEnabled
  1571. * 1 = enable recording\n
  1572. * 0 = disable recording
  1573. * \var UBXLOGFILTERPsmOncePerWakupEnabled
  1574. * 1 = enable recording only one single position per PSM on/off mode wake up period\n
  1575. * 0 = disable once per wake up
  1576. * \var UBXLOGFILTERApplyAllFilterSettings
  1577. * 1 = apply all filter settings\n
  1578. * 0 = only apply recordEnabled
  1579. */
  1580. /*!
  1581. * \enum UBXNAV5Mask
  1582. * \brief UBXNAV5Mask implements flags bitmask
  1583. * for #UBXCFG_NAV5 message
  1584. * \var UBXNAV5Dyn
  1585. * Apply dynamic model settings
  1586. * \var UBXNAV5MinEl
  1587. * Apply minimum elevation settings
  1588. * \var UBXNAV5PosFixMode
  1589. * Apply fix mode settings
  1590. * \var UBXNAV5DrLim
  1591. * Reserved
  1592. * \var UBXNAV5PosMask
  1593. * Apply position mask settings
  1594. * \var UBXNAV5TimeMask
  1595. * Apply time mask settings
  1596. * \var UBXNAV5StaticHoldMask
  1597. * Apply static hold settings
  1598. * \var UBXNAV5DgpsMask
  1599. * Apply DGPS settings.
  1600. */
  1601. /*!
  1602. * \enum UBXNAV5Model
  1603. * \brief UBXNAV5Model
  1604. * enum describes dynamic platform models
  1605. * for #UBXCFG_NAV5 message
  1606. * \var UBXNAV5ModelPortable
  1607. * Portable
  1608. * \var UBXNAV5ModelStationary
  1609. * Stationary
  1610. * \var UBXNAV5ModelPedestrian
  1611. * Pedestrian
  1612. * \var UBXNAV5ModelAutomotive
  1613. * Automotive
  1614. * \var UBXNAV5ModelSea
  1615. * Sea
  1616. * \var UBXNAV5ModelAirborne1g
  1617. * Airborne1g
  1618. * \var UBXNAV5ModelAirborne2g
  1619. * Airborne2g
  1620. * \var UBXNAV5ModelAirborne4g
  1621. * Airborne4g
  1622. */
  1623. /*!
  1624. * \enum UBXNAV5FixMode
  1625. * \brief UBXNAV5FixMode
  1626. * enum describes position fixing mode
  1627. * for #UBXCFG_NAV5 message
  1628. * \var UBXNAV5Fix2DOnly
  1629. * 2D Only
  1630. * \var UBXNAV5Fix3DOnly
  1631. * 3D Only
  1632. * \var UBXNAV5FixAuto2D3D
  1633. * Auto 2D/3D
  1634. */
  1635. /*!
  1636. * \enum UBXNAVX5Mask
  1637. * \brief UBXNAVX5Mask
  1638. * implements flags bitmask
  1639. * for #UBXCFG_NAVX5 message
  1640. * \var UBXNAVX5AopMinMax
  1641. * Apply min/max SVs settings
  1642. * \var UBXNAVX5AopMinCno
  1643. * Apply minimum C/N0 setting
  1644. * \var UBXNAVX5AopInitial3dfix
  1645. * Apply initial 3D fix settings
  1646. * \var UBXNAVX5AopWknRoll
  1647. * Apply GPS weeknumber rollover settings
  1648. * \var UBXNAVX5AopPPP
  1649. * Apply PPP flag\n
  1650. * \note Only supported on certain product variants
  1651. * \var UBXNAVX5Aop
  1652. * Apply useAOP flag and aopOrbMaxErr setting (AssistNow Autonomous)
  1653. */
  1654. /*!
  1655. * \enum UBXNMEAFilter
  1656. * \brief UBXNMEAFilter
  1657. * implements NMEA message filter bitmask
  1658. * for #UBXCFG_NMEA
  1659. * \var UBXNMEAPosFilter
  1660. * Enable position output for failed or invalid fixes
  1661. * \var UBXNMEAMskPosFilter
  1662. * Enable position output for invalid fixes
  1663. * \var UBXNMEATimeFilter
  1664. * Enable time output for invalid times
  1665. * \var UBXNMEADateFilter
  1666. * Enable date output for invalid dates
  1667. * \var UBXNMEAGPSOnlyFilter
  1668. * Restrict output to GPS satellites only
  1669. * \var UBXNMEATrackFilter
  1670. * Enable COG output even if COG is frozen
  1671. */
  1672. /*!
  1673. * \enum UBXNMEAVersion
  1674. * \brief UBXNMEAVersion
  1675. * describes supported NMEA protocol version
  1676. * \var UBXNMEAVersion23
  1677. * NMEA version 2.3
  1678. * \var UBXNMEAVersion21
  1679. * NMEA version 2.1
  1680. */
  1681. /*!
  1682. * \enum UBXNMEAFlags
  1683. * \brief UBXNMEAFlags
  1684. * implements flags bitmask for #UBXCFG_NMEA
  1685. * \var UBXNMEACompatFlag
  1686. * enable compatibility mode.\n
  1687. * This might be needed for certain applications when customer's NMEA parser expects a fixed number of digits in
  1688. * position coordinates
  1689. * \var UBXNMEAConsiderFlag
  1690. * enable considering mode.
  1691. */
  1692. /*!
  1693. * \enum UBXNMEAGNSSToFilter
  1694. * \brief UBXNMEAGNSSToFilter
  1695. * implements bitmask to filters out satellites based
  1696. * on their GNSS.
  1697. * \var UBXNMEAGPSFilter
  1698. * Disable reporting of GPS satellites
  1699. * \var UBXNMEASBASFilter
  1700. * Disable reporting of SBAS satellites
  1701. * \var UBXNMEAQZSSFilter
  1702. * Disable reporting of QZSS satellites
  1703. * \var UBXNMEAGLONASSFilter
  1704. * Disable reporting of GLONASS satellites
  1705. */
  1706. /*!
  1707. * \enum UBXNMEASVNumbering
  1708. * \brief UBXNMEASVNumbering
  1709. *
  1710. * \var UBXNMEASVNumStrict
  1711. * Satellites are not output
  1712. * \var UBXNMEASVNumExtended
  1713. * Use UBX proprietary numbering
  1714. */
  1715. /*!
  1716. * \enum UBXNMEATalkerIds
  1717. * \brief UBXNMEATalkerIds
  1718. *
  1719. * \var UBXNMEATalkerNotOverriden
  1720. * Main Talker ID is not overridden
  1721. * \var UBXNMEATalkerGP
  1722. * Set main Talker ID to 'GP'
  1723. * \var UBXNMEATalkerGL
  1724. * Set main Talker ID to 'GL'
  1725. * \var UBXNMEATalkerGN
  1726. * Set main Talker ID to 'GN'
  1727. */
  1728. /*!
  1729. * \enum UBXNMEAGSVTalkerIds
  1730. * \brief UBXNMEAGSVTalkerIds
  1731. *
  1732. * \var UBXNMEAGSVTalkerGNSSSpecific
  1733. * Use GNSS specific Talker ID (as defined by NMEA)
  1734. * \var UBXNMEAGSVTalkerMain
  1735. * Use the main Talker ID
  1736. */
  1737. /*!
  1738. * \enum UBXPM2LimitPeakCurrent
  1739. * \brief UBXPM2LimitPeakCurrent
  1740. *
  1741. * \var UBXPM2LimitCurrentDisabled
  1742. * disabled
  1743. * \var UBXPM2LimitCurrentEnabled
  1744. * enabled, peak current is limited
  1745. */
  1746. /*!
  1747. * \enum UBXPM2Mode
  1748. * \brief UBXPM2Mode
  1749. *
  1750. * \var UBXPM2OnOffOperation
  1751. * ON/OFF operation
  1752. * \var UBXPM2CyclicTrackOperation
  1753. * Cyclic tracking operation
  1754. */
  1755. /*!
  1756. * \enum UBXPRTModeCharLen
  1757. * \brief UBXPRTModeCharLen used for #UBXCFG_PRT
  1758. *
  1759. * \var UBXPRTMode5BitCharLen
  1760. * 5bit \n
  1761. * \note Not supported
  1762. * \var UBXPRTMode6BitCharLen
  1763. * 6bit\n
  1764. * \note Not supported
  1765. * \var UBXPRTMode7BitCharLen
  1766. * 7bit\n
  1767. * \note Supported only with parity
  1768. * \var UBXPRTMode8BitCharLen
  1769. * 8bit
  1770. */
  1771. /*!
  1772. * \enum UBXPRTModeParity
  1773. * \brief UBXPRTModeParity used for #UBXCFG_PRT
  1774. *
  1775. * \var UBXPRTModeEvenParity
  1776. * Even Parity
  1777. * \var UBXPRTModeOddParity
  1778. * Odd Parity
  1779. * \var UBXPRTModeNoParity
  1780. * No Parity
  1781. * \var UBXPRTModeReserved
  1782. * Reserved\n
  1783. * \note Exclude this member from target value
  1784. */
  1785. /*!
  1786. * \enum UBXPRTModeStopBits
  1787. * \brief UBXPRTModeStopBits used for #UBXCFG_PRT
  1788. *
  1789. * \var UBXPRTMode1StopBit
  1790. * 1 Stop Bit
  1791. * \var UBXPRTMode1dot5StopBit
  1792. * 1.5 Stop Bit
  1793. * \var UBXPRTMode2StopBit
  1794. * 2 Stop Bit
  1795. * \var UBXPRTMode0dot5StopBit
  1796. * 0.5 Stop Bit
  1797. */
  1798. /*!
  1799. * \enum UBXPRTInProtoMask
  1800. * \brief UBXPRTInProtoMask used for #UBXCFG_PRT
  1801. *
  1802. * \var UBXPRTInProtoInUBX
  1803. * UBX protocol
  1804. * \var UBXPRTInProtoInNMEA
  1805. * NMEA protocol
  1806. * \var UBXPRTInProtoInRTCM
  1807. * RTCM protocol
  1808. */
  1809. /*!
  1810. * \enum UBXPRTOutProtoMask
  1811. * \brief UBXPRTOutProtoMask used for #UBXCFG_PRT
  1812. *
  1813. * \var UBXPRTOutProtoOutUBX
  1814. * UBX protocol
  1815. * \var UBXPRTOutProtoOutNMEA
  1816. * NMEA protocol
  1817. */
  1818. /*!
  1819. * \enum UBXPRTFlags
  1820. * \brief UBXPRTFlags used for #UBXCFG_PRT
  1821. *
  1822. * \var UBXPRTExtendedTxTimeout
  1823. * Extended TX timeout: if set, the port will timeout if allocated TX memory >=4 kB and no activity for 1.5s
  1824. */
  1825. /*!
  1826. * \enum UBXPRTSPIMode
  1827. * \brief UBXPRTSPIMode used for #UBXCFG_PRT
  1828. *
  1829. * \var UBXPRTSPIMode0
  1830. * 0 SPI Mode 0: CPOL = 0, CPHA = 0
  1831. * \var UBXPRTSPIMode1
  1832. * SPI Mode 1: CPOL = 0, CPHA = 1
  1833. * \var UBXPRTSPIMode2
  1834. * SPI Mode 2: CPOL = 1, CPHA = 0
  1835. * \var UBXPRTSPIMode3
  1836. * SPI Mode 3: CPOL = 1, CPHA = 1
  1837. */
  1838. /*!
  1839. * \enum UBXRINVFlags
  1840. * \brief UBXRINVFlags used for #UBXCFG_RINV
  1841. *
  1842. * \var UBXRINVDump
  1843. * Dump data at startup. Does not work if flag binary is set.
  1844. * \var UBXRINVBinary
  1845. * Data is binary
  1846. */
  1847. /*!
  1848. * \enum UBXRXMLowPowerModes
  1849. * \brief UBXRXMLowPowerModes used for #UBXCFG_RXM
  1850. *
  1851. * \var UBXRXMContinousMode
  1852. * Continous Mode
  1853. * \var UBXRXMPowerSaveMode
  1854. * Power Save Mode
  1855. */
  1856. /*!
  1857. * \enum UBXSBASModes
  1858. * \brief UBXSBASModes used for #UBXCFG_SBAS
  1859. *
  1860. * \var UBXSBASModeEnabled
  1861. * SBAS Enabled (1) / Disabled (0)
  1862. * \var UBXSBASModeTest
  1863. * SBAS Testbed: Use data anyhow (1) / Ignore data when in Test Mode (SBAS Msg 0)
  1864. */
  1865. /*!
  1866. * \enum UBXSBASUsage
  1867. * \brief UBXSBASUsage
  1868. *
  1869. * \var UBXSBASUsageRange
  1870. * Use SBAS GEOs as a ranging source (for navigation)
  1871. * \var UBXSBASUsageDiffCorr
  1872. * Use SBAS Differential Corrections
  1873. * \var UBXSBASUsageIntegrity
  1874. * Use SBAS Integrity Information
  1875. */
  1876. /*!
  1877. * \enum UBXSBASScanModes2
  1878. * \brief UBXSBASScanModes2
  1879. *
  1880. * \var UBXSBASScanModePRN152
  1881. * \var UBXSBASScanModePRN153
  1882. * \var UBXSBASScanModePRN154
  1883. * \var UBXSBASScanModePRN155
  1884. * \var UBXSBASScanModePRN156
  1885. * \var UBXSBASScanModePRN157
  1886. * \var UBXSBASScanModePRN158
  1887. */
  1888. /*!
  1889. * \enum UBXSBASScanModes1
  1890. * \brief UBXSBASScanModes1
  1891. *
  1892. * \var UBXSBASScanModePRN120
  1893. * \var UBXSBASScanModePRN121
  1894. * \var UBXSBASScanModePRN122
  1895. * \var UBXSBASScanModePRN123
  1896. * \var UBXSBASScanModePRN124
  1897. * \var UBXSBASScanModePRN125
  1898. * \var UBXSBASScanModePRN126
  1899. * \var UBXSBASScanModePRN127
  1900. * \var UBXSBASScanModePRN128
  1901. * \var UBXSBASScanModePRN129
  1902. * \var UBXSBASScanModePRN130
  1903. * \var UBXSBASScanModePRN131
  1904. * \var UBXSBASScanModePRN132
  1905. * \var UBXSBASScanModePRN133
  1906. * \var UBXSBASScanModePRN134
  1907. * \var UBXSBASScanModePRN135
  1908. * \var UBXSBASScanModePRN136
  1909. * \var UBXSBASScanModePRN137
  1910. * \var UBXSBASScanModePRN138
  1911. * \var UBXSBASScanModePRN139
  1912. * \var UBXSBASScanModePRN140
  1913. * \var UBXSBASScanModePRN141
  1914. * \var UBXSBASScanModePRN142
  1915. * \var UBXSBASScanModePRN143
  1916. * \var UBXSBASScanModePRN144
  1917. * \var UBXSBASScanModePRN145
  1918. * \var UBXSBASScanModePRN146
  1919. * \var UBXSBASScanModePRN147
  1920. * \var UBXSBASScanModePRN148
  1921. * \var UBXSBASScanModePRN149
  1922. * \var UBXSBASScanModePRN150
  1923. * \var UBXSBASScanModePRN151
  1924. */
  1925. /*!
  1926. * \enum UBXUSBFlags
  1927. * \brief UBXUSBFlags
  1928. *
  1929. * \var USBFlagReEnum
  1930. * force re-enumeration
  1931. * \var USBFlagPowerMode
  1932. * self-powered (1), bus-powered (0)
  1933. */
  1934. /*!
  1935. * \enum UBXLOGCfg
  1936. * \brief UBXLOGCfg
  1937. * \var UBXLOGCfgCircular
  1938. * Log is circular (new entries overwrite old ones in a full log) if this bit set
  1939. */
  1940. /*!
  1941. * \enum UBXLOGSize
  1942. * \brief UBXLOGSize
  1943. *
  1944. * \var UBXLOGMaximumSafeSize
  1945. * Maximum safe size\n
  1946. * \note Ensures that logging will not be interupted and enough space
  1947. * will be left avaiable for all other uses of the filestore
  1948. * \var UBXLOGMinimunSize
  1949. * Minimun size
  1950. * \var UBXLOGUserDefined
  1951. * User defined\n
  1952. * \note See UBXLOG_CREATE::userDefinedSize
  1953. */
  1954. /*!
  1955. * \enum UBXLOGStatus
  1956. * \brief UBXLOGStatus
  1957. *
  1958. * \var UBXLOGStatusRecording
  1959. * Log entry recording is currently turned on
  1960. * \var UBXLOGStatusInactive
  1961. * Logging system not active - no log present
  1962. * \var UBXLOGStatusCircular
  1963. * The current log is circular
  1964. */
  1965. /*!
  1966. * \enum UBXRETRIEVEPOSFixType
  1967. * \brief UBXRETRIEVEPOSFixType
  1968. *
  1969. * \var UBXRETRIEVEPOS2DFix
  1970. * 2D-Fix
  1971. * \var UBXRETRIEVEPOS3DFix
  1972. * 3D-Fix
  1973. */
  1974. /*!
  1975. * \enum UBXRXRFlags
  1976. * \brief UBXRXRFlags
  1977. *
  1978. * \var UBXRXRAwake
  1979. * not in Backup mode
  1980. */
  1981. /*!
  1982. * \enum UBXAOPStatus
  1983. * \brief UBXAOPStatus
  1984. *
  1985. * \var UBXAOPStatusIdle
  1986. * AOP idle
  1987. * \var UBXAOPStatusRunning
  1988. * AOP running
  1989. */
  1990. /*!
  1991. * \enum UBXAOPCfg
  1992. * \brief UBXAOPCfg
  1993. *
  1994. * \var UBXAOPCfgUseAOP
  1995. * AOP enabled flag
  1996. */
  1997. /*!
  1998. * \enum UBXGPSFix
  1999. * \brief UBXGPSFix
  2000. *
  2001. * \var UBXGPSNoFix
  2002. * No Fix
  2003. * \var UBXGPSDeadReckoning
  2004. * Dead Reckoning only
  2005. * \var UBXGPS2DFix
  2006. * 2D-Fix
  2007. * \var UBXGPS3DFix
  2008. * 3D-Fix
  2009. * \var UBXGPSGNSSDeadReckoning
  2010. * GNSS + dead reckoning combined
  2011. * \var UBXGPSTimeOnlyFix
  2012. * Time only fix
  2013. */
  2014. /*!
  2015. * \enum UBXPVTValid
  2016. * \brief UBXPVTValid
  2017. *
  2018. * \var UBXPVTValidDate
  2019. * Valid UTC Date
  2020. * \var UBXPVTValidTime
  2021. * Valid UTC Time of Day
  2022. * \var UBXPVTFullyResolved
  2023. * UTC Time of Day has been fully resolved (no seconds uncertainty)
  2024. */
  2025. /*!
  2026. * \enum UBXPVTPSMStates
  2027. * \brief UBXPVTPSMStates
  2028. *
  2029. * \var UBXPVTPSMStateNA
  2030. * n/a (i.e no PSM is active)
  2031. * \var UBXPVTPSMStateEnabled
  2032. * Enabled (an intermediate state before Acquisition state)
  2033. * \var UBXPVTPSMStateAcquisition
  2034. * Acquisition
  2035. * \var UBXPVTPSMStateTracking
  2036. * Tracking
  2037. * \var UBXPVTPSMStatePowerOptim
  2038. * Power optimized tracking
  2039. * \var UBXPVTPSMStateInactive
  2040. * Inactive
  2041. */
  2042. /*!
  2043. * \enum UBXSBASService
  2044. * \brief UBXSBASService
  2045. *
  2046. * \var UBXSBASServiceRanging
  2047. * Service ranging
  2048. * \var UBXSBASServiceCorrections
  2049. * Service corrections
  2050. * \var UBXSBASServiceIntegrity
  2051. * Service integrity
  2052. * \var UBXSBASServiceTestmode
  2053. * Service in testmode
  2054. */
  2055. /*!
  2056. * \enum UBXSBASSOLFlags
  2057. * \brief UBXSBASSOLFlags
  2058. *
  2059. {
  2060. * \var UBXSBASSOLGPSfixOK
  2061. * Fix within limits. Position and velocity valid and within DOP and ACC Masks.
  2062. * \var UBXSBASSOLDiffSoln
  2063. * DGPS used
  2064. * \var UBXSBASSOLWKNSet
  2065. * Valid GPS week number
  2066. * \var UBXSBASSOLTOWSet
  2067. * Valid GPS time of week (iTOW & fTOW)
  2068. */
  2069. /*!
  2070. * \enum UBXSVINFOChipGen
  2071. * \brief UBXSVINFOChipGen
  2072. *
  2073. * \var UBXSVINFOAntarisChip
  2074. * Antaris, Antaris 4
  2075. * \var UBXSVINFOUBlox5Chip
  2076. * u-blox© 5
  2077. * \var UBXSVINFOUBlox6Chip
  2078. * u-blox© 6
  2079. */
  2080. /*!
  2081. * \enum UBXSVINFOFlags
  2082. * \brief UBXSVINFOFlags
  2083. *
  2084. {
  2085. * \var UBXSVINFOFlagsSVUsed
  2086. * SV is used for navigation
  2087. * \var UBXSVINFOFlagsDiffCorr
  2088. * Differential correction data is available for this SV
  2089. * \var UBXSVINFOFlagsOrbitAvail
  2090. * Orbit information is available for this SV (Ephemeris or Almanac)
  2091. * \var UBXSVINFOFlagsOrbitEph
  2092. * Orbit information is Ephemeris
  2093. * \var UBXSVINFOFlagsUnhealthy
  2094. * SV is unhealthy / shall not be used
  2095. * \var UBXSVINFOFlagsOrbitAlm
  2096. * Orbit information is Almanac Plus
  2097. * \var UBXSVINFOFlagsOrbitAop
  2098. * Orbit information is AssistNow Autonomous
  2099. * \var UBXSVINFOFlagsSmoothed
  2100. * Carrier smoothed pseudorange used
  2101. */
  2102. /*!
  2103. * \enum UBXSVINFOQualityId
  2104. * \brief UBXSVINFOQualityId
  2105. *
  2106. * \var UBXSVINFOQualityChannelIdle
  2107. * This channel is idle
  2108. * \var UBXSVINFOQualityChannelSearching
  2109. * Channel is searching
  2110. * \var UBXSVINFOQualitySignalAquired
  2111. * Signal aquired
  2112. * \var UBXSVINFOQualitySignalDetected
  2113. * Signal detected but unusable
  2114. * \var UBXSVINFOQualityCodeLockOnSignal
  2115. * Code Lock on Signal
  2116. * \var UBXSVINFOQualityCodeCarrierLocked
  2117. * Code and Carrier locked
  2118. */
  2119. /*!
  2120. * \enum UBXTIMEGPSValidityFlags
  2121. * \brief UBXTIMEGPSValidityFlags
  2122. *
  2123. * \var UBXTIMEGPSTowValid
  2124. * Valid GPS time of week (iTOW & fTOW)
  2125. * \var UBXTIMEGPSWeekValid
  2126. * Valid GPS week number
  2127. * \var UBXTIMEGPSLeapSValid
  2128. * Valid GPS leap seconds
  2129. */
  2130. /*!
  2131. * \enum UBXTIMEUTCValidityFlags
  2132. * \brief UBXTIMEUTCValidityFlags
  2133. *
  2134. * \var UBXTIMEUTCValidTOW
  2135. * Valid Time of Week
  2136. * \var UBXTIMEUTCValidWKN
  2137. * Valid Week Number
  2138. * \var UBXTIMEUTCValidUTC
  2139. * Valid UTC Time
  2140. */
  2141. /*!
  2142. * \enum UBXPMREQFlags
  2143. * \brief UBXPMREQFlags
  2144. *
  2145. * \var UBXPMREQBackup
  2146. * The receiver goes into backup mode for a time period defined by duration
  2147. */
  2148. /*!
  2149. * \enum UBXTM2FlagsMode
  2150. * \brief UBXTM2FlagsMode
  2151. *
  2152. * \var UBXTM2FlagsModeSingle
  2153. * Single mode
  2154. * \var UBXTM2FlagsModeRunning
  2155. * Running mode
  2156. */
  2157. /*!
  2158. * \enum UBXTM2FlagsRun
  2159. * \brief UBXTM2FlagsRun
  2160. *
  2161. * \var UBXTM2FlagsRunArmed
  2162. * Armed
  2163. * \var UBXTM2FlagsRunStopped
  2164. * Stopped
  2165. */
  2166. /*!
  2167. * \enum UBXTM2FlagsTimeBase
  2168. * \brief UBXTM2FlagsTimeBase
  2169. *
  2170. * \var UBXTM2FlagsTimeBaseReceiverTime
  2171. * Time base is Receiver Time
  2172. * \var UBXTM2FlagsTimeBaseGPS
  2173. * Time base is GPS
  2174. * \var UBXTM2FlagsTimeBaseUTC
  2175. * Time base is UTC
  2176. */
  2177. /*!
  2178. * \enum UBXTM2FlagsUTC
  2179. * \brief UBXTM2FlagsUTC
  2180. *
  2181. * \var UBXTM2FlagsUTCNotAvailable
  2182. * UTC not available
  2183. * \var UBXTM2FlagsUTCAvailable
  2184. * UTC available
  2185. */
  2186. /*!
  2187. * \enum UBXTM2FlagsTime
  2188. * \brief UBXTM2FlagsTime
  2189. *
  2190. * \var UBXTM2FlagsTimeInvalid
  2191. * Time is not valid
  2192. * \var UBXTM2FlagsTimeValid
  2193. * Time is valid (Valid GPS fix)
  2194. */
  2195. /*!
  2196. * \enum UBXTPFlags
  2197. * \brief UBXTPFlags
  2198. *
  2199. * \var UBXTPTimeBaseUTC
  2200. * If is set time base is UTC. If not set time base is GPS
  2201. * \var UBXTPUTCAvailable
  2202. * UTC available
  2203. */
  2204. /*!
  2205. * \enum UBXVRFYFlagsSource
  2206. * \brief UBXVRFYFlagsSource
  2207. *
  2208. * \var UBXVRFYNoTimeAidingDone
  2209. * No time aiding done
  2210. * \var UBXVRFYSourceRTC
  2211. * Source was RTC
  2212. * \var UBXVRFYSourceAID_INI
  2213. * Source was AID-INI
  2214. */
  2215. /*! @} */
  2216. /*! \struct UBXHdr
  2217. * \brief This structure is UBX message header
  2218. * \var UBXHdr::msgClass
  2219. * Message class. A class is a grouping of messages which are related to each other.
  2220. * See #UBXMessageClass
  2221. * \var UBXHdr::msgId
  2222. * Message identificator. See #UBXMessageId
  2223. * \var UBXHdr::length
  2224. * Length is defined as being the length of the payload, only. It does not include
  2225. * Sync Chars, Length Field, Class, ID or CRC fields. The number format of the
  2226. * length field is an unsigned 16-Bit integer in Little Endian Format.
  2227. */
  2228. /*! \struct UBXMsg
  2229. * \brief This structure is base for every message in
  2230. * UBX protocol
  2231. * \var UBXMsg::preamble
  2232. * preable of UBX message is allways 0xB562
  2233. * \var UBXMsg::hdr
  2234. * UBX message header of #UBXHdr type.
  2235. * \var UBXMsg::payload
  2236. * Union of #UBXMsgs type that contains all possible payloads
  2237. * for current protocol version
  2238. */
  2239. /*! \struct UBXMsgBuffer
  2240. * \brief This structure is used by every message getters
  2241. * to wrap returned message data.
  2242. * \var UBXMsgBuffer::size
  2243. * size of buffer
  2244. * \var UBXMsgBuffer::data
  2245. * pointer to data heap
  2246. */
  2247. /*! \union UBXMsgs
  2248. * \brief This union contains all possible payloads
  2249. * in current protocol version
  2250. */
  2251. /*! \struct UBXAlpFileInfo
  2252. * \brief This structure contains data of alpfile
  2253. * It's simple wrapper on byte array with file id
  2254. * specification
  2255. * \var UBXAlpFileInfo::fileId
  2256. * File id used to indetificate part appurtenance
  2257. * \var UBXMsg::alpData
  2258. * Part of file data
  2259. * \var UBXMsg::dataSize
  2260. * Size of part in bytes
  2261. */
  2262. /*!
  2263. * \struct UBXAID_ALPSRV
  2264. * This message is sent by the ALP client to the ALP server in order to request data. The given
  2265. * identifier must be prepended to the requested data when submitting the data.
  2266. * \brief ALP client requests AlmanacPlus data from server
  2267. * \var UBXAID_ALPSRV::idSize
  2268. * Identifier size. This data, beginning at message start, must prepend the returned data.
  2269. * \var UBXAID_ALPSRV::type
  2270. * Requested data type. Must be different from 0xff, otherwise this is not a data request.
  2271. * \var UBXAID_ALPSRV::offset
  2272. * Requested data offset [16bit words]
  2273. * \var UBXAID_ALPSRV::size
  2274. * Requested data size [16bit words]
  2275. * \var UBXAID_ALPSRV::fileId
  2276. * Unused when requesting data, filled in when sending back the data
  2277. * \var UBXAID_ALPSRV::dataSize
  2278. * Actual data size. Unused when requesting data, filled in when sending back the data.
  2279. * \var UBXAID_ALPSRV::id1
  2280. * Identifier data
  2281. * \var UBXAID_ALPSRV::id2
  2282. * Identifier data
  2283. * \var UBXAID_ALPSRV::id3
  2284. * Identifier data
  2285. */
  2286. /*!
  2287. * \struct UBXACK_ACK
  2288. * Output upon processing of an input message
  2289. * \brief Message acknowledged
  2290. * \var UBXACK_ACK::msgClass
  2291. * Class ID of the Acknowledged Message
  2292. * \see #UBXMessageClass to fill this field
  2293. * \var UBXACK_ACK::msgId
  2294. * Message ID of the Acknowledged Message
  2295. * \see #UBXMessageId to fill this field
  2296. */
  2297. /*!
  2298. * \struct UBXACK_NACK
  2299. * Output upon processing of an input message
  2300. * \brief Message Not-Acknowledged
  2301. * \var UBXACK_NACK::msgClass
  2302. * Class ID of the Acknowledged Message
  2303. * \see #UBXMessageClass to fill this field
  2304. * \var UBXACK_NACK::msgId
  2305. * Message ID of the Acknowledged Message
  2306. * \see #UBXMessageId to fill this field
  2307. */
  2308. /*!
  2309. * \struct UBXAID_ALM_POLL
  2310. * Poll GPS Aiding Data (Almanac) for all 32 SVs by sending this message to the receiver
  2311. * without any payload. The receiver will return 32 messages of type AID-ALM as defined
  2312. * below.
  2313. * \note No payload
  2314. * \brief Poll GPS Aiding Almanac Data
  2315. */
  2316. /*!
  2317. * \struct UBXAID_ALM_POLL_OPT
  2318. * Poll GPS Aiding Data (Almanac) for an SV by sending this message to the receiver. The
  2319. * receiver will return one message of type AID-ALM as defined below.
  2320. * \brief Poll GPS Aiding Almanac Data for a SV
  2321. *
  2322. * \var UBXAID_ALM_POLL_OPT::svid
  2323. * SV ID for which the receiver shall return its
  2324. * Almanac Data (Valid Range: 1 .. 32 or 51, 56,
  2325. * 63).
  2326. */
  2327. /*!
  2328. * \struct UBXAID_ALM
  2329. * - If the WEEK Value is 0, DWRD0 to DWRD7 are not sent as the Almanac is not available
  2330. * for the given SV. This may happen even if NAV-SVINFO and RXM-SVSI are indicating
  2331. * almanac availability as the internal data may not represent the content of an original
  2332. * broadcast almanac (or only parts thereof).
  2333. * - DWORD0 to DWORD7 contain the 8 words following the Hand-Over Word ( HOW )
  2334. * from the GPS navigation message, either pages 1 to 24 of sub-frame 5 or pages 2 to 10
  2335. * of subframe 4. See IS-GPS-200 for a full description of the contents of the Almanac
  2336. * pages.
  2337. * - In DWORD0 to DWORD7, the parity bits have been removed, and the 24 bits of data are
  2338. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  2339. * - Example: Parameter e (Eccentricity) from Almanac Subframe 4/5, Word 3, Bits 69-84
  2340. * within the subframe can be found in DWRD0, Bits 15-0 whereas Bit 0 is the LSB.
  2341. * \brief GPS Aiding Almanac Input/Output Message
  2342. *
  2343. * \var UBXAID_ALM::svid
  2344. * SV ID for which this
  2345. * Almanac Data is (Valid Range: 1 .. 32 or 51, 56,
  2346. * 63).
  2347. * \var UBXAID_ALM::week
  2348. * Issue Date of Almanac (GPS week number)
  2349. */
  2350. /*!
  2351. * \struct UBXAID_ALM_OPT
  2352. * - If the WEEK Value is 0, DWRD0 to DWRD7 are not sent as the Almanac is not available
  2353. * for the given SV. This may happen even if NAV-SVINFO and RXM-SVSI are indicating
  2354. * almanac availability as the internal data may not represent the content of an original
  2355. * broadcast almanac (or only parts thereof).
  2356. * - DWORD0 to DWORD7 contain the 8 words following the Hand-Over Word ( HOW )
  2357. * from the GPS navigation message, either pages 1 to 24 of sub-frame 5 or pages 2 to 10
  2358. * of subframe 4. See IS-GPS-200 for a full description of the contents of the Almanac
  2359. * pages.
  2360. * - In DWORD0 to DWORD7, the parity bits have been removed, and the 24 bits of data are
  2361. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  2362. * - Example: Parameter e (Eccentricity) from Almanac Subframe 4/5, Word 3, Bits 69-84
  2363. * within the subframe can be found in DWRD0, Bits 15-0 whereas Bit 0 is the LSB.
  2364. * \brief GPS Aiding Almanac Input/Output Message
  2365. *
  2366. * \var UBXAID_ALM_OPT::svid
  2367. * SV ID for which this
  2368. * Almanac Data is (Valid Range: 1 .. 32 or 51, 56,
  2369. * 63).
  2370. * \var UBXAID_ALM_OPT::week
  2371. * Issue Date of Almanac (GPS week number)
  2372. * \var UBXAID_ALM_OPT::dwrd[8]
  2373. * Almanac Words
  2374. */
  2375. /*!
  2376. * \struct UBXAID_ALP
  2377. * This message is used to transfer a chunk of data from the AlmanacPlus file to the receiver.
  2378. * Upon reception of this message, the receiver will write the payload data to its internal
  2379. * non-volatile memory, eventually also erasing that part of the memory first. Make sure that
  2380. * the payload size is even sized (i.e. always a multiple of 2). Do not use payloads larger than
  2381. * ~ 700 bytes, as this would exceed the receiver's internal buffering capabilities. The receiver
  2382. * will (not-) acknowledge this message using the message alternatives given below. The host
  2383. * shall wait for an acknowledge message before sending the next chunk.
  2384. * \note This structure contains variable payload:\n
  2385. * UBXU2_t alpData ALP file data
  2386. * \brief ALP file data transfer to the receiver
  2387. */
  2388. /*!
  2389. * \struct UBXAID_ALP_END
  2390. * This message is used to indicate that all chunks have been transferred, and normal receiver
  2391. * operation can resume. Upon reception of this message, the receiver will verify all chunks
  2392. * received so far, and enable AssistNow Offline and GPS receiver operation if successful. This
  2393. * message could also be sent to cancel an incomplete download.
  2394. * \brief Mark end of data transfer
  2395. * \var UBXAID_ALP_END::dummy
  2396. * - Value is ignored if it's end of data transfer
  2397. * - If value is set to 0x01 message acknowledges a data transfer
  2398. * - If value is set to 0x00 message indicates problems with a data transfer
  2399. */
  2400. /*!
  2401. * \struct UBXAID_ALP_POLL
  2402. * \brief Poll the AlmanacPlus status
  2403. *
  2404. * \var UBXAID_ALP_POLL::predTow
  2405. * Prediction start time of week
  2406. * \var UBXAID_ALP_POLL::predDur
  2407. * Prediction duration from start of first data set to
  2408. * end of last data set
  2409. * \var UBXAID_ALP_POLL::age
  2410. * Current age of ALP data
  2411. * \var UBXAID_ALP_POLL::predWno
  2412. * Prediction start week number
  2413. * \var UBXAID_ALP_POLL::almWno
  2414. * Truncated week number of reference almanac
  2415. * \var UBXAID_ALP_POLL::reserved1
  2416. * Reserved
  2417. * \var UBXAID_ALP_POLL::svs
  2418. * Number of satellite data sets contained in the
  2419. * ALP UBXAID_ALP_POLL::data
  2420. * \var UBXAID_ALP_POLL::reserved2
  2421. * Reserved
  2422. * \var UBXAID_ALP_POLL::reserved3
  2423. * Reserved
  2424. */
  2425. /*!
  2426. * \struct UBXAID_AOP_POLL
  2427. * Poll AssistNow Autonomous aiding data for all satellits by sending this empty message. The
  2428. * receiver will return an AID-AOP message (see definition below) for each satellite for which
  2429. * data is available. For satellites for which no data is available it will return a corresponding
  2430. * AID-AOP poll request message.
  2431. * \note No payload
  2432. * \brief Poll AssistNow Autonomous data
  2433. */
  2434. /*!
  2435. * \struct UBXAID_AOP_POLL_OPT
  2436. * Poll the AssistNow Autonomous data for the specified satellite. The receiver will return a
  2437. * AID-AOP message (see definition below) if data is available for the requested satellite. If no
  2438. * data is available it will return corresponding AID-AOP poll request message (i.e. this
  2439. * message).
  2440. * \brief Poll AssistNow Autonomous data for one satellite
  2441. * \var UBXAID_AOP_POLL_OPT::svid
  2442. * GPS SV id for which the data is requested
  2443. * \note Range: 1..32
  2444. */
  2445. /*!
  2446. * \struct UBXAID_AOP
  2447. * If enabled, this message is output at irregular intervals. It is output whenever AssistNow
  2448. * Autonomous has produced new data for a satellite. Depending on the availability of the
  2449. * optional data the receiver will output either version of the message. If this message is
  2450. * polled using one of the two poll requests described above the receiver will send this
  2451. * message if AOP data is available or the corresponding poll request message if no AOP data
  2452. * is available for each satellite (i.e. svid 1..32). At the user's choice the optional data may be
  2453. * chopped from the payload of a previously polled message when sending the message back
  2454. * to the receiver. Sending a valid AID-AOP message to the receiver will automatically enable
  2455. * the AssistNow Autonomous feature on the receiver. See the section AssistNow
  2456. * Autonomous in the receiver description for details on this feature.
  2457. * \brief AssistNow Autonomous data
  2458. * \var UBXAID_AOP::svid
  2459. * GPS SV id
  2460. * \var UBXAID_AOP::data[59]
  2461. * AssistNow Autonomous data
  2462. */
  2463. /*!
  2464. * \struct UBXAID_AOP_OPT
  2465. * If enabled, this message is output at irregular intervals. It is output whenever AssistNow
  2466. * Autonomous has produced new data for a satellite. Depending on the availability of the
  2467. * optional data the receiver will output either version of the message. If this message is
  2468. * polled using one of the two poll requests described above the receiver will send this
  2469. * message if AOP data is available or the corresponding poll request message if no AOP data
  2470. * is available for each satellite (i.e. svid 1..32). At the user's choice the optional data may be
  2471. * chopped from the payload of a previously polled message when sending the message back
  2472. * to the receiver. Sending a valid AID-AOP message to the receiver will automatically enable
  2473. * the AssistNow Autonomous feature on the receiver. See the section AssistNow
  2474. * Autonomous in the receiver description for details on this feature.
  2475. * \brief AssistNow Autonomous data
  2476. * \var UBXAID_AOP_OPT::svid
  2477. * GPS SV id
  2478. * \var UBXAID_AOP_OPT::data[59]
  2479. * AssistNow Autonomous data
  2480. * \var UBXAID_AOP_OPT::optional0[48]
  2481. * Optional data chunk 1/3
  2482. * \var UBXAID_AOP_OPT::optional1[48]
  2483. * Optional data chunk 2/3
  2484. * \var UBXAID_AOP_OPT::optional2[48]
  2485. * Optional data chunk 3/3
  2486. */
  2487. /*!
  2488. * \struct UBXAID_DATA_POLL
  2489. * If this poll is received, the messages AID-INI, AID-HUI, AID-EPH and AID-ALM are sent.
  2490. * \note No payload
  2491. * \brief Polls all GPS Initial Aiding Data
  2492. */
  2493. /*!
  2494. * \struct UBXAID_EPH_POLL
  2495. * This message has an empty payload!
  2496. * Poll GPS Aiding Data (Ephemeris) for all 32 SVs by sending this message to the receivewithout any payload.
  2497. * The receiver will return 32 messages of type #UBXAID_EPH
  2498. * \note No payload
  2499. * \brief Poll GPS Aiding Ephemeris Data
  2500. *
  2501. */
  2502. /*!
  2503. * \struct UBXAID_EPH_POLL_OPT
  2504. * Poll GPS Constellation Data (Ephemeris) for an SV by sending this message to the receiver.
  2505. * The receiver will return 32 messages of type #UBXAID_EPH
  2506. * \brief Poll GPS Aiding Ephemeris Data for a SV
  2507. *
  2508. * \var UBXAID_EPH_POLL_OPT::svid
  2509. * SV ID for which the receiver shall return its
  2510. * Ephemeris Data (Valid Range: 1 .. 32).
  2511. */
  2512. /*!
  2513. * \struct UBXAID_EPH
  2514. * - SF1D0 to SF3D7 is only sent if ephemeris is available for this SV. If not, the payload may
  2515. * be reduced to 8 Bytes, or all bytes are set to zero, indicating that this SV Number does
  2516. * not have valid ephemeris for the moment. This may happen even if NAV-SVINFO and
  2517. * RXM-SVSI are indicating ephemeris availability as the internal data may not represent the
  2518. * content of an original broadcast ephemeris (or only parts thereof).
  2519. * - SF1D0 to SF3D7 contain the 24 words following the Hand-Over Word ( HOW ) from the
  2520. * GPS navigation message, subframes 1 to 3. The Truncated TOW Count is not valid and
  2521. * cannot be used. See IS-GPS-200 for a full description of the contents of the Subframes.
  2522. * - In SF1D0 to SF3D7, the parity bits have been removed, and the 24 bits of data are
  2523. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  2524. * - When polled, the data contained in this message does not represent the full original
  2525. * ephemeris broadcast. Some fields that are irrelevant to u-blox© receivers may be missing.
  2526. * The week number in Subframe 1 has already been modified to match the Time Of
  2527. * Ephemeris (TOE).
  2528. * \brief GPS Aiding Ephemeris Input/Output Message
  2529. * \var UBXAID_EPH::svid
  2530. * SV ID for which this ephemeris data is
  2531. * \note Range: 1..32
  2532. * \var UBXAID_EPH::how
  2533. * Hand-Over Word of first Subframe. This is
  2534. * required if data is sent to the receiver.
  2535. * 0 indicates that no Ephemeris Data is following.
  2536. */
  2537. /*!
  2538. * \struct UBXAID_EPH_OPT
  2539. * - SF1D0 to SF3D7 is only sent if ephemeris is available for this SV. If not, the payload may
  2540. * be reduced to 8 Bytes, or all bytes are set to zero, indicating that this SV Number does
  2541. * not have valid ephemeris for the moment. This may happen even if NAV-SVINFO and
  2542. * RXM-SVSI are indicating ephemeris availability as the internal data may not represent the
  2543. * content of an original broadcast ephemeris (or only parts thereof).
  2544. * - SF1D0 to SF3D7 contain the 24 words following the Hand-Over Word ( HOW ) from the
  2545. * GPS navigation message, subframes 1 to 3. The Truncated TOW Count is not valid and
  2546. * cannot be used. See IS-GPS-200 for a full description of the contents of the Subframes.
  2547. * - In SF1D0 to SF3D7, the parity bits have been removed, and the 24 bits of data are
  2548. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  2549. * - When polled, the data contained in this message does not represent the full original
  2550. * ephemeris broadcast. Some fields that are irrelevant to u-blox© receivers may be missing.
  2551. * The week number in Subframe 1 has already been modified to match the Time Of
  2552. * Ephemeris (TOE).
  2553. * \brief GPS Aiding Ephemeris Input/Output Message
  2554. * \var UBXAID_EPH_OPT::svid
  2555. * SV ID for which this ephemeris data is
  2556. * \note Range: 1..32
  2557. * \var UBXAID_EPH_OPT::how
  2558. * Hand-Over Word of first Subframe. This is
  2559. * required if data is sent to the receiver.
  2560. * 0 indicates that no Ephemeris Data is following.
  2561. * \var UBXAID_EPH_OPT::sf1d[8]
  2562. * Subframe 1 Words 3..10 (SF1D0..SF1D7)
  2563. * \var UBXAID_EPH_OPT::sf2d[8]
  2564. * Subframe 2 Words 3..10 (SF1D0..SF1D7)
  2565. * \var UBXAID_EPH_OPT::sf3d[8]
  2566. * Subframe 3 Words 3..10 (SF1D0..SF1D7)
  2567. */
  2568. /*!
  2569. * \struct UBXAID_HUI_POLL
  2570. * \note No payload
  2571. * \brief Poll GPS Health, UTC and ionosphere parameters
  2572. */
  2573. /*!
  2574. * \struct UBXAID_HUI
  2575. * This message contains a health bit mask, UTC time and Klobuchar parameters. For more
  2576. * information on these parameters, please see the ICD-GPS-200 documentation.
  2577. * \brief GPS Health, UTC and ionosphere parameters
  2578. * \var UBXAID_HUI::health
  2579. * Bitmask, every bit represenst a GPS SV (1-32). If
  2580. * the bit is set the SV is healthy.
  2581. * \var UBXAID_HUI::utcA0
  2582. * UTC - parameter A0
  2583. * \var UBXAID_HUI::utcA1
  2584. * UTC - parameter A1
  2585. * \var UBXAID_HUI::utcTOW
  2586. * UTC - reference time of week
  2587. * \var UBXAID_HUI::utcWNT
  2588. * UTC - reference week number
  2589. * \var UBXAID_HUI::utcLS
  2590. * UTC - time difference due to leap seconds before event
  2591. * \var UBXAID_HUI::utcWNF
  2592. * UTC - week number when next leap second event occurs
  2593. * \var UBXAID_HUI::utcDN
  2594. * UTC - day of week when next leap second event occurs
  2595. * \var UBXAID_HUI::utcLSF
  2596. * UTC - time difference due to leap seconds after event
  2597. * \var UBXAID_HUI::utcSpare
  2598. * UTC - Spare to ensure structure is a multiple of 4 bytes
  2599. * \var UBXAID_HUI::klobA0
  2600. * Klobuchar - alpha 0
  2601. * \var UBXAID_HUI::klobA1
  2602. * Klobuchar - alpha 1
  2603. * \var UBXAID_HUI::klobA2
  2604. * Klobuchar - alpha 2
  2605. * \var UBXAID_HUI::klobA3
  2606. * Klobuchar - alpha 3
  2607. * \var UBXAID_HUI::klobB0
  2608. * Klobuchar - beta 0
  2609. * \var UBXAID_HUI::klobB1
  2610. * Klobuchar - beta 1
  2611. * \var UBXAID_HUI::klobB2
  2612. * Klobuchar - beta 2
  2613. * \var UBXAID_HUI::klobB3
  2614. * Klobuchar - beta 3
  2615. * \var UBXAID_HUI::flags
  2616. * Flags.
  2617. * \see #UBXHUIFlags to fill this field
  2618. */
  2619. /*!
  2620. * \struct UBXAID_INI_POLL
  2621. * \note No payload
  2622. * \brief Poll GPS Initial Aiding Data
  2623. */
  2624. /*!
  2625. * \struct UBXAID_INI
  2626. * This message contains position, time and clock drift information. The position can be input
  2627. * in either the ECEF X/Y/Z coordinate system or as lat/lon/height. The time can either be input
  2628. * as inexact value via the standard communication interface, suffering from latency
  2629. * depending on the baudrate, or using harware time synchronization where an accuracte
  2630. * time pulse is input on the external interrupts. It is also possible to supply hardware
  2631. * frequency aiding by connecting a continuous signal to an external interrupt.
  2632. * \brief Aiding position, time, frequency, clock drift
  2633. *
  2634. * \var UBXAID_INI::ecefXOrLat
  2635. * WGS84 ECEF X coordinate or latitude, depending on UBXAID_INI::flags
  2636. * \var UBXAID_INI::ecefYOrLat
  2637. * WGS84 ECEF Y coordinate or longitude, depending on UBXAID_INI::flags
  2638. * \var UBXAID_INI::ecefZOrLat
  2639. * WGS84 ECEF Z coordinate or altitude, depending on UBXAID_INI::flags
  2640. * \var UBXAID_INI::posAcc
  2641. * Position accuracy
  2642. * \var UBXAID_INI::tmCfg
  2643. * Time mark configuration
  2644. * \see #UBXINItmCfg to fill this field
  2645. * \var UBXAID_INI::wnoOrDate
  2646. * Actual week number or yearSince2000/Month (YYMM), depending on UBXAID_INI::flags
  2647. * \var UBXAID_INI::towOrDate
  2648. * Actual time of week or
  2649. * DayOfMonth/Hour/Minute/Second
  2650. * (DDHHMMSS), depending on UBXAID_INI::flags
  2651. * \var UBXAID_INI::towNs
  2652. * Fractional part of time of week
  2653. * \var UBXAID_INI::tAccMS
  2654. * Milliseconds part of time accuracy
  2655. * \var UBXAID_INI::tAccNS
  2656. * Nanoseconds part of time accuracy
  2657. * \var UBXAID_INI::clkDOrFreq
  2658. * Clock drift or frequency, depending on UBXAID_INI::flags
  2659. * \var UBXAID_INI::clkDAccOrFreqAcc
  2660. * Accuracy of clock drift or frequency, depending on UBXAID_INI::flags
  2661. * \var UBXAID_INI::flags
  2662. * Bitmask with the flags
  2663. * \see #UBXINIFlags to fill this field
  2664. */
  2665. /*!
  2666. * \struct UBXAID_REQ
  2667. * AID-REQ is not a message but a placeholder for configuration purposes.
  2668. * If the virtual AID-REQ is configured to be output (see CFG-MSG), the receiver will output a
  2669. * request for aiding data (AID-DATA) after a start-up if its internally stored data (position,
  2670. * time) don't allow it to perform a hot start. If position and time information could be
  2671. * retrieved from internal storage, no AID-REQ will be sent, even when the receiver is missing
  2672. * valid ephemeris data. Only GPS orbits are supported for GNSS.
  2673. * \note No payload
  2674. * \brief Sends a poll UXBAID_DATA for all GPS Aiding Data
  2675. */
  2676. /*!
  2677. * \struct UBXCFG_ANT_POLL
  2678. * Sending this (empty / no-payload) message to the receiver results in the receiver returning a
  2679. * message of type #UBXCFG_ANT
  2680. * \note No payload
  2681. * \brief Poll Antenna Control Settings
  2682. */
  2683. /*!
  2684. * \struct UBXANTPins
  2685. * It describes antenna pin configuration
  2686. * \brief This sturcture is a part of #UBXCFG_ANT message
  2687. * \var UBXANTPins::UBXANTpinSwitch
  2688. * PIO-Pin used for switching antenna supply (internal to TIM-LP/TIM-LF)
  2689. * \var UBXANTPins::UBXANTpinSCD
  2690. * PIO-Pin used for detecting a short in the antenna supply
  2691. * \var UBXANTPins::UBXANTpinOCD
  2692. * PIO-Pin used for detecting open/not connected antenna
  2693. * \var UBXANTPins::UBXANTreconfig
  2694. * If set to one, and this command is sent to the receiver, the receiver will reconfigure the pins as specified
  2695. */
  2696. /*!
  2697. * \struct UBXCFG_ANT
  2698. * \brief Antenna Control Settings
  2699. * \var UBXCFG_ANT::flags
  2700. * Antenna flag mask
  2701. * \see #UBXANTFlags to fill this field
  2702. * \var UBXCFG_ANT::pins
  2703. * Antenna Pin Configuration
  2704. */
  2705. /*!
  2706. * \struct UBXCFG_CFG
  2707. * See the Receiver Configuration chapter(u-blox© official documentation) for a detailed description on how Receiver
  2708. * Configuration should be used. The three masks are made up of individual bits, each bit
  2709. * indicating the sub-section of all configurations on which the corresponding action shall be
  2710. * carried out. The reserved bits in the masks must be set to '0'. For detailed information
  2711. * please refer to the Organization of the Configuration Sections (u-blox© official documentation). Please note that commands
  2712. * can be combined. The sequence of execution is Clear, Save, Load
  2713. * \brief Clear, Save and Load configurations
  2714. *
  2715. * \var UBXCFG_CFG::clearMask
  2716. * Mask with configuration sub-sections to Clear
  2717. * \note Load Default Configurations to Permanent
  2718. * Configurations in non-volatile memory
  2719. * \see #UBXCFGMask to fill this field
  2720. * \var UBXCFG_CFG::saveMask
  2721. * Mask with configuration sub-section to Save
  2722. * \note Save Current Configuration to Non-volatile
  2723. * Memory
  2724. * \see #UBXCFGMask to fill this field
  2725. * \var UBXCFG_CFG::loadMask
  2726. * Mask with configuration sub-sections to Load
  2727. * \note Load Permanent Configurations from
  2728. * Non-volatile Memory to Current
  2729. * Configurations
  2730. * \see #UBXCFGMask to fill this field
  2731. */
  2732. /*!
  2733. * \struct UBXCFG_CFG_OPT
  2734. * See the Receiver Configuration chapter(u-blox© official documentation) for a detailed description on how Receiver
  2735. * Configuration should be used. The three masks are made up of individual bits, each bit
  2736. * indicating the sub-section of all configurations on which the corresponding action shall be
  2737. * carried out. The reserved bits in the masks must be set to '0'. For detailed information
  2738. * please refer to the Organization of the Configuration Sections (u-blox© official documentation). Please note that commands
  2739. * can be combined. The sequence of execution is Clear, Save, Load
  2740. * \brief Clear, Save and Load configurations
  2741. *
  2742. * \var UBXCFG_CFG_OPT::clearMask
  2743. * Mask with configuration sub-sections to Clear
  2744. * \note Load Default Configurations to Permanent
  2745. * Configurations in non-volatile memory
  2746. * \see #UBXCFGMask to fill this field
  2747. * \var UBXCFG_CFG_OPT::saveMask
  2748. * Mask with configuration sub-section to Save
  2749. * \note Save Current Configuration to Non-volatile
  2750. * Memory
  2751. * \see #UBXCFGMask to fill this field
  2752. * \var UBXCFG_CFG_OPT::loadMask
  2753. * Mask with configuration sub-sections to Load
  2754. * \note Load Permanent Configurations from
  2755. * Non-volatile Memory to Current
  2756. * Configurations
  2757. * \see #UBXCFGMask to fill this field
  2758. * \var UBXCFG_CFG_OPT::deviceMask
  2759. * Mask which selects the devices for this
  2760. * command
  2761. * \see #UBXCFGDeviceMask to fill this field
  2762. */
  2763. /*!
  2764. * \struct UBXCFG_DAT_POLL
  2765. * Upon sending of this message, the receiver returns UBXCFG_DAT
  2766. * \note No payload
  2767. * \brief Poll Datum Setting
  2768. */
  2769. /*!
  2770. * \struct UBXCFG_DAT_IN
  2771. * \brief Set User-defined Datum
  2772. *
  2773. * \var UBXCFG_DAT_IN::majA
  2774. * Semi-major Axis
  2775. * \note accepted range = 6,300,000.0
  2776. * to 6,500,000.0 metres
  2777. * \var UBXCFG_DAT_IN::flat
  2778. * 1.0 / Flattening
  2779. * \note accepted range is 0.0 to 500.0
  2780. * \var UBXCFG_DAT_IN::dX
  2781. * X Axis shift at the origin
  2782. * \note accepted range is +/-5000.0 metres
  2783. * \var UBXCFG_DAT_IN::dY
  2784. * Y Axis shift at the origin
  2785. * \note accepted range is +/-5000.0 metres
  2786. * \var UBXCFG_DAT_IN::dZ
  2787. * Z Axis shift at the origin
  2788. * \note accepted range is +/-5000.0 metres
  2789. * \var UBXCFG_DAT_IN::rotX
  2790. * Rotation about the X Axis
  2791. * \note accepted range is +/-20.0 milli-arc seconds
  2792. * \var UBXCFG_DAT_IN::rotY
  2793. * Rotation about the Y Axis
  2794. * \note accepted range is +/-20.0 milli-arc seconds
  2795. * \var UBXCFG_DAT_IN::rotZ
  2796. * Rotation about the Z Axis
  2797. * \note accepted range is +/-20.0 milli-arc seconds
  2798. * \var UBXCFG_DAT_IN::scale
  2799. * Scale change
  2800. * \note accepted range is 0.0 to 50.0 parts per million
  2801. */
  2802. /*!
  2803. * \struct UBXCFG_DAT_OUT
  2804. * Returns the parameters of the currently defined datum. If no user-defined datum has been
  2805. * set, this will default to WGS84.
  2806. * \brief The currently defined Datum
  2807. * \var UBXCFG_DAT_OUT::datumNum
  2808. * Datum Number: 0 = WGS84, -1 = user-defined
  2809. * \var UBXCFG_DAT_OUT::datumName[6]
  2810. * ASCII String: WGS84 or USER
  2811. * \var UBXCFG_DAT_OUT::majA
  2812. * Semi-major Axis
  2813. * \note accepted range = 6,300,000.0
  2814. * to 6,500,000.0 metres
  2815. * \var UBXCFG_DAT_OUT::flat
  2816. * 1.0 / Flattening
  2817. * \note accepted range is 0.0 to 500.0
  2818. * \var UBXCFG_DAT_OUT::dX
  2819. * X Axis shift at the origin
  2820. * \note accepted range is +/-5000.0 metres
  2821. * \var UBXCFG_DAT_OUT::dY
  2822. * Y Axis shift at the origin
  2823. * \note accepted range is +/-5000.0 metres
  2824. * \var UBXCFG_DAT_OUT::dZ
  2825. * Z Axis shift at the origin
  2826. * \note accepted range is +/-5000.0 metres
  2827. * \var UBXCFG_DAT_OUT::rotX
  2828. * Rotation about the X Axis
  2829. * \note accepted range is +/-20.0 milli-arc seconds
  2830. * \var UBXCFG_DAT_OUT::rotY
  2831. * Rotation about the Y Axis
  2832. * \note accepted range is +/-20.0 milli-arc seconds
  2833. * \var UBXCFG_DAT_OUT::rotZ
  2834. * Rotation about the Z Axis
  2835. * \note accepted range is +/-20.0 milli-arc seconds
  2836. * \var UBXCFG_DAT_OUT::scale
  2837. * Scale change
  2838. * \note accepted range is 0.0 to 50.0 parts per million
  2839. */
  2840. /*!
  2841. * \struct UBXCFG_GNSS_POLL
  2842. * Polls the configuration of the GNSS system configuration\
  2843. * \note No payload
  2844. * \brief Polls the configuration of the GNSS system configuration
  2845. */
  2846. /*!
  2847. * \struct UBXCFG_GNSS
  2848. * Gets or sets the GNSS system channel sharing configuration. The receiver will send an
  2849. * #UBXACK_ACK message if the configuration is valid, an #UBXACK_NACK if any configuration
  2850. * parameter is invalid.
  2851. * The number of tracking channels in use must not exceed the number of tracking channels
  2852. * available on hardware, and the sum of all reserved tracking channels needs to be smaller or
  2853. * equal the number of tracking channels in use. Additionally, the maximum number of
  2854. * tracking channels used for the specific GNSS system must be greater or equal to the
  2855. * number of reserved tracking channels.
  2856. * See section GNSS Configuration for a discussion of the use of this message and section
  2857. * Satellite Numbering for a description of the GNSS IDs available.
  2858. * Configuration specific to the GNSS system can be done via other messages. Configuration
  2859. * specific to SBAS can be done with #UBXCFG_SBAS.
  2860. * Note that GLONASS operation cannot be selected when the receiver is configured to
  2861. * operate in Power Save Mode (using #UBXCFG_RXM).
  2862. * \note This message contains variable payload. See #UBXCFG_GNSS_PART to add variable payload.
  2863. * \brief GNSS system configuration
  2864. *
  2865. * \var UBXCFG_GNSS::msgVer
  2866. * Message version
  2867. * \var UBXCFG_GNSS::numTrkChHw
  2868. * Number of tracking channels available in
  2869. * hardware
  2870. * \note Read only
  2871. * \var UBXCFG_GNSS::numTrkChUse
  2872. * Number of tracking channels to use
  2873. * \note Should be <= UBXCFG_GNSS::numTrkChHw
  2874. * \var UBXCFG_GNSS::numConfigBlocks
  2875. * Number of configuration blocks following
  2876. */
  2877. /*!
  2878. * \struct UBXCFG_GNSS_PART
  2879. * \brief This structure is variable payload for #UBXCFG_GNSS
  2880. * \var UBXCFG_GNSS_PART::gnssId
  2881. * GNSS identifier
  2882. * \see #UBXGNSSIds to fill this field
  2883. * \var UBXCFG_GNSS_PART::resTrkCh
  2884. * Number of reserved (minimum) tracking
  2885. * channels for this GNSS system
  2886. * \var UBXCFG_GNSS_PART::maxTrkCh
  2887. * Maximum number of tracking channels used for
  2888. * this GNSS system
  2889. * \note should be >= UBXCFG_GNSS_PART::resTrkCh
  2890. * \var UBXCFG_GNSS_PART::reserved1
  2891. * Reserved
  2892. * \var UBXCFG_GNSS_PART::flags
  2893. * Bitfield of flags.\n
  2894. * The only acceptable values:\n
  2895. * - 0 - disabled
  2896. * - 1 - enabled
  2897. */
  2898. /*!
  2899. * \struct UBXCFG_INF_POLL
  2900. * \brief Poll INF message configuration for one protocol
  2901. *
  2902. * \var protocolId
  2903. * Protocol Identifier, identifying the output
  2904. * protocol for this Poll Request.
  2905. * \see #UBXCFGProtocolIds to fill this field
  2906. */
  2907. /*!
  2908. * \struct UBXCFG_INF
  2909. * The value of infMsgMask[x] below are that each bit represents one of the INF class
  2910. * messages (Bit 0 for ERROR, Bit 1 for WARNING and so on.). For a complete list, please see
  2911. * the Message Class INF(). Several configurations can be concatenated to one input
  2912. * message. In this case the payload length can be a multiple of the normal length. Output
  2913. * messages from the module contain only one configuration unit. Please note that I/O Ports 1
  2914. * and 2 correspond to serial ports 1 and 2. I/O port 0 is DDC. I/O port 3 is USB. I/O port 4 is
  2915. * SPI. I/O port 5 is reserved for future use.
  2916. * \note This message has variable payload of #UBXCFG_INF_PART type
  2917. * \brief Information message configuration
  2918. */
  2919. /*!
  2920. * \struct UBXCFG_INF_PART
  2921. * \brief The UBXCFG_INF_PART structure is variable payload for #UBXCFG_INF message
  2922. *
  2923. * \var protocolId
  2924. * Protocol Identifier, identifying for which
  2925. * protocol the configuration is set/get
  2926. * \see #UBXCFGProtocolIds to fill this field
  2927. * \var reserved0
  2928. * Reserved
  2929. * \var reserved1
  2930. * Reserved
  2931. * \var infMsgMask[6]
  2932. * A bit mask, saying which information messages
  2933. * are enabled on each I/O port
  2934. * \see #UBXCFGInfMsgMask to fill this field
  2935. */
  2936. /*!
  2937. * \struct UBXCFG_ITFM_POLL
  2938. * \note No payload
  2939. * \brief Polls the Jamming/Interference Monitor configuration.
  2940. */
  2941. /*!
  2942. * \struct UBXITFMConfig
  2943. * \brief This structure describes bitfields of UBXCFG_ITFM::config field
  2944. * \var UBXITFMConfig::bbThreshold
  2945. * Broadband jamming detection threshold
  2946. * \note unit - dB
  2947. * \var UBXITFMConfig::cwThreshold
  2948. * CW jamming detection threshold
  2949. * \note unit - dB
  2950. * \var UBXITFMConfig::reserved1
  2951. * Reserved algorithm settings
  2952. * \note should be set to 0x16B156
  2953. * \var UBXITFMConfig::enbled
  2954. * Enable interference detection
  2955. */
  2956. /*!
  2957. * \struct UBXITFMConfig2
  2958. * \brief This structure describes bitfields of UBXCFG_ITFM::config2 field
  2959. * \var UBXITFMConfig2::reserved2
  2960. * Reserved
  2961. * \note Should be 0x31E
  2962. * \var UBXITFMConfig2::antSetting
  2963. * Antenna setting
  2964. * \see #UBXITFMAntSetting to fill this field
  2965. * \var UBXITFMConfig2::reserved3
  2966. * Reserved
  2967. * \note Should be 0x00
  2968. */
  2969. /*!
  2970. * \struct UBXCFG_ITFM
  2971. * \brief Jamming/Interference Monitor configuration
  2972. *
  2973. * \var UBXCFG_ITFM::config
  2974. * Interference config word
  2975. * \see #UBXITFMConfig to fill this field
  2976. * \var UBXCFG_ITFM::config2
  2977. * Extra settings for jamming/interference monitor
  2978. * \see #UBXITFMConfig2 to fill this field
  2979. */
  2980. /*!
  2981. * \struct UBXCFG_LOGFILTER_POLL
  2982. * Upon sending of this message, the receiver returns CFG-LOGFILTER as defined below
  2983. * \note No payload
  2984. * \brief Poll Data Logger filter Configuration
  2985. */
  2986. /*!
  2987. * \struct UBXCFG_LOGFILTER
  2988. * This message is used to enable/disable logging and to get or set the position entry filter
  2989. * settings.
  2990. * Position entries can be filtered based on time difference, position difference or current
  2991. * speed thresholds. Position and speed filtering also have a minimum time interval.
  2992. * A position is logged if any of the thresholds are exceeded. If a threshold is set to zero it is
  2993. * ignored. The maximum rate of position logging is 1Hz.
  2994. * The filter settings will only be applied if the 'applyAllFilterSettings' flag is set. This enables
  2995. * recording to be enabled/disabled without affecting the other settings.
  2996. * \brief Data Logger Configuration
  2997. *
  2998. * \var UBXCFG_LOGFILTER::version
  2999. * The version of this message
  3000. * \note Set to 1
  3001. * \var UBXCFG_LOGFILTER::flags
  3002. * Flags
  3003. * \see #UBXLOGFILTERFlags to fill this field
  3004. * \var UBXCFG_LOGFILTER::minIterval
  3005. * Minimum time interval between logged
  3006. * positions
  3007. * \note This is only applied in
  3008. * combination with the speed and/or
  3009. * position thresholds
  3010. * \note 0 - not set
  3011. * \var UBXCFG_LOGFILTER::timeThreshold
  3012. * If the time difference is greater than the
  3013. * threshold then the position is logged
  3014. * \note 0 - not set
  3015. * \var UBXCFG_LOGFILTER::speedThreshold
  3016. * If the current speed is greater than the
  3017. * threshold then the position is logged
  3018. * \note 0 - not set
  3019. * \note UBXCFG_LOGFILTER::minInterval also applies
  3020. * \var UBXCFG_LOGFILTER::positionThreshold
  3021. * If the 3D position difference is greater than the
  3022. * threshold then the position is logged
  3023. * \note 0 - not set
  3024. * \note minInterval also applies
  3025. */
  3026. /*!
  3027. * \struct UBXCFG_MSG_POLL
  3028. * \brief Poll a message configuration
  3029. *
  3030. * \var UBXCFG_MSG_POLL::msgClass
  3031. * Message Class
  3032. * \see #UBXMessageClass to fill this field
  3033. * \var UBXCFG_MSG_POLL::msgId
  3034. * Message Id
  3035. * \see #UBXMessageId to fill this field
  3036. */
  3037. /*!
  3038. * \struct UBXCFG_MSG_RATES
  3039. * Set/Get message rate configurations to/from the receiver. See also section "How to change
  3040. * between protocols" (u-blox© official documentation).
  3041. * - Send rate is relative to the event a message is registered on. For example, if the rate of a
  3042. * navigation message is set to 2, the message is sent every second navigation solution. For
  3043. * configuring NMEA messages, the section "NMEA Messages Overview" (u-blox© official documentation describes Class and
  3044. * Identifier numbers used.
  3045. * \brief Set Message Rates
  3046. * \var UBXCFG_MSG_RATES::msgClass
  3047. * Message Class
  3048. * \see #UBXMessageClass to fill this field
  3049. * \var UBXCFG_MSG_RATES::msgId
  3050. * Message Id
  3051. * \see #UBXMessageId to fill this field
  3052. * \var UBXCFG_MSG_RATES::rate[6]
  3053. * Send rate on I/O Port (6 Ports)
  3054. */
  3055. /*!
  3056. * \struct UBXCFG_MSG_RATE
  3057. * Set/Get message rate configurations to/from the receiver. See also section "How to change
  3058. * between protocols" (u-blox© official documentation).
  3059. * \brief Set Message Rate
  3060. * \var UBXCFG_MSG_RATE::msgClass
  3061. * Message Class
  3062. * \see #UBXMessageClass to fill this field
  3063. * \var UBXCFG_MSG_RATE::msgId
  3064. * Message Id
  3065. * \see #UBXMessageId to fill this field
  3066. * \var UBXCFG_MSG_RATE::rate
  3067. * Send rate on current Port
  3068. */
  3069. /*!
  3070. * \struct UBXCFG_NAV5_POLL
  3071. * \note No payload
  3072. * \brief Poll Navigation Engine Settings
  3073. */
  3074. /*!
  3075. * \struct UBXCFG_NAV5
  3076. * See the Navigation "Configuration Settings Description" (u-blox© official documentation) for a detailed description of how
  3077. * these settings affect receiver operation.
  3078. * \brief Navigation Engine Settings
  3079. *
  3080. * \var mask
  3081. * Parameters Bitmask. Only the masked parameters will be applied.
  3082. * \see #UBXNAV5Mask to fill this field
  3083. * \var UBXCFG_NAV5::dynModel
  3084. * Dynamic Platform model
  3085. * \see #UBXNAV5Model to fill this field
  3086. * \var UBXCFG_NAV5::fixMode
  3087. * Position Fixing Mode
  3088. * \see #UBXNAV5FixMode to fill this field
  3089. * \var UBXCFG_NAV5::fixedAlt
  3090. * Fixed altitude (mean sea level) for 2D fix mode
  3091. * \var UBXCFG_NAV5::fixedAltVar
  3092. * Fixed altitude variance for 2D mode
  3093. * \var UBXCFG_NAV5::minElev
  3094. * Minimum Elevation for a GNSS satellite to be
  3095. * used in NAV
  3096. * \var UBXCFG_NAV5::drLimit
  3097. * Reserved
  3098. * \var UBXCFG_NAV5::pDop
  3099. * Position DOP Mask to use
  3100. * \var UBXCFG_NAV5::tDop
  3101. * Time DOP Mask to use
  3102. * \var UBXCFG_NAV5::pAcc
  3103. * Position Accuracy Mask
  3104. * \var UBXCFG_NAV5::tAcc
  3105. * Time Accuracy Mask
  3106. * \var UBXCFG_NAV5::staticHoldThresh
  3107. * Static hold threshold
  3108. * \var UBXCFG_NAV5::dgpsTimeOut
  3109. * DGPS timeout
  3110. * \var UBXCFG_NAV5::cnoThreshNumSVs
  3111. * Number of satellites required to have C/N0
  3112. * above cnoThresh for a fix to be attempted
  3113. * \var UBXCFG_NAV5::cnoThresh
  3114. * C/N0 threshold for deciding whether to attempt
  3115. * a fix
  3116. * \var UBXCFG_NAV5::reserved2
  3117. * Reserved
  3118. * \note Set to 0
  3119. * \var UBXCFG_NAV5::reserved3
  3120. * Reserved
  3121. * \note Set to 0
  3122. * \var UBXCFG_NAV5::reserved4
  3123. * Reserved
  3124. * \note Set to 0
  3125. */
  3126. /*!
  3127. * \struct UBXCFG_NAVX5_POLL
  3128. * Sending this (empty / no-payload) message to the receiver results in the receiver returning a
  3129. * message of type CFG-NAVX5 with a payload as defined below.
  3130. * \note No payload
  3131. * \brief Poll Navigation Engine Expert Settings
  3132. */
  3133. /*!
  3134. * \struct UBXCFG_NAVX5
  3135. * \brief Navigation Engine Expert Settings
  3136. *
  3137. * \var UBXCFG_NAVX5::version
  3138. * Message version
  3139. * \note 0 for this version
  3140. * \var UBXCFG_NAVX5::mask1
  3141. * First Parameters Bitmask. Only the flagged
  3142. * parameters will be applied, unused bits must be
  3143. * set to 0
  3144. * \see #UBXNAVX5Mask to fill this field
  3145. * \var UBXCFG_NAVX5::reserved0
  3146. * Reserved
  3147. * \note Set to 0
  3148. * \var UBXCFG_NAVX5::reserved1
  3149. * Reserved
  3150. * \note Set to 0
  3151. * \var UBXCFG_NAVX5::reserved2
  3152. * Reserved
  3153. * \note Set to 0
  3154. * \var UBXCFG_NAVX5::minSVs
  3155. * Minimum number of satellites for navigation
  3156. * \var UBXCFG_NAVX5::maxSVs
  3157. * Maximum number of satellites for navigation
  3158. * \var UBXCFG_NAVX5::minCNO
  3159. * Minimum satellite signal level for navigation
  3160. * \var UBXCFG_NAVX5::reserved5
  3161. * Reserved
  3162. * \note Set to 0
  3163. * \var UBXCFG_NAVX5::iniFix3D
  3164. * Initial Fix must be 3D flag
  3165. * \note
  3166. * - 0 - false
  3167. * - 1 - true
  3168. * \var UBXCFG_NAVX5::reserved6
  3169. * Reserved
  3170. * \note Set to 0
  3171. * \var UBXCFG_NAVX5::reserved7
  3172. * Reserved
  3173. * \note Set to 0
  3174. * \var UBXCFG_NAVX5::reserved8
  3175. * Reserved
  3176. * \note Set to 0
  3177. * \var UBXCFG_NAVX5::wknRollover
  3178. * GPS week rollover number; GPS week numbers
  3179. * will be set correctly from this week up to 1024
  3180. * weeks after this week.
  3181. * \note 0 reverts to firmware default.
  3182. * \var UBXCFG_NAVX5::reserved9
  3183. * Reserved
  3184. * \note Set to 0
  3185. * \var UBXCFG_NAVX5::reserved10
  3186. * Reserved
  3187. * \note Set to 0
  3188. * \var UBXCFG_NAVX5::reserved11
  3189. * Reserved
  3190. * \note Set to 0
  3191. * \var UBXCFG_NAVX5::usePPP
  3192. * Use Precise Point Positioning flag
  3193. * \note Only supported on certain product variants
  3194. * \note
  3195. * - 0 - false
  3196. * - 1 - true
  3197. * \var UBXCFG_NAVX5::aopCFG
  3198. * AssistNow Autonomous configuration
  3199. * /note
  3200. * - 0 - disabled
  3201. * - 1 - enabled
  3202. * \var UBXCFG_NAVX5::reserved12
  3203. * \note Set to 0
  3204. * \var UBXCFG_NAVX5::reserved13
  3205. * Reserved
  3206. * \note Set to 0
  3207. * \var UBXCFG_NAVX5::aopOrbMaxErr
  3208. * maximum acceptable (modelled) AssistNow
  3209. * Autonomous orbit error
  3210. * \note valid range = 5..1000,
  3211. * \note 0 - reset to firmware default
  3212. * \var UBXCFG_NAVX5::reserved14
  3213. * Reserved
  3214. * \note Set to 0
  3215. * \var UBXCFG_NAVX5::reserved15
  3216. * Reserved
  3217. * \note Set to 0
  3218. * \var UBXCFG_NAVX5::reserved3
  3219. * Reserved
  3220. * \note Set to 0
  3221. * \var UBXCFG_NAVX5::reserved4
  3222. * Reserved
  3223. * \note Set to 0
  3224. */
  3225. /*!
  3226. * \struct UBXCFG_NMEA_POLL
  3227. * \note No payload
  3228. * \brief Poll the NMEA protocol configuration
  3229. */
  3230. /*!
  3231. * \struct UBXCFG_NMEA
  3232. * Set/Get the NMEA protocol configuration. See section "NMEA Protocol Configuration" (u-blox© official documentation) for a
  3233. * detailed description of the configuration effects on NMEA output.
  3234. * \brief NMEA protocol configuration
  3235. *
  3236. * \var UBXCFG_NMEA::filter
  3237. * Filter flags
  3238. * \see #UBXNMEAFilter to fill this field
  3239. * \var UBXCFG_NMEA::nmeaVersion
  3240. * NMEA version
  3241. * \see #UBXNMEAVersion to fill this field
  3242. * \var UBXCFG_NMEA::numSV
  3243. * Maximum Number of SVs to report in NMEA
  3244. * protocol.\n
  3245. * This does not affect the receiver's operation.
  3246. * It only limits the number of SVs reported in
  3247. * NMEA mode (this might be needed with older
  3248. * mapping applications which only support 8- or
  3249. * 12-channel receivers).
  3250. * \var UBXCFG_NMEA::flags
  3251. * Flags
  3252. * \see #UBXNMEAFlags to fill this field
  3253. * \var UBXCFG_NMEA::gnssToFilter
  3254. * Filters out satellites based on their GNSS. If a
  3255. * bitfield is enabled, the corresponding satellites
  3256. * will be not output.
  3257. * \see #UBXNMEAGNSSToFilter to fill this field
  3258. * \var UBXCFG_NMEA::svNumbering
  3259. * Configures the display of satellites that do not
  3260. * have an NMEA-defined value.
  3261. * \note This does not apply to satellites with an
  3262. * unknown ID.
  3263. * \var UBXCFG_NMEA::mainTalkerId
  3264. * By default the main Talker ID (i.e. the Talker ID
  3265. * used for all messages other than GSV) is
  3266. * determined by the GNSS assignment of the
  3267. * receiver's channels (see #UBXCFG_GNSS).
  3268. * This field enables the main Talker ID to be
  3269. * overridden.
  3270. * \var UBXCFG_NMEA::gsvTalkerId
  3271. * By default the Talker ID for GSV messages is
  3272. * GNSS specific (as defined by NMEA).
  3273. * This field enables the GSV Talker ID to be
  3274. * overridden.
  3275. * \var UBXCFG_NMEA::reserved
  3276. * Reserved
  3277. * \note Set to 0
  3278. */
  3279. /*!
  3280. * \struct UBXCFG_NVS
  3281. * Three masks are made up of individual bits that indicate which data is to be cleared, saved
  3282. * and/or loaded. The fourth mask defines on which devices the corresponding action shall be
  3283. * carried out. Please note that only one command should be flagged at once. Otherwise all
  3284. * commands are processed in the order Clear, Save, and Load. All reserved bits must be set
  3285. * to zero.
  3286. * \brief Clear, Save and Load non-volatile storage data
  3287. * \var UBXCFG_NVS::clearMask
  3288. * Mask of data to be cleared
  3289. * \see #UBXCFGMask CFG_NVS section to fill this field
  3290. * \var UBXCFG_NVS::saveMask
  3291. * Mask of data to be saved
  3292. * \see #UBXCFGMask CFG_NVS section to fill this field
  3293. * \var UBXCFG_NVS::loadMask
  3294. * Mask of data to be loaded,
  3295. * \see #UBXCFGMask CFG_NVS section to fill this field
  3296. * \var UBXCFG_NVS::deviceMask
  3297. * Mask of devices to consider
  3298. * \note Default: all devices
  3299. * \see #UBXCFGDeviceMask to fill this field
  3300. */
  3301. /*!
  3302. * \struct UBXCFG_PM2_POLL
  3303. * \note No payload
  3304. * \brief Poll extended Power Management configuration
  3305. */
  3306. /*!
  3307. * \struct UBXCFG_PM2Flags
  3308. * \brief Implements bitmask for UBXCFG_PM2::flags
  3309. * \var UBXCFG_PM2Flags::blank1
  3310. * Stub to make gap
  3311. * \var UBXCFG_PM2Flags::reserved
  3312. * Reserved
  3313. * \note Must be set to '000'
  3314. * \var UBXCFG_PM2Flags::extIntSelect
  3315. * EXTINT Pin Select
  3316. * \note
  3317. * - 0 - EXTINT0
  3318. * - 1 - EXTINT1
  3319. * \var UBXCFG_PM2Flags::extIntWake
  3320. * EXTINT Pin Control
  3321. * \note
  3322. * - 0 - disabled
  3323. * - 1 - enabled, force receiver into BACKUP mode when selected EXTINT pin is 'low'
  3324. * \var UBXCFG_PM2Flags::extIntBackup
  3325. * EXTINT Pin Control
  3326. * - 0 - disabled
  3327. * - 1 - enabled, force receiver into BACKUP mode when selected EXTINT pin is 'low'
  3328. * \var UBXCFG_PM2Flags::blank2
  3329. * Stub to make gap
  3330. * \var UBXCFG_PM2Flags::limitPeakCurr
  3331. * Limit Peak Current
  3332. * \see #UBXPM2LimitPeakCurrent to fill this field
  3333. * \var UBXCFG_PM2Flags::waitTimeFix
  3334. * Wait for Timefix
  3335. * \note
  3336. * - 0 - wait for normal Fix ok, before starting on-time
  3337. * - 1 - wait for time fix ok, before starting on-time
  3338. * \var UBXCFG_PM2Flags::updateRTC
  3339. * Update Real Time Clock
  3340. * - 0 - Do not wake-up to update RTC. RTC is updated during normal on-time.
  3341. * - 1 - Update RTC. The receiver adds extra wake-up cycles to update the RTC.
  3342. * \var UBXCFG_PM2Flags::updateEPH
  3343. * Update Ephemeris
  3344. * - 0 - Do not wake-up to update Ephemeris data
  3345. * - 1 - Update Ephemeris. The receiver adds extra wake-up cycles to update the Ephemeris data
  3346. * \var UBXCFG_PM2Flags::blank3
  3347. * Stub to make gap
  3348. * \var UBXCFG_PM2Flags::doNotEnterOff
  3349. * Behavior of receiver in case of no fix
  3350. * - 0 - receiver enters inactive for search state
  3351. * - 1 - receiver does not enter inactive for search state but keeps trying to acquire a fix instead
  3352. * \var UBXCFG_PM2Flags::mode
  3353. * Mode of operation
  3354. * \see #UBXPM2Mode to fill this field
  3355. */
  3356. /*!
  3357. * \struct UBXCFG_PM2
  3358. * \brief Extended Power Management configuration
  3359. * \var UBXCFG_PM2::version
  3360. * Message version
  3361. * \note 1 for this version
  3362. * \var UBXCFG_PM2::reserved1
  3363. * Reserved
  3364. * \var UBXCFG_PM2::reserved2
  3365. * Reserved
  3366. * \var UBXCFG_PM2::reserved3
  3367. * Reserved
  3368. * \var UBXCFG_PM2::flags
  3369. * PSM configuration flags
  3370. * \note See UBXCFG_PM2Flags to fill this field
  3371. * \var UBXCFG_PM2::updatePeriod
  3372. * Position update period.
  3373. * \note If set to 0, the receiver will never retry a fix
  3374. * \var UBXCFG_PM2::searchPeriod
  3375. * Acquisition retry period
  3376. * \note If set to 0, the receiver will never retry a startup
  3377. * \var UBXCFG_PM2::gridOffset
  3378. * Grid offset relative to GPS start of week
  3379. * \var UBXCFG_PM2::onTime
  3380. * On time after first successful fix
  3381. * \var UBXCFG_PM2::minAcqTime
  3382. * Minimal search time
  3383. * \var UBXCFG_PM2::reserved4
  3384. * Reserved
  3385. * \var UBXCFG_PM2::reserved5
  3386. * Reserved
  3387. * \var UBXCFG_PM2::reserved6
  3388. * Reserved
  3389. * \var UBXCFG_PM2::reserved7
  3390. * Reserved
  3391. * \var UBXCFG_PM2::reserved8
  3392. * Reserved
  3393. * \var UBXCFG_PM2::reserved9
  3394. * Reserved
  3395. * \var UBXCFG_PM2::reserved10
  3396. * Reserved
  3397. * \var UBXCFG_PM2::reserved11
  3398. * Reserved
  3399. */
  3400. /*!
  3401. * \struct UBXCFG_PRT_POLL
  3402. * \note No payload
  3403. * \brief Polls the configuration of the used I/O Port
  3404. */
  3405. /*!
  3406. * \struct UBXCFG_PRT_POLL_OPT
  3407. * \brief Polls the configuration for one I/O Port
  3408. *
  3409. * \var UBXCFG_PRT_POLL_OPT::portId
  3410. * Port Identifier Number
  3411. * \see #UBXCFG_PRT for valid values
  3412. */
  3413. /*!
  3414. * \struct UBXCFG_PRTTxReady
  3415. * \brief This structure described TX ready PIN configuration for UBXCFG_PRT::txReady
  3416. * \var UBXCFG_PRTTxReady::en
  3417. * Enable TX ready feature for this port
  3418. * \note
  3419. * - 0 - disable
  3420. * - 1 - enabled
  3421. * \var UBXCFG_PRTTxReady::pol
  3422. * Polarity
  3423. * - 0 - High-active
  3424. * - 1 - Low-active
  3425. * \var UBXCFG_PRTTxReady::pin
  3426. * PIO to be used
  3427. * \note must not be in use already by another function
  3428. * \var UBXCFG_PRTTxReady::thres
  3429. * Threshold
  3430. * The TX ready PIN goes active after >= thres*8 bytes are pending for the port and going inactive after the last
  3431. * pending bytes have been written to hardware (0-4 bytes before end of stream).
  3432. * \note Given value is multiplied by 8 bytes
  3433. */
  3434. /*!
  3435. * \struct UBXCFG_PRTUARTMode
  3436. * It is part of #UBXCFG_PRTMode union
  3437. * \brief This structure describes port settings for UART
  3438. * \var UBXCFG_PRTUARTMode::blank0
  3439. * Stub for gap
  3440. * \var UBXCFG_PRTUARTMode::reserved1
  3441. * Reserved
  3442. * \note Set to 1 for compatibility with A4
  3443. * \var UBXCFG_PRTUARTMode::blank1
  3444. * Stub for gap
  3445. * \var UBXCFG_PRTUARTMode::charLen
  3446. * Character Length
  3447. * \see #UBXPRTModeCharLen to fill this field
  3448. * \var UBXCFG_PRTUARTMode::blank2
  3449. * Stub for gap
  3450. * \var UBXCFG_PRTUARTMode::parity
  3451. * Parity
  3452. * \see #UBXPRTModeParity to fill this field
  3453. * \var UBXCFG_PRTUARTMode::nStopBits
  3454. * Number of Stop Bits
  3455. * \see #UBXPRTModeStopBits to fill this field
  3456. * \var UBXCFG_PRTUARTMode::blank3
  3457. * Stub for gap
  3458. */
  3459. /*!
  3460. * \struct UBXCFG_PRTSPIMode
  3461. * It is part of #UBXCFG_PRTMode union
  3462. * \brief This structure describes port settings for SPI
  3463. * \var UBXCFG_PRTSPIMode::blank0
  3464. * Stub for gap
  3465. * \var UBXCFG_PRTSPIMode::spiMode
  3466. * Mode
  3467. * \see #UBXPRTSPIMode to fill this field
  3468. * \var UBXCFG_PRTSPIMode::blank1
  3469. * Stub for gap
  3470. * \var UBXCFG_PRTSPIMode::flowControl
  3471. * Flow control
  3472. * \note
  3473. * - 0 - disabled
  3474. * - 1 - enabled
  3475. * \var UBXCFG_PRTSPIMode::blank2
  3476. * Stub for gap
  3477. * \var UBXCFG_PRTSPIMode::ffCnt
  3478. * Number of bytes containing 0xFF to receive before switching off reception.
  3479. * \note Range: 0(mechanism off)-255
  3480. * \var UBXCFG_PRTSPIMode::blank3
  3481. * Stub for gap
  3482. */
  3483. /*!
  3484. * \struct UBXCFG_PRTDDCMode
  3485. * It is part of #UBXCFG_PRTMode union
  3486. * \brief This structure describes port settings for DDC(I2C)
  3487. * \var UBXCFG_PRTDDCMode::blank0
  3488. * Stub for gap
  3489. * \var UBXCFG_PRTDDCMode::slaveAddr
  3490. * Slave address
  3491. * \note Range: 0x07 < slaveAddr < 0x78. Bit 0 shall be 0
  3492. * \var UBXCFG_PRTDDCMode::blank1
  3493. * Stub for gap
  3494. */
  3495. /*!
  3496. * \union UBXCFG_PRTMode
  3497. * It is used to fill UBXCFG_PRT::mode field
  3498. * \brief This union contains mode settings for all ports
  3499. * \var UBXCFG_PRTMode::UART
  3500. * UART mode settings
  3501. * \var UBXCFG_PRTMode::SPI
  3502. * SPI mode settings
  3503. * \var UBXCFG_PRTMode::DDC
  3504. * DDC mode settings
  3505. * \var UBXCFG_PRTMode::USB
  3506. * Reserved
  3507. * \note for USB port there are no mode settings
  3508. */
  3509. /*!
  3510. * \union UBXCFG_PRT5Option
  3511. * \brief This union used as 5-th option of #UBXCFG_PRT
  3512. * \var UBXCFG_PRT5Option::UARTbaudRate
  3513. * Setup baudrate for UART ports
  3514. * \var UBXCFG_PRT5Option::OtherReserved
  3515. * Setting is reserved for all ports except UART
  3516. */
  3517. /*!
  3518. * \struct UBXCFG_PRT
  3519. * For more detailed description please look at official u-blox© documentation
  3520. * \brief Port Configuration message scope for all ports
  3521. * \var UBXCFG_PRT::portID
  3522. * Port Identifier Number
  3523. * \var UBXCFG_PRT::reserved0
  3524. * Reserved for all ports
  3525. * \var UBXCFG_PRT::txReady
  3526. * \see #UBXCFG_PRTTxReady to fill this field
  3527. * TX ready PIN configuration
  3528. * \var UBXCFG_PRT::mode;
  3529. * A bit mask describing port mode
  3530. * \see #UBXCFG_PRTMode to fille this field
  3531. * \var UBXCFG_PRT::option;
  3532. * Optional block
  3533. * \see #UBXCFG_PRT5Option to fill this field
  3534. * \var UBXCFG_PRT::inProtoMask
  3535. * A mask describing which input protocols are
  3536. * active.
  3537. * Each bit of this mask is used for a protocol.
  3538. * \note Multiple protocols can be defined
  3539. * on a single port.
  3540. * \see #UBXPRTInProtoMask to fill this field
  3541. * \var UBXCFG_PRT::outProtoMask
  3542. * A mask describing which output protocols are
  3543. * active.
  3544. * Each bit of this mask is used for a protocol.
  3545. * \note Multiple protocols can be defined
  3546. * on a single port
  3547. * \see #UBXPRTOutProtoMask to fill this field
  3548. * \var UBXCFG_PRT::flags
  3549. * Flags bit mask
  3550. * \see #UBXPRTFlags to fill this field
  3551. * \note Shall be 0 for USB
  3552. * \var UBXCFG_PRT::reserved5
  3553. * Reserved
  3554. * \note Always set to 0
  3555. */
  3556. /*!
  3557. * \struct UBXCFG_RATE_POLL
  3558. * Sending this message to the receiver results in the receiver returning a message of type #UBXCFG_RATE
  3559. * \note No payload
  3560. * \brief Poll Navigation/Measurement Rate Settings
  3561. */
  3562. /*!
  3563. * \struct UBXCFG_RATE
  3564. * The u-blox© positioning technology supports navigation update rates higher or lower than 1
  3565. * update per second. The calculation of the navigation solution will always be aligned to the
  3566. * top of a second.
  3567. * - The update rate has a direct influence on the power consumption. The more fixes that
  3568. * are required, the more CPU power and communication resources are required.
  3569. * - For most applications a 1 Hz update rate would be sufficient.
  3570. * - When using Power Save Mode, measurement and navigation rate can differ from the
  3571. * values configured here. See "Measurement and navigation rate with Power Save Mode" (u-blox© official documentation)
  3572. * for details.
  3573. * \brief Navigation/Measurement Rate Settings
  3574. *
  3575. * \var UBXCFG_RATE::measRate
  3576. * Measurement Rate, GPS measurements are
  3577. * taken every measRate milliseconds
  3578. * \var UBXCFG_RATE::navRate
  3579. * Navigation Rate, in number of measurement
  3580. * cycles.
  3581. * \note This parameter cannot be changed, and
  3582. * must be set to 1.
  3583. * \var UBXCFG_RATE::timeRef
  3584. * Alignment to reference time.
  3585. * \note
  3586. * - 0 - UTC time
  3587. * - 1 - GPS time
  3588. */
  3589. /*!
  3590. * \struct UBXCFG_RINV_POLL
  3591. * \note No payload
  3592. * \brief Poll contents of Remote Inventory
  3593. */
  3594. /*!
  3595. * \struct UBXCFG_RINV
  3596. * \note This message has variable payload
  3597. * If size of variable payload is greater than 30, the excess bytes are discarded. In future firmware versions, this limit
  3598. * may change.
  3599. * \brief Contents of Remote Inventory
  3600. * \var UBXCFG_RINV::flags
  3601. * Flags
  3602. * \see #UBXRINVFlags to fill this field
  3603. */
  3604. /*!
  3605. * \struct UBXCFG_RST
  3606. * \brief Reset Receiver / Clear Backup Data Structures
  3607. *
  3608. * \var UBXCFG_RST::navBBRMask
  3609. * BBR Sections to clear.
  3610. * \see #UBXBBRSpecialSets for special sets
  3611. * \see #UBXBBRMask to fill this field manually
  3612. * \var UBXCFG_RST::resetMode
  3613. * Reset Type
  3614. * \see #UBXResetMode to fill this field
  3615. * \var UBXCFG_RST::reserved1
  3616. * Reserved
  3617. */
  3618. /*!
  3619. * \struct UBXCFG_RXM_POLL
  3620. * \note No payload
  3621. * \brief Poll RXM configuration
  3622. */
  3623. /*!
  3624. * \struct UBXCFG_RXM
  3625. * For a detailed description see section "Power Management"(u-blox© official documentation)
  3626. * \note Power Save Mode cannot be selected when the receiver is configured to process
  3627. * GLONASS signals using #UBXCFG_GNSS.
  3628. * \brief RXM configuration
  3629. *
  3630. * \var UBXCFG_RXM::reserved1
  3631. * Reserved
  3632. * \note Shall be set to 8
  3633. * \var UBXCFG_RXM::lpMode
  3634. * Low power mode
  3635. * \see #UBXRXMLowPowerModes to fill this field
  3636. */
  3637. /*!
  3638. * \struct UBXCFG_SBAS_POLL
  3639. * \note No payload
  3640. * \brief Poll contents of SBAS Configuration
  3641. *
  3642. */
  3643. /*!
  3644. * \struct UBXCFG_SBAS
  3645. * This message configures the SBAS receiver subsystem (i.e. WAAS, EGNOS, MSAS)
  3646. * \see "SBAS Configuration Settings Description" (u-blox© official documentation)
  3647. * for a detailed description of how these settings affect receiver operation.
  3648. * \brief SBAS Configuration
  3649. *
  3650. * \var UBXCFG_SBAS::mode
  3651. * SBAS Mode
  3652. * \see #UBXSBASModes to fill this field
  3653. * \var UBXCFG_SBAS::usage
  3654. * SBAS Usage
  3655. * \see #UBXSBASUsage to fill this field
  3656. * \var UBXCFG_SBAS::maxSBAS
  3657. * Maximum Number of SBAS prioritized tracking
  3658. * channels to use
  3659. * \note valid range: 0 - 3
  3660. * \deprecated obsolete and superseeded by #UBXCFG_GNSS in protocol
  3661. * versions 14.00+.
  3662. * \var UBXCFG_SBAS::scanmode2
  3663. * Continuation of scanmode bitmask below
  3664. * \see #UBXSBASScanModes2 to fill this field
  3665. * \var UBXCFG_SBAS::scanmode1
  3666. * Which SBAS PRN numbers to search for (Bitmask)
  3667. * If all Bits are set to zero, auto-scan (i.e. all valid
  3668. * PRNs) are searched.
  3669. * Every bit corresponds to a PRN number
  3670. * \see #UBXSBASScanModes1 to fill this field
  3671. */
  3672. /*!
  3673. * \struct UBXCFG_TP5_POLL
  3674. * Sending this message to the receiver results in the receiver returning a
  3675. * message of type #UBXCFG_TP5 with a payload for timepulse 0.
  3676. * \note No payload
  3677. * \brief Poll Time Pulse Parameters
  3678. */
  3679. /*!
  3680. * \struct UBXCFG_TP5_POLL_OPT
  3681. * Sending this message to the receiver results in the receiver returning a message of type
  3682. * #UBXCFG_TP5 with a payload for the specified time pulse.
  3683. * \brief Poll Time Pulse Parameters
  3684. * \var UBXCFG_TP5_POLL_OPT::tpIdx
  3685. * Time pulse selection
  3686. * \see #UBXCFGTimepulses to fill this field
  3687. */
  3688. /*!
  3689. * \struct UBXCFG_TP5
  3690. * This message is used to get/set time pulse parameters. For more information see section
  3691. * "Time pulse" (u-blox© official documentation).
  3692. * \brief The UBXCFG_TP5 structure is
  3693. *
  3694. * \var UBXCFG_TP5::tpIdx
  3695. * Time pulse selection
  3696. * \see #UBXCFGTimepulses to fill this field
  3697. * \var UBXCFG_TP5::reserved0
  3698. * Reserved
  3699. * \var UBXCFG_TP5::reserved1
  3700. * Reserved
  3701. * \var UBXCFG_TP5::antCableDelay
  3702. * Antenna cable delay
  3703. * \var UBXCFG_TP5::rfGroupDelay
  3704. * RF group delay
  3705. * \var UBXCFG_TP5::freqPeriod
  3706. * Frequency or period time
  3707. * \note Depending on setting of bit 'isFreq'
  3708. * \var UBXCFG_TP5::freqPeriodLock
  3709. * Frequency or period time when locked to GPS
  3710. * time
  3711. * \note Only used if 'lockedOtherSet' is set
  3712. * \var UBXCFG_TP5::pulseLenRatio
  3713. * Pulse length or duty cycle
  3714. * \note Depending on 'isLength'
  3715. * \var UBXCFG_TP5::pulseLenRatioLock
  3716. * Pulse length or duty cycle when locked to GPS
  3717. * time
  3718. * \note only used if 'lockedOtherSet' is set
  3719. * \var UBXCFG_TP5::userConfigDelay
  3720. * User configurable time pulse delay
  3721. * \var UBXCFG_TP5::flags
  3722. * Configuration flags
  3723. * \see #UBXCFGTimepulseFlags to fill this field
  3724. */
  3725. /*!
  3726. * \struct UBXCFG_USB_POLL
  3727. * \note No payload
  3728. * \brief Poll a USB configuration
  3729. */
  3730. /*!
  3731. * \struct UBXCFG_USB
  3732. * \brief USB Configuration
  3733. *
  3734. * \var UBXCFG_USB::vendorId
  3735. * Vendor ID. This field shall only be set to
  3736. * registered Vendor IDs.
  3737. * \note Changing this field
  3738. * requires special Host drivers.
  3739. * \var UBXCFG_USB::productId
  3740. * Product ID.
  3741. * \note Changing this field requires special
  3742. * Host drivers.
  3743. * \var UBXCFG_USB::reserved1
  3744. * Reserved
  3745. * \note Set to 0
  3746. * \var UBXCFG_USB::reserved2
  3747. * Reserved
  3748. * \note Set to 1
  3749. * \var UBXCFG_USB::powerConsumption
  3750. * Power consumed by the device
  3751. * \var UBXCFG_USB::flags
  3752. * Various configuration flags
  3753. * \see #UBXUSBFlags to fill this field
  3754. * \var UBXCFG_USB::vendorString[32]
  3755. * String containing the vendor name. 32 ASCII bytes
  3756. * including 0-termination.
  3757. * \var UBXCFG_USB::productString[32]
  3758. * String containing the product name. 32 ASCI bytes
  3759. * including 0-termination.
  3760. * \var UBXCFG_USB::serialNumber[32]
  3761. * String containing the serial number. 32 ASCII
  3762. * bytes including 0-termination.
  3763. * \note Changing the String fields requires special Host
  3764. * drivers.
  3765. */
  3766. /*!
  3767. * \struct UBXINF_DEBUG
  3768. * This message has a variable length payload, representing an ASCII string.
  3769. * \note This message has a variable length payload
  3770. * \brief ASCII String output, indicating debug output
  3771. */
  3772. /*!
  3773. * \struct UBXINF_ERROR
  3774. * This message has a variable length payload, representing an ASCII string.
  3775. * \note This message has a variable length payload
  3776. * \brief ASCII String output, indicating an error
  3777. */
  3778. /*!
  3779. * \struct UBXINF_NOTICE
  3780. * This message has a variable length payload, representing an ASCII string.
  3781. * \note This message has a variable length payload
  3782. * \brief ASCII String output, with informational contents
  3783. */
  3784. /*!
  3785. * \struct UBXINF_TEST
  3786. * This message has a variable length payload, representing an ASCII string.
  3787. * \note This message has a variable length payload
  3788. * \brief ASCII String output, indicating test output
  3789. */
  3790. /*!
  3791. * \struct UBXINF_WARNING
  3792. * This message has a variable length payload, representing an ASCII string.
  3793. * \note This message has a variable length payload
  3794. * \brief ASCII String output, indicating a warning
  3795. */
  3796. /*!
  3797. * \struct UBXLOG_CREATE
  3798. * This message is used to create an initial logging file and activate the logging subsystem.
  3799. * #UBXACK_ACK or #UBXACK_NACK are returned to indicate success or failure.
  3800. * This message does not handle activation of recording or filtering of log entries
  3801. * \see #UBXCFG_LOGFILTER
  3802. * \brief Create Log File
  3803. * \var UBXLOG_CREATE::version
  3804. * The version of this message.
  3805. * \note Set to 0
  3806. * \var UBXLOG_CREATE::logCfg
  3807. * Config flags
  3808. * \see #UBXLOGCfg to fill this field
  3809. * \var UBXLOG_CREATE::reserved
  3810. * Reserved
  3811. * \note Set to 0
  3812. * \var UBXLOG_CREATE::logSize
  3813. * Indicates the size of the log
  3814. * \see #UBXLOGSize to fill this field
  3815. * \var UBXLOG_CREATE::userDefinedSize
  3816. * Sets the maximum amount of space in the
  3817. * filestore that can be used by the logging task
  3818. * \note This field is only applicable if logSize is set to user defined.
  3819. */
  3820. /*!
  3821. * \struct UBXLOG_ERASE
  3822. * This message deactivates the logging system and erases all logged data.
  3823. * #UBXACK_ACK or #UBXACK_NACK are returned to indicate success or failure.
  3824. * \note No payload
  3825. * \brief Erase Logged Data
  3826. */
  3827. /*!
  3828. * \struct UBXLOG_FINDTIME_IN
  3829. * This message can be used to search a log for the index of the first entry less than or equal
  3830. * to the given time. This index can then be used with the #UBXLOG_RETRIEVE message to
  3831. * provide time-based retrieval of log entries.
  3832. * \brief Finds the index of the first log entry <= given time
  3833. *
  3834. * \var UBXLOG_FINDTIME_IN::version
  3835. * Message version
  3836. * \note Set to 0
  3837. * \var UBXLOG_FINDTIME_IN::type
  3838. * Message type
  3839. * \note 0 for request
  3840. * \var UBXLOG_FINDTIME_IN::reserved1
  3841. * Reserved
  3842. * \var UBXLOG_FINDTIME_IN::year
  3843. * Year of UTC time
  3844. * \note Range 1-65635
  3845. * \var UBXLOG_FINDTIME_IN::month
  3846. * Month of UTC time
  3847. * \note Range 1-12
  3848. * \var UBXLOG_FINDTIME_IN::day
  3849. * Day of UTC time
  3850. * \note Range 1-31
  3851. * \var UBXLOG_FINDTIME_IN::hour
  3852. * Hour of UTC time
  3853. * \note Range 0-23
  3854. * \var UBXLOG_FINDTIME_IN::minute
  3855. * Minute of UTC time
  3856. * \note Range 0-59
  3857. * \var UBXLOG_FINDTIME_IN::second
  3858. * Second of UTC time
  3859. * \note Range 0-60 - looks like mistake in official documentation
  3860. * \var UBXLOG_FINDTIME_IN::reserved2
  3861. * Reserved
  3862. */
  3863. /*!
  3864. * \struct UBXLOG_FINDTIME_OUT
  3865. * \brief This message is the response to FINDTIME request.
  3866. *
  3867. * \var UBXLOG_FINDTIME_OUT::version
  3868. * Message version
  3869. * \note Set to 1
  3870. * \var UBXLOG_FINDTIME_OUT::type
  3871. * \note Is set to 1 for response
  3872. * \var UBXLOG_FINDTIME_OUT::reserved1
  3873. * Reserved
  3874. * \var UBXLOG_FINDTIME_OUT::entryNumber
  3875. * Index of the most recent entry with time <= specified
  3876. */
  3877. /*!
  3878. * \struct UBXLOG_INFO_POLL
  3879. * \note No payload
  3880. * \brief Poll for log information
  3881. */
  3882. /*!
  3883. * \struct UBXLOG_INFO
  3884. * This message is used to report information about the logging subsystem.
  3885. * \note
  3886. * - The reported maximum log size will be smaller than that originally specified in
  3887. * LOG-CREATE due to logging and filestore implementation overheads.
  3888. * - Log entries are compressed in a variable length fashion, so it may be difficult to predict
  3889. * log space usage with any precision.
  3890. * - There may be times when the receiver does not have an accurate time (e.g. if the week
  3891. * number is not yet known), in which case some entries will not have a timestamp - this
  3892. * may result in the oldest/newest entry time values not taking account of these entries.
  3893. * \brief Log information
  3894. * \var UBXLOG_INFO::version
  3895. * The version of this message
  3896. * \note Set to 1
  3897. * \var UBXLOG_INFO::reserved1[3]
  3898. * Reserved
  3899. * \var UBXLOG_INFO::filestoreCapacity
  3900. * The capacity of the filestore
  3901. * \var UBXLOG_INFO::reserved2
  3902. * Reserved
  3903. * \var UBXLOG_INFO::reserved3
  3904. * Reserved
  3905. * \var UBXLOG_INFO::currentMaxLogSize
  3906. * The maximum size the current log is allowed to grow to
  3907. * \var UBXLOG_INFO::currentLogSize
  3908. * Approximate amount of space in log currently occupied
  3909. * \var UBXLOG_INFO::entryCount
  3910. * Number of entries in the log.
  3911. * \note For circular logs this value will decrease
  3912. * when a group of entries is deleted to make
  3913. * space for new ones.
  3914. * \var UBXLOG_INFO::oldestYear
  3915. * Oldest entry UTC year.
  3916. * \note Range 1-65635 or zero if
  3917. * there are no entries with known time
  3918. * \var UBXLOG_INFO::oldestMonth
  3919. * Oldest month
  3920. * \note Range 1-12
  3921. * \var UBXLOG_INFO::oldestDay
  3922. * Oldest day
  3923. * \note Range 1-31
  3924. * \var UBXLOG_INFO::oldestHour
  3925. * Oldest hour
  3926. * \note Range 0-23
  3927. * \var UBXLOG_INFO::oldestMinute
  3928. * Oldest minute
  3929. * \note Range 0-59
  3930. * \var UBXLOG_INFO::oldestSecond
  3931. * Oldest second
  3932. * \note Range 0-60
  3933. * \var UBXLOG_INFO::reserved4
  3934. * Reserved
  3935. * \var UBXLOG_INFO::newestYear
  3936. * Newest entry UTC year year.
  3937. * \note Range 1-65635 or zero if
  3938. * there are no entries with known time
  3939. * \var UBXLOG_INFO::newestMonth
  3940. * Newest month
  3941. * \note Range 1-12
  3942. * \var UBXLOG_INFO::newestDay
  3943. * Newest day
  3944. * \note Range 1-31
  3945. * \var UBXLOG_INFO::newestHour
  3946. * Newest hour
  3947. * \note Range 0-23
  3948. * \var UBXLOG_INFO::newestMinute
  3949. * Newest minute
  3950. * \note Range 0-59
  3951. * \var UBXLOG_INFO::newestSecond
  3952. * Newest second
  3953. * \note Range 0-60
  3954. * \var UBXLOG_INFO::reserved5
  3955. * Reserved
  3956. * \var UBXLOG_INFO::status
  3957. * Log status flags
  3958. * \see #UBXLOGStatus to fill this field
  3959. * \var UBXLOG_INFO::reserved6[3]
  3960. * Reserved
  3961. */
  3962. /*!
  3963. * \struct UBXLOG_RETRIEVEPOS
  3964. * This message is used to report a position fix log entry
  3965. * \brief Position fix log entry
  3966. * \var UBXLOG_RETRIEVEPOS::entryIndex
  3967. * The index of this log entry
  3968. * \var UBXLOG_RETRIEVEPOS::lon
  3969. * Longitude
  3970. * \var UBXLOG_RETRIEVEPOS::lat
  3971. * Latitude
  3972. * \var UBXLOG_RETRIEVEPOS::hMSL
  3973. * Height above mean sea level
  3974. * \var UBXLOG_RETRIEVEPOS::hAcc
  3975. * Horizontal accuracy estimate
  3976. * \var UBXLOG_RETRIEVEPOS::gSpeed
  3977. * Ground speed (2-D)
  3978. * \var UBXLOG_RETRIEVEPOS::heading
  3979. * Heading
  3980. * \var UBXLOG_RETRIEVEPOS::version
  3981. * The version of this message.
  3982. * \note Set to 0
  3983. * \var UBXLOG_RETRIEVEPOS::fixType
  3984. * Fix type
  3985. * \see #UBXRETRIEVEPOSFixType to fill this field
  3986. * \var UBXLOG_RETRIEVEPOS::year
  3987. * Year
  3988. * \note Range 1-65635
  3989. * \var UBXLOG_RETRIEVEPOS::month
  3990. * Month
  3991. * \note Range 1-12
  3992. * \var UBXLOG_RETRIEVEPOS::day
  3993. * Day
  3994. * \note Range 1-31
  3995. * \var UBXLOG_RETRIEVEPOS::hour
  3996. * Hour
  3997. * \note Range 0-23
  3998. * \var UBXLOG_RETRIEVEPOS::minute
  3999. * Minute
  4000. * \note Range 0-59
  4001. * \var UBXLOG_RETRIEVEPOS::second
  4002. * Second
  4003. * \note Range 0-60
  4004. * \var UBXLOG_RETRIEVEPOS::reserved1
  4005. * Reserved
  4006. * \var UBXLOG_RETRIEVEPOS::numSV
  4007. * Number of satellites used in the position fix
  4008. * \var UBXLOG_RETRIEVEPOS::reserved2
  4009. * Reserved
  4010. */
  4011. /*!
  4012. * \struct UBXLOG_RETRIEVESTRING
  4013. * This message is used to report a byte string log entry
  4014. * \note this message contains variable payload of UBXLOG_RETRIEVESTRING::byteCount size
  4015. * \brief Byte string log entry
  4016. * \var UBXLOG_RETRIEVESTRING::entryIndex
  4017. * The index of this log entry
  4018. * \var UBXLOG_RETRIEVESTRING::version
  4019. * \note Set to 0
  4020. * \var UBXLOG_RETRIEVESTRING::reserved1
  4021. * Reserved
  4022. * \var UBXLOG_RETRIEVESTRING::year
  4023. * Year
  4024. * \note Range 1-65635
  4025. * \var UBXLOG_RETRIEVESTRING::month
  4026. * Month
  4027. * \note Range 1-12
  4028. * \var UBXLOG_RETRIEVESTRING::day
  4029. * Day
  4030. * \note Range 1-31
  4031. * \var UBXLOG_RETRIEVESTRING::hour
  4032. * Hour
  4033. * \note Range 0-23
  4034. * \var UBXLOG_RETRIEVESTRING::minute
  4035. * Minute
  4036. * \note Range 0-59
  4037. * \var UBXLOG_RETRIEVESTRING::second
  4038. * Second
  4039. * \note Range 0-60
  4040. * \var UBXLOG_RETRIEVESTRING::reserved2
  4041. * Reserved
  4042. * \var UBXLOG_RETRIEVESTRING::byteCount
  4043. * Size of string in bytes
  4044. */
  4045. /*!
  4046. * \struct UBXLOG_RETRIEVE
  4047. * This message is used to request logged data.
  4048. * Log entries are returned in chronological order, using the messages
  4049. * #UBXLOG_RETRIEVEPOS and #UBXLOG_RETRIEVESTRING. The maximum number of
  4050. * entries that can be returned in response to a single UBX-LOG-RETRIEVE message is 256. If
  4051. * more entries than this are required the mesage will need to be sent multiple times with
  4052. * different startNumbers. The retrieve will be stopped if any UBX-LOG message is received.
  4053. * \note The speed of transfer can be maximised by using a high data rate and temporarily stopping
  4054. * the GPS processing see #UBXCFG_RST
  4055. * \note log recording must first be disabled see #UBXCFG_LOGFILTER
  4056. * \brief Request log data
  4057. * \var UBXLOG_RETRIEVE::startNumber
  4058. * Index of first entry to be transferred
  4059. * \var UBXLOG_RETRIEVE::entryCount
  4060. * Number of log entries to transfer. The maximum
  4061. * is 256
  4062. * \var UBXLOG_RETRIEVE::version
  4063. * The version of this message
  4064. * \note Set to 0
  4065. * \var UBXLOG_RETRIEVE::reserved[3]
  4066. * Reserved
  4067. */
  4068. /*!
  4069. * \struct UBXLOG_STRING
  4070. * This message can be used to store an arbitrary byte string in the on-board flash memory.
  4071. * The maximum length that can be stored is 256 bytes.
  4072. * \note this message has variable payload
  4073. * \brief Store arbitrary string in on-board Flash memory
  4074. */
  4075. /*!
  4076. * \struct UBXMON_HW2
  4077. * Status of different aspects of the hardware such as Imbalance, Low-Level Configuration
  4078. * and POST Results.
  4079. * The first four parameters of this message represent the complex signal from the RF front
  4080. * end. The following rules of thumb apply:
  4081. * - The smaller the absolute value of the variable ofsI and ofsQ respectively, the better.
  4082. * - Ideally, the magnitude of the I-part (UBXMON_HW2::magI) and the Q-part (UBXMON_HW2::magQ) of the complex signal
  4083. * should be the same.
  4084. * \brief Extended Hardware Status
  4085. *
  4086. * \var UBXMON_HW2::ofsI
  4087. * Imbalance of I-part of complex signal, scaled.
  4088. * \note
  4089. * - -128 - max. negative imbalance
  4090. * - 127 - max. positive imbalance
  4091. * \var UBXMON_HW2::magI
  4092. * Magnitude of I-part of complex signal, scaled
  4093. * \note
  4094. * - 0 - no signal
  4095. * - 255 = max. magnitude
  4096. * \var UBXMON_HW2::ofsQ
  4097. * Imbalance of Q-part of complex signal, scaled.
  4098. * \note
  4099. * - -128 = max. negative imbalance
  4100. * - 127 = max. positive imbalance
  4101. * \var UBXMON_HW2::magQ
  4102. * Magnitude of Q-part of complex signal, scaled
  4103. * \note
  4104. * - 0 - no signal
  4105. * - 255 = max. magnitude
  4106. * \var UBXMON_HW2::cfgSource
  4107. * Source of low-level configuration
  4108. * \todo Following values will be covered with enum in future
  4109. * - 114 - ROM
  4110. * - 111 - OTP
  4111. * - 112 - config pins
  4112. * - 102 - flash image)
  4113. * \var UBXMON_HW2::reserved0[3]
  4114. * Reserved
  4115. * \var UBXMON_HW2::lowLevCfg
  4116. * Low-level configuration
  4117. * \var UBXMON_HW2::reserved1[2]
  4118. * Reserved
  4119. * \var UBXMON_HW2::postStatus
  4120. * POST status word
  4121. * \var UBXMON_HW2::reserved2
  4122. * Reserved
  4123. */
  4124. /*!
  4125. * \struct UBXHWFlags
  4126. * \brief This structure describes UBXMON_HW::flags value
  4127. * \var UBXHWFlags::UBXHWFlagsRTCCalib
  4128. * RTC is calibrated
  4129. * \var UBXHWFlags::UBXHWFlagsSafeBoot
  4130. * SafeBoot mode
  4131. * - 0 - inactive
  4132. * - 1 - active
  4133. * \var UBXHWFlags::UBXHWFlagsJammingState
  4134. * Output from Jamming/Interference Monitor
  4135. * \todo Following values will be covered with enum in future
  4136. * - 0 - unknown or feature disabled
  4137. * - 1 - ok - no significant jamming
  4138. * - 2 - warning - interference visible but fix OK
  4139. * - 3 - critical - interference visible and no fix
  4140. */
  4141. /*!
  4142. * \struct UBXMON_HW
  4143. * Status of different aspect of the hardware, such as Antenna, PIO/Peripheral Pins, Noise
  4144. * Level, Automatic Gain Control (AGC)
  4145. * \brief Hardware Status
  4146. *
  4147. * \var UBXMON_HW::pinSel
  4148. * Mask of Pins Set as Peripheral/PIO
  4149. * \var UBXMON_HW::pinBank
  4150. * Mask of Pins Set as Bank A/B
  4151. * \var UBXMON_HW::pinDir
  4152. * Mask of Pins Set as Input/Output
  4153. * \var UBXMON_HW::pinVal
  4154. * Mask of Pins Value Low/High
  4155. * \var UBXMON_HW::noisePerMS
  4156. * Noise Level as measured by the GPS Core
  4157. * \var UBXMON_HW::agcCnt
  4158. * AGC Monitor
  4159. * \note counts SIGHI xor SIGLO
  4160. * \note Range 0 to 8191
  4161. * \var UBXMON_HW::aStatus
  4162. * Status of the Antenna Supervisor State Machine
  4163. * \todo Following values will be covered with enum in future
  4164. * - 0 - INIT
  4165. * - 1 - DONTKNOW
  4166. * - 2 - OK
  4167. * - 3 - SHORT
  4168. * - 4 - OPEN
  4169. * \var UBXMON_HW::aPower
  4170. * Current PowerStatus of Antenna
  4171. * \todo Following values will be covered with enum in future
  4172. * - 0 - OFF
  4173. * - 1 - ON
  4174. * - 2 - DONTKNOW
  4175. * \var UBXMON_HW::flags
  4176. * Flags
  4177. * \see #UBXHWFlags to fill this field
  4178. * \var UBXMON_HW::reserved1
  4179. * Reserved
  4180. * \var UBXMON_HW::usedMask
  4181. * Mask of Pins that are used by the Virtual Pin
  4182. * Manager
  4183. * \var UBXMON_HW::VP[17]
  4184. * Array of Pin Mappings for each of the 17
  4185. * Physical Pins
  4186. * \var UBXMON_HW::jamInd
  4187. * CW Jamming indicator, scaled
  4188. * \todo Following values will be covered with enum in future
  4189. * - 0 - no CW jamming
  4190. * - 255 - strong CW jamming)
  4191. * \var UBXMON_HW::reserved3
  4192. * Reserved
  4193. * \var UBXMON_HW::pinIrq
  4194. * Mask of Pins Value using the PIO Irq
  4195. * \var UBXMON_HW::pullH
  4196. * Mask of Pins Value using the PIO Pull High Resistor
  4197. * \var UBXMON_HW::pullL
  4198. * Mask of Pins Value using the PIO Pull Low Resistor
  4199. */
  4200. /*!
  4201. * \struct UBXMON_IO_PART
  4202. * This message is part of #UBXMON_IO
  4203. * \brief I/O port status
  4204. * \var UBXMON_IO_PART::rxBytes
  4205. * Number of bytes ever received
  4206. * \var UBXMON_IO_PART::txBytes
  4207. * Number of bytes ever sent
  4208. * \var UBXMON_IO_PART::parityErrs
  4209. * Number of 100ms timeslots with parity errors
  4210. * \var UBXMON_IO_PART::framingErrs
  4211. * Number of 100ms timeslots with framing errors
  4212. * \var UBXMON_IO_PART::overrunErrs
  4213. * Number of 100ms timeslots with overrun errors
  4214. * \var UBXMON_IO_PART::breakCond
  4215. * Number of 100ms timeslots with break conditions
  4216. * \var UBXMON_IO_PART::rxBusy
  4217. * Flag is receiver is busy
  4218. * \var UBXMON_IO_PART::txBusy
  4219. * Flag is transmitter is busy
  4220. * \var UBXMON_IO_PART::reserved1
  4221. * Reserved
  4222. */
  4223. /*!
  4224. * \struct UBXMON_IO
  4225. * \note The size of the message is determined by the number of ports 'N' the receiver supports, i.e.
  4226. * on u-blox 5 the number of ports is 6.
  4227. * \note this message has variable payload of #UBXMON_IO_PART type.
  4228. * It depends of UBX_IO_PORTS_NUM macro that is 6 by default.
  4229. * Redefine this macro otherwise.
  4230. * \brief I/O Subsystem Status
  4231. * \var UBXMON_IO::ioPortInfo
  4232. * I/O ports information scope
  4233. * \see #UBXMON_IO_PART to fill this filed
  4234. */
  4235. /*!
  4236. * \struct UBXMON_MSGPP
  4237. * \brief Message Parse and Process Status
  4238. *
  4239. * \var UBXMON_MSGPP::msg1[8]
  4240. * Number of successfully parsed messages for
  4241. * each protocol on port 0
  4242. * \var UBXMON_MSGPP::msg2[8]
  4243. * Number of successfully parsed messages for
  4244. * each protocol on port 1
  4245. * \var UBXMON_MSGPP::msg3[8]
  4246. * Number of successfully parsed messages for
  4247. * each protocol on port 2
  4248. * \var UBXMON_MSGPP::msg4[8]
  4249. * Number of successfully parsed messages for
  4250. * each protocol on port 3
  4251. * \var UBXMON_MSGPP::msg5[8]
  4252. * Number of successfully parsed messages for
  4253. * each protocol on port 4
  4254. * \var UBXMON_MSGPP::msg6[8]
  4255. * Number of successfully parsed messages for
  4256. * each protocol on port 5
  4257. * \var UBXMON_MSGPP::skipped[6]
  4258. * Number skipped bytes for each port
  4259. */
  4260. /*!
  4261. * \struct UBXMON_RXBUF
  4262. * \brief Receiver Buffer Status
  4263. *
  4264. * \var UBXMON_RXBUF::pending[6]
  4265. * Number of bytes pending in receiver buffer for each target
  4266. * \var UBXMON_RXBUF::usage[6]
  4267. * Maximum usage receiver buffer during the last sysmon period for each target
  4268. * \note Units %
  4269. * \var UBXMON_RXBUF::peakUsage[6]
  4270. * Maximum usage receiver buffer for each target
  4271. * \note Units %
  4272. */
  4273. /*!
  4274. * \struct UBXMON_RXR
  4275. * The receiver ready message is sent when the receiver changes from or to backup mode.
  4276. * \brief Receiver Status Information
  4277. *
  4278. * \var UBXMON_RXR::flags
  4279. * Receiver status flags
  4280. * \see #UBXRXRFlags to fill this field
  4281. */
  4282. /*!
  4283. * \struct UBXMON_TXBUF
  4284. * \brief Transmitter Buffer Status
  4285. *
  4286. * \var UBXMON_TXBUF::pending[6]
  4287. * Number of bytes pending in transmitter buffefor each target
  4288. * \var UBXMON_TXBUF::usage[6]
  4289. * Maximum usage transmitter buffer during the
  4290. * last sysmon period for each target
  4291. * \note Units %
  4292. * \var UBXMON_TXBUF::peakUsage[6]
  4293. * Maximum usage transmitter buffer for each
  4294. * target
  4295. * \note Units %
  4296. * \var UBXMON_TXBUF::tUsage
  4297. * Maximum usage of transmitter buffer during
  4298. * the last sysmon period for all targets
  4299. * \note Units %
  4300. * \var UBXMON_TXBUF::tPeakusage
  4301. * Maximum usage of transmitter buffer for all
  4302. * targets
  4303. * \var UBXMON_TXBUF::errors
  4304. * Error bitmask
  4305. * \todo Bitmask will be implemented in future
  4306. * \var UBXMON_TXBUF::reserved1
  4307. * Reserved
  4308. */
  4309. /*!
  4310. * \struct UBXMON_VER_POLL
  4311. * \note No payload
  4312. * \brief Poll Receiver/Software Version
  4313. */
  4314. /*!
  4315. * \struct UBXMON_VER
  4316. * \brief Receiver Software Version
  4317. * \note Variable payload of #UBXMON_VER_PART type
  4318. * \var UBXMON_VER::swVersion[30]
  4319. * Zero-terminated Software Version String
  4320. * \var UBXMON_VER::hwVersion[10]
  4321. * Zero-terminated Hardware Version String
  4322. */
  4323. /*!
  4324. * \struct UBXMON_VER_PART
  4325. * Extended receiver/software information.
  4326. * If the receiver's firmware is running from flash,
  4327. * the first extension field will contain the Software
  4328. * Version String of the underlying ROM.
  4329. * Additional fields may also indicate the
  4330. * supported protocol version and any product
  4331. * variants, capabilities or extensions.
  4332. * \brief This structure is variable payload for #UBXMON_VER
  4333. * \var UBXMON_VER_PART::extension[30]
  4334. * See structure descruption
  4335. */
  4336. /*!
  4337. * \struct UBXNAV_AOPSTATUS
  4338. * This message provides information on the current availability of AssistNow Autonomous
  4339. * data and the current state of the subsystem on the receiver. For example, a host application
  4340. * can determine the optimal time to shut down the receiver by monitoring the status field
  4341. * for a steady 0. See the chapter "AssistNow Autonomous"(u-blox© official documentation) in the receiver description for
  4342. * details on this feature.
  4343. * \brief AssistNow Autonomous Status
  4344. * \var UBXNAV_AOPSTATUS::iTOW
  4345. * GPS time of week of the navigation epoch.
  4346. * See the description of iTOW (u-blox© official documentation) for details.
  4347. * \var UBXNAV_AOPSTATUS::aopCfg
  4348. * AssistNow Autonomous configuration
  4349. * \see #UBXAOPCfg to fill this field
  4350. * \var UBXNAV_AOPSTATUS::status
  4351. * AssistNow Autonomous subsystem is idle or running
  4352. * \see #UBXAOPStatus to fill this field
  4353. * \var UBXNAV_AOPSTATUS::reserved0
  4354. * Reserved
  4355. * \note Set to 0
  4356. * \var UBXNAV_AOPSTATUS::reserved1
  4357. * Reserved
  4358. * \note Set to 0
  4359. * \var UBXNAV_AOPSTATUS::availGPS
  4360. * data availability mask for GPS SVs
  4361. * \note bits 0-31 correspond to GPS PRN 1-32
  4362. * \var UBXNAV_AOPSTATUS::reserved2
  4363. * Reserved
  4364. * \note Set to 0
  4365. * \var UBXNAV_AOPSTATUS::reserved3
  4366. * Reserved
  4367. * \note Set to 0
  4368. */
  4369. /*!
  4370. * \struct UBXNAV_CLOCK
  4371. * \brief Clock Solution
  4372. *
  4373. * \var UBXNAV_CLOCK::iTOW
  4374. * GPS time of week of the navigation epoch.
  4375. * See the description of iTOW (u-blox© official documentation) for details.
  4376. * \var UBXNAV_CLOCK::clkB
  4377. * Clock bias
  4378. * \var UBXNAV_CLOCK::clkD
  4379. * Clock drift
  4380. * \var UBXNAV_CLOCK::tAcc
  4381. * Time accuracy estimate
  4382. * \var UBXNAV_CLOCK::fAcc
  4383. * Frequency accuracy estimate
  4384. */
  4385. /*!
  4386. * \struct UBXNAV_DGPS
  4387. * This message outputs the DGPS correction data that has been applied to the current NAV
  4388. * Solution. See also the notes on the "RTCM protocol"(u-blox© official documentation).
  4389. * \note This message has variable payload of #UBXNAV_DGPS_PART type
  4390. * \brief DGPS Data Used for NAV
  4391. *
  4392. * \var UBXNAV_DGPS::iTOW
  4393. * GPS time of week of the navigation epoch.
  4394. * See the description of iTOW (u-blox© official documentation) for details.
  4395. * \var UBXNAV_DGPS::age
  4396. * Age of newest correction data
  4397. * \var UBXNAV_DGPS::baseId
  4398. * DGPS basestation identifier
  4399. * \var UBXNAV_DGPS::baseHealth
  4400. * DGPS basestation health status
  4401. * \var UBXNAV_DGPS::numCh
  4402. * Number of channels for which correction data is following
  4403. * \var UBXNAV_DGPS::status
  4404. * DGPS correction type status
  4405. * \todo Following values will be covered with enum in future
  4406. * - 0x00 - none
  4407. * - 0x01 - PR+PRR correction
  4408. * \var UBXNAV_DGPS::reserved1
  4409. * Reserved
  4410. */
  4411. /*!
  4412. * \struct UBXDGPSFlags
  4413. * This structure implemets UBXNAV_DGPS_PART::flags
  4414. * \brief #UBXNAV_DGPS_PART flags
  4415. * \var UBXDGPSFlags::channel
  4416. * GPS channel number this SV is on
  4417. * \var UBXDGPSFlags::dgpsUsed
  4418. * DGPS used for this SV
  4419. */
  4420. /*!
  4421. * \struct UBXNAV_DGPS_PART
  4422. * \brief This sturcture implements variable payload for #UBXNAV_DGPS
  4423. *
  4424. * \var UBXNAV_DGPS_PART::svid
  4425. * Satellite ID
  4426. * \var UBXNAV_DGPS_PART::flags
  4427. * Channel number and usage
  4428. * \var UBXNAV_DGPS_PART::ageC
  4429. * Age of latest correction data
  4430. * \var UBXNAV_DGPS_PART::prc
  4431. * Pseudorange correction
  4432. * \var UBXNAV_DGPS_PART::prrc
  4433. * Pseudorange rate correction
  4434. */
  4435. /*!
  4436. * \struct UBXNAV_DOP
  4437. * - DOP values are dimensionless.
  4438. * - All DOP values are scaled by a factor of 100. If the unit transmits a value of e.g. 156, the
  4439. * DOP value is 1.56.
  4440. * \brief Dilution of precision
  4441. *
  4442. * \var UBXNAV_DOP::iTOW
  4443. * GPS time of week of the navigation epoch.
  4444. * See the description of iTOW (u-blox© official documentation) for details.
  4445. * \var UBXNAV_DOP::gDOP
  4446. * Geometric DOP
  4447. * \var UBXNAV_DOP::pDOP
  4448. * Position DOP
  4449. * \var UBXNAV_DOP::tDOP
  4450. * Time DOP
  4451. * \var UBXNAV_DOP::vDOP
  4452. * Vertical DOP
  4453. * \var UBXNAV_DOP::hDOP
  4454. * Horizontal DOP
  4455. * \var UBXNAV_DOP::nDOP
  4456. * Northing DOP
  4457. * \var UBXNAV_DOP::eDOP
  4458. * Easting DOP
  4459. */
  4460. /*!
  4461. * \struct UBXNAV_POSECEF
  4462. * \brief Position Solution in ECEF
  4463. * \var UBXNAV_POSECEF::iTOW
  4464. * GPS time of week of the navigation epoch.
  4465. * See the description of iTOW (u-blox© official documentation) for details.
  4466. * \var UBXNAV_POSECEF::ecefX
  4467. * ECEF X coordinate
  4468. * \var UBXNAV_POSECEF::ecefY
  4469. * ECEF Y coordinate
  4470. * \var UBXNAV_POSECEF::ecefZ
  4471. * ECEF Z coordinate
  4472. * \var UBXNAV_POSECEF::pAcc
  4473. * Position Accuracy Estimate
  4474. */
  4475. /*!
  4476. * \struct UBXNAV_POSLLH
  4477. * This message outputs the Geodetic position in the currently selected ellipsoid. The default is
  4478. * the WGS84 Ellipsoid, but can be changed with the message CFG-DAT.
  4479. * \warning See important comments concerning validity of position given in section
  4480. * Navigation Output Filters(u-blox© official documentation).
  4481. * \brief Geodetic Position Solution
  4482. * GPS time of week of the navigation epoch.
  4483. * See the description of iTOW (u-blox© official documentation) for details.
  4484. * \var UBXNAV_POSLLH::iTOW
  4485. * GPS time of week of the navigation epoch.
  4486. * See the description of iTOW (u-blox© official documentation) for details.
  4487. * \var UBXNAV_POSLLH::lon
  4488. * Longitude
  4489. * \var UBXNAV_POSLLH::lat
  4490. * Latitude
  4491. * \var UBXNAV_POSLLH::height
  4492. * Height above ellipsoid
  4493. * \var UBXNAV_POSLLH::hMSL
  4494. * Height above mean sea level
  4495. * \var UBXNAV_POSLLH::hAcc
  4496. * Horizontal accuracy estimate
  4497. * \var UBXNAV_POSLLH::vAcc
  4498. * Vertical accuracy estimate
  4499. */
  4500. /*!
  4501. * \struct UBXPVTFlags
  4502. * \brief this structure implements UBXNAV_PVT::flags
  4503. * \var gnssFixOk
  4504. * A valid fix (i.e within DOP & accuracy masks)
  4505. * \var diffSoln:1
  4506. * 1 if differential corrections were applied
  4507. * \var psmState:3
  4508. * Power Save Mode state
  4509. * \see #UBXPVTPSMStates to fill this field
  4510. */
  4511. /*!
  4512. * \struct UBXNAV_PVT
  4513. * This message combines position, velocity and time solution, including accuracy figures
  4514. * \brief Navigation Position Velocity Time Solution
  4515. * \note that during a leap second there may be more (or less) than 60 seconds in a
  4516. * minute.\n
  4517. * See the description of leap seconds(u-blox© official documentation) for details.
  4518. * \var UBXNAV_PVT::iTOW
  4519. * GPS time of week of the navigation epoch.
  4520. * See the description of iTOW (u-blox© official documentation) for details.
  4521. * \var UBXNAV_PVT::year
  4522. * Year (UTC)
  4523. * \note Range 1-65635
  4524. * \var UBXNAV_PVT::month
  4525. * Month
  4526. * \note Range 1-12
  4527. * \var UBXNAV_PVT::day
  4528. * Day
  4529. * \note Range 1-31
  4530. * \var UBXNAV_PVT::hour
  4531. * Hour
  4532. * \note Range 0-23
  4533. * \var UBXNAV_PVT::minute
  4534. * Minute
  4535. * \note Range 0-59
  4536. * \var UBXNAV_PVT::second
  4537. * Second
  4538. * \note Range 0-60
  4539. * \var UBXNAV_PVT::valid
  4540. * Validity Flags
  4541. * \see #UBXPVTValid to fill this field
  4542. * \var UBXNAV_PVT::tAcc
  4543. * Time accuracy estimate
  4544. * \var UBXNAV_PVT::nano
  4545. * Fraction of second
  4546. * \note Range -1e9 .. 1e9
  4547. * \var UBXNAV_PVT::fixType
  4548. * GNSSfix Type
  4549. * \see #UBXGPSFix to fill this field
  4550. * \var UBXNAV_PVT::flags
  4551. * Fix Status Flags
  4552. * \see #UBXPVTFlags to fill this field
  4553. * \var UBXNAV_PVT::reserved1
  4554. * Reserved
  4555. * \var UBXNAV_PVT::numSV
  4556. * Number of satellites used in Nav Solution
  4557. * \var UBXNAV_PVT::lon
  4558. * Longitude
  4559. * \var UBXNAV_PVT::lat
  4560. * Latitude
  4561. * \var UBXNAV_PVT::height
  4562. * Height above Ellipsoid
  4563. * \var UBXNAV_PVT::hMSL
  4564. * Height above mean sea level
  4565. * \var UBXNAV_PVT::hAcc
  4566. * Horizontal Accuracy Estimate
  4567. * \var UBXNAV_PVT::vAcc
  4568. * Vertical Accuracy Estimate
  4569. * \var UBXNAV_PVT::velN
  4570. * NED north velocity
  4571. * \var UBXNAV_PVT::velE
  4572. * NED east velocity
  4573. * \var UBXNAV_PVT::velD
  4574. * NED down velocity
  4575. * \var UBXNAV_PVT::gSpeed
  4576. * Ground Speed (2-D)
  4577. * \var UBXNAV_PVT::heading
  4578. * Heading of motion 2-D
  4579. * \var UBXNAV_PVT::sAcc
  4580. * Speed Accuracy Estimate
  4581. * \var UBXNAV_PVT::headingAcc
  4582. * Heading Accuracy Estimate
  4583. * \var UBXNAV_PVT::pDOP
  4584. * Position DOP
  4585. * \var UBXNAV_PVT::reserved2
  4586. * Reserved
  4587. * \var UBXNAV_PVT::reserved3
  4588. * Reserved
  4589. */
  4590. /*!
  4591. * \struct UBXNAV_SBAS
  4592. * This message outputs the status of the SBAS sub system
  4593. * \note this message has variable payload of #UBXNAV_SBAS_PART type
  4594. * \brief SBAS Status Data
  4595. *
  4596. * \var UBXNAV_SBAS::iTOW
  4597. * GPS time of week of the navigation epoch.
  4598. * See the description of iTOW (u-blox© official documentation) for details.
  4599. * \var UBXNAV_SBAS::geo
  4600. * PRN Number of the GEO where correction and
  4601. * integrity data is used from
  4602. * \var UBXNAV_SBAS::mode
  4603. * SBAS Mode
  4604. * \todo Following values will be covered with enum in future
  4605. * - 0 Disabled
  4606. * - 1 Enabled Integrity
  4607. * - 3 Enabled Testmode
  4608. * \var UBXNAV_SBAS::sys
  4609. * SBAS System (WAAS/EGNOS/...)
  4610. * \todo Following values will be covered with enum in future
  4611. * - -1 Unknown
  4612. * - 0 WAAS
  4613. * - 1 EGNOS
  4614. * - 2 MSAS
  4615. * - 16 GPS
  4616. * \var UBXNAV_SBAS::service
  4617. * SBAS Services available
  4618. * \see #UBXSBASService to fill this field
  4619. * \var UBXNAV_SBAS::cnt
  4620. * Number of SV data following
  4621. * \var UBXNAV_SBAS::reserved0[3]
  4622. * Reserved
  4623. */
  4624. /*!
  4625. * \struct UBXNAV_SBAS_PART
  4626. * \brief Variable payload for #UBXNAV_SBAS
  4627. *
  4628. * \var UBXNAV_SBAS_PART::svid
  4629. * SV Id
  4630. * \var UBXNAV_SBAS_PART::flags
  4631. * Flags for this SV
  4632. * \var UBXNAV_SBAS_PART::udre
  4633. * Monitoring status
  4634. * \var UBXNAV_SBAS_PART::svSys
  4635. * System (WAAS/EGNOS/...) same as UBXNAV_SBAS::sys
  4636. * \var UBXNAV_SBAS_PART::svService
  4637. * Services available same as UBXNAV_SBAS::service
  4638. * \var UBXNAV_SBAS_PART::reserved1
  4639. * Reserved
  4640. * \var UBXNAV_SBAS_PART::prc
  4641. * Pseudo Range correction
  4642. * \var UBXNAV_SBAS_PART::reserved2
  4643. * Reserved
  4644. * \var UBXNAV_SBAS_PART::ic
  4645. * Ionosphere correction
  4646. */
  4647. /*!
  4648. * \struct UBXNAV_SOL
  4649. * This message combines position, velocity and time solution in ECEF, including accuracy figures.
  4650. * This message has only been retained for backwards compatibility; users are recommended
  4651. * to use the UBX-NAV-PVT message in preference.
  4652. * \brief Navigation Solution Information
  4653. *
  4654. * \var UBXNAV_SOL::iTOW
  4655. * GPS time of week of the navigation epoch.
  4656. * See the description of iTOW (u-blox© official documentation) for details.
  4657. * \var UBXNAV_SOL::fTOW
  4658. * Fractional part of iTOW
  4659. * The precise GPS time of week in seconds is:
  4660. * (UBXNAV_SOL::iTOW * 1e-3) + (UBXNAV_SOL::fTOW * 1e-9)
  4661. * \note Range +/-500000
  4662. * \var UBXNAV_SOL::week
  4663. * GPS week number of the navigation epoch
  4664. * \var UBXNAV_SOL::gpsFix
  4665. * GPS fix type
  4666. * \see #UBXGPSFix to fill this field
  4667. * \var UBXNAV_SOL::flags
  4668. * Fix Status Flags
  4669. * \see #UBXSBASSOLFlags to fill this field
  4670. * \var UBXNAV_SOL::ecefX
  4671. * ECEF X coordinate
  4672. * \var UBXNAV_SOL::ecefY
  4673. * ECEF Y coordinate
  4674. * \var UBXNAV_SOL::ecefZ
  4675. * ECEF Z coordinate
  4676. * \var UBXNAV_SOL::pAcc
  4677. * 3D Position Accuracy Estimate
  4678. * \var UBXNAV_SOL::ecefVX
  4679. * ECEF X velocity
  4680. * \var UBXNAV_SOL::ecefVY
  4681. * ECEF Y velocity
  4682. * \var UBXNAV_SOL::ecefVZ
  4683. * ECEF Z velocity
  4684. * \var UBXNAV_SOL::sAcc
  4685. * Speed Accuracy Estimate
  4686. * \var UBXNAV_SOL::pDOP
  4687. * Position DOP
  4688. * \var UBXNAV_SOL::reserved1
  4689. * Reserved
  4690. * \var UBXNAV_SOL::numSV
  4691. * Number of SVs used in Nav Solution
  4692. * \var UBXNAV_SOL::reserved2
  4693. * Reserved
  4694. */
  4695. /*!
  4696. * \struct UBXNAV_STATUS
  4697. * Validity of position and velocity given in.
  4698. * \warning See important comments concerningsection Navigation Output Filters(u-blox© official documentation).
  4699. * \brief Receiver Navigation Status
  4700. * \var UBXNAV_STATUS::iTOW
  4701. * GPS time of week of the navigation epoch.
  4702. * See the description of iTOW (u-blox© official documentation) for details.
  4703. * \var UBXNAV_STATUS::gpsFix
  4704. * GPSfix Type, this value does not qualify a fix as
  4705. * valid and within the limits
  4706. * \see #UBXGPSFix to fill this field
  4707. * \var UBXNAV_STATUS::flags
  4708. * Navigation Status Flags
  4709. * \see #UBXGPSFix to fill this field
  4710. * \var UBXNAV_STATUS::fixStat
  4711. * Fix Status Information
  4712. * \see #UBXSBASSOLFlags to fill this field
  4713. * \var UBXNAV_STATUS::flags2
  4714. * Further information about navigation output
  4715. * \todo Structure to fill this field will be implemtened in future
  4716. * - 0 -ACQUISITION [or when psm disabled]
  4717. * - 1 - TRACKING
  4718. * - 2 - POWER OPTIMIZED TRACKING
  4719. * - 3 - INACTIVE
  4720. * \var UBXNAV_STATUS::ttff
  4721. * Time to first fix (millisecond time tag)
  4722. * \var UBXNAV_STATUS::msss
  4723. * Milliseconds since Startup / Reset
  4724. */
  4725. /*!
  4726. * \struct UBXSVINFOGlobalFlags
  4727. * \brief Implements UBXNAV_SVINFO::globalFlags
  4728. * \var UBXSVINFOGlobalFlags::chipGen:3
  4729. * Chip hardware generation
  4730. * \see #UBXSVINFOChipGen to fill this field
  4731. */
  4732. /*!
  4733. * \struct UBXNAV_SVINFO
  4734. * \note this message has variable payload of #UBXNAV_SVINFO_PART type
  4735. * \brief Space Vehicle Information
  4736. *
  4737. * \var UBXNAV_SVINFO::iTOW
  4738. * GPS time of week of the navigation epoch.
  4739. * See the description of iTOW (u-blox© official documentation) for details.
  4740. * \var UBXNAV_SVINFO::numCh
  4741. * Number of channels
  4742. * \var UBXNAV_SVINFO::globalFlags
  4743. * Bitmask
  4744. * \var UBXNAV_SVINFO::reserved2
  4745. * Reserved
  4746. */
  4747. /*!
  4748. * \struct UBXSVINFOQuality
  4749. * \brief Implements UBXNAV_SVINFO_PART::quality
  4750. * \var UBXSVINFOQuality::qualityInd
  4751. * Signal Quality indicator
  4752. * \see #UBXSVINFOQualityId to fill this field
  4753. */
  4754. /*!
  4755. * \struct UBXNAV_SVINFO_PART
  4756. * \brief Variable payload for #UBXNAV_SVINFO
  4757. *
  4758. * \var UBXNAV_SVINFO_PART::chn
  4759. * Channel number, 255 for SVs not assigned to a channel
  4760. * \var UBXNAV_SVINFO_PART::svid
  4761. * Satellite ID, see Satellite numbering(u-blox© official documentation) for
  4762. * assignment
  4763. * \var UBXNAV_SVINFO_PART::flags
  4764. * Bitmask
  4765. * \see #UBXSVINFOFlags to fill this field
  4766. * \var UBXNAV_SVINFO_PART::quality
  4767. * Bitfield
  4768. * \see #UBXSVINFOQuality to fill this field
  4769. * \var UBXNAV_SVINFO_PART::cno
  4770. * Carrier to Noise Ratio (Signal Strength)
  4771. * \var UBXNAV_SVINFO_PART::elev
  4772. * Elevation in integer degrees
  4773. * \var UBXNAV_SVINFO_PART::azim
  4774. * Azimuth in integer degrees
  4775. * \var UBXNAV_SVINFO_PART::prRes
  4776. * Pseudo range residual in centimetres
  4777. */
  4778. /*!
  4779. * \struct UBXNAV_TIMEGPS
  4780. * This message reports the precise GPS time of the most recent navigation solution including
  4781. * validity falgs and an accuracy estimate.
  4782. * \brief GPS Time Solution
  4783. *
  4784. * \var UBXNAV_TIMEGPS::iTOW
  4785. * GPS time of week of the navigation epoch.
  4786. * See the description of iTOW (u-blox© official documentation) for details.
  4787. * \var UBXNAV_TIMEGPS::fTOW
  4788. * Fractional part of iTOW
  4789. * The precise GPS time of week in seconds is:
  4790. * (UBXNAV_SOL::iTOW * 1e-3) + (UBXNAV_SOL::fTOW * 1e-9)
  4791. * \var UBXNAV_TIMEGPS::week
  4792. * GPS week number of the navigation epoch
  4793. * \var UBXNAV_TIMEGPS::leapS
  4794. * GPS leap seconds
  4795. * \var UBXNAV_TIMEGPS::valid
  4796. * Validity Flags
  4797. * \see #UBXTIMEGPSValidityFlags to fill this field
  4798. * \var UBXNAV_TIMEGPS::tAcc
  4799. * Time Accuracy Estimate
  4800. */
  4801. /*!
  4802. * \struct UBXNAV_TIMEUTC
  4803. * Note that during a leap second there may be more (or less) than 60 seconds in a
  4804. * minute; see the description of leap seconds(u-blox© official documentation) for details.
  4805. * \brief UTC Time Solution
  4806. * \var UBXNAV_TIMEUTC::iTOW
  4807. * GPS time of week of the navigation epoch.
  4808. * See the description of iTOW (u-blox© official documentation) for details.
  4809. * \var UBXNAV_TIMEUTC::tAcc
  4810. * Time accuracy estimate (UTC)
  4811. * \var UBXNAV_TIMEUTC::nano
  4812. * Fraction of second
  4813. * \note Range -1e9 .. 1e9 (UTC)
  4814. * \var UBXNAV_TIMEUTC::year
  4815. * Year (UTC)
  4816. * \note Range 1-65635
  4817. * \var UBXNAV_TIMEUTC::month
  4818. * Month
  4819. * \note Range 1-12
  4820. * \var UBXNAV_TIMEUTC::day
  4821. * Day
  4822. * \note Range 1-31
  4823. * \var UBXNAV_TIMEUTC::hour
  4824. * Hour
  4825. * \note Range 0-23
  4826. * \var UBXNAV_TIMEUTC::minute
  4827. * Minute
  4828. * \note Range 0-59
  4829. * \var UBXNAV_TIMEUTC::second
  4830. * Second
  4831. * \var valid
  4832. * Validity Flags
  4833. * \see #UBXTIMEUTCValidityFlags to fill this field
  4834. */
  4835. /*!
  4836. * \struct UBXNAV_VELECEF
  4837. * See important comments concerning validity of velocity given in section
  4838. * Navigation Output Filters(u-blox© official documentation).
  4839. * \brief Velocity Solution in ECEF
  4840. * \var UBXNAV_VELECEF::iTOW
  4841. * GPS time of week of the navigation epoch.
  4842. * See the description of iTOW (u-blox© official documentation) for details.
  4843. * \var UBXNAV_VELECEF::ecefVX
  4844. * ECEF X velocity
  4845. * \var UBXNAV_VELECEF::ecefVY
  4846. * ECEF Y velocity
  4847. * \var UBXNAV_VELECEF::ecefVZ
  4848. * ECEF Z velocity
  4849. * \var UBXNAV_VELECEF::sAcc
  4850. * Speed accuracy estimate
  4851. */
  4852. /*!
  4853. * \struct UBXNAV_VELNED
  4854. * See important comments concerning validity of velocity given in section
  4855. * Navigation Output Filters(u-blox© official documentation).
  4856. * \brief Velocity Solution in NED
  4857. *
  4858. * \var UBXNAV_VELNED::iTOW
  4859. * GPS time of week of the navigation epoch.
  4860. * See the description of iTOW (u-blox© official documentation) for details.
  4861. * \var UBXNAV_VELNED::velN
  4862. * North velocity component
  4863. * \var UBXNAV_VELNED::velE
  4864. * East velocity component
  4865. * \var UBXNAV_VELNED::velD
  4866. * Down velocity component
  4867. * \var UBXNAV_VELNED::speed
  4868. * Speed (3-D)
  4869. * \var UBXNAV_VELNED::gSpeed
  4870. * Ground speed (2-D)
  4871. * \var UBXNAV_VELNED::heading
  4872. * Heading of motion 2-D
  4873. * \var UBXNAV_VELNED::sAcc
  4874. * Speed accuracy Estimate
  4875. * \var UBXNAV_VELNED::cAcc
  4876. * Course / Heading accuracy estimate
  4877. */
  4878. /*!
  4879. * \struct UBXRXM_ALM_POLL
  4880. * \note No payload
  4881. * \brief Poll GPS Constellation Almanac Data
  4882. */
  4883. /*!
  4884. * \struct UBXRXM_ALM_POLL_OPT
  4885. * \brief Poll GPS Constellation Almanac Data for a SV
  4886. *
  4887. * \var UBXRXM_ALM_POLL_OPT::svid
  4888. * SV ID for which the receiver shall return its Almanac Data
  4889. * \note Valid Range: 1..32
  4890. */
  4891. /*!
  4892. * \struct UBXRXM_ALM
  4893. * - If the WEEK Value is 0, DWRD0 to DWRD7 are not sent as the Almanac is not available
  4894. * for the given SV.
  4895. * - DWORD0 to DWORD7 contain the 8 words following the Hand-Over Word ( HOW )
  4896. * from the GPS navigation message, either pages 1 to 24 of sub-frame 5 or pages 2 to 10
  4897. * of subframe 4. See IS-GPS-200 for a full description of the contents of the Almanac
  4898. * pages.
  4899. * - In DWORD0 to DWORD7, the parity bits have been removed, and the 24 bits of data are
  4900. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  4901. * - Example: Parameter e (Eccentricity) from Almanac Subframe 4/5, Word 3, Bits 69-84
  4902. * within the subframe can be found in DWRD0, Bits 15-0 whereas Bit 0 is the LSB.
  4903. * \brief GPS Aiding Almanac Input/Output Message
  4904. *
  4905. * \deprecated This RMX messages marked as obsolete API use AID instead
  4906. * \var UBXRXM_ALM::svid
  4907. * SV ID for which this Almanac Data
  4908. * \note Valid Range: 1 .. 32 or 51, 56, 63.
  4909. * \var UBXRXM_ALM::week
  4910. * Issue Date of Almanac (GPS week number)
  4911. */
  4912. /*!
  4913. * \struct UBXRXM_ALM_OPT
  4914. * - If the WEEK Value is 0, DWRD0 to DWRD7 are not sent as the Almanac is not available
  4915. * for the given SV.
  4916. * - DWORD0 to DWORD7 contain the 8 words following the Hand-Over Word ( HOW )
  4917. * from the GPS navigation message, either pages 1 to 24 of sub-frame 5 or pages 2 to 10
  4918. * of subframe 4. See IS-GPS-200 for a full description of the contents of the Almanac
  4919. * pages.
  4920. * - In DWORD0 to DWORD7, the parity bits have been removed, and the 24 bits of data are
  4921. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  4922. * - Example: Parameter e (Eccentricity) from Almanac Subframe 4/5, Word 3, Bits 69-84
  4923. * within the subframe can be found in DWRD0, Bits 15-0 whereas Bit 0 is the LSB.
  4924. * \brief GPS Aiding Almanac Input/Output Message
  4925. * \deprecated This RMX messages marked as obsolete API use AID instead
  4926. * \var UBXRXM_ALM_OPT::svid
  4927. * SV ID for which this Almanac Data
  4928. * \note Valid Range: 1 .. 32 or 51, 56, 63.
  4929. * \var UBXRXM_ALM_OPT::week
  4930. * Issue Date of Almanac (GPS week number)
  4931. * \var UBXRXM_ALM_OPT::dwrd[8]
  4932. * Almanac Words
  4933. */
  4934. /*!
  4935. * \struct UBXRXM_EPH_POLL
  4936. * Poll GPS Constellation Data (Ephemeris) for all 32 SVs by sending this message to the
  4937. * receiver without any payload.
  4938. * \note No payload
  4939. * \brief Poll GPS Constellation Ephemeris Data
  4940. */
  4941. /*!
  4942. * \struct UBXRXM_EPH_POLL_OPT
  4943. * Poll GPS Constellation Data (Ephemeris) for an SV by sending this message to the receiver.
  4944. * \brief Poll GPS Constellation Ephemeris Data for a SV
  4945. *
  4946. * \var UBXRXM_EPH_POLL_OPT::svid
  4947. * SV ID for which this Almanac Data
  4948. * \note Valid Range: 1 .. 32 or 51, 56, 63.
  4949. */
  4950. /*!
  4951. * \struct UBXRXM_EPH
  4952. * - SF1D0 to SF3D7 is only sent if ephemeris is available for this SV. If not, the payload may
  4953. * be reduced to 8 Bytes, or all bytes are set to zero, indicating that this SV Number does
  4954. * not have valid ephemeris for the moment.
  4955. * - SF1D0 to SF3D7 contain the 24 words following the Hand-Over Word ( HOW ) from the
  4956. * GPS navigation message, subframes 1 to 3. See IS-GPS-200 for a full description of the
  4957. * contents of the Subframes.
  4958. * - In SF1D0 to SF3D7, the parity bits have been removed, and the 24 bits of data are
  4959. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  4960. * \brief GPS Aiding Ephemeris Input/Output Message
  4961. *
  4962. * \deprecated This RMX messages marked as obsolete API use AID instead
  4963. * \var UBXRXM_EPH::svid
  4964. * SV ID for which this Almanac Data
  4965. * \var UBXRXM_EPH::how
  4966. * Hand-Over Word of first Subframe. This is
  4967. * required if data is sent to the receiver.
  4968. * 0 indicates that no Ephemeris Data is following.
  4969. */
  4970. /*!
  4971. * \struct UBXRXM_EPH_OPT
  4972. * - SF1D0 to SF3D7 is only sent if ephemeris is available for this SV. If not, the payload may
  4973. * be reduced to 8 Bytes, or all bytes are set to zero, indicating that this SV Number does
  4974. * not have valid ephemeris for the moment.
  4975. * - SF1D0 to SF3D7 contain the 24 words following the Hand-Over Word ( HOW ) from the
  4976. * GPS navigation message, subframes 1 to 3. See IS-GPS-200 for a full description of the
  4977. * contents of the Subframes.
  4978. * - In SF1D0 to SF3D7, the parity bits have been removed, and the 24 bits of data are
  4979. * located in Bits 0 to 23. Bits 24 to 31 shall be ignored.
  4980. * \brief GPS Aiding Ephemeris Input/Output Message
  4981. *
  4982. * \deprecated This RMX messages marked as obsolete API use AID instead
  4983. * \var UBXRXM_EPH_OPT::svid
  4984. * SV ID for which this Almanac Data
  4985. * \var UBXRXM_EPH_OPT::how
  4986. * \var UBXRXM_EPH_OPT::sf1d[8]
  4987. * Subframe 1 Words 3..10 (SF1D0..SF1D7)
  4988. * \var UBXRXM_EPH_OPT::sf2d[8]
  4989. * Subframe 2 Words 3..10 (SF2D0..SF2D7)
  4990. * \var UBXRXM_EPH_OPT::sf3d[8]
  4991. * Subframe 3 Words 3..10 (SF3D0..SF3D7)
  4992. */
  4993. /*!
  4994. * \struct UBXRXM_PMREQ
  4995. * Request of a Power Management related task of the receiver.
  4996. * \brief Requests a Power Management task
  4997. * \var UBXRXM_PMREQ::duration
  4998. * Duration of the requested task
  4999. * \note Set to 0 for infinite duration
  5000. * \var UBXRXM_PMREQ::flags
  5001. * Task flags
  5002. * \see #UBXPMREQFlags to fill this field
  5003. */
  5004. /*!
  5005. * \struct UBXRXM_RAW
  5006. * This message contains all information needed to be able to generate a RINEX observation
  5007. * file.
  5008. * This message outputs pseudorange, doppler and carrier phase measurements for GPS
  5009. * satellites once signals have been synchronised. No other GNSS types are currently
  5010. * supported.
  5011. * \note This message has variable payload of #UBXRXM_RAW_PART type
  5012. * \brief Raw Measurement Data
  5013. *
  5014. * \var UBXRXM_RAW::rcvTow
  5015. * Measurement time of week in receiver local
  5016. * time
  5017. * \var UBXRXM_RAW::week
  5018. * Measurement week number in receiver local
  5019. * time
  5020. * \var UBXRXM_RAW::numSV
  5021. * Number of satellites following
  5022. * \var UBXRXM_RAW::reserved1
  5023. * Reserved
  5024. */
  5025. /*!
  5026. * \struct UBXRXM_RAW_PART
  5027. * \brief Variable payload for #UBXRXM_RAW
  5028. * \var UBXRXM_RAW_PART::cpMes
  5029. * Carrier phase measurement
  5030. * \var UBXRXM_RAW_PART::prMes
  5031. * Pseudorange measurement
  5032. * \var UBXRXM_RAW_PART::doMes
  5033. * Doppler measurement (positive sign for approaching satellites)
  5034. * \var UBXRXM_RAW_PART::sv
  5035. * Space Vehicle number
  5036. * \var UBXRXM_RAW_PART::mesQI
  5037. * Nav Measurements Quality Indicator:
  5038. * \note
  5039. * - >=4 - PR+DO OK
  5040. * - >=5 - PR+DO+CP OK
  5041. * - <6 - likely loss of carrier lock in previous interval
  5042. * \var UBXRXM_RAW_PART::cno
  5043. * Signal strength C/No
  5044. * \var UBXRXM_RAW_PART::lli
  5045. * Loss of lock indicator (RINEX definition)
  5046. */
  5047. /*!
  5048. * \struct UBXRXM_SFRB
  5049. * The content of one single subframe buffer
  5050. * For GPS satellites, the 10 dwrd values contain the parity checked subframe data for 10
  5051. * Words. Each dwrd has 24 Bits with valid data (Bits 23 to 0). The remaining 8 bits (31 to 24)
  5052. * have an undefined value. The direction within the Word is that the higher order bits are
  5053. * received from the SV first. Example: The Preamble can be found in dwrd[0], at bit position
  5054. * 23 down to 16. For more details on the data format please refer to the ICD-GPS-200C
  5055. * Interface document.
  5056. * For SBAS satellites, the 250 Bit message block can be found in dwrd[0] to dwrd[6] for the
  5057. * first 224 bits. The remaining 26 bits are in dwrd[7], whereas Bits 25 and 24 are the last two
  5058. * data bits, and Bits 23 down to 0 are the parity bits. For more information on SBAS data
  5059. * format, please refer to RTCA/DO-229C (MOPS), Appendix A.
  5060. * No other GNSS types are currently supported.
  5061. * \brief Subframe Buffer
  5062. * \var UBXRXM_SFRB::chn
  5063. * Channel Number
  5064. * \var UBXRXM_SFRB::svid
  5065. * ID of Satellite transmitting Subframe
  5066. * \var UBXRXM_SFRB::dwrd[10]
  5067. * Words of Data
  5068. */
  5069. /*!
  5070. * \struct UBXRXM_SVSI
  5071. * Status of the receiver manager knowledge about GPS Orbit Validity
  5072. * \note This message has variable payload of #UBXRXM_SVSI_PART type
  5073. * \brief SV Status Info
  5074. *
  5075. * \var UBXRXM_SVSI::iTOW
  5076. * GPS time of week of the navigation epoch.
  5077. * See the description of iTOW (u-blox© official documentation) for details.
  5078. * \var UBXRXM_SVSI::week
  5079. * GPS week number of the navigation epoch
  5080. * \var UBXRXM_SVSI::numVis
  5081. * Number of visible satellites
  5082. * \var UBXRXM_SVSI::numSV
  5083. * Number of per-SV data blocks following
  5084. */
  5085. /*!
  5086. * \struct UBXSVSISVFlags
  5087. * \brief Implements UBXRXM_SVSI_PART::svFlag
  5088. * \var UBXSVSISVFlags::ura
  5089. * Figure of Merit (URA)
  5090. * \note Range 0..15
  5091. * \var UBXSVSISVFlags::healthy
  5092. * SV healthy flag
  5093. * \var UBXSVSISVFlags::ephVal
  5094. * Ephemeris valid
  5095. * \var UBXSVSISVFlags::almVal
  5096. * Almanac valid
  5097. * \var UBXSVSISVFlags::notAvail
  5098. * SV not available
  5099. */
  5100. /*!
  5101. * \struct UBXSVSIAge
  5102. * \brief Implements UBXRXM_SVSI_PART::age
  5103. * \var UBXSVSIAge::almAge
  5104. * Age of ALM in days offset by 4
  5105. * i.e. the reference time may be in the future:
  5106. * ageOfAlm = (age & 0x0f) - 4
  5107. * \var UBXSVSIAge::ephAge
  5108. * Age of EPH in hours offset by 4.
  5109. * i.e. the reference time may be in the future:
  5110. * ageOfEph = ((age & 0xf0) >> 4) - 4
  5111. */
  5112. /*!
  5113. * \struct UBXRXM_SVSI_PART
  5114. * \brief Variable payload for #UBXRXM_SVSI
  5115. * \var UBXRXM_SVSI_PART::svid
  5116. * Satellite ID
  5117. * \var UBXRXM_SVSI_PART::svFlag
  5118. * Information Flags
  5119. * \see #UBXSVSISVFlags to fill this field
  5120. * \var UBXRXM_SVSI_PART::azim
  5121. * Azimuth
  5122. * \var UBXRXM_SVSI_PART::elev
  5123. * Elevation
  5124. * \var UBXRXM_SVSI_PART::age
  5125. * Age of Almanac and Ephemeris
  5126. * \see UBXSVSIAge to fill this field
  5127. */
  5128. /*!
  5129. * \struct UBXTM2Flags
  5130. * \brief Implements UBXTIM_TM2::flags
  5131. * \var UBXTM2Flags::mode
  5132. * Mode bitmask
  5133. * \see #UBXTM2FlagsMode to fill this field
  5134. * \var UBXTM2Flags::run
  5135. * Run state
  5136. * \see #UBXTM2FlagsRun to fill this field
  5137. * \var UBXTM2Flags::newFallingEdge
  5138. * New falling edge detected
  5139. * \var UBXTM2Flags::timeBase
  5140. * Time base
  5141. * \see #UBXTM2FlagsTimeBase to fill this field
  5142. * \var UBXTM2Flags::utc
  5143. * UTC availability
  5144. * \see #UBXTM2FlagsUTC to fill this field
  5145. * \var UBXTM2Flags::time
  5146. * Time is valid
  5147. * \see #UBXTM2FlagsTime to fill this field
  5148. * \var UBXTM2Flags::newRisingEdge
  5149. * New rising edge detected
  5150. */
  5151. /*!
  5152. * \struct UBXTIM_TM2
  5153. * This message contains information for high precision time stamping / pulse counting.
  5154. * The delay figures and timebase given in UBXCFG_TP5 are also applied to the time results
  5155. * output in this message.
  5156. * \brief Time mark data
  5157. *
  5158. * \var UBXTIM_TM2::ch
  5159. * Marker channel 0 or 1
  5160. * \var UBXTIM_TM2::flags
  5161. * Flags
  5162. * \see #UBXTM2Flags to fill this field
  5163. * \var UBXTIM_TM2::count
  5164. * Rising edge counter
  5165. * \var UBXTIM_TM2::wnR
  5166. * week number of last rising edge
  5167. * \var UBXTIM_TM2::wnF
  5168. * week number of last falling edge
  5169. * \var UBXTIM_TM2::towMsR
  5170. * tow of rising edge
  5171. * \var UBXTIM_TM2::towSubMsR
  5172. * millisecond fraction of tow of rising edge in
  5173. * nanoseconds
  5174. * \var UBXTIM_TM2::towMsF
  5175. * tow of falling edge
  5176. * \var UBXTIM_TM2::towSubMsF
  5177. * millisecond fraction of tow of falling edge in
  5178. * nanoseconds
  5179. * \var UBXTIM_TM2::accEst
  5180. * Accuracy estimate
  5181. */
  5182. /*!
  5183. * \struct UBXTIM_TP
  5184. * This message contains information for high precision timing. The recommended
  5185. * configuration when using this message is to set both the measurement rate (CFG-RATE)
  5186. * and the timepulse frequency (CFG-TP5) to 1Hz. For more information see section Time
  5187. * pulse.
  5188. * \brief Time Pulse Timedata
  5189. *
  5190. * \var UBXTIM_TP::towMS
  5191. * Time pulse time of week according to time base
  5192. * \var UBXTIM_TP::towSubMS
  5193. * Submillisecond part of TOWMS
  5194. * \var UBXTIM_TP::qErr
  5195. * Quantization error of time pulse.
  5196. * \var UBXTIM_TP::week
  5197. * Time pulse week number according to time
  5198. * base
  5199. * \var UBXTIM_TP::flags
  5200. * \see UBXTPFlags to fill this field
  5201. * \var UBXTIM_TP::reserved1
  5202. * Reserved
  5203. */
  5204. /*!
  5205. * \struct UBXVRFYFlags
  5206. * \brief Implements UBXTIM_VRFY::flags
  5207. *
  5208. * \var UBXVRFYFlags::src
  5209. * Aiding time source
  5210. * \see #UBXVRFYFlagsSource to fill this field
  5211. */
  5212. /*!
  5213. * \struct UBXTIM_VRFY
  5214. * \brief Sourced Time Verification
  5215. *
  5216. * \var UBXTIM_VRFY::itow
  5217. * Integer millisecond tow received by source
  5218. * \var UBXTIM_VRFY::frac
  5219. * Sub-millisecond part of tow
  5220. * \var UBXTIM_VRFY::deltaMs
  5221. * Integer milliseconds of delta time (current time minus sourced time)
  5222. * \var UBXTIM_VRFY::deltaNs
  5223. * Sub-millisecond part of delta time
  5224. * \var UBXTIM_VRFY::wno
  5225. * Week number
  5226. * \var UBXTIM_VRFY::flags
  5227. * Information flags
  5228. * \see #UBXVRFYFlags to fill this field
  5229. * \var UBXTIM_VRFY::reserved1
  5230. * Reserved
  5231. */
  5232. /*! \addtogroup Types
  5233. * @{
  5234. */
  5235. /*!
  5236. * \typedef UBXU1_t
  5237. * Unsigned char
  5238. * \note Size: 1 byte\n
  5239. * Range: 0..255
  5240. *
  5241. * \typedef UBXI1_t
  5242. * Signed char
  5243. * \note Size: 1 byte\n
  5244. * Range: -128..127
  5245. *
  5246. * \typedef UBXX1_t
  5247. * Bitfield
  5248. * \note Size: 1 byte\n
  5249. * Range: 0b00000000..0b11111111
  5250. *
  5251. * \typedef UBXU2_t
  5252. * Unsigned short
  5253. * \note Size: 2 bytes\n
  5254. * Range: 0..65535
  5255. *
  5256. * \typedef UBXI2_t
  5257. * Signed short
  5258. * \note Size: 2 bytes\n
  5259. * Range: -32768..32767
  5260. *
  5261. * \typedef UBXX2_t
  5262. * Bitfield
  5263. * \note Size: 2 bytes\n
  5264. * Range: 0b0000000000000000..0b1111111111111111
  5265. *
  5266. * \typedef UBXU4_t
  5267. * Unsigned Long
  5268. * \note Size: 4 bytes\n
  5269. * Range: 0..4294967295
  5270. *
  5271. * \typedef UBXI4_t
  5272. * Unsigned Long
  5273. * \note Size: 4 bytes\n
  5274. * Range: -2147483648..2147483647
  5275. *
  5276. * \typedef UBXX4_t
  5277. * Bitfield
  5278. * \note Size: 4 bytes\n
  5279. * Range: 0b00000000000000000000000000000000..0b11111111111111111111111111111111
  5280. *
  5281. * \typedef UBXR4_t
  5282. * IEEE 754 Single Precision
  5283. * \note Size: 4 bytes\n
  5284. * Range: -1*2^+127..2^+127
  5285. *
  5286. * \typedef UBXR8_t
  5287. * IEEE 754 Double Precision
  5288. * \note Size: 8 bytes\n
  5289. * Range: -1*2^+1023..2^+1023
  5290. *
  5291. * \typedef UBXCH_t;
  5292. * ASCII / ISO 8859.1 Encoding
  5293. * \note Size: 1 byte\n
  5294. */
  5295. /*! @} */
  5296. /*! \addtogroup Functions
  5297. * @{
  5298. */
  5299. /*!
  5300. * \fn struct UBXMsgBuffer getAID_ALPSRV(struct UBXMsg* clientMgs, const struct UBXAlpFileInfo *fileInfo)
  5301. * \brief Getter for #UBXAID_ALPSRV message
  5302. * \param clientMgs
  5303. * u-blox module original request
  5304. * \param fileInfo
  5305. * full ALP file data
  5306. * \return
  5307. * Returns full UBXMsgBuffer including header and checksum
  5308. */
  5309. /*!
  5310. * \fn struct UBXMsgBuffer getCFG_MSG_POLL(enum UBXMessageClass msgClass, enum UBXMessageId msgId)
  5311. * This function construct full buffer for #UBXCFG_MSG_POLL message.
  5312. * \brief Getter for #UBXCFG_MSG_POLL
  5313. * \param msgClass
  5314. * Message Class
  5315. * \see #UBXMessageClass to fill this field
  5316. * \param msgId
  5317. * Message Id
  5318. * \see #UBXMessageId to fill this field
  5319. * \return
  5320. * Returns full UBXMsgBuffer including header and checksum
  5321. */
  5322. /*!
  5323. * \fn struct UBXMsgBuffer getCFG_MSG_RATE(enum UBXMessageClass msgClass, enum UBXMessageId msgId, UBXU1_t rate)
  5324. * This function construct full buffer for #UBXCFG_MSG_RATE message.
  5325. * \brief Getter for #UBXCFG_MSG_RATE
  5326. * \param msgClass
  5327. * Message Class
  5328. * \see #UBXMessageClass to fill this field
  5329. * \param msgId
  5330. * Message Id
  5331. * \see #UBXMessageId to fill this field
  5332. * \param rate
  5333. * Send rate on current Port
  5334. * \return
  5335. * Returns full UBXMsgBuffer including header and checksum
  5336. */
  5337. /*!
  5338. * \fn struct UBXMsgBuffer getCFG_MSG_RATES(enum UBXMessageClass msgClass, enum UBXMessageId msgId, UBXU1_t rate[])
  5339. * This function construct full buffer for #UBXCFG_MSG_RATES message.
  5340. * \brief Getter for #UBXCFG_MSG_RATES
  5341. * \param msgClass
  5342. * Message Class
  5343. * \see #UBXMessageClass to fill this field
  5344. * \param msgId
  5345. * Message Id
  5346. * \see #UBXMessageId to fill this field
  5347. * \param rate
  5348. * Send rate on I/O Port (6 Ports)
  5349. * \return
  5350. * Returns full UBXMsgBuffer including header and checksum
  5351. */
  5352. /*!
  5353. * \fn struct UBXMsgBuffer getCFG_RST(int mode, UBXU2_t mask)
  5354. * This function construct full buffer for #UBXCFG_RST message.
  5355. * \brief Getter for #UBXCFG_RST
  5356. * \param mode
  5357. * Mode bitmask
  5358. * \see UBXResetMode to fill this field
  5359. * \param mask
  5360. * BBR Sections to clear.
  5361. * \see #UBXBBRMask to fill this field manually
  5362. * \return
  5363. * Returns full UBXMsgBuffer including header and checksum
  5364. */
  5365. /*!
  5366. * \fn struct UBXMsgBuffer getCFG_RST_OPT(int mode, enum UBXBBRSpecialSets special)
  5367. * This function construct full buffer for #UBXCFG_RST_OPT message.
  5368. * \brief Getter for #UBXCFG_RST_OPT
  5369. * \param mode
  5370. * Mode bitmask
  5371. * \see UBXResetMode to fill this field
  5372. * \param special
  5373. * BBR Sections to clear.
  5374. * \see #UBXBBRSpecialSets for special sets
  5375. * \return
  5376. * Returns full UBXMsgBuffer including header and checksum
  5377. */
  5378. /*!
  5379. * \fn struct UBXMsgBuffer getCFG_TP5_POLL_OPT(enum UBXCFGTimepulses tpIdx)
  5380. * This function construct full buffer for #UBXCFG_TP5_POLL_OPT message.
  5381. * \brief Getter for #UBXCFG_TP5_POLL_OPT
  5382. * \param tpIdx
  5383. * Time pulse selection
  5384. * \see #UBXCFGTimepulses to fill this field
  5385. * \return
  5386. * Returns full UBXMsgBuffer including header and checksum
  5387. */
  5388. /*!
  5389. * \fn struct UBXMsgBuffer getCFG_TP5(enum UBXCFGTimepulses tpIdx, int16_t antCableDelay, int16_t rfGroupDelay,
  5390. u_int32_t freqPeriod, u_int32_t freqPeriodLock, u_int32_t pulseLenRatio,
  5391. u_int32_t pulseLenRatioLock, int32_t userConfigDelay, int32_t flags)
  5392. * This function construct full buffer for #UBXCFG_TP5 message.
  5393. * \brief Getter for #UBXCFG_TP5
  5394. * \param tpIdx
  5395. * Time pulse selection
  5396. * \see #UBXCFGTimepulses to fill this field
  5397. * \param antCableDelay
  5398. * Antenna cable delay
  5399. * \param rfGroupDelay
  5400. * RF group delay
  5401. * \param freqPeriod
  5402. * Frequency or period time
  5403. * \note Depending on setting of bit 'isFreq'
  5404. * \param freqPeriodLock
  5405. * Frequency or period time when locked to GPS
  5406. * time
  5407. * \note Only used if 'lockedOtherSet' is set
  5408. * \param pulseLenRatio
  5409. * Pulse length or duty cycle
  5410. * \note Depending on 'isLength'
  5411. * \param pulseLenRatioLock
  5412. * Pulse length or duty cycle when locked to GPS
  5413. * time
  5414. * \note only used if 'lockedOtherSet' is set
  5415. * \param userConfigDelay
  5416. * User configurable time pulse delay
  5417. * \param flags
  5418. * Configuration flags
  5419. * \return
  5420. * Returns full UBXMsgBuffer including header and checksum
  5421. */
  5422. /*!
  5423. * \fn getAID_ALM_POLL
  5424. * This function construct full buffer for #UBXAID_ALM_POLL message.
  5425. * \brief Getter for #UBXAID_ALM_POLL
  5426. * \return
  5427. * Returns full UBXMsgBuffer including header and checksum
  5428. */
  5429. /*!
  5430. * \fn struct UBXMsgBuffer getAID_ALM_POLL_OPT(UBXU1_t svid)
  5431. * This function construct full buffer for #UBXAID_ALM_POLL_OPT message.
  5432. * \brief Getter for #UBXAID_ALM_POLL_OPT
  5433. * \param svid
  5434. * SV ID for which the receiver shall return its
  5435. * Almanac Data (Valid Range: 1 .. 32 or 51, 56,
  5436. * 63).
  5437. * \return
  5438. * Returns full UBXMsgBuffer including header and checksum
  5439. */
  5440. /*!
  5441. * \fn struct UBXMsgBuffer getAID_ALM(UBXU4_t svid, UBXU4_t week)
  5442. * This function construct full buffer for #UBXAID_ALM message.
  5443. * \brief Getter for #UBXAID_ALM
  5444. * \param svid
  5445. * SV ID for which the receiver shall return its
  5446. * Almanac Data (Valid Range: 1 .. 32 or 51, 56,
  5447. * 63).
  5448. * \param week
  5449. * Issue Date of Almanac (GPS week number)
  5450. * \return
  5451. * Returns full UBXMsgBuffer including header and checksum
  5452. */
  5453. /*!
  5454. * \fn struct UBXMsgBuffer getAID_ALM_OPT(UBXU4_t svid, UBXU4_t week, UBXU4_t dwrd[8])
  5455. * This function construct full buffer for #UBXAID_ALM_OPT message.
  5456. * \brief Getter for #UBXAID_ALM_OPT
  5457. * \param svid
  5458. * SV ID for which the receiver shall return its
  5459. * Almanac Data (Valid Range: 1 .. 32 or 51, 56,
  5460. * 63).
  5461. * \param week
  5462. * Issue Date of Almanac (GPS week number)
  5463. * \param dwrd
  5464. * Almanac Words
  5465. * \return
  5466. * Returns full UBXMsgBuffer including header and checksum
  5467. */
  5468. /*!
  5469. * \fn struct UBXMsgBuffer getAID_ALP_POLL(UBXU4_t predTow,
  5470. UBXU4_t predDur,
  5471. UBXI4_t age,
  5472. UBXU2_t predWno,
  5473. UBXU2_t almWno,
  5474. UBXU1_t svs)
  5475. * This function construct full buffer for #UBXAID_ALP_POLL message.
  5476. * \brief Getter for #UBXAID_ALP_POLL
  5477. * \param predTow
  5478. * Prediction start time of week
  5479. * \param predDur
  5480. * Prediction duration from start of first data set to
  5481. * end of last data set
  5482. * \param age
  5483. * Current age of ALP data
  5484. * \param predWno
  5485. * Prediction start week number
  5486. * \param almWno
  5487. * Truncated week number of reference almanac
  5488. * \param svs
  5489. * Number of satellite data sets contained in the
  5490. * ALP UBXAID_ALP_POLL::data
  5491. * \return
  5492. * Returns full UBXMsgBuffer including header and checksum
  5493. */
  5494. /*!
  5495. * \fn getAID_ALP_END
  5496. * This function construct full buffer for #UBXAID_ALP_END message.
  5497. * \brief Getter for #UBXAID_ALP_END
  5498. * \return
  5499. * Returns full UBXMsgBuffer including header and checksum
  5500. */
  5501. /*!
  5502. * \fn struct UBXMsgBuffer getAID_ALP(UBXU2_t* chunk, int chunkSize)
  5503. * This function construct full buffer for #UBXAID_ALP message.
  5504. * \brief Getter for #UBXAID_ALP
  5505. * \param chunk
  5506. * ALP data chunk
  5507. * \param chunkSize
  5508. * size of chunk
  5509. * \return
  5510. * Returns full UBXMsgBuffer including header and checksum
  5511. */
  5512. /*!
  5513. * \fn getAID_AOP_POLL
  5514. * This function construct full buffer for #UBXAID_AOP_POLL message.
  5515. * \brief Getter for #UBXAID_AOP_POLL
  5516. * \return
  5517. * Returns full UBXMsgBuffer including header and checksum
  5518. */
  5519. /*!
  5520. * \fn struct UBXMsgBuffer getAID_AOP_POLL_OPT(UBXU1_t svid)
  5521. * This function construct full buffer for #UBXAID_AOP_POLL_OPT message.
  5522. * \brief Getter for #UBXAID_AOP_POLL_OPT
  5523. * \param svid
  5524. * GPS SV id for which the data is requested (valid range: 1..32).
  5525. * \return
  5526. * Returns full UBXMsgBuffer including header and checksum
  5527. */
  5528. /*!
  5529. * \fn struct UBXMsgBuffer getAID_AOP(UBXU1_t svid, UBXU1_t data[59])
  5530. * This function construct full buffer for #UBXAID_AOP message.
  5531. * \brief Getter for #UBXAID_AOP
  5532. * \param svid
  5533. * GPS SV id
  5534. * \param data
  5535. * AssistNow Autonomous data
  5536. * \return
  5537. * Returns full UBXMsgBuffer including header and checksum
  5538. */
  5539. /*!
  5540. * \fn struct UBXMsgBuffer getAID_AOP_OPT(UBXU1_t svid, UBXU1_t data[59], UBXU1_t optional0[48], UBXU1_t optional1[48], UBXU1_t optional2[48])
  5541. * This function construct full buffer for #UBXAID_AOP_OPT message.
  5542. * \brief Getter for #UBXAID_AOP_OPT
  5543. * \param svid
  5544. * GPS SV id
  5545. * \param data
  5546. * AssistNow Autonomous data
  5547. * \param optional0
  5548. * Optional data chunk 1/3
  5549. * \param optional1
  5550. * Optional data chunk 2/3
  5551. * \param optional2
  5552. * Optional data chunk 3/3
  5553. * \return
  5554. * Returns full UBXMsgBuffer including header and checksum
  5555. */
  5556. /*!
  5557. * \fn getAID_DATA_POLL
  5558. * This function construct full buffer for #UBXAID_DATA_POLL message.
  5559. * \brief Getter for #UBXAID_DATA_POLL
  5560. * \return
  5561. * Returns full UBXMsgBuffer including header and checksum
  5562. */
  5563. /*!
  5564. * \fn getAID_EPH_POLL
  5565. * This function construct full buffer for #UBXAID_EPH_POLL message.
  5566. * \brief Getter for #UBXAID_EPH_POLL
  5567. * \return
  5568. * Returns full UBXMsgBuffer including header and checksum
  5569. */
  5570. /*!
  5571. * \fn struct UBXMsgBuffer getAID_EPH_POLL_OPT(UBXU1_t svid)
  5572. * This function construct full buffer for #UBXAID_EPH_POLL_OPT message.
  5573. * \brief Getter for #UBXAID_EPH_POLL_OPT
  5574. * \param svid
  5575. * SV ID for which the receiver shall return its
  5576. * Ephemeris Data (Valid Range: 1 .. 32).
  5577. * \return
  5578. * Returns full UBXMsgBuffer including header and checksum
  5579. */
  5580. /*!
  5581. * \fn struct UBXMsgBuffer getAID_EPH(UBXU4_t svid, UBXU4_t how)
  5582. * This function construct full buffer for #UBXAID_EPH message.
  5583. * \brief Getter for #UBXAID_EPH
  5584. * \param svid
  5585. * SV ID for which this ephemeris data is
  5586. * \note Range: 1..32
  5587. * \param how
  5588. * Hand-Over Word of first Subframe. This is
  5589. * required if data is sent to the receiver.
  5590. * 0 indicates that no Ephemeris Data is following.
  5591. * \return
  5592. * Returns full UBXMsgBuffer including header and checksum
  5593. */
  5594. /*!
  5595. * \fn struct UBXMsgBuffer getAID_EPH_OPT(UBXU4_t svid, UBXU4_t how, UBXU4_t sf1d[8], UBXU4_t sf2d[8], UBXU4_t sf3d[8])
  5596. * This function construct full buffer for #UBXAID_EPH_OPT message.
  5597. * \brief Getter for #UBXAID_EPH_OPT
  5598. * \param svid
  5599. * SV ID for which this ephemeris data is
  5600. * \note Range: 1..32
  5601. * \param how
  5602. * Hand-Over Word of first Subframe. This is
  5603. * required if data is sent to the receiver.
  5604. * 0 indicates that no Ephemeris Data is following.
  5605. * \param sf1d
  5606. * Subframe 1 Words 3..10 (SF1D0..SF1D7)
  5607. * \param sf2d
  5608. * Subframe 2 Words 3..10 (SF1D0..SF1D7)
  5609. * \param sf3d
  5610. * Subframe 3 Words 3..10 (SF1D0..SF1D7)
  5611. * \return
  5612. * Returns full UBXMsgBuffer including header and checksum
  5613. */
  5614. /*!
  5615. * \fn getAID_HUI_POLL
  5616. * This function construct full buffer for #UBXAID_HUI_POLL message.
  5617. * \brief Getter for #UBXAID_HUI_POLL
  5618. * \return
  5619. * Returns full UBXMsgBuffer including header and checksum
  5620. */
  5621. /*!
  5622. * \fn struct UBXMsgBuffer getAID_HUI(UBXI4_t health, UBXR4_t utcA0, UBXR4_t utcA1,
  5623. UBXI4_t utcTOW, UBXI2_t utcWNT, UBXI2_t utcLS,
  5624. UBXI2_t utcWNF, UBXI2_t utcDN, UBXI2_t utcLSF,
  5625. UBXI2_t utcSpare, UBXR4_t klobA0, UBXR4_t klobA1,
  5626. UBXR4_t klobA2, UBXR4_t klobA3, UBXR4_t klobB0,
  5627. UBXR4_t klobB1, UBXR4_t klobB2, UBXR4_t klobB3,
  5628. UBXX2_t flags)
  5629. * This function construct full buffer for #UBXAID_HUI message.
  5630. * \brief Getter for #UBXAID_HUI
  5631. * \param health
  5632. * Bitmask, every bit represenst a GPS SV (1-32). If
  5633. * the bit is set the SV is healthy.
  5634. * \param utcA0
  5635. * UTC - parameter A0
  5636. * \param utcA1
  5637. * UTC - parameter A1
  5638. * \param utcTOW
  5639. * UTC - reference time of week
  5640. * \param utcWNT
  5641. * UTC - reference week number
  5642. * \param utcLS
  5643. * UTC - time difference due to leap seconds before event
  5644. * \param utcWNF
  5645. * UTC - week number when next leap second event occurs
  5646. * \param utcDN
  5647. * UTC - day of week when next leap second event occurs
  5648. * \param utcLSF
  5649. * UTC - time difference due to leap seconds after event
  5650. * \param utcSpare
  5651. * UTC - Spare to ensure structure is a multiple of 4 bytes
  5652. * \param klobA0
  5653. * Klobuchar - alpha 0
  5654. * \param klobA1
  5655. * Klobuchar - alpha 1
  5656. * \param klobA2
  5657. * Klobuchar - alpha 2
  5658. * \param klobA3
  5659. * Klobuchar - alpha 3
  5660. * \param klobB0
  5661. * Klobuchar - beta 0
  5662. * \param klobB1
  5663. * Klobuchar - beta 1
  5664. * \param klobB2
  5665. * Klobuchar - beta 2
  5666. * \param klobB3
  5667. * Klobuchar - beta 3
  5668. * \param flags
  5669. * Flags.
  5670. * \see #UBXHUIFlags to fill this field
  5671. * \return
  5672. * Returns full UBXMsgBuffer including header and checksum
  5673. */
  5674. /*!
  5675. * \fn getAID_INI_POLL
  5676. * This function construct full buffer for #UBXAID_INI_POLL message.
  5677. * \brief Getter for #UBXAID_INI_POLL
  5678. * \return
  5679. * Returns full UBXMsgBuffer including header and checksum
  5680. */
  5681. /*!
  5682. * \fn struct UBXMsgBuffer getAID_INI(UBXI1_t ecefXOrLat,
  5683. UBXI1_t ecefYOrLat,
  5684. UBXI1_t ecefZOrLat,
  5685. UBXU1_t posAcc,
  5686. UBXI1_t tmCfg,
  5687. UBXU2_t wnoOrDate,
  5688. UBXU4_t towOrDate,
  5689. UBXI4_t towNs,
  5690. UBXU4_t tAccMS,
  5691. UBXU4_t tAccNS,
  5692. UBXI4_t clkDOrFreq,
  5693. UBXU4_t clkDAccOrFreqAcc,
  5694. UBXX4_t flags)
  5695. * This function construct full buffer for #UBXAID_INI message.
  5696. * \brief Getter for #UBXAID_INI
  5697. * \param ecefXOrLat
  5698. * WGS84 ECEF X coordinate or latitude
  5699. * \param ecefYOrLat
  5700. * WGS84 ECEF Y coordinate or latitude
  5701. * \param ecefZOrLat
  5702. * WGS84 ECEF Z coordinate or latitude
  5703. * \param posAcc
  5704. * Position accuracy
  5705. * \param tmCfg
  5706. * Time mark configuration
  5707. * \see #UBXINItmCfg to fill this field
  5708. * \param wnoOrDate
  5709. * Actual week number or yearSince2000/Month (YYMM), depending on UBXAID_INI::flags
  5710. * \param towOrDate
  5711. * Actual time of week or
  5712. * DayOfMonth/Hour/Minute/Second
  5713. * (DDHHMMSS), depending on UBXAID_INI::flags
  5714. * \param towNs
  5715. * Fractional part of time of week
  5716. * \param tAccMS
  5717. * Milliseconds part of time accuracy
  5718. * \param tAccNS
  5719. * Nanoseconds part of time accuracy
  5720. * \param clkDOrFreq
  5721. * Clock drift or frequency, depending on UBXAID_INI::flags
  5722. * \param clkDAccOrFreqAcc
  5723. * Accuracy of clock drift or frequency, depending on UBXAID_INI::flags
  5724. * \param flags
  5725. * Bitmask with the flags
  5726. * \return
  5727. * Returns full UBXMsgBuffer including header and checksum
  5728. */
  5729. /*!
  5730. * \fn struct UBXMsgBuffer getCFG_ANT(UBXX2_t flags, struct UBXANTPins pins)
  5731. * This function construct full buffer for #UBXCFG_ANT message.
  5732. * \brief Getter for #UBXCFG_ANT
  5733. * \param flags
  5734. * Antenna flag mask
  5735. * \see #UBXANTFlags to fill this field
  5736. * \param pins
  5737. * Antenna Pin Configuration
  5738. * \return
  5739. * Returns full UBXMsgBuffer including header and checksum
  5740. */
  5741. /*!
  5742. * \fn getCFG_ANT_POLL
  5743. * This function construct full buffer for #UBXCFG_ANT_POLL message.
  5744. * \brief Getter for #UBXCFG_ANT_POLL
  5745. * \return
  5746. * Returns full UBXMsgBuffer including header and checksum
  5747. */
  5748. /*!
  5749. * \fn struct UBXMsgBuffer getCFG_CFG(UBXX4_t clearMask, UBXX4_t saveMask, UBXX4_t loadMask)
  5750. * This function construct full buffer for #UBXCFG_CFG message.
  5751. * \brief Getter for #UBXCFG_CFG
  5752. * \param clearMask
  5753. * Mask with configuration sub-sections to Clear
  5754. * \note Load Default Configurations to Permanent
  5755. * Configurations in non-volatile memory
  5756. * \see #UBXCFGMask to fill this field
  5757. * \param saveMask
  5758. * Mask with configuration sub-section to Save
  5759. * \note Save Current Configuration to Non-volatile
  5760. * Memory
  5761. * \see #UBXCFGMask to fill this field
  5762. * \param loadMask
  5763. * Mask with configuration sub-sections to Load
  5764. * \note Load Permanent Configurations from
  5765. * Non-volatile Memory to Current
  5766. * Configurations
  5767. * \see #UBXCFGMask to fill this field
  5768. * \return
  5769. * Returns full UBXMsgBuffer including header and checksum
  5770. */
  5771. /*!
  5772. * \fn struct UBXMsgBuffer getCFG_CFG_OPT(UBXX4_t clearMask, UBXX4_t saveMask, UBXX4_t loadMask, UBXX1_t deviceMask)
  5773. * This function construct full buffer for #UBXCFG_CFG_OPT message.
  5774. * \brief Getter for #UBXCFG_CFG_OPT
  5775. * \param clearMask
  5776. * Mask with configuration sub-sections to Clear
  5777. * \note Load Default Configurations to Permanent
  5778. * Configurations in non-volatile memory
  5779. * \see #UBXCFGMask to fill this field
  5780. * \param saveMask
  5781. * Mask with configuration sub-section to Save
  5782. * \note Save Current Configuration to Non-volatile
  5783. * Memory
  5784. * \see #UBXCFGMask to fill this field
  5785. * \param loadMask
  5786. * Mask with configuration sub-sections to Load
  5787. * \note Load Permanent Configurations from
  5788. * Non-volatile Memory to Current
  5789. * Configurations
  5790. * \see #UBXCFGMask to fill this field
  5791. * \param deviceMask
  5792. * Mask which selects the devices for this
  5793. * command
  5794. * \see #UBXCFGDeviceMask to fill this field
  5795. * \return
  5796. * Returns full UBXMsgBuffer including header and checksum
  5797. */
  5798. /*!
  5799. * \fn struct UBXMsgBuffer getCFG_DAT_IN(UBXR8_t majA, UBXR8_t flat, UBXR4_t dX, UBXR4_t dY, UBXR4_t dZ, UBXR4_t rotX, UBXR4_t rotY, UBXR4_t rotZ, UBXR4_t scale)
  5800. * This function construct full buffer for #UBXCFG_DAT_IN message.
  5801. * \brief Getter for #UBXCFG_DAT_IN
  5802. * \param majA
  5803. * Semi-major Axis
  5804. * \note accepted range = 6,300,000.0 to 6,500,000.0 metres
  5805. * \param flat
  5806. * 1.0 / Flattening
  5807. * \note accepted range is 0.0 to 500.0
  5808. * \param dX
  5809. * X Axis shift at the origin
  5810. * \note accepted range is +/-5000.0 metres
  5811. * \param dY
  5812. * Y Axis shift at the origin
  5813. * \note accepted range is +/-5000.0 metres
  5814. * \param dZ
  5815. * Z Axis shift at the origin
  5816. * \note accepted range is +/-5000.0 metres
  5817. * \param rotX
  5818. * Rotation about the X Axis
  5819. * \note accepted range is +/-20.0 milli-arc seconds
  5820. * \param rotY
  5821. * Rotation about the Y Axis
  5822. * \note accepted range is +/-20.0 milli-arc seconds
  5823. * \param rotZ
  5824. * Rotation about the Z Axis
  5825. * \note accepted range is +/-20.0 milli-arc seconds
  5826. * \param scale
  5827. * Scale change
  5828. * \note accepted range is 0.0 to 50.0 parts per million
  5829. * \return
  5830. * Returns full UBXMsgBuffer including header and checksum
  5831. */
  5832. /*!
  5833. * \fn getCFG_DAT_POLL
  5834. * This function construct full buffer for #UBXCFG_DAT_POLL message.
  5835. * \brief Getter for #UBXCFG_DAT_POLL
  5836. * \return
  5837. * Returns full UBXMsgBuffer including header and checksum
  5838. */
  5839. /*!
  5840. * \fn getCFG_GNSS_POLL
  5841. * This function construct full buffer for #UBXCFG_GNSS_POLL message.
  5842. * \brief Getter for #UBXCFG_GNSS_POLL
  5843. * \return
  5844. * Returns full UBXMsgBuffer including header and checksum
  5845. */
  5846. /*!
  5847. * \fn struct UBXMsgBuffer getCFG_GNSS(UBXU1_t msgVer,
  5848. UBXU1_t numTrkChHw,
  5849. UBXU1_t numTrkChUse,
  5850. UBXU1_t numConfigBlocks,
  5851. struct UBXCFG_GNSS_PART* gnssPart,
  5852. int gnssPartCount)
  5853. * This function construct full buffer for #UBXCFG_GNSS message.
  5854. * \brief Getter for #UBXCFG_GNSS
  5855. * \param msgVer
  5856. * Message version
  5857. * \param numTrkChHw
  5858. * Number of tracking channels available in
  5859. * hardware
  5860. * \note Read only
  5861. * \param numTrkChUse
  5862. * Number of tracking channels to use
  5863. * \note Should be <= UBXCFG_GNSS::numTrkChHw
  5864. * \param numConfigBlocks
  5865. * Number of configuration blocks following
  5866. * \param gnssPart
  5867. * Variable payload part
  5868. * \param gnssPartCount
  5869. * Variable payload count
  5870. * \return
  5871. * Returns full UBXMsgBuffer including header and checksum
  5872. */
  5873. /*!
  5874. * \fn struct UBXMsgBuffer getCFG_INF_POLL(UBXU1_t protocolId)
  5875. * This function construct full buffer for #UBXCFG_INF_POLL message.
  5876. * \brief Getter for #UBXCFG_INF_POLL
  5877. * \param protocolId
  5878. * Protocol Identifier, identifying the output
  5879. * protocol for this Poll Request.
  5880. * \see #UBXCFGProtocolIds to fill this field
  5881. * \return
  5882. * Returns full UBXMsgBuffer including header and checksum
  5883. */
  5884. /*!
  5885. * \fn struct UBXMsgBuffer getCFG_INF(struct UBXCFG_INF_PART* infPart, int infPartCount)
  5886. * This function construct full buffer for #UBXCFG_INF message.
  5887. * \brief Getter for #UBXCFG_INF
  5888. * \param infPart
  5889. * Variable payload
  5890. * \param infPartCount
  5891. * Variable payload count
  5892. * \return
  5893. * Returns full UBXMsgBuffer including header and checksum
  5894. */
  5895. /*!
  5896. * \fn getCFG_ITFM_POLL
  5897. * This function construct full buffer for #UBXCFG_ITFM_POLL message.
  5898. * \brief Getter for #UBXCFG_ITFM_POLL
  5899. * \return
  5900. * Returns full UBXMsgBuffer including header and checksum
  5901. */
  5902. /*!
  5903. * \fn struct UBXMsgBuffer getCFG_ITFM(struct UBXITFMConfig config,
  5904. struct UBXITFMConfig2 config2)
  5905. * This function construct full buffer for #UBXCFG_ITFM message.
  5906. * \brief Getter for #UBXCFG_ITFM
  5907. * \param config
  5908. * Interference config word
  5909. * \see #UBXITFMConfig to fill this field
  5910. * \param config2
  5911. * Extra settings for jamming/interference monitor
  5912. * \see #UBXITFMConfig2 to fill this field
  5913. * \return
  5914. * Returns full UBXMsgBuffer including header and checksum
  5915. */
  5916. /*!
  5917. * \fn getCFG_LOGFILTER_POLL
  5918. * This function construct full buffer for #UBXCFG_LOGFILTER_POLL message.
  5919. * \brief Getter for #UBXCFG_LOGFILTER_POLL
  5920. * \return
  5921. * Returns full UBXMsgBuffer including header and checksum
  5922. */
  5923. /*!
  5924. * \fn struct UBXMsgBuffer getCFG_LOGFILTER(UBXU1_t version,
  5925. UBXX1_t flags,
  5926. UBXU2_t minIterval,
  5927. UBXU2_t timeThreshold,
  5928. UBXU2_t speedThreshold,
  5929. UBXU4_t positionThreshold)
  5930. * This function construct full buffer for #UBXCFG_LOGFILTER message.
  5931. * \brief Getter for #UBXCFG_LOGFILTER
  5932. * \param version
  5933. * The version of this message
  5934. * \note Set to 1
  5935. * \param flags
  5936. * Flags
  5937. * \see #UBXLOGFILTERFlags to fill this field
  5938. * \param minIterval
  5939. * Minimum time interval between logged
  5940. * positions
  5941. * \note This is only applied in
  5942. * combination with the speed and/or
  5943. * position thresholds
  5944. * \note 0 - not set
  5945. * \param timeThreshold
  5946. * If the time difference is greater than the
  5947. * threshold then the position is logged
  5948. * \note 0 - not set
  5949. * \param speedThreshold
  5950. * If the current speed is greater than the
  5951. * threshold then the position is logged
  5952. * \note 0 - not set
  5953. * \note UBXCFG_LOGFILTER::minInterval also applies
  5954. * \param positionThreshold
  5955. * If the 3D position difference is greater than the
  5956. * threshold then the position is logged
  5957. * \note 0 - not set
  5958. * \note minInterval also applies
  5959. * \return
  5960. * Returns full UBXMsgBuffer including header and checksum
  5961. */
  5962. /*!
  5963. * \fn getCFG_NAV5_POLL
  5964. * This function construct full buffer for #UBXCFG_NAV5_POLL message.
  5965. * \brief Getter for #UBXCFG_NAV5_POLL
  5966. * \return
  5967. * Returns full UBXMsgBuffer including header and checksum
  5968. */
  5969. /*!
  5970. * \fn struct UBXMsgBuffer getCFG_NAV5(UBXX2_t mask,
  5971. enum UBXNAV5Model dynModel,
  5972. enum UBXNAV5FixMode fixMode,
  5973. UBXI4_t fixedAlt,
  5974. UBXU4_t fixedAltVar,
  5975. UBXI1_t minElev,
  5976. UBXU2_t pDop,
  5977. UBXU2_t tDop,
  5978. UBXU2_t pAcc,
  5979. UBXU2_t tAcc,
  5980. UBXU1_t staticHoldThresh,
  5981. UBXU1_t dgpsTimeOut,
  5982. UBXU1_t cnoThreshNumSVs,
  5983. UBXU1_t cnoThresh)
  5984. * This function construct full buffer for #UBXCFG_NAV5 message.
  5985. * \brief Getter for #UBXCFG_NAV5
  5986. * \param mask
  5987. * Parameters Bitmask. Only the masked parameters will be applied.
  5988. * \see #UBXNAV5Mask to fill this field
  5989. * \param dynModel
  5990. * Dynamic Platform model
  5991. * \see #UBXNAV5Model to fill this field
  5992. * \param fixMode
  5993. * Position Fixing Mode
  5994. * \see #UBXNAV5FixMode to fill this field
  5995. * \param fixedAlt
  5996. * Fixed altitude (mean sea level) for 2D fix mode
  5997. * \param fixedAltVar
  5998. * Fixed altitude variance for 2D mode
  5999. * \param minElev
  6000. * Minimum Elevation for a GNSS satellite to be
  6001. * used in NAV
  6002. * \param pDop
  6003. * Position DOP Mask to use
  6004. * \param tDop
  6005. * Time DOP Mask to use
  6006. * \param pAcc
  6007. * Position Accuracy Mask
  6008. * \param tAcc
  6009. * Time Accuracy Mask
  6010. * \param staticHoldThresh
  6011. * Static hold threshold
  6012. * \param dgpsTimeOut
  6013. * DGPS timeout
  6014. * \param cnoThreshNumSVs
  6015. * Number of satellites required to have C/N0
  6016. * above cnoThresh for a fix to be attempted
  6017. * \param cnoThresh
  6018. * C/N0 threshold for deciding whether to attempt
  6019. * a fix
  6020. * \return
  6021. * Returns full UBXMsgBuffer including header and checksum
  6022. */
  6023. /*!
  6024. * \fn getCFG_NAVX5_POLL
  6025. * This function construct full buffer for #UBXCFG_NAVX5_POLL message.
  6026. * \brief Getter for #UBXCFG_NAVX5_POLL
  6027. * \return
  6028. * Returns full UBXMsgBuffer including header and checksum
  6029. */
  6030. /*!
  6031. * \fn struct UBXMsgBuffer getCFG_NAVX5(UBXU2_t version,
  6032. UBXX2_t mask1,
  6033. UBXU1_t minSVs,
  6034. UBXU1_t maxSVs,
  6035. UBXU1_t minCNO,
  6036. UBXU1_t iniFix3D,
  6037. UBXU2_t wknRollover,
  6038. UBXU1_t usePPP,
  6039. UBXU1_t aopCFG,
  6040. UBXU1_t aopOrbMaxErr)
  6041. * This function construct full buffer for #UBXCFG_NAVX5 message.
  6042. * \brief Getter for #UBXCFG_NAVX5
  6043. * \param version
  6044. * Message version
  6045. * \note 0 for this version
  6046. * \param mask1
  6047. * First Parameters Bitmask. Only the flagged
  6048. * parameters will be applied, unused bits must be
  6049. * set to 0
  6050. * \see #UBXNAVX5Mask to fill this field
  6051. * \param minSVs
  6052. * Minimum number of satellites for navigation
  6053. * \param maxSVs
  6054. * Maximum number of satellites for navigation
  6055. * \param minCNO
  6056. * Minimum satellite signal level for navigation
  6057. * \param iniFix3D
  6058. * Initial Fix must be 3D flag
  6059. * \note
  6060. * - 0 - false
  6061. * - 1 - true
  6062. * \param wknRollover
  6063. * GPS week rollover number; GPS week numbers
  6064. * will be set correctly from this week up to 1024
  6065. * weeks after this week.
  6066. * \note 0 reverts to firmware default.
  6067. * \param usePPP
  6068. * Use Precise Point Positioning flag
  6069. * \note Only supported on certain product variants
  6070. * \note
  6071. * - 0 - false
  6072. * - 1 - true
  6073. * \param aopCFG
  6074. * AssistNow Autonomous configuration
  6075. * /note
  6076. * - 0 - disabled
  6077. * - 1 - enabled
  6078. * \param aopOrbMaxErr
  6079. * maximum acceptable (modelled) AssistNow
  6080. * Autonomous orbit error
  6081. * \note valid range = 5..1000,
  6082. * \note 0 - reset to firmware default
  6083. * \return
  6084. * Returns full UBXMsgBuffer including header and checksum
  6085. */
  6086. /*!
  6087. * \fn getCFG_NMEA_POLL
  6088. * This function construct full buffer for #UBXCFG_NMEA_POLL message.
  6089. * \brief Getter for #UBXCFG_NMEA_POLL
  6090. * \return
  6091. * Returns full UBXMsgBuffer including header and checksum
  6092. */
  6093. /*!
  6094. * \fn struct UBXMsgBuffer getCFG_NMEA(UBXX1_t filter,
  6095. UBXU1_t nmeaVersion,
  6096. UBXU1_t numSV,
  6097. UBXX1_t flags,
  6098. UBXX4_t gnssToFilter,
  6099. enum UBXNMEASVNumbering svNumbering,
  6100. enum UBXNMEATalkerIds mainTalkerId,
  6101. enum UBXNMEAGSVTalkerIds gsvTalkerId)
  6102. * This function construct full buffer for #UBXCFG_NMEA message.
  6103. * \brief Getter for #UBXCFG_NMEA
  6104. * \param filter
  6105. * Filter flags
  6106. * \see #UBXNMEAFilter to fill this field
  6107. * \param nmeaVersion
  6108. * NMEA version
  6109. * \see #UBXNMEAVersion to fill this field
  6110. * \param numSV
  6111. * Maximum Number of SVs to report in NMEA
  6112. * protocol.\n
  6113. * This does not affect the receiver's operation.
  6114. * It only limits the number of SVs reported in
  6115. * NMEA mode (this might be needed with older
  6116. * mapping applications which only support 8- or
  6117. * 12-channel receivers).
  6118. * \param flags
  6119. * Flags
  6120. * \see #UBXNMEAFlags to fill this field
  6121. * \param gnssToFilter
  6122. * Filters out satellites based on their GNSS. If a
  6123. * bitfield is enabled, the corresponding satellites
  6124. * will be not output.
  6125. * \see #UBXNMEAGNSSToFilter to fill this field
  6126. * \param svNumbering
  6127. * Configures the display of satellites that do not
  6128. * have an NMEA-defined value.
  6129. * \note This does not apply to satellites with an
  6130. * unknown ID.
  6131. * \param mainTalkerId
  6132. * By default the main Talker ID (i.e. the Talker ID
  6133. * used for all messages other than GSV) is
  6134. * determined by the GNSS assignment of the
  6135. * receiver's channels (see #UBXCFG_GNSS).
  6136. * This field enables the main Talker ID to be
  6137. * overridden.
  6138. * \param gsvTalkerId
  6139. * By default the Talker ID for GSV messages is
  6140. * GNSS specific (as defined by NMEA).
  6141. * This field enables the GSV Talker ID to be
  6142. * overridden.
  6143. * \return
  6144. * Returns full UBXMsgBuffer including header and checksum
  6145. */
  6146. /*!
  6147. * \fn struct UBXMsgBuffer getCFG_NVS(UBXX4_t clearMask,
  6148. UBXX4_t saveMask,
  6149. UBXX4_t loadMask,
  6150. UBXX1_t deviceMask)
  6151. * This function construct full buffer for #UBXCFG_NVS message.
  6152. * \brief Getter for #UBXCFG_NVS
  6153. * \param clearMask
  6154. * Mask of data to be cleared
  6155. * \see #UBXCFGMask CFG_NVS section to fill this field
  6156. * \param saveMask
  6157. * Mask of data to be saved
  6158. * \see #UBXCFGMask CFG_NVS section to fill this field
  6159. * \param loadMask
  6160. * Mask of data to be loaded,
  6161. * \see #UBXCFGMask CFG_NVS section to fill this field
  6162. * \param deviceMask
  6163. * Mask of devices to consider
  6164. * \note Default: all devices
  6165. * \see #UBXCFGDeviceMask to fill this field
  6166. * \return
  6167. * Returns full UBXMsgBuffer including header and checksum
  6168. */
  6169. /*!
  6170. * \fn getCFG_PM2_POLL
  6171. * This function construct full buffer for #UBXCFG_PM2_POLL message.
  6172. * \brief Getter for #UBXCFG_PM2_POLL
  6173. * \return
  6174. * Returns full UBXMsgBuffer including header and checksum
  6175. */
  6176. /*!
  6177. * \fn struct UBXMsgBuffer getCFG_PM2(struct UBXCFG_PM2Flags flags, UBXU4_t updatePeriod, UBXU4_t searchPeriod, UBXU4_t gridOffset, UBXU2_t onTime, UBXU2_t minAcqTime)
  6178. * This function construct full buffer for #UBXCFG_PM2 message.
  6179. * \brief Getter for #UBXCFG_PM2
  6180. * \param flags
  6181. * PSM configuration flags
  6182. * \note See UBXCFG_PM2Flags to fill this field
  6183. * \param updatePeriod
  6184. * Position update period.
  6185. * \note If set to 0, the receiver will never retry a fix
  6186. * \param searchPeriod
  6187. * Acquisition retry period
  6188. * \note If set to 0, the receiver will never retry a startup
  6189. * \param gridOffset
  6190. * Grid offset relative to GPS start of week
  6191. * \param onTime
  6192. * On time after first successful fix
  6193. * \param minAcqTime
  6194. * Minimal search time
  6195. * \return
  6196. * Returns full UBXMsgBuffer including header and checksum
  6197. */
  6198. /*!
  6199. * \fn getCFG_PRT_POLL
  6200. * This function construct full buffer for #UBXCFG_PRT_POLL message.
  6201. * \brief Getter for #UBXCFG_PRT_POLL
  6202. * \return
  6203. * Returns full UBXMsgBuffer including header and checksum
  6204. */
  6205. /*!
  6206. * \fn struct UBXMsgBuffer getCFG_PRT_POLL_OPT(UBXU1_t portId)
  6207. * This function construct full buffer for #UBXCFG_PRT_POLL_OPT message.
  6208. * \brief Getter for #UBXCFG_PRT_POLL_OPT
  6209. * \param portId
  6210. * Port Identifier Number
  6211. * \see #UBXCFG_PRT for valid values
  6212. * \return
  6213. * Returns full UBXMsgBuffer including header and checksum
  6214. */
  6215. /*!
  6216. * \fn getCFG_PRT_UART
  6217. * This function construct full buffer for #UBXCFG_PRT_UART message.
  6218. * \brief Getter for #UBXCFG_PRT_UART
  6219. * \todo Getter is not complete
  6220. * \return
  6221. * Returns full UBXMsgBuffer including header and checksum
  6222. */
  6223. /*!
  6224. * \fn getCFG_PRT_USB
  6225. * This function construct full buffer for #UBXCFG_PRT_USB message.
  6226. * \brief Getter for #UBXCFG_PRT_USB
  6227. * \todo Getter is not complete
  6228. * \return
  6229. * Returns full UBXMsgBuffer including header and checksum
  6230. */
  6231. /*!
  6232. * \fn getCFG_PRT_SPI
  6233. * This function construct full buffer for #UBXCFG_PRT_SPI message.
  6234. * \brief Getter for #UBXCFG_PRT_SPI
  6235. * \todo Getter is not complete
  6236. * \return
  6237. * Returns full UBXMsgBuffer including header and checksum
  6238. */
  6239. /*!
  6240. * \fn getCFG_PRT_DDC
  6241. * This function construct full buffer for #UBXCFG_PRT_DDC message.
  6242. * \brief Getter for #UBXCFG_PRT_DDC
  6243. * \todo Getter is not complete
  6244. * \return
  6245. * Returns full UBXMsgBuffer including header and checksum
  6246. */
  6247. /*!
  6248. * \fn getCFG_RATE_POLL
  6249. * This function construct full buffer for #UBXCFG_RATE_POLL message.
  6250. * \brief Getter for #UBXCFG_RATE_POLL
  6251. * \return
  6252. * Returns full UBXMsgBuffer including header and checksum
  6253. */
  6254. /*!
  6255. * \fn struct UBXMsgBuffer getCFG_RATE(UBXU2_t measRate, UBXU2_t navRate, UBXU2_t timeRef)
  6256. * This function construct full buffer for #UBXCFG_RATE message.
  6257. * \brief Getter for #UBXCFG_RATE
  6258. * \param measRate
  6259. * Measurement Rate, GPS measurements are
  6260. * taken every measRate milliseconds
  6261. * \param navRate
  6262. * Navigation Rate, in number of measurement
  6263. * cycles.
  6264. * \note This parameter cannot be changed, and
  6265. * must be set to 1.
  6266. * \param timeRef
  6267. * Alignment to reference time.
  6268. * \note
  6269. * - 0 - UTC time
  6270. * - 1 - GPS time
  6271. * \return
  6272. * Returns full UBXMsgBuffer including header and checksum
  6273. */
  6274. /*!
  6275. * \fn struct UBXMsgBuffer getCFG_RINV(UBXX1_t flags, UBXU1_t* data, int dataSize)
  6276. * This function construct full buffer for #UBXCFG_RINV message.
  6277. * \brief Getter for #UBXCFG_RINV
  6278. * \param flags
  6279. * Flags
  6280. * \see #UBXRINVFlags to fill this field
  6281. * \param data
  6282. * Pointer to variable payload data
  6283. * \param dataSize
  6284. * Data size
  6285. * \return
  6286. * Returns full UBXMsgBuffer including header and checksum
  6287. */
  6288. /*!
  6289. * \fn getCFG_RINV_POLL
  6290. * This function construct full buffer for #UBXCFG_RINV_POLL message.
  6291. * \brief Getter for #UBXCFG_RINV_POLL
  6292. * \return
  6293. * Returns full UBXMsgBuffer including header and checksum
  6294. */
  6295. /*!
  6296. * \fn struct UBXMsgBuffer getCFG_RXM(UBXU1_t lpMode)
  6297. * This function construct full buffer for #UBXCFG_RXM message.
  6298. * \brief Getter for #UBXCFG_RXM
  6299. * \param lpMode
  6300. * Low power mode
  6301. * \see #UBXRXMLowPowerModes to fill this field
  6302. * \return
  6303. * Returns full UBXMsgBuffer including header and checksum
  6304. */
  6305. /*!
  6306. * \fn getCFG_RXM_POLL
  6307. * This function construct full buffer for #UBXCFG_RXM_POLL message.
  6308. * \brief Getter for #UBXCFG_RXM_POLL
  6309. * \return
  6310. * Returns full UBXMsgBuffer including header and checksum
  6311. */
  6312. /*!
  6313. * \fn struct UBXMsgBuffer getCFG_SBAS(UBXX1_t mode, UBXX1_t usage, UBXU1_t maxSBAS, UBXX1_t scanmode2, UBXX4_t scanmode1)
  6314. * This function construct full buffer for #UBXCFG_SBAS message.
  6315. * \brief Getter for #UBXCFG_SBAS
  6316. * \param mode
  6317. * SBAS Mode
  6318. * \see #UBXSBASModes to fill this field
  6319. * \param usage
  6320. * SBAS Usage
  6321. * \see #UBXSBASUsage to fill this field
  6322. * \param maxSBAS
  6323. * Maximum Number of SBAS prioritized tracking
  6324. * channels to use
  6325. * \note valid range: 0 - 3
  6326. * \deprecated obsolete and superseeded by #UBXCFG_GNSS in protocol
  6327. * versions 14.00+.
  6328. * \param scanmode2
  6329. * Continuation of scanmode bitmask below
  6330. * \see #UBXSBASScanModes2 to fill this field
  6331. * \param scanmode1
  6332. * Which SBAS PRN numbers to search for (Bitmask)
  6333. * If all Bits are set to zero, auto-scan (i.e. all valid
  6334. * PRNs) are searched.
  6335. * Every bit corresponds to a PRN number
  6336. * \see #UBXSBASScanModes1 to fill this field
  6337. * \return
  6338. * Returns full UBXMsgBuffer including header and checksum
  6339. */
  6340. /*!
  6341. * \fn getCFG_SBAS_POLL
  6342. * This function construct full buffer for #UBXCFG_SBAS_POLL message.
  6343. * \brief Getter for #UBXCFG_SBAS_POLL
  6344. * \return
  6345. * Returns full UBXMsgBuffer including header and checksum
  6346. */
  6347. /*!
  6348. * \fn getCFG_TP5_POLL
  6349. * This function construct full buffer for #UBXCFG_TP5_POLL message.
  6350. * \brief Getter for #UBXCFG_TP5_POLL
  6351. * \return
  6352. * Returns full UBXMsgBuffer including header and checksum
  6353. */
  6354. /*!
  6355. * \fn getCFG_USB_POLL
  6356. * This function construct full buffer for #UBXCFG_USB_POLL message.
  6357. * \brief Getter for #UBXCFG_USB_POLL
  6358. * \return
  6359. * Returns full UBXMsgBuffer including header and checksum
  6360. */
  6361. /*!
  6362. * \fn struct UBXMsgBuffer getCFG_USB(UBXU2_t vendorId,
  6363. UBXU2_t productId,
  6364. UBXU2_t powerConsumption,
  6365. UBXX2_t flags,
  6366. UBXCH_t* vendorString,
  6367. UBXCH_t* productString,
  6368. UBXCH_t* serialNumber)
  6369. * This function construct full buffer for #UBXCFG_USB message.
  6370. * \brief Getter for #UBXCFG_USB
  6371. * \param vendorId
  6372. * Vendor ID. This field shall only be set to
  6373. * registered Vendor IDs.
  6374. * \note Changing this field
  6375. * requires special Host drivers.
  6376. * \param productId
  6377. * Product ID.
  6378. * \note Changing this field requires special
  6379. * Host drivers.
  6380. * \param powerConsumption
  6381. * Power consumed by the device
  6382. * \param flags
  6383. * Various configuration flags
  6384. * \see #UBXUSBFlags to fill this field
  6385. * \param vendorString
  6386. * String containing the vendor name. 32 ASCII bytes
  6387. * including 0-termination.
  6388. * \param productString
  6389. * String containing the product name. 32 ASCI bytes
  6390. * including 0-termination.
  6391. * \param serialNumber
  6392. * String containing the serial number. 32 ASCII
  6393. * bytes including 0-termination.
  6394. * \note Changing the String fields requires special Host
  6395. * drivers.
  6396. * \return
  6397. * Returns full UBXMsgBuffer including header and checksum
  6398. */
  6399. /*!
  6400. * \fn struct UBXMsgBuffer getLOG_CREATE(UBXU1_t version, UBXX1_t logCfg, UBXU1_t logSize, UBXU4_t userDefinedSize)
  6401. * This function construct full buffer for #UBXLOG_CREATE message.
  6402. * \brief Getter for #UBXLOG_CREATE
  6403. * \param logCfg
  6404. * Config flags
  6405. * \see #UBXLOGCfg to fill this field
  6406. * \param logSize
  6407. * Indicates the size of the log
  6408. * \see #UBXLOGSize to fill this field
  6409. * \param userDefinedSize
  6410. * Sets the maximum amount of space in the
  6411. * filestore that can be used by the logging task
  6412. * \note This field is only applicable if logSize is set to user defined.
  6413. * \return
  6414. * Returns full UBXMsgBuffer including header and checksum
  6415. */
  6416. /*!
  6417. * \fn getLOG_ERASE
  6418. * This function construct full buffer for #UBXLOG_ERASE message.
  6419. * \brief Getter for #UBXLOG_ERASE
  6420. * \return
  6421. * Returns full UBXMsgBuffer including header and checksum
  6422. */
  6423. /*!
  6424. * \fn struct UBXMsgBuffer getLOG_FINDTIME_IN(UBXU2_t year, UBXU1_t month, UBXU1_t day, UBXU1_t hour, UBXU1_t minute, UBXU1_t second)
  6425. * This function construct full buffer for #UBXLOG_FINDTIME_IN message.
  6426. * \brief Getter for #UBXLOG_FINDTIME_IN
  6427. * \param year
  6428. * Year of UTC time
  6429. * \note Range 1-65635
  6430. * \param month
  6431. * Month of UTC time
  6432. * \note Range 1-12
  6433. * \param day
  6434. * Day of UTC time
  6435. * \note Range 1-31
  6436. * \param hour
  6437. * Hour of UTC time
  6438. * \note Range 0-23
  6439. * \param minute
  6440. * Minute of UTC time
  6441. * \note Range 0-59
  6442. * \param second
  6443. * Second of UTC time
  6444. * \note Range 0-60 - looks like mistake in official documentation
  6445. * \return
  6446. * Returns full UBXMsgBuffer including header and checksum
  6447. */
  6448. /*!
  6449. * \fn getLOG_INFO_POLL
  6450. * This function construct full buffer for #UBXLOG_INFO_POLL message.
  6451. * \brief Getter for #UBXLOG_INFO_POLL
  6452. * \return
  6453. * Returns full UBXMsgBuffer including header and checksum
  6454. */
  6455. /*!
  6456. * \fn struct UBXMsgBuffer getLOG_RETRIEVE(UBXU4_t startNumber,
  6457. UBXU4_t entryCount,
  6458. UBXU1_t version)
  6459. * This function construct full buffer for #UBXLOG_RETRIEVE message.
  6460. * \brief Getter for #UBXLOG_RETRIEVE
  6461. * \param startNumber
  6462. * Index of first entry to be transferred
  6463. * \param entryCount
  6464. * Number of log entries to transfer. The maximum
  6465. * is 256
  6466. * \param version
  6467. * The version of this message
  6468. * \note Set to 0
  6469. * \return
  6470. * Returns full UBXMsgBuffer including header and checksum
  6471. */
  6472. /*!
  6473. * \fn getLOG_STRING
  6474. * This function construct full buffer for #UBXLOG_STRING message.
  6475. * \brief Getter for #UBXLOG_STRING
  6476. * \return
  6477. * Returns full UBXMsgBuffer including header and checksum
  6478. */
  6479. /*!
  6480. * \fn getMON_VER_POLL
  6481. * This function construct full buffer for #UBXMON_VER_POLL message.
  6482. * \brief Getter for #UBXMON_VER_POLL
  6483. * \return
  6484. * Returns full UBXMsgBuffer including header and checksum
  6485. */
  6486. /*!
  6487. * \fn getRXM_ALM_POLL
  6488. * This function construct full buffer for #UBXRXM_ALM_POLL message.
  6489. * \brief Getter for #UBXRXM_ALM_POLL
  6490. * \return
  6491. * Returns full UBXMsgBuffer including header and checksum
  6492. */
  6493. /*!
  6494. * \fn struct UBXMsgBuffer getRXM_ALM_POLL_OPT(UBXU1_t svid)
  6495. * This function construct full buffer for #UBXRXM_ALM_POLL_OPT message.
  6496. * \brief Getter for #UBXRXM_ALM_POLL_OPT
  6497. * \param svid
  6498. * SV ID for which the receiver shall return its Almanac Data
  6499. * \note Valid Range: 1..32
  6500. * \return
  6501. * Returns full UBXMsgBuffer including header and checksum
  6502. */
  6503. /*!
  6504. * \fn getRXM_EPH_POLL
  6505. * This function construct full buffer for #UBXRXM_EPH_POLL message.
  6506. * \brief Getter for #UBXRXM_EPH_POLL
  6507. * \return
  6508. * Returns full UBXMsgBuffer including header and checksum
  6509. */
  6510. /*!
  6511. * \fn struct UBXMsgBuffer getRXM_EPH_POLL_OPT(UBXU1_t svid)
  6512. * This function construct full buffer for #UBXRXM_EPH_POLL_OPT message.
  6513. * \brief Getter for #UBXRXM_EPH_POLL_OPT
  6514. * \param svid
  6515. * SV ID for which this Almanac Data
  6516. * \note Valid Range: 1 .. 32 or 51, 56, 63.
  6517. * \return
  6518. * Returns full UBXMsgBuffer including header and checksum
  6519. */
  6520. /*!
  6521. * \fn struct UBXMsgBuffer getRXM_PMREQ(UBXU4_t duration, UBXX4_t flags)
  6522. * This function construct full buffer for #UBXRXM_PMREQ message.
  6523. * \brief Getter for #UBXRXM_PMREQ
  6524. * \param duration
  6525. * Duration of the requested task
  6526. * \note Set to 0 for infinite duration
  6527. * \param flags
  6528. * Task flags
  6529. * \see #UBXPMREQFlags to fill this field
  6530. * \return
  6531. * Returns full UBXMsgBuffer including header and checksum
  6532. */
  6533. /*!
  6534. * \fn struct UBXMsgBuffer getRXM_SVSI(UBXU4_t iTOW,
  6535. UBXI2_t week,
  6536. UBXU1_t numVis,
  6537. UBXU1_t numSV,
  6538. struct UBXRXM_SVSI_PART* svsiPart,
  6539. int svsiPartCount)
  6540. * This function construct full buffer for #UBXRXM_SVSI message.
  6541. * \brief Getter for #UBXRXM_SVSI
  6542. * \param iTOW
  6543. * GPS time of week of the navigation epoch.
  6544. * See the description of iTOW (u-blox© official documentation) for details.
  6545. * \param week
  6546. * GPS week number of the navigation epoch
  6547. * \param numVis
  6548. * Number of visible satellites
  6549. * \param numSV
  6550. * Number of per-SV data blocks following
  6551. * \param svsiPart
  6552. * Pointer to variabl payload part
  6553. * \param svsiPartCount
  6554. * variabl payload parts count
  6555. * \return
  6556. * Returns full UBXMsgBuffer including header and checksum
  6557. */
  6558. /*! @} */