ubx.c 215 KB

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