ubx.c 226 KB

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