ubx.c 163 KB

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