©DecawaveLtd2019 Version1.4 Page1of121
DW3000DEVICEDRIVERAPIGUIDE
DW3000DEVICE
DRIVERAPPLICATION
PROGRAMMING
INTERFACE(API)GUIDE
USINGAPIFUNCTIONSTO
CONFIGUREANDPROGRAMTHE
DW3000UWBTRANSCEIVER
Thisdocumentissubjecttochangewithoutnotice
DW3000 API Guide
©DecawaveLtd2019 Version1.4 Page2of121
DOCUMENTINFORMATION
Disclaimer
Decawavereservestherighttochangeproductspecificationswithoutnotice.Asfaraspossiblechangesto
functionalityandspecificationswillbeissuedinproductspecificerratasheetsorinnewversionsofthis
document.CustomersareadvisedtochecktheDecawavewebsiteforthemostrecentupdatesonthis
product
Copyright
©2019DecawaveLtd
LIFESUPPORTPOLICY
Decawaveproductsarenotauthorizedforuseinsafety‐criticalapplications(suchaslifesupport)wherea
failureoftheDecawaveproductwouldreasonablybeexpectedtocauseseverepersonalinjuryordeath.
DecawavecustomersusingorsellingDecawaveproductsinsuchamannerdosoentirelyattheirownrisk
andagreetofullyindemnifyDecawaveanditsrepresentativesagainstanydamagesarisingoutoftheuseof
Decawaveproductsinsuchsafety‐criticalapplications.
Caution!ESDsensitivedevice.
Precautionshouldbeusedwhenhandlingthedeviceinordertopreventpermanentdamage
DW3000 API Guide
©DecawaveLtd2019 Version1.4 Page3of121
DISCLAIMER
ThisDisclaimerappliestotheDW3000APIsourcecode(collectively“DecawaveSoftware”)provided
byDecawaveLtd.(“Decawave”).
Downloading,acceptingdeliveryoforusingtheDecawaveSoftwareindicatesyouragreementtothe
termsofthisDisclaimer.IfyoudonotagreewiththetermsofthisDisclaimerdonotdownload,
acceptdelivery
oforusetheDecawaveSoftware.
DecawaveSoftwareissolelyintendedtoassistyouindevelopingsystemsthatincorporate
Decawavesemiconductorproducts.Youunderstandandagreethatyouremainresponsibleforusing
yourindependentanalysis,evaluationandjudgmentindesigningyoursystemsandproducts.THE
DECISIONTOUSEDECAWAVESOFTWARE
INWHOLEORINPARTINYOURSYSTEMSANDPRODUCTS
RESTSENTIRELYWITHYOU.
DECAWAVESOFTWAREISPROVIDED"ASIS".DECAWAVEMAKESNOWARRANTIESOR
REPRESENTATIONSWITHREGARDTOTHEDECAWA VESOFTWAREORUSEOFTHEDECAWAVE
SOFTWARE,EXPRESS,IMPLIEDORSTATUTORY,INCLUDINGACCURACYORCOMPLETENESS.
DECAWAVEDISCLAIMSANYWARRANTYOF
TITLEANDANYIMPLIEDWARRANTIESOF
MERCHANTABILITY,FITNESSFORAPARTICULARPURPOSEANDNON‐INFRINGEMENTOFANYTHIRD
PARTYINTELLECTUALPROPERTYRIGHTSWITHREGARDTODECAWAVESOFTWAREORTHEUSE
THEREOF.
DECAWAVESHALLNOTBELIABLEFORANDSHALLNOTDEFENDORINDEMNIFYYOUAGAINSTANY
THIRDPARTYINFRINGEMENTCLAIM
THATRELATESTOORISBASEDONTHEDECAWAVESOFTWARE
ORTHEUSEOFTHEDECAWAVESOFTWAREWITHDECAWAVESEMICONDUCTORTECHNOLOGY.IN
NOEVENTSHALLDECAWAVEBELIABLEFORANYACTUAL,SPECIAL,INCIDENTAL,CONSEQUENTIAL
ORINDIRECTDAMAGES,HOWEVERCAUSED,INCLUDINGWITHOUTLIMITATIONTOTHEGENERALITY
OFTHEFOREGOING,LOSSOFANTIC IPATED
PROFITS,GOODWILL,REPUTATION, BUSINESS RECEIPTS
ORCONTRACTS,COSTSOFPROCUREMENTOFSUBSTITUTEGOODSORSERVICES;LOSSOFUSE,
DATA,ORPROFITS;ORBUSINESSINTERRUPTION),LOSSESOREXPENSESRESULTINGFROMTHIRD
PARTYCLAIMS.THESELIMITATIONSWILLAPPLYREGARDLESSOFTHEFORMOFACTION,WHETHER
UNDERSTATUTE,INCONTRACTORTORTINCLUDING
NEGLIGENCEORANYOTHERFORMOFACTION
ANDWHETHERORNOTDECAWAVEHASBEENADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGES,
ARISINGINANYWAYOUTOFDECAWAVESOFTWAREORTHEUSEOFDECAWAVESOFTWARE.
YouareauthorizedtouseDecawaveSoftwareinyourendproductsandtomodifytheDecawave
Softwareinthedevelopmentofyourendproducts.HOWEVER,NOOTHERLICENSE,EXPRESSOR
IMPLIED,BYESTOPPELOROTHERWISETOANYOTHERDECAWAVEINTELLECTUALPROPERTYRIGHT,
ANDNOLICENSETOANYTHIRDPARTYTECHNOLOGYORINTELLECTUALPROPERTYRIGHT,IS
GRANTEDHEREIN,includingbutnotlimitedtoanypatentright,copyright,
maskworkright,orother
intellectualpropertyrightrelatingtoanycombination,machine,orprocessinwhichDecawave
semiconductorproductsorDecawaveSoftwareareused.
Youacknowledgeandagreethatyouaresolelyresponsibleforcompliancewithalllegal,regulatory
andsafety‐relatedrequirementsconcerningyourproducts,andanyuseof
DecawaveSoftwarein
DW3000 API Guide
©DecawaveLtd2019 Version1.4 Page4of121
yourapplications,notwithstandinganyapplications‐relatedinformationorsupportthatmaybe
providedbyDecawave.
Decawavereservestherighttomakecorrections,enhancements,improvementsandotherchanges
toitssoftwareatanytime.
Mailingaddress:‐
DecawaveLtd.,
AdelaideChambers,
PeterStreet,
DublinD08T6YA
DW3000 API Guide
©DecawaveLtd2019 Version1.4 Page5of121
TABLEOFCONTENTS
1 INTRODUCTIONANDOVERVIEW........................................................................................................11
2 GENERALFRAMEWORK............................ .................................................. .......................................12
3 TYPICALSYSTEMSTART‐UP................................................................................................................14
4 INTERRUPTHANDLING............ ..................................................................................................... ......15
5 APIFUNCTIONDESCRIPTIONS.......................................... ..................................................................16
5.1 INITIALISEAPIS........................................................................................................................................16
5.1.1 dwt_apiversion...............................................................................................................................16
5.1.2 dwt_readdevid................................................................................................................................16
5.1.3 dwt_check_dev_id..........................................................................................................................17
5.1.4 dwt_getpartid.................................................................................................................................17
5.1.5 dwt_getlotid...................................................................................................................................18
5.1.6 dwt_geticrefvolt..............................................................................................................................18
5.1.7 dwt_geticreftemp...........................................................................................................................19
5.1.8 dwt_getxtaltrim..............................................................................................................................19
5.1.9 dwt_setlocaldataptr.......................................................................................................................20
5.1.10 dwt_otprevision..........................................................................................................................20
5.1.11 dwt_softreset.............................................................................................................................21
5.1.12 dwt_checkidlerc..........................................................................................................................21
5.1.13 dwt_initalise...............................................................................................................................22
5.2 CONFIGUREAPIS.....................................................................................................................................23
5.2.1 dwt_configure.................................................................................................................................23
5.2.2 dwt_restoreconfig...........................................................................................................................29
5.2.3 dwt_setplenfine..............................................................................................................................29
5.2.4 dwt_configuretxrf...........................................................................................................................30
5.2.5 dwt_setrxantennadelay.................................................................................................................. 31
5.2.6 dwt_settxantennadelay..................................................................................................................32
5.2.7 dwt_configurestskey.......................................................................................................................32
5.2.8 dwt_configurestsiv..........................................................................................................................33
5.2.9 dwt_configurestsmode...................................................................................................................34
5.2.10 dwt_configurestsloadiv..............................................................................................................34
5.2.11 dwt_configuresfdtype.................................................................................................................34
5.2.12 dwt_setleds................................................................................................................................35
5.2.13 dwt_setlnapamode.....................................................................................................................35
5.2.14 dwt_generatecrc8......................................................................................................................36
5.2.15 dwt_enablespicrccheck...............................................................................................................37
5.2.16 dwt_configmrxlut.......................................................................................................................38
5.2.17 dwt_enablegpioclocks................................................................................................................39
5.2.18 dwt_pgf_cal................................................................................................................................39
5.2.19 dwt_run_pgfcal..........................................................................................................................40
5.2.20 dwt_setdwstate..........................................................................................................................40
5.3 TX/RXANDTIMESTAMPAPIS....................................................................................................................41
5.3.1 dwt_writetxdata.............................................................................................................................41
5.3.2 dwt_writetxfctrl..............................................................................................................................42
5.3.3 dwt_starttx.....................................................................................................................................43
5.3.4 dwt_setdelayedtrxtime...................................................................................................................44
评论0