ubx.c 203 KB

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