n-sen manual 20180424 - nnnco. · 2 n-sen types there are three n-sen variants available as...
TRANSCRIPT
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page1of30
N-sen User Manual ST08-UM-001 April 2018
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page2of30
ChangeLog
Description Date Who
1.0 Firstdraft. 7/10/17 DC1.1 Addedexternalsensorwiringdiagram.FAQupdate.Known
problemsupdate.12/10/17 DC
1.2 Updatedfeaturesforv48firmware.Startedonfirmwareupdate,modemmodeandpowersupplydescription.
3/11/17 DC
1.3 Updatedfeaturesforv48Afirmware–Secondintervalreportadded.
23/11/17 DC
1.4 Updatedfeaturesforv48Bfirmware–Triggeredreportsandpulseinputstatechannelsadded.
1/12/17 DC
1.5 Minorcleanup.Cayennechanneldatatypeschecked. 4/12/17 DC1.6 UpdatedfeaturesforV50Afirmware–Parameterssplitin
twogroups,accumulatedpulseandbridgechannelsadded.AddeddetailsonCayennelimitationsandsplitpackets.Extendedpowersupplydescription.
27/12/17 DC
1.7 Changeddefaultsettingsforgenericuserandimprovedchannelmaskdescription.
10/01/18 DC
1.8 Correctiontoreportconditionvalues. 11/01/18 DC1.9 UpdatedforV51Afirmware–Valuetriggersnow
implemented.Modecommandadded.24/01/18 DC
2.0 Minorcorrections. 30/01/18 DC2.1 Minorcorrections 23/04/18 RZ
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page3of30
Table of Contents
1 Overview..........................................................................................................................................4
2 N-senTypes .....................................................................................................................................4
2.1 Internalsensors......................................................................................................................42.2 Externalinputsandoutputs ...................................................................................................4
3 N-senUsage.....................................................................................................................................7
4 N-senConfiguration ........................................................................................................................7
4.1 DriverInstallationWindowsXP/7/8only ...............................................................................74.2 ConfiguringthePort ...............................................................................................................74.3 TerminalSession ....................................................................................................................94.4 N-senCommands .................................................................................................................104.5 N-senParameters.................................................................................................................124.5.1 SystemGroupDescription ....................................................................................................................144.5.2 ReportingGroupDescription................................................................................................................154.5.3 LoRaWANParameters .........................................................................................................................174.5.4 HardwareConfigurationParameters...................................................................................................174.5.5 ReportingParameters ..........................................................................................................................184.5.6 IntervalReporting ................................................................................................................................184.5.7 ConditionalReporting ..........................................................................................................................184.5.8 PulseCountingandAccumulation .......................................................................................................184.5.9 TriggeredReporting .............................................................................................................................19
4.5.10 ChannelMasks .............................................................................................................................214.6 Resetcommand ...................................................................................................................234.7 PasswordSettings ................................................................................................................244.8 SystemMode .......................................................................................................................244.9 DemonstrationConfiguration ..............................................................................................244.10 UsingGPS .............................................................................................................................254.11 UplinkPayloadFormat–MyDevicesCayenneDataFormat................................................254.12 LimitationsofMydevicesCayenneDataRendering.............................................................274.13 SplitPayloadManagement ..................................................................................................28
5 KnownProblems............................................................................................................................28
6 Softwarefeaturesindevelopment................................................................................................28
6.1 ModemMode ......................................................................................................................287 SoftwareUpdate ...........................................................................................................................28
8 PowerSupply.................................................................................................................................29
9 Specifications.................................................................................................................................30
10 Frequentlyaskedquestions...........................................................................................................30
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page4of30
N-sen User Manual
1 Overview
N-senisacompactself-containedmultipurposeLoRaWANendpointdevicepackagedinaruggedwaterproofenclosurewithaconfigurableedgecomputingsoftwareplatformbuiltin.Itprovidesinternalsensorsandcanalsobeconnectedtoexternalsensorsandinstrumentswhichsupportlogging,pulse/accumulationandahighlyflexibleeventtriggeringsystem.AkeyfeatureofN-senisitsabilitytobeeasycustomisedtosuitcustomerspecificrequirementsbeyonditsstandardconfiguration.Thismayonlyrequiresoftwarechangesbutcanalsoincludehardwareconfigurationchangesdoneduringmanufacture.
2 N-sen Types
TherearethreeN-senvariantsavailableasstandard:1. N-sen-S.ThisisthestandardproductthatincludesallinternalsensorsexceptGPSandall
externalinputsandoutputs.2. N-sen-G.ThisaddsGNSSbasedlocationservicestoN-sen-S.3. N-sen-P.Thisisastrippeddownversionintendedforlowcostpulselogging.
Productsarenormallysuppliedwithafullysealedenclosurebutarealsoavailablewithventsthatallowtheinternalsensorstosampletheoutsideenvironment.Thestandardproductincludesthefollowing:
2.1 Internal sensors
1. Temperature.2. Humidity(indicatesdeworleakageinsealedenclosure).3. Barometricpressureandaltitude(typicallydisabledinsealedenclosure).4. 3-Axisaccelerometerincludingderivedpitchandrollangles.5. Powermonitoringincludingbatterycurrentsandvoltages.
2.2 External inputs and outputs
1. 3xdrycontactpulseoreventinputs.2. 3x0-3Vanalogueinputswith2channelsfactoryconfiguredforalternateuseforconnection
tothermistors.3. 1x4-20mAanalogueloopcurrentinput.4. 2xDCswitchingoutputs.5. 1x0-3Vanalogueoutput.6. 1xserialportwithtransmitenable(3Vlevels).
Factoryconfigurationdetermineswhichinputsandoutputsareavailableontheexternalsensorconnectorandalsoallowsforalternatescalingandgroupingoftheanalogueinputstosupportbridgesensorssuchaspressure,vacuumandmagnetictransducerswithswitched3Vpower.Soilmoisturesensorsrequiringcommutatingdrivearealsosupported.ActivepulsesensorssuchasthosewithbufferedCMOSoutputscanalsobesupportedwithswitched3Vpower.Thestandardsensorconnectorconfigurationisasfollows:
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page5of30
Pin number
Wire colour
Name Description Alternate function in standard product.
1 White PulseCH-1
Pulsechannel1.Drycontact.
2 Blue PulseCH-2
Pulsechannel2.Drycontact.
3 Red PulseCH-3
Pulsechannel3.Drycontact. Configurableasaneventinputresultinginimmediateuplink
4 Black Com Commonforpulseinputs.
9 White/Black
AIN-1 Analogueinput1.0-3VRange.Use9.1Mseriesresistortoscaleto0-30V.
8 Brown AIN-2 Analogueinput2.0-3VRange.Use9.1Mseriesresistortoscaleto0-30V.
Thermistorchannel1.
7 Yellow AIN-3 Analogueinput3.0-3VRange.Use9.1Mseriesresistortoscaleto0-30V.
Thermistorchannel2.
6 Green Com Commonforanalogueandthermistorinputs.
Table1:SensorConnections
Astandardsensorcableassemblyisavailablethatbreaksouttheseconnectionstosoldertailswiththewirecoloursshown.Compatibleconnectorsforcustomerwiringarealsoavailable.
Notes:
1. N-sendoesnotprovidea5or12Vsupplyoutputstopowerexternalinstrumentsorcurrentloops.
2. Accesstothe4-20mAloopinput,analogueoutput,DCoutputsorserialportrequiresalternateinternalwiring.
3. Seesection9fordetailedsensorspecifications.4. Consultthesupplierformoreinformation.
Thefollowingdiagramshowstypicalsensorwiringinmoredetail.Theviewoftheconnectorshownislookingatthesolderablepinsattherearoftheconnector.Thepinsareclosetogetherandsomeskillisrequiredforhandassembly.Werecommendusingthebreakoutcableassemblywherepractical.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page6of30
Figure1:ExternalSensorWiringDiagram
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page7of30
3 N-sen Usage
N-senshipswithageneralpurposeedgecomputingfirmwaresuite.Itspurposeistoallowsimpleconfigurationandreportingofsensordatabasedonanintervalorevent.DataisformattedintopacketsthatarecompatiblewiththeIPSOStandard/Cayennecompatibledevices.Packetsinthisformatcanalsobesenttootherreceiversandapplications.Consultyoursupplierformoreadvancedandcustomisedsolutionsforspecificusecasesincludingremoteconfigurationandcontrol.
4 N-sen Configuration
N-senisconfiguredviaaUSBconnectiontoaPCorotherdevicethatcansupportaterminalsession.AdedicatedUSBcableisprovidedthatconnectstothesameconnectorusedforexternalsensorconnection.RemovetheexternalsensorcableandconnecttheUSBcablewhenconfigurationisrequired.TheUSBconnectionprovidesaVirtualComPort(VCP)thatallowsaterminalsessiontobestarted.OnwindowsXP,7and8adriverhastobeloadedtosupporttheVCP.ThedriverisalreadyresidentonWindows10.OtherdevicesincludingLinuxmachines,AppleMACandRaspberryPigenerallydonotrequireadriver.
4.1 Driver Installation Windows XP/7/8 only
IfthedriverisrequiredfirstunziptheVirtualcomportdriver.ThennavigatetotheWin7orWin8folderasrequiredforyourmachine.Thenrunthesetupprogram“dpinst_am64.exe”for64bitor“dpinst_x86.exe”for32bitsystems.UsetheWin7folderforXPsystems.DonotconnecttheN-senuntilafterthedriverhasbeeninstalled.
4.2 Configuring the Port
TheVCPwilltakethenextavailablecomportnumberandthiswillbesystemdependent.Toseetheportusedgotothestartmenuandtypedevicemanagertorunthedevicemanager.Thisisalsoaccessiblefromthecontrolpanel.Withthecontrolpanelopen,connecttheN-sen.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page8of30
InthiscasetheN-senhasbeenassignedCOMPort(COM8).YoucanthenlaunchaterminalprogramsuchasTeratermorPutty.OpenaterminalsessionusingtheCOMportassigned(inthisexampleCOM8).Portassignmentonnon-Windowshostswillvary.Contactthesupplierforfurtherassistance.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page9of30
4.3 Terminal Session
Withtheterminalsessionopen,press<Enter>andtheN-senwillrespondwithatimestamplikethis:00:38:49.698:-Everytimeyoupress<Enter>anothernulltimestampwillbereturned.Thisallowswhitespacetobeenteredtoseparateeventsifdesired.Thisis“loggingmode”anditwillshowwhattheN-senisdoinginrealtime.Everytimeareportingintervalisreachedyouwillseeitloggedagainstatimestamp.Forexample:
00:41:10.629:MyDevices:capturesensors00:41:11.886:MyDevices:maxpacketsize24200:41:11.877:MyDevicesSVPB:1.181Vetc,dataisbeinguplinkedtothenetwork.
Othereventsarealsologgedincludingthesamplingthebatterystateofchargeevery60seconds.Fromloggingmodeyoucanforceanuplinkbypressingthe“S”keyorCtrl-S(ControlandSkeysatthesametime).InordertoconfigureandinteractwiththeN-sen,pressthe<Home>keyorCtrl-Atomoveinto“commandmode”.TheN-senwillreturnapromptlikethis“>”whenreadyforacommand.
?<Enter>willshowalistofavailablecommands.
WhentheN-senhasbeendisconnectedfromahostpreviouslyandyoumoveintocommandmodetheonlycommandavailablewillbepasswordenter.Therearetwopasswordlevelsrelevanttousersandservicepersonal.Users(default=user)areabletoviewsettingsandinteractwithimmediatecommandsbutcannotchangesettings.Service(default=service)areabletousealluserlevelcommandsandcanalsochangesettings.Entertheservicepasswordasfollows:passservice<Enter>.Thentype?<Enter>forafulllistofthecommandsasfollows:
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page10of30
4.4 N-sen Commands
Abriefusageforeachcommandisasfollows:
?help–showsalistofcommandsavailable.reset–usedtorestartaunitafterchangesaremadetoLoRaWANsettings.p1–getandsetsystemparameters.p2–getandsetreportingandeventparameters.def–restoresfactorydefaultsettings.(Careful).adc–showstheanaloguereadingsinrealtime.sen–showstheinternalsensorreadinginrealtime.pul1–showsthereport1pulsecountsinrealtime.pul2–showsthereport2pulsecountsinrealtime.pula–showstheaccumulatedpulsecountsinrealtime.pulrst–resetsthereport1and2pulsecounts.pularst–resetstheaccumulatedpulsecounts.gps–turnstheGPSreceiveronandoffandshowsthecurrentlocationinNEMAformatifavailable.pass–passwordentry.trig–triggersanimmediateuplink.therm–showsthetemperaturereadingforthermistor1and2ifconnected.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page11of30
bridge–showsthebridgechannelreadingifsensorandhardwareiscorrectlyconfigured.chan1–allowsreport1channelsbeingreportedtobeturnedonoroff.chan2–allowsreport2channelsbeingreportedtobeturnedonoroff.gm–GPSmanagerusedtomonitoranddebugGPSmonitoring.soc–StateOfChargemanagerusedtomonitoranddebugSOCmonitoring.ssm–Systemstatusmanagerusedtomonitoranddebugsystemmonitoring.ATD–Modemmode–useN-senasaLoRaWANmodem.op–TurnDCoutputswitchesonoroff.dout–Outputthespecifiedvalueontheanalogueoutput.0=0V,4095=3Vforstandardproduct.ver–printsoftwareversiondetails.mode–allowsthesystemmodetobedisplayedandchanged.Modesare:run,stopandship.
N-senwillremembercommandspreviouslyissued.Usetheuparrowkeytoscrollthroughthecommandlinehistory,thenpress<Enter>toexecute.
Note:tosampleanddisplaytheimmediatevaluesoftheexternalanalogue,thermistorsandpulseinputsaspecial“Y”cableisavailablethatallowsUSBandsensorconnectionsatthesametime.AlternatelyexternalsensorreadingscanbeviewedinCayenneorotherdashboardsshowinguplinkeddata.Generallya“Y”cableisonlyusedfordebugging.Itisalsopossibletoaccesssensorinputswiththecaseopenforqualifiedpersonal.Pleasecontactthesupplierformoreinformationonthis.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page12of30
4.5 N-sen Parameters
Parametersarestoredinpersistentmemory.Theyaredividedintotwogroups:p1–systemparameters.p2–reportingparameters.Parameterscanbeviewedandchangedonthecommandline.Therearemanyparametersandtheymustbehandledcarefully.Tosimplifythis,aPCapplicationandremoteaccesswebsitearebeingdevelopedandshouldbeavailablesoon.Pleasecontactthesupplierformoreinformationonthis.
Toshowallsystemparameterstypep1<Enter>asfollows:
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page13of30
Toshowallofthereportingparameterstypep2<Enter>asfollows:
Theparameterlistsarearrangedintorowswithanindexnumber,nameandvaluepair.Toviewaspecificparameterusep1orp2followedbytheindexnumberoftheparametertobedisplayed.e.g.p112<Enter>willshowtheDevEUI.
Tochangeaparameterusep1orp2followedbytheindexnumber,followedbythenewvaluerequired.e.g.p21300<Enter>willsetthereportingintervalto300seconds=5minutesforreport1.“1”istheindexnumberwhichreferstotheparameternamed“Rep1Secs”.Thechangevalueischeckedandifacceptablewillbewrittenintopersistentstorage.Thechangewillbeechoedbackonthecommandlineifitwasaccepted.e.g.>p21300Rep1Secs:300>
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page14of30
(Changewasacceptedandhasbeensaved).
>p21freddofrog>(Changewasnotaccepted–valuewasnotechoedback).
4.5.1 System Group Description
Index Name Description ValueTypeRange
Default Editable ResetNeeded
3 DevClass LoRaWANdeviceclass–Setbyfactory.
A/B/C A NO Yes
4 PubNet LoRaWANpublicnetworkflag.
0=off.1=on.i.e0/1
1 Yes Yes
5 OTA LoRaWANOTAAflag. 0/1 0 Yes Yes6 ADR LoRaWANADRflag. 0/1 1 Yes Yes7 ConfMsg LoRaWANConfirmed
Messagesflag.0/1 0 Yes Yes
8 DevAddr LoRaWANDeviceAddress.
4bytesinhex
000FFFFF Yes Yes
9 NwkId LoRaWANNetworkID.
4bytesinhex
00000000 Yes Yes
10 NwkSKey LoRaWANnetworksessionkey.
16bytesinhex
026F52D7445070BA259E3F6CDAFA64C3
Yes Yes
11 AppSKey LoRaWANapplicationkey(OTAA)orapplicationsessionkey(ABP).
16bytesinhex
1E1E892E4C61992E8F9436950D1E59B6
Yes Yes
12 DevEUI LoRaWANDeviceEUI–Setbyfactoryforeachunit.
8bytesinhex
947EB900000Fxxxx
NO Yes
13 AppEUI LoRaWANApplicationEUIforOTAA.
8bytesinhex
Yes Yes
14 PacGapSecs Timebetweenpacketsinsecondsifpayloadneedstobesplitintomultiplepackets.
1-4294967295
10 Yes Yes
15 ModemPort ModempacketLoRaWANportnumber.
1-255 2 Yes Yes
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page15of30
16 ExtAnt Enablesexternalantenna.
0/1 0 Yes Yes
17 PABoost EnablesRFPowerBoost.
0/1 0 Yes Yes
18 GPSTimerSecs TimeoutinsecondsallowedforGPSinitialfixbeforereceiverisswitchedoff.
0-4294967295
300 Yes NO
19 SOCTotal TotalchargeinAmp/Secondsforprimarycell/sfitted.StateOfCharge.
- 9000for1xAA size LTCcell
Yes Yes
20 SOCSampleSecs SamplingintervalinsecondsforSOC.
- 60 NO NO
21 SOCStoreSecs StorageintervalinsecondsforSOC.
- 3600 NO NO
22 SocAccum SOCAccumulatorinmicroAmpseconds
8bytes 0000000000000000
NO NO
23 ServicePass Serviceaccesspassword
31charactersmax
service Yes NO
24 UserPass Useraccesspassword
31charactersmax
user Yes NO
25 Mode SystemModeSeemodecommand
0,1,2. service Yes Yes
Table2:SystemConfigurationParameters
4.5.2 Reporting Group Description
Index Name Description ValueTypeRange
Default Editable ResetNeeded
1 Rep1Secs Intervalreport1timeinseconds.
0-4294967295
300 Yes Yes
2 Rep1Chan Intervalreport1channelenablemask.Seealsochan1command.
0000000000000000-FFFFFFFFFFFFFFFF
000000000020BFC5
Yes Yes
3 Rep1Port Intervalreport1LoRaWANportnumber.
1-255 3 Yes Yes
4 Rep1Cond Intervalreport1Condition.
0-255 0 Yes Yes
5 Rep1PulAcc Intervalreport1 0-7 0 Yes Yes
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page16of30
PulseChannelAccumulatorsetup
6 Rep2Secs Intervalreport2timeinseconds.
0-4294967295
0=disabled.
Yes Yes
7 Rep2Chan Intervalreport2channelenablemask.Seealsochancommand.
0000000000000000-FFFFFFFFFFFFFFFF
0000000000000000=alloff.
Yes Yes
8 Rep2Port Intervalreport2LoRaWANportnumber.
1-255 3 Yes Yes
9 Rep2Cond Intervalreport2Condition.
0-255 0 Yes Yes
10 Rep2PulAcc Intervalreport2PulseChannelAccumulatorsetup
0-7 0 Yes Yes
11 TrigSampSec TriggerGeneratorSampleTimer
0-65535 0=Disabled
Yes Yes
TriggerGenerator1
12 Trig1Chan Trigger1sourcechannelnumber
0-255 0 Yes Yes
13 Trig1Cond Trigger1condition 0-5 0 Yes Yes14 Trig1Value Trigger1value 0-65535 0 Yes Yes
15 Trig1Flt Trigger1filterinseconds
0-255 0 Yes Yes
16 Trig1Rep Trigger2reportnumber
0-2 0 Yes Yes
TriggerGenerator2 17 Trig2Chan Trigger2source
channelnumber0-255 0 Yes Yes
18 Trig2Cond Trigger2condition 0-5 0 Yes Yes19 Trig2Value Trigger2value 0-65535 0 Yes Yes20 Trig2Flt Trigger2filterin
seconds0-255 0 Yes Yes
21 Trig2Rep Trigger2reportnumber
0-2 0 Yes Yes
TriggerGenerator3
22 Trig3Chan Trigger3sourcechannelnumber
0-255 0 Yes Yes
23 Trig3Cond Trigger3condition 0-5 0 Yes Yes24 Trig3Value Trigger3value 0-65535 0 Yes Yes25 Trig3Flt Trigger3filterin
seconds0-255 0 Yes Yes
26 Trig3Rep Trigger3reportnumber
0-2 0 Yes Yes
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page17of30
TriggerGenerator4
27 Trig4Chan Trigger4sourcechannelnumber
0-255 11 Yes Yes
28 Trig4Cond Trigger4condition 0-5 2 Yes Yes29 Trig4Value Trigger4value 0-65535 0 Yes Yes30 Trig4Flt Trigger4filterin
seconds0-255 1 Yes Yes
31 Trig4Rep Trigger4reportnumber
0-2 1 Yes Yes
Table3:ReportingConfigurationParameters
4.5.3 LoRaWAN Parameters
LoRaWANparametersarepartthesystemgroupshadedingrey.TheN-senisnormallyoperatedaclassALoRaWANlowpowerdevice.Inthismode,thedeviceisabletosleepbetweeneachscheduleduplinkandonlylistensfordownlinkpacketsintheRX1andRX2receivewindowsafteranuplink.ThedefaultbandplanusedisAS923–LoRaWANVersion1.02.TheDevEUIissetatthefactoryandcannotbechanged.Thedeviceclassisalsofixed.
IftheN-senistobeOTAjoined(OverTheAirActivated)thentheAppEUI,AppKey=AppSKeywillberequired.TheOTAflagshouldbeenabled=1.IftheN-senistobeABPjoined(ActivationByPersonalisation)thentheDevAddr,NwkSKeyandAppSKeywillberequired.ThePublicNetworkflagshouldbeenabled=1foruseonallpublicnetworks.Itincreasesthetimeallowanceforjoin.
Note:LoRaWANparameterswillgenerallybepre-configuredbythesupplierduringdeviceprovisioningforyourdevice.Contactthesupplierifchangesarerequired.
4.5.4 Hardware Configuration Parameters
Hardwareconfigurationparametersarepartthesystemgroupshadedinblue.
N-senhasaninternalantennabutcanbepurchasedwithanSMAconnectoroppositethesensorcableconnectorusedforconnectiontoexternalantennas.TheExtAntparametershouldbeenabledinthiscase.Pleasecontactthesupplierformoreinformationonthis.
EnablingPABoostwillincreasetheuplinkpowerbyupto6dBbutwillsignificantlyincreasepowerconsumption.Pleaseseethespecificationsectionformoredetailsonthis.WerecommendleavingPABoostoffonsinglebatterysystems.
GPSTimerSecssetstheamountoftimethesystemwillkeeptheGPSreceiverrunningtoreceiveitsinitiallocationfixbeforepoweringdown.Werecommendleavingthisatthedefaultsetting.
SOCTotalissettothetotalavailablechargeinAmp/Seconds(Coulombs)fortheprimarybatteryusedintheunit.WhenthebatteryStateOfCharge(SOC)iscalculated,thisvaluerepresentstheinitialcapacity=100%.TheSOCsubsystemkeepstrackofthechargeremovedfromthebattery.e.g.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page18of30
Ifthechargeusedsofarwas4500x1,000,000micro-ampsecondsthentheSOCreportedwouldbe50%.
4.5.5 Edge Computing Reporting Parameters
Reportingparametersarepartofthereportinggroupshadedingreen.Thissectionisusedtosetupthereportingconfiguration.Thesecanbechangedasrequired.Note:changeswillnotcomeintoeffectuntilafteraresetcommandisissuedinmostcases.
4.5.6 Interval Reporting
Therearetwocompletelyindependenttimeintervalbasedreportgenerators,IntervalReport1and2.Eachhasitsownsetofchannelenables.Atypicalusagewouldbetohavereport1configuredtosendasmallnumberofchannelsoftenwhilereport2isusedtosendalargergrouplessoften.Thisapproachresultsinlongerbatterylifewhilestillprovidingthecriticaldatarequiredatanacceptablerate.
Thedefaultsetupasshippedwillhavethereportingintervalssetasfollows:Rep1Secs=600seconds(every10minutes)andRep2Secs=0.Settingtheintervalto0secondsdisablesthereportfrombeingsentperiodicallybutatriggeredreportcanstillbesentifthetriggeringconditionismet.Thereportingintervalcanbesetintherangeintherange10–4294967295seconds.Werecommendaminimumof60secondsforuseonpublicnetworksandtypically900seconds(15minutes)forlongbatterylifeapplicationswherereportingisunconditional.
4.5.7 Conditional Reporting
Bydefaultnoconditionsareapplied(“Rep1Cond”=0,“Rep2Cond”=0)andintervalreportswillbesentattheintervalspecified.Otherconditionsavailableare:
0 –Noconditionreportswillbesent.1 –Reportsaresentiftrigger1conditionprevails.2–Reportsaresentiftrigger2conditionprevails.3–Reportsaresentiftrigger3conditionprevails.4–Reportsaresentiftrigger4conditionprevails.16–Reportsareonlysentif1ormorepulsesaredetectedonpulseinput1or2duringtheintervaltime.
Otherconditionscanbeaddedtosuitcustomerrequirements.Pleasecontactthesupplierformoreinformationonthis.
4.5.8 Pulse Counting and Accumulation
TheN-senhas3pulseinputchannelswhichcanalsobeusedforstatei.e.openorclosedcontactmonitoring.Eachreportgeneratorhasthreeindependentpulsecounters.Normallythesecountersareresetatthestartofeachnewintervaltoprovideacountperintervalreading.Theycanalsobeswitchedintoaccumulatedmode,wherethecountcontinuestoincrementuntilitisspecifically
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page19of30
resetorrollsover.Bydefaultaccumulationisdisabled(“Rep1PulAcc”=0,“Rep2PulAcc”=0)butcanenabledseparatelyforeachreportandpulsechannelasfollows:
Rep#PulAcc PulseCH3 PulseCH2 PulseCH10 count count count1 count count accumulate2 count accumulate count3 count accumulate accumulate4 accumulate count count5 accumulate count accumulate6 accumulate accumulate count7 accumulate accumulate accumulateNote:#is1forreport1and2forreport2.
Thesepulsecounters/accumulatorsareassignedtoreportchannels9,10and11andareseparateforeachreport.Thatmeansforexample,pulseinput1couldbeshownasacountinreport1andasanaccumulatedcountinreport2.
Apartfromthesepulsecounters,thereare3completelyseparatecounters(1perpulsechannel)thatarereportedasunsigned32bitvalues(0–4294967295)thatalwaysaccumulateandareassignedtochannels29,30and31.Note:ThesechannelsarenotsupportedbyMydevicesCayenneandareintendedforusewithmoreadvancedmonitoringsystems.
4.5.9 Triggered Reporting
Inmanyapplicationstoextendbatterylife,reducenetworktrafficandalsotocaptureeventsinnearrealtime,triggeredreportingcanbeused.N-senhasaflexiblesystemwithfourindependenttriggergenerators.Theparametersassociatedwiththeseareshadedinorange.Atriggeredreportissentatthetimethetriggerconditionismetandhaspassedthroughafilter.Whiletheconditionprevails,ongoingintervalreportscansentifrequired.Pleaseseeconditionalreportingabove.Afurtherreportcanbesentatthetimetheconditionends.
Eachtriggergeneratorhasthefollowingsettings:
TriggerChannel–thisisthesourcechannelbeingmonitoredfromwhichatriggereventwillbedetected.
TriggerCondition–thisistheconditionthatwillresultintriggering.Optionsare:0–Off-notriggerwillbegenerated.1 –Risingedge=contactopenonpulseinputchannel.2 –Fallingedge=contactclosedonpulseinputchannel.3–Equalto.4 –Lessthan.5 –Greaterthan.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page20of30
TriggerValue–numericvalueforthetrigger.Thisisapplicabletoalltriggersbasedonvalue.Forexampleaspecificvoltage,temperature,pitchangleorpulsecount.Itisnotapplicabletocontactopenandclosedetection.
TriggerFilter–Thetriggerconditionmustprevailforthetimespecifiedbythisparameterinsecondsforcontactopenandclosedetection.Thisisintendedforswitchde-bouncing.Foravalue,thisparameterspecifiesthenumbertriggersamplesforwhichtheconditionmustprevailbeforeareportistriggered.
TriggerReport–Thisspecifiesthereportthatwillbesentwhenthetriggerisdetected.Possiblevaluesare:0 –Noreport.1 –Sendreport1whentriggered.2–Sendreport2whentriggered.3 –Sendreport1and2whentriggered.4 –Reserved.5 –Sendreport1whentriggeredandagainwhentriggerconditionends.6–Sendreport2whentriggeredandagainwhentriggerconditionends.7–Sendreport1and2whentriggeredandagainwhentriggerconditionends.
Commontoalltriggergenerators:TriggerGeneratorSampleTimer-Thissetstherateinsecondsatwhichchannelsaresampledfortriggeringpurposes.Itisnotapplicabletocontactopenandclosedetectionwherethedetectionisimmediate.
Asshipped,acontactcloseonpulseinput3foronesecondwilltriggerreport1tobesent.Triggergenerator4isused.ThisishandyfortestingexternalsensorswithoutaUSBconnectiontorequestanuplink.Todisablethisfeaturechangeparameterp228“Trig4Cond”usingthefollowingcommand:p2280<Enter>.Note:0=off.
Example:Wewanttosendreport1ifthetemperaturegoesabove40˚C.Wewillusetriggergenerator1.Whilethisconditionprevailswewanttocontinuesendingreportsevery10minutes.Tokeeppowerconsumptionlow,wewillonlysamplethetemperatureonceaminute.Therelevantparametervaluesare:
P21Rep1Secs=600(Reportintervalsetto10minutes).P24Rep1Cond=1(Reportswillcontinuetobesentwhiletheconditionprevails).P211TrigSampSec=60(Triggersampleratesetto1minute).P212Trig1Chan=13(Sampletemperature).P213Trig1Cond=5(Triggerifgreaterthan).P214Trig1Value=40.0(40degreesC).P215Trig1Flt=0(Nofiltering–triggerwilloccuronfirstsample).P216Trig1Rep=1(Sendreport1).
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page21of30
4.5.10 Channel Masks
Allofthesensordataisarrangedintonumberedchannels.Onlychannelsthatareenabledwillbesampledandreported.ToshowallofthechannelsforIntervalreport1typechan1<Enter>asfollows:
Note:Bydefaultreport1hasanumberofchannelsalreadyenabled=1.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page22of30
Toshowallofthechannelsforintervalreport2typechan2<Enter>.
Note:Bydefaultreport2hasallchannelsdisabled=0.
Toenableachannelforreport1use:chan1number1<Enter>.Todisableachanneluse:chan1number0<Enter>.Forexamplechan1161<Enter>willturnonthepitchanglechannelwhichisavaluederivedfromtheaccelerometer.Toenableanddisablechannelsforreport2usechan2insteadofchan1forthefirstpartofthecommand.
EachchannelisrepresentedbyonebitstoredinRep1Chanforreport1andRep2Chanforreport2inthereportingparametergroup.Bit0representschannel0,bit1channel1etcthroughtobit63.Thisallowsforamaximumof64channels.Sofarbits0–32havebeenassignedtosensorsandderivedvalue.Onceyouhavearrivedatthechannelconfigurationmaskrequiredforyourprojectusingthe“chan1”or“chan2”command,youcancutandpastetheresultingvalueintheparametereditortoquicklyconfigureotherN-senswiththesamechannelmask.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page23of30
Note:AlwaysissuearesetcommandafterchannelchangeshavebeenmadesotheN-senwillpickupthenewconfiguration.
4.6 Reset command
Toresettheunitafterparameterchangesaremadewherearesetisrequireduse:reset<Enter>.TheunitwilldisconnectandthenreconnecttoUSBandwillshowalogondialogsimilartothefollowing:
NotesometerminalprogramsincludingTeratermversionspriorto4.95mayneedtobeclosedandthenre-openedafterreset.TheunitwillreturntologgingmodeafteraresetorUSBdisconnectionandreconnection.Apasswordwillhavetobeenteredontransitiontocommandmodewhenthe<Home>keyispressedifUSBwasdisconnected.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page24of30
4.7 Password Settings
Iftheservicepasswordwasissuedonentrytothecommandline,itcanbechangedusingtheServicePasswordparameter.Serviceuserscanalsochangetheuserpassword.Iftheuserpasswordwasenteredonentrytothecommandlineonlytheuserpasswordcanbechanged.
4.8 System Mode
N-senhasthreepossiblesystemstates:run,stopandship.RunmodeisthenormalmodewherereportswillbesentviaLoRaWAN.InthismodetheN-senisabletotransmitanddetecttriggerevents.Stopmodeinhibitstransmissionsbutallowssensorstobesampledandtriggeringconditionstobeshownontheterminalinloggingmode.Shipmodeinhibitsalltransmissionsandalsodisablessamplingandtriggerdetection.Shipmodeisintendedforshippingunitswhentransmissionisprohibitedandalsotoconservepoweruntiltheunitisreadytobedeployed.
4.9 Demonstration Configuration
TodemonstratesomeofthefunctionsoftheN-senasimpleMydevicesprofilehasbeensetup.Thiscanbechangedasdescribedabove.ChannelsthatareenabledwillbecustomerspecificbutwillgenerallyincludethefollowingchannelsshownasaCayenneDashboardasfollows:
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page25of30
4.10 Using GPS
TodetermineifaGPSreceiverisfittedusethecommand:gps1<Enter>.Ifyoureceivetheresponse>gps1GPSStartGPSnoresponseyet>ThenGPSisnotfitted.IfGPSisfitteditwillreturnafixinNEMAformatafterithascalculatedaninitialfixandmaybeenabledinthechannelmasksandreported.TouseGPSinreportsasecondarybattery(rechargeable)shouldbefittedandwillneedtobechargedperiodicallybyconnectingtoaUSBhostorotherexternalsupplydependingonthereportinginterval.PleasecontactthesupplierformoreinformationonGPSoperations.
4.11 Uplink Payload Format – MyDevices Cayenne Data Format
ThenN-sendemonstrationconfigurationuplinkssensordatausingMydevicesCayenneLowPowerPayloadasdescribedinthefollowingdocument:https://mydevices.com/cayenne/docs/lora/
Thedataistransmittedintheorderdescribedinthefollowingtable.Eachchannelcanenabledordisabledusingthe“chan1”or“chan2”command.Toreducethetimerequiredforeachuplinkandthereforereduceonairtimeandpowerconsumption,onlyenabletherequiredchannels.
N-sencanbeselectedasadeviceinCayenneintheLoRasection.UseyourLoRaWANnetworkprovider’sdevicemanagertoenrolyourn-SendeviceseitherusingABPorOTAJoin.AnapplicationroutetoCayenneisrequired.Youcanalsoroutethedatatoyourownapplicationserver.Pleasecontactthesupplierformoreinformationincludingsupporteddownlinkcommands.
Signal Name
Description Cayenne Data Type
Cayenne Data Channel
Cayenne Dashboard Setting
Conversion/ Unit
SVPB Primarybatteryvoltage
AnalogInput 0 Units:VNumdecimals:2
x10mV
SIPB Primarybatterycurrent
AnalogInput 1 Units:mANumdecimals:1
x0.1mA
SVEXT Externalsupplyvoltage
AnalogInput 2 Units:VNumdecimals:2
x10mV
SVSB Secondarybatteryvoltage
AnalogInput 3 Units:VNumdecimals:2
x10mV
SISB Secondarybatterycurrent
AnalogInput 4 Units:mANumdecimals:1
x0.1mA
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page26of30
SILOOP 4-20mALoopcurrent
AnalogInput 5 Units:mANumdecimals:2
x0.01mA
AIN1 Analoginput1 AnalogInput 6 Units:VNumdecimals:2
x10mV
AIN2 Analoginput2 AnalogInput 7 Units:VNumdecimals:2
x10mV
AIN3 AnalogInput3 AnalogInput 8 Units:VNumdecimals:2
x10mV
Pulse1 Pulse1inputcount AnalogInput 9 Units:Counts/100Numdecimals:2
x0.01count
Pulse2 Pulse2inputcount AnalogInput 10 Units:Counts/100Numdecimals:2
x0.01count
Pulse3 Pulse3inputcount AnalogInput 11 Units:Counts/100Numdecimals:2
x0.01count
RelativeHumidity HumiditySensor 12 Units:%
Numdecimals:1x0.5%
Temperature Temperature
Sensor13 Units:degC
Numdecimals:1x0.1C
Pressure Barometer 14 Units:hectopascal
Numdecimals:1x0.1hPa
Accelerometer Accelerometer 15 Units:G
Numdecimals:3x0.001G
PitchAngle AnalogInput 16 Units:degrees
Numdecimals:0x1Degree
RollAngle AnalogInput 17 Units:degrees
Numdecimals:0x1Degree
Thermistor1 Temperature
Sensor18 Units:degC
Numdecimals:1x0.1C
Thermistor2 Temperature
Sensor19 Units:degC
Numdecimals:1x0.1C
GPSposition GPSLocation 20
x0.0001Degreex0.01mHeight
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page27of30
PrimarybatterySOC(StateofCharge)
AnalogInput 21 Units:%Numdecimals:0
x1%
CPUUsage AnalogInput 22 Units:%Numdecimals
CPUUpTimeMissionElapsedTime
AnalogInput 23 Months x0.01
RSSIDown AnalogInput 24 RSSIofdownlink x1dB
SNRDown AnalogInput 25 SNRofdownlink x1dB
Pulse1 Pulse1State DigitalInput 26 Stateofpulseinput1. 0=open1=closed
Pulse2 Pulse2State DigitalInput 27 Stateofpulseinput2. 0=open1=closed
Pulse3 Pulse3State DigitalInput 28 Stateofpulseinput3. 0=open1=closed
Pulse1 Pulse1AccumulatedCount
Undefined 29 32bitunsigned N/A
Pulse2 Pulse2AccumulatedCount
Undefined 30 32bitunsigned N/A
Pulse3 Pulse3AccumulatedCount
Undefined 31 32bitunsigned N/A
BridgeAIN1,2&3
BridgeSensor AnalogInput 32 Units:mBarNumdecimals:2
x0.01mBar
Table4:CayenneSensorData
4.12 Limitations of Mydevices Cayenne Data Rendering
Cayennehaslimiteddatarendering.Thereisnoprovisionforunitconversions,scaling,offsetsorunsignedvalues.Pulsecountscanonlybeshownasiftheyweresignedanaloguevalueswitharangeof+327.67to-327.68.Thatmeans1pulsewillshowas0.01andasthecountincrementsto32767shownas327.67itwillsuddenlyjumpto-327.68onthenextincrement.The32bitunsignedpulseaccumulatorchannelsareNOTsupportedatallbyCayenne.
Thepayloadformathoweverissimpleandeasytodecodeandcanbedirectedtoalternateapplicationserversasrequired.NNNCowillprovideanimproveddemonstrationplatformforN-seninthefuturewhentheN-senwebsiteispublished.Pleasecontactthesupplierformoreinformation.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page28of30
4.13 Split Payload Management
DependingontheLoRaWANdatarateavailable,N-senmayspittheuplinkpayloadintomorethanonepacket.Thetimebetweenpacketsinthiscaseissetbythe“PacGapSecs”parameter.Cayennepayloadswillalwaysbespitsuchthateachfragmentstartswithachannelnumber.Channelsarealwayssentinorderlowest(sentfirst)tohighest(sentlast).Mydevicescopeswellwithsplitpacketsandwillstillcorrectlyupdateeachwidget.
CustomersimplementingtheirownreceiversforN-sendatashouldnotexpectthatallchannelsenabledwillbesentinasinglepacketandshouldparseeachpacketindependently.DependingontheMetadataavailablefromthenetworkserver,sequencenumbersandtimestampscanbeusedtoallocatedatapacketsintospecificsamplebins.Pleasecontactthesupplierformoreinformationonthis.
5 Known Problems
N-senmayfailtoenumeratecorrectlywhenconnectedtoUSBwithsomehosts.Ifthisoccurs,pleaseunplugfromthehostandreconnectafterthirtyseconds.LeavetheUSBcableconnectedallthetimeattheN-senendanddisconnectandreconnectatthehost(PC)end.Pleasebepatientwiththisandweexpecttheproblemtoberesolvedonthenextrelease.
6 Software features in development
Discussfeaturesincludinglogging,serialinterface,modemfunctionsandcompositeUSBwithfilesystem.
6.1 Modem Mode
N-sencanbeusedasamodemforsendingandreceivingdataviaLoRaWAN.Themodemoperatesinhalfduplexmodeanddataisbufferedinbothdirections.APCorotherdeviceisusedasahostconnectedviaUSBVCPorthehardwareserialport.Asuitableapplicationisrequiredonthenetworkside.IssuetheATDcommandtoentermodemdatamode,thenallincomingserialdatawillbepacketisedanduplinkedtothenetworkserver.
ThesizeofeachpacketsentovertheairdependsontheLoRaWANdatarateandthedelaybetweenpacketsuplinkedissetbythe“PacGapSecs”Parameter.AnydatareceivedonthedownlinkwillbesentoutontheserialVCPandhardwareserialport.ToexitmodemdatamodeandreturntocommandmodeissuethestandardHayesmodem“+++”escapesequence.Pleasecontactthesupplierformoreinformationonmodemmode.
7 Software Update
FirstreleaseN-senproducts(onesthatdon’tmountafilesystemwhenUSBisconnected)requireopeningthecaseandinsertionofjumperlinktoruntheUSBbootloader.Pleasecontactthesupplierforassistancewiththisifrequired.
Unitswithafilesystemallowthenewfirmwarefile(.nbfformat)tobedraggedanddroppedontothedrive.Acommandisthenusedtotriggerreloading.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page29of30
8 Power Supply
N-senisdesignedtoforawidevarietyofapplicationsrangingfromexternallypoweredhighreportingratesystemsatoneextremetostoreandburst(nobatteryfitted)attheother.Centraltothisconceptisthechargerinthefollowingdiagram.Energyfromanexternalsupply,PVcell,4-20mAcurrentlooporUSBsupplychargesastoragecapacitorandsecondary(rechargeable)batteryiffitted.Energyfromtheprimarybatteryisonlyusedwhenthereisinsufficientexternalpoweravailable.
ThechargerisbasedonaDC/DCconverterthatoperatesfrom2.5Vto15Vinput.Itaimstochargethestoragecapacitorandsecondarybatterytoamaximumvoltageof4V.IftheexternalsourceisaPVcellthechargeradjustsitsoutputcurrentformaximumsolarefficiencyfrom3Vpanelsthataresmallenoughtobefittedontothetopcover.
TherearetwobatterymountingpositionsinsidetheN-sen.Foranapplicationwithoutanyexternalpower,upto2x“A”sizeLTCcellscanbefitted.Moretypicallyoneortwo“AA”sizecellsarefitted.ForapplicationswithexternalpowerandGPS/GNSSa“AA”sizeLIONrechargeablecellwillbefitted.TheN-sen-PwhichisalowcostpulseloggingversionoftheN-senhasnochargingcircuitryandoperatesfromprimarybatteriesorUSBsupplywhenconnected.
Figure2:PowerSupplyDiagram
Current Monitor
Current Monitor
External Power
Sources
Secondary Battery
Storage Capacitor
Voltage Monitor
Jumper LK1 Voltage
Monitor Primary Battery
1 or 2 cells Voltage Monitor
USB 5V supply
Sensor Supply 4-20mA
Loop
Charger Ext Supply 2.5 – 15V eg PV Cell
Ext Disable
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page30of30
Thepowersupplyoperatingconditionsaremonitoredasfollows:Name Description Range Typ UnitsSVPB SenseVoltagePrimaryBattery 0-6 3.3to3.7 VSIPB SensecurrentPrimaryBattery 0-300 0.5to10 mASVEXT SenseVoltageExternalSupply 0-18 2.5to15 VSVSB SenseVoltageSecondaryBattery/Capacitor 0-6 3.3to4.0(1) VSISB SensecurrentSecondaryBattery/Capacitor -360to180 -300to50(2) mA
Notes:
(1) LoRaWANtransmissionisdisabledwhenSISBislessthan3.0V.(2) Negativevaluesindicatecharging.Positivevaluesindicatedischarging.(3) N-senbatterypacksarefittedwithinternalprotectioncircuitryandmustbepurchasedfromthesupplierforcontinuedsupportandcompliancewithspecifiedstandards.
9 Specifications
Complieswith:LoRaWANAllianceSpecification1.02.LoRaWANfirmwareportedfromSemtechLoRaMac-nodeV4.4.0.AS/NZSCISPR22RadiatedandConductedEmissions–InformationTechnology.AS/NZSCISPR24ImmunityCharacteristics-InformationTechnology.AS/NZS60950ElectricalSafetyRequirementsInformationTechnology.AS/NZS4268Radioequipmentandsystems-Shortrangedevices.
ST08-UM-001 NationalNarrowbandNetworkCommunications.www.nnnco.com.au
Page31of30
10 Frequently asked questions
Q.WhyisN-sennotreporting?A.Itmaystillbein“ship”mode.Changethemodetoruntoallowreportstobesent.Seesection4.8formoredetails.
Q.Whyhasn’tN-senchangedtonewconfigurationsettings?A.Alwaysissuethe“reset”commandafterchangingreportingorLoRaWANsettings.
Q.HowcanIforceanuplinktocheckthatdataisbeingsent?A.UsetheScommandinloggingmodeifahostisconnectedorthe“trig”commandifincommandmode.Acontactclosureonpulseinput3willalsoforceanuplinkifconfigured.
Q.IsitpossibletohaveaUSBhostconnectedandatthesametimehaveaccesstoexternalsensorinputconnections?A.Yesbutthisrequiresa“Y”cable.Pleasecontactthesupplierformoreinformationonthis.
Q.HowdoIdorangetesting?A.Thisiscomplexbutasimplemethodistousethewirelessloggerprovidedbyyournetworkprovider.NormallyLoRaWANADRisenabledbydefault.Thisallowsthedataratetoadjustupanddowndependingonlinkconditionswhichminimisestheuplinkdurationandsavesbatterypower.TosavetimewaitingforADRtotraindownyoucanissuetheresetcommand.Youcanalsoforcesendingatthelowestdatarate(LoRaWANSF12)bydisablingADR.Thisgivesthelongestuplinkrangebutshouldonlybeusedfortesting.Pleasediscussthisfurtherwiththesupplier.