| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526305273052830529305303053130532305333053430535305363053730538305393054030541305423054330544305453054630547305483054930550305513055230553305543055530556305573055830559305603056130562305633056430565305663056730568305693057030571305723057330574305753057630577305783057930580305813058230583305843058530586305873058830589305903059130592305933059430595305963059730598305993060030601306023060330604306053060630607306083060930610306113061230613306143061530616306173061830619306203062130622306233062430625306263062730628306293063030631306323063330634306353063630637306383063930640306413064230643306443064530646306473064830649306503065130652306533065430655306563065730658306593066030661306623066330664306653066630667306683066930670306713067230673306743067530676306773067830679306803068130682306833068430685306863068730688306893069030691306923069330694306953069630697306983069930700307013070230703307043070530706307073070830709307103071130712307133071430715307163071730718307193072030721307223072330724307253072630727307283072930730307313073230733307343073530736307373073830739307403074130742307433074430745307463074730748307493075030751307523075330754307553075630757307583075930760307613076230763307643076530766307673076830769307703077130772307733077430775307763077730778307793078030781307823078330784307853078630787307883078930790307913079230793307943079530796307973079830799308003080130802308033080430805308063080730808308093081030811308123081330814308153081630817308183081930820308213082230823308243082530826308273082830829308303083130832308333083430835308363083730838308393084030841308423084330844308453084630847308483084930850308513085230853308543085530856308573085830859308603086130862308633086430865308663086730868308693087030871308723087330874308753087630877308783087930880308813088230883308843088530886308873088830889308903089130892308933089430895308963089730898308993090030901309023090330904309053090630907309083090930910309113091230913309143091530916309173091830919309203092130922309233092430925309263092730928309293093030931309323093330934309353093630937309383093930940309413094230943309443094530946309473094830949309503095130952309533095430955309563095730958309593096030961309623096330964309653096630967309683096930970309713097230973309743097530976309773097830979309803098130982309833098430985309863098730988309893099030991309923099330994309953099630997309983099931000310013100231003310043100531006310073100831009310103101131012310133101431015310163101731018310193102031021310223102331024310253102631027310283102931030310313103231033310343103531036310373103831039310403104131042310433104431045310463104731048310493105031051310523105331054310553105631057310583105931060310613106231063310643106531066310673106831069310703107131072310733107431075310763107731078310793108031081310823108331084310853108631087310883108931090310913109231093310943109531096310973109831099311003110131102311033110431105311063110731108311093111031111311123111331114311153111631117311183111931120311213112231123311243112531126311273112831129311303113131132311333113431135311363113731138311393114031141311423114331144311453114631147311483114931150311513115231153311543115531156311573115831159311603116131162311633116431165311663116731168311693117031171311723117331174311753117631177311783117931180311813118231183311843118531186311873118831189311903119131192311933119431195311963119731198311993120031201312023120331204312053120631207312083120931210312113121231213312143121531216312173121831219312203122131222312233122431225312263122731228312293123031231312323123331234312353123631237312383123931240312413124231243312443124531246312473124831249312503125131252312533125431255312563125731258312593126031261312623126331264312653126631267312683126931270312713127231273312743127531276312773127831279312803128131282312833128431285312863128731288312893129031291312923129331294312953129631297312983129931300313013130231303313043130531306313073130831309313103131131312313133131431315313163131731318313193132031321313223132331324313253132631327313283132931330313313133231333313343133531336313373133831339313403134131342313433134431345313463134731348313493135031351313523135331354313553135631357313583135931360313613136231363313643136531366313673136831369313703137131372313733137431375313763137731378313793138031381313823138331384313853138631387313883138931390313913139231393313943139531396313973139831399314003140131402314033140431405314063140731408314093141031411314123141331414314153141631417314183141931420314213142231423314243142531426314273142831429314303143131432314333143431435314363143731438314393144031441314423144331444314453144631447314483144931450314513145231453314543145531456314573145831459314603146131462314633146431465314663146731468314693147031471314723147331474314753147631477314783147931480314813148231483314843148531486314873148831489314903149131492314933149431495314963149731498314993150031501315023150331504315053150631507315083150931510315113151231513315143151531516315173151831519315203152131522315233152431525315263152731528315293153031531315323153331534315353153631537315383153931540315413154231543315443154531546315473154831549315503155131552315533155431555315563155731558315593156031561315623156331564315653156631567315683156931570315713157231573315743157531576315773157831579315803158131582315833158431585315863158731588315893159031591315923159331594315953159631597315983159931600316013160231603316043160531606316073160831609316103161131612316133161431615316163161731618316193162031621316223162331624316253162631627316283162931630316313163231633316343163531636316373163831639316403164131642316433164431645316463164731648316493165031651316523165331654316553165631657316583165931660316613166231663316643166531666316673166831669316703167131672316733167431675316763167731678316793168031681316823168331684316853168631687316883168931690316913169231693316943169531696316973169831699317003170131702317033170431705317063170731708317093171031711317123171331714317153171631717317183171931720317213172231723317243172531726317273172831729317303173131732317333173431735317363173731738317393174031741317423174331744317453174631747317483174931750317513175231753317543175531756317573175831759317603176131762317633176431765317663176731768317693177031771317723177331774317753177631777317783177931780317813178231783317843178531786317873178831789317903179131792317933179431795317963179731798317993180031801318023180331804318053180631807318083180931810318113181231813318143181531816318173181831819318203182131822318233182431825318263182731828318293183031831318323183331834318353183631837318383183931840318413184231843318443184531846318473184831849318503185131852318533185431855318563185731858318593186031861318623186331864318653186631867318683186931870318713187231873318743187531876318773187831879318803188131882318833188431885318863188731888318893189031891318923189331894318953189631897318983189931900319013190231903319043190531906319073190831909319103191131912319133191431915319163191731918319193192031921319223192331924319253192631927319283192931930319313193231933319343193531936319373193831939319403194131942319433194431945319463194731948319493195031951319523195331954319553195631957319583195931960319613196231963319643196531966319673196831969319703197131972319733197431975319763197731978319793198031981319823198331984319853198631987319883198931990319913199231993319943199531996319973199831999320003200132002320033200432005320063200732008320093201032011320123201332014320153201632017320183201932020320213202232023320243202532026320273202832029320303203132032320333203432035320363203732038320393204032041320423204332044320453204632047320483204932050320513205232053320543205532056320573205832059320603206132062320633206432065320663206732068320693207032071320723207332074320753207632077320783207932080320813208232083320843208532086320873208832089320903209132092320933209432095320963209732098320993210032101321023210332104321053210632107321083210932110321113211232113321143211532116321173211832119321203212132122321233212432125321263212732128321293213032131321323213332134321353213632137321383213932140321413214232143321443214532146321473214832149321503215132152321533215432155321563215732158321593216032161321623216332164321653216632167321683216932170321713217232173321743217532176321773217832179321803218132182321833218432185321863218732188321893219032191321923219332194321953219632197321983219932200322013220232203322043220532206322073220832209322103221132212322133221432215322163221732218322193222032221322223222332224322253222632227322283222932230322313223232233322343223532236322373223832239322403224132242322433224432245322463224732248322493225032251322523225332254322553225632257322583225932260322613226232263322643226532266322673226832269322703227132272322733227432275322763227732278322793228032281322823228332284322853228632287322883228932290322913229232293322943229532296322973229832299323003230132302323033230432305323063230732308323093231032311323123231332314323153231632317323183231932320323213232232323323243232532326323273232832329323303233132332323333233432335323363233732338323393234032341323423234332344323453234632347323483234932350323513235232353323543235532356323573235832359323603236132362323633236432365323663236732368323693237032371323723237332374323753237632377323783237932380323813238232383323843238532386323873238832389323903239132392323933239432395323963239732398323993240032401324023240332404324053240632407324083240932410324113241232413324143241532416324173241832419324203242132422324233242432425324263242732428324293243032431324323243332434324353243632437324383243932440324413244232443324443244532446324473244832449324503245132452324533245432455324563245732458324593246032461324623246332464324653246632467324683246932470324713247232473324743247532476324773247832479324803248132482324833248432485324863248732488324893249032491324923249332494324953249632497324983249932500325013250232503325043250532506325073250832509325103251132512325133251432515325163251732518325193252032521325223252332524325253252632527325283252932530325313253232533325343253532536325373253832539325403254132542325433254432545325463254732548325493255032551325523255332554325553255632557325583255932560325613256232563325643256532566325673256832569325703257132572325733257432575325763257732578325793258032581325823258332584325853258632587325883258932590325913259232593325943259532596325973259832599326003260132602326033260432605326063260732608326093261032611326123261332614326153261632617326183261932620326213262232623326243262532626326273262832629326303263132632326333263432635326363263732638326393264032641326423264332644326453264632647326483264932650326513265232653326543265532656326573265832659326603266132662326633266432665326663266732668326693267032671326723267332674326753267632677326783267932680326813268232683326843268532686326873268832689326903269132692326933269432695326963269732698326993270032701327023270332704327053270632707327083270932710327113271232713327143271532716327173271832719327203272132722327233272432725327263272732728327293273032731327323273332734327353273632737327383273932740327413274232743327443274532746327473274832749327503275132752327533275432755327563275732758327593276032761327623276332764327653276632767327683276932770327713277232773327743277532776327773277832779327803278132782327833278432785327863278732788327893279032791327923279332794327953279632797327983279932800328013280232803328043280532806328073280832809328103281132812328133281432815328163281732818328193282032821328223282332824328253282632827328283282932830328313283232833328343283532836328373283832839328403284132842328433284432845328463284732848328493285032851328523285332854328553285632857328583285932860328613286232863328643286532866328673286832869328703287132872328733287432875328763287732878328793288032881328823288332884328853288632887328883288932890328913289232893328943289532896328973289832899329003290132902329033290432905329063290732908329093291032911329123291332914329153291632917329183291932920329213292232923329243292532926329273292832929329303293132932329333293432935329363293732938329393294032941329423294332944329453294632947329483294932950329513295232953329543295532956329573295832959329603296132962329633296432965329663296732968329693297032971329723297332974329753297632977329783297932980329813298232983329843298532986329873298832989329903299132992329933299432995329963299732998329993300033001330023300333004330053300633007330083300933010330113301233013330143301533016330173301833019330203302133022330233302433025330263302733028330293303033031330323303333034330353303633037330383303933040330413304233043330443304533046330473304833049330503305133052330533305433055330563305733058330593306033061330623306333064330653306633067330683306933070330713307233073330743307533076330773307833079330803308133082330833308433085330863308733088330893309033091330923309333094330953309633097330983309933100331013310233103331043310533106331073310833109331103311133112331133311433115331163311733118331193312033121331223312333124331253312633127331283312933130331313313233133331343313533136331373313833139331403314133142331433314433145331463314733148331493315033151331523315333154331553315633157331583315933160331613316233163331643316533166331673316833169331703317133172331733317433175331763317733178331793318033181331823318333184331853318633187331883318933190331913319233193331943319533196331973319833199332003320133202332033320433205332063320733208332093321033211332123321333214332153321633217332183321933220332213322233223332243322533226332273322833229332303323133232332333323433235332363323733238332393324033241332423324333244332453324633247332483324933250332513325233253332543325533256332573325833259332603326133262332633326433265332663326733268332693327033271332723327333274332753327633277332783327933280332813328233283332843328533286332873328833289332903329133292332933329433295332963329733298332993330033301333023330333304333053330633307333083330933310333113331233313333143331533316333173331833319333203332133322333233332433325333263332733328333293333033331333323333333334333353333633337333383333933340333413334233343333443334533346333473334833349333503335133352333533335433355333563335733358333593336033361333623336333364333653336633367333683336933370333713337233373333743337533376333773337833379333803338133382333833338433385333863338733388333893339033391333923339333394333953339633397333983339933400334013340233403334043340533406334073340833409334103341133412334133341433415334163341733418334193342033421334223342333424334253342633427334283342933430334313343233433334343343533436334373343833439334403344133442334433344433445334463344733448334493345033451334523345333454334553345633457334583345933460334613346233463334643346533466334673346833469334703347133472334733347433475334763347733478334793348033481334823348333484334853348633487334883348933490334913349233493334943349533496334973349833499335003350133502335033350433505335063350733508335093351033511335123351333514335153351633517335183351933520335213352233523335243352533526335273352833529335303353133532335333353433535335363353733538335393354033541335423354333544335453354633547335483354933550335513355233553335543355533556335573355833559335603356133562335633356433565335663356733568335693357033571335723357333574335753357633577335783357933580335813358233583335843358533586335873358833589335903359133592335933359433595335963359733598335993360033601336023360333604336053360633607336083360933610336113361233613336143361533616336173361833619336203362133622336233362433625336263362733628336293363033631336323363333634336353363633637336383363933640336413364233643336443364533646336473364833649336503365133652336533365433655336563365733658336593366033661336623366333664336653366633667336683366933670336713367233673336743367533676336773367833679336803368133682336833368433685336863368733688336893369033691336923369333694336953369633697336983369933700337013370233703337043370533706337073370833709337103371133712337133371433715337163371733718337193372033721337223372333724337253372633727337283372933730337313373233733337343373533736337373373833739337403374133742337433374433745337463374733748337493375033751337523375333754337553375633757337583375933760337613376233763337643376533766337673376833769337703377133772337733377433775337763377733778337793378033781337823378333784337853378633787337883378933790337913379233793337943379533796337973379833799338003380133802338033380433805338063380733808338093381033811338123381333814338153381633817338183381933820338213382233823338243382533826338273382833829338303383133832338333383433835338363383733838338393384033841338423384333844338453384633847338483384933850338513385233853338543385533856338573385833859338603386133862338633386433865338663386733868338693387033871338723387333874338753387633877338783387933880338813388233883338843388533886338873388833889338903389133892338933389433895338963389733898338993390033901339023390333904339053390633907339083390933910339113391233913339143391533916339173391833919339203392133922339233392433925339263392733928339293393033931339323393333934339353393633937339383393933940339413394233943339443394533946339473394833949339503395133952339533395433955339563395733958339593396033961339623396333964339653396633967339683396933970339713397233973339743397533976339773397833979339803398133982339833398433985339863398733988339893399033991339923399333994339953399633997339983399934000340013400234003340043400534006340073400834009340103401134012340133401434015340163401734018340193402034021340223402334024340253402634027340283402934030340313403234033340343403534036340373403834039340403404134042340433404434045340463404734048340493405034051340523405334054340553405634057340583405934060340613406234063340643406534066340673406834069340703407134072340733407434075340763407734078340793408034081340823408334084340853408634087340883408934090340913409234093340943409534096340973409834099341003410134102341033410434105341063410734108341093411034111341123411334114341153411634117341183411934120341213412234123341243412534126341273412834129341303413134132341333413434135341363413734138341393414034141341423414334144341453414634147341483414934150341513415234153341543415534156341573415834159341603416134162341633416434165341663416734168341693417034171341723417334174341753417634177341783417934180341813418234183341843418534186341873418834189341903419134192341933419434195341963419734198341993420034201342023420334204342053420634207342083420934210342113421234213342143421534216342173421834219342203422134222342233422434225342263422734228342293423034231342323423334234342353423634237342383423934240342413424234243342443424534246342473424834249342503425134252342533425434255342563425734258342593426034261342623426334264342653426634267342683426934270342713427234273342743427534276342773427834279342803428134282342833428434285342863428734288342893429034291342923429334294342953429634297342983429934300343013430234303343043430534306343073430834309343103431134312343133431434315343163431734318343193432034321343223432334324343253432634327343283432934330343313433234333343343433534336343373433834339343403434134342343433434434345343463434734348343493435034351343523435334354343553435634357343583435934360343613436234363343643436534366343673436834369343703437134372343733437434375343763437734378343793438034381343823438334384343853438634387343883438934390343913439234393343943439534396343973439834399344003440134402344033440434405344063440734408344093441034411344123441334414344153441634417344183441934420344213442234423344243442534426344273442834429344303443134432344333443434435344363443734438344393444034441344423444334444344453444634447344483444934450344513445234453344543445534456344573445834459344603446134462344633446434465344663446734468344693447034471344723447334474344753447634477344783447934480344813448234483344843448534486344873448834489344903449134492344933449434495344963449734498344993450034501345023450334504345053450634507345083450934510345113451234513345143451534516345173451834519345203452134522345233452434525345263452734528345293453034531345323453334534345353453634537345383453934540345413454234543345443454534546345473454834549345503455134552345533455434555345563455734558345593456034561345623456334564345653456634567345683456934570345713457234573345743457534576345773457834579345803458134582345833458434585345863458734588345893459034591345923459334594345953459634597345983459934600346013460234603346043460534606346073460834609346103461134612346133461434615346163461734618346193462034621346223462334624346253462634627346283462934630346313463234633346343463534636346373463834639346403464134642346433464434645346463464734648346493465034651346523465334654346553465634657346583465934660346613466234663346643466534666346673466834669346703467134672346733467434675346763467734678346793468034681346823468334684346853468634687346883468934690346913469234693346943469534696346973469834699347003470134702347033470434705347063470734708347093471034711347123471334714347153471634717347183471934720347213472234723347243472534726347273472834729347303473134732347333473434735347363473734738347393474034741347423474334744347453474634747347483474934750347513475234753347543475534756347573475834759347603476134762347633476434765347663476734768347693477034771347723477334774347753477634777347783477934780347813478234783347843478534786347873478834789347903479134792347933479434795347963479734798347993480034801348023480334804348053480634807348083480934810348113481234813348143481534816348173481834819348203482134822348233482434825348263482734828348293483034831348323483334834348353483634837348383483934840348413484234843348443484534846348473484834849348503485134852348533485434855348563485734858348593486034861348623486334864348653486634867348683486934870348713487234873348743487534876348773487834879348803488134882348833488434885348863488734888348893489034891348923489334894348953489634897348983489934900349013490234903349043490534906349073490834909349103491134912349133491434915349163491734918349193492034921349223492334924349253492634927349283492934930349313493234933349343493534936349373493834939349403494134942349433494434945349463494734948349493495034951349523495334954349553495634957349583495934960349613496234963349643496534966349673496834969349703497134972349733497434975349763497734978349793498034981349823498334984349853498634987349883498934990349913499234993349943499534996349973499834999350003500135002350033500435005350063500735008350093501035011350123501335014350153501635017350183501935020350213502235023350243502535026350273502835029350303503135032350333503435035350363503735038350393504035041350423504335044350453504635047350483504935050350513505235053350543505535056350573505835059350603506135062350633506435065350663506735068350693507035071350723507335074350753507635077350783507935080350813508235083350843508535086350873508835089350903509135092350933509435095350963509735098350993510035101351023510335104351053510635107351083510935110351113511235113351143511535116351173511835119351203512135122351233512435125351263512735128351293513035131351323513335134351353513635137351383513935140351413514235143351443514535146351473514835149351503515135152351533515435155351563515735158351593516035161351623516335164351653516635167351683516935170351713517235173351743517535176351773517835179351803518135182351833518435185351863518735188351893519035191351923519335194351953519635197351983519935200352013520235203352043520535206352073520835209352103521135212352133521435215352163521735218352193522035221352223522335224352253522635227352283522935230352313523235233352343523535236352373523835239352403524135242352433524435245352463524735248352493525035251352523525335254352553525635257352583525935260352613526235263352643526535266352673526835269352703527135272352733527435275352763527735278352793528035281352823528335284352853528635287352883528935290352913529235293352943529535296352973529835299353003530135302353033530435305353063530735308353093531035311353123531335314353153531635317353183531935320353213532235323353243532535326353273532835329353303533135332353333533435335353363533735338353393534035341353423534335344353453534635347353483534935350353513535235353353543535535356353573535835359353603536135362353633536435365353663536735368353693537035371353723537335374353753537635377353783537935380353813538235383353843538535386353873538835389353903539135392353933539435395353963539735398353993540035401354023540335404354053540635407354083540935410354113541235413354143541535416354173541835419354203542135422354233542435425354263542735428354293543035431354323543335434354353543635437354383543935440354413544235443354443544535446354473544835449354503545135452354533545435455354563545735458354593546035461354623546335464354653546635467354683546935470354713547235473354743547535476354773547835479354803548135482354833548435485354863548735488354893549035491354923549335494354953549635497354983549935500355013550235503355043550535506355073550835509355103551135512355133551435515355163551735518355193552035521355223552335524355253552635527355283552935530355313553235533355343553535536355373553835539355403554135542355433554435545355463554735548355493555035551355523555335554355553555635557355583555935560355613556235563355643556535566355673556835569355703557135572355733557435575355763557735578355793558035581355823558335584355853558635587355883558935590355913559235593355943559535596355973559835599356003560135602356033560435605356063560735608356093561035611356123561335614356153561635617356183561935620356213562235623356243562535626356273562835629356303563135632356333563435635356363563735638356393564035641356423564335644356453564635647356483564935650356513565235653356543565535656356573565835659356603566135662356633566435665356663566735668356693567035671356723567335674356753567635677356783567935680356813568235683356843568535686356873568835689356903569135692356933569435695356963569735698356993570035701357023570335704357053570635707357083570935710357113571235713357143571535716357173571835719357203572135722357233572435725357263572735728357293573035731357323573335734357353573635737357383573935740357413574235743357443574535746357473574835749357503575135752357533575435755357563575735758357593576035761357623576335764357653576635767357683576935770357713577235773357743577535776357773577835779357803578135782357833578435785357863578735788357893579035791357923579335794357953579635797357983579935800358013580235803358043580535806358073580835809358103581135812358133581435815358163581735818358193582035821358223582335824358253582635827358283582935830358313583235833358343583535836358373583835839358403584135842358433584435845358463584735848358493585035851358523585335854358553585635857358583585935860358613586235863358643586535866358673586835869358703587135872358733587435875358763587735878358793588035881358823588335884358853588635887358883588935890358913589235893358943589535896358973589835899359003590135902359033590435905359063590735908359093591035911359123591335914359153591635917359183591935920359213592235923359243592535926359273592835929359303593135932359333593435935359363593735938359393594035941359423594335944359453594635947359483594935950359513595235953359543595535956359573595835959359603596135962359633596435965359663596735968359693597035971359723597335974359753597635977359783597935980359813598235983359843598535986359873598835989359903599135992359933599435995359963599735998359993600036001360023600336004360053600636007360083600936010360113601236013360143601536016360173601836019360203602136022360233602436025360263602736028360293603036031360323603336034360353603636037360383603936040360413604236043360443604536046360473604836049360503605136052360533605436055360563605736058360593606036061360623606336064360653606636067360683606936070360713607236073360743607536076360773607836079360803608136082360833608436085360863608736088360893609036091360923609336094360953609636097360983609936100361013610236103361043610536106361073610836109361103611136112361133611436115361163611736118361193612036121361223612336124361253612636127361283612936130361313613236133361343613536136361373613836139361403614136142361433614436145361463614736148361493615036151361523615336154361553615636157361583615936160361613616236163361643616536166361673616836169361703617136172361733617436175361763617736178361793618036181361823618336184361853618636187361883618936190361913619236193361943619536196361973619836199362003620136202362033620436205362063620736208362093621036211362123621336214362153621636217362183621936220362213622236223362243622536226362273622836229362303623136232362333623436235362363623736238362393624036241362423624336244362453624636247362483624936250362513625236253362543625536256362573625836259362603626136262362633626436265362663626736268362693627036271362723627336274362753627636277362783627936280362813628236283362843628536286362873628836289362903629136292362933629436295362963629736298362993630036301363023630336304363053630636307363083630936310363113631236313363143631536316363173631836319363203632136322363233632436325363263632736328363293633036331363323633336334363353633636337363383633936340363413634236343363443634536346363473634836349363503635136352363533635436355363563635736358363593636036361363623636336364363653636636367363683636936370363713637236373363743637536376363773637836379363803638136382363833638436385363863638736388363893639036391363923639336394363953639636397363983639936400364013640236403364043640536406364073640836409364103641136412364133641436415364163641736418364193642036421364223642336424364253642636427364283642936430364313643236433364343643536436364373643836439364403644136442364433644436445364463644736448364493645036451364523645336454364553645636457364583645936460364613646236463364643646536466364673646836469364703647136472364733647436475364763647736478364793648036481364823648336484364853648636487364883648936490364913649236493364943649536496364973649836499365003650136502365033650436505365063650736508365093651036511365123651336514365153651636517365183651936520365213652236523365243652536526365273652836529365303653136532365333653436535365363653736538365393654036541365423654336544365453654636547365483654936550365513655236553365543655536556365573655836559365603656136562365633656436565365663656736568365693657036571365723657336574365753657636577365783657936580365813658236583365843658536586365873658836589365903659136592365933659436595365963659736598365993660036601366023660336604366053660636607366083660936610366113661236613366143661536616366173661836619366203662136622366233662436625366263662736628366293663036631366323663336634366353663636637366383663936640366413664236643366443664536646366473664836649366503665136652366533665436655366563665736658366593666036661366623666336664366653666636667366683666936670366713667236673366743667536676366773667836679366803668136682366833668436685366863668736688366893669036691366923669336694366953669636697366983669936700367013670236703367043670536706367073670836709367103671136712367133671436715367163671736718367193672036721367223672336724367253672636727367283672936730367313673236733367343673536736367373673836739367403674136742367433674436745367463674736748367493675036751367523675336754367553675636757367583675936760367613676236763367643676536766367673676836769367703677136772367733677436775367763677736778367793678036781367823678336784367853678636787367883678936790367913679236793367943679536796367973679836799368003680136802368033680436805368063680736808368093681036811368123681336814368153681636817368183681936820368213682236823368243682536826368273682836829368303683136832368333683436835368363683736838368393684036841368423684336844368453684636847368483684936850368513685236853368543685536856368573685836859368603686136862368633686436865368663686736868368693687036871368723687336874368753687636877368783687936880368813688236883368843688536886368873688836889368903689136892368933689436895368963689736898368993690036901369023690336904369053690636907369083690936910369113691236913369143691536916369173691836919369203692136922369233692436925369263692736928369293693036931369323693336934369353693636937369383693936940369413694236943369443694536946369473694836949369503695136952369533695436955369563695736958369593696036961369623696336964369653696636967369683696936970369713697236973369743697536976369773697836979369803698136982369833698436985369863698736988369893699036991369923699336994369953699636997369983699937000370013700237003370043700537006370073700837009370103701137012370133701437015370163701737018370193702037021370223702337024370253702637027370283702937030370313703237033370343703537036370373703837039370403704137042370433704437045370463704737048370493705037051370523705337054370553705637057370583705937060370613706237063370643706537066370673706837069370703707137072370733707437075370763707737078370793708037081370823708337084370853708637087370883708937090370913709237093370943709537096370973709837099371003710137102371033710437105371063710737108371093711037111371123711337114371153711637117371183711937120371213712237123371243712537126371273712837129371303713137132371333713437135371363713737138371393714037141371423714337144371453714637147371483714937150371513715237153371543715537156371573715837159371603716137162371633716437165371663716737168371693717037171371723717337174371753717637177371783717937180371813718237183371843718537186371873718837189371903719137192371933719437195371963719737198371993720037201372023720337204372053720637207372083720937210372113721237213372143721537216372173721837219372203722137222372233722437225372263722737228372293723037231372323723337234372353723637237372383723937240372413724237243372443724537246372473724837249372503725137252372533725437255372563725737258372593726037261372623726337264372653726637267372683726937270372713727237273372743727537276372773727837279372803728137282372833728437285372863728737288372893729037291372923729337294372953729637297372983729937300373013730237303373043730537306373073730837309373103731137312373133731437315373163731737318373193732037321373223732337324373253732637327373283732937330373313733237333373343733537336373373733837339373403734137342373433734437345373463734737348373493735037351373523735337354373553735637357373583735937360373613736237363373643736537366373673736837369373703737137372373733737437375373763737737378373793738037381373823738337384373853738637387373883738937390373913739237393373943739537396373973739837399374003740137402374033740437405374063740737408374093741037411374123741337414374153741637417374183741937420374213742237423374243742537426374273742837429374303743137432374333743437435374363743737438374393744037441374423744337444374453744637447374483744937450374513745237453374543745537456374573745837459374603746137462374633746437465374663746737468374693747037471374723747337474374753747637477374783747937480374813748237483374843748537486374873748837489374903749137492374933749437495374963749737498374993750037501375023750337504375053750637507375083750937510375113751237513375143751537516375173751837519375203752137522375233752437525375263752737528375293753037531375323753337534375353753637537375383753937540375413754237543375443754537546375473754837549375503755137552375533755437555375563755737558375593756037561375623756337564375653756637567375683756937570375713757237573375743757537576375773757837579375803758137582375833758437585375863758737588375893759037591375923759337594375953759637597375983759937600376013760237603376043760537606376073760837609376103761137612376133761437615376163761737618376193762037621376223762337624376253762637627376283762937630376313763237633376343763537636376373763837639376403764137642376433764437645376463764737648376493765037651376523765337654376553765637657376583765937660376613766237663376643766537666376673766837669376703767137672376733767437675376763767737678376793768037681376823768337684376853768637687376883768937690376913769237693376943769537696376973769837699377003770137702377033770437705377063770737708377093771037711377123771337714377153771637717377183771937720377213772237723377243772537726377273772837729377303773137732377333773437735377363773737738377393774037741377423774337744377453774637747377483774937750377513775237753377543775537756377573775837759377603776137762377633776437765377663776737768377693777037771377723777337774377753777637777377783777937780377813778237783377843778537786377873778837789377903779137792377933779437795377963779737798377993780037801378023780337804378053780637807378083780937810378113781237813378143781537816378173781837819378203782137822378233782437825378263782737828378293783037831378323783337834378353783637837378383783937840378413784237843378443784537846378473784837849378503785137852378533785437855378563785737858378593786037861378623786337864378653786637867378683786937870378713787237873378743787537876378773787837879378803788137882378833788437885378863788737888378893789037891378923789337894378953789637897378983789937900379013790237903379043790537906379073790837909379103791137912379133791437915379163791737918379193792037921379223792337924379253792637927379283792937930379313793237933379343793537936379373793837939379403794137942379433794437945379463794737948379493795037951379523795337954379553795637957379583795937960379613796237963379643796537966379673796837969379703797137972379733797437975379763797737978379793798037981379823798337984379853798637987379883798937990379913799237993379943799537996379973799837999380003800138002380033800438005380063800738008380093801038011380123801338014380153801638017380183801938020380213802238023380243802538026380273802838029380303803138032380333803438035380363803738038380393804038041380423804338044380453804638047380483804938050380513805238053380543805538056380573805838059380603806138062380633806438065380663806738068380693807038071380723807338074380753807638077380783807938080380813808238083380843808538086380873808838089380903809138092380933809438095380963809738098380993810038101381023810338104381053810638107381083810938110381113811238113381143811538116381173811838119381203812138122381233812438125381263812738128381293813038131381323813338134381353813638137381383813938140381413814238143381443814538146381473814838149381503815138152381533815438155381563815738158381593816038161381623816338164381653816638167381683816938170381713817238173381743817538176381773817838179381803818138182381833818438185381863818738188381893819038191381923819338194381953819638197381983819938200382013820238203382043820538206382073820838209382103821138212382133821438215382163821738218382193822038221382223822338224382253822638227382283822938230382313823238233382343823538236382373823838239382403824138242382433824438245382463824738248382493825038251382523825338254382553825638257382583825938260382613826238263382643826538266382673826838269382703827138272382733827438275382763827738278382793828038281382823828338284382853828638287382883828938290382913829238293382943829538296382973829838299383003830138302383033830438305383063830738308383093831038311383123831338314383153831638317383183831938320383213832238323383243832538326383273832838329383303833138332383333833438335383363833738338383393834038341383423834338344383453834638347383483834938350383513835238353383543835538356383573835838359383603836138362383633836438365383663836738368383693837038371383723837338374383753837638377383783837938380383813838238383383843838538386383873838838389383903839138392383933839438395383963839738398383993840038401384023840338404384053840638407384083840938410384113841238413384143841538416384173841838419384203842138422384233842438425384263842738428384293843038431384323843338434384353843638437384383843938440384413844238443384443844538446384473844838449384503845138452384533845438455384563845738458384593846038461384623846338464384653846638467384683846938470384713847238473384743847538476384773847838479384803848138482384833848438485384863848738488384893849038491384923849338494384953849638497384983849938500385013850238503385043850538506385073850838509385103851138512385133851438515385163851738518385193852038521385223852338524385253852638527385283852938530385313853238533385343853538536385373853838539385403854138542385433854438545385463854738548385493855038551385523855338554385553855638557385583855938560385613856238563385643856538566385673856838569385703857138572385733857438575385763857738578385793858038581385823858338584385853858638587385883858938590385913859238593385943859538596385973859838599386003860138602386033860438605386063860738608386093861038611386123861338614386153861638617386183861938620386213862238623386243862538626386273862838629386303863138632386333863438635386363863738638386393864038641386423864338644386453864638647386483864938650386513865238653386543865538656386573865838659386603866138662386633866438665386663866738668386693867038671386723867338674386753867638677386783867938680386813868238683386843868538686386873868838689386903869138692386933869438695386963869738698386993870038701387023870338704387053870638707387083870938710387113871238713387143871538716387173871838719387203872138722387233872438725387263872738728387293873038731387323873338734387353873638737387383873938740387413874238743387443874538746387473874838749387503875138752387533875438755387563875738758387593876038761387623876338764387653876638767387683876938770387713877238773387743877538776387773877838779387803878138782387833878438785387863878738788387893879038791387923879338794387953879638797387983879938800388013880238803388043880538806388073880838809388103881138812388133881438815388163881738818388193882038821388223882338824388253882638827388283882938830388313883238833388343883538836388373883838839388403884138842388433884438845388463884738848388493885038851388523885338854388553885638857388583885938860388613886238863388643886538866388673886838869388703887138872388733887438875388763887738878388793888038881388823888338884388853888638887388883888938890388913889238893388943889538896388973889838899389003890138902389033890438905389063890738908389093891038911389123891338914389153891638917389183891938920389213892238923389243892538926389273892838929389303893138932389333893438935389363893738938389393894038941389423894338944389453894638947389483894938950389513895238953389543895538956389573895838959389603896138962389633896438965389663896738968389693897038971389723897338974389753897638977389783897938980389813898238983389843898538986389873898838989389903899138992389933899438995389963899738998389993900039001390023900339004390053900639007390083900939010390113901239013390143901539016390173901839019390203902139022390233902439025390263902739028390293903039031390323903339034390353903639037390383903939040390413904239043390443904539046390473904839049390503905139052390533905439055390563905739058390593906039061390623906339064390653906639067390683906939070390713907239073390743907539076390773907839079390803908139082390833908439085390863908739088390893909039091390923909339094390953909639097390983909939100391013910239103391043910539106391073910839109391103911139112391133911439115391163911739118391193912039121391223912339124391253912639127391283912939130391313913239133391343913539136391373913839139391403914139142391433914439145391463914739148391493915039151391523915339154391553915639157391583915939160391613916239163391643916539166391673916839169391703917139172391733917439175391763917739178391793918039181391823918339184391853918639187391883918939190391913919239193391943919539196391973919839199392003920139202392033920439205392063920739208392093921039211392123921339214392153921639217392183921939220392213922239223392243922539226392273922839229392303923139232392333923439235392363923739238392393924039241392423924339244392453924639247392483924939250392513925239253392543925539256392573925839259392603926139262392633926439265392663926739268392693927039271392723927339274392753927639277392783927939280392813928239283392843928539286392873928839289392903929139292392933929439295392963929739298392993930039301393023930339304393053930639307393083930939310393113931239313393143931539316393173931839319393203932139322393233932439325393263932739328393293933039331393323933339334393353933639337393383933939340393413934239343393443934539346393473934839349393503935139352393533935439355393563935739358393593936039361393623936339364393653936639367393683936939370393713937239373393743937539376393773937839379393803938139382393833938439385393863938739388393893939039391393923939339394393953939639397393983939939400394013940239403394043940539406394073940839409394103941139412394133941439415394163941739418394193942039421394223942339424394253942639427394283942939430394313943239433394343943539436394373943839439394403944139442394433944439445394463944739448394493945039451394523945339454394553945639457394583945939460394613946239463394643946539466394673946839469394703947139472394733947439475394763947739478394793948039481394823948339484394853948639487394883948939490394913949239493394943949539496394973949839499395003950139502395033950439505395063950739508395093951039511395123951339514395153951639517395183951939520395213952239523395243952539526395273952839529395303953139532395333953439535395363953739538395393954039541395423954339544395453954639547395483954939550395513955239553395543955539556395573955839559395603956139562395633956439565395663956739568395693957039571395723957339574395753957639577395783957939580395813958239583395843958539586395873958839589395903959139592395933959439595395963959739598395993960039601396023960339604396053960639607396083960939610396113961239613396143961539616396173961839619396203962139622396233962439625396263962739628396293963039631396323963339634396353963639637396383963939640396413964239643396443964539646396473964839649396503965139652396533965439655396563965739658396593966039661396623966339664396653966639667396683966939670396713967239673396743967539676396773967839679396803968139682396833968439685396863968739688396893969039691396923969339694396953969639697396983969939700397013970239703397043970539706397073970839709397103971139712397133971439715397163971739718397193972039721397223972339724397253972639727397283972939730397313973239733397343973539736397373973839739397403974139742397433974439745397463974739748397493975039751397523975339754397553975639757397583975939760397613976239763397643976539766397673976839769397703977139772397733977439775397763977739778397793978039781397823978339784397853978639787397883978939790397913979239793397943979539796397973979839799398003980139802398033980439805398063980739808398093981039811398123981339814398153981639817398183981939820398213982239823398243982539826398273982839829398303983139832398333983439835398363983739838398393984039841398423984339844398453984639847398483984939850398513985239853398543985539856398573985839859398603986139862398633986439865398663986739868398693987039871398723987339874398753987639877398783987939880398813988239883398843988539886398873988839889398903989139892398933989439895398963989739898398993990039901399023990339904399053990639907399083990939910399113991239913399143991539916399173991839919399203992139922399233992439925399263992739928399293993039931399323993339934399353993639937399383993939940399413994239943399443994539946399473994839949399503995139952399533995439955399563995739958399593996039961399623996339964399653996639967399683996939970399713997239973399743997539976399773997839979399803998139982399833998439985399863998739988399893999039991399923999339994399953999639997399983999940000400014000240003400044000540006400074000840009400104001140012400134001440015400164001740018400194002040021400224002340024400254002640027400284002940030400314003240033400344003540036400374003840039400404004140042400434004440045400464004740048400494005040051400524005340054400554005640057400584005940060400614006240063400644006540066400674006840069400704007140072400734007440075400764007740078400794008040081400824008340084400854008640087400884008940090400914009240093400944009540096400974009840099401004010140102401034010440105401064010740108401094011040111401124011340114401154011640117401184011940120401214012240123401244012540126401274012840129401304013140132401334013440135401364013740138401394014040141401424014340144401454014640147401484014940150401514015240153401544015540156401574015840159401604016140162401634016440165401664016740168401694017040171401724017340174401754017640177401784017940180401814018240183401844018540186401874018840189401904019140192401934019440195401964019740198401994020040201402024020340204402054020640207402084020940210402114021240213402144021540216402174021840219402204022140222402234022440225402264022740228402294023040231402324023340234402354023640237402384023940240402414024240243402444024540246402474024840249402504025140252402534025440255402564025740258402594026040261402624026340264402654026640267402684026940270402714027240273402744027540276402774027840279402804028140282402834028440285402864028740288402894029040291402924029340294402954029640297402984029940300403014030240303403044030540306403074030840309403104031140312403134031440315403164031740318403194032040321403224032340324403254032640327403284032940330403314033240333403344033540336403374033840339403404034140342403434034440345403464034740348403494035040351403524035340354403554035640357403584035940360403614036240363403644036540366403674036840369403704037140372403734037440375403764037740378403794038040381403824038340384403854038640387403884038940390403914039240393403944039540396403974039840399404004040140402404034040440405404064040740408404094041040411404124041340414404154041640417404184041940420404214042240423404244042540426404274042840429404304043140432404334043440435404364043740438404394044040441404424044340444404454044640447404484044940450404514045240453404544045540456404574045840459404604046140462404634046440465404664046740468404694047040471404724047340474404754047640477404784047940480404814048240483404844048540486404874048840489404904049140492404934049440495404964049740498404994050040501405024050340504405054050640507405084050940510405114051240513405144051540516405174051840519405204052140522405234052440525405264052740528405294053040531405324053340534405354053640537405384053940540405414054240543405444054540546405474054840549405504055140552405534055440555405564055740558405594056040561405624056340564405654056640567405684056940570405714057240573405744057540576405774057840579405804058140582405834058440585405864058740588405894059040591405924059340594405954059640597405984059940600406014060240603406044060540606406074060840609406104061140612406134061440615406164061740618406194062040621406224062340624406254062640627406284062940630406314063240633406344063540636406374063840639406404064140642406434064440645406464064740648406494065040651406524065340654406554065640657406584065940660406614066240663406644066540666406674066840669406704067140672406734067440675406764067740678406794068040681406824068340684406854068640687406884068940690406914069240693406944069540696406974069840699407004070140702407034070440705407064070740708407094071040711407124071340714407154071640717407184071940720407214072240723407244072540726407274072840729407304073140732407334073440735407364073740738407394074040741407424074340744407454074640747407484074940750407514075240753407544075540756407574075840759407604076140762407634076440765407664076740768407694077040771407724077340774407754077640777407784077940780407814078240783407844078540786407874078840789407904079140792407934079440795407964079740798407994080040801408024080340804408054080640807408084080940810408114081240813408144081540816408174081840819408204082140822408234082440825408264082740828408294083040831408324083340834408354083640837408384083940840408414084240843408444084540846408474084840849408504085140852408534085440855408564085740858408594086040861408624086340864408654086640867408684086940870408714087240873408744087540876408774087840879408804088140882408834088440885408864088740888408894089040891408924089340894408954089640897408984089940900409014090240903409044090540906409074090840909409104091140912409134091440915409164091740918409194092040921409224092340924409254092640927409284092940930409314093240933409344093540936409374093840939409404094140942409434094440945409464094740948409494095040951409524095340954409554095640957409584095940960409614096240963409644096540966409674096840969409704097140972409734097440975409764097740978409794098040981409824098340984409854098640987409884098940990409914099240993409944099540996409974099840999410004100141002410034100441005410064100741008410094101041011410124101341014410154101641017410184101941020410214102241023410244102541026410274102841029410304103141032410334103441035410364103741038410394104041041410424104341044410454104641047410484104941050410514105241053410544105541056410574105841059410604106141062410634106441065410664106741068410694107041071410724107341074410754107641077410784107941080410814108241083410844108541086410874108841089410904109141092410934109441095410964109741098410994110041101411024110341104411054110641107411084110941110411114111241113411144111541116411174111841119411204112141122411234112441125411264112741128411294113041131411324113341134411354113641137411384113941140411414114241143411444114541146411474114841149411504115141152411534115441155411564115741158411594116041161411624116341164411654116641167411684116941170411714117241173411744117541176411774117841179411804118141182411834118441185411864118741188411894119041191411924119341194411954119641197411984119941200412014120241203412044120541206412074120841209412104121141212412134121441215412164121741218412194122041221412224122341224412254122641227412284122941230412314123241233412344123541236412374123841239412404124141242412434124441245412464124741248412494125041251412524125341254412554125641257412584125941260412614126241263412644126541266412674126841269412704127141272412734127441275412764127741278412794128041281412824128341284412854128641287412884128941290412914129241293412944129541296412974129841299413004130141302413034130441305413064130741308413094131041311413124131341314413154131641317413184131941320413214132241323413244132541326413274132841329413304133141332413334133441335413364133741338413394134041341413424134341344413454134641347413484134941350413514135241353413544135541356413574135841359413604136141362413634136441365413664136741368413694137041371413724137341374413754137641377413784137941380413814138241383413844138541386413874138841389413904139141392413934139441395413964139741398413994140041401414024140341404414054140641407414084140941410414114141241413414144141541416414174141841419414204142141422414234142441425414264142741428414294143041431414324143341434414354143641437414384143941440414414144241443414444144541446414474144841449414504145141452414534145441455414564145741458414594146041461414624146341464414654146641467414684146941470414714147241473414744147541476414774147841479414804148141482414834148441485414864148741488414894149041491414924149341494414954149641497414984149941500415014150241503415044150541506415074150841509415104151141512415134151441515415164151741518415194152041521415224152341524415254152641527415284152941530415314153241533415344153541536415374153841539415404154141542415434154441545415464154741548415494155041551415524155341554415554155641557415584155941560415614156241563415644156541566415674156841569415704157141572415734157441575415764157741578415794158041581415824158341584415854158641587415884158941590415914159241593415944159541596415974159841599416004160141602416034160441605416064160741608416094161041611416124161341614416154161641617416184161941620416214162241623416244162541626416274162841629416304163141632416334163441635416364163741638416394164041641416424164341644416454164641647416484164941650416514165241653416544165541656416574165841659416604166141662416634166441665416664166741668416694167041671416724167341674416754167641677416784167941680416814168241683416844168541686416874168841689416904169141692416934169441695416964169741698416994170041701417024170341704417054170641707417084170941710417114171241713417144171541716417174171841719417204172141722417234172441725417264172741728417294173041731417324173341734417354173641737417384173941740417414174241743417444174541746417474174841749417504175141752417534175441755417564175741758417594176041761417624176341764417654176641767417684176941770417714177241773417744177541776417774177841779417804178141782417834178441785417864178741788417894179041791417924179341794417954179641797417984179941800418014180241803418044180541806418074180841809418104181141812418134181441815418164181741818418194182041821418224182341824418254182641827418284182941830418314183241833418344183541836418374183841839418404184141842418434184441845418464184741848418494185041851418524185341854418554185641857418584185941860418614186241863418644186541866418674186841869418704187141872418734187441875418764187741878418794188041881418824188341884418854188641887418884188941890418914189241893418944189541896418974189841899419004190141902419034190441905419064190741908419094191041911419124191341914419154191641917419184191941920419214192241923419244192541926419274192841929419304193141932419334193441935419364193741938419394194041941419424194341944419454194641947419484194941950419514195241953419544195541956419574195841959419604196141962419634196441965419664196741968419694197041971419724197341974419754197641977419784197941980419814198241983419844198541986419874198841989419904199141992419934199441995419964199741998419994200042001420024200342004420054200642007420084200942010420114201242013420144201542016420174201842019420204202142022420234202442025420264202742028420294203042031420324203342034420354203642037420384203942040420414204242043420444204542046420474204842049420504205142052420534205442055420564205742058420594206042061420624206342064420654206642067420684206942070420714207242073420744207542076420774207842079420804208142082420834208442085420864208742088420894209042091420924209342094420954209642097420984209942100421014210242103421044210542106421074210842109421104211142112421134211442115421164211742118421194212042121421224212342124421254212642127421284212942130421314213242133421344213542136421374213842139421404214142142421434214442145421464214742148421494215042151421524215342154421554215642157421584215942160421614216242163421644216542166421674216842169421704217142172421734217442175421764217742178421794218042181421824218342184421854218642187421884218942190421914219242193421944219542196421974219842199422004220142202422034220442205422064220742208422094221042211422124221342214422154221642217422184221942220422214222242223422244222542226422274222842229422304223142232422334223442235422364223742238422394224042241422424224342244422454224642247422484224942250422514225242253422544225542256422574225842259422604226142262422634226442265422664226742268422694227042271422724227342274422754227642277422784227942280422814228242283422844228542286422874228842289422904229142292422934229442295422964229742298422994230042301423024230342304423054230642307423084230942310423114231242313423144231542316423174231842319423204232142322423234232442325423264232742328423294233042331423324233342334423354233642337423384233942340423414234242343423444234542346423474234842349423504235142352423534235442355423564235742358423594236042361423624236342364423654236642367423684236942370423714237242373423744237542376423774237842379423804238142382423834238442385423864238742388423894239042391423924239342394423954239642397423984239942400424014240242403424044240542406424074240842409424104241142412424134241442415424164241742418424194242042421424224242342424424254242642427424284242942430424314243242433424344243542436424374243842439424404244142442424434244442445424464244742448424494245042451424524245342454424554245642457424584245942460424614246242463424644246542466424674246842469424704247142472424734247442475424764247742478424794248042481424824248342484424854248642487424884248942490424914249242493424944249542496424974249842499425004250142502425034250442505425064250742508425094251042511425124251342514425154251642517425184251942520425214252242523425244252542526425274252842529425304253142532425334253442535425364253742538425394254042541425424254342544425454254642547425484254942550425514255242553425544255542556425574255842559425604256142562425634256442565425664256742568425694257042571425724257342574425754257642577425784257942580425814258242583425844258542586425874258842589425904259142592425934259442595425964259742598425994260042601426024260342604426054260642607426084260942610426114261242613426144261542616426174261842619426204262142622426234262442625426264262742628426294263042631426324263342634426354263642637426384263942640426414264242643426444264542646426474264842649426504265142652426534265442655426564265742658426594266042661426624266342664426654266642667426684266942670426714267242673426744267542676426774267842679426804268142682426834268442685426864268742688426894269042691426924269342694426954269642697426984269942700427014270242703427044270542706427074270842709427104271142712427134271442715427164271742718427194272042721427224272342724427254272642727427284272942730427314273242733427344273542736427374273842739427404274142742427434274442745427464274742748427494275042751427524275342754427554275642757427584275942760427614276242763427644276542766427674276842769427704277142772427734277442775427764277742778427794278042781427824278342784427854278642787427884278942790427914279242793427944279542796427974279842799428004280142802428034280442805428064280742808428094281042811428124281342814428154281642817428184281942820428214282242823428244282542826428274282842829428304283142832428334283442835428364283742838428394284042841428424284342844428454284642847428484284942850428514285242853428544285542856428574285842859428604286142862428634286442865428664286742868428694287042871428724287342874428754287642877428784287942880428814288242883428844288542886428874288842889428904289142892428934289442895428964289742898428994290042901429024290342904429054290642907429084290942910429114291242913429144291542916 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <title>FHEM Referenz</title>
- <script type="text/javascript" src="fhemdoc.js"></script>
- <noscript>
- <link rel="stylesheet" type="text/css" href="../www/pgm2/style.css" />
- </noscript>
- <meta http-equiv="Content-type" content="text/html; charset=UTF-8">
- <link rel="shortcut icon" href="/fhem/icons/favicon.ico"/>
- </head>
- <body style="word-wrap: break-word;">
- <div id="menuScrollArea">
- <div id="logo"></div>
- <div id="menu">
- <h3>fhem.pl Referenz</h3>
- <br><br>
- <a href="#doctop">Zum Anfang</a>
- <br><br>
- <a style="display:none" href="#" name="loadAll">Komplette Doku laden</a>
- <br><br>
- <a id="otherLang" style="display:none" href="#" name="otherLang">
- <span style="display:none" lang="DE">Deutsche</span>
- <span style="display:none" lang="EN">Englische</span>
- Doku für <span class="mod"></span> laden
- </a>
- </div>
- </div>
- <div id="right">
- <a name="doctop"></a>
- <h3>Inhalt</h3>
- <div class='langLinks'>[<a href='commandref.html#doctop'>EN</a> DE]</div>
- <ul>
- <a href="#intro">Einleitung</a><br>
- <a href="#command">FHEM Befehls-Typen</a><br>
- <a href="#devspec">Geräte-Spezifikation</a><br>
- <a href="#attributes">Attribute</a><br>
- <br>
- <b>FHEM-Befehle</b>
- <ul>
- <!-- header:command -->
- <a href="#apptime">apptime</a>
- <a href="#attr">attr</a>
- <a href="#backup">backup</a>
- <a href="#cancel">cancel</a>
- <a href="#cmdalias">cmdalias</a>
- <a href="#configdb">configdb</a>
- <a href="#copy">copy</a>
- <a href="#count">count</a>
- <a href="#createlog">createlog</a>
- <a href="#CULflash">CULflash</a>
- <a href="#define">define</a>
- <a href="#defmod">defmod</a>
- <a href="#delete">delete</a>
- <a href="#deleteattr">deleteattr</a>
- <a href="#deletefile">deletefile</a>
- <a href="#deletereading">deletereading</a>
- <a href="#displayattr">displayattr</a>
- <a href="#fhemdebug">fhemdebug</a>
- <a href="#fheminfo">fheminfo</a>
- <a href="#get">get</a>
- <a href="#help">help</a>
- <a href="#HMtemplate">HMtemplate</a>
- <a href="#IF">IF</a>
- <a href="#include">include</a>
- <a href="#inform">inform</a>
- <a href="#JsonList">JsonList</a>
- <a href="#JsonList2">JsonList2</a>
- <a href="#list">list</a>
- <a href="#modify">modify</a>
- <a href="#MSG">MSG</a>
- <a href="#notice">notice</a>
- <a href="#quit">quit</a>
- <a href="#reload">reload</a>
- <a href="#rename">rename</a>
- <a href="#rereadcfg">rereadcfg</a>
- <a href="#restore">restore</a>
- <a href="#save">save</a>
- <a href="#set">set</a>
- <a href="#setdefaultattr">setdefaultattr</a>
- <a href="#setreading">setreading</a>
- <a href="#setstate">setstate</a>
- <a href="#shutdown">shutdown</a>
- <a href="#sleep">sleep</a>
- <a href="#template">template</a>
- <a href="#trigger">trigger</a>
- <a href="#update">update</a>
- <a href="#uptime">uptime</a>
- <a href="#usb">usb</a>
- <a href="#version">version</a>
- <a href="#XmlList">XmlList</a>
- </ul>
- <br>
- <b>Gerätemodule</b>
- <ul>
- <a href="#global">global</a><br>
- <!-- header:device -->
- <a href="#alexa">alexa</a>
- <a href="#ALL3076">ALL3076</a>
- <a href="#ALL4000T">ALL4000T</a>
- <a href="#ALL4027">ALL4027</a>
- <a href="#allergy">allergy</a>
- <a href="#AMAD">AMAD</a>
- <a href="#AMADCommBridge">AMADCommBridge</a>
- <a href="#AMADDevice">AMADDevice</a>
- <a href="#Aqicn">Aqicn</a>
- <a href="#ArduCounter">ArduCounter</a>
- <a href="#Aurora">Aurora</a>
- <a href="#BDKM">BDKM</a>
- <a href="#BOSEST">BOSEST</a>
- <a href="#BRAVIA">BRAVIA</a>
- <a href="#Broadlink">Broadlink</a>
- <a href="#BS">BS</a>
- <a href="#Calendar">Calendar</a>
- <a href="#CALVIEW">CALVIEW</a>
- <a href="#CM11">CM11</a>
- <a href="#CO20">CO20</a>
- <a href="#ComfoAir">ComfoAir</a>
- <a href="#CUL">CUL</a>
- <a href="#CUL_EM">CUL_EM</a>
- <a href="#CUL_FHTTK">CUL_FHTTK</a>
- <a href="#CUL_HM">CUL_HM</a>
- <a href="#CUL_HOERMANN">CUL_HOERMANN</a>
- <a href="#CUL_IR">CUL_IR</a>
- <a href="#CUL_MAX">CUL_MAX</a>
- <a href="#CUL_REDIRECT">CUL_REDIRECT</a>
- <a href="#CUL_RFR">CUL_RFR</a>
- <a href="#CUL_TCM97001">CUL_TCM97001</a>
- <a href="#CUL_TX">CUL_TX</a>
- <a href="#CUL_WS">CUL_WS</a>
- <a href="#dash_dhcp">dash_dhcp</a>
- <a href="#DBPlan">DBPlan</a>
- <a href="#DFPlayerMini">DFPlayerMini</a>
- <a href="#DLNARenderer">DLNARenderer</a>
- <a href="#Dooya">Dooya</a>
- <a href="#DUOFERN">DUOFERN</a>
- <a href="#DUOFERNSTICK">DUOFERNSTICK</a>
- <a href="#EC3000">EC3000</a>
- <a href="#ECMD">ECMD</a>
- <a href="#ECMDDevice">ECMDDevice</a>
- <a href="#EDIPLUG">EDIPLUG</a>
- <a href="#EGPM">EGPM</a>
- <a href="#EGPM2LAN">EGPM2LAN</a>
- <a href="#EIB">EIB</a>
- <a href="#EleroDrive">EleroDrive</a>
- <a href="#EleroStick">EleroStick</a>
- <a href="#EleroSwitch">EleroSwitch</a>
- <a href="#EM">EM</a>
- <a href="#EMEM">EMEM</a>
- <a href="#EMGZ">EMGZ</a>
- <a href="#EMT7110">EMT7110</a>
- <a href="#EMWZ">EMWZ</a>
- <a href="#ENECSYSGW">ENECSYSGW</a>
- <a href="#ENECSYSINV">ENECSYSINV</a>
- <a href="#ENIGMA2">ENIGMA2</a>
- <a href="#EnOcean">EnOcean</a>
- <a href="#EQ3BT">EQ3BT</a>
- <a href="#ESA2000">ESA2000</a>
- <a href="#ESPEasy">ESPEasy</a>
- <a href="#fakeRoku">fakeRoku</a>
- <a href="#FBAHA">FBAHA</a>
- <a href="#FBAHAHTTP">FBAHAHTTP</a>
- <a href="#FBDECT">FBDECT</a>
- <a href="#FHT">FHT</a>
- <a href="#FHT8V">FHT8V</a>
- <a href="#FHZ">FHZ</a>
- <a href="#FRAMEBUFFER">FRAMEBUFFER</a>
- <a href="#FReplacer">FReplacer</a>
- <a href="#FRITZBOX">FRITZBOX</a>
- <a href="#FRM">FRM</a>
- <a href="#FRM_AD">FRM_AD</a>
- <a href="#FRM_I2C">FRM_I2C</a>
- <a href="#FRM_IN">FRM_IN</a>
- <a href="#FRM_LCD">FRM_LCD</a>
- <a href="#FRM_OUT">FRM_OUT</a>
- <a href="#FRM_PWM">FRM_PWM</a>
- <a href="#FRM_RGB">FRM_RGB</a>
- <a href="#FRM_ROTENC">FRM_ROTENC</a>
- <a href="#FRM_SERVO">FRM_SERVO</a>
- <a href="#FRM_STEPPER">FRM_STEPPER</a>
- <a href="#FS20">FS20</a>
- <a href="#FTUISRV">FTUISRV</a>
- <a href="#FULLY">FULLY</a>
- <a href="#GAEBUS">GAEBUS</a>
- <a href="#GardenaSmartBridge">GardenaSmartBridge</a>
- <a href="#GardenaSmartDevice">GardenaSmartDevice</a>
- <a href="#GHoma">GHoma</a>
- <a href="#GOOGLECAST">GOOGLECAST</a>
- <a href="#harmony">harmony</a>
- <a href="#HEATRONIC">HEATRONIC</a>
- <a href="#HEOSGroup">HEOSGroup</a>
- <a href="#HEOSMaster">HEOSMaster</a>
- <a href="#HEOSPlayer">HEOSPlayer</a>
- <a href="#Hideki">Hideki</a>
- <a href="#HMCCU">HMCCU</a>
- <a href="#HMCCUCHN">HMCCUCHN</a>
- <a href="#HMCCUDEV">HMCCUDEV</a>
- <a href="#HMCCURPC">HMCCURPC</a>
- <a href="#HMCCURPCPROC">HMCCURPCPROC</a>
- <a href="#HMLAN">HMLAN</a>
- <a href="#HMS">HMS</a>
- <a href="#HMUARTLGW">HMUARTLGW</a>
- <a href="#holiday">holiday</a>
- <a href="#HOMBOT">HOMBOT</a>
- <a href="#HP1000">HP1000</a>
- <a href="#HTTPMOD">HTTPMOD</a>
- <a href="#HTTPSRV">HTTPSRV</a>
- <a href="#HUEBridge">HUEBridge</a>
- <a href="#HUEDevice">HUEDevice</a>
- <a href="#HXB">HXB</a>
- <a href="#HXBDevice">HXBDevice</a>
- <a href="#Hyperion">Hyperion</a>
- <a href="#I2C_BH1750">I2C_BH1750</a>
- <a href="#I2C_BME280">I2C_BME280</a>
- <a href="#I2C_BMP180">I2C_BMP180</a>
- <a href="#I2C_DS1307">I2C_DS1307</a>
- <a href="#I2C_EEPROM">I2C_EEPROM</a>
- <a href="#I2C_EMC1001">I2C_EMC1001</a>
- <a href="#I2C_HDC1008">I2C_HDC1008</a>
- <a href="#I2C_K30">I2C_K30</a>
- <a href="#I2C_LCD">I2C_LCD</a>
- <a href="#I2C_LM75A">I2C_LM75A</a>
- <a href="#I2C_MCP23008">I2C_MCP23008</a>
- <a href="#I2C_MCP23017">I2C_MCP23017</a>
- <a href="#I2C_MCP342x">I2C_MCP342x</a>
- <a href="#I2C_MMA845X">I2C_MMA845X</a>
- <a href="#I2C_PCA9532">I2C_PCA9532</a>
- <a href="#I2C_PCA9685">I2C_PCA9685</a>
- <a href="#I2C_PCF8574">I2C_PCF8574</a>
- <a href="#I2C_SHT21">I2C_SHT21</a>
- <a href="#I2C_SHT3x">I2C_SHT3x</a>
- <a href="#I2C_TSL2561">I2C_TSL2561</a>
- <a href="#IOhomecontrol">IOhomecontrol</a>
- <a href="#IPCAM">IPCAM</a>
- <a href="#IPWE">IPWE</a>
- <a href="#IT">IT</a>
- <a href="#Itach_IR">Itach_IR</a>
- <a href="#Itach_IRDevice">Itach_IRDevice</a>
- <a href="#Itach_Relay">Itach_Relay</a>
- <a href="#Jabber">Jabber</a>
- <a href="#JawboneUp">JawboneUp</a>
- <a href="#JeeLink">JeeLink</a>
- <a href="#JSONMETER">JSONMETER</a>
- <a href="#KeyValueProtocol">KeyValueProtocol</a>
- <a href="#km200">km200</a>
- <a href="#KM273">KM273</a>
- <a href="#KNX">KNX</a>
- <a href="#KODI">KODI</a>
- <a href="#KOPP_FC">KOPP_FC</a>
- <a href="#KOSTALPIKO">KOSTALPIKO</a>
- <a href="#KS300">KS300</a>
- <a href="#LaCrosse">LaCrosse</a>
- <a href="#LaCrosseGateway">LaCrosseGateway</a>
- <a href="#Level">Level</a>
- <a href="#LGTV">LGTV</a>
- <a href="#LGTV_IP12">LGTV_IP12</a>
- <a href="#LGTV_WebOS">LGTV_WebOS</a>
- <a href="#LIGHTIFY">LIGHTIFY</a>
- <a href="#LINDY_HDMI_SWITCH">LINDY_HDMI_SWITCH</a>
- <a href="#LIRC">LIRC</a>
- <a href="#LuftdatenInfo">LuftdatenInfo</a>
- <a href="#LUXTRONIK2">LUXTRONIK2</a>
- <a href="#M232">M232</a>
- <a href="#M232Counter">M232Counter</a>
- <a href="#M232Voltage">M232Voltage</a>
- <a href="#mailcheck">mailcheck</a>
- <a href="#MAX">MAX</a>
- <a href="#MAXLAN">MAXLAN</a>
- <a href="#MEDIAPORTAL">MEDIAPORTAL</a>
- <a href="#MilightBridge">MilightBridge</a>
- <a href="#MilightDevice">MilightDevice</a>
- <a href="#MOBILEALERTS">MOBILEALERTS</a>
- <a href="#MOBILEALERTSGW">MOBILEALERTSGW</a>
- <a href="#Modbus">Modbus</a>
- <a href="#ModbusAttr">ModbusAttr</a>
- <a href="#ModbusSET">ModbusSET</a>
- <a href="#ModbusTrovis5576">ModbusTrovis5576</a>
- <a href="#MPD">MPD</a>
- <a href="#MQTT">MQTT</a>
- <a href="#MQTT_BRIDGE">MQTT_BRIDGE</a>
- <a href="#MQTT_DEVICE">MQTT_DEVICE</a>
- <a href="#MSGFile">MSGFile</a>
- <a href="#MSGMail">MSGMail</a>
- <a href="#MYSENSORS">MYSENSORS</a>
- <a href="#MYSENSORS_DEVICE">MYSENSORS_DEVICE</a>
- <a href="#N4HBUS">N4HBUS</a>
- <a href="#N4HMODULE">N4HMODULE</a>
- <a href="#Nello">Nello</a>
- <a href="#netatmo">netatmo</a>
- <a href="#NetIO230B">NetIO230B</a>
- <a href="#Netzer">Netzer</a>
- <a href="#NetzerI2C">NetzerI2C</a>
- <a href="#NEUTRINO">NEUTRINO</a>
- <a href="#Nextion">Nextion</a>
- <a href="#Nmap">Nmap</a>
- <a href="#NotifyAndroidTV">NotifyAndroidTV</a>
- <a href="#NUKIBridge">NUKIBridge</a>
- <a href="#NUKIDevice">NUKIDevice</a>
- <a href="#NUT">NUT</a>
- <a href="#OBIS">OBIS</a>
- <a href="#ONKYO_AVR">ONKYO_AVR</a>
- <a href="#ONKYO_AVR_ZONE">ONKYO_AVR_ZONE</a>
- <a href="#OPENWEATHER">OPENWEATHER</a>
- <a href="#OREGON">OREGON</a>
- <a href="#OWAD">OWAD</a>
- <a href="#OWCOUNT">OWCOUNT</a>
- <a href="#OWDevice">OWDevice</a>
- <a href="#OWFS">OWFS</a>
- <a href="#OWID">OWID</a>
- <a href="#OWLCD">OWLCD</a>
- <a href="#OWMULTI">OWMULTI</a>
- <a href="#OWServer">OWServer</a>
- <a href="#OWSWITCH">OWSWITCH</a>
- <a href="#OWTEMP">OWTEMP</a>
- <a href="#OWTHERM">OWTHERM</a>
- <a href="#OWVAR">OWVAR</a>
- <a href="#OWX">OWX</a>
- <a href="#OWX_ASYNC">OWX_ASYNC</a>
- <a href="#OWX_CCC">OWX_CCC</a>
- <a href="#OWX_FRM">OWX_FRM</a>
- <a href="#OWX_SER">OWX_SER</a>
- <a href="#OWX_TCP">OWX_TCP</a>
- <a href="#panStamp">panStamp</a>
- <a href="#PCA301">PCA301</a>
- <a href="#PHILIPS_AUDIO">PHILIPS_AUDIO</a>
- <a href="#PHTV">PHTV</a>
- <a href="#PID20">PID20</a>
- <a href="#PIFACE">PIFACE</a>
- <a href="#pilight">pilight</a>
- <a href="#pilight_contact">pilight_contact</a>
- <a href="#pilight_ctrl">pilight_ctrl</a>
- <a href="#pilight_dimmer">pilight_dimmer</a>
- <a href="#pilight_raw">pilight_raw</a>
- <a href="#pilight_smoke">pilight_smoke</a>
- <a href="#pilight_switch">pilight_switch</a>
- <a href="#pilight_temp">pilight_temp</a>
- <a href="#ping">ping</a>
- <a href="#PIONEERAVR">PIONEERAVR</a>
- <a href="#PIONEERAVRZONE">PIONEERAVRZONE</a>
- <a href="#PiXtendV2">PiXtendV2</a>
- <a href="#PLAYBULB">PLAYBULB</a>
- <a href="#plex">plex</a>
- <a href="#Plugwise">Plugwise</a>
- <a href="#POKEYS">POKEYS</a>
- <a href="#PrecipitationSensor">PrecipitationSensor</a>
- <a href="#PROPLANTA">PROPLANTA</a>
- <a href="#Pushalot">Pushalot</a>
- <a href="#Pushbullet">Pushbullet</a>
- <a href="#PushNotifier">PushNotifier</a>
- <a href="#Pushover">Pushover</a>
- <a href="#Pushsafer">Pushsafer</a>
- <a href="#PW_Circle">PW_Circle</a>
- <a href="#PW_Scan">PW_Scan</a>
- <a href="#PW_Sense">PW_Sense</a>
- <a href="#PW_Switch">PW_Switch</a>
- <a href="#PWM">PWM</a>
- <a href="#PWMR">PWMR</a>
- <a href="#QRCode">QRCode</a>
- <a href="#Revolt">Revolt</a>
- <a href="#RFXCOM">RFXCOM</a>
- <a href="#RFXMETER">RFXMETER</a>
- <a href="#RFXX10REC">RFXX10REC</a>
- <a href="#Robonect">Robonect</a>
- <a href="#RPI_GPIO">RPI_GPIO</a>
- <a href="#RPII2C">RPII2C</a>
- <a href="#rssFeed">rssFeed</a>
- <a href="#S7">S7</a>
- <a href="#S7_ARead">S7_ARead</a>
- <a href="#S7_AWrite">S7_AWrite</a>
- <a href="#S7_Client">S7_Client</a>
- <a href="#S7_DRead">S7_DRead</a>
- <a href="#S7_DWrite">S7_DWrite</a>
- <a href="#S7_S5Client">S7_S5Client</a>
- <a href="#S7_S7Client">S7_S7Client</a>
- <a href="#SCIVT">SCIVT</a>
- <a href="#SD_RSL">SD_RSL</a>
- <a href="#SD_WS">SD_WS</a>
- <a href="#SD_WS07">SD_WS07</a>
- <a href="#SD_WS09">SD_WS09</a>
- <a href="#SD_WS_Maverick">SD_WS_Maverick</a>
- <a href="#SHC">SHC</a>
- <a href="#SHCdev">SHCdev</a>
- <a href="#SIGNALduino">SIGNALduino</a>
- <a href="#SIGNALduino_un">SIGNALduino_un</a>
- <a href="#siri">siri</a>
- <a href="#Siro">Siro</a>
- <a href="#SIS_PMS">SIS_PMS</a>
- <a href="#SISPM">SISPM</a>
- <a href="#SMAEM">SMAEM</a>
- <a href="#SMAInverter">SMAInverter</a>
- <a href="#SmartMeterP1">SmartMeterP1</a>
- <a href="#SMARTMON">SMARTMON</a>
- <a href="#SmartPi">SmartPi</a>
- <a href="#SMASTP">SMASTP</a>
- <a href="#SML">SML</a>
- <a href="#Snapcast">Snapcast</a>
- <a href="#SOMFY">SOMFY</a>
- <a href="#SONOS">SONOS</a>
- <a href="#SONOSPLAYER">SONOSPLAYER</a>
- <a href="#speedtest">speedtest</a>
- <a href="#Spotify">Spotify</a>
- <a href="#SSCam">SSCam</a>
- <a href="#STACKABLE">STACKABLE</a>
- <a href="#STACKABLE_CC">STACKABLE_CC</a>
- <a href="#STOCKQUOTES">STOCKQUOTES</a>
- <a href="#STV">STV</a>
- <a href="#SWAP">SWAP</a>
- <a href="#SWAP_0000002200000003">SWAP_0000002200000003</a>
- <a href="#SWAP_0000002200000008">SWAP_0000002200000008</a>
- <a href="#SYSMON">SYSMON</a>
- <a href="#SYSSTAT">SYSSTAT</a>
- <a href="#tahoma">tahoma</a>
- <a href="#TBot_List">TBot_List</a>
- <a href="#TCM">TCM</a>
- <a href="#TechemHKV">TechemHKV</a>
- <a href="#TechemWZ">TechemWZ</a>
- <a href="#TEK603">TEK603</a>
- <a href="#TelegramBot">TelegramBot</a>
- <a href="#TellStick">TellStick</a>
- <a href="#TeslaPowerwall2AC">TeslaPowerwall2AC</a>
- <a href="#THINKINGCLEANER">THINKINGCLEANER</a>
- <a href="#THZ">THZ</a>
- <a href="#TPLinkHS110">TPLinkHS110</a>
- <a href="#TRAFFIC">TRAFFIC</a>
- <a href="#TRX">TRX</a>
- <a href="#TRX_ELSE">TRX_ELSE</a>
- <a href="#TRX_LIGHT">TRX_LIGHT</a>
- <a href="#TRX_SECURITY">TRX_SECURITY</a>
- <a href="#TRX_WEATHER">TRX_WEATHER</a>
- <a href="#TUL">TUL</a>
- <a href="#UbiquitiMP">UbiquitiMP</a>
- <a href="#UbiquitiOut">UbiquitiOut</a>
- <a href="#Unifi">Unifi</a>
- <a href="#UnifiVideo">UnifiVideo</a>
- <a href="#UNIRoll">UNIRoll</a>
- <a href="#UpsPico">UpsPico</a>
- <a href="#USBWX">USBWX</a>
- <a href="#USF1000">USF1000</a>
- <a href="#UWZ">UWZ</a>
- <a href="#Vallox">Vallox</a>
- <a href="#VantagePro2">VantagePro2</a>
- <a href="#VBUSDEV">VBUSDEV</a>
- <a href="#VBUSIF">VBUSIF</a>
- <a href="#VCONTROL">VCONTROL</a>
- <a href="#Verkehrsinfo">Verkehrsinfo</a>
- <a href="#VIERA">VIERA</a>
- <a href="#VolumeLink">VolumeLink</a>
- <a href="#Weather">Weather</a>
- <a href="#WEBCOUNT">WEBCOUNT</a>
- <a href="#WEBIO">WEBIO</a>
- <a href="#WEBIO_12DIGITAL">WEBIO_12DIGITAL</a>
- <a href="#WifiLight">WifiLight</a>
- <a href="#WINCONNECT">WINCONNECT</a>
- <a href="#withings">withings</a>
- <a href="#WMBUS">WMBUS</a>
- <a href="#WS2000">WS2000</a>
- <a href="#WS300">WS300</a>
- <a href="#WS3600">WS3600</a>
- <a href="#Wunderground">Wunderground</a>
- <a href="#WWO">WWO</a>
- <a href="#X10">X10</a>
- <a href="#XBMC">XBMC</a>
- <a href="#XiaomiBTLESens">XiaomiBTLESens</a>
- <a href="#XiaomiDevice">XiaomiDevice</a>
- <a href="#XiaomiFlowerSens">XiaomiFlowerSens</a>
- <a href="#xs1Bridge">xs1Bridge</a>
- <a href="#xs1Dev">xs1Dev</a>
- <a href="#xxLG7000">xxLG7000</a>
- <a href="#YAMAHA_AVR">YAMAHA_AVR</a>
- <a href="#YAMAHA_BD">YAMAHA_BD</a>
- <a href="#YAMAHA_NP">YAMAHA_NP</a>
- <a href="#yowsup">yowsup</a>
- <a href="#ZWave">ZWave</a>
- <a href="#ZWCUL">ZWCUL</a>
- <a href="#ZWDongle">ZWDongle</a>
- </ul>
- <br>
- <b>Hilfs (Erweiterungs-) Module</b>
- <ul>
- <!-- header:helper -->
- <a href="#Alarm">Alarm</a>
- <a href="#alarmclock">alarmclock</a>
- <a href="#allowed">allowed</a>
- <a href="#archetype">archetype</a>
- <a href="#Astro">Astro</a>
- <a href="#at">at</a>
- <a href="#autocreate">autocreate</a>
- <a href="#average">average</a>
- <a href="#Babble">Babble</a>
- <a href="#cloneDummy">cloneDummy</a>
- <a href="#configDB">configDB</a>
- <a href="#CustomReadings">CustomReadings</a>
- <a href="#Dashboard">Dashboard</a>
- <a href="#DbLog">DbLog</a>
- <a href="#DbRep">DbRep</a>
- <a href="#dewpoint">dewpoint</a>
- <a href="#DOIF">DOIF</a>
- <a href="#DOIFtools">DOIFtools</a>
- <a href="#dummy">dummy</a>
- <a href="#ElectricityCalculator">ElectricityCalculator</a>
- <a href="#eventTypes">eventTypes</a>
- <a href="#expandJSON">expandJSON</a>
- <a href="#FB_CALLLIST">FB_CALLLIST</a>
- <a href="#FB_CALLMONITOR">FB_CALLMONITOR</a>
- <a href="#FHEM2FHEM">FHEM2FHEM</a>
- <a href="#FHEMWEB">FHEMWEB</a>
- <a href="#FileLog">FileLog</a>
- <a href="#FLOORPLAN">FLOORPLAN</a>
- <a href="#freezemon">freezemon</a>
- <a href="#GasCalculator">GasCalculator</a>
- <a href="#GEOFANCY">GEOFANCY</a>
- <a href="#GoogleAuth">GoogleAuth</a>
- <a href="#GUEST">GUEST</a>
- <a href="#HCS">HCS</a>
- <a href="#Heating_Control">Heating_Control</a>
- <a href="#HMinfo">HMinfo</a>
- <a href="#HOMEMODE">HOMEMODE</a>
- <a href="#HourCounter">HourCounter</a>
- <a href="#InfoPanel">InfoPanel</a>
- <a href="#KM271">KM271</a>
- <a href="#LightScene">LightScene</a>
- <a href="#Log2Syslog">Log2Syslog</a>
- <a href="#logProxy">logProxy</a>
- <a href="#MaxScanner">MaxScanner</a>
- <a href="#MediaList">MediaList</a>
- <a href="#monitoring">monitoring</a>
- <a href="#msgConfig">msgConfig</a>
- <a href="#msgDialog">msgDialog</a>
- <a href="#notify">notify</a>
- <a href="#PachLog">PachLog</a>
- <a href="#PostMe">PostMe</a>
- <a href="#powerMap">powerMap</a>
- <a href="#PRESENCE">PRESENCE</a>
- <a href="#rain">rain</a>
- <a href="#RandomTimer">RandomTimer</a>
- <a href="#readingsChange">readingsChange</a>
- <a href="#readingsGroup">readingsGroup</a>
- <a href="#readingsHistory">readingsHistory</a>
- <a href="#readingsProxy">readingsProxy</a>
- <a href="#remotecontrol">remotecontrol</a>
- <a href="#RESIDENTS">RESIDENTS</a>
- <a href="#RFHEM">RFHEM</a>
- <a href="#ROOMMATE">ROOMMATE</a>
- <a href="#RSS">RSS</a>
- <a href="#sequence">sequence</a>
- <a href="#SingleFileLog">SingleFileLog</a>
- <a href="#SIP">SIP</a>
- <a href="#statistics">statistics</a>
- <a href="#structure">structure</a>
- <a href="#SUNRISE_EL">SUNRISE_EL</a>
- <a href="#SVG">SVG</a>
- <a href="#Talk2Fhem">Talk2Fhem</a>
- <a href="#telnet">telnet</a>
- <a href="#Text2Speech">Text2Speech</a>
- <a href="#THRESHOLD">THRESHOLD</a>
- <a href="#TrashCal">TrashCal</a>
- <a href="#Twilight">Twilight</a>
- <a href="#Utils">Utils</a>
- <a href="#watchdog">watchdog</a>
- <a href="#WaterCalculator">WaterCalculator</a>
- <a href="#weblink">weblink</a>
- <a href="#WeekdayTimer">WeekdayTimer</a>
- <a href="#weekprofile">weekprofile</a>
- <a href="#WOL">WOL</a>
- <a href="#WUup">WUup</a>
- <a href="#YAAHM">YAAHM</a>
- </ul>
- <br>
- <a href="#perl">PERL Besonderheiten</a><br>
- <a href="#gnuplot-syntax">gnuplot file Syntax</a><br>
- </ul>
- <a name="intro"></a>
- <h3>Einleitung</h3>
- <div class='langLinks'>[<a href='commandref.html#intro'>EN</a> DE]</div>
- <ul>
- <p>FHEM wird hauptsächlich zur Heimautomatisierung benutzt,
- ist aber ebenso für andere Aufgaben einsetzbar wo Benachrichtigungen,
- Zeitschaltungen und Datensammlungen eine wichtige Rolle spielen.</p>
- <p>FHEM unterstützt verschiedene Hardwaregeräte die eine
- Verbindung mittels unterschiedlicher Protokolle (z.B. FHZ1000 mit Interfaces vom
- Typ FS20 und HMS, CM11 um mit X10 zu arbeiten) sowie logischer Geräte wie FS20
- oder FHT die einen Nachrichtenaustausch mit verschiedensten Geräten die diese
- Protokolle verwenden ermöglichen.</p>
- <p>
- FHEM ist modular. Abhängig von den unterschiedlichen Geräten werden in den
- Modulen verschiedene Funktionen (z.B. define, get, set) realisiert. FHEM enthält
- weitere Funktionen wie Trigger (<a href="#notify">notify</a>),
- Zeitabhängige Funktionen (<a href="#at">at</a>)
- die die Funktionalität erweitern.</p>
- <p>
- FHEM wird entweder über einfache ASCII-Kommandozeilen gesteuert die in Dateien
- wie z.B. der Konfigurationsdatei fhem.cfg gespeichert sind oder über eine TCP/IP
- Verbindung, entweder direkt in einer "telnet"-Sitzung, oder per fhem.pl im
- Client-Modus oder über eines der Webfrontends.<br> </p>
- <p class="MsoNormal">Wenn Sie den FHEM-Server starten, müssen Sie eine
- Konfigurationsdatei auswählen:</p>
- <ul>
- <code>perl fhem.pl fhem.cfg</code>
- </ul>
- <p>Nachstehend eine Minimal-Konfiguration Datei: </p><pre>
- attr global <a href="#logfile">logfile</a> log/fhem.log
- attr global <a href="#modpath">modpath</a> .
- attr global <a href="#statefile">statefile</a> log/fhem.save
- attr global <a href="#verbose">verbose</a> 3
- define telnetPort <a href="#telnet">telnet</a> 7072 global
- define WEB <a href="#FHEMWEB">FHEMWEB</a> 8083 global</pre>
- Die letzten zwei Zeilen definieren einen telnet und einen WEB Zugang, beide können aber
- bei Bedarf auch abgeschaltet werden.<br><br>
- Die WEB Schnittstelle kann über
- <ul>
- http://<fhemhost>:8083
- </ul>
- erreicht werden.
- <br><br>
- Die Kommunikation mit FHEM kann entweder in einer "session" (über telnet) oder
- über einzelne Klient-Kommandos (über fhem.pl) erfolgen. Beispiel:
- <ul>
- <code>telnet <fhemhost> 7072<br>
- <NL> </code>(Die Betätigung der "Enter"-Taste schaltet in den "prompt"
- Modus)<code><br>
- <command>...<br>
- quit</code><br>
- </ul>
- oder
- <ul>
- <code>fhem.pl <fhemhost>:7072 "<command>..."</code>
- </ul>
- <br>
- Falls FHEM als root gestartet wurde, und ein OS-Benutzer fhem existiert, dann
- wechselt FHEM nach dem start zu diesem Benutzer (via setuid). <br>
- </ul>
- <br>
- <!-- intro end - diese Zeile nicht entfernen! -->
- <a name="command"></a>
- <h3>FHEM Befehlstypen</h3>
- <div class='langLinks'>[<a href='commandref.html#command'>EN</a> DE]</div>
- <ul>
- Es gibt drei Arten von Befehlen: "fhem" Befehle (werden in diesem Dokument
- beschrieben), SHELL-Befehle (diese müssen von doppelten
- Anführungszeichen "" eingeschlossen werden) und PERL-Ausdrücken (von
- geschwungenen Klammern {} eingeschlossen). SHELL-Befehle oder
- PERL-Ausdrücke werden für komplexe <a href="#at">at</a> oder <a
- href="#notify">notify</a> Ausdrücke benötigt, können aber auch
- als "normale" Befehle angewendet werden.
- <br>
- <br>
- Die folgenden drei Befehle bewirken z.B. dasselbe Ergebnis, wenn sie am
- telnet-Prompt eingegeben werden:
- <ul>
- set lamp off<br>
- "fhem.pl 7072 "set lamp off""<br>
- {fhem("set lamp off")}<br>
- </ul>
- SHELL-Kommandos werden im Hintergrund ausgeführt,
- PERL-Ausdrücke und FHEM-Kommandos werden im Haupt-"thread" ausgeführt. Um
- PERL-Ausdrücke leichter eingeben zu können, sind einige Spezialfunktionen und
- Variablen verfügbar. Lesen Sie sich bitte die Abschnitte <a href="#perl">
- Perl special</a> zum besseren Verständnis durch.</p>
- <p>Um FHEM-Befehle in einen SHELL-Script zu triggern (dies ist
- eine "andere" Möglichkeit), benutzen Sie bitte die oben beschriebene Client-Form
- der fhem.pl.
- <br>
- Mehrere FHEM-Kommandos hintereinander werden mittels
- Semikolon (;) getrennt. Weil Semikola auch in PERL-Code oder SHELL-Programmen
- benutzt werden, müssen sie mittels doppelten Semikola geschützt werden. Lesen
- Sie sich bitte die <b>Bermerkungen </b>des <a href="#notify">notify</a>-Abschnittes zu Kommandoparametern und Regeln durch.
- <br>
- Z.B. schaltet die erste der folgenden Befehlszeilen die Lampe 1 nur/erst zur
- Uhrzeit 07:00 Uhr aus, die Lampe 2 aber sofort und die zweite Befehlszeile
- schaltet Lampe 1 und 2 um 7:00 Uhr gleichzeitig aus.
- <ul>
- define lampoff at 07:00 set Lamp1 off; set Lamp2 off<br>
- define lampoff at 07:00 set Lamp1 off;; set Lamp2 off<br>
- </ul>
- <br>
- Für jede weitere Indirektion muss man die Strichpunkte verdoppeln. Um also die beiden Lampen um 7:00 für 10 Minuten einzuschalten schreibt man:
- <ul>
- define onAt at 07:00 set Lamp1 on;;set Lamp2 on;; define offAt at +00:10 set Lamp1 off;;;;set Lamp2 off
- </ul>
- Keine Angst, das Vorherige kann in FHEM auch deutlich einfacher formuliert werden als:
- <ul>
- define onAt at 07:00 set Lamp1,Lamp2 on-for-timer 600
- </ul>
- <br>
- Befehle können entweder direkt eingegeben oder aus einer Datei (z.B. am
- Start von FHEM aus der Konfugurationsdatei) eingelesen werden. Die Befehle
- werden entweder direkt ausgeführt oder später wenn sie als Argumente
- eines <a href="#at">at</a> oder <a href="#notify">notify</a>-Befehles verwendet
- werden.
- <p>Eine mit einem \ abgeschlossene Zeile wird mit der
- nachfolgenden Zeile verbunden. Somit können lange Befehlszeilen (die z.B. aus
- mehreren PERL-Befehlen bestehen) auf mehrere Zeilen aufgteilt werden. Einige
- Web-Frontends (z.B. webpgm2) erleichtern die Eingabe von sich über mehrere
- Zeilen erstreckende Befehle, indem man keine \ am Zeilenende eingeben muss.</p>
- <p> </p>
- </ul>
- <!-- command end - diese Zeile nicht entfernen! -->
- <a name="devspec"></a>
- <h3>Geräte-Spezifikation (devspec)</h3>
- <div class='langLinks'>[<a href='commandref.html#devspec'>EN</a> DE]</div>
- <ul>
- Die Befehle
- <a href="#attr">attr</a>,
- <a href="#set">set</a>,
- <a href="#get">get</a>, usw.
- <a href="#attr">attr</a>,
- <a href="#deleteattr">deleteattr</a>,
- <a href="#displayattr">displayattr</a>,
- <a href="#delete">delete</a>,
- <a href="#get">get</a>,
- <a href="#list">list</a>,
- <a href="#set">set</a>,
- <a href="#setreading">setreading</a>,
- <a href="#setstate">setstate</a>,
- <a href="#trigger">trigger</a>
- können eine komplexere Gerätespezifikation als Argumente enthalten,
- die auch eine Anzahl von Geräten betreffen kann. Eine
- Gerätespezifikation kann folgendes sein:
- <ul>
- <li>ein einzelner Gerätename. Dies ist der Normalfall</li>
- <li>eine durch Komma(,) getrennte Liste von Gerätenamen</li>
- <li>ein regulärer Ausdruck</li>
- <li>ein NAME=WERT Ausdruck, wo NAME ein "Internal" Wert wie TYPE ist, ein
- Reading-Name oder ein Attribut. WERT ist ein regulärer Ausdruck.
- Um die Bedingung zu negieren, muss NAME!=WERT verwendet werden.
- Um die Suche einzugrenzen, kann man als Praefix i: für internal
- Werte, r: für Reading-Namen und a: für Attribute verwenden,
- siehe das Beispiel unten. Groß-/Kleinschreibung wird durch die
- Verwendung von ~ oder !~ ignoriert.
- </li>
- <li>Falls die Spezifikation von :FILTER=NAME=WERT gefolgt wird,
- dann wird die zuvor gefundene Liste durch diesen neuen Ausdruck
- gefiltert.
- </ul>
- Beispiele:
- <ul>
- <code>set lamp1 on</code><br>
- <code>set lamp1,lamp2,lamp3 on</code><br>
- <code>set lamp.* on</code><br>
- <code>set room=kitchen off</code><br>
- <code>set room=kitchen:FILTER=STATE=on off</code><br>
- <code>set room=kitchen:FILTER=STATE!=off off</code><br>
- <code>list disabled=</code><br>
- <code>list room~office</code><br>
- <code>list TYPE=FS20 STATE</code><br>
- <code>list i:TYPE=FS20 STATE</code><br>
- </ul>
- Bemerkungen:
- <ul>
- <li>die Spezifikation kann keine Leerzeichen enthalten.</li>
- <li>falls ein Gerätename exakt dem Spezifikation entspricht, dann werden
- keine reguläre Ausdrücke oder Filter ausgewertet.
- <li>zuerst wird die durch Komma getrennte Spezifikation abgearbeitet, dann
- folgen die regulären Ausdrücke und die Filter</li>
- <li>die Befehlszeile kann die selbe Gerätebezeichnung mehrfach enthalten
- z.B.: "set lamp3,lamp3 on". Lamp3 wird hier zwei Mal
- eingeschalten.</li>
- <li>um Strukturen mit komplexeren Anforderungen zu realisieren lesen Sie
- bitte den Abschnitt zu <a href="#structure"> structure</a>.
- </ul>
- </ul>
- <!-- devspec end - diese Zeile nicht entfernen! -->
- <a name="attributes"></a>
- <h3>Attribute</h3>
- <div class='langLinks'>[<a href='commandref.html#attributes'>EN</a> DE]</div>
- Alle Geräte haben Attribute. Diese werden mittels des Befehls <a
- href="#attr">attr</a> gesetzt, angezeigt mit dem Befehl <a
- href="#displayattr">displayattr</a>, und mit dem Kommando <a
- href="#deleteattr">deleteattr</a> entfernt.<p>
- Es gibt globale Attribute, die von allen Geräten genutzt werden, und lokale
- Attribute, die nur auf individuelle Geräteklassen zutreffen.<p>
- Manche Geräte (wie <a href="#FHEMWEB">FHEMWEB</a>) definieren automatisch
- neue globale Attribute bei der ersten Definition eines Gerätes dieses
- Typs.<p>
- Sie können den Befehl<p><code>attr global userattr
- <attributelist></code><p> für das Gerät <a
- href="#global">global</a> verwenden, um neue globale Attribute zu deklarieren,
- und <p><code>attr <devicespec> userattr
- <attributelist></code>,<p>um neue lokale Attribute für bestimmte
- individuelle Geräte gemäß <a href="#devspec">devspec</a> zu
- deklarieren.
- <code><attributelist></code> ist eine durch Leerzeichen getrennte Liste,
- die die Namen der zusätzlichen Attribute enthält. In der
- Dokumentation zum Befehl <a href="#attr">attr</a> sind Beispiele.<p>
- Seien Sie vorsichtig und überschreiben Sie keine zusätzlichen
- globale Attribute, die bereits zuvor durch Sie selbst oder ein Gerät
- definiert wurden. <code>attr global userattr <attributelist></code>
- sollte so früh wie möglich in der Konfiguration erscheinen.
- <h4>Gerätespezifische Attribute</h4>
- Gerätespezifische Attribute sind in dem jeweiligen Abschnitt zum
- Gerät dokumentiert.
- <h4>Globale Attribute für alle Geräte</h4>
-
- <ul>
- <a name="alias"></a>
- <li>alias<br>
- Wird in FHEMWEB benutzt, um ein en anderen Namen für ein Gerät
- anzuzeigen z.B. wenn Sonderzeichen/Leerzeichen nicht in der
- Gerätedefinition verwendet werden können.
- </li><br>
- <a name="comment"></a>
- <li>comment<br>
- Fügt einen beliebigen Kommentar hinzu.
- </li><br>
- <a name="eventMap"></a>
- <li>eventMap<br>
- Ersetze Event Namen und setze Argumente. Der Wert dieses Attributes
- besteht aus einer Liste von durch Leerzeichen getrennte Werten. Jeder
- Wert ist ein durch Doppelpunkt getrenntes Paar. Der erste Teil stellt den
- "alten" Wert, der zweite Teil den "neuen" Wert dar. Wenn der erste Wert
- ein Slash (/) oder ein Komma (,) ist, dann wird nicht durch Leerzeichen
- sondern durch das vorgestellte Zeichen getrennt.
- Optional kann man auch ein widgetOverride angeben (angehängt nach
- einem Doppelpunkt (z.Bsp. on-for-timer:OnFor:texField). Die
- Voreinstellung ist :noArg, um das Input Feld bei cmdList zu vermeiden.
- Beispiele:
- <ul><code>
- attr store eventMap on:open off:closed<br>
- attr store eventMap /on-for-timer 10:open/off:closed/<br>
- set store open
- </code></ul>
- Die explizite Variante dieses Attributes hat folgenden Syntax:
- <ul><code>
- attr store eventMap { dev=>{'on'=>'open'}, usr=>{'open'=>'on'} }<br>
- attr store eventMap { dev=>{'^on(-for-timer)?(.*)'=>'open$2'},
- usr=>{'^open(.*)'=>'on$1'},
- fw=>{'^open(.*)'=>'open'} }
- </code></ul>
- Diese Variante muss dann verwendet werden, falls das Mapping nicht
- symmetrisch ist. Der erste Teil (dev) spezifiziert dabei die Richtung
- Gerät zu Benutzer, d.h. falls das Gerät on 100 oder
- on-for-timer 100 meldet, dann wird der Benutzer open 100 zu sehen
- bekommen. Der zweite Teil (usr) spezifiziert die Richtung Benutzer zu
- Gerät, d.h. wenn man "set XX open 100" eingibt, dann wird das
- Kommando "on 100" an das Gerät gesendet. In beiden Fällen wird
- der Schlüssel zuerst direkt, und dann als Regexp mit dem Wert
- verglichen. Falls man Regexps mit Wildcards im usr Teil verwendet, dann
- muss man den fw Teil mit dem exakt gleichen Schlüsseln
- ausfüllen, damit FHEMWEB in der Detail-Ansicht den set-Auswahl
- richtig anzeigen kann.
- </li><br>
- <a name="genericDisplayType"></a>
- <li>genericDisplayType<br>
- Wird von bestimmten Frontends (aber nicht FHEMWEB) verwendet, um
- für das Gerät passende Voreinstellungen (Bild/Befehle/etc)
- anzubieten. Z.Zt werden folgende Werte unterstützt:
- switch,outlet,light,blind,speaker,thermostat
- </li><br>
- <a name="group"></a>
- <li>group<br>
- Gerätegruppen. FHEMWEB zeigt Geräte die in die gleiche Gruppe
- gehören auch in einer gemeinsamen Box an. Ein Gerät kann zu
- mehr als einer Gruppe gehören. In diesem Fall müssen die
- entsprechenden Gruppen durch Kommata getrennt eingetragen werden. Wenn
- dieses Attribut nicht gesetzt ist, wird der in der Gerätegruppe
- gesetzte Gerätetyp verwendet.
- </li><br>
- <a name="room"></a>
- <li>room<br>
- Filtert/gruppiert Geräte.
- Ein Gerät kann zu mehr als einem Raum zugeordnet werden. In diesem
- Fall müssen die Raumzuordnungen durch Kommata getrennt
- angegeben werden.<br>
- Geräte, die dem Raum mit der Bezeichnung "hidden" zugeordnet
- werden, erscheinen nicht auf der Webseite.
- Mit -> werden Räume strukturiert, z.Bsp. OG->Schlafzimmer
- </li><br>
- <a name="showtime"></a>
- <li>showtime<br>
- Wird im FHEMWEB verwendet, um die Zeit der letzten Aktivität
- anstelle des Status in der Gesamtansicht anzuzeigen. Nützlich z.B.
- für FS20 PIRI Geräte.
- </li></br>
- <a name="suppressReading"></a>
- <li>suppressReading<br>
- Wird verwendet, um nicht gewollte Readings zu entfernen. Der Wert ist
- ein Regular Expression, ergänzt mit ^ und $. Wird nur in
- Ausnahmefällen benötigt.
- </li><br>
-
- <a name="verbose"></a>
- <li>verbose<br>
- Setzt den Schwellwert für die Logfile-Meldungen.
- Mögliche Werte sind:
- <ul>
- <li>0 - Server start/stop</li>
- <li>1 - Fehlermeldungen oder unbekannte Pakete</li>
- <li>2 - bedeutende Ereigbisse/Alarme.</li>
- <li>3 - ausgesendete Kommandos werden gelogged.</li>
- <li>4 - von den einzelnen Geräten empfangene Daten.</li>
- <li>5 - Fehlersuche.</li>
- </ul>
- Der für die <a href="#global">global</a> Instanz gesetzte Wert gilt
- als Voreinstellung für die Instanzen, die dieses Attribut nicht
- gesetzt haben.
- </li><br>
- </ul>
- <a name="readingFnAttributes"></a>
- <h4>readingFnAttribute</h4>
- Die folgenden Attribute werden bei Modulen verwendet, die standardisierte
- "readings" Aktualisierung der fhem.pl benutzen. Informieren Sie sich in der
- Liste der Modulattribute wenn Sie wissen möchten ob dies
- unterstützt wird.<br><br>
- <ul>
- <a name="stateFormat"></a>
- <li>stateFormat<br>
- Ändert den Gerätestatus, dies ist z.Bsp. in der Ausgabe des list
- Kommandos zu sehen, oder in der Raumübersicht von FHEMWEB. Falls
- nicht gesetzt, dann wird das state Reading übernommen. Sonst werden
- alle Wörter im Wert des Attributes durch das entsprechende Reading des
- Gerätes ersetzt (soweit vorhanden). Falls der Wert in {}
- eingeschlossen ist, dann wird es als Perl Ausdruck ausgewertet. Die
- Auswertung passiert bei jeder Änderung eines Readings.<br>
- Die <a href="#set">hier</a> beschriebene "set magic" wird auch angewendet.
- </li>
- <a name="event-on-update-reading"></a>
- <li>event-on-update-reading<br>
- Wenn nicht gesetzt, erzeugt jede Veränderung eines "readings" ein
- Ereignis, welches z.B. von <a href="#notify">notify</a> oder<a
- href="FileLog"> FileLog</a> berücksichtigt wird. Wenn gesetzt erzeugen
- nur Aktualisierungen der eingetragenen "readings" ein Ereignis.
- </li>
- <a name="event-on-change-reading"></a>
- <li>event-on-change-reading<br>
- Dieses Attribut enthält eine durch Kommata getrennte Liste von
- "readings". Wenn gesetzt, erzeugen nur Veränderungen der gelisteten
- "readings" ein Ereignis. Wenn die aktualiserten Werte der gelisteten
- "readings" identisch sind, wird kein Ereignis generiert.<br>
- Wenn hinter dem Namen eines "readings" eine :Schwelle angegeben ist, wird
- das Event nur getriggert wenn die Änderung grösser als diese
- Schwelle ist.
- </li>
- Die unterschiedlichen Bedeutungen von event-on-update-reading und
- event-on-change-reading sind folgende:
- <ol>
- <li>Wenn beide Attribute nicht gesetzt sind erzeugt jede Aktualisierung
- eines jeden "readings" eines Gerätes ein Ereignis.</li>
- <li>Wenn eines der Attribute gesetzt ist, erzeugen nur Updates oder
- änderungen von "readings" die in einem der Attribute gesetzt
- sind ein Ereignis.</li>
- <li>Wenn ein "reading" in event-on-update-reading aufgeführt ist,
- erzeugt eine Aktualisierung ein Ereignis unabhängig ob das
- "reading" auch in event-on-change-reading aufgelistet ist.</li>
- </ol>
- <a name="timestamp-on-change-reading"></a>
- <li>timestamp-on-change-reading<br>
- Dieses Attribut enthält eine durch Kommata getrennte Liste von
- "readings". Wenn gesetzt, werden die Zeitstempel der gelisteten "readings"
- nicht aktualisiert wenn durch ein ebenfalls gesetztes event-on-change-reading
- für dieses "reading" kein Ereignis erzeugen würde.
- </li>
- <p>
- <a name="event-aggregator"></a>
- <li>event-aggregator</li>
- The primary uses of this attribute are to calculate (time-weighted) averages of
- readings over time periods and to throttle the update rate of readings and thus
- the amount of data written to the logs.<p>
- This attribute takes a comma-separated list of <code>reading:interval:method:function:holdTime</code>
- quintuples. You may use regular expressions for <code>reading</code>. If set, updates for the
- listed readings are ignored and associated events are suppressed for a black-out period of at
- least <code>interval</code> seconds (downsampling). After the black-out period has expired, the reading is
- updated with a value that is calculated from the values and timestamps of the previously ignored
- updates within the black-out period as follows:
-
- <table>
- <tr><th>function</th><th>description</th></tr>
- <tr><td>v</td><td>the last value encountered</td></tr>
- <tr><td>v0</td><td>the first value encountered</td></tr>
- <tr><td>min</td><td>the smallest value encountered</td></tr>
- <tr><td>max</td><td>the largest value encountered</td></tr>
- <tr><td>mean</td><td>the arithmetic mean of all values</td></tr>
- <tr><td>sd</td><td>the standard deviation from the mean</td></tr>
- <tr><td>median</td><td>the median of all values (requires holdTime and function none)</td></tr>
- <tr><td>integral</td><td>the arithmetic sum (if not time-weighted) or integral area (if time-weighted) of all values</td></tr>
- <tr><td>n</td><td>number of samples</td></tr>
- <tr><td>t</td><td>timestamp of the last value</td></tr>
- <tr><td>t0</td><td>timestamp of the first value</td></tr>
- </table>
- <p>
- If <code>method</code> is <code>none</code>, then that's all there is. If <code>method</code>
- is <code>const</code> or <code>linear</code>, the time-weighted series of values is taken into
- account instead. The weight is the timespan between two subsequent updates.
- With the <code>const</code> method, the value is the value of the reading at the beginning of
- the timespan; with the <code>linear</code> method, the value is the arithmetic average of
- the values at the beginning and the end of the timespan.
- Rollovers of black-out periods are handled as one would expect it.<p>
- One would typically use the <code>linear</code> method with the <code>mean</code> function for
- quantities continuously varying over time like electric power consumption, temperature or speed.
- For cumulative quantities like energy consumed, rain fallen or distance covered,
- the <code>none</code> method with the <code>v</code> function is used. The <code>constant</code>
- method is for discrete quantities that stay constant until the corresponding reading is updated,
- e.g. counters, switches and the like.<p>
-
- If the <code>holdTime</code> in seconds is defined, the samples will be kept in memory allowing
- the calculation of floating statistics instead of blocked statistics. With <code>holdTime</code>
- defined the <code>interval</code> can be kept undefined so that the readings update rate is unchanged
- or it can be set to a value less then <code>holdTime</code> for downsampling as described above
- with a full history of the readings in memory. Note that the historic samples are not persistent
- and will be lost when restarting FHEM.<p>
-
- The event aggregator only takes into consideration those updates that remain after preprocessing
- according to the <code>event-on-update-reading</code> and <code>event-on-change-reading</code>
- directives. Besides which, any update of a reading that occurs within a timespan from the preceding
- update that is smaller than the resolution of FHEM's time granularity is ditched.<p>
-
- When more than one function should be calculated for the same reading, the original reading must be
- multiplied (e.g. by using a notify) before applying the event-aggregator to the derived readings.<p>
- Examples:<br>
- <code>attr myPowerMeter event-aggregator EP_POWER_METER:300:linear:mean,EP_ENERGY_METER:300:none:v</code><br>
- <code>attr myBadSensor event-aggregator TEMP::none:median:300</code><br>
- <code>attr mySunMeter event-aggregator SUN_INTENSITY_24H::const:integral:86400</code>
- </li>
-
- <a name="event-min-interval"></a>
- <li>event-min-interval<br>
- Dieses Attribut enthält eine durch Kommata getrennte Liste von
- "readings:minInterval" Paare. readings kann ein regexp sein. Ein Event wird
- nur dann generiert, falls seit dem letzten Auftreten des gleichen Events
- mindestens minInterval Sekunden vergangen sind. Falls
- event-on-change-reading auch spezifiziert ist, dann werden sie mit ODER
- kombiniert, d.h. wenn einer der beiden Bedingungen wahr ist.
- </li>
-
- <a name="oldreadings"></a>
- <li>oldreadings<br>
- Dieses Attribut enthält eine durch Kommata getrennte Liste von
- Readings. regex sind erlaubt. Für jedes Reading aus der Liste
- speichert FHEM intern den vorherigen Wert wenn sich das Reading
- ändert. Zum Zugriff auf die Werte gibt es die OldReadings.* Routinen.
- </li>
- <a name="userReadings"></a>
- <li>userReadings<br>
- Komma getrennte Liste von benutzerdefinierten Readings. Jede Definition hat
- folgendes Format:
- <ul><code>
- <reading>[:<trigger>] [<modifier>] { <perl code> }
- </code></ul>
- Diese benutzerdefinierte Readings werden bei jeder Aktualisierung der
- Gerätereadings gesetzt, indem das spezifizierte <a href="#perl">perl
- code</a> <code>{ <perl code> }</code> ausgeführt wird, und
- dessen Wert dem Reading zugewiesen wird.
- Falls <trigger> spezifiziert ist, dann findet diese Ausführung
- nur dann statt, falls einer der aktualisierten Readings dem regexp
- <trigger> entspricht (matched). <br>
- Beispiele:
- <ul><code>
- attr myEnergyMeter userReadings energy
- { ReadingsVal("myEnergyMeter","counters.A",0)/1250.0;; }<br>
- attr myMultiMeter userReadings
- energy1:counters.A.* {ReadingsVal("myMultiMeter","counters.A",0)/1250.0},
- energy2:counters.B.* {ReadingsVal("myMultiMeter","counters.B",0)/1250.0}
- </code></ul>
- <code><modifier></code> kann die folgenden Werte haben:
- <ul>
- <li>none: als ob man es gar nicht spezifiziert hätte.</li>
- <li>difference: das Reading wird auf die Differenz zw. dem aktuellen und
- dem vorherigen Wert gesetzt.</li>
- <li>differential: das Reading wird auf die Differenz zw. dem aktuellen und
- dem vorherigen Wert, geteilt durch die Sekunden zw. der aktuellen Zeit
- und der letzten Auswertung, sekundengenau. Kein Wert wird berechnet,
- falls der Unterschied unter eine Sekunde liegt.</li>
- <li>integral: das Gegenteil von differential. Das Ergebnis wird um das
- Produkt aus der Zeit-Differenz und der Durschnittswert der letzten zwei
- Readings erhöht.<br>
- result += (time - timeold) * (oldval + value) / 2
- </li>
- <li>offset: wenn der aktuellen Wert kleiner als der vorherige Wert ist
- wird der vorherige Wert zum Reading addiert. Das Reading kann dann als
- offset verwendet werden um einen Zähler der durch Sromverlust
- zurückgesetzt wird zu korrigieren.</li>
- <li>monotonic: wenn die Differenz zw. dem aktuellen und dem vorherigen
- Wert positiv ist wird diese Differenz zum Reading addiert. Damit
- lässt sich von einem Zähler der bei Stromverlust
- zurückgesetzt wird ein monoton wachsender Zähler
- ableiten.</li>
- </ul>
- Beispiel:
- <ul><code>
- attr myPowerMeter userReadings power differential
- { ReadingsVal("myPowerMeter","counters.A",0)/1250.0}
- </code></ul>
- Achtung:<ul>
- <li>Falls difference oder differential spezifiziert ist, dann werden
- für die Berechnung ältere Werte benötigt, d.h. der Wert
- wird frühestens beim zweiten Änderung gesetzt.</li>
- <li>der Name der definierten Readings besteht aus alphanumerischen
- Zeichen, Unterstrich (_) und Minus-Zeichen (-).</li>
- </ul>
- </li><br>
- </ul>
- <h4>Allgemeine Attribute</h4>
- Die folgenden lokalen Attribute werden von mehreren Geräten verwendet:
- <ul>
- <a name="IODev"></a>
- <li>IODev<br>
- Setzt das IO oder das physische Device, welches zum Senden der Signale an
- dieses logische Device verwendet werden soll (Beispielsweise FHZ oder
- CUL). Hinweis: Beim Start weist FHEM jedem logischen Device das letzte
- physische Device zu, das Daten von diesem Typ empfangen kann. Das
- Attribut IODev muss nur gesetzt werden, wenn mehr als ein physisches
- Device fähig ist, Signale von diesem logischen Device zu empfangen.
- </li><br>
- <li>Attribut "disable" umschalten<br/>
- Das Attribut "disable" kann, sofern vom Gerätemodul bereitgestellt,<br/>
- mit folgendem Befehl einfach umgeschaltet werden:</br>
- <br/>
- <code>attr <device> disable toggle</code><br/>
- </li>
- </ul>
- <!-- attributes end - diese Zeile nicht entfernen! -->
- <br><br>
- <a name="attr"></a>
- <h3>attr</h3>
- <div class='langLinks'>[<a href='commandref.html#attr'>EN</a> DE]</div>
- <ul>
- <code>attr [-a|-r] <devspec> <attrname> [<value>]</code><br>
- <br>
- Dieser Befehl setzt ein Attribut für ein Gerät welches mit <a
- href="#define">define</a> definiert wurde. value ist optional, und ist 1
- falls nicht spezifiziert. Sie können auch Ihre eigenen
- Attribute definieren, um sie in anderen Applikationen anzuwenden. Geben Sie
- "<attr <name> ?" ein, um eine Liste verfügbarer Attribute
- anzuzeigen.
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- Gerätespezifische Attribute sind in der Beschreibung zum jeweiligen
- Gerät aufgeführt.
- Nach der Durchführung das globale Ereignis "ATTR" wird generiert.
- <br>
- Falls die Option -a spezifiziert ist, dann wird value zum aktuellen Wert
- hinzugefügt. Achtung: falls value nicht mit einem Komma (,)
- anfängt, dann wird es mit einem Leerzeichen angehängt.
- <br>
- Mit der -r Option kann man Teile eines Attributes wieder entfernen.<br>
- <br>
- Beispiele:
- <ul><code>
- attr global verbose 3<br>
- attr lamp room kitchen<br>
- attr lamp group lights<br>
- attr lamp loglevel 6<br>
- attr weatherstation event-on-update-reading wind,temperature,humidity<br>
- attr weatherstation event-on-change-reading israining<br>
- attr weatherstation event-on-change-reading israining,state<br>
- attr heating stateFormat Temp:measured-temp, Valve:actuator<br>
- attr -a TYPE=SVG room ,SvgRoom</br>
- attr -r TYPE=SVG room ,SvgRoom</br>
- </code></ul>
- <br>
- Bemerkungen:<br>
- <ul>
- <li>Lesen Sie unter <a href="#deleteattr">deleteattr</a> nach um Attribute
- zu löschen.</li>
- </ul>
- </ul>
- <!-- attr end -->
- <a name="cancel"></a>
- <h3>cancel</h3>
- <div class='langLinks'>[<a href='commandref.html#cancel'>EN</a> DE]</div>
- <ul>
- <code>cancel [<id> [quiet]]</code>
- <br><br>
- Entfernt ein benanntes <a href="#sleep">sleep</a>.
-
- </ul>
- <!-- cancel end -->
- <a name="define"></a>
- <h3>define</h3>
- <div class='langLinks'>[<a href='commandref.html#define'>EN</a> DE]</div>
- <ul>
- <code>define [option] <name> <type> <type-specific></code><br>
- <br>
- Definiert ein Gerät. Sie müssen Geräte einrichten um sie zu
- beeinflussen (z.B. das Kommando set on/off auszuführen). Gleichfalls
- ist das Logfile besser lesbar wenn es z.B. "lamp off" anstatt "Device 5673,
- Button 00, Code 00 (off)" als Text enthält. <br>
- Nach der Durchführung wird das globale Ereignis "DEFINED" generiert.
- <br><br>
- Je nach Typ benötigt man unterscheidliche Argumente, lesen Sie sich
- bitte die zu dem jeweiligen Gerät gehörenden Abschnitte durch.
- <br><br>
- Optionen:<br>
- <ul>
- <li>-temporary<br>
- Setzt den TEMPORARY Marker, was das Abspeichern dieser Definition in
- fhem.cfg verhindert.
- </li><br>
- <li>-ignoreErr<br>
- Reduziert die Anzahl der Fehlermeldungen, falls ein FHEM-Modul nicht
- geladen werden kann. Wird in fhem.cfg.demo verwendet, da das RSS Beispiel
- etliche, normalerweise nicht installierte perl-Module benötigt.
- </li><br>
- </ul>
- </ul>
- <!-- define end -->
- <a name="defmod"></a>
- <h3>defmod</h3>
- <div class='langLinks'>[<a href='commandref.html#defmod'>EN</a> DE]</div>
- <ul>
- <code>defmod <name> <type> <type-specific></code><br>
- <br>
- Definiert ein Gerät, oder ändert es, falls es exisitiert. Um
- z.Bsp. eine Lampe 10 Minuten nach der letzten Meldung eines Bewegungsmelders
- abzuschalten, könnte man folgendes definieren:
- <ul><code>
- define mdNtfy notify motionDetector defmod mdOff at +00:10 set lamp off
- </code></ul>
- Falls man statt defmod ein define verwenden würde, dann würde eine
- Meldung innerhalb von 10 Minuten nach der letzten Meldung zu einem Fehler
- führen, da mdOff noch existiert.
- <br>
- </ul>
- <!-- defmod end -->
- <a name="delete"></a>
- <h3>delete</h3>
- <div class='langLinks'>[<a href='commandref.html#delete'>EN</a> DE]</div>
- <ul>
- <code>delete <devspec></code> <br>
- <br>
- Löscht etwas was mit dem <a href="#define">define</a> Befehl erstellt
- worden ist.<br>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- Nach dem löschen, wird das globale Ereignis "DELETED" erzeugt.<br>
- Beispiel:
- <ul>
- <code>delete lamp</code><br>
- </ul>
- <br>
- </ul>
- <!-- delete end -->
- <a name="deleteattr"></a>
- <h3>deleteattr</h3>
- <div class='langLinks'>[<a href='commandref.html#deleteattr'>EN</a> DE]</div>
- <ul>
- <code>deleteattr <devspec> [<attrname>]</code> <br>
- <br>
- Löscht entweder ein einzelnes Attribut (siehe Abschnitt <a
- href="#attr">attr</a> ) oder alle Attribute eines Gerätes (falls
- kein <attrname> angegeben wird).<br>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- Nach der Durchführung das globale Ereignis "DELETEATTR" wird generiert.
- <br>
- Beispiele:
- <ul>
- <code>deleteattr lamp follow-on-for-timer</code><br>
- <code>deleteattr lamp</code><br>
- </ul>
- <br>
- </ul>
- <!-- deleteattr end -->
- <a name="deletereading"></a>
- <h3>deletereading</h3>
- <div class='langLinks'>[<a href='commandref.html#deletereading'>EN</a> DE]</div>
- <ul>
- <code>deletereading <devspec> <readingname></code> <br>
- <br>
- Entfernt das Reading <readingname> für das spezifizierte
- Gerät. <readingname> ist ein perl Regular-Expression, was den
- vollständigen Namen des Readings erfassen muss.
- Mit größter Sorgfalt verwenden! FHEM kann abstürzen, falls
- man lebenswichtige Readings entfernt.<br>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- <br>
- Beispiele:
- <ul>
- <code>deletereading mySensor temp1</code><br>
- <code>deletereading mySensor temp\d+</code><br>
- </ul>
- <br>
- </ul>
- <!-- deletereading end -->
- <a name="displayattr"></a>
- <h3>displayattr</h3>
- <div class='langLinks'>[<a href='commandref.html#displayattr'>EN</a> DE]</div>
- <ul>
- <code>displayattr <devspec> [<attrname>]</code> <br>
- <br>
- Zeigt entweder den Wert eines Attributes an (falls <attrname>
- spezifiziert wurde) oder alle Attribute eines Gerätes.
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- Falls mehrere Geräte spezifiziert wurden, dann enthält die Ausgabe
- den Namen der Geräte.
- <br>
- Beispiele:
- <ul>
- <code>
- fhem> di WEB<br>
- menuEntries AlarmOn,/fhem?cmd=set%20alarm%20on<br>
- room Misc.<br>
- fhem> di WEB room<br>
- Misc.<br>
- </code>
- </ul>
- <br>
- </ul>
- <!-- displayattr end -->
- <a name="get"></a>
- <h3>get</h3>
- <div class='langLinks'>[<a href='commandref.html#get'>EN</a> DE]</div>
- <ul>
- <code>get <devspec> <type-specific></code>
- <br><br>
- Fragt einen Wert direkt (aktuell) vom Gerät ab und wartet auf eine
- Antwort. Eine allgemeine Liste möglicher Paramter erhalten Sie mit<ul>
- <code>get <device> ?</code>
- </ul>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- Jedes Gerät hat unterschiedliche "get"-Parameter. Lesen Sie Details bitte im
- zugehörigen Abschnitt nach.<br>
- <br>
- </ul>
- <!-- get end -->
- <a name="getstate"></a>
- <h3>getstate</h3>
- <div class='langLinks'>[<a href='commandref.html#getstate'>EN</a> DE]</div>
- <ul>
- <code>getstate <devspec></code>
- <br><br>
- Gibt einen kurzen, durch Leerzeichen getrennte Statusliste für <devspec>
- aus . Dies ist nützlich, um das Gerät in z.B. Cacti zu beobachten.<br>
- Beispiel:
- <ul><code>
- getstate lamp<br>
- state:1<br>
- <br>
- getstate fl<br>
- ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...] measured-temp:22.9 [...]
- </code></ul>
- Bemerkung: Um diesen Befehl nutzen zu können, kopieren Sie bitte die
- Datei 99_getstate.pm aus dem Verzeichnis contrib/getstate/ in Ihr FHEM
- Verzeichnis.
- <br>
- </ul>
- <!-- getstate end -->
- <a name="include"></a>
- <h3>include</h3>
- <div class='langLinks'>[<a href='commandref.html#include'>EN</a> DE]</div>
- <ul>
- <code>include <filename></code> <br>
- <br>
- Liest (z.B. als Befehlszeile in der fhem.cfg) die in <filename>
- angegebene Datei in FHEM ein und interpretiert jede Dateizeile als FHEM
- Befehl. Dieses Befehl sollte nur von Experten verwendet werden.
- <br>
- </ul>
- <!-- include end -->
- <a name="inform"></a>
- <h3>inform</h3>
- <div class='langLinks'>[<a href='commandref.html#inform'>EN</a> DE]</div>
- <ul>
- <code>inform {on|off|timer|raw} [regexp]</code> <br>
- <br>
- Wenn auf "on" gesetzt und der Status eines Gerätes ändert
- sich, dann wird eine Nachricht an den Client gesendet. Dieser Befehl kann von
- anderen Programmen/Modulen dazu benutzt werden, eine Hinweisnachricht zu
- erhalten. <br> Die Option "timer" fügt der Nachricht
- einen Zeitstempel hinzu. Hinweis: Dieser Befehl erleichtert Ihnen die bessere
- Kontrolle in <a href="#notify">notify</a> oder <a href="#FileLog">FileLog</a>
- , wann welche Ereignisse erzeugt wurden.
- <br>
- </ul>
- <!-- inform -->
- <a name="list"></a>
- <h3>list</h3>
- <div class='langLinks'>[<a href='commandref.html#list'>EN</a> DE]</div>
- <ul>
- <code>list [devspec] [value]</code><br>
- oder<br>
- <code>list {-r|-R} devspec</code><br>
- <br><br>
- Auflistung aller "definitions", "notify" und
- "at"-Definitionen. Dies ist eines der wenigen Befehle, die im
- Normalfall eine Zeichenkette ausgeben.<br> Siehe den Abschnitt über <a
- href="#devspec">Geräte-Spezifikation</a> für Details der
- <devspec>.<br>
-
- <br> Wenn value angegeben ist, der von ( DEF, TYPE, usw) oder reading
- (actuator, measured-temp) für alle Geräte die in devspec angegeben
- sind. <br><br> Beispiel:
- <pre><code>fhem> list
- Type list <name> for detailed info.
- Internal:
- global (Internal)
- FHZ:
- FHZ (fhtbuf: 23)
- FS20:
- Btn4 (on-old-for-timer)
- Roll1 (on)
- Stehlampe (off)
- FHT:
- fl (measured-temp: 21.1 (Celsius))
- KS300:
- out1 (T: 2.9 H: 74 W: 2.2 R: 8.2 IR: no)
- at:
- at_rollup (Next: 07:00:00)
- notify:
- ntfy_btn4 (active)
- FileLog:
- avglog (active)
- </name></code></pre>
- Wenn Sie für <code>name</code> einen Gerätenamen eingeben, dann
- erhalten Sie einen genauen Status für das in<code> name</code>
- angegebene Gerät angezeigt, z.B.:
- <pre><code> fhem> list fl
- Internals:
- CODE 5102
- DEF 5102
- NAME fl
- NR 15
- STATE measured-temp: 21.1 (Celsius)
- TYPE FHT
- IODev FHZ
- Attributes:
- room Heizung
- Readings:
- 2006-11-02 09:45:56 actuator 19%
- [...]
- </code></pre>
- Mit der -r (raw) Option werden die Daten in einem für fhem.cfg bzw.
- fhem.state passenden Format generiert. -R liefert diese Daten auch für
- alle von diesem Gerät vermutlich benögten Geräte.
- Achtung: die Bestimmung dieser Liste ist ungenau.
- </ul>
- <!-- list end -->
- <a name="modify"></a>
- <h3>modify</h3>
- <div class='langLinks'>[<a href='commandref.html#modify'>EN</a> DE]</div>
- <ul>
- <code>modify <name> <type-dependent-options></code>
- <br><br>
- Dieser Befehl wird benutzt, um Definitionen zu verändern. Er ist
- nützlich, um <a href="#at">at</a> oder <a href="#notify">notify</a>
- Definitionen zu verändern. Wenn Sie einen Wert einer an Definition
- verändern, dann wird nur der für die Zeit zuständige Teil
- geändert. Im Falle der Veränderung einer Definition vom Typ
- "notify" wird nur der regex Teil geändert. Alle anderen
- Werte (Stati, Attribute, etc) bleiben erhalten.
- After modify, the global event "MODIFIED" will be generated.
- Nach der Durchführung das globale Ereignis "MODIFIED" wird generiert.
- <br><br>
- Beispiel:
- <ul>
- <code>define lampon at 19:00 set lamp on</code><br>
- <code>modify lampon *19:00</code><br>
- <code>modify lampon 19:00 set lamp on-for-timer 16</code><br>
- </ul>
- </ul>
- <!-- modify end -->
- <a name="quit"></a>
- <h3>quit</h3>
- <div class='langLinks'>[<a href='commandref.html#quit'>EN</a> DE]</div>
- <ul>
- <code>quit</code>
- <br><br>
- Dieser Befehl wird in einer TCP/IP Session benutzt um die Client-Sitzung zu
- beenden.<br>
- Wird dieser Befehl in einem Skript benutzt, wird das abarbeiten des Skriptes
- beendet.
- <br><br>
- Beispiel:
- <ul>
- <code>quit</code>
- </ul>
- </ul>
- <!-- quit end -->
- <a name="reload"></a>
- <h3>reload</h3>
- <div class='langLinks'>[<a href='commandref.html#reload'>EN</a> DE]</div>
- <ul>
- <code>reload <module></code>
- <br><br>
- Reload the given module from the module directory. It is a convenient way to
- test modules whithout restarting the program.
- <br><br>
- Example:
- <ul>
- <code>reload 99_PRIV</code>
- </ul>
- </ul>
- <!-- reload end -->
- <a name="rename"></a>
- <h3>rename</h3>
- <div class='langLinks'>[<a href='commandref.html#rename'>EN</a> DE]</div>
- <ul>
- <code>rename <oldname> <newname></code>
- <br><br>
- Benennt ein Gerät von <oldname> in <newname>,
- einschliesslich der Attribute, um. Das globale Ereignis "RENAMED"
- wird erstellt, Lesen Sie bitte den Abschnitt "notify" durch um
- Details zu erfahren.
- <br><br>
- Beispiel:
- <ul>
- <code>rename FHT_1234 fht.kitchen</code>
- </ul>
- </ul>
- <!-- rename end -->
- <a name="rereadcfg"></a>
- <h3>rereadcfg</h3>
- <div class='langLinks'>[<a href='commandref.html#rereadcfg'>EN</a> DE]</div>
- <ul>
- <code>rereadcfg [fhem-config-file]</code>
- <br><br>
- Liest entweder die aktuelle Konfigurationsdatei oder die angegebene Datei
- ein.<br> Der Ablauf ist dabei wie folgt: Zuerst wird das <a
- href="#statefile">statefile</a> gesichert. Dann werden alle Geräte
- gelöscht. Dann wird die aktuelle Konfigurationsdatei (oder die
- angegebene Datei) eingelesen zuletzt wird das statefile neu eingelesen.<br>
- Wenn dieser Ablauf abgeschlossen ist, wird das globale REREADCFG Ereignis
- ausgelöst. Alle existierenden Verbindungenwerden bis zum
- "rereadcfg" Ereignis getrennt.
- <br><br>
- Beipiel:
- <ul>
- <code>rereadcfg</code>
- </ul>
- </ul>
- <!-- rereadcfg end -->
- <a name="save"></a>
- <h3>save</h3>
- <div class='langLinks'>[<a href='commandref.html#save'>EN</a> DE]</div>
- <ul>
- <code>save [<configfile>]</code>
- <br><br>
- Sichert zuerst das <a href="#statefile">statefile</a> und dann das
- <a href="#configfile">configfile</a>. Wenn ein Parameter angegeben wird dieser
- anstelle der allgemeinen Konfigurationsdatei benutzt.<br><br>
- Hinweise:
- <ul>
- <li>Der Befehl speichert nur "definitions" und
- "attributes" aber keine (set/get) Befehle die vorher Teil der
- Konfigurationsdatei waren. Wenn Sie solche Befehle nach der
- Initialisierung (z.B. <a href="#FHZset">FHTcode</a>)
- benötigen,dann müssen Sie sie mit <a href="#notify">notify</a>
- triggern wenn das INITIALIZED Ereignis eintritt.</li>
- <li>Der Befehl "save" versucht Kommentarzeilen (Zeilen die
- mit # beginnen) und "include"-Zeilen zu erhalten, aber arbeitet
- nicht korrekt wenn FHEM für diese Dateien keine Schreibrechte
- besitzt.</li>
- <li>Vor dem Überschreiben der Dateien wird die alte Version gesichert,
- siehe <a href="#restoreDirs">restoreDirs</a> für Einzelheiten.</li>
- </ul>
- </ul>
- <!-- save end -->
- <a name="set"></a>
- <h3>set</h3>
- <div class='langLinks'>[<a href='commandref.html#set'>EN</a> DE]</div>
- <ul>
- <code>set <devspec> <type-specific></code>
- <br><br>
- Der Befehl setzt Geräteparameter/sendet Signale an ein Gerät. Sie
- erhalten eine Liste verfügbarer Parameter wenn Sie folgendes eingeben:
- <ul>
- <code>set <name> ?</code>
- </ul>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- Der "set"-Befehl gibt nur bei Fehler einen Wert zurück.
- <br><br>
- Jedes Gerät hat verschiedene Parameter die mit "set" gesetzt
- werden können. Lesen Sie bitte den entsprechenden Abschnitt für
- das Gerät für Details durch.
- <br><br>
- Ab featurelevel 5.7 ersetzt das set und setreading Befehl
- <ul>
- <li>[device:name] mit dem Wert des Readings, Internals oder Attributes
- für device, falls sowohl device, als auch Reading, Internal oder
- Attribut existiert, und nicht leer ist.
- <ul>
- <li>Man kann einen der Präfixe r:, i: oder a: verwenden, um die
- Suche einzuschränken, genau wie im devspec.</li>
- <li>Das Suffix :d extrahiert die erste Zahl.</li>
- <li>Das Suffix :i extrahiert die erste Zahl als Ganzzahl.</li>
- <li>Das Suffix :r<n> extrahiert die erste Zahl, und rundet sie auf
- <n> Dezimalstellen. Falls <n> fehlt, dann wird auf eine
- Dezimalstelle gerundet.</li>
- <li>Das Suffix :t liefert den Zeitstempel des Readings</li>
- <li>Das Suffix :sec liefert Anzahl der Sekunden seit Änderung
- des Readings.</li>
- </ul>
- Beispiel:
- <ul>
- set Lamp blink [blinkDummy:number] [r:blinkDummy:duration:d]
- </ul>
- </lu>
- <li>{(perlExpression)} mit dem Ergebnis der perlExpression.
- $DEV wird dabei mit dem Namen des vom set betroffenen Gerätes ersetzt.
- </li>
- </ul>
- Diese Ersetzungen sind unter dem Namen "set magic" bekannt.
- <br><br>
- <a name="setExtensions"></a>
- Manche Module unterstützen die sog. <b>set extensions</b>, und in der
- entsprechenden Dokumentation ist ein Link auf diesem Text zu finden. Falls im
- Modul selber einer der unten aufgeführten Befehle implementiert ist, dann
- wird die Modul-Implementation verwendet.
- <ul>
- <li>on-for-timer <sekunden><br>
- Das Gerät wird per "on" eingeschaltet, und ein interner Zeitgeber
- wird erstellt, um nach <sekunden> ein "off" Kommando
- auszuführen. Um diesen Zeitgeber zu entfernen sollte man das
- Kommando mit dem Argument 0 erneut aufrufen. Achtung: dieser Zeitgeber
- wird bei einem restart nicht gespeichert.</li>
- <li>off-for-timer <sekunden><br>
- siehe on-for-timer.</li>
- <li>on-till <timedet><br>
- Das Gerät wird per "on" eingeschaltet, und ein at Instanz wird
- definiert, um es um <timedet> (Format: HH:MM[:SS]) per off
- auszuschalten. Diese at Instanz ist sichtbar unter dem Namen
- geräteName+"_till". Um das Ausschalten zu deaktivieren
- löscht man diese at Definition. Achtung: das Ein/Ausschalten wird
- nicht durchgeführt, falls die aktuelle Uhrzeit nach der
- spezifizierten Zeit ist, um folgende Szenarien zu vereinfachen:
- <ul><code>
- define morningLight at *06:00 set Lamp on-till {sunrise()}
- </code></ul>
- </li>
- <li>on-till-overnight <timedet><br>
- Wie on-till, aber die aktuelle Uhrzeit wird nicht mit der
- Spezifizierten verglichen, damit folgendes funktioniert:
- <ul><code>
- define nightLight at *{sunset()} set Lamp on-till-overnight 01:00
- </code></ul>
- </li>
- <li>off-till <timedet><br>
- siehe on-till.</li>
- <li>off-till-overnight <timedet><br>
- siehe on-till-overnight.</li>
- <li>blink <anzahl> <blink-periode><br>
- Das Gerät wird mit "on" für die <blink-periode>
- eingeschaltet, und das wird nach <blink-periode> wiederholt. Um
- das Blinken vorzeitig zu stoppen spezifiziert man "0 0" als
- Argument.</li>
- <li>intervals <from1>-<till1> <from2>-<till2>...
- </br>
- Das Gerät wird für die spezifizierten Intervalle
- eingeschaltet. Die einzelnen Intervalle sind Leerzeichen getrennt, und
- ein Intervall besteht aus zwei Zeitspezifikationen, die mit einem "-"
- getrennt sind.
- </li>
- <li>toggle<br>
- Das Gerät wird mit "on" eingeschaltet, falls STATE "off" ist (oder
- dim 0), sonst wird es mit "off" ausgeschaltet.
- </ul>
- Beispiele:
- <ul>
- <code>
- set switch on-for-timer 12.5<br>
- set switch on-till {sunset()}<br>
- set switch blink 3 1<br>
- set switch intervals 08:00-12:00 13:00-18:00<br>
- </code>
- </ul>
- </ul>
- </ul>
- <!-- set end -->
- <a name="setdefaultattr"></a>
- <h3>setdefaultattr</h3>
- <div class='langLinks'>[<a href='commandref.html#setdefaultattr'>EN</a> DE]</div>
- <ul>
- <code>setdefaultattr [<attrname> [<value>]] </code><br>
- <br>
- Fügt Sie ein Standardattribut hinzu. Jedem nach dieser Zuweisung definierte
- Gerät wird dieses Attribut zugewiesen. Wenn kein "attrname" angegeben wird,
- dann wird die Liste der Standardattribute gelöscht.
- <br><br>
- Beispiel, um das Attribut "room kitchen" und "loglevel 4" allen Lampen
- zuzuweisen:
- <ul>
- <code>setdefaultattr room kitchen</code><br>
- <code>setdefaultattr loglevel 4</code><br>
- <code>define lamp1 FS20 1234 11</code><br>
- <code>define lamp2 FS20 1234 12</code><br>
- <code>define lamp3 FS20 1234 13</code><br>
- <code>setdefaultattr</code><br>
- </ul>
- <br>
- Anmerkungen:<br>
- <ul>
- <li>es gibt keine Möglichkeit, ein einzelnes Standardattribut aus der Liste
- tu löschen.</li>
- </ul>
- </ul>
- <!-- setdefaultattr end -->
- <a name="setreading"></a>
- <h3>setreading</h3>
- <div class='langLinks'>[<a href='commandref.html#setreading'>EN</a> DE]</div>
- <ul>
- <code>setreading <devspec> <reading> <value></code>
- <br><br>
- Der Befehl setzt das Reading <reading> auf den Wert <value> ohne
- Signale an das betroffene Gerät zu senden, generiert aber Ereignisse und
- die übliche eventMap und stateFormat Umwandlung wird auch
- durchgeführt.
- <br>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec> und die Beschreibung des set Befehls
- für Ersetzung.<br>
- <br>
- Beispiel:
- <ul>
- setreading lampe state on
- </ul>
- Achtung: setreading generiert kein Event für ein Gerät X, falls es
- aus einem notify für Gerät X aufgerufen wurde. In so einem Fall
- könnte man auf "sleep 0.1; setreading X Y Z" ausweichen.
- </ul>
- <!-- setreading end -->
- <a name="setstate"></a>
- <h3>setstate</h3>
- <div class='langLinks'>[<a href='commandref.html#setstate'>EN</a> DE]</div>
- <ul>
- <code>setstate <devspec> <value></code>
- <br><br>
- Der Befehl setzt den STATE Eintrag des Gerätes direkt, ohne Ereignisse
- zu generieren oder ein Signal an das Gerät zu senden. Dieser Eintrag ist
- maßgebend für die Status-Anzeige in diversen Frontends. Dieser
- Befehl wird auch im <a href="#statefile">statefile</a> benutzt.<br> Siehe den
- Abschnitt über <a href="#devspec">Geräte-Spezifikation</a> für
- Details der <devspec>.<br> <br>
- Beispiel:
- <ul>
- setstate lampe An
- </ul>
- </ul>
- <!-- setstate end -->
- <a name="shutdown"></a>
- <h3>shutdown</h3>
- <div class='langLinks'>[<a href='commandref.html#shutdown'>EN</a> DE]</div>
- <ul>
- <p>
- <code>shutdown [<var>restart</var>] [<var>exitValue</var>]</code>
- </p>
- <p>
- Der Befehl fährt <abbr>FHEM</abbr> herunter (nach dem Sichern aller <a
- href="#statefile">Gerätestatus</a>). Er triggert den <code>global:SHUTDOWN</code>-<span lang="en">Event</span>.
- Mit dem optionalen Parameter <var lang="en">restart</var> startet <abbr>FHEM</abbr> danach neu.
- Der <var lang="en">exitValue</var> ist möglicherweise bei bestimmten Start-Skripten zur korrekten Funktion
- vonnöten <abbr>bzw.</abbr> wichtig.
- </p>
- Beispiel:
- <ul>
- <code>shutdown</code><br>
- <code>shutdown restart</code><br>
- <code>shutdown 1</code>
- </ul>
- </ul>
- <!-- shutdown end -->
- <a name="sleep"></a>
- <h3>sleep</h3>
- <div class='langLinks'>[<a href='commandref.html#sleep'>EN</a> DE]</div>
- <ul>
- <code>sleep <sec> [<id>] [quiet]</code>
- <br><br>
- sleep gefolgt von weiteren Befehlen ist vergleichbar mit einem namenlosen <a
- href="#at">at</a> Kommando, es führt die nachfolgenden Befehle aus,
- nachdem es die spezifizierte Zeitspanne gewartet hat. Die Einheit ist
- Sekunde, Millisekunden genau, da man Nachkommastellen spezifizieren
- kann.<br><br>
- Ein sleep mit einer <id> ersetzt ein sleep mit der gleichen <id>
- and can mit <a href="#cancel">cancel</a> entfernt werden.
- Falls sleep in at/notify/etc aufgerufen wurde, und die nachfolgenden
- Kommandos einen nicht leeren Text zurückgeliefert haben, dann wird
- dieser Text mit loglevel 2 protokolliert.<br>
- quiet vermeidet diese Protokollierung.
- <br><br>
- Beispiele:
- <ul>
- <code>sleep 0.5</code><br>
- <code>define n3 notify btn3.* set lamp toggle;;sleep 0.5;;set lamp
- toggle</code><br>
- <code>define a3 at +*00:05 set Windsensor 1w_measure;; sleep 2 quiet;; get
- Windsensor 1w_temp</code>
- </ul>
- <br>
- Bemerkung: falls sleep von keinem Befehl gefolgt wird, dann wird FHEM
- blockiert. Das ist unerwünscht, und im FHEM-Log wird eine Warnung
- protokolliert.
- </ul>
- <!-- sleep end -->
- <a name="trigger"></a>
- <h3>trigger</h3>
- <div class='langLinks'>[<a href='commandref.html#trigger'>EN</a> DE]</div>
- <ul>
- <code>trigger <devspec> <event></code>
- <br><br>
- Generiert das Ereignis <event>, was z.Bsp. ein <a
- href="#notify">notify</a> anstoßen kann, oder den FileLog zum
- protokollieren dieser Zeile bewegen kann.<br>
- Siehe den Abschnitt über <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- <br>
- Beispiel:
- <ul>
- <code>trigger btn3 on</code>
- </ul>
- </ul>
- <!-- trigger end -->
- <!-- commands end - diese Zeile nicht entfernen! -->
- <a name="global"></a>
- <h3>global</h3>
- <div class='langLinks'>[<a href='commandref.html#global'>EN</a> DE]</div>
- <ul>
- Das "global" Gerät wird benutzt, um allgemeingültige
- Attribute zu setzen. Es wird automatisch erstellt und kann nicht
- gelöscht oder umbenannt werden. Es hat keine "set" oder
- "get" Parameter.<br>
- <br>
- <b>Define</b><ul>N/A</ul><br>
- <b>Set </b><ul>N/A</ul><br>
- <b>Get</b><ul>N/A</ul><br>
- <b>Attributes</b>
- <ul>
- <li><a href="#archivedir">archivedir</a></li>
- <li><a href="#archivecmd">archivecmd</a></li>
- <li><a href="#nrarchive">nrarchive</a></li>
- <a name="archivesort"></a>
- <li>archivesort<br>
- archivesort kann auf dem (voreingestellten) Wert alphanum oder timestamp
- gesetzt werden, und bestimmt die Methode für die
- Reihenfolgenberechnung der Dateien für nrarchive.<br>
- </li><br>
- <a name="autoload_undefined_devices"></a>
- <li>autoload_undefined_devices<br>
- wenn dieses Attribut gesetzt ist, werden die zu einer neu empfangenen
- Nachricht zugehörigen Module automatisch geladen. Dies
- erfolgt vom <a href="#autocreate"> autocreate</a> Gerät, um so
- automatisch ein FHEM-Gerät bei erreichen einer entsprechenden
- Nachricht zu erstellen.
- </li><br>
- <a name="backupcmd"></a>
- <li>backupcmd<br>
- Sie können das Update durch Ihre eigenen Befehle/Skripts
- durchführen indem Sie dieses Attribut setzen. Wenn dieses
- Attribut gesetzt ist, dann startet es als ein SHELL-Befehl und erstellt
- eine durch Leerzeichen getrennte Liste von Dateien/Verzeichnissen als
- <strong>ein</strong> Argument zum Befehl, z.B.:
- <br>
- <ul>
- <code>"/etc/fhem.cfg /var/log/fhem/fhem.save /usr/share/fhem/contrib
- /usr/share/fhem/FHEM /usr/share/fhem/foo /usr/share/fhem/foobar
- /usr/share/fhem/www"</code>
- </ul>
- Bemerkung: Ihr Befehl/Skript muss die Zeichenkette "backup done"
- zurückgeben oder eine entsprechende Zeichenkette um
- Fehlermeldungen auszugeben, damit die Zusammenarbeit mit update
- funktioniert!<br> Dieses Attribut wird vom <a href="#backup">backup</a>
- Befehl benutzt.<br>
- Beispiel:<br>
- <ul>
- attr global backupcmd /usr/local/bin/myBackupScript.sh
- </ul>
- </li><br>
- <a name="backupdir"></a>
- <li>backupdir<br>
- Ein Ordner um die komprimierten Sicherheitsdateien zu speichern.
- Dieses Attribut wird vom <a href="#backup">backup</a> Befehl
- benutzt.<br> Beispiel:<br>
- <ul>
- attr global backupdir /Volumes/BigHD
- </ul>
- </li><br>
- <a name="backupsymlink"></a>
- <li>backupsymlink<br>
- Wenn dieses Attribut auf etwas anderes als "no", dann unterstützt
- der Archviierungsbefehl "tar" symbolische Links in Ihrem
- Backup. Andererseits, wenn dieses Attribut auf "no" gesetzt ist werden
- symbolische Links vom Befehl "tar" ignoriert. Dieses
- Attribut wird vom <a href="#backup">backup</a> Befehl benutzt.<br>
- Beispiel:<br>
- <ul>
- attr global backupsymlink yes
- </ul>
- </li><br>
- <a name="blockingCallMax"></a>
- <li>blockingCallMax<br>
- Begrenzt die Anzahl der parallel laufenden Prozesse, die von der
- BlockingCall FHEM Hilfsroutine gestartet wurden. Sinnvoll auf weniger
- leistungsfaehigen Hardware.
- </li><br>
- <a name="configfile"></a>
- <li>configfile<br>
- Enthält den Namen der FHEM Konfigurationsdatei. Wenn <a
- href="#save">save</a> ohne Argumente aufgerufen wird dann wird die
- Ausgabedatei unter diesem Dateinamen gespeichert.
- </li><br>
- <a name="commandref"></a>
- <li>commandref<br>
- Falls der Wert "full" (die Voreinstellung) ist, dann wird nach jedem
- update ein komplettes commandref.html generiert. Falls der Wert
- "modular" ist, dann wird die Moduldokumentation erst nach Bedarf
- waehrend der Laufzeit per JavaScript geladen.
- </li><br>
- <a name="dnsHostsFile"></a>
- <li>dnsHostsFile<br>
- Falls dnsServer gesetzt ist, wird die angegebene Datei nach dem
- Hostnamen durchsucht. Um die vom System verwendete Datei zu benutzen,
- ist es unter Linux/Unix/OSX auf /etc/hosts und unter Windows auf
- C:\windows\system32\drivers\etc\hosts zu setzen. Achtung: es wird nur
- IPv4 unterstützt.
- </li><br>
- <a name="dnsServer"></a>
- <li>dnsServer<br>
- Enthält die IP Adresse des DNS Servers. Die von bestimmten Modulen
- (oder eigenen Code) aufgerufene HttpUtils_NonblockingGet wird auch bei
- der DNS Auflösung nicht mehr blockieren, falls dieses Attribut
- gesetzt ist, da es in diesem Fall FHEM eigene Routinen aufgerufen
- werden. Sonst werden die OS-eigenen, blockierenden Routinen inet_aton
- bzw gethostbyname aufgerufen.
- </li><br>
- <a name="featurelevel"></a>
- <li>featurelevel<br>
- Aktiviere bzw. deaktiviere bestimmte alte oder neue Funktionen, basierend
- auf die FHEM Version. Z.Bsp. das $value hash für notify wird nur bis featurelevel 5.6
- befüllt, da es unerwünscht ist. Stattdessen sollte man die
- Value() Funktion verwenden.
- </li><br>
- <a name="holiday2we"></a>
- <li>holiday2we<br>
- Wenn dieses Attribut gesetzt wurde, dann wird die <a
- href="#perl">$we</a> Variable als "true" betrachtet, wenn der
- Wert der <a href="#holiday">holiday</a> Variable zu diesem Attribut
- nicht "none" ist.<br>
- Falls es eine Komma getrennte Liste ist, dann ist es wahr, falls einer
- der referenzierten Instanzen nicht "none" ist.<br>
- Beispiel:<br>
- <ul>
- attr global holiday2we hessen
- </ul>
- </li><br>
- <a name="httpcompress"></a>
- <li>httpcompress<br>
- das HttpUtils Modul wird von etlichen FHEM modulen verwendet und
- aktiviert Komprimierung in der Voreinstellung. Falls man
- httpcompress auf 0 setzt, wird die Komprimierung deaktiviert.
- </li><br>
- <a name="logdir"></a>
- <li>logdir<br>
- Falls gesetzt, wird %L in dem logfile Attribut (oder in der Dateinamen
- Spezifikation des FileLog Moduls) durch den Wert des Attributes ersetzt.
- Achtung: ändern des Wertes bewirkt nicht das Verschieben bereits
- erstellter Dateien, und kann zu diversen Problemen führen.
- </li><br>
- <a name="logfile"></a>
- <li>logfile<br>
- Gibt das Logfile an, in welches gespeichert werden soll. Sie
- können "-" für die Ausgabe in das stdout-Gerät. In
- diesem Fall stellt sich der Server nicht selbst in den Hintergrund.<br>
- Der Name der Logdatei kann auch "wildcards" enthalten, um
- eine einfachere Abfolge für die Dateien zu erreichen. Lesen Sie
- bitte den Abschnitt <a href="#FileLog">FileLog</a>. Fügen Sie die
- Attribute <code>archivecmd / archivedir / nrarchive</code> zum
- <code>global</code> Gerät hinzu wie Sie es auch bei einem FileLog
- device tun könnten.<br> Sie können den Namen der Logdatei
- mit <code>{ $currlogfile }festlegen</code>.
- </li><br>
- <a name="modpath"></a>
- <li>modpath<br>
- Mit modpath geben Sie den Pfad zu dem Verzeichnis der <code>FHEM</code>
- Module an. Der Pfad enthält <b>nicht</b> das Verzeichnis FHEM.
- Durch das setzen der Attribute, wird das Verzeichnis nach Dateinamen in
- der Form NN_<NAME>.pm durchsucht, und sie werden für die
- Definition von Geräten unter dem Namen <NAME> verfügbar
- gemacht. Wenn das erste Gerät des Typs <NAME> definiert
- wird, werden die entsprechenden Module geladen und in dem Modul die
- entsprechende Funktion mit dem Namen <NAME>_Initialize wird
- aufgerufen. Eine Ausnahme bilden Module die mit der Nummer 99 im
- Dateinamen beginnen. Diese enthalten PERL-Hilfsfunktionen und
- werden zur Startzeit geladen.
- </li><br>
- <a name="motd"></a>
- <li>motd<br>
- Nachricht des Tages. Wird im Begrüßungsbildschirm von FHEM
- angezeigt, oder direkt beim Start einer "telnet" Sitzung,
- bevor der fhem> Prompt erscheint. Der SecurityCheck setzt motd wenn
- es bisher nicht gesetzt ist. Um das zu verhindern, können sie den
- Wert von motd auf "none" setzen.
- motd wird auch verwendet, um Fehlermeldungen während des
- FHEM-Starts zu sammeln und anzuzeigen.
- </li><br>
- <a name="mseclog"></a>
- <li>mseclog<br>
- Wenn dieses Attribut gesetzt ist, enthalten Datums/Zeiteinträge
- (timestamp) in der Logdatei einen Millisekunden-Eintrag.
- </li><br>
- <a name="nofork"></a>
- <li>nofork<br>
- Wenn dieses Attribut oder "attr global logfile -" gesetzt ist,
- dann wird FHEM nicht im Hintergrund abgearbeitet.
- Dieses Attribut ist bei einigen FHEM Installationen auf FRITZ!-Boxen
- notwendig, und wid fuer Windows automatisch gesetzt.
- </li><br>
- <a name="pidfilename="></a>
- <li>pidfilename<br>
- Schreibt die PERL Prozess-ID in die angegebene Datei. Der Server
- läuft als Daemon und einige Distributionen wollen anhand der PID
- testen, ob der FHEM Prozess läuft. Die Datei wird bei
- Ausführung des "shutdown"-Kommandos gelöscht.
- </li><br>
- <a name="proxy"></a>
- <li>proxy<br>
- IP:PORT des proxy Servers, wird von HttpUtils benutzt.
- </li><br>
- <a name="proxyAuth"></a>
- <li>proxyAuth<br>
- Base64 kodiertes Benutzername:Passwort
- </li><br>
- <a name="proxyExclude"></a>
- <li>proxyExclude<br>
- Regexp, um bestimmte Hosts nicht via proxy zu kontaktieren.
- </li><br>
- <a name="restoreDirs"></a>
- <li><a name="restoreDirs">restoreDirs</a><br>
- update sichert jede Datei vor dem Überschreiben mit der neuen
- Version aus dem Web. Für diesen Zweck wird zuerst ein restoreDir
- Verzeichnis in der global modpath Verzeichnis angelegt, und danach
- ein Unterverzeichnis mit dem aktuellen Datum. In diesem Verzeichnis
- werden vor dem Überschreiben die alten Versionen der Dateien
- gerettet. Die Voreinstellung ist 3, d.h. die letzten 3
- Datums-Verzeichnisse werden aufgehoben, und die älteren entfernt.
- <br>
- Auch fhem.cfg und fhem.state wird auf diese Weise vor dem ausfüren
- von save gesichert. Zum restaurieren der alten Dateien kann man das
- restore Befehl verwenden.<br>
- Falls man den Wert auf 0 setzt, dann ist dieses Feature deaktiviert.
- </li><br>
- <li><a href="#fheminfo">sendStatistics</a><br>
- <a name="statefile"></a>
- <li>statefile<br>
- Dieses Attribut legt den Namen der Datei fest, in die
- Statusinformationen aller Geräte gespeichert werden bevor der
- Server heruntergefahren wird. Falls diese Datei nicht angegeben wird, so
- werden keinerlei Informationen gesichert.
- </li><br>
- <li><a href="#title">title</a><br>
- <li><a href="#fheminfo">uniqueID</a>
- <a name="useInet6"></a>
- <li>useInet6<br>
- Die HttpUtils Routinen verwenden IPv6 für die Kommunikation, falls
- der Server eine IPv6 Adresse hat. Achtung: das Perl-Modul
- IO::Socket::INET6 wird benötigt.
- </li><br>
- <a name="userattr"></a>
- <li>userattr<br>
- Enthält eine durch Leerzeichen getrennte Liste in welcher die
- Namen zusätzlicher Attribute aufgeführt sind. Diese
- müssen zuerst in dieser Liste definiert werden, bevor sie
- (bei allen Geräten) angewendet werden können.<br>
- userattr kann auch für einzelne Geräte spezifiziert werden,
- um weitere Attribute für diese Geräte zu definieren.
- </li><br>
- <a name="dupTimeout"></a>
- <li>dupTimeout<br>
- Definert die Wartezeit, nach der 2 identische Ereignisse zweier
- Empfänger als Duplikat angesehen werden. Voreingestellt sind 0,5
- Sekunden.
- </li><br>
- <a name="showInternalValues"></a>
- <li>showInternalValues<br>
- Attribute/Geräte-Eintraege/Readings die mit Punkt (.) anfangen
- werden nicht angezeigt, es sei denn das globale Attribut
- showInternalValues ist gesetzt. Diese Variable wird bei dem list und
- xmllist Befehl, und bei der FHEMWEB Raumansicht geprüft.
- </li><br>
- <a name="sslVersion"></a>
- <li>sslVersion<br>
- Setzt die akzeptierten Crypto-Algorithmen im TcpServices Hilfsmodul.
- Die Voreinstellung TLSv12:!SSLv3 wird als sicherer erachtet als die
- vorherige SSLv23:!SSLv3:!SSLv2, aber sie kann Probleme mit nicht
- ausreichend aktualisierten Netzwerk-Diensten verursachen.
- </li><br>
- <a name="stacktrace"></a>
- <li>stacktrace<br>
- Falls gesetzt (auf 1), schreibt ins FHEM-Log zusätzlich zu jedem
- "PERL WARNING" den stacktrace.
- </li><br>
- <a name="restartDelay"></a>
- <li>restartDelay<br>
- Setzt die Verzögerung beim Neustart mit shutdown restart, die
- Voreinstellung ist 2 (Sekunden).
- </li><br>
- <a name="autosave"></a>
- <li>autosave<br>
- Erlaubt manchen Modulen save auszuführen, nach einer automatischen
- Änderung der Konfiguration, z.Bsp. nachdem ein Gerät angelegt
- wurde. Die Voreinstellung ist 1 (wahr), man kann es ausschalten, indem
- man den Wert auf 0 setzt.
- </li>
- </ul>
- <br><br>
- <b>Events</b>
- <ul>
- <li>INITIALIZED<br>sobald die Initialization vollständig ist.</li>
- <li>REREADCFG<br>nachdem die Konfiguration erneut eingelesen wurde.</li>
- <li>SAVE<br>bevor die Konfiguration gespeichert wird.</li>
- <li>SHUTDOWN<br>bevor FHEM heruntergefahren wird.</li>
- <li>DEFINED <devname><br>nach dem Definieren eines
- Gerätes.</li>
- <li>DELETED <devname><br>nach dem Löschen eines
- Gerätes.</li>
- <li>RENAMED <old> <new><br>nach dem Umbenennen eines
- Gerätes.</li>
- <li>UNDEFINED <defspec><br>beim Auftreten einer Nachricht für
- ein undefiniertes Gerät.</li>
- <li>MODIFIED <defspec><br>nach Änderung einer
- Gerätedefinition.</li>
- <li>UPDATE<br>nach Abschluss eines Updates.</li>
- </ul>
- </ul>
- <!-- global end - diese Zeile nicht entfernen! -->
- <a name="ALL3076"></a>
- <h3>ALL3076</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ALL3076'>ALL3076</a><br/>
- </ul>
- <a name="ALL4000T"></a>
- <h3>ALL4000T</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ALL4000T'>ALL4000T</a><br/>
- </ul>
- <a name="ALL4027"></a>
- <h3>ALL4027</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ALL4027'>ALL4027</a><br/>
- </ul>
- <a name="AMAD"></a>
- <h3>AMAD</h3>
- <div class='langLinks'>[<a href='commandref.html#AMAD'>EN</a> DE]</div>
- <ul>
- <u><b>AMAD - Automagic Android Device</b></u>
- <br>
- Dieses Modul liefert, <b><u>in Verbindung mit der Android APP Automagic</u></b>, diverse Informationen von Android Geräten.
- Die AndroidAPP Automagic (welche nicht von mir stammt und 2.90 Euro kostet) funktioniert wie Tasker, ist aber bei weitem User freundlicher.
- <br>
- Mit etwas Einarbeitung können jegliche Informationen welche Automagic bereit stellt in FHEM angezeigt werden. Hierzu bedarf es lediglich eines eigenen Flows welcher seine Daten an die AMADCommBridge sendet. Das Modul gibt auch die Möglichkeit Androidgeräte zu steuern.
- <br>
- Für all diese Aktionen und Informationen wird auf dem Androidgerät "Automagic" und ein so genannter Flow benötigt. Die App ist über den Google PlayStore zu beziehen. Das benötigte Flowset bekommt man aus dem FHEM Verzeichnis.
- <br><br>
- <b>Wie genau verwendet man nun AMAD?</b>
- <ul>
- <li>man installiert die App "Automagic Premium" aus dem PlayStore.</li>
- <li>dann installiert man das Flowset 74_AMADautomagicFlowset$VERSION.xml aus dem Ordner $INSTALLFHEM/FHEM/lib/ auf dem Androidgerät und aktiviert die Flows.</li>
- </ul>
- <br>
- Es muß noch ein Device in FHEM anlegt werden.
- <br><br>
- <a name="AMADdefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> AMAD <IP-ADRESSE></code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define WandTabletWohnzimmer AMAD 192.168.0.23</code><br>
- </ul>
- <br>
- Diese Anweisung erstellt zwei neues AMAD-Device im Raum AMAD.Der Parameter <IP-ADRESSE> legt die IP Adresse des Android Gerätes fest.<br>
- Das zweite Device ist die AMADCommBridge welche als Kommunikationsbrücke vom Androidgerät zu FHEM diehnt. !!!Comming Soon!!! Wer den Port ändern möchte, kann dies über das Attribut "port" tun. <b>Ihr solltet aber wissen was Ihr tut, da dieser Port im HTTP Request Trigger der beiden Flows eingestellt ist. Demzufolge muß der Port dort auch geändert werden. Der Port für die Bridge kann ohne Probleme im Bridge Device mittels dem Attribut "port" verändert werden.
- <br>
- Der Port für die Bridge kann ohne Probleme im Bridge Device mittels dem Attribut "port" verändert werden.</b>
- </ul>
- <br><a name="AMADCommBridge"></a>
- <b>AMAD Communication Bridge</b>
- <ul>
- Beim ersten anlegen einer AMAD Deviceinstanz wird automatisch ein Gerät Namens AMADCommBridge im Raum AMAD mit angelegt. Dieses Gerät diehnt zur Kommunikation vom Androidgerät zu FHEM ohne das zuvor eine Anfrage von FHEM aus ging. <b>Damit das Androidgerät die IP von FHEM kennt, muss diese sofort nach dem anlegen der Bridge über den set Befehl in ein entsprechendes Reading in die Bridge geschrieben werden. DAS IST SUPER WICHTIG UND FÜR DIE FUNKTION DER BRIDGE NOTWENDIG.</b><br>
- Hierfür muß folgender Befehl ausgeführt werden. <i>set AMADCommBridge fhemServerIP <FHEM-IP>.</i><br>
- Als zweites Reading kann <i>expertMode</i> gesetzen werden. Mit diesem Reading wird eine unmittelbare Komminikation mit FHEM erreicht ohne die Einschränkung über ein
- Notify gehen zu müssen und nur reine set Befehle ausführen zu können.
- </ul><br>
- <b><u>NUN bitte die Flows AKTIVIEREN!!!</u></b><br>
- <br>
- <b><u>Fertig! Nach anlegen der Geräteinstanz und dem eintragen der fhemServerIP in der CommBridge sollten nach spätestens 15 Sekunden bereits die ersten Readings reinkommen. Nun wird alle 15 Sekunden probiert einen Status Request erfolgreich ab zu schließen. Wenn der Status sich über einen längeren Zeitraum nicht auf "active" ändert, sollte man im Log nach eventuellen Fehlern suchen.</u></b>
- <br><br><br>
- <a name="AMADreadings"></a>
- <b>Readings</b>
- <ul>
- <li>airplanemode - Status des Flugmodus</li>
- <li>androidVersion - aktuell installierte Androidversion</li>
- <li>automagicState - Statusmeldungen von der AutomagicApp <b>(Voraussetzung Android >4.3). Ist Android größer 4.3 vorhanden und im Reading steht "wird nicht unterstützt", muß in den Androideinstellungen unter Ton und Benachrichtigungen -> Benachrichtigungszugriff ein Haken für Automagic gesetzt werden</b></li>
- <li>batteryHealth - Zustand der Battery (1=unbekannt, 2=gut, 3=Überhitzt, 4=tot, 5=Überspannung, 6=unbekannter Fehler, 7=kalt)</li>
- <li>batterytemperature - Temperatur der Batterie</li>
- <li>bluetooth - on/off, Bluetooth Status an oder aus</li>
- <li>checkActiveTask - Zustand einer zuvor definierten APP. 0=nicht aktiv oder nicht aktiv im Vordergrund, 1=aktiv im Vordergrund, <b>siehe Hinweis unten</b></li>
- <li>connectedBTdevices - eine Liste der verbundenen Gerät</li>
- <li>connectedBTdevicesMAC - eine Liste der MAC Adressen aller verbundender BT Geräte</li>
- <li>currentMusicAlbum - aktuell abgespieltes Musikalbum des verwendeten Mediaplayers</li>
- <li>currentMusicApp - aktuell verwendeter Mediaplayer (Amazon Music, Google Play Music, Google Play Video, Spotify, YouTube, TuneIn Player, Aldi Life Music)</li>
- <li>currentMusicArtist - aktuell abgespielter Musikinterpret des verwendeten Mediaplayers</li>
- <li>currentMusicIcon - Cover vom aktuell abgespielten Album <b>Noch nicht fertig implementiert</b></li>
- <li>currentMusicState - Status des aktuellen/zuletzt verwendeten Mediaplayers</li>
- <li>currentMusicTrack - aktuell abgespielter Musiktitel des verwendeten Mediaplayers</li>
- <li>daydream - on/off, Daydream gestartet oder nicht</li>
- <li>deviceState - Status des Androidgerätes. unknown, online, offline.</li>
- <li>doNotDisturb - aktueller Status des nicht stören Modus</li>
- <li>dockingState - undocked/docked Status ob sich das Gerät in einer Dockinstation befindet.</li>
- <li>flow_SetCommands - active/inactive, Status des SetCommands Flow</li>
- <li>flow_informations - active/inactive, Status des Informations Flow</li>
- <li>flowsetVersionAtDevice - aktuell installierte Flowsetversion auf dem Device</li>
- <li>incomingCallerName - Anrufername des eingehenden Anrufes</li>
- <li>incomingCallerNumber - Anrufernummer des eingehenden Anrufes</li>
- <li>incommingWhatsAppMessageFrom - letzte WhatsApp Nachricht</li>
- <li>incommingWhatsTelegramMessageFrom - letzte Telegram Nachricht</li>
- <li>intentRadioName - zuletzt gesrreamter Intent Radio Name</li>
- <li>intentRadioState - Status des IntentRadio Players</li>
- <li>keyguardSet - 0/1 Displaysperre gesetzt 0=nein 1=ja, bedeutet nicht das sie gerade aktiv ist</li>
- <li>lastSetCommandError - letzte Fehlermeldung vom set Befehl</li>
- <li>lastSetCommandState - letzter Status vom set Befehl, Befehl erfolgreich/nicht erfolgreich gesendet</li>
- <li>lastStatusRequestError - letzte Fehlermeldung vom statusRequest Befehl</li>
- <li>lastStatusRequestState - letzter Status vom statusRequest Befehl, Befehl erfolgreich/nicht erfolgreich gesendet</li>
- <li>nextAlarmDay - aktiver Alarmtag</li>
- <li>nextAlarmState - aktueller Status des <i>"Androidinternen"</i> Weckers</li>
- <li>nextAlarmTime - aktive Alarmzeit</li>
- <li>powerLevel - Status der Batterie in %</li>
- <li>powerPlugged - Netzteil angeschlossen? 0=NEIN, 1|2=JA</li>
- <li>screen - on locked/unlocked, off locked/unlocked gibt an ob der Bildschirm an oder aus ist und gleichzeitig gesperrt oder nicht gesperrt</li>
- <li>screenBrightness - Bildschirmhelligkeit von 0-255</li>
- <li>screenFullscreen - on/off, Vollbildmodus (An,Aus)</li>
- <li>screenOrientation - Landscape,Portrait, Bildschirmausrichtung (Horizontal,Vertikal)</li>
- <li>screenOrientationMode - auto/manual, Modus für die Ausrichtung (Automatisch, Manuell)</li>
- <li>state - aktueller Status</li>
- <li>userFlowState - aktueller Status eines Flows, festgelegt unter dem setUserFlowState Attribut</li>
- <li>volume - Media Lautstärkewert</li>
- <li>volumeNotification - Benachrichtigungs Lautstärke</li>
- <br>
- Beim Reading checkActivTask muß zuvor der Packagename der zu prüfenden App als Attribut <i>checkActiveTask</i> angegeben werden. Beispiel: <i>attr Nexus10Wohnzimmer
- checkActiveTask com.android.chrome</i> für den Chrome Browser.
- <br><br>
- </ul>
- <br><br>
- <a name="AMADset"></a>
- <b>Set</b>
- <ul>
- <li>activateVoiceInput - aktiviert die Spracheingabe</li>
- <li>bluetooth - on/off, aktiviert/deaktiviert Bluetooth</li>
- <li>clearNotificationBar - All,Automagic, löscht alle Meldungen oder nur die Automagic Meldungen in der Statusleiste</li>
- <li>closeCall - beendet einen laufenden Anruf</li>
- <li>currentFlowsetUpdate - fürt ein Flowsetupdate auf dem Device durch</li>
- <li>doNotDisturb - schaltet den nicht stören Modus, always immer stören, never niemals stören, alarmClockOnly nur Wecker darf stören, onlyImportant nur wichtige Störungen</li>
- <li>installFlowSource - installiert einen Flow auf dem Device, <u>das XML File muss unter /tmp/ liegen und die Endung xml haben</u>. <b>Bsp:</b> <i>set TabletWohnzimmer installFlowSource WlanUebwerwachen.xml</i></li>
- <li>mediaAmazonMusic - play, stop, next, back ,steuert den Amazon Musik Mediaplayer</li>
- <li>mediaGoogleMusic - play, stop, next, back ,steuert den Google Play Musik Mediaplayer</li>
- <li>mediaSpotifyMusic - play, stop, next, back ,steuert den Spotify Mediaplayer</li>
- <li>nextAlarmTime - setzt die Alarmzeit. gilt aber nur innerhalb der nächsten 24Std.</li>
- <li>openCall - ruft eine Nummer an und legt optional nach X Sekunden auf / set DEVICE openCall 01736458 10 / ruft die Nummer an und beendet den Anruf nach 10s</li>
- <li>screenBrightness - setzt die Bildschirmhelligkeit, von 0-255.</li>
- <li>screenMsg - versendet eine Bildschirmnachricht</li>
- <li>sendintent - sendet einen Intentstring <u>Bsp:</u><i> set $AMADDEVICE sendIntent org.smblott.intentradio.PLAY url http://stream.klassikradio.de/live/mp3-192/stream.klassikradio.de/play.m3u name Klassikradio</i>, der erste Befehl ist die Aktion und der zweite das Extra. Es können immer zwei Extras mitgegeben werden.</li>
- <li>sendSMS - sendet eine SMS an eine bestimmte Telefonnummer. Bsp.: sendSMS Dies ist ein Test|555487263</li>
- <li>statusRequest - Fordert einen neuen Statusreport beim Device an. Es können nicht von allen Readings per statusRequest die Daten geholt werden. Einige wenige geben nur bei Statusänderung ihren Status wieder.</li>
- <li>timer - setzt einen Timer innerhalb der als Standard definierten ClockAPP auf dem Device. Es können nur Sekunden angegeben werden.</li>
- <li>ttsMsg - versendet eine Nachricht welche als Sprachnachricht ausgegeben wird</li>
- <li>userFlowState - aktiviert oder deaktiviert einen oder mehrere Flows,<b><i>set Nexus7Wohnzimmer Badezimmer vorheizen:inactive</i> oder <i>set Nexus7Wohnzimmer Badezimmer vorheizen,Nachtlicht Steven:inactive</i></b></li>
- <li>vibrate - lässt das Androidgerät vibrieren</li>
- <li>volume - setzt die Medialautstärke. Entweder die internen Lautsprecher oder sofern angeschlossen die Bluetoothlautsprecher und per Klinkenstecker angeschlossene Lautsprecher, + oder - vor dem Wert reduziert die aktuelle Lautstärke um den Wert</li>
- <li>volumeNotification - setzt die Benachrichtigungslautstärke.</li>
- </ul>
- <br>
- <b>Set abhängig von gesetzten Attributen</b>
- <ul>
- <li>changetoBtDevice - wechselt zu einem anderen Bluetooth Gerät. <b>Attribut setBluetoothDevice muß gesetzt sein. Siehe Hinweis unten!</b></li>
- <li>notifySndFile - spielt die angegebene Mediadatei auf dem Androidgerät ab. <b>Die aufzurufende Mediadatei sollte sich im Ordner /storage/emulated/0/Notifications/ befinden. Ist dies nicht der Fall kann man über das Attribut setNotifySndFilePath einen Pfad vorgeben.</b></li>
- <li>openApp - öffnet eine ausgewählte App. <b>Attribut setOpenApp</b></li>
- <li>openURL - öffnet eine URL im Standardbrowser, sofern kein anderer Browser über das <b>Attribut setOpenUrlBrowser</b> ausgewählt wurde.<b> Bsp:</b><i> attr Tablet setOpenUrlBrowser de.ozerov.fully|de.ozerov.fully.MainActivity, das erste ist der Package Name und das zweite der Class Name</i></li>
- <li>setAPSSID - setzt die AccessPoint SSID um ein WLAN sleep zu verhindern</li>
- <li>screen - on/off/lock/unlock schaltet den Bildschirm ein/aus oder sperrt/entsperrt ihn, in den Automagic Einstellungen muss "Admin Funktion" gesetzt werden sonst funktioniert "Screen off" nicht. <b>Attribut setScreenOnForTimer</b> ändert die Zeit wie lange das Display an bleiben soll!</li>
- <li>screenFullscreen - on/off, (aktiviert/deaktiviert) den Vollbildmodus. <b>Attribut setFullscreen</b></li>
- <li>screenLock - Sperrt den Bildschirm mit Pinabfrage. <b>Attribut setScreenlockPIN - hier die Pin dafür eingeben. Erlaubt sind nur Zahlen. Es müßen mindestens 4, bis max 16 Zeichen verwendet werden.</b></li>
- <li>screenOrientation - Auto,Landscape,Portait, aktiviert die Bildschirmausrichtung (Automatisch,Horizontal,Vertikal). <b>Attribut setScreenOrientation</b></li>
- <li>system - setzt Systembefehle ab (nur bei gerootetet Geräen). reboot,shutdown,airplanemodeON (kann nur aktiviert werden) <b>Attribut root</b>, in den Automagic Einstellungen muss "Root Funktion" gesetzt werden</li>
- <li>setNotifySndFilePath - setzt den korrekten Systempfad zur Notifydatei (default ist /storage/emulated/0/Notifications/</li>
- <li>setTtsMsgSpeed - setzt die Sprachgeschwindigkeit bei der Sprachausgabe(Werte zwischen 0.5 bis 4.0 in 0.5er Schritten) default ist 1.0</li>
- <li>setTtsMsgSpeed - setzt die Sprache bei der Sprachausgabe, de oder en (default ist de)</li>
- <br>
- Um openApp verwenden zu können, muss als Attribut der Package Name der App angegeben werden.
- <br><br>
- Um zwischen Bluetoothgeräten wechseln zu können, muß das Attribut setBluetoothDevice mit folgender Syntax gesetzt werden. <b>attr <DEVICE> BTdeviceName1|MAC,BTDeviceName2|MAC</b> Es muss
- zwingend darauf geachtet werden das beim BTdeviceName kein Leerzeichen vorhanden ist. Am besten zusammen oder mit Unterstrich. Achtet bei der MAC darauf das Ihr wirklich nach jeder zweiten Zahl auch
- einen : drin habt<br>
- Beispiel: <i>attr Nexus10Wohnzimmer setBluetoothDevice Logitech_BT_Adapter|AB:12:CD:34:EF:32,Anker_A3565|GH:56:IJ:78:KL:76</i>
- </ul>
- <br><br>
- <a name="AMADstate"></a>
- <b>state</b>
- <ul>
- <li>initialized - Ist der Status kurz nach einem define.</li>
- <li>active - die Geräteinstanz ist im aktiven Status.</li>
- <li>disabled - die Geräteinstanz wurde über das Attribut disable deaktiviert</li>
- </ul>
- <br><br><br>
- <u><b>Anwendungsbeispiele:</b></u>
- <ul><br>
- <a href="http://www.fhemwiki.de/wiki/AMAD#Anwendungsbeispiele">Hier verweise ich auf den gut gepflegten Wikieintrag</a>
- </ul>
- <br><br><br>
- </ul>
- <p><a name="AMADCommBridge"></a>
- <h3>AMADCommBridge</h3>
- <div class='langLinks'>[<a href='commandref.html#AMADCommBridge'>EN</a> DE]</div>
- <ul>
- <u><b>AMAD - Automagic Android Device</b></u></p>
- <b>AMADCommBridge - Kommunikationsbrücke für alle AMAD Geräte</b>
- </br>
- Dieses Modul ist das Ausgangsmodul zur erfolgreichen Integration von Androidgeräten in FHEM. Es stellt ferner eine Verbindungsebene zwischen AMAD unterstützten Geräten und FHEM zur Verfügung. Alle Kommunikation zwischen AMAD Android und FHEM läuft über diese Schnittstelle.</br>
- Daher erfolgt die Ersteinrichtung eines AMAD Devices auch genau über diese Modulinstanz.
- </br></br>
- Damit erfolgreich ein Androidgerät in FHEM eingerichtet werden kann, muss im ersten Schritt ein AMADCommBridge Device angelegt werden.
- <br><br>
- <a name="AMADCommBridgedefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> AMADCommBridge</code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define AMADBridge AMADCommBridge</code><br>
- </ul>
- <br>
- Diese Anweisung erstellt ein neues AMADCommBridge Device Namens AMADBridge.
- </ul></br>
- Es kann wahlweise die APP Automagic oder Tasker auf dem Android Gerät verwendet werden.
- <br>
- <b>Für Autoremote:</b><br>
- Im folgenden muß lediglich das Flowset auf dem Android Gerät installiert werden und der Flow 'First Run Assistent' ausgeführt werden. (einfach den Homebutton drücken)</br>
- Der Assistent geleitet Dich dann durch die Einrichtung Deines AMAD Gerätes und sorgt dafür das am Ende des Installationsprozess das Androidgerät als AMAD Device in FHEM angelegt wird.</br>
- <br>
- <b>Für Tasker:</b><br>
- Bei Verwendung von Tasker muss das Tasker-Projekt auf das Android Gerät geladen und in Tasker über die Import Funktion importiert werden.<br>
- Für die Ersteinrichtung auf dem Android Gerät gibt es eine Eingabemaske (Scene), in der die benötigten Parameter (Device Name, Device IP, Bridgeport usw.)</br>
- eingegeben werden können, diese Felder werden (soweit möglich) automatisch befüllt, können aber auch manuell angepasst werden.</br>
- Hierfür den Task "AMAD" ausführen.</br>
- Für schnellen Zugriff kann für diesen Task auch ein Tasker-Shortcut auf dem Homescreen angelegt werden.</br>
- Infos zu den einzelnen Einstellungen erhält man durch einen Touch auf das jeweiligen Textfeld.</br>
- Sind alle Eingaben vollständig, kann das AMAD Device über die Schaltfläche "create Device" erstellt werden.</br>
- Damit Steuerbefehle von FHEM zu Tasker funktionieren wird zusätzlich noch die APP "Autoremote" oder "Tasker Network Event Server (TNES)" benötigt.
- </ul>
- <br><br>
- <a name="AMADCommBridgereadings"></a>
- <b>Readings</b>
- <ul><br>
- <li>JSON_ERROR - JSON Fehlermeldung welche von Perl gemeldet wird</li>
- <li>JSON_ERROR_STRING - der String welcher die JSON Fehlermeldung verursacht hat</li>
- <li>fhemServerIP - die Ip-Adresse des FHEM Servers, wird vom Modul auf Basis des JSON Strings vom Installationsassistenten gesetzt. Kann aber auch mittels set Befehles vom User gesetzt werden</li>
- <li>receiveFhemCommand - ist das Attribut fhemControlMode auf trigger gestellt, wird das Reading gesetzt sobald ein FHEM Befehl übersendet wird. Hierauf kann dann ein Notify triggern.</br>
- Wird anstelle von trigger setControl als Wert für fhemControlMode eingestellt, wird das Reading nicht gestzt sondern der set Befehl sofort ausgeführt.</li>
- <li>receiveVoiceCommand - wird die Sprachsteuerung von AMAD aktiviert (set DEVICE activateVoiceInput) so wird der letzte erkannten Sprachbefehle in dieses Reading geschrieben.</li>
- <li>receiveVoiceDevice - Name des Devices von wo aus der letzte erkannte Sprachbefehl gesendet wurde</li>
- <li>state - Status der Bridge, open, closed</li>
- </ul>
- <br><br>
- <a name="AMADCommBridgeattribute"></a>
- <b>Attribute</b>
- <ul><br>
- <li>allowFrom - Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.</br>
- Achtung: falls allowfrom nicht gesetzt ist, und keine gütige allowed Instanz definiert ist, und die Gegenstelle eine nicht lokale Adresse hat, dann wird die Verbindung abgewiesen. Folgende Adressen werden als local betrachtet:</br>
- IPV4: 127/8, 10/8, 192.168/16, 172.16/10, 169.254/16</br>
- IPV6: ::1, fe80/10</li>
- <li>debugJSON - wenn auf 1 gesetzt, werden JSON Fehlermeldungen in Readings geschrieben. Siehe hierzu JSON_ERROR* unter Readings</li>
- <li>fhemControlMode - steuert die zulässige Art der Kontrolle von FHEM Devices. Du kannst über die Bridge auf 2 Arten FHEM Devices steuern. Entweder per direktem FHEM Befehl aus einem Flow heraus, oder als Sprachbefehl mittels Sprachsteuerung (set DEVICE activateVoiceInput)
- <ul><li>trigger - ist der Wert trigger gesetzt, werden alle an die Bridge gesendeten FHEM set Befehle in das Reading receiveFhemCommand geschrieben und können so mittels notify ausgeführt werden. Sprachsteuerung ist möglich, es werden Readings receiveVoice* gesetzt. Auf dem Androidgerät können bei Sprachsteuerung mehrere Sprachbefehle mittels "und" verknüpft/aneinander gereiht werden. Bsp: schalte die Lichtszene Abends an und schalte den Fernsehr an</li>
- <li>setControl - alle set Befehle welche mittels eines Flows über die Bridge gesendet werden, werden automatisch ausgeführt. Das triggern eines Readings ist nicht nötig. Die Steuerung mittels Sprache verhält sich wie beim Wert trigger</li>
- <li>thirdPartControl - verhält sich wie trigger, bei der Sprachsteuerung ist jedoch ein anreihen von Sprachbefehlen mittels "und" nicht möglich. Dient der Sprachsteuerung über Module anderer Modulautoren ((z.B. 39_TEERKO.pm)</li></ul>
- </li>
- </ul>
- </br></br>
- Wie man bei Problemen mit dem Assistenten ein Androidgerät auch von Hand anlegen kann, erfährst Du in der Commandref zum AMADDevice Modul.
- </ul>
- <p><a name="AMADDevice"></a>
- <h3>AMADDevice</h3>
- <div class='langLinks'>[<a href='commandref.html#AMADDevice'>EN</a> DE]</div>
- <ul>
- <u><b>AMADDevice - Automagic Android Device</b></u>
- <br>
- Dieses Modul liefert, <b><u>in Verbindung mit der Android APP Automagic oder Tasker</u></b>, diverse Informationen von Android Geräten.
- Die Android APP Automagic (welche nicht von mir stammt und 2.90 Euro kostet) funktioniert wie Tasker, ist aber bei weitem User freundlicher.
- <br>
- Mit etwas Einarbeitung können jegliche Informationen welche Automagic/Tasker bereit stellt in FHEM angezeigt werden. Hierzu bedarf es lediglich eines eigenen Flows/Task welcher seine Daten an die AMADDeviceCommBridge sendet. Das Modul gibt auch die Möglichkeit Androidgeräte zu steuern.
- <br>
- Für all diese Aktionen und Informationen wird auf dem Androidgerät "Automagic/Tasker" und ein so genannter Flow/Task benötigt. Die App ist über den Google PlayStore zu beziehen. Das benötigte Flowset/Tasker-Projekt bekommt man aus dem FHEM Verzeichnis.
- <br><br>
- <b>Wie genau verwendet man nun AMADDevice?</b>
- <ul>
- <li>stelle sicher das als aller erstes die AMADCommBridge in FHEM definiert wurde</li>
- <li><b>Bei verwendung von Autoremote</b></li>
- <ul>
- <li>installiere die App "Automagic Premium" aus dem PlayStore.</li>
- <li>installiere das Flowset 74_AMADDeviceautomagicFlowset$VERSION.xml aus dem Ordner $INSTALLFHEM/FHEM/lib/ auf dem Androidgerät</li>
- <li>aktiviere den Installationsassistanten Flow in Automagic. Wenn man nun Automagic in den Hintergrund schickt, z.B. Hometaste drücken, startet der Assistant und legt automatisch ein Device für das Androidgerät an.</li>
- </ul>
- <li><b>Bei verwendung von Tasker</b></li>
- <ul>
- <li>installiere die App "Tasker" aus dem PlayStore.</li>
- <li>installiere das Tasker Projekt 74_AMADtaskerset_$VERSION.prj.xml aus dem Ordner $INSTALLFHEM/FHEM/lib/ auf dem Androidgerät</li>
- <li>Starte den Task "AMAD", es erscheint eine Eingabemaske in der alle Einstellungen vorgenommen werden können, durch einen Klick auf "create Device" wird das Gerät in FHEM erstellt.</li>
- </ul>
- </ul>
- <br><br>
- <u><b>Ein AMADDevice Gerät von Hand anlegen.</b></u>
- <br><br>
- <a name="AMADDevicedefine"></a>
- <b>Define</b>
- <ul><br>
- 10.6.9.10 1496497380000 IODev=AMADBridge
- <code>define <name> AMADDevice <IP-ADRESSE> <AMAD_ID> IODev=<IODEVICE></code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define WandTabletWohnzimmer AMADDevice 192.168.0.23 123456 IODev=NAME_des_AMADCommBridge_Devices</code><br>
- </ul>
- <br>
- In diesem Fall wird ein AMADDevice von Hand angelegt. Die AMAD_ID, hier 123456, muß auch exakt so als globale Variable in Automagic/Tasker eingetragen sein.
- </ul>
- <br><br><br>
- <a name="AMADDevicereadings"></a>
- <b>Readings</b>
- <ul>
- <li>airplanemode - Status des Flugmodus</li>
- <li>androidVersion - aktuell installierte Androidversion</li>
- <li>automagicState - Statusmeldungen von der Automagic oder Tasker App <b>(Voraussetzung Android >4.3). Ist Android größer 4.3 vorhanden und im Reading steht "wird nicht unterstützt", muß in den Androideinstellungen unter Ton und Benachrichtigungen -> Benachrichtigungszugriff ein Haken für Automagic/Tasker gesetzt werden</b></li>
- <li>batteryHealth - Zustand der Battery (1=unbekannt, 2=gut, 3=Überhitzt, 4=tot, 5=Überspannung, 6=unbekannter Fehler, 7=kalt) (nur Automagic)</li>
- <li>batterytemperature - Temperatur der Batterie (nur Automagic)</li>
- <li>bluetooth - on/off, Bluetooth Status an oder aus</li>
- <li>checkActiveTask - Zustand einer zuvor definierten APP. 0=nicht aktiv oder nicht aktiv im Vordergrund, 1=aktiv im Vordergrund, <b>siehe Hinweis unten</b> (nur Automagic)</li>
- <li>connectedBTdevices - eine Liste der verbundenen Gerät (nur Automagic)</li>
- <li>connectedBTdevicesMAC - eine Liste der MAC Adressen aller verbundender BT Geräte (nur Automagic)</li>
- <li>currentMusicAlbum - aktuell abgespieltes Musikalbum des verwendeten Mediaplayers (nur Automagic)</li>
- <li>currentMusicApp - aktuell verwendeter Mediaplayer (Amazon Music, Google Play Music, Google Play Video, Spotify, YouTube, TuneIn Player, Aldi Life Music) (nur Automagic)</li>
- <li>currentMusicArtist - aktuell abgespielter Musikinterpret des verwendeten Mediaplayers (nur Automagic)</li>
- <li>currentMusicIcon - Cover vom aktuell abgespielten Album <b>Noch nicht fertig implementiert</b> (nur Automagic)</li>
- <li>currentMusicState - Status des aktuellen/zuletzt verwendeten Mediaplayers (nur Automagic)</li>
- <li>currentMusicTrack - aktuell abgespielter Musiktitel des verwendeten Mediaplayers (nur Automagic)</li>
- <li>daydream - on/off, Daydream gestartet oder nicht</li>
- <li>deviceState - Status des Androidgerätes. unknown, online, offline.</li>
- <li>doNotDisturb - aktueller Status des nicht stören Modus</li>
- <li>dockingState - undocked/docked Status ob sich das Gerät in einer Dockinstation befindet.</li>
- <li>flow_SetCommands - active/inactive, Status des SetCommands Flow</li>
- <li>flow_informations - active/inactive, Status des Informations Flow</li>
- <li>flowsetVersionAtDevice - aktuell installierte Flowsetversion auf dem Device</li>
- <li>incomingCallerName - Anrufername des eingehenden Anrufes</li>
- <li>incomingCallerNumber - Anrufernummer des eingehenden Anrufes</li>
- <li>incomingWhatsAppMessage - letzte WhatsApp Nachricht</li>
- <li>incomingTelegramMessage - letzte Telegram Nachricht</li>
- <li>incomingSmsMessage - letzte SMS Nachricht</li>
- <li>intentRadioName - zuletzt gesrreamter Intent Radio Name</li>
- <li>intentRadioState - Status des IntentRadio Players</li>
- <li>keyguardSet - 0/1 Displaysperre gesetzt 0=nein 1=ja, bedeutet nicht das sie gerade aktiv ist</li>
- <li>lastSetCommandError - letzte Fehlermeldung vom set Befehl</li>
- <li>lastSetCommandState - letzter Status vom set Befehl, Befehl erfolgreich/nicht erfolgreich gesendet</li>
- <li>lastStatusRequestError - letzte Fehlermeldung vom statusRequest Befehl</li>
- <li>lastStatusRequestState - letzter Status vom statusRequest Befehl, Befehl erfolgreich/nicht erfolgreich gesendet</li>
- <li>nextAlarmDay - aktiver Alarmtag</li>
- <li>nextAlarmState - aktueller Status des <i>"Androidinternen"</i> Weckers</li>
- <li>nextAlarmTime - aktive Alarmzeit</li>
- <li>nfc - Status des NFC on/off</li>
- <li>nfcLastTagID - nfc_id des zu letzt gescannten Tag's / Damit die ID korrekt erkannt wird muss im Flow NFC Tag Support der Trigger NFC TagIDs bearbeitet werden und die TagId's Kommasepariert eingetragen werden. (nur Automagic)</li>
- <li>powerLevel - Status der Batterie in %</li>
- <li>powerPlugged - Netzteil angeschlossen? 0=NEIN, 1|2=JA</li>
- <li>screen - on locked/unlocked, off locked/unlocked gibt an ob der Bildschirm an oder aus ist und gleichzeitig gesperrt oder nicht gesperrt</li>
- <li>screenBrightness - Bildschirmhelligkeit von 0-255</li>
- <li>screenFullscreen - on/off, Vollbildmodus (An,Aus) (nur Automagic)</li>
- <li>screenOrientation - Landscape,Portrait, Bildschirmausrichtung (Horizontal,Vertikal)</li>
- <li>screenOrientationMode - auto/manual, Modus für die Ausrichtung (Automatisch, Manuell)</li>
- <li>state - aktueller Status</li>
- <li>userFlowState - aktueller Status eines Flows, festgelegt unter dem setUserFlowState Attribut (nur Automagic)</li>
- <li>volume - Media Lautstärkewert</li>
- <li>volumeNotification - Benachrichtigungs Lautstärke</li>
- <li>wiredHeadsetPlugged - 0/1 gibt an ob ein Headset eingesteckt ist oder nicht</li>
- <br>
- Beim Reading checkActivTask muß zuvor der Packagename der zu prüfenden App als Attribut <i>checkActiveTask</i> angegeben werden. Beispiel: <i>attr Nexus10Wohnzimmer
- checkActiveTask com.android.chrome</i> für den Chrome Browser.
- <br><br>
- </ul>
- <br><br>
- <a name="AMADDeviceset"></a>
- <b>Set</b>
- <ul>
- <li>activateVoiceInput - aktiviert die Spracheingabe</li>
- <li>bluetooth - on/off, aktiviert/deaktiviert Bluetooth</li>
- <li>clearNotificationBar - All,Automagic, löscht alle Meldungen oder nur die Automagic/Tasker Meldungen in der Statusleiste</li>
- <li>closeCall - beendet einen laufenden Anruf</li>
- <li>currentFlowsetUpdate - fürt ein Flowset/Tasker-Projekt update auf dem Device durch</li>
- <li>doNotDisturb - schaltet den nicht stören Modus, always immer stören, never niemals stören, alarmClockOnly nur Wecker darf stören, onlyImportant nur wichtige Störungen</li>
- <li>installFlowSource - installiert einen Flow auf dem Device, <u>das XML File muss unter /tmp/ liegen und die Endung xml haben</u>. <b>Bsp:</b> <i>set TabletWohnzimmer installFlowSource WlanUebwerwachen.xml</i> (nur Automagic)</li>
- <li>mediaPlay - play Befehl zur Media App</li>
- <li>mediaStop - stop Befehl zur Media App</li>
- <li>mediaNext - nächster Titel Befehl zur Media App</li>
- <li>mediaBack - vorheriger Titel zur Media App</li>
- <li>nextAlarmTime - setzt die Alarmzeit. gilt aber nur innerhalb der nächsten 24Std.</li>
- <li>openCall - ruft eine Nummer an und legt optional nach X Sekunden auf / set DEVICE openCall 01736458 10 / ruft die Nummer an und beendet den Anruf nach 10s</li>
- <li>screenBrightness - setzt die Bildschirmhelligkeit, von 0-255.</li>
- <li>screenMsg - versendet eine Bildschirmnachricht</li>
- <li>sendintent - sendet einen Intentstring <u>Bsp:</u><i> set $AMADDeviceDEVICE sendIntent org.smblott.intentradio.PLAY url http://stream.klassikradio.de/live/mp3-192/stream.klassikradio.de/play.m3u name Klassikradio</i>, der erste Befehl ist die Aktion und der zweite das Extra. Es können immer zwei Extras mitgegeben werden.</li>
- <li>sendSMS - sendet eine SMS an eine bestimmte Telefonnummer. Bsp.: sendSMS Dies ist ein Test|555487263</li>
- <li>startDaydream - startet den Daydream</li>
- <li>statusRequest - Fordert einen neuen Statusreport beim Device an. Es können nicht von allen Readings per statusRequest die Daten geholt werden. Einige wenige geben nur bei Statusänderung ihren Status wieder.</li>
- <li>timer - setzt einen Timer innerhalb der als Standard definierten ClockAPP auf dem Device. Es können nur Minuten angegeben werden.</li>
- <li>ttsMsg - versendet eine Nachricht welche als Sprachnachricht ausgegeben wird (um die Sprache für diese eine Durchsage zu ändern setze vor Deinem eigentlichen Text &en; oder &de;)</li>
- <li>userFlowState - aktiviert oder deaktiviert einen oder mehrere Flows/Tasker-Profile,<b><i>set Nexus7Wohnzimmer Badezimmer vorheizen:inactive</i> oder <i>set Nexus7Wohnzimmer Badezimmer vorheizen,Nachtlicht Steven:inactive</i></b></li>
- <li>userFlowRun - führt den angegebenen Flow/Task aus</li>
- <li>vibrate - lässt das Androidgerät vibrieren</li>
- <li>volume - setzt die Medialautstärke. Entweder die internen Lautsprecher oder sofern angeschlossen die Bluetoothlautsprecher und per Klinkenstecker angeschlossene Lautsprecher, + oder - vor dem Wert reduziert die aktuelle Lautstärke um den Wert. Der maximale Sliderwert kann über das Attribut setVolMax geregelt werden.</li>
- <li>volumeUp - erhöht die Lautstärke um den angegeben Wert im entsprechenden Attribut. Ist kein Attribut angegeben wird per default 2 genommen.</li>
- <li>volumeDown - reduziert die Lautstärke um den angegeben Wert im entsprechenden Attribut. Ist kein Attribut angegeben wird per default 2 genommen.</li>
- <li>volumeNotification - setzt die Benachrichtigungslautstärke.</li>
- </ul>
- <br>
- <b>Set abhängig von gesetzten Attributen</b>
- <ul>
- <li>changetoBtDevice - wechselt zu einem anderen Bluetooth Gerät. <b>Attribut setBluetoothDevice muß gesetzt sein. Siehe Hinweis unten!</b> (nur Automagic)</li>
- <li>notifySndFile - spielt die angegebene Mediadatei auf dem Androidgerät ab. <b>Die aufzurufende Mediadatei sollte sich im Ordner /storage/emulated/0/Notifications/ befinden. Ist dies nicht der Fall kann man über das Attribut setNotifySndFilePath einen Pfad vorgeben.</b></li>
- <li>nfc - schaltet nfc an oder aus /on/off<b>Attribut root</b></li>
- <li>openApp - öffnet eine ausgewählte App. <b>Attribut setOpenApp</b></li>
- <li>openURL - öffnet eine URL im Standardbrowser, sofern kein anderer Browser über das <b>Attribut setOpenUrlBrowser</b> ausgewählt wurde.<b> Bsp:</b><i> attr Tablet setOpenUrlBrowser de.ozerov.fully|de.ozerov.fully.MainActivity, das erste ist der Package Name und das zweite der Class Name</i></li>
- <li>screen - on/off/lock/unlock schaltet den Bildschirm ein/aus oder sperrt/entsperrt ihn, in den Automagic Einstellungen muss "Admin Funktion" gesetzt werden sonst funktioniert "Screen off" nicht. <b>Attribut setScreenOnForTimer</b> ändert die Zeit wie lange das Display an bleiben soll! (Tasker unterstützt nur "screen off")</li>
- <li>screenFullscreen - on/off, (aktiviert/deaktiviert) den Vollbildmodus. <b>Attribut setFullscreen</b></li>
- <li>screenLock - Sperrt den Bildschirm mit Pinabfrage. <b>Attribut setScreenlockPIN - hier die Pin dafür eingeben. Erlaubt sind nur Zahlen. Es müßen mindestens 4, bis max 16 Zeichen verwendet werden.</b></li>
- <li>screenOrientation - Auto,Landscape,Portait, aktiviert die Bildschirmausrichtung (Automatisch,Horizontal,Vertikal). <b>Attribut setScreenOrientation</b> (Tasker unterstützt nur Auto on/off)</li>
- <li>system - setzt Systembefehle ab (nur bei gerootetet Geräen). reboot,shutdown,airplanemodeON (kann nur aktiviert werden) <b>Attribut root</b>, in den Automagic Einstellungen muss "Root Funktion" gesetzt werden</li>
- <li>takePicture - löst die Kamera aus für ein Foto <b>Attribut setTakePictureResolution</b></li>
- </ul>
- <br><br>
- <a name="AMADDeviceattribute"></a>
- <b>Attribute</b>
- <ul>
- <li>setNotifySndFilePath - setzt den korrekten Systempfad zur Notifydatei (default ist /storage/emulated/0/Notifications/</li>
- <li>setTtsMsgSpeed - setzt die Sprachgeschwindigkeit bei der Sprachausgabe(Für Automagic: Werte zwischen 0.5 bis 4.0 in 0.5er Schritten, default:1.0)(Für Tasker: Werte zwischen 1 bis 10 in 1er Schritten, default:5)</li>
- <li>setTtsMsgLang - setzt die Sprache bei der Sprachausgabe, de oder en (default ist de)</li>
- <li>setTtsMsgVol - wenn gesetzt wird der Wert als neues Media Volume fü die Sprachansage verwendet und danach wieder der alte Wert eingestellt</li>
- <li>setVolUpDownStep - setzt den Step für volumeUp und volumeDown</li>
- <li>setVolMax - setzt die maximale Volume Gr&uoml;e für den Slider</li>
- <li>setNotifyVolMax - setzt den maximalen Lautstärkewert für Benachrichtigungslautstärke für den Slider</li>
- <li>setRingSoundVolMax - setzt den maximalen Lautstärkewert für Klingellautstärke für den Slider</li>
- <li>setAPSSID - setzt die AccessPoint SSID um ein WLAN sleep zu verhindern (nur Automagic)</li>
- <li>setTakePictureResolution - welche Kameraauflösung soll verwendet werden? (800x600,1024x768,1280x720,1600x1200,1920x1080)</li>
- <li>setTakePictureCamera - welche Kamera soll verwendet werden (Back,Front).</li>
- <br>
- Um openApp verwenden zu können, muss als Attribut der Package Name der App angegeben werden.
- <br><br>
- Um zwischen Bluetoothgeräten wechseln zu können, muß das Attribut setBluetoothDevice mit folgender Syntax gesetzt werden. <b>attr <DEVICE> BTdeviceName1|MAC,BTDeviceName2|MAC</b> Es muss
- zwingend darauf geachtet werden das beim BTdeviceName kein Leerzeichen vorhanden ist. Am besten zusammen oder mit Unterstrich. Achtet bei der MAC darauf das Ihr wirklich nach jeder zweiten Zahl auch
- einen : drin habt<br>
- Beispiel: <i>attr Nexus10Wohnzimmer setBluetoothDevice Logitech_BT_Adapter|AB:12:CD:34:EF:32,Anker_A3565|GH:56:IJ:78:KL:76</i>
- </ul>
- <br><br>
- <a name="AMADDevicestate"></a>
- <b>state</b>
- <ul>
- <li>initialized - Ist der Status kurz nach einem define.</li>
- <li>active - die Geräteinstanz ist im aktiven Status.</li>
- <li>disabled - die Geräteinstanz wurde über das Attribut disable deaktiviert</li>
- </ul>
- <br><br><br>
- <u><b>Anwendungsbeispiele:</b></u>
- <ul><br>
- <a href="http://www.fhemwiki.de/wiki/AMADDevice#Anwendungsbeispiele">Hier verweise ich auf den gut gepflegten Wikieintrag</a>
- </ul>
- <br><br><br>
- </ul>
- <p><a name="Alarm"></a>
- <h3>Alarm</h3>
- <div class='langLinks'>[<a href='commandref.html#Alarm'>EN</a> DE]</div>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Modul_Alarm">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#Alarm">Alarm</a>
- </ul>
- <p><a name="Aqicn"></a>
- <h3>Air Quality Index</h3>
- <div class='langLinks'>[<a href='commandref.html#Aqicn'>EN</a> DE]</div>
- <p><a name="ArduCounter"></a>
- <h3>ArduCounter</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ArduCounter'>ArduCounter</a><br/>
- </ul>
- <a name="Astro"></a>
- <h3>Astro</h3>
- <div class='langLinks'>[<a href='commandref.html#Astro'>EN</a> DE]</div>
- <ul>
- Absichtlich keine deutsche Dokumentation vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#Astro">Astro</a>
- </ul>
- <p><a name="Aurora"></a>
- <h3>Aurora</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Aurora'>Aurora</a><br/>
- </ul>
- <a name="BDKM"></a>
- <h3>BDKM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#BDKM'>BDKM</a><br/>
- </ul>
- <a name="BOSEST"></a>
- <h3>BOSEST</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#BOSEST'>BOSEST</a><br/>
- </ul>
- <a name="BRAVIA"></a>
- <h3>BRAVIA</h3>
- <div class='langLinks'>[<a href='commandref.html#BRAVIA'>EN</a> DE]</div>
- <ul>
- Diese Module dient zur Steuerung von Sony TVs der BRAVIA-Serien beginnend mit dem Modelljahr 2011.
- <br><br>
- <b>Define</b>
- <ul>
- <code>define <name> BRAVIA <ip-or-hostname> [<poll-interval>]</code>
- <br><br>
- Bei der Definition eines BRAVIA Gerätes wird ein interner Task eingeplant,
- der regelmäßig den Status des TV prüft und weitere Informationen abruft.<br>
- Das Intervall des Tasks kann durch den optionalen Parameter <poll-intervall> in Sekunden gesetzt werden.
- Ansonsten wird der Task mit 45 Sekunden als Intervall definiert.
- <br><br>
- Nach der Definition eines Gerätes muss dieses einmalig im TV als Fernbedienung
- registriert werden (<a href=#BRAVIAregister><code>set register</code></a>).
- <br><br>
- Soweit die Readings nicht den allgemeinen AV Readings entsprechen, sind sie gruppiert:
- <table>
- <tr><td>s_*</td><td>: Status</td></tr>
- <tr><td>ci_*</td><td>: Inhaltsinfo</td></tr>
- </table>
- <br><br>
- Das Modul enthält vorgefertigte Layouts für <a href=#remotecontrol>remotecontrol</a> mit PNG und SVG.
- <br><br>
- </ul>
- <a name="BRAVIAset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <option> <value></code>
- <br><br>
- Optionen:
- <ul>
- <li><i>application</i><br>
- Liste der Anwendungen.
- Anwenungen sind ab Modelljahr 2013 verfügbar.</li>
- <li><i>channel</i><br>
- Liste aller bekannten Kanäle. Das Modul merkt sich alle aufgerufenen Kanäle.
- Ab Modelljahr 2013 werden die Kanäle automatisch geladen
- (Anzahl siehe <a href=#BRAVIAchannelsMax>channelsMax</a>).</li>
- <li><i>channelDown</i><br>
- Einen Kanal zurück schalten.</li>
- <li><i>channelUp</i><br>
- Einen Kanal weiter schalten.</li>
- <li><i>input</i><br>
- Liste der Eingänge.
- Eingänge sind ab Modelljahr 2013 verfügbar.</li>
- <li><i>mute</i><br>
- Direkte Stummschaltung erfolgt nur per aktiviertem <a href=#BRAVIAupnp>Upnp</a>.</li>
- <li><i>off</i><br>
- Schaltet den TV aus. Der State des Gerätes wird auf "set_off" gesetzt. Dieser Wert wird nach 60 Sekunden wieder überschrieben oder sobald der TV entsprechend "off" meldet.</li>
- <li><a name="BRAVIAon"></a><i>on</i><br>
- Einschalten des TV, ab Modelljahr 2013 per WOL. Der State des Gerätes wird auf "set_on" gesetzt. Dieser Wert wird nach 60 Sekunden wieder überschrieben oder sobald der TV entsprechend "on" meldet.</li>
- <li><i>pause</i><br>
- Pausiert die Wiedergabe einer Aufnahme, einer internen App, etc.</li>
- <li><i>play</i><br>
- Startet die Wiedergabe einer Aufnahme, einer internen App, etc.</li>
- <li><i>record</i><br>
- Startet die Aufnahme des aktuellen Inhalts.</li>
- <li><a name="BRAVIAregister"></a><i>register</i><br>
- Einmalige Registrierung von FHEM als Fernbedienung im TV.<br>
- Bei <a href=#BRAVIArequestFormat>requestFormat</a> = "xml" erfolgt die Registrierung ohne Parameter.<br>
- Bei <a href=#BRAVIArequestFormat>requestFormat</a> = "json" ist die Registrierung zweistufig.<br>
- Beim Aufruf des Setter gibt es ein Eingabefeld:
- <ol>
- <li>Aufruf mit leerem Eingabefeld. Auf dem TV sollte eine PIN zur Registrierung erscheinen.</li>
- <li>PIN im Eingabefeld eintragen und Registrierung noch mal ausführen</li></ol></li>
- <li><a name="BRAVIArequestFormat"></a><i>requestFormat</i><br>
- "xml" für xml-basierte Kommunikation 2011er/2012er Geräte<br>
- "json" für die Kommunikation seit der 2013er Generation</li>
- <li><i>remoteControl</i><br>
- Direktes Senden von Kommandos an den TV.</li>
- <li><i>statusRequest</i><br>
- Ruft die aktuellen Statusinformationen vom TV ab.</li>
- <li><i>stop</i><br>
- Stoppt die Wiedergabe einer Aufnahme, einer internen App, etc.</li>
- <li><i>text</i><br>
- Überträgt den eingegebenen Text in ein Textfeld der Anzeige.</li>
- <li><i>toggle</i><br>
- Wechselt den Einschaltstatus des TV.</li>
- <li><i>tvpause</i><br>
- Aktiviert den Timeshift-Modus.</li>
- <li><a name="BRAVIAupnp"></a><i>upnp</i><br>
- Aktiviert Upnp zum Abfragen und Einstellen der Lautstärke.</li>
- <li><i>volume</i><br>
- Direktes Setzen der Lautstärke erfolgt nur per aktiviertem <a href=#BRAVIAupnp>Upnp</a>.</li>
- <li><i>volumeDown</i><br>
- Verringert die Lautstärke.</li>
- <li><i>volumeUp</i><br>
- Erhöht die Lautstärke.</li>
- </ul>
- </ul>
- <br>
-
- <a name="BRAVIAattr"></a>
- <b>Attributes</b>
- <ul>
- <code>attr <name> <attribute> <value></code>
- <br><br>
- Attribute:
- <ul>
- <li><a name="BRAVIAchannelsMax"></a><i>channelsMax</i><br>
- Maximale Anzahl der im FHEMWEB angezeigten Kanäle. Der Standartwert ist 50.</li>
- <li><a name="BRAVIAmacaddr"></a><i>macaddr</i><br>
- Ermöglicht das Einschalten des TV per WOL.</li>
- </ul>
- </ul>
- </ul>
- <p><a name="BS"></a>
- <h3>BS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#BS'>BS</a><br/>
- </ul>
- <a name="Babble"></a>
- <h3>Babble</h3>
- <div class='langLinks'>[<a href='commandref.html#Babble'>EN</a> DE]</div>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Modul_Babble">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#babble">babble</a>
- </ul>
- <p><a name="Broadlink"></a>
- <h3>Broadlink</h3>
- <div class='langLinks'>[<a href='commandref.html#Broadlink'>EN</a> DE]</div>
- <ul>
- <i>Broadlink</i> implementiert die Verbindung zu Broadlink Geräten - aktuell mit Broadlink RM Pro, welcher sowohl Infrarot als auch 433MHz aufnehmen und anschließend versenden kann.
- Zusätzlich werden RMMinis und die Wlan Steckdosen SP3 und SP3S unterstützt
- <br>
- Das Modul benötigt AES-Verschlüsslung.<br>
- In Windows installiert man die Untersützung mit:<br>
- <code>ppm install Crypt-CBC</code><br>
- <code>ppm install Crypt-OpenSSL-AES</code><br><br>
- Auf Linux/Raspberry:
- <code>sudo apt-get install libcrypt-cbc-perl</code><br>
- <code>sudo apt-get install libcrypt-rijndael-perl</code><br>
- <code>sudo cpan Crypt/OpenSSL/AES.pm</code><br>
- <br><br>
- <a name="Broadlinkdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Broadlink <ip/host> <mac> <type=rmpro or rmmini or sp3 or sp3s></code>
- <br><br>
- Beispiel: <code>define broadlinkWZ Broadlink 10.23.11.85 34:EA:34:F4:77:7B rmpro</code>
- <br><br>
- Die <i>mac</i>-Adresse des Gerätes muss im folgenden Format eingegeben werden: xx:xx:xx:xx:xx<br>
- Der Typ <i>sp3</i> wird für schaltbare Steckdosen genutzt. <i>rmpro</i> für alle anderen Geräte.
- </ul>
- <br>
-
- <a name="Broadlinkset"></a>
- <b>Set für rmpro</b><br>
- <ul>
- <li><code>set <name> <commandSend> <command name></code>
- <br><br>
- Sendet ein vorher aufgenommenen Befehl
- </li>
- <li><code>set <name> recordNewCommand <command name></code>
- <br><br>
- Nimmt ein neuen Befehl auf. Man muss einen Befehlnamen angeben.
- </li>
- <li>
- <code>set <name> remove <command name></code>
- <br><br>
- Löscht einen vorher aufgezeichneten Befehl.
- </li>
- <li>
- <code>set <name> rename <old command name> <new command name></code>
- <br><br>
- Benennt einen vorher aufgezeichneten Befehl um.
- </li>
- <li><code>set <name> getTemperature</code>
- <br><br>
- Ermittelt die aktuelle Temperatur die am Gerät gemessen wird.
- </li>
- </ul>
- <br>
- <b>Set für rmmini</b><br>
- <ul>
- <li><code>set <name> <commandSend> <command name></code>
- <br><br>
- Sendet ein vorher aufgenommenen Befehl
- </li>
- <li><code>set <name> recordNewCommand <command name></code>
- <br><br>
- Nimmt ein neuen Befehl auf. Man muss einen Befehlnamen angeben.
- </li>
- <li>
- <code>set <name> remove <command name></code>
- <br><br>
- Löscht einen vorher aufgezeichneten Befehl.
- </li>
- <li>
- <code>set <name> rename <old command name> <new command name></code>
- <br><br>
- Benennt einen vorher aufgezeichneten Befehl um.
- </li>
- </ul>
- <br>
- <b>Set für sp3</b><br>
- <ul>
- <li><code>set <name> on</code>
- <br><br>
- Schaltet das Gerät an.
- </li>
- <li><code>set <name> off</code>
- <br><br>
- Schaltet das Gerät aus.
- </li>
- <li><code>set <name> toggle</code>
- <br><br>
- Schaltet das Gerät entweder ein oder aus.
- </li>
- <li><code>set <name> getStatus</code>
- <br><br>
- Ermittelt den aktuellen Status des Gerätes.
- </li>
- </ul>
- <br>
- <b>Set für sp3s</b><br>
- <ul>
- <li><code>set <name> on</code>
- <br><br>
- Schaltet das Gerät an.
- </li>
- <li><code>set <name> off</code>
- <br><br>
- Schaltet das Gerät aus.
- </li>
- <li><code>set <name> toggle</code>
- <br><br>
- Schaltet das Gerät entweder ein oder aus.
- </li>
- <li><code>set <name> getStatus</code>
- <br><br>
- Ermittelt den aktuellen Status des Gerätes.
- </li>
- <li><code>set <name> getEnergy</code>
- <br><br>
- Ermittelt den aktuellen Stromverbrauch des angeschlossenen Gerätes.
- </li>
- </ul>
- <br>
- <a name="Broadlinkattr"></a>
- <b>Attribute für alle Broadlink Gräte</b><br>
- <ul>
- <li><code>socket_timeout</code>
- <br><br>
- Setzt den Timeout für die Gerätekommunikation.
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="CALVIEW"></a>
- <h3>CALVIEW</h3>
- <div class='langLinks'>[<a href='commandref.html#CALVIEW'>EN</a> DE]</div>
- <ul>Dieses Modul erstellt ein Device welches als Readings Termine eines oder mehrere Kalender(s), basierend auf dem 57_Calendar.pm Modul, besitzt. Ihr müsst das Perl-Modul Date::Parse installieren!</ul>
- <ul>Aktuell wird nur die "get <> next" Funktion vom CALENDAR untertstützt.</ul>
- <b>Define</b>
- <ul><code>define <Name> CALVIEW <Kalendername(n) getrennt durch ','> <next> <updateintervall in sek (default 43200)></code></ul>
- <ul><code>define myView CALVIEW Googlekalender next</code></ul>
- <ul><code>define myView CALVIEW Googlekalender,holiday next 900</code></ul>
- <ul>- die Einstellung des Aktualisierungsintervalls wird normalerweise nicht benötigt, da jede Kalenderaktualisierung ein Caview-Update auslöst</ul>
- <a name="CALVIEW set"></a>
- <b>Set</b>
- <ul>update readings:</ul>
- <ul><code>set <Name> update</code></ul>
- <ul><code>set myView update</code></ul><br>
- <b>Attributes</b>
- <li>datestyle<br>
- nicht gesetzt - Standard, Readings bdatetimeiso / edatetimeiso werden nicht gezeigt<br>
- ISO8601 - aktiviert die readings bdatetimeiso / edatetimeiso (zeigen Terminstart und Ende im ISO8601 Format zB. 2017-02-27T00:00:00)
- </li><br>
- <li>disable<br>
- 0 / nicht gesetzt - aktiviert die interne Notify-Funktion (Standard) <br>
- 1 - deaktiviert die interne Notify-Funktion welche ausgelöst wird wenn sich einer der Kalender aktualisiert hat
- </li><br>
- <li>filterSummary <filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>]<br>
- not set - zeigt alle Termine (Standard) <br>
- <filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>] - CALVIEW filtert Termine die <filtersquelle>:<filtertitel> entsprechen, mehrere Filter sind durch Komma (,) zu trennen.
-
- zb.: filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Abfall:Bioabfall
- filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Feiertage:.*,Kalender_Christian:.*,Kalender_Geburtstage:.*
-
- </li><br>
- <li>fulldaytext [text]<br>
- Dieser Text wird bei ganztägigen Terminen in _timeshort Readings genutzt (default ganztägig)
- </li><br>
- <li>isbirthday<br>
- 0 / nicht gesetzt - keine Altersberechnung (Standard) <br>
- 1 - aktiviert die Altersberechnung im Modul. Das Alter wird aus der in der Terminbeschreibung (description) angegebenen Jahreszahl (Geburtsjahr) berechnet. (siehe Attribut yobfield)
- </li><br>
- <li>maxreadings<br>
- bestimmt die Anzahl der Termine als Readings
- </li><br>
- <li>modes<br>
- hier können die CALENDAR modi gewählt werden, welche in der View angezeigt werden sollen
- </li><br>
- <li>oldStyledReadings<br>
- 0 die Standarddarstellung für Readings <br>
- 1 aktiviert die Termindarstellung im "alten" Format "2015.06.21-00:00" mit Wert "Start of Summer"
- </li><br>
- <li>sourcecolor <calendername>:<colorcode>[,<calendername>:<colorcode>]<br>
- Hier kann man die Farben für die einzelnen Calendar definieren die dann zb im Tabletui widget genutzt werden kann.
- Die calendar:color Elemente sind durch Komma zu trennen.
- So kann man zb die google-Kalender Farben auch in der TUI für eine gewohnte Anzeige nutzen.
- </li><br>
- <li>timeshort<br>
- 0 Zeit in _timeshort Readings im Format 00:00:00 - 00:00:00 <br>
- 1 Zeit in _timeshort Readings im Format 00:00 - 00:00
- </li><br>
- <li>yobfield<br>
- _description - (der Standard) Geburtsjahr wird aus der Terminbechreibung gelesen <br>
- _location - Geburtsjahr wird aus dem Terminort gelesen <br>
- _summary - Geburtsjahr wird aus dem Termintiele gelesen (verwendet wird die erste folge von 4 Ziffern im String))
- </li><br>
- <li>weekdayformat<br>
- formatiert den Namen im Reading weekdayname <br>
- - de-long - (default) Deutsch, lang zb Dienstag <br>
- - de-short - Deutsch, kurze zb Di <br>
- - en-long - English, lang zb Tuesday <br>
- - en-short - English, kurze zb Tue <br>
- </li><br>
- <p><a name="CM11"></a>
- <h3>CM11</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CM11'>CM11</a><br/>
- </ul>
- <a name="CO20"></a>
- <h3>CO20</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CO20'>CO20</a><br/>
- </ul>
- <a name="CUL"></a>
- <h3>CUL</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL'>EN</a> DE]</div>
- <ul>
- <table>
- <tr><td>
- Der CUL/CUN(O) ist eine Familie von Funkempfängern, die von der Firma
- <a href="http://www.busware.de">Busware</a> verkauft wird.
- Mit der OpenSource Firmware
- <a href="http://culfw.de/culfw.html">culfw</a> können sie verschiedene
- 868 MHz Funkprotokolle empfangen bzw. senden (FS20/FHT/S300/EM/HMS/MAX!).
- Man kann diese Geräte auch zur Reichweitenverlängerung, siehe
- <a href="#CUL_RFR">CUL_RFR</a> einsetzen.
- <br> <br>
- Einige Protokolle (FS20, FHT und KS300) werden von diesem Modul in das FHZ
- Format konvertiert, daher kann dasselbe logische Gerät verwendet werden,
- egal ob das Funktelegramm von einem CUL oder einem FHZ Gerät empfangen
- wird.<br>
- Andere Protokolle (S300/EM) benötigen ihre eigenen Module. S300
- Geräte werden vom Modul CUL_WS verarbeitet, wenn das Signal von einem
- CUL empfangen wurde, ähnliches gilt für EMWZ/EMGZ/EMEM: diese
- werden vom CUL_EM Modul verarbeitet.<br><br>
- Es ist möglich mehr als ein Gerät zu verwenden, um einen besseren
- Empfang zu erhalten, FHEM filtert doppelte Funktelegramme aus.<br><br>
- Bemerkung: Dieses Modul benötigt unter Umständen das
- <code>Device::SerialPort</code> bzw. <code>Win32::SerialPort</code> Modul,
- wenn Sie das Gerät über USB anschließen und das
- Betriebssystem unübliche Parameter für serielle Schnittstellen
- setzt.<br><br>
- </td><td>
- <img src="ccc.jpg"/>
- </td></tr>
- </table>
- <a name="CULdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> CUL <device> <FHTID></code> <br>
- <br>
- Geräte, die an USB angeschlossen sind (CUL/CUN):<br>
- <ul>
- <device> gibt die serielle Schnittstelle an, mit der der CUL
- kommuniziert. Der Name der seriellen Schnittstelle hängt von der
- gewählten Distribution und USB-Treiber ab, unter Linux ist dies das
- Kernel Modul cdc_acm und üblicherweise wird die Schnittstelle
- /dev/ttyACM0 genannt. Wenn die Linux Distribution über kein Kernel
- Modul cdc_acm verfügt, dann kann die Schnittstelle über
- usbserial mit dem folgenden Befehl erzeugt werden:
- <ul><code>
- modprobe usbserial vendor=0x03eb product=0x204b
- </code></ul>
- In diesem Fall ist diese Schnittstelle dann wahrscheinlich
- /dev/ttyUSB0.<br><br>
- Wenn der Name der Schnittstelle ein @ enthält, kann nachfolgend die
- verwendete Baudrate angegeben werden, z.B.: /dev/ttyACM0@38400.<br><br>
- Wenn die Baudrate mit "directio" angegeben wird (z.B.:
- /dev/ttyACM0@directio), wird das Perl Modul
- <code>Device::SerialPort</code> nicht benötigt und FHEM öffnet
- die Schnittstelle mit einfachem Dateizugriff. Dies sollte dann
- funktionieren, wenn das Betriebssystem vernünftige Standardwerte
- für die serielle Schnittstelle verwendet, wie z.B. einige Linux
- Distributionen oder OSX.<br><br>
- </ul>
- Geräte, die mit dem Netzwerk verbunden sind (CUN(O)):<br>
- <ul>
- <device> gibt die Hostadresse:Port des Gerätes an, z.B.
- 192.168.0.244:2323
- </ul>
- <br>
- Wenn das Gerät mit none bezeichnet wird, wird keine Schnittstelle
- geöffnet und man kann ohne angeschlossene Hardware
- experimentieren.<br>
- Die FHTID ist eine 4-stellige hexadezimale Zahl und wird verwendet, wenn
- der CUL FHT Telegramme sendet bzw. Daten anfragt. Diese sollte als 0000
- gewählt werden, wenn man FHT80b Anfragen durch den CUL vermeiden will.
- </ul>
- <br>
- <a name="CULset"></a>
- <b>Set </b>
- <ul>
- <li>reopen<br>
- Öffnet die Verbindung zum Gerät neu und initialisiert es.
- </li><br>
- <li>raw<br>
- Sendet einen CUL Firmware Befehl. Siehe auch
- <a href="http://culfw.de/commandref.html">hier</a> für
- nähere Erläuterungen der CUL Befehle.
- </li><br>
- <li>freq / bWidth / rAmpl / sens<br>
- Nur in der Betriebsart <a href="#rfmode">SlowRF</a>.<br> Bestimmt die
- CUL Frequenz / Bandbreite / Empfänger Amplitude /
- Empfindlichkeit<br>
- Bitte mit Vorsicht verwenden, da es die verwendete Hardware
- zerstören kann bzw. es zu illegalen Funkzuständen kommen
- kann. <br> Bemerkung: Die Parameter für die RFR Übermittlung
- werden hierdurch nicht beeinflußt.<br>
- <ul>
- <li>freq bestimmt sowohl die Empfangs- als auch die Sendefrequenz.<br>
- Bemerkung: Auch wenn der CC1101 zwischen den Frequenzen 315 und 915
- MHz eingestellt werden kann, ist die Antennenanbindung bzw. die
- Antenne des CUL exakt auf eine Frequenz eingestellt. Standard ist
- 868.3 MHz (bzw. 433 MHz).</li>
- <li>bWidth kann zwischen 58 kHz und 812 kHz variiert werden.
- Große Werte sind empfindlicher gegen Interferencen, aber
- machen es möglich, nicht genau kalbrierte Signale zu
- empfangen. Die Einstellung beeinflusst ebenso die Übertragung.
- Standardwert ist 325 kHz.</li>
- <li>rAmpl ist die Verstärkung des Empfängers mit Werten
- zwischen 24 and 42 dB. Größere Werte erlauben den
- Empfang von schwachen Signalen. Standardwert ist 42.</li>
- <li>sens ist die Entscheidungsgrenze zwischen "on" und "off"
- Zuständen und kann 4, 8, 12 oder 16 dB sein. Kleinere Werte
- erlauben den Empfang von undeutlicheren Signalen. Standard ist 4
- dB.</li>
- </ul>
- </li><br>
- <a name="hmPairForSec"></a>
- <li>hmPairForSec<br>
- Nur in der Betriebsart <a href="#rfmode">HomeMatic</a>.<br> Versetzt den
- CUL für die angegebene Zeit in Sekunden in den Anlern-Modus. Jedes
- HM Gerät, das sich im Anlern-Modus befindet, wird an FHEM
- angelernt. </li><br>
- <a name="hmPairSerial"></a>
- <li>hmPairSerial<br>
- Nur in der Betriebsart <a href="#rfmode">HomeMatic</a>.<br>
- Versucht, das angegebene Gerät anzulernen (zu "pairen"). Der
- Parameter ist eine 10-stellige Zeichenfolge, die normalerweise mit
- Buchstaben beginnt und mit Ziffern endet; diese sind auf der
- Rückseite der Geräte aufgedruckt. Wenn das Gerät ein
- Empfänger ist, ist es nicht notwendig, das angegebene Gerät in
- den Anlern-Modus zu versetzen. </li><br>
- <a name="hmPairForSec"></a>
- <li>led<br>
- Schaltet die LED des CUL: aus (00), an (01) oder blinkend (02).
- </li><br>
- <li>ITClock</br>
- Setzt die IT clock fü Intertechno V1 Protokoll. Default 250.
- </li><br>
- </ul>
- <a name="CULget"></a>
- <b>Get</b>
- <ul>
- <li>version<br>
- gibt die Version der CUL Firmware zurück
- </li><br>
- <li>uptime<br>
- gibt die Betriebszeit des CULs zurück (Zeit seit dem letzten Reset
- des CULs) </li><br>
- <li>raw<br>
- Sendet einen CUL Firmware Befehl und wartet auf eine Rückgabe des
- CULs. Siehe auch README der Firmware für nähere
- Erläuterungen zu den CUL Befehlen. </li><br>
- <li>fhtbuf<br>
- Der CUL hat einen Puffer für Nachrichten für FHT. Wenn der
- Puffer voll ist, werden neu empfangene Telegramme ignoriert und eine
- "EOB" Meldung wird in die FHEM Logdatei geschrieben.
- <code>fhtbuf</code> gibt den freien Speicher dieses Puffers (in hex)
- zurück, ein leerer Puffer im CUL V2 hat 74 Byte, im CUL V3/CUN(O)
- hat 200 Byte. Eine Telegramm benötigt 3 + 2x(Anzahl der FHT
- Befehle) Byte, dies ist ein Grund, warum man mehrere FHT Befehle mit
- einem <a href="#set">set</a> senden sollte. Ein weiterer Grund ist,
- dass diese FHT Befehle in einem "Paket" zum FHT Gerät gesendet werden.
- </li> <br>
- <li>ccconf<br>
- Liest einige CUL Register des CC1101 (Sende- und Empfängerchips)
- aus (Frequenz, Bandbreite, etc.) und stellt diese in lesbarer Form dar.
- </li><br>
- <li>cmds<br>
- In abhägigkeit der installierten Firmware hat der CUL/CUN(O)
- unterschiedliche Befehlssätze. Nähere Informationen über
- die Befehle bzw. deren Interpretation siehe README Datei der
- verwendeten CUL Firmware. Siehe auch Anmerkungen beim raw Befehl.
- </li><br>
- <li>credit10ms<br>
- Der Funkraum darf für eine Dauer von credit10ms*10 ms belegt
- werden, bevor die gesetzliche 1% Grenze erreicht ist und eine
- LOVF Meldung ausgegeben wird. </li><br> </ul>
- <a name="CULattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a name="addvaltrigger">addvaltrigger</a><br>
- Generiert Trigger für zusätzliche Werte. Momentan sind dies
- RSSI und RAWMSG für die CUL Familie und RAWMSG für FHZ.
- </li><br>
- <li><a name="connectCommand">connectCommand</a><br>
- culfw Befehl, was nach dem Verbindungsaufbau mit dem USB-Gerät, nach
- Senden der zum Initialisieren der konfigurierten rfmode benötigten
- Befehle gesendet wird.
- </li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#attrdummy">dummy</a></li>
- <li><a name="hmId">hmId</a><br>
- Setzt die HomeMatic ID des Gerätes. Wenn dieses Attribut fehlt,
- wird die ID zu F1<FHTID> gesetzt. Bemerkung 1: Nach dem Setzen
- bzw. Verändern dieses Attributes müssen alle HomeMatic
- Geräte neu angelernt werden. Bemerkung 2: Der Wert <b>muss</b>
- eine 6-stellige Hexadezimalzahl sein, 000000 ist ungültig. FHEM
- überprüft nicht, ob die ID korrekt ist, im Zweifelsfall
- funktioniert die Kommunikation nicht. </li><br>
- <li><a name="hmProtocolEvents">hmProtocolEvents</a><br>
- Generiert Ereignisse für HomeMatic Telegramme. Diese werden
- normalerweise für die Fehlersuche verwendet, z.B. durch Aktivieren
- von <code>inform timer</code> in einer telnet Sitzung bzw. im
- <code>Event Monitor</code> Fenster im FHEMWEB Frontend.<br>
- Beispiel:
- <ul>
- <code>
- 2012-05-17 09:44:22.515 CUL CULHM RCV L:0B N:81 CMD:A258 SRC:......
- DST:...... 0000 (TYPE=88,WAKEMEUP,BIDI,RPTEN)
- </code>
- </ul>
- </li><br>
- <li><a name="longids">longids</a><br>
- Durch Kommata getrennte Liste von Device-Typen für Empfang von
- langen IDs mit den CUL. Diese zusätzliche ID erlaubt es
- Wettersensoren, welche auf dem gleichen Kanal senden zu unterscheiden.
- Hierzu wird eine zufällig generierte ID hinzugefügt. Wenn Sie
- longids verwenden, dann wird in den meisten Fällen nach einem
- Batteriewechsel ein neuer Sensor angelegt.
- Standardmäßig werden keine langen IDs verwendet.<br>
- Folgende Module verwenden diese Funktionalität:
- 14_Hideki, 41_OREGON, 14_CUL_TCM97001, 14_SD_WS07.<br>
- Beispiele:
- <ul><code>
- # Keine langen IDs verwenden (Default Einstellung):<br>
- attr cul longids 0<br>
- # Immer lange IDs verwenden:<br>
- attr cul longids 1<br>
- # Verwende lange IDs für SD_WS07 Devices.<br>
- # Device Namen sehen z.B. so aus: SD_WS07_TH_3 for channel 3.<br>
- attr cul longids SD_WS07
- </code></ul>
- </li><br>
-
- <li><a href="#model">model</a> (CUL,CUN)</li><br>
- <li><a name="rfmode">rfmode</a><br>
- Konfiguriert den RF Transceiver des CULs (CC1101). Verfügbare
- Argumente sind:
- <ul>
- <li>SlowRF<br>
- Für die Kommunikation mit FS20/FHT/HMS/EM1010/S300/Hoermann
- Geräten @1 kHz Datenrate (Standardeinstellung).</li>
- <li>HomeMatic<br>
- Für die Kommunikation mit HomeMatic Geräten @10 kHz
- Datenrate.</li>
- <li>MAX<br>
- Für die Kommunikation mit MAX! Geräten @10 kHz
- Datenrate.</li>
- <li>WMBus_S</li>
- <li>WMBus_T<br>
- Für die Kommunikation mit Wireless M-Bus Geräten wie
- Wasser-, Gas- oder Elektrozählern. Wireless M-Bus verwendet
- zwei unterschiedliche Kommunikationsarten, S-Mode und T-Mode. In
- diesem Modus ist der Empfang von anderen Protokollen wie SlowRF
- oder HomeMatic nicht möglich.</li>
- </ul>
- </li><br>
- <li><a name="sendpool">sendpool</a><br>
- Wenn mehr als ein CUL verwendet wird, um einen größeren
- Bereich abzudecken, können diese sich gegenseitig
- beeinflussen. Dieses Phänomen wird auch Palm-Beach-Resort Effekt
- genannt. Wenn man diese zu einen gemeinsamen Sende"pool"
- zusammenschließt, wird das Senden der einzelnen Telegramme
- seriell (d.h. hintereinander) durchgeführt.
- Wenn z.B. drei CUN's zur
- Verfügung stehen, werden folgende Attribute gesetzt:<br>
- <code>attr CUN1 sendpool CUN1,CUN2,CUN3<br>
- attr CUN2 sendpool CUN1,CUN2,CUN3<br>
- attr CUN3 sendpool CUN1,CUN2,CUN3</code><br>
- </li><br>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="CUL_EM"></a>
- <h3>CUL_EM</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_EM'>EN</a> DE]</div>
- <ul>
- Das Modul CUL_EM wertet von einem CUL empfange Botschaften des Typs EM aus,
- dies sind aktuell Botschaften von EMEM, EMWZ bzw. EMGZ Geräten.
- <br><br>
- <a name="CUL_EMdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> CUL_EM <code> [corr1 corr2
- CostPerUnit BasicFeePerMonth]</code> <br>
- <br>
- <code> ist der Code, der am EM Gerät eingestellt wird.
- Gütige Werte sind 1 bis 12. 1-4 gilt für EMWZ, 5-8 für EMEM
- und 9-12 für EMGZ Geräte.<br><br>
- <b>corr1</b> ist der Kalibrierfaktor für den Momentanverbrauch,
- <b>corr2</b> für den Gesamtverbrauch.
- <ul>
- <li>für EMWZ Geräte wird die Umdrehungsgeschwindigkeit (U/kW)
- des verwendeten Stromzählers (z.B. 150) für corr1 und 12 mal
- diesen Wert für corr2 verwendet</li>
- <li>für EMEM devices ist corr1 mit 0.01 und corr2 mit 0.001
- anzugeben</li>
- </ul>
- <br>
- <b>CostPerUnit</b> und <b>BasicFeePerMonth</b> werden dazu verwendet, die
- tägliche bzw. monatliche Kosten zu berechnen. Die Kosten werden in der
- Logdatei einmal täglich (ohne Fixkosten) bzw. monatlich (mit Fixkosten)
- generiert und angezeigt.
- Die Definition sollte in etwa so aussehen:
- <ul><code>
- define emwz 1 75 900 0.15 12.50<br>
- </code></ul>
- und in der Logdatei sollten diese Zeilen erscheinen:
- <ul><code>
- CUM_DAY: 6.849 CUM: 60123.4 COST: 1.02<br>
- CUM_MONTH: 212.319 CUM: 60123.4 COST: 44.34<br>
- </code></ul>
- Tipp: Das EMWZ Gerät kann so konfiguriert werden, dass es in der CUM
- Spalte des STATE Wertes den aktuellen Wert des Stromzählers anzeigt.
- Hierfür muss der aktuell am Stromzähler abgelesene Wert mit corr1
- (U/kW) multipliziert werden und der CUM Rohwert aus der aktuellen fhem
- Messung ('reading') davon abgezogen werden. Dann muss dieser Wert als
- Basiswert des EMWZ Gerätes (im Beispiel emwz) gesetzt werden.<br>
- </ul>
- <br>
- <a name="CUL_EMset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="CUL_EMget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="CUL_EMattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#ignore">ignore</a></li><br>
- <li><a href="#do_not_notify">do_not_notify</a></li><br>
- <li><a href="#showtime">showtime</a></li><br>
- <li><a href="#model">model</a> (EMEM,EMWZ,EMGZ)</li><br>
- <li><a href="#IODev">IODev</a></li><br>
- <li><a href="#eventMap">eventMap</a></li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="maxPeak">maxPeak</a> <number><br>
- Gibt den maximal möglichen Spitzenwert für das EM-Meter an
- ("TOP:"-Wert in Logdatei). Spitzenwerte größer als dieser
- Wert gelten als EM-Lesefehler und werden ignoriert.
- Wenn es z.B. nicht möglich ist mehr zu 40kW Leistung
- zu beziehen setzt man maxPeak auf 40 um das Auslesen des
- Stromzählers robuster zu machen.
- </li><br>
- <li><a name="CounterOffset">CounterOffset</a><br>
- Gibt den Unterschied zwischen dem tatsächlichen Zählerstand und
- dem vom EMGZ gemeldeten Wert an.<br>
- CounterOffset = tatsächlicher Zählerstand - Reading "total"<br>
- Beispiel:
- <ul>
- <code>attr Gaszaehler CounterOffset 15427.434</code><br>
- </ul>
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="CUL_FHTTK"></a>
- <h3>CUL_FHTTK</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_FHTTK'>EN</a> DE]</div>
- <ul>
- Dieses Modul hantiert die empfangen Daten von FHT80 TF "Fenster-Tür-Kontakt" Sensoren, welche
- normalerweise nur mit den <a href="#FHT">FHT80B</a> Geräten kommunizieren. Mit diesen Modul können
- FHT80 TFs in eingeschränkter Weise ähnlich wie HMS TFK Sensoren benutzt werden (weitere
- Informationen sind unter <a href="http://fhz4linux.info/tiki-index.php?page=FHT+protocol">Wiki</a> zu lesen).
- Der name des FHEM Moduls wurde so gewählt, weil a) nur der CUL die Daten empfangen kann und b) "TF" normalerweise
- Temperatur- und Feuchtigkeitssensoren suggeriert. (Keine Ahnung, warum ELV diesen Sensor nicht TFK genannt hat,
- wie die Sensoren von FS20 und HMS).
- <br><br>
- <a href="#CUL">CUL</a> device muss vorhr definiert sein.
- <br><br>
- Mit dem letzten Build auf <a href="http://sourceforge.net/p/culfw/code/HEAD/tree/trunk/culfw/Devices/">SVN</a>
- oder mit der nächsten offiziellen Version 1.62 oder höher, ist es möglich, FHT80 TF Daten zu senden.
- Möglich mit einem CUL oder ähnlichen Geräten. So können bis zu vier Fenstersensoren mit einem Gerät
- simuliert werden (siehe <a href="http://www.fhemwiki.de/wiki/CUL_FHTTK">FHEM Wiki</a>). Es muss lediglich das Attribut model mit dem
- Wert "dummy" hinzugefügt oder geändert werden. Wichtig: Der Devicecode sollte nicht der FHTID entsprechen.<br><br>
- <a name="CUL_FHTTKdefine"></a>
- <b>D</b>
- <ul>
- <code>define <name> CUL_FHTTK <devicecode></code>
- <br><br>
- <code><devicecode></code> Ist eine sechstellige Hexadezimalzahl, welche zum Zeitpunkt der Produktion
- des FHT80 TF gegeben wurde. Somit ist diese auch nicht mehr änderbar und bleibt auch nach einem Batteriewechsel
- erhalten.<br>
- Examples:
- <ul>
- <code>define TK_TEST CUL_FHTTK 965AB0</code>
- </ul>
- </ul>
- <br>
- <a name="CUL_FHTTKset"></a>
- <b>Set</b>
- <ul> Nur vorhanden, wenn das Attribut model mit dummy definiert wurde.<br><br>
- <code>set <name> <value></code>
- <br><br>
- wobei <code>value</code> folgendes sein kann:<br>
- <ul><code>
- Pair # startet das Anlernen an das FHT80B (FHT80B muss sich im Sync mode befinden) - danach wird der state auf "Closed" gesetzt<br>
- Closed # setzt den Fensterstatus zu Closed<br>
- Open # setzt den Fensterstatus zu Open<br>
- ReSync # neu synchronisieren des virtuellen Sensor mit dem FHT80b Module. Damit wird ein virtueller Batteriewechsel symuliert und der angelernte
- Sensor wieder aufsynchronisiert. (aktuell nur mit Prototyp CUL FW verfügbar Forum 55774)<br>
- </code></ul>
- </ul>
- <br>
- <b>Get</b>
- <ul> N/A </ul>
- <br>
- <a name="CUL_FHTTKattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li><br>
- <li><a href="#verbose">verbose</a></li><br>
- <li><a href="#model">model</a><br>Mögliche Werte sind: FHT80TF, FHT80TF-2, dummy (zum simulieren eines Fensterkontaktes)</li><br>
- <li><a href="#showtime">showtime</a></li><br>
- <li><a href="#IODev">IODev</a></li><br>
- <li><a href="#ignore">ignore</a></li><br>
- <li><a href="#eventMap">eventMap</a></li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p> <a name="CUL_HM"></a><h3>CUL_HM</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_HM'>EN</a> DE]</div>
- <ul>
- Unterstützung für eQ-3 HomeMatic Geräte via <a href="#CUL">CUL</a> oder <a href="#HMLAN">HMLAN</a>.<br>
- <br>
- <a name="CUL_HMdefine"></a><b>Define</b>
- <ul>
- <code><B>define <name> CUL_HM <6-digit-hex-code|8-digit-hex-code></B></code>
-
- <br><br>
- Eine korrekte Gerätedefinition ist der Schlüssel zur einfachen Handhabung der HM-Umgebung.
- <br>
-
- Hintergrund zur Definition:<br>
- HM-Geräte haben eine 3 Byte (6 stelliger HEX-Wert) lange HMid - diese ist Grundlage
- der Adressierung. Jedes Gerät besteht aus einem oder mehreren Kanälen. Die HMid für einen
- Kanal ist die HMid des Gerätes plus die Kanalnummer (1 Byte, 2 Stellen) in
- hexadezimaler Notation.
- Kanäle sollten für alle mehrkanaligen Geräte definiert werden. Einträge für Kanäle
- können nicht angelegt werden wenn das zugehörige Gerät nicht existiert.<br> Hinweis: FHEM
- belegt das Gerät automatisch mit Kanal 1 falls dieser nicht explizit angegeben wird. Daher
- ist bei einkanaligen Geräten keine Definition nötig.<br>
-
- Hinweis: Wird ein Gerät gelöscht werden auch die zugehörigen Kanäle entfernt. <br> Beispiel einer
- vollständigen Definition eines Gerätes mit 2 Kanälen:<br>
- <ul><code>
- define livingRoomSwitch CUL_HM 123456<br>
- define LivingroomMainLight CUL_HM 12345601<br>
- define LivingroomBackLight CUL_HM 12345602<br><br>
- </code></ul>
-
- livingRoomSwitch bezeichnet das zur Kommunikation verwendete Gerät. Dieses wird
- vor den Kanälen definiert um entsprechende Verweise einstellen zu können. <br>
- LivingroomMainLight hat Kanal 01 und behandelt den Lichtstatus, Kanal-Peers
- sowie zugehörige Kanalregister. Falls nicht definiert wird Kanal 01 durch die Geräteinstanz
- abgedeckt.<br> LivingRoomBackLight ist der zweite "Kanal", Kanal 02. Seine
- Definition ist verpflichtend um die Funktion ausführen zu können.<br><br>
-
- Sonderfall Sender: HM behandelt jeden Knopf einer Fernbedienung, Drucktaster und
- ähnliches als Kanal . Es ist möglich (nicht notwendig) einen Kanal pro Knopf zu
- definieren. Wenn alle Kanäle definiert sind ist der Zugriff auf Pairing-Informationen
- sowie auf Kanalregister möglich. Weiterhin werden Verknüpfungen durch Namen besser
- lesbar.<br><br>
-
- define kann auch durch das <a href="#autocreate">autocreate</a>
- Modul aufgerufen werden, zusammen mit dem notwendigen subType Attribut.
- Normalerweise erstellt man <a href="#CULset">hmPairForSec</a> und drückt dann den
- zugehörigen Knopf am Gerät um die Verknüpfung herzustellen oder man verwendet <a
- href="#CULset">hmPairSerial</a> falls das Gerät ein Empfänger und die Seriennummer
- bekannt ist. Autocreate wird dann ein FHEM-Gerät mit allen notwendigen Attributen anlegen.
- Ohne Pairing wird das Gerät keine Befehle von FHEM akzeptieren. Selbst wenn das Pairing
- scheitert legt FHEM möglicherweise das Gerät an. Erfolgreiches Pairen wird
- durch den Eintrag CommandAccepted in den Details zum CUL_HM Gerät angezeigt.<br><br>
-
- Falls autocreate nicht verwendet werden kann muss folgendes spezifiziert werden:<br>
- <ul>
- <li>Der <6-stellige-Hex-Code>oder HMid+ch <8-stelliger-Hex-Code><br>
- Das ist eine einzigartige, festgelegte Geräteadresse die nicht geändert werden kann (nein,
- man kann sie nicht willkürlich auswählen wie z.B. bei FS20 Geräten). Man kann sie feststellen
- indem man das FHEM-Log durchsucht.</li>
- <li>Das subType Attribut<br>
- Dieses lautet: switch dimmer blindActuator remote sensor swi
- pushButton threeStateSensor motionDetector keyMatic winMatic
- smokeDetector</li>
- <li>Das model Attribut<br>
- ist entsprechend der HM Nomenklatur zu vergeben</li>
- </ul>
- Ohne diese Angaben kann FHEM nicht korrekt mit dem Gerät arbeiten.<br><br>
-
- <b>Hinweise</b>
- <ul>
- <li>Falls das Interface ein Gerät vom Typ CUL ist muss <a href="#rfmode">rfmode </a>
- des zugehörigen CUL/CUN Gerätes auf HomeMatic gesetzt werden.
- Achtung: Dieser Modus ist nur für BidCos/Homematic. Nachrichten von FS20/HMS/EM/S300
- werden durch diese Gerät <b>nicht</b> empfangen. Bereits definierte FS20/HMS
- Geräte müssen anderen Eingängen zugeordnet werden (CUL/FHZ/etc).
- </li>
- <li>Nachrichten eines Geräts werden nur richtig interpretiert wenn der Gerätetyp
- bekannt ist. FHEM erhält den Gerätetyp aus einer"pairing request"
- Nachricht, selbst wenn es darauf keine Antwort erhält (siehe <a
- href="#hmPairSerial">hmPairSerial</a> und <a
- href="#hmPairForSec">hmPairForSec</a> um Parinig zu ermöglichen).
- Alternativ, setzen des richtigen subType sowie Modelattributes, für eine Liste der
- möglichen subType-Werte siehe "attr hmdevice ?".</li>
- <a name="HMAES"></a>
- <li>Die sogenannte "AES-Verschlüsselung" ist eigentlich eine Signaturanforderung: Ist sie
- aktiviert wird ein Aktor den erhaltenen Befehl nur ausführen falls er die korrekte
- Antwort auf eine zuvor durch den Aktor gestellte Anfrage erhält. Das bedeutet:
- <ul>
- <li>Die Reaktion auf Befehle ist merklich langsamer, da 3 Nachrichten anstatt einer übertragen
- werden bevor der Befehl vom Aktor ausgeführt wird.</li>
- <li>Jeder Befehl sowie seine Bestätigung durch das Gerät wird in Klartext übertragen, ein externer
- Beobachter kennt somit den Status jedes Geräts.</li>
- <li>Die eingebaute Firmware ist fehlerhaft: Ein "toggle" Befehl wir ausgeführt <b>bevor</b> die
- entsprechende Antwort auf die Signaturanforderung empfangen wurde, zumindest bei einigen Schaltern
- (HM-LC-Sw1-Pl und HM-LC-SW2-PB-FM).</li>
- <li>Der <a href="#HMLAN">HMLAN</a> Konfigurator beantwortet Signaturanforderungen selbstständig,
- ist dabei die 3-Byte-Adresse einer anderen CCU eingestellt welche noch immer das Standardpasswort hat,
- kann dieser Signaturanfragen korrekt beantworten.</li>
- <li>AES-Verschlüsselung wird durch HMLAN und CUL unterstützt. Bei Einsatz eines CUL
- ist das Perl-Modul Crypt::Rijndael notwendig. Aufgrund dieser Einschränkungen ist der
- Einsatz der Homematic-Verschlüsselung nicht zu empfehlen!</li>
- </ul>
- </li>
- </ul>
- </ul><br>
- <a name="CUL_HMset"></a><b>Set</b>
- <ul>
- Hinweis: Geräte die normalerweise nur senden (Fernbedienung/Sensor/etc.) müssen in den
- Pairing/Lern-Modus gebracht werden um die folgenden Befehle zu empfangen.
- <br>
- <br>
-
- Allgemeine Befehle (verfügbar für die meisten HM-Geräte):
- <ul>
- <li><B>clear <[rssi|readings|register|msgEvents|attack|all]></B><a name="CUL_HMclear"></a><br>
- Eine Reihe von Variablen kann entfernt werden.<br>
- <ul>
- readings: Alle Messwerte werden gelöscht, neue Werte werden normal hinzugefügt. Kann benutzt werden um alte Daten zu entfernen<br>
- register: Alle in FHEM aufgezeichneten Registerwerte werden entfernt. Dies hat KEINEN Einfluss auf Werte im Gerät.<br>
- msgEvents: Alle Anchrichtenzähler werden gelöscht. Ebenso wird der Befehlsspeicher zurückgesetzt. <br>
- rssi: gesammelte RSSI-Werte werden gelöscht.<br>
- attack: Einträge bezüglich einer Attack werden gelöscht.<br>
- all: alles oben genannte.<br>
- </ul>
- </li>
- <li><B>getConfig</B><a name="CUL_HMgetConfig"></a><br>
- Liest die Hauptkonfiguration eines HM_Gerätes aus. Angewendet auf einen Kanal
- erhält man Pairing-Information, List0, List1 und List3 des ersten internen Peers.
- Außerdem erhält man die Liste der Peers für den gegebenen Kanal. Wenn auf ein Gerät
- angewendet so bekommt man mit diesem Befehl die vorherigen Informationen für alle
- zugeordneten Kanäle. Ausgeschlossen davon sind Konfigurationen zusätzlicher Peers.
- <br> Der Befehl ist eine Abkürzung für eine Reihe anderer Befehle.
- </li>
- <li><B>getRegRaw [List0|List1|List2|List3|List4|List5|List6]<peerChannel> </B><a name="CUL_HMgetRegRaw"></a><br>
- Auslesen der Rohdaten des Registersatzes. Eine Beschreibung der Register sprengt
- den Rahmen dieses Dokuments.<br>
-
- Die Register sind in sog. Listen strukturiert welche einen Satz Register enthalten.<br>
-
- List0: Geräteeinstellungen z.B: Einstellungen für CUL-Pairing Temperaturlimit eines Dimmers.<br>
-
- List1: Kanaleinstellungen z.B. benötigte Zeit um Rollo hoch und runter zu fahren.<br>
-
- List3: "link" Einstellungen - d.h. Einstellungen für Peer-Kanal. Das ist eine große Datenmenge!
- Steuert Aktionen bei Empfang eines Triggers vom Peer.<br>
-
- List4: Einstellungen für den Kanal (Taster) einer Fernbedienung.<br><br>
-
- <PeerChannel> verknüpfte HMid+ch, z.B. 4 byte (8 stellige) Zahl wie
- '12345601'. Ist verpflichtend für List3 und List4 und kann ausgelassen werden
- für List0 und 1. <br>
-
- 'all' kann verwendet werden um Daten von jedem mit einem Kanal verknüpften Link zu bekommen. <br>
-
- 'selfxx' wird verwendet um interne Kanäle zu adressieren (verbunden mit den eingebauten Schaltern
- falls vorhanden). xx ist die Kanalnummer in dezimaler Notation.<br>
-
- Hinweis 1: Ausführung ist abhängig vom Entity. Wenn List1 für ein Gerät statt einem Kanal
- abgefragt wird gibt der Befehl List1 für alle zugehörigen Kanäle aus.
- List3 mit 'peerChannel = all' gibt alle Verbindungen für alle Kanäle eines Gerätes zurück.<br>
-
- Hinweis 2: für 'Sender' siehe auch <a href="#CUL_HMremote">remote</a> <br>
-
- Hinweis 3: Das Abrufen von Informationen kann dauern - besonders für Geräte
- mit vielen Kanälen und Verknüpfungen. Es kann nötig sein das Webinterface manuell neu zu laden
- um die Ergebnisse angezeigt zu bekommen.<br>
-
- Hinweis 4: Direkte Schalter eines HM-Geräts sind standardmäßig ausgeblendet.
- Dennoch sind sie genauso als Verknüpfungen implemetiert. Um Zugriff auf 'internal links'
- zu bekommen ist es notwendig folgendes zu erstellen:<br>
- 'set <name> <a href="#CUL_HMregSet">regSet</a> intKeyVisib visib'<br>
- oder<br>
- 'set <name> <a href="#CUL_HMregBulk">regBulk</a> RegL_0. 2:81'<br>
- Zurücksetzen lässt es sich indem '81' mit '01' ersetzt wird.<br> example:<br>
-
- <ul><code>
- set mydimmer getRegRaw List1<br>
- set mydimmer getRegRaw List3 all <br>
- </code></ul>
- </li>
- <li><B>getSerial</B><a name="CUL_HMgetSerial"></a><br>
- Auslesen der Seriennummer eines geräts und speichern in Attribut serialNr.
- </li>
- <li><B>inhibit [on|off]</B><br>
- Blockieren/Zulassen aller Kanaländerungen eines Aktors, d.h. Zustand des Aktors ist
- eingefroren bis 'inhibit' wieder deaktiviert wird. 'Inhibit' kann für jeden Aktorkanal
- ausgeführt werden aber natürlich nicht für Sensoren - würde auch keinen Sinn machen.<br>
- Damit ist es praktischerweise möglich Nachrichten ebenso wie verknüpfte Kanalaktionen
- temporär zu unterdrücken ohne sie löschen zu müssen. <br>
- Beispiele:
- <ul><code>
- # Ausführung blockieren<br>
- set keymatic inhibit on <br><br>
- </ul></code>
- </li>
-
- <li><B>pair</B><a name="CUL_HMpair"></a><br>
- Verbinden eines Geräts bekannter Seriennummer (z.b. nach einem Reset)
- mit einer FHEM-Zentrale. Diese Zentrale wird normalerweise durch CUL/CUNO,
- HMLAN,... hergestellt.
- Wenn verbunden melden Geräte ihren Status and FHEM.
- Wenn nicht verbunden wird das Gerät auf bestimmte Anfragen nicht reagieren
- und auch bestimmte Statusinformationen nicht melden. Pairing geschieht auf
- Geräteebene. Kanäle können nicht unabhängig von einem Gerät mit der Zentrale
- verbunden werden.
- Siehe auch <a href="#CUL_HMgetpair">getPair</a> und
- <a href="#CUL_HMunpair">unpair</a>.<br>
- Nicht das Verbinden (mit einer Zentrale) mit verknüpfen (Kanal zu Kanal) oder
- <a href="#CUL_HMpeerChan">peerChan</a> verwechseln.<br>
- </li>
- <li><B>peerBulk</B> <peerch1,peerch2,...> [set|unset]<a name="CUL_HMpeerBulk"></a><br>
- peerBulk fügt Peer-Kanäle zu einem Kanal hinzu. Alle Peers einer Liste werden
- dabei hinzugefügt.<br>
- Peering setzt die Einstellungen einer Verknüpfung auf Standardwerte. Da Peers nicht in Gruppen
- hinzugefügt werden werden sie durch HM standardmäßig als'single' für dieses Gerät
- angelegt. <br>
- Eine ausgeklügeltere Funktion wird gegeben durch
- <a href="#CUL_HMpeerChan">peerChan</a>.<br>
- peerBulk löscht keine vorhandenen Peers sondern bearbeitet nur die Peerliste.
- Andere bereits angelegt Peers werden nicht verändert.<br>
- peerBulk kann verwendet werden um Peers zu löschen indem die <B>unset</B> Option
- mit Standardeinstellungen aufgerufen wird.<br>
-
- Verwendungszweck dieses Befehls ist hauptsächlich das Wiederherstellen
- von Daten eines Geräts.
- Empfehlenswert ist das anschließende Wiederherstellen der Registereinstellung
- mit <a href="#CUL_HMregBulk">regBulk</a>. <br>
- Beispiel:<br>
- <ul><code>
- set myChannel peerBulk 12345601,<br>
- set myChannel peerBulk self01,self02,FB_Btn_04,FB_Btn_03,<br>
- set myChannel peerBulk 12345601 unset # entferne Peer 123456 Kanal 01<br>
- </code></ul>
- </li>
- <li><B>regBulk <reg List>:<peer> <addr1:data1> <addr2:data2>...</B><a name="CUL_HMregBulk"></a><br>
- Dieser Befehl ersetzt das bisherige regRaw. Er erlaubt Register mit Rohdaten zu
- beschreiben. Hauptzweck ist das komplette Wiederherstellen eines zuvor gesicherten
- Registers. <br>
- Werte können mit <a href="#CUL_HMgetConfig">getConfig</a> ausgelesen werden. Die
- zurückgegebenen Werte können direkt für diesen Befehl verwendet werden.<br>
- <reg List> bezeichnet die Liste in die geschrieben werden soll. Mögliches Format
- '00', 'RegL_00', '01'...<br>
- <peer> ist eine optionale Angabe falls die Liste ein Peer benötigt.
- Der Peer kann als Kanalname oder als 4-Byte (8 chars) HM-Kanal ID angegeben
- werden.<br>
- <addr1:data1> ist die Liste der Register im Hex-Format.<br>
- Beispiel:<br>
- <ul><code>
- set myChannel regBulk RegL_00. 02:01 0A:17 0B:43 0C:BF 15:FF 00:00<br>
- RegL_03.FB_Btn_07
- 01:00 02:00 03:00 04:32 05:64 06:00 07:FF 08:00 09:FF 0A:01 0B:44 0C:54 0D:93 0E:00 0F:00 11:C8 12:00 13:00 14:00 15:00 16:00 17:00 18:00 19:00 1A:00 1B:00 1C:00 1D:FF 1E:93 1F:00 81:00 82:00 83:00 84:32 85:64 86:00 87:FF 88:00 89:FF 8A:21 8B:44 8C:54 8D:93 8E:00 8F:00 91:C8 92:00 93:00 94:00 95:00 96:00 97:00 98:00 99:00 9A:00 9B:00 9C:00 9D:05 9E:93 9F:00 00:00<br>
- set myblind regBulk 01 0B:10<br>
- set myblind regBulk 01 0C:00<br>
- </code></ul>
- myblind setzt die maximale Zeit für das Hochfahren der Rollos auf 25,6 Sekunden
- </li>
- <li><B>regSet [prep|exec] <regName> <value> <peerChannel></B><a name="CUL_HMregSet"></a><br>
- Für einige Hauptregister gibt es eine lesbarere Version die Registernamen <regName>
- und Wandlung der Werte enthält. Nur ein Teil der Register wird davon unterstützt.<br>
- Der optionale Parameter [prep|exec] erlaubt das Packen von Nachrichten und verbessert damit
- deutlich die Datenübertragung.
- Benutzung durch senden der Befehle mit Parameter "prep". Daten werden dann für das Senden gesammelt.
- Der letzte Befehl muss den Parameter "exec" habe um die Information zu übertragen.<br>
- <value> enthält die Daten in menschenlesbarer Form die in das Register geschrieben werden.<br>
- <peerChannel> wird benötigt falls das Register 'peerChan' basiert definiert wird.
- Kann ansonsten auf '0' gesetzt werden. Siehe <a
- href="#CUL_HMgetRegRaw">getRegRaw</a> für komplette Definition.<br>
- Unterstützte Register eines Geräts können wie folgt bestimmt werden:<br>
- <ul><code>set regSet ? 0 0</code></ul>
- Eine verkürzte Beschreibung der Register wird zurückgegeben mit:<br>
- <ul><code>set regSet <regname> ? 0</code></ul>
- </li>
- <li><B>reset</B><a name="CUL_HMreset"></a><br>
- Rücksetzen des Geräts auf Werkseinstellungen. Muss danach erneut verbunden werden um es
- mit FHEM zu nutzen.
- </li>
- <li><B>sign [on|off]</B><a name="CUL_HMsign"></a><br>
- Ein- oder ausschalten der Signierung (auch "AES-Verschlüsselung" genannt, siehe <a
- href="#HMAES">note</a>). Achtung: Wird das Gerät über einen CUL eingebunden, ist schalten (oder
- deaktivieren der Signierung) nur möglich, wenn das Perl-Modul Crypt::Rijndael installiert ist.
- </li>
- <li><B>statusRequest</B><a name="CUL_HMstatusRequest"></a><br>
- Aktualisieren des Gerätestatus. Für mehrkanalige Geräte sollte dies kanalbasiert
- erfolgen.
- </li>
- <li><B>unpair</B><a name="CUL_HMunpair"></a><br>
- Aufheben des "Pairings", z.B. um das verbinden mit einem anderen Master zu ermöglichen.
- Siehe <a href="#CUL_HMpair">pair</a> für eine Beschreibung.</li>
- <li><B>virtual <Anzahl an Knöpfen></B><a name="CUL_HMvirtual"></a><br>
- Konfiguriert eine vorhandene Schaltung als virtuelle Fernbedienung. Die Anzahl der anlegbaren
- Knöpfe ist 1 - 255. Wird der Befehl für die selbe Instanz erneut aufgerufen werden Knöpfe
- hinzugefügt. <br>
- Beispiel für die Anwendung:
- <ul><code>
- define vRemote CUL_HM 100000 # die gewählte HMid darf nicht in Benutzung sein<br>
- set vRemote virtual 20 # definiere eine Fernbedienung mit 20 Knöpfen<br>
- set vRemote_Btn4 peerChan 0 <actorchannel> # verknüpft Knopf 4 und 5 mit dem gewählten Kanal<br>
- set vRemote_Btn4 press<br>
- set vRemote_Btn5 press long<br>
- </code></ul>
- siehe auch <a href="#CUL_HMpress">press</a>
- </li>
- <li><B>deviceRename <newName></B><a name="CUL_HMdeviceRename"></a><br>
- benennt das Device und alle seine Kanäle um.
- </li>
- <li><B>fwUpdate [onlyEnterBootLoader] <filename> [<waitTime>]</B><br>
- update Fw des Device. Der User muss das passende FW file bereitstellen.
- waitTime ist optional. Es ist die Wartezeit, um das Device manuell in den FW-update-mode
- zu versetzen.<br>
- "onlyEnterBootLoader" schickt das Device in den Booloader so dass es vom eq3 Firmware Update
- Tool geflashed werden kann. Hauptsächlich für Unterputz-Aktoren in Verbindung mit
- FHEM Installationen die ausschliesslich HM-LANs nutzen interessant.
- </li>
- </ul>
- <br>
- <B>subType abhängige Befehle:</B>
- <ul>
- <br>
- <li>switch
- <ul>
- <li><B>on</B> <a name="CUL_HMon"> </a> - setzt Wert auf 100%</li>
- <li><B>off</B><a name="CUL_HMoff"></a> - setzt Wert auf 0%</li>
- <li><B>on-for-timer <sec></B><a name="CUL_HMonForTimer"></a> -
- Schaltet das Gerät für die gewählte Zeit in Sekunden [0-85825945] an.<br> Hinweis:
- off-for-timer wie bei FS20 wird nicht unterstützt. Kann aber über Kanalregister
- programmiert werden.</li>
- <li><B>on-till <time></B><a name="CUL_HMonTill"></a> - einschalten bis zum angegebenen Zeitpunkt.<br>
- <ul><code>set <name> on-till 20:32:10<br></code></ul>
- Das momentane Maximum für eine Endzeit liegt bei 24 Stunden.<br>
- </li>
- <li><B>pressL <peer> [<repCount>] [<repDelay>] </B><a name="CUL_HMpressL"></a><br>
- simuliert einen Tastendruck eines lokalen oder anderen peers.<br>
- <B><peer></B> peer auf den der Tastendruck bezogen wird. <br>
- <B><repCount></B> automatische Wiederholungen des long press. <br>
- <B><repDelay></B> timer zwischen den Wiederholungen. <br>
- <B>Beispiel:</B>
- <code>
- set actor pressL FB_Btn01 # trigger long peer FB button 01<br>
- set actor pressL FB_chn-8 # trigger long peer FB button 08<br>
- set actor pressL self01 # trigger short des internen peers 01<br>
- set actor pressL fhem02 # trigger short des FHEM channel 2<br>
- </code>
- </li>
- <li><B>pressS <peer></B><a name="CUL_HMpressS"></a><br>
- simuliert einen kurzen Tastendruck entsprechend peerL
- </li>
- <li><B>eventL <peer> <condition> [<repCount>] [<repDelay>] </B><a name="CUL_HMeventL"></a><br>
- simuliert einen Event mit zusätzlichem Wert.<br>
- <B><peer></B> peer auf den der Tastendruck bezogen wird.<br>
- <B><codition></B>wert des Events, 0..255 <br>
- <B>Beispiel:</B>
- <code>
- set actor eventL md 30 # trigger vom Bewegungsmelder mit Wert 30<br>
- </code>
- </li>
- <li><B>eventS <peer> <condition> </B><a name="CUL_HMeventS"></a><br>
- simuliert einen kurzen Event eines Peers des actors. Typisch senden Sensoren nur short Events.
- </li>
- <br>
- </ul>
- </li>
- <li>dimmer, blindActuator<br>
- Dimmer können virtuelle Kanäle unterstützen. Diese werden automatisch angelegt falls vorhanden.
- Normalerweise gibt es 2 virtuelle Kanäle zusätzlich zum primären Kanal. Virtuelle Dimmerkanäle sind
- standardmäßig deaktiviert, können aber parallel zum ersten Kanal benutzt werden um das Licht zu steuern. <br>
- Die virtuellen Kanäle haben Standardnamen SW<channel>_V<nr> z.B. Dimmer_SW1_V1 and Dimmer_SW1_V2.<br>
- Virtuelle Dimmerkanäle unterscheiden sich komplett von virtuellen Knöpfen und Aktoren in FHEM, sind aber
- Teil des HM-Geräts. Dokumentation und Möglichkeiten würde hier aber zu weit führen.<br>
- <ul>
- <li><B>0 - 100 [on-time] [ramp-time]</B><br>
- Setzt den Aktor auf den gegeben Wert (In Prozent)
- mit einer Auflösung von 0.5.<br>
- Bei Dimmern ist optional die Angabe von "on-time" und "ramp-time" möglich, beide in Sekunden mit 0.1s Abstufung.<br>
- "On-time" verhält sich analog dem "on-for-timer".<br>
- "Ramp-time" beträgt standardmäßig 2.5s, 0 bedeutet umgehend.<br>
- </li>
- <li><B><a href="#CUL_HMon">on</a></B></li>
- <li><B><a href="#CUL_HMoff">off</a></B></li>
- <li><B><a href="#CUL_HMpress">press <[short|long]><[on|off]></a></B></li>
- <li><B><a href="#CUL_HMtoggle">toggle</a></B></li>
- <li><B>toggleDir</B><a name="CUL_HMtoggleDir"></a> - toggelt die fahrtrichtung des Rollo-Aktors.
- Es wird umgeschaltet zwischen auf/stop/ab/stop</li>
- <li><B><a href="#CUL_HMonForTimer">on-for-timer <sec></a></B> - Nur Dimmer! <br></li>
- <li><B><a href="#CUL_HMonTill">on-till <time></a></B> - Nur Dimmer! <br></li>
- <li><B>stop</B> - Stopt Bewegung (Rollo) oder Dimmerrampe</li>
- <li><B>old</B> - schaltet auf den vorigen Wert zurück. Nur dimmer. </li>
- <li><B>pct <level> [<ontime>] [<ramptime>]</B> - setzt Aktor auf gewünschten <B>absolut Wert</B>.<br>
- Optional können für Dimmer "ontime" und "ramptime" angegeben werden.<br>
- "Ontime" kann dabei in Sekunden angegeben werden. Kann auch als Endzeit angegeben werden im Format hh:mm:ss
- </li>
- <li><B>up [changeValue] [<ontime>] [<ramptime>]</B> Einen Schritt hochdimmen.</li>
- <li><B>down [changeValue] [<ontime>] [<ramptime>]</B> Einen Schritt runterdimmen.<br>
- "changeValue" ist optional und gibt den zu ändernden Wert in Prozent an. Mögliche Abstufung dabei ist 0.5%, Standard ist 10%. <br>
- "ontime" ist optional und gibt an wielange der Wert gehalten werden soll. '0' bedeutet endlos und ist Standard.<br>
- "ramptime" ist optional und definiert die Zeit bis eine änderung den neuen Wert erreicht. Hat nur für Dimmer Bedeutung.
- <br></li>
- </ul>
- <br>
- </li>
- <li>remotes, pushButton<a name="CUL_HMremote"></a><br>
- Diese Geräteart reagiert nicht auf Anfragen, außer sie befinden sich im Lernmodus. FHEM reagiert darauf
- indem alle Anfragen gesammelt werden bis der Lernmodus detektiert wird. Manuelles Eingreifen durch
- den Benutzer ist dazu nötig. Ob Befehle auf Ausführung warten kann auf Geräteebene mit dem Parameter
- 'protCmdPend' abgefragt werden.
- <ul>
- <li><B>trgEventS [all|<peer>] <condition></B><a name="CUL_HMtrgEventS"></a><br>
- Initiiert ein eventS fuer die peer entity. Wenn <B>all</B> ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch <a href="CUL_HMeventS">eventS</a><br>
- <B><condition></B>: Ist der Wert welcher mit dem Event versendet wird. Bei einem Bewegungsmelder ist das bspw. die Helligkeit.
- </li>
- <li><B>trgEventL [all|<peer>] <condition></B><a name="CUL_HMtrgEventL"></a><br>
- Initiiert ein eventL fuer die peer entity. Wenn <B>all</B> ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch <a href="CUL_HMeventL">eventL</a><br>
- <B><condition></B>: is the condition being transmitted with the event. E.g. the brightness in case of a motion detector.
- </li>
- <li><B>trgPressS [all|<peer>] </B><a name="CUL_HMtrgPressS"></a><br>
- Initiiert ein pressS fuer die peer entity. Wenn <B>all</B> ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch <a href="CUL_HMpressS">pressS</a><br>
- </li>
- <li><B>trgPressL [all|<peer>] </B><a name="CUL_HMtrgPressL"></a><br>
- Initiiert ein pressL fuer die peer entity. Wenn <B>all</B> ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch <a href="CUL_HMpressL">pressL</a><br>
- </li>
- <li><B>peerChan <btn_no> <actChan> [single|<u>dual</u>|reverse]
- [<u>set</u>|unset] [<u>both</u>|actor|remote]</B><a name="CUL_HMpeerChan"></a><br>
- "peerChan" richtet eine Verbindung zwischen Sender-<B>Kanal</B> und
- Aktor-<B>Kanal</B> ein, bei HM "link" genannt. "Peering" darf dabei nicht
- mit "pairing" verwechselt werden.<br>
- <B>Pairing</B> bezeichnet das Zuordnen eines <B>Geräts</B> zu einer Zentrale.<br>
- <B>Peering</B> bezeichnet das faktische Verbinden von <B>Kanälen</B>.<br>
- Peering erlaubt die direkte Interaktion zwischen Sender und Aktor ohne den Einsatz einer CCU<br>
- Peering eines Senderkanals veranlaßt den Sender nach dem Senden eines Triggers auf die
- Bestätigung eines - jeden - Peers zu warten. Positives Feedback (z.B. grüne LED)
- gibt es dabei nur wenn alle Peers den Befehl bestätigt haben.<br>
- Peering eines Aktorkanals richtet dabei einen Satz von Parametern ein welche die auszuführenden Aktionen
- definieren wenn ein Trigger dieses Peers empfangen wird. Dies bedeutet: <br>
- - nur Trigger von Peers werden ausgeführt<br>
- - die auszuführende Aktion muss für den zugehörigen Trigger eines Peers definiert werden<br>
- Ein Aktorkanal richtet dabei eine Standardaktion beim Peering ein - diese hängt vom Aktor ab.
- Sie kann ebenfalls davon abhängen ob ein oder zwei Tasten <B>ein einem Befehl</B> gepeert werden.
- Peert man einen Schalter mit 2 Tasten kann eine Taste für 'on' und eine andere für 'off' angelegt werden.
- Wenn nur eine Taste definiert wird ist die Funktion wahrscheinlich 'toggle'.<br>
- Die Funktion kann durch programmieren des Register (vom Aktor abhängig) geändert werden.<br>
-
- Auch wenn der Befehl von einer Fernbedienung oder einem Taster kommt hat er direkten Effekt auf
- den Aktor. Das Peering beider Seiten ist quasi unabhängig und hat unterschiedlich Einfluss auf
- Sender und Empfänger.<br>
- Peering eines Aktorkanals mit mehreren Senderkanälen ist ebenso möglich wie das eines Senderkanals
- mit mehreren Empfängerkanälen.<br>
-
- <actChan> ist der zu verknüpfende Aktorkanal.<br>
-
- <btn_no> ist der zu verknüpfende Senderkanal (Knopf). Wird
- 'single' gewählt werden die Tasten von 1 an gezählt. Für 'dual' ist btn_no
- die Nummer des zu verwendenden Tasterpaares. Z.B. ist '3' iim Dualmodus das
- dritte Tasterpaar welches mit Tasten 5 und 6 im Singlemodus übereinstimmt.<br>
-
- Wird der Befehl auf einen Kanal angewendet wird btn_no igroriert.
- Muss gesetzt sein, sollte dabei 0 sein.<br>
-
- [single|dual]: Dieser Modus bewirkt das Standardverhalten des Aktors bei Benutzung eines Tasters. Ein Dimmer
- kann z.B. an einen einzelnen oder ein Paar von Tastern angelernt werden. <br>
- Standardeinstellung ist "dual".<br>
-
- 'dual' (default) Schalter verknüpft zwei Taster mit einem Aktor. Bei einem Dimmer
- bedeutet das ein Taster für hoch- und einer für runterdimmen. <br>
-
- 'reverse' identisch zu dual - nur die Reihenfolge der Buttons ist gedreht<br>
-
- 'single' benutzt nur einen Taster des Senders. Ist z.B. nützlich für einen einfachen Schalter
- der nur zwischen an/aus toggled. Aber auch ein Dimmer kann an nur einen Taster angelernt werden.<br>
-
- [set|unset]: Wählt aus ob Peer hinzugefügt oder entfernt werden soll.<br>
- Hinzufügen ist Standard.<br>
- 'set' stellt Peers für einen Kanal ein.<br>
- 'unset' entfernt Peer für einen Kanal.<br>
-
- [actor|remote|both] beschränkt die Ausführung auf Aktor oder Fernbedienung.
- Das ermöglicht dem Benutzer das entfernen des Peers vom Fernbedienungskanal ohne
- die Einstellungen am Aktor zu entfernen.<br>
- Standardmäßig gewählt ist "both" für beides.<br>
-
- Example:
- <ul><code>
- set myRemote peerChan 2 mySwActChn single set #Peer zweiten Knopf mit Aktorkanal<br>
- set myRmtBtn peerChan 0 mySwActChn single set #myRmtBtn ist ein Knopf der Fernbedienung. '0' wird hier nicht verarbeitet<br>
- set myRemote peerChan 2 mySwActChn dual set #Verknüpfe Knöpfe 3 und 4<br>
- set myRemote peerChan 3 mySwActChn dual unset #Entferne Peering für Knöpfe 5 und 6<br>
- set myRemote peerChan 3 mySwActChn dual unset aktor #Entferne Peering für Knöpfe 5 und 6 nur im Aktor<br>
- set myRemote peerChan 3 mySwActChn dual set remote #Verknüpfe Knöpfe 5 und 6 nur mit Fernbedienung. Linkeinstellungen mySwActChn werden beibehalten.<br>
- </code></ul>
- </li>
- </ul>
-
- </li>
- <li>virtual<a name="CUL_HMvirtual"></a><br>
- <ul>
- <li><B><a href="#CUL_HMpeerChan">peerChan</a></B> siehe remote</li>
- <li><B><a name="CUL_HMpress"></a>press [long|short] [<peer>] [<repCount>] [<repDelay>] </B>
- <ul>
- Simuliert den Tastendruck am Aktor eines gepeerted Sensors
- <li>[long|short] soll ein langer oder kurzer Taastendrucl simuliert werden? Default ist kurz. </li>
- <li>[<peer>] legt fest, wessen peer's trigger simuliert werden soll.Default ist self(channelNo).</li>
- <li>[<repCount>] nur gueltig fuer long. wie viele messages sollen gesendet werden? (Laenge des Button press). Default ist 1.</li>
- <li>[<repDelay>] nur gueltig fuer long. definiert die Zeit zwischen den einzelnen Messages. </li>
- </ul>
- </li>
- <li><B>virtTemp <[off -10..50]><a name="CUL_HMvirtTemp"></a></B>
- Simuliert ein Thermostat. Wenn mit einem Gerät gepeert wird periodisch eine Temperatur gesendet,
- solange bis "off" gewählt wird. Siehe auch <a href="#CUL_HMvirtHum">virtHum</a><br>
- </li>
- <li><B>virtHum <[off -10..50]><a name="CUL_HMvirtHum"></a></B>
- Simuliert den Feuchtigkeitswert eines Thermostats. Wenn mit einem Gerät verknüpft werden periodisch
- Luftfeuchtigkeit undTemperatur gesendet, solange bis "off" gewählt wird. Siehe auch <a href="#CUL_HMvirtTemp">virtTemp</a><br>
- </li>
- <li><B>valvePos <[off 0..100]><a name="CUL_HMvalvePos"></a></B>
- steuert einen Ventilantrieb<br>
- </li>
- </ul>
- </li>
- <li>smokeDetector<br>
- Hinweis: All diese Befehle funktionieren momentan nur wenn mehr als ein Rauchmelder
- vorhanden ist, und diese gepeert wurden um eine Gruppe zu bilden. Um die Befehle abzusetzen
- muss der Master dieser gruppe verwendet werden, und momentan muss man raten welcher der Master ist.<br>
- smokeDetector kann folgendermaßen in Gruppen eingeteilt werden:
- <a href="#CUL_HMpeerChan">peerChan</a>. Alle Mitglieder müssen mit dem Master verknüpft werden. Auch der
- Master muss mit peerChan zur Gruppe zugefügt werden - z.B. mit sich selbst verknüpft! Dadurch hat man volle
- Kontrolle über die Gruppe und muss nicht raten.<br>
- <ul>
- <li><B>teamCall</B> - führt einen Netzwerktest unter allen Gruppenmitgliedern aus</li>
- <li><B>teamCallBat</B> - Simuliert einen low-battery alarm</li>
- <li><B>alarmOn</B> - löst einen Alarm aus</li>
- <li><B>alarmOff</B> - schaltet den Alarm aus</li>
- </ul>
- </li>
- <li>4Dis (HM-PB-4DIS-WM|HM-PB-4DIS-WM|HM-RC-Dis-H-x-EU|ROTO_ZEL-STG-RM-DWT-10)
- <ul>
- <li><B>text <btn_no> [on|off] <text1> <text2></B><br>
- Zeigt Text auf dem Display eines Geräts an. Für diesen Zweck muss zuerst ein set-Befehl
- (oder eine Anzahl davon) abgegeben werden, dann können im "teach-in" Menü des 4Dis mit
- "Central" Daten übertragen werden.<br>
- Falls auf einen Kanal angewendet dürfen btn_no und on|off nicht verwendet werden, nur
- reiner Text.<br>
- \_ wird durch ein Leerzeichen ersetzt.<br>
- Beispiel:
- <ul>
- <code>
- set 4Dis text 1 on On Lamp<br>
- set 4Dis text 1 off Kitchen Off<br>
- <br>
- set 4Dis_chn4 text Kitchen Off<br>
- </code>
- </ul>
- </li>
- </ul>
- <br>
- </li>
- <li>Climate-Control (HM-CC-TC)
- <ul>
- <li><B>desired-temp <temp></B><br>
- Setzt verschiedene Temperaturen. <temp> muss zwischen 6°C und 30°C liegen, die Auflösung beträgt 0.5°C.</li>
- <li><B>tempListSat [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListSun [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListMon [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListTue [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListThu [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListWed [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListFri [prep|exec] HH:MM temp ... 24:00 temp</B><br>
- Gibt eine Liste mit Temperaturintervallen an. Bis zu 24 Intervall können pro Wochentag definiert werden, die
- Auflösung dabei sind 10 Minuten. Die letzte Zeitangabe muss 24:00 Uhr sein.<br>
- Beispiel: bis 6:00 soll die Temperatur 19°C sein, dann bis 23:00 Uhr 22.5°C, anschließend
- werden bis Mitternacht 19°C gewünscht.<br>
- <code> set th tempListSat 06:00 19 23:00 22.5 24:00 19<br></code>
- </li>
- <li><B>partyMode <HH:MM><durationDays></B><br>
- setzt die Steuerung für die angegebene Zeit in den Partymodus. Dazu ist die Endzeit sowie <b>Anzahl an Tagen</b>
- die er dauern soll anzugeben. Falls er am nächsten Tag enden soll ist '1'
- anzugeben<br></li>
- <li><B>sysTime</B><br>
- setzt Zeit des Klimakanals auf die Systemzeit</li>
- </ul><br>
- </li>
- <li>Climate-Control (HM-CC-RT-DN|HM-CC-RT-DN-BoM)
- <ul>
- <li><B>controlMode <auto|boost|day|night></B><br></li>
- <li><B>controlManu <temp></B><br></li>
- <li><B>controlParty <temp><startDate><startTime><endDate><endTime></B><br>
- setzt die Steuerung in den Partymodus, definiert Temperatur und Zeitrahmen.<br>
- Beispiel:<br>
- <code>set controlParty 15 03.8.13 20:30 5.8.13 11:30</code></li>
- <li><B>sysTime</B><br>
- setzt Zeit des Klimakanals auf die Systemzeit</li>
- <li><B>desired-temp <temp></B><br>
- Setzt verschiedene Temperaturen. <temp> muss zwischen 6°C und 30°C liegen, die Auflösung beträgt 0.5°C.</li>
- <li><B>tempListSat [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListSun [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListMon [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListTue [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListThu [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListWed [prep|exec] HH:MM temp ... 24:00 temp</B><br></li>
- <li><B>tempListFri [prep|exec] HH:MM temp ... 24:00 temp</B><br>
- Gibt eine Liste mit Temperaturintervallen an. Bis zu 24 Intervall können pro Wochentag definiert werden, die
- Auflösung dabei sind 10 Minuten. Die letzte Zeitangabe muss immer 24:00 Uhr sein.<br>
- Der optionale Parameter [prep|exec] erlaubt das packen der Nachrichten und verbessert damit deutlich
- die Datenübertragung. Besonders nützlich wenn das Gerät im "Wakeup"-modus betrieben wird.
- Benutzung durch senden der Befehle mit Parameter "prep". Daten werden dann für das Senden gesammelt.
- Der letzte Befehl muss den Parameter "exec" habe um die Information zu übertragen.<br>
- Beispiel: bis 6:00 soll die Temperatur 19°C sein, dann bis 23:00 Uhr 22.5°C, anschließend
- werden bis Mitternacht 19°C gewünscht.<br>
- <code> set th tempListSat 06:00 19 23:00 22.5 24:00 19<br></code>
- <br>
- <code> set th tempListSat prep 06:00 19 23:00 22.5 24:00 19<br>
- set th tempListSun prep 06:00 19 23:00 22.5 24:00 19<br>
- set th tempListMon prep 06:00 19 23:00 22.5 24:00 19<br>
- set th tempListTue exec 06:00 19 23:00 22.5 24:00 19<br></code>
- </li>
- <li><B>tempListTmpl =>"[verify|restore] [[<file>:]templateName] ...</B><br>
- Die Temperaturlisten für ein oder mehrere Devices können in einem File hinterlegt
- werden. Es wird ein template für eine Woche hinterlegt. Der User kann dieses
- template in ein Device schreiben lassen (restore). Er kann auch prüfen, ob das Device korrekt
- nach dieser Templist programmiert ist (verify).
- Default Opeartion ist verify.<br>
- Default File ist tempList.cfg.<br>
- Default templateName ist der name der Entity<br>
- Default für file und templateName kann mit dem Attribut <B>tempListTmpl</B> gesetzt werden.<br>
- Beispiel für ein templist File. room1 und room2 sind die Namen 2er Tempaltes:<br>
- <code>entities:room1
- tempListSat>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0
- tempListSun>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0
- tempListMon>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
- tempListTue>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0
- tempListWed>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
- tempListThu>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
- tempListFri>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
- entities:room2
- tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0
- tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0
- tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0
- tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0
- tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0
- tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0
- tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
- </code>
- Specials:<br>
- <li>none: das Template wird ignoriert</li>
- <li>defaultWeekplan: Es wird als Default jeden Tag 18.0 Grad eingestellt.
- Sinnvoll nutzbar wenn man einen TC als Kontroller nutzt. Der Wochenplan des TC wird dann imlizit genutzt</li>
- </li>
- <li><B>tempTmplSet =>"[[ <file> :]templateName]</B><br>
- Setzt das Attribut und sendet die Änderungen an das Device.
- </li>
- <li><B>templateDel =>" <template> </B><br>
- Löscht eine Templateeintrag an dieser entity.
- </li>
- </ul><br>
- </li>
- <li>OutputUnit (HM-OU-LED16)
- <ul>
- <li><B>led [off|red|green|yellow]</B><br>
- schaltet die LED des Kanals auf die gewünschte Farbe. Wird der Befehl auf ein Gerät angewandt so
- werden alle LEDs auf diese Farbe gesetzt.<br>
- Experten können die LEDs separat durch eine 8-stellige Hex-Zahl ansteuern.<br></li>
- <li><B>ilum <Helligkeit><Dauer> </B><br>
- <Helligkeit> [0-15] der Beleuchtung.<br>
- <Dauer> [0-127] in Sekunden, 0 bedeutet dauernd an.<br></li>
- </ul><br>
- </li>
- <li>OutputUnit (HM-OU-CFM-PL)
- <ul>
- <li><B>led <color>[,<color>..] [<repeat>..]</B><br>
- Mögliche Farben sind [redL|greenL|yellowL|redS|greenS|yellowS|pause]. Eine Folge von Farben
- kann durch trennen der Farbeinträge mit ',' eingestellt werden.
- Leerzeichen dürfen in der Liste nicht benutzt werden. 'S' bezeichnet kurze und
- 'L' lange Beleuchtungsdauer. <br>
- <b>repeat</b> definiert wie oft die Sequenz ausgeführt werden soll. Standard ist 1.<br>
- </li>
- <li><B>playTone <MP3No>[,<MP3No>..] [<repeat>] [<volume>]</B><br>
- Spielt eine Reihe von Tönen. Die Liste muss mit ',' getrennt werden. Leerzeichen
- dürfen in der Liste nicht benutzt werden.<br>
- <b>replay</b> kann verwendet werden um den zuletzt gespielten Klang zu wiederholen.<br>
- <b>repeat</b> definiert wie oft die Sequenz ausgeführt werden soll. Standard ist 1.<br>
- <b>volume</b> kann im Bereich 0..10 liegen. 0 stoppt jeden aktuell gespielten Sound. Standard ist 10 (100%.<br>
- Beispiel:
- <ul><code>
- set cfm_Mp3 playTone 3 # MP3 Titel 3 einmal<br>
- set cfm_Mp3 playTone 3 3 # MP3 Titel 3 dreimal<br>
- set cfm_Mp3 playTone 3 1 5 # MP3 Titel 3 mit halber Lautstärke<br>
- set cfm_Mp3 playTone 3,6,8,3,4 # MP3 Titelfolge 3,6,8,3,4 einmal<br>
- set cfm_Mp3 playTone 3,6,8,3,4 255# MP3 Titelfolge 3,6,8,3,4 255 mal<br>
- set cfm_Mp3 playTone replay # Wiederhole letzte Sequenz<br>
- <br>
- set cfm_Led led redL 4 # rote LED dreimal lang blinken<br>
- set cfm_Led led redS,redS,redS,redL,redL,redL,redS,redS,redS 255 # SOS 255 mal<br>
- </ul></code>
-
- </li>
- </ul><br>
- </li>
- <li>HM-RC-19xxx
- <ul>
- <li><B>alarm <count></B><br>
- sendet eine Alarmnachricht an die Steuerung<br></li>
- <li><B>service <count></B><br>
- sendet eine Servicenachricht an die Steuerung<br></li>
- <li><B>symbol <symbol> [set|unset]</B><br>
- aktiviert ein verfügbares Symbol auf der Steuerung<br></li>
- <li><B>beep [off|1|2|3]</B><br>
- aktiviert Töne<br></li>
- <li><B>backlight [off|on|slow|fast]</B><br>
- aktiviert Hintergrundbeleuchtung<br></li>
- <li><B>display <text> comma unit tone backlight <symbol(s)>
- </B><br>
- Steuert das Display der Steuerung<br>
- <text> : bis zu 5 Zeichen <br>
- comma : 'comma' aktiviert das Komma, 'no' läßt es aus <br>
- [unit] : setzt Einheitensymbole.
- [off|Proz|Watt|x3|C|x5|x6|x7|F|x9|x10|x11|x12|x13|x14|x15]. Momentan sind
- x3..x15 nicht getestet. <br>
- tone : aktiviert einen von 3 Tönen [off|1|2|3]<br>
- backlight: läßt die Hintergrundbeleuchtung aufblinken [off|on|slow|fast]<br>
- <symbol(s)> aktiviert die Anzeige von Symbolen. Mehrere Symbole
- können zu selben Zeit aktiv sein, Verknüpfung erfolgt komma-getrennt. Dabei keine
- Leerzeichen verwenden. Mögliche Symbole:
- [bulb|switch|window|door|blind|scene|phone|bell|clock|arrowUp|arrowDown]<br><br>
-
- Beispiel:
- <ul><code>
- # "Hello" auf dem Display, Symbol bulb an, Hintergrundbeleuchtung, Ton ausgeben<br>
- set FB1 display Hello no off 1 on bulb<br>
- # "1234,5" anzeigen mit Einheit 'W'. Symbole scene,phone,bell und
- # clock sind aktiv. Hintergrundbeleuchtung blinikt schnell, Ausgabe von Ton 2<br>
- set FB1 display 12345 comma Watt 2 fast scene,phone,bell,clock
- </ul></code>
- </li>
- </ul><br>
- </li>
- <li>HM-Dis-WM55
- <ul>
- <li><B>displayWM help </B><br>
- <B>displayWM [long|short] <text1> <color1> <icon1> ... <text6> <color6> <icon6></B><br>
- <B>displayWM [long|short] <lineX> <text> <color> <icon></B><br>
- es können bis zu 6 Zeilen programmiert werden.<br>
- <B>lineX</B> legt die zu ändernde Zeilennummer fest. Es können die 3 Parameter der Zeile geändert werden.<br>
- <B>textNo</B> ist der anzuzeigende Text. Der Inhalt des Texts wird in den Buttonds definiert.
- txt<BtnNo>_<lineNo> referenziert den Button und dessn jeweiligen Zeile.
- Alternativ kann ein bis zu 12 Zeichen langer Freitext angegeben werden<br>
- <B>color</B> kann sein white, red, orange, yellow, green, blue<br>
- <B>icon</B> kann sein off, on, open, closed, error, ok, noIcon<br>
-
- Example:
- <ul><code>
- set disp01 displayWM short txt02_2 green noIcon txt10_1 red error txt05_2 yellow closed txt02_2 orange open <br>
- set disp01 displayWM long line3 txt02_2 green noIcon<br>
- set disp01 displayWM long line2 nc yellow noIcon<br>
- set disp01 displayWM long line6 txt02_2<br>
- set disp01 displayWM long line1 nc nc closed<br>
- </ul></code>
- </li>
- </ul><br>
- </li>
- <li>HM-Dis-EP-WM55
- <ul>
- <li><B>displayEP help </B><br>
- <B>displayEP <text1,icon1:text2,icon2:text3,icon3> <sound> <repetition> <pause> <signal></B><br>
- bis zu 3 Zeilen werden adressiert.<br>
- Wenn help eingegeben wird wird eine <i><B>hilfe</B></i> zum Kommando ausgegeben. Optionen der Parameter werden ausgegeben.<br>
- <B>textx</B> 12 char text für die Zeile.
- Wenn leer wird der Wert gemäß Reading genutzt. Typisch bedeuted es, dass keine Änderung stattfindet.
- text0-9 zeigt den vordefinierten Wert der Kanäle 4 bis 8 an.
- 0xHH erlaubt die anzeige eines hex Zeichens.<br>
- <B>iconx</B> Icon der Zeile.
- Typisch bedeuted es, dass keine Änderung stattfindet.<br>
- <B>sound</B> sound zum Abspielen.<br>
- <B>repetition</B> 0..15 <br>
- <B>pause</B> 1..160<br>
- <B>signal</B> Signalfarbe zum Anzeigen<br>
- <br>
- <B>Note: param reWriteDisplayxx</B> <br>
- <li>
- Beim Druck einer Taste ueberschreibt das Geraet diemittleren 3 Zeilen. Wenn da Attribut <br>
- attr chan param reWriteDisplayxx<br>
- gesetzt ist werden die 3 Zeilen nach xx Sekunden auf den Orginalwert zurück geschrieben.<br>
- </li>
-
- </li>
- </ul><br>
- </li>
- <li>keyMatic<br><br>
- <ul>Keymatic verwendet eine AES-signierte Kommunikation. Die Steuerung von KeyMatic
- ist mit HMLAN und mit CUL möglich.
- Um die Keymatic mit einem CUL zu steuern, muss das Perl-Modul Crypt::Rijndael
- installiert sein.</ul><br>
- <ul>
- <li><B>lock</B><br>
- Schließbolzen fährt in Zu-Position<br></li>
- <li><B>unlock [sec]</B><br>
- Schließbolzen fährt in Auf-Position.<br>
- [sec]: Stellt die Verzögerung ein nach der sich das Schloss automatisch wieder verschließt.<br>
- 0 - 65535 Sekunden</li>
- <li><B>open [sec]</B><br>
- Entriegelt die Tür sodass diese geöffnet werden kann.<br>
- [sec]: Stellt die Verzögerung ein nach der sich das Schloss automatisch wieder
- verschließt.<br>0 - 65535 Sekunden</li>
- </ul>
- </li>
- <li>winMatic <br><br>
- <ul>winMatic arbeitet mit 2 Kanälen, einem für die Fenstersteuerung und einem für den Akku.</ul><br>
- <ul>
- <li><B>level <level> <relockDelay> <speed></B><br>
- stellt den Wert ein. <br>
- <level>: Bereich ist 0% bis 100%<br>
- <relockDelay>: Spanne reicht von 0 bis 65535 Sekunden. 'ignore' kann verwendet werden um den Wert zu ignorieren.<br>
- <speed>: Bereich ist 0% bis 100%<br>
- </li>
- <li><B>stop</B><br>
- stopt die Bewegung<br>
- </li>
- </ul>
- </li>
- <li>CCU_FHEM<br>
- <ul>
- <li>defIgnUnknown<br>
- Definieren die unbekannten Devices und setze das Attribut ignore.
- Ddann loesche die Readings. <br>
- </li>
- </ul>
- </li>
- <li>HM-Sys-sRP-Pl<br>
- legt Einträge für den Repeater an. Bis zu 36 Einträge können angelegt werden.
- <ul>
- <li><B>setRepeat <entry> <sender> <receiver> <broadcast></B><br>
- <entry> [1..36] Nummer des Eintrags in der Tabelle.<br>
- <sender> Name oder HMid des Senders oder der Quelle die weitergeleitet werden soll<br>
- <receiver> Name oder HMid des Empfängers oder Ziels an das weitergeleitet werden soll<br>
- <broadcast> [yes|no] definiert ob Broadcasts von einer ID weitergeleitet werden sollen.<br>
- <br>
- Kurzanwendung: <br>
- <code>setRepeat setAll 0 0 0<br></code>
- schreibt die gesamte Liste der Geräte neu. Daten kommen vom Attribut repPeers. <br>
- Das Attribut repPeers hat folgendes Format:<br>
- src1:dst1:[y/n],src2:dst2:[y/n],src2:dst2:[y/n],...<br>
- <br>
- Formatierte Werte von repPeer:<br>
- <ul>
- Number src dst broadcast verify<br>
- number: Nummer des Eintrags in der Liste<br>
- src: Ursprungsgerät der Nachricht - aus Repeater ausgelesen<br>
- dst: Zielgerät der Nachricht - aus den Attributen abgeleitet<br>
- broadcast: sollen Broadcasts weitergeleitet werden - aus Repeater ausgelesen<br>
- verify: stimmen Attribute und ausgelesen Werte überein?<br>
- </ul>
- </li>
- </ul>
- </li>
-
- </ul>
- <br>
- Debugging:
- <ul>
- <li><B>raw <data> ...</B><br>
- nur für Experimente benötigt.
- Sendet eine Liste von "Roh"-Befehlen. Der erste Befehl wird unmittelbar gesendet,
- die folgenden sobald der vorherige bestätigt wurde. Die Länge wird automatisch
- berechnet und der Nachrichtenzähler wird erhöht wenn die ersten beiden Zeichen ++ sind.
-
- Beispiel (AES aktivieren):
- <pre>
- set hm1 raw ++A001F100001234560105000000001\
- ++A001F10000123456010802010AF10B000C00\
- ++A001F1000012345601080801\
- ++A001F100001234560106
- </pre>
- </li>
- </ul>
- </ul>
- <br>
- <a name="CUL_HMget"></a><b>Get</b><br>
- <ul>
- <li><B>configSave <filename></B><a name="CUL_HMconfigSave"></a><br>
- Sichert die Einstellungen eines Eintrags in einer Datei. Die Daten werden in
- einem von der FHEM-Befehlszeile ausführbaren Format gespeichert.<br>
- Die Datei liegt im FHEM Home-Verzeichnis neben der fhem.cfg. Gespeichert wird
- kumulativ- d.h. neue Daten werden an die Datei angehängt. Es liegt am Benutzer das
- doppelte speichern von Einträgen zu vermeiden.<br>
- Ziel der Daten ist NUR die Information eines HM-Gerätes welche IM Gerät gespeichert ist.
- Im Deteil sind das nur die Peer-Liste sowie die Register.
- Durch die Register wird also das Peering eingeschlossen.<br>
- Die Datei ist vom Benutzer les- und editierbar. Zusätzlich gespeicherte Zeitstempel
- helfen dem Nutzer bei der Validierung.<br>
- Einschränkungen:<br>
- Auch wenn alle Daten eines Eintrags in eine Datei gesichert werden so sichert FHEM nur
- die zum Zeitpunkt des Speicherns verfügbaren Daten! Der Nutzer muss also die Daten
- der HM-Hardware auslesen bevor dieser Befehl ausgeführt wird.
- Siehe empfohlenen Ablauf unten.<br>
- Dieser Befehl speichert keine FHEM-Attribute oder Gerätedefinitionen.
- Diese verbleiben in der fhem.cfg.<br>
- Desweiteren werden gesicherte Daten nicht automatisch zurück auf die HM-Hardware geladen.
- Der Benutzer muss die Wiederherstellung auslösen.<br><br>
- Ebenso wie ander Befehle wird 'configSave' am besten auf ein Gerät und nicht auf einen
- Kanal ausgeführt. Wenn auf ein Gerät angewendet werden auch die damit verbundenen Kanäle
- gesichert. <br><br>
- <code>
- Empfohlene Arbeitsfolge für ein Gerät 'HMdev':<br>
- set HMdev clear msgEvents # alte Events löschen um Daten besser kontrollieren zu können<br>
- set HMdev getConfig # Geräte- und Kanalinformation auslesen<br>
- # warten bis Ausführung abgeschlossen ist<br>
- # "protState" sollte dann "CMDs_done" sein<br>
- # es sollten keine Warnungen zwischen "prot" und den Variablen auftauchen<br>
- get configSave myActorFile<br>
- </code>
- </li>
- <li><B>param <paramName></B><br>
- Gibt den Inhalt der relevanten Parameter eines Eintrags zurück. <br>
- Hinweis: wird der Befehl auf einen Kanal angewandt und 'model' abgefragt so wird das Model
- des inhalteanbietenden Geräts zurückgegeben.
- </li>
- <li><B>reg <addr> <list> <peerID></B><br>
- liefert den Wert eines Registers zurück. Daten werden aus dem Speicher von FHEM und nicht direkt vom Gerät geholt.
- Falls der Registerinhalt nicht verfügbar ist muss "getConfig" sowie anschließend "getReg" verwendet werden.<br>
-
- <addr> Adresse des Registers in HEX. Registername kann alternativ verwendet werden falls in FHEM bekannt.
- "all" gibt alle dekodierten Register eines Eintrags in einer Liste zurück.<br>
- <list> Liste aus der das Register gewählt wird. Wird der REgistername verwendet wird "list" ignoriert und kann auf '0' gesetzt werden.<br>
- <peerID> identifiziert die Registerbänke für "list3" und "list4". Kann als Dummy gesetzt werden wenn nicht benötigt.<br>
- </li>
- <li><B>regList</B><br>
- gibt eine Liste der von FHEM für dieses Gerät dekodierten Register zurück.<br>
- Beachten dass noch mehr Register für ein Gerät implemetiert sein können.<br>
- </li>
- <li><B>saveConfig <file></B><a name="CUL_HMsaveConfig"></a><br>
- speichert Peers und Register in einer Datei.<br>
- Gespeichert werden die Daten wie sie in FHEM verfügbar sind. Es ist daher notwendig vor dem Speichern die Daten auszulesen.<br>
- Der Befehl unterstützt Aktionen auf Geräteebene. D.h. wird der Befehl auf ein Gerät angewendet werden auch alle verbundenen Kanaleinträge gesichert.<br>
- Das Speichern der Datei erfolgt kumulativ. Wird ein Eintrag mehrfach in der selben Datei gespeichert so werden die Daten an diese angehängt.
- Der Nutzer kann den Zeitpunkt des Speichern bei Bedarf auslesen.<br>
- Der Inhalt der Datei kann verwendet werden um die Geräteeinstellungen wiederherzustellen. Er stellt alle Peers und Register des Eintrags wieder her.<br>
- Zwänge/Beschränkungen:<br>
- vor dem zurückschreiben der Daten eines Eintrags muss das Gerät mit FHEM verbunden werden.<br>
- "restore" löscht keine verknüpften Kanäle, es fügt nur neue Peers hinzu.<br>
- </li>
- <li><B>listDevice</B><br>
- <ul>
- <li>bei einer CCU gibt es eine Liste der Devices, welche den ccu service zum zuweisen der IOs zurück<br>
- </li>
- <li>beim ActionDetector wird eine Komma geteilte Liste der Entities zurückgegeben<br>
- get ActionDetector listDevice # returns alle assigned entities<br>
- get ActionDetector listDevice notActive# returns entities ohne status alive<br>
- get ActionDetector listDevice alive # returns entities mit status alive<br>
- get ActionDetector listDevice unknown # returns entities mit status unknown<br>
- get ActionDetector listDevice dead # returns entities mit status dead<br>
- </li>
- </ul>
- </li>
- </ul><br>
- <a name="CUL_HMattr"></a><b>Attribute</b>
- <ul>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#dummy">dummy</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <li><a name="CUL_HMaesCommReq">aesCommReq</a>
- wenn gesetzt wird IO AES signature anfordern bevor ACK zum Device gesendet wird.<br>
- </li>
- <li><a name="#CUL_HMactAutoTry">actAutoTry</a>
- actAutoTry 0_off,1_on<br>
- setzen erlaubt dem ActionDetector ein statusrequest zu senden falls das Device dead markiert werden soll.
- Das Attribut kann fuer Devices nützlich sein, welche sich nicht von selbst zyklisch melden.
- </li>
- <li><a href="#actCycle">actCycle</a>
- actCycle <[hhh:mm]|off><br>
- Bietet eine 'alive' oder besser 'not alive' Erkennung für Geräte. [hhh:mm] ist die maximale Zeit ohne Nachricht eines Geräts. Wenn innerhalb dieser Zeit keine Nachricht empfangen wird so wird das Event"<device> is dead" generiert.
- Sendet das Gerät wieder so wird die Nachricht"<device> is alive" ausgegeben. <br>
- Diese Erkennung wird durch 'autocreate' für jedes Gerät mit zyklischer Statusmeldung angelegt.<br>
- Die Kontrollinstanz ist ein Pseudo-Gerät "ActionDetector" mit der HMId "000000".<br>
- Aufgrund von Performanceüberlegungen liegt die Antwortverzögerung bei 600 Sekunden (10min). Kann über das Attribut "actCycle" des "ActionDetector" kontrolliert werden.<br>
- Sobald die Überwachung aktiviert wurde hat das HM-Gerät 2 Attribute:<br>
- <ul>
- actStatus: Aktivitätsstatus des Geräts<br>
- actCycle: Detektionsspanne [hhh:mm]<br>
- </ul>
- Die gesamte Funktion kann über den "ActionDetector"-Eintrag überprüft werden. Der Status aller Instanzen liegt im READING-Bereich.<br>
- Hinweis: Diese Funktion kann ebenfalls für Geräte ohne zyklische Übertragung aktiviert werden. Es obliegt dem Nutzer eine vernünftige Zeitspanne festzulegen.
- </li>
- <li><a name="#CUL_HMautoReadReg">autoReadReg</a><br>
- '0' autoReadReg wird ignorert.<br>
- '1' wird automatisch in getConfig ausgeführt für das Device nach jedem reboot von FHEM. <br>
- '2' wie '1' plus nach Power on.<br>
- '3' wie '2' plus update wenn auf das Device geschreiben wird.<br>
- '4' wie '3' plus fordert Status an, wenn es nicht korrekt erscheint<br>
- '5' prüft Registerlisten und peerlisten. Wenn diese nicht komplett sind wird ein update angefordert<br>
- '8_stateOnly' es wird nur der Status geprüft, updates für Register werden nicht gemacht.<br>
- Ausführung wird verzögert ausgeführt. Wenn das IO eine gewisse Last erreicht hat wird
- das Kommando weiter verzögert um eine Überlast zu vermeiden.<br>
- Empfohlene Zusammenhänge bei Nutzung:<br>
- <ul>
- Benutze das Attribut für das Device, nicht für jeden einzelnen Kanal<br>
- Das Setzen auf Level 5 wird für alle Devices und Typen empfohlen, auch wakeup Devices.<br>
- </ul>
- </li>
- <li><a name="CUL_HMburstAccess">burstAccess</a><br>
- kann für eine Geräteinstanz gesetzt werden falls das Model bedingte Bursts erlaubt.
- Das Attribut deaktiviert den Burstbetrieb (0_off) was die Nachrichtenmenge des HMLAN reduziert
- und damit die Wahrscheinlichkeit einer Überlast von HMLAN verringert.<br>
- Einschalten (1_auto) erlaubt kürzere Reaktionszeiten eines Geräts. Der Nutzer muss nicht warten
- bis das Gerät wach ist. <br>
- Zu beacht ist dass das Register "burstRx" im Gerät ebenfalls gesetzt werden muss.
- </li>
- <li><a name="CUL_HMexpert">expert</a><br>
- Dieses Attribut steuert die Sichtbarkeit der Register Readngs. Damit wird die Darstellung der Geräteparameter kontrolliert.<br>
- Es handdelt sich um einen binaer kodierten Wert mit folgenden Empfehlungen:<br>
- <ul>
- 0_defReg : default Register<br>
- 1_allReg : all Register<br>
- 2_defReg+raw : default Register und raw Register<br>
- 3_allReg+raw : alle Register und raw reading<br>
- 4_off : no Register<br>
- 8_templ+default: templates und default Register<br>
- 12_templOnly : nur templates<br>
- 251_anything : alles verfügbare<br>
- </ul>
- Wird 'expert' auf ein Gerät angewendet so gilt dies auch für alle verknüpften Kanäle.
- Kann übergangen werden indem das Attribut ' expert' auch für den Gerätekanal gesetzt wird.<br>
- Das Attribut "showInternalValues" bei den globalen Werten muss ebenfalls überprüft werden.
- "expert" macht sich diese Implementierung zu Nutze.
- Gleichwohl setzt "showInternalValues" - bei Definition - 'expert' außer Kraft .
- </li>
- <li><a name="#CUL_HMreadOnly">readOnly</a><br>
- beschränkt kommandos auf Lesen und Beobachten.
- </li>
- <li><a name="#CUL_HMIOgrp">IOgrp</a><br>
- kann an Devices vergeben werden udn zeigt auf eine virtuelle ccu. Danach wird die ccu
- beim Senden das passende IO für das Device auswählen. Es ist notwendig, dass die virtuelle ccu
- definiert und alle erlaubten IOs eingetragen sind. Beim Senden wird die ccu prüfen
- welches IO operational ist und welches den besten rssi-faktor für das Device hat.<br>
- Optional kann ein bevorzugtes IO definiert werden. In diesem Fall wird es, wenn operational,
- genutzt - unabhängig von den rssi Werten.<br>
- wenn kein prefIO verfügbar ist und none erkannt wird wird das IO aus IODev gewählt<br>
- Beispiel:<br>
- <ul><code>
- attr myDevice1 IOgrp vccu<br>
- attr myDevice2 IOgrp vccu:prefIO1,prefIO2,prefIO3<br>
- attr myDevice2 IOgrp vccu:prefIO1,prefIO2,none<br>
- </code></ul>
- </li>
- <li><a name="#CUL_HMlevelRange">levelRange</a><br>
- nur für Dimmer! Der Dimmbereich wird eingeschränkt.
- Es ist gedacht um z.B. LED Lichter unterstützen welche mit 10% beginnen und bei 40% bereits das Maximum haben.
- levelrange normalisiert den Bereich entsprechend. D.h. set 100 wird physikalisch den Dimmer auf 40%,
- 1% auf 10% setzen. 0% schaltet physikalisch aus.<br>
- Beeinflusst werdne Kommndos on, up, down, toggle und pct. <b>Nicht</b> beeinflusst werden Kommandos
- die den Wert physikalisch setzen.<br>
- Zu beachten:<br>
- dimmer level von Peers gesetzt wird nicht beeinflusst. Dies wird durch Register konfiguriert.<br>
- Readings level könnte negative werden oder über 100%. Das kommt daher, dass physikalisch der Bereich 0-100%
- ist aber auf den logischen bereicht normiert wird.<br>
- Sind virtuelle Dimmer Kanäle verfügbar muss das Attribut für jeden Kanal gesetzt werden<br>
- Beispiel:<br>
- <ul><code>
- attr myChannel levelRange 0,40<br>
- attr myChannel levelRange 10,80<br>
- </code></ul>
- </li>
- <li><a name="#CUL_HMtempListTmpl">tempListTmpl</a><br>
- Setzt das Default für Heizungskontroller. Ist es nicht gesetzt wird der default filename genutzt und der name
- der entity als templatename. Z.B. ./tempList.cfg:RT_Clima<br>
- Um das template nicht zu nutzen kann man es auf '0'setzen.<br>
- Format ist <file>:<templatename>.
- </li>
- <li><a name="CUL_HMmodel">model</a>,
- <a name="subType">subType</a><br>
- Diese Attribute werden bei erfolgreichem Pairing automatisch gesetzt.
- Sie sollten nicht per Hand gesetzt werden und sind notwendig um Gerätenachrichten
- korrekt interpretieren oder senden zu können.</li>
- <li><a name="param">param</a><br>
- 'param' definiert modelspezifische Verhalten oder Funktionen. Siehe "models" für Details.</li>
- <li><a name="CUL_HMmsgRepeat">msgRepeat</a><br>
- Definiert die Nummer an Wiederholungen falls ein Gerät nicht rechtzeitig antwortet. <br>
- Für Geräte die nur den "Config"-Modus unterstützen sind Wiederholungen nicht erlaubt. <br>
- Bei Geräte mit wakeup-Modus wartet das Gerät bis zum nächsten Aufwachen. Eine längere Verzögerung
- sollte in diesem Fall angedacht werden. <br>
- Wiederholen von Bursts hat Auswirkungen auf die HMLAN Übertragungskapazität.</li>
- <li><a name="rawToReadable">rawToReadable</a><br>
- Wird verwendet um Rohdaten von KFM100 in ein lesbares Fomrat zu bringen, basierend auf
- den gemessenen Werten. Z.B. langsames Füllen eines Tanks, während die Werte mit <a href="#inform">inform</a>
- angezeigt werden. Man sieht:
- <ul>
- 10 (bei 0%)<br>
- 50 (bei 20%)<br>
- 79 (bei 40%)<br>
- 270 (bei 100%)<br>
- </ul>
- Anwenden dieser Werte: "attr KFM100 rawToReadable 10:0 50:20 79:40 270:100".
- FHEM für damit eine lineare Interpolation der Werte in den gegebenen Grenzen aus.
- </li>
- <li><a name="unit">unit</a><br>
- setzt die gemeldete Einheit des KFM100 falls 'rawToReadable' aktiviert ist. Z.B.<br>
- attr KFM100 unit Liter
- </li>
- <li><a name="autoReadReg">autoReadReg</a><br>
- '0' autoReadReg wird ignoriert.<br>
- '1' führt ein "getConfig" für ein Gerät automatisch nach jedem Neustart von FHEM aus. <br>
- '2' verhält sich wie '1',zusätzlich nach jedem power_on.<br>
- '3' wie '2', zusätzlich bei jedem Schreiben auf das Gerät<br>
- '4' wie '3' und versucht außerdem den Status abzufragen falls dieser nicht verfügbar erscheint.<br>
- '5' kontrolliert 'reglist' und 'peerlist'. Falls das Auslesen unvollständig ist wird 'getConfig' ausgeführt<br>
- '8_stateOnly' aktualisiert nur Statusinformationen aber keine Konfigurationen wie Daten- oder
- Peerregister.<br>
- Ausführung wird verzögert um eine Überlastung beim Start zu vermeiden . Daher werden Aktualisierung und Anzeige
- von Werten abhängig von der Größe der Datenbank verzögert geschehen.<br>
- Empfehlungen und Einschränkungen bei Benutzung:<br>
- <ul>
- Dieses Attribut nur auf ein Gerät oder Kanal 01 anwenden. Nicht auf einzelne Kanäle eines mehrkanaligen
- Geräts anwenden um eine doppelte Ausführung zu vermeiden.<br>
- Verwendung bei Geräten die nur auf den 'config'-Modus reagieren wird nicht empfohlen da die Ausführung
- erst starten wird wenn der Nutzer die Konfiguration vornimmt<br>
- Anwenden auf Geräte mit 'wakeup'-Modus ist nützlich. Zu bedenken ist aber dass die Ausführung
- bis zm "aufwachen" verzögert wird.<br>
- </ul>
- </li>
- </ul> <br>
- <a name="CUL_HMparams"><b>verfügbare Parameter für "param"</b></a>
- <ul>
- <li><B>HM-Sen-RD-O</B><br>
- offAtPon: nur Heizkanäle: erzwingt Ausschalten der Heizung nach einem powerOn<br>
- onAtRain: nur Heizkanäle: erzwingt Einschalten der Heizung bei Status 'rain' und Ausschalten bei Status 'dry'<br>
- </li>
- <li><B>virtuals</B><br>
- noOnOff: eine virtuelle Instanz wird den Status nicht ändern wenn ein Trigger empfangen wird. Ist dieser Paramter
- nicht gegeben so toggled die Instanz ihren Status mit jedem trigger zwischen An und Aus<br>
- msgReduce: falls gesetzt und der Kanal wird für <a ref="CUL_HMvalvePos"></a> genutzt wird jede Nachricht
- außer die der Ventilstellung verworfen um die Nachrichtenmenge zu reduzieren<br>
- </li>
- <li><B>blind</B><br>
- <B>levelInverse</B> während HM 100% als offen und 0% als geschlossen behandelt ist dies evtl. nicht
- intuitiv für den Nutzer. Defaut für 100% ist offen und wird als 'on'angezeigt.
- Das Setzen des Parameters invertiert die Anzeige - 0% wird also offen und 100% ist geschlossen.<br>
- ACHTUNG: Die Anpassung betrifft nur Readings und Kommandos. <B>Register sind nicht betroffen.</B><br>
- <B>ponRestoreSmart</B> bei powerup des Device fährt das Rollo in die vermeintlich nächstgelegene Endposition und anschliessend in die ursprüngliche Position.<br>
- <B>ponRestoreForce</B> bei powerup des Device fährt das Rollo auf Level 0, dann auf Level 100 und anschliessend in die ursprüngliche Position.<br>
- </li>
- <li><B>sensRain</B><br>
- <B>siren</B><br>
- <B>powerMeter</B><br>
- <B>switch</B><br>
- <B>dimmer</B><br>
- <B>rgb</B><br>
- <B>showTimed</B> wenn timedOn running ist wird -till an state gehängt. Dies führt dazu, dass ggf. on-till im State steht was das stateIcon handling verbessert.<br>
- </li>
- </ul><br>
- <a name="CUL_HMevents"><b>Erzeugte Events:</b></a>
- <ul>
- <li><B>Allgemein</B><br>
- recentStateType:[ack|info] # kann nicht verwendet werden um Nachrichten zu triggern<br>
- <ul>
- <li>ack zeigt an das eine Statusinformation aus einer Bestätigung abgeleitet wurde</li>
- <li>info zeigt eine automatische Nachricht eines Geräts an</li>
- <li><a name="CUL_HMsabotageAttackId"><b>sabotageAttackId</b></a><br>
- Alarmiert bei Konfiguration des Geräts durch unbekannte Quelle<br></li>
- <li><a name="CUL_HMsabotageAttack"><b>sabotageAttack</b></a><br>
- Alarmiert bei Konfiguration des Geräts welche nicht durch das System ausgelöst wurde<br></li>
- <li><a name="CUL_HMtrigDst"><b>trigDst_<name>: noConfig</b></a><br>
- Ein Sensor triggert ein Device welches nicht in seiner Peerliste steht. Die Peerliste ist nicht akuell<br></li>
- </ul>
- </li>
- <li><B>HM-CC-TC,ROTO_ZEL-STG-RM-FWT</B><br>
- T: $t H: $h<br>
- battery:[low|ok]<br>
- measured-temp $t<br>
- humidity $h<br>
- actuator $vp %<br>
- desired-temp $dTemp<br>
- desired-temp-manu $dTemp #Temperatur falls im manuellen Modus<br>
- desired-temp-cent $dTemp #Temperatur falls im Zentrale-Modus<br>
- windowopen-temp-%d %.1f (sensor:%s)<br>
- tempList$wd hh:mm $t hh:mm $t ...<br>
- displayMode temp-[hum|only]<br>
- displayTemp [setpoint|actual]<br>
- displayTempUnit [fahrenheit|celsius]<br>
- controlMode [auto|manual|central|party]<br>
- tempValveMode [Auto|Closed|Open|unknown]<br>
- param-change offset=$o1, value=$v1<br>
- ValveErrorPosition_for_$dname $vep %<br>
- ValveOffset_for_$dname : $of %<br>
- ValveErrorPosition $vep %<br>
- ValveOffset $of %<br>
- time-request<br>
- trig_<src> <value> #channel was triggered by <src> channel.
- Dieses Event hängt vom kompletten Auslesen der Kanalkonfiguration ab, anderenfalls können Daten
- unvollständig oder fehlerhaft sein.<br>
- trigLast <channel> #letzter empfangener Trigger<br>
- </li>
- <li><B>HM-CC-RT-DN and HM-CC-RT-DN-BoM</B><br>
- state:T: $actTemp desired: $setTemp valve: $vp %<br>
- motorErr: [ok|ValveTight|adjustRangeTooLarge|adjustRangeTooSmall|communicationERR|unknown|lowBat|ValveErrorPosition]
- measured-temp $actTemp<br>
- desired-temp $setTemp<br>
- ValvePosition $vp %<br>
- mode [auto|manual|party|boost]<br>
- battery [low|ok]<br>
- batteryLevel $bat V<br>
- measured-temp $actTemp<br>
- desired-temp $setTemp<br>
- actuator $vp %<br>
- time-request<br>
- trig_<src> <value> #Kanal wurde durch <src> Kanal ausgelößt.
- </li>
- <li><B>HM-CC-VD,ROTO_ZEL-STG-RM-FSA</B><br>
- $vp %<br>
- battery:[critical|low|ok]<br>
- motorErr:[ok|blocked|loose|adjusting range too small|opening|closing|stop]<br>
- ValvePosition:$vp %<br>
- ValveErrorPosition:$vep %<br>
- ValveOffset:$of %<br>
- ValveDesired:$vp % # durch Temperatursteuerung gesetzt <br>
- operState:[errorTargetNotMet|onTarget|adjusting|changed] # operative Bedingung<br>
- operStateErrCnt:$cnt # Anzahl fehlgeschlagener Einstellungen<br>
- </li>
- <li><B>HM-CC-SCD</B><br>
- [normal|added|addedStrong]<br>
- battery [low|ok]<br>
- </li>
- <li><B>HM-SEC-SFA-SM</B><br>
- powerError [on|off]<br>
- sabotageError [on|off]<br>
- battery: [critical|low|ok]<br>
- </li>
- <li><B>HM-LC-BL1-PB-FM</B><br>
- motor: [opening|closing]<br>
- </li>
- <li><B>HM-LC-SW1-BA-PCB</B><br>
- battery: [low|ok]<br>
- </li>
- <li><B>HM-OU-LED16</B><br>
- color $value # in Hex - nur für Gerät<br>
- $value # in Hex - nur für Gerät<br>
- color [off|red|green|orange] # für Kanal <br>
- [off|red|green|orange] # für Kanal <br>
- </li>
- <li><B>HM-OU-CFM-PL</B><br>
- [on|off|$val]<br>
- </li>
- <li><B>HM-Sen-Wa-Od</B><br>
- $level%<br>
- level $level%<br>
- </li>
- <li><B>KFM100</B><br>
- $v<br>
- $cv,$unit<br>
- rawValue:$v<br>
- Sequence:$seq<br>
- content:$cv,$unit<br>
- </li>
- <li><B>KS550/HM-WDS100-C6-O</B><br>
- T: $t H: $h W: $w R: $r IR: $ir WD: $wd WDR: $wdr S: $s B: $b<br>
- temperature $t<br>
- humidity $h<br>
- windSpeed $w<br>
- windDirection $wd<br>
- windDirRange $wdr<br>
- rain $r<br>
- isRaining $ir<br>
- sunshine $s<br>
- brightness $b<br>
- unknown $p<br>
- </li>
- <li><B>HM-Sen-RD-O</B><br>
- lastRain: timestamp # kein Trigger wird erzeugt. Anfang des vorherigen Regen-Zeitstempels
- des Messwerts ist Ende des Regens. <br>
- </li>
- <li><B>THSensor und HM-WDC7000</B><br>
- T: $t H: $h AP: $ap<br>
- temperature $t<br>
- humidity $h<br>
- airpress $ap #nur HM-WDC7000<br>
- </li>
- <li><B>dimmer</B><br>
- overload [on|off]<br>
- overheat [on|off]<br>
- reduced [on|off]<br>
- dim: [up|down|stop]<br>
- </li>
- <li><B>motionDetector</B><br>
- brightness:$b<br>
- alive<br>
- motion on (to $dest)<br>
- motionCount $cnt _next:$nextTr"-"[0x0|0x1|0x2|0x3|15|30|60|120|240|0x9|0xa|0xb|0xc|0xd|0xe|0xf]<br>
- cover [closed|open] # nicht bei HM-Sec-MDIR<br>
- sabotageError [on|off] # nur bei HM-Sec-MDIR<br>
- battery [low|ok]<br>
- devState_raw.$d1 $d2<br>
- </li>
- <li><B>remote/pushButton/outputUnit</B><br>
- <ul> (to $dest) wird hinzugefügt wenn der Knopf gepeert ist und keinen Broadcast sendet<br>
- Freigabe ist nur für verknüpfte Kanäle verfügbar</ul>
- Btn$x onShort<br>
- Btn$x offShort<br>
- Btn$x onLong $counter<br>
- Btn$x offLong $counter<br>
- Btn$x onLongRelease $counter<br>
- Btn$x offLongRelease $counter<br>
- Btn$x onShort (to $dest)<br>
- Btn$x offShort (to $dest)<br>
- Btn$x onLong $counter (to $dest)<br>
- Btn$x offLong $counter (to $dest)<br>
- Btn$x onLongRelease $counter (to $dest)<br>
- Btn$x offLongRelease $counter (to $dest)<br>
- </li>
- <li><B>remote/pushButton</B><br>
- battery [low|ok]<br>
- trigger [Long|Short]_$no trigger event from channel<br>
- </li>
- <li><B>swi</B><br>
- Btn$x Short<br>
- Btn$x Short (to $dest)<br>
- battery: [low|ok]<br>
- </li>
- <li><B>switch/dimmer/blindActuator</B><br>
- $val<br>
- powerOn [on|off|$val]<br>
- [unknown|motor|dim] [up|down|stop]:$val<br>
- timedOn [running|off]<br> # "An" ist temporär - z.B. mit dem 'on-for-timer' gestartet
- </li>
- <li><B>sensRain</B><br>
- $val<br>
- powerOn <br>
- level <val≥<br>
- timedOn [running|off]<br> # "An" ist temporär - z.B. mit dem 'on-for-timer' gestartet
- trigger [Long|Short]_$no trigger event from channel<br>
- </li>
- <li><B>smokeDetector</B><br>
- [off|smoke-Alarm|alive] # für Gruppen-Master<br>
- [off|smoke-forward|smoke-alarm] # für Gruppenmitglieder<br>
- [normal|added|addedStrong] #HM-CC-SCD<br>
- SDteam [add|remove]_$dname<br>
- battery [low|ok]<br>
- smoke_detect [none|<src>]<br>
- teamCall:from $src<br>
- </li>
- <li><B>threeStateSensor</B><br>
- [open|tilted|closed]<br>
- [wet|damp|dry] #nur HM-SEC-WDS<br>
- cover [open|closed] #HM-SEC-WDS und HM-Sec-RHS<br>
- alive yes<br>
- battery [low|ok]<br>
- contact [open|tilted|closed]<br>
- contact [wet|damp|dry] #nur HM-SEC-WDS<br>
- sabotageError [on|off] #nur HM-SEC-SC<br>
- </li>
- <li><B>winMatic</B><br>
- [locked|$value]<br>
- motorErr [ok|TurnError|TiltError]<br>
- direction [no|up|down|undefined]<br>
- charge [trickleCharge|charge|dischange|unknown]<br>
- airing [inactiv|$air]<br>
- course [tilt|close]<br>
- airing [inactiv|$value]<br>
- contact tesed<br>
- </li>
- <li><B>keyMatic</B><br>
- unknown:40<br>
- battery [low|ok]<br>
- uncertain [yes|no]<br>
- error [unknown|motor aborted|clutch failure|none']<br>
- lock [unlocked|locked]<br>
- [unlocked|locked|uncertain]<br>
- </li>
- </ul>
- <a name="CUL_HMinternals"><b>Internals</b></a>
- <ul>
- <li><B>aesCommToDev</B><br>
- Information über Erfolg und Fehler der AES Kommunikation zwischen IO-device und HM-Device<br>
- </li>
- </ul><br>
- <br>
- </ul>
- <p><a name="CUL_HOERMANN"></a>
- <h3>CUL_HOERMANN</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CUL_HOERMANN'>CUL_HOERMANN</a><br/>
- </ul>
- <a name="CUL_IR"></a>
- <h3>CUL_IR</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CUL_IR'>CUL_IR</a><br/>
- </ul>
- <a name="CUL_MAX"></a>
- <h3>CUL_MAX</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_MAX'>EN</a> DE]</div>
- <ul>
- Das Modul CUL_MAX wertet von einem CUL empfangene MAX! Botschaften aus.
- Es wird mit Hilfe von autocreate automatisch generiert, es muss nur sichergestellt
- werden, dass der richtige rfmode gesetzt wird, z.B. <code>attr CUL0 rfmode MAX</code>.<br>
- <br>
- <a name="CUL_MAXdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> CUL_MAX <addr></code>
- <br><br>
- Definiert ein CUL_MAX Gerät des Typs <type> und der Adresse <addr>.
- Die Adresse darf nicht schon von einem anderen MAX! Gerät verwendet werden.
- </ul>
- <br>
- <a name="CUL_MAXset"></a>
- <b>Set</b>
- <ul>
- <li>pairmode<br>
- Versetzt den CUL_MAX für 60 Sekunden in den Pairing Modus, während dieser Zeit
- kann das Gerät mit anderen Geräten gepaart werden (Heizkörperthermostate,
- Eco-Taster, etc.). Auch das zu paarende Gerät muss manuell in den Pairing Modus
- versetzt werden (z.B. beim Heizkörperthermostat durch Drücken der "Boost"
- Taste für 3 Sekunden).</li>
- <li>fakeSC <device> <open><br>
- Sendet eine fingierte <i>ShutterContactState</i> Meldung <open>, dies muss 0 bzw. 1 für
- "Fenster geschlossen" bzw. "Fenster offen" sein. Wenn das <device> eine Gruppen-ID
- ungleich Null hat, beeinflusst diese fingierte <i>ShutterContactState</i> Meldung alle Geräte
- mit dieser Gruppen-ID. Es muss sichergestellt werden, dass vorher alle Zielgeräte
- mit <i>fakeShutterContact</i> verbunden werden.</li>
- <li>fakeWT <device> <desiredTemperature> <measuredTemperature><br>
- Sendet eine fingierte <i>WallThermostatControl</i> Meldung (beide Parameter können
- eine Nachkommastelle haben, für <i>desiredTemperature</i> darf die Nachkommastelle nur 0 bzw. 5 sein).
- Wenn das <device> eine Gruppen-ID ungleich Null hat, beeinflusst diese fingierte
- <i>WallThermostatControl</i> Meldung alle Geräte mit dieser Gruppen-ID.
- Es muss sichergestellt werden, dass vorher alle Zielgeräte
- mit <i>fakeWallThermostat</i> verbunden werden.</li>
- </ul>
- <br>
- <a name="CUL_MAXget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="CUL_MAXattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#ignore">ignore</a></li><br>
- <li><a href="#do_not_notify">do_not_notify</a></li><br>
- <li><a href="#showtime">showtime</a></li><br>
- <li><a href="#loglevel">loglevel</a></li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <a name="CUL_MAXevents"></a>
- <b>Events</b>
- <ul>N/A</ul>
- <br>
- </ul>
- <p><a name="CUL_REDIRECT"></a>
- <h3>CUL_REDIRECT</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_REDIRECT'>EN</a> DE]</div>
- <ul>
- Das CUL_REDIRECT Modul empfängt weitere Protokolle vom CUL<br>
- und leitet diese an die entsprechenden Module weiter.
- <br>
-
- <a name="CUL_REDIRECT_Parse"></a>
- </ul>
- <p><a name="CUL_RFR"></a>
- <h3>CUL_RFR</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CUL_RFR'>CUL_RFR</a><br/>
- </ul>
- <a name="CUL_TCM97001"></a>
- <h3>CUL_TCM97001</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_TCM97001'>EN</a> DE]</div>
- <ul>
- Das CUL_TCM97001 Module verarbeitet von einem IO Gerät (CUL, CUN, SIGNALDuino, etc.) empfangene Nachrichten von Temperatur \ Wind \ Rain - Sensoren.<br>
- <br>
- <b>Unterstütze Modelle:</b>
- <ul>
- <li>ABS700</li>
- <li>AURIOL</li>
- <li>Eurochron</li>
- <li>GT_WT_02</li>
- <li>KW9010</li>
- <li>NC_WS</li>
- <li>TCM21....</li>
- <li>TCM97...</li>
- <li>PFR-130 (rain)</li>
- <li>Prologue</li>
- <li>Rubicson</li>
- <li>W155 (wind/rain)</li>
- <li>W174 (rain)</li>
- </ul>
- <br>
- Neu empfangene Sensoren werden in der fhem Kategory CUL_TCM97001 per autocreate angelegt.
- <br><br>
- <a name="CUL_TCM97001_Define"></a>
- <b>Define</b>
- <ul>Die empfangenen Sensoren werden automatisch angelegt.<br>
- Die ID der angelgten Sensoren sind die ersten zwei HEX Werte des empfangenen Paketes in dezimaler Schreibweise.<br>
- </ul>
- <br>
- <a name="CUL_TCM97001 Events"></a>
- <b>Generierte Events:</b>
- <ul>
- <li>temperature: Die aktuelle Temperatur</li>
- <li>humidity: Die aktuelle Luftfeutigkeit (falls verfügbar)</li>
- <li>battery: Der Batteriestatus: low oder ok (falls verfügbar)</li>
- <li>channel: Kanalnummer (falls verfügbar)</li>
- <li>trend: Der Temperaturtrend (falls verfügbar)</li>
- <li>israining: Aussage Regen zwichen zwei Messungen (falls verfügbar)</li>
- <li>rain: Der Regenwert, eine fortlaufende Zahl bis zum Batteriewechsel (falls verfügbar)</li>
- </ul>
- <br>
- <b>Attribute</b>
- <ul>
- <li><a href="#IODev">IODev</a>
- Spezifiziert das physische Gerät, das die Ausstrahlung der Befehle für das
- "logische" Gerät ausführt. Ein Beispiel für ein physisches Gerät ist ein CUL.<br>
- </li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#model">model</a> (ABS700, AURIOL, GT_WT_02, KW9010, NC_WS, PFR-130, Prologue, Rubicson, TCM21...., TCM97…, Unknown, W174)</li>
- <li>max-deviation-temp: (Default:1, erlaubte Werte: 1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50)<br>
- Maximal erlaubte Abweichung der gemessenen Temperatur zum vorhergehenden Wert in Kelvin.<br></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- </ul>
- <p><a name="CUL_TX"></a>
- <h3>CUL_TX</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CUL_TX'>CUL_TX</a><br/>
- </ul>
- <a name="CUL_WS"></a>
- <h3>CUL_WS</h3>
- <div class='langLinks'>[<a href='commandref.html#CUL_WS'>EN</a> DE]</div>
- <ul>
- Das CUL_WS-Modul entschlüsselt die Nachrichten des Types S300, die von
- dem CUL empfangen wurden.
- <br><br>
- <a name="CUL_WSdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> CUL_WS <code> [corr1...corr4]</code> <br>
- <br>
- <code> ist der Code, der an dem S300 eingestellt werden muss.
- Gültige Werte sind 1 bis 8
- <br>
- corr1..corr4 entsprechen vier möglichen Korrekturwerten, die den
- jeweiligen Werten hinzuaddiert werden, um die Geräte zu kalibrieren.
- Hinweis: Bei den Werten für Regenmengen werden die Korrekturwerte
- nicht hinzuaddiert, sondern als Faktor mit dem Regenwert multipliziert.
- </ul>
- <br>
- <a name="CUL_WSset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="CUL_WSget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="CUL_WSattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#IODev">IODev (!)</a>
- Achtung: mit diesem Attribut ist es möglich mehrere 8-er Sets an
- S300-er in FHEM zu definieren. Wichtige Voraussetzung allerdings ist,
- dass nur das spezifizierte CUL das S300 empfangen kann, z.Bsp. durch
- Frequenztrennung (433MHz vs. 868MHz).
- </li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#model">model</a> (S300,KS300,ASH2200)</li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="CULflash"></a>
- <h3>CULflash</h3>
- <div class='langLinks'>[<a href='commandref.html#CULflash'>EN</a> DE]</div>
- <ul>
- <code>CULflash [fhem-device|none]; <TYPE></code> <br>
- <br>
- Lädt die spezifizierte Firmware von fhem.de und programmiert das
- angeschlossene Gerät.
- Z.Zt unterstützt wird das CUL und folgende Versionen:
- CUL_V2, CUL_V2_HM, CUL_V3, CUL_V3_ZWAVE, CUL_V4.<br>
- Falls als fhem-device none angegeben wurde, dann muss sich das
- angeschlossene Gerät bereits in flash-mode befinden.<br>
- <b>Achtung:</b>Für CUL flashen muss dfu-programmer installiert und im
- Pfad auffindbar sein, das ist der Fall bei dem Fritz!BOX 7390 Paket von
- fhem.de<br>
- Beispiele:
- <ul>
- <code>CULflash CUL CUL_V3<br>
- CULflash none CUL_V3</code>
- </ul>
- Achtung: die Meldung "dfu-programmer: failed to release interface 0." ist
- auf der FB7390 "normal".
- </ul>
- <p><a name="Calendar"></a>
- <h3>Calendar</h3>
- <div class='langLinks'>[<a href='commandref.html#Calendar'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="Calendardefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Calendar ical url <URL> [<interval>]</code><br>
- <code>define <name> Calendar ical file <FILENAME> [<interval>]</code><br>
- <br>
- Definiert ein Kalender-Device.<br><br>
- Ein Kalender-Device ermittelt (Serien-) Termine aus einem Quell-Kalender. Dieser kann eine URL oder eine Datei sein.
- Die Datei muss im iCal-Format vorliegen.<br><br>
- Beginnt die URL mit <code>https://</code>, muss das Perl-Modul IO::Socket::SSL installiert sein
- (use <code>cpan -i IO::Socket::SSL</code>).<br><br>
- Hinweis für Nutzer des Google-Kalenders: Du kann direkt die private iCal-URL des Google Kalender nutzen.
- Sollte Deine Google-Kalender-URL mit <code>https://</code> beginnen und das Perl-Modul IO::Socket::SSL ist nicht auf Deinem Systeme installiert,
- kannst Du in der URL <code>https://</code> durch <code>http://</code> ersetzen, falls keine automatische Umleitung auf die <code>https://</code> URL erfolgt.
- Solltest Du unsicher sein, ob dies der Fall ist, überprüfe es bitte zuerst mit Deinem Browser.<br><br>
- Der optionale Parameter <code>interval</code> bestimmt die Zeit in Sekunden zwischen den Updates. Default-Wert ist 3600 (1 Stunde).<br><br>
- Beispiele:
- <pre>
- define MeinKalender Calendar ical url https://www.google.com­/calendar/ical/john.doe%40example.com­/private-foo4711/basic.ics
- define DeinKalender Calendar ical url http://www.google.com­/calendar/ical/jane.doe%40example.com­/private-bar0815/basic.ics 86400
- define IrgendeinKalender Calendar ical file /home/johndoe/calendar.ics
- </pre>
- </ul>
- <br>
- <a name="Calendarset"></a>
- <b>Set </b><br><br>
- <ul>
- <code>set <name> update</code><br>
- Erzwingt das Einlesen des Kalenders von der definierten URL. Das nächste automatische Einlesen erfolgt in
- <code>interval</code> Sekunden später.<br><br>
- <code>set <name> reload</code><br>
- Dasselbe wie <code>update</code>, jedoch werden zuerst alle Termine entfernt.<br><br>
- </ul>
- <br>
- <a name="Calendarget"></a>
- <b>Get</b><br><br>
- <ul>
- <code>get <name> update</code><br>
- Entspricht <code>set <name> update</code><br><br>
- <code>get <name> reload</code><br>
- Entspricht <code>set <name> reload</code><br><br>
- <code>get <name> <format> <filter> [<max>]</code><br>
- Die Termine für den Kalender <name> werden Zeile für Zeile ausgegeben.<br><br>
- Folgende Selektoren/Filter stehen zur Verfügung:<br><br>
- Der Selektor <format> legt den zurückgegeben Inhalt fest:<br><br>
- <table>
- <tr><th><format></th><th>Inhalt</th></tr>
- <tr><td>uid</td><td>UID des Termins</td></tr>
- <tr><td>text</td><td>Benutzer-/Monitorfreundliche Textausgabe.</td></tr>
- <tr><td>summary</td><td>Übersicht (Betreff, Titel)</td></tr>
- <tr><td>location</td><td>Ort</td></tr>
- <tr><td>categories</td><td>Kategorien</td></tr>
- <tr><td>alarm</td><td>Alarmzeit</td></tr>
- <tr><td>start</td><td>Startzeit</td></tr>
- <tr><td>end</td><td>Endezeit</td></tr>
- <tr><td>full</td><td>Vollständiger Status</td></tr>
- <tr><td>debug</td><td>wie <full> mit zusätzlichen Informationen zur Fehlersuche</td></tr>
- </table><br>
- Der Filter <filter> grenzt die Termine ein:<br><br>
- <table>
- <tr><th><filter></th><th>Inhalt</th></tr>
- <tr><td>mode=<regex></td><td>alle Termine, deren Modus durch den regulären Ausdruck <regex> beschrieben werden.</td></tr>
- <tr><td><mode></td><td>alle Termine mit Modus <mode>.</td></tr>
- <tr><td>uid=<regex></td><td>Alle Termine, deren UIDs durch den regulären Ausdruck <regex> beschrieben werden.</td></tr>
- <tr><td><uid></td><td>Alle Termine mit der UID <uid></td></tr>
- <tr><td><reading></td><td>Alle Termine die im Reading <reading> aufgelistet werden (modeAlarm, modeAlarmed, modeStart, etc.)
- - dieser Filter ist abgekündigt und steht in einer zukünftigen Version nicht mehr zur Verfügung, bitte mode=<regex> benutzen.</td></tr>
- <tr><td>all</td><td>Alle Termine (vergangene, aktuelle und zukünftige)</td></tr>
- <tr><td>next</td><td>Alle Termine, die noch nicht beendet sind. Bei Serienterminen der erste Termin. Benutzer-/Monitorfreundliche Textausgabe</td></tr>
- </table><br>
- Die Filter <code>mode=<regex></code> und <code>uid=<regex></code> sollten den Filtern
- <code><mode></code> und <code><uid></code> vorgezogen werden.<br><br>
- Der optionale Parameter <code><max></code> schränkt die Anzahl der zurückgegebenen Zeilen ein.<br><br>
- Bitte beachte die Attribute <code>hideOlderThan</code> und
- <code>hideLaterThan</code> für die Seletion von Terminen in einem bestimmten Zeitfenster.
- Bitte berücksichtige, dass das globale ±400 Tageslimit gilt .<br><br>
- Beispiele:<br>
- <code>get MyCalendar text next</code><br>
- <code>get MyCalendar summary uid:435kjhk435googlecom 1</code><br>
- <code>get MyCalendar summary 435kjhk435googlecom 1</code><br>
- <code>get MyCalendar full all</code><br>
- <code>get MyCalendar text mode=alarm|start</code><br>
- <code>get MyCalendar text uid=.*6286.*</code><br>
- <br>
- <code>get <name> find <regexp></code><br>
- Gibt Zeile für Zeile die UIDs aller Termine deren Zusammenfassungen durch den regulären Ausdruck <regex> beschrieben werden.
- <regexp>.<br><br>
- <code>get <name> vcalendar</code><br>
- Gibt den Kalender ICal-Format, so wie er von der Quelle gelesen wurde, zurück.<br><br>
- <code>get <name> vevents</code><br>
- Gibt eine Liste aller VEVENT-Einträge des Kalenders <name>, angereichert um Ausgaben für die Fehlersuche, zurück.
- Es werden nur Eigenschaften angezeigt, die während der Programmausführung beibehalten wurden. Es wird sowohl die Liste
- der Termine, die von jedem VEVENT-Eintrag erzeugt wurden, als auch die Liste der ausgelassenen Termine angezeigt.
- </ul>
- <br>
- <a name="Calendarattr"></a>
- <b>Attributes</b>
- <br><br>
- <ul>
- <li><code>update sync|async|none</code><br>
- Wenn dieses Attribut nicht gesetzt ist oder wenn es auf <code>sync</code> gesetzt ist,
- findet die Verarbeitung des Kalenders im Vordergrund statt. Große Kalender werden FHEM
- auf langsamen Systemen blockieren. Wenn das Attribut auf <code>async</code> gesetzt ist,
- findet die Verarbeitung im Hintergrund statt, und FHEM wird während der Verarbeitung
- nicht blockieren. Wenn dieses Attribut auf <code>none</code> gesetzt ist, wird der
- Kalender überhaupt nicht aktualisiert.
- </li><p>
- <li><code>removevcalendar 0|1</code><br>
- Wenn dieses Attribut auf 1 gesetzt ist, wird der vCalendar nach der Verarbeitung verworfen,
- gleichzeitig reduziert sich der Speicherverbrauch des Moduls.
- Ein Abruf über <code>get <name> vcalendar</code> ist dann nicht mehr möglich.
- </li><p>
- <li><code>hideOlderThan <timespec></code><br>
- <code>hideLaterThan <timespec></code><br><p>
- Dieses Attribut grenzt die Liste der durch <code>get <name> full|debug|text|summary|location|alarm|start|end ...</code> gezeigten Termine ein.
- Die Zeit wird relativ zur aktuellen Zeit t angegeben.<br>
- Wenn <hideOlderThan> gesetzt ist, werden Termine, die vor <t-hideOlderThan> enden, ingnoriert.<br>
- Wenn <hideLaterThan> gesetzt ist, werden Termine, die nach <t+hideLaterThan> anfangen, ignoriert.<p>
- Bitte beachten, dass eine Aktion, die durch einen Wechsel in den Modus "end" ausgelöst wird, nicht auf den Termin
- zugreifen kann, wenn hideOlderThan 0 ist, weil der Termin dann schon versteckt ist. Besser hideOlderThan auf 10 setzen.<p>
- <code><timespec></code> muss einem der folgenden Formate entsprechen:<br>
- <table>
- <tr><th>Format</th><th>Beschreibung</th><th>Beispiel</th></tr>
- <tr><td>SSS</td><td>Sekunden</td><td>3600</td></tr>
- <tr><td>SSSs</td><td>Sekunden</td><td>3600s</td></tr>
- <tr><td>HH:MM</td><td>Stunden:Minuten</td><td>02:30</td></tr>
- <tr><td>HH:MM:SS</td><td>Stunden:Minuten:Sekunden</td><td>00:01:30</td></tr>
- <tr><td>D:HH:MM:SS</td><td>Tage:Stunden:Minuten:Sekunden</td><td>122:10:00:00</td></tr>
- <tr><td>DDDd</td><td>Tage</td><td>100d</td></tr>
- </table></li>
- <p>
- <li><code>cutoffOlderThan <timespec></code><br>
- Dieses Attribut schneidet alle nicht wiederkehrenden Termine weg, die eine Zeitspanne cutoffOlderThan
- vor der letzten Aktualisierung des Kalenders endeten. Der Zweck dieses Attributs ist es Speicher zu
- sparen. Auf solche Termine kann gar nicht mehr aus FHEM heraus zugegriffen werden. Serientermine und
- Termine ohne Endezeitpunkt (DTEND) werden nicht weggeschnitten.
- </li><p>
- <li><code>onCreateEvent <perl-code></code><br>
- Dieses Attribut führt ein Perlprogramm <perl-code> für jeden erzeugten Termin aus.
- Weitere Informationen unter <a href="#CalendarPlugIns">Plug-ins</a> im Text.
- </li><p>
- <li><code>SSLVerify</code><br>
- Dieses Attribut setzt die Art der Überprüfung des Zertifikats des Partners
- bei mit SSL gesicherten Verbindungen. Entweder auf 0 setzen für
- SSL_VERIFY_NONE (keine Überprüfung des Zertifikats) oder auf 1 für
- SSL_VERIFY_PEER (Überprüfung des Zertifikats). Die Überprüfung auszuschalten
- ist nützlich für lokale Kalenderinstallationen(e.g. OwnCloud, NextCloud)
- ohne gütiges SSL-Zertifikat.
- </li><p>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <b>Beschreibung</b>
- <ul><br>
- Ein Kalender ist eine Menge von Terminen. Ein Termin hat eine Zusammenfassung (normalerweise der Titel, welcher im Quell-Kalender angezeigt wird), eine Startzeit, eine Endzeit und keine, eine oder mehrere Alarmzeiten. Die Termine werden
- aus dem Quellkalender ermittelt, welcher über die URL angegeben wird. Sollten mehrere Alarmzeiten für einen Termin existieren, wird nur der früheste Alarmzeitpunkt beibehalten. Wiederkehrende Kalendereinträge werden in einem gewissen Umfang unterstützt:
- FREQ INTERVAL UNTIL COUNT werden ausgewertet, BYMONTHDAY BYMONTH WKST
- werden erkannt aber nicht ausgewertet. BYDAY wird für wöchentliche und monatliche Termine
- korrekt behandelt. Das Modul wird es sehr wahrscheinlich falsch machen, wenn Du wiederkehrende Termine mit unerkannten oder nicht ausgewerteten Schlüsselwörtern hast.<p>
- Termine werden erzeugt, wenn FHEM gestartet wird oder der betreffende Eintrag im Quell-Kalender verändert
- wurde oder der Kalender mit <code>get <name> reload</code> neu geladen wird. Es werden nur Termine
- innerhalb ±400 Tage um die Erzeugungs des Termins herum erzeugt. Ziehe in Betracht, den Kalender von Zeit zu Zeit
- neu zu laden, um zu vermeiden, dass die künftigen Termine ausgehen. Du kann so etwas wie <code>define reloadCalendar at +*240:00:00 set MyCalendar reload</code> dafür verwenden.<p>
- Manche dummen Kalender benutzen LAST-MODIFIED nicht. Das kann dazu führen, dass Veränderungen im
- Quell-Kalender unbemerkt bleiben. Lade den Kalender neu, wenn Du dieses Problem hast.<p>
- Ein Termin wird durch seine UID identifiziert. Die UID wird vom Quellkalender bezogen. Um das Leben leichter zu machen, werden alle nicht-alphanumerischen Zeichen automatisch aus der UID entfernt.<p>
- Ein Termin kann sich in einem der folgenden Modi befinden:
- <table>
- <tr><td>upcoming</td><td>Weder die Alarmzeit noch die Startzeit des Kalendereintrags ist erreicht.</td></tr>
- <tr><td>alarm</td><td>Die Alarmzeit ist überschritten, aber die Startzeit des Kalender-Ereignisses ist noch nicht erreicht.</td></tr>
- <tr><td>start</td><td>Die Startzeit ist überschritten, aber die Ende-Zeit des Kalender-Ereignisses ist noch nicht erreicht.</td></tr>
- <tr><td>end</td><td>Die Ende-Zeit des Kalender-Ereignisses wurde überschritten.</td></tr>
- </table><br>
- Ein Kalender-Ereignis wechselt umgehend von einem Modus zum Anderen, wenn die Zeit für eine Änderung erreicht wurde. Dies wird dadurch erreicht, dass auf die früheste zukünftige Zeit aller Alarme, Start- oder Endezeiten aller Kalender-Ereignisse gewartet wird.
- <p>
- Ein Kalender-Device hat verschiedene Readings. Mit Ausnahme von <code>calname</code> stellt jedes Reading eine Semikolon-getrennte Liste von UIDs von Kalender-Ereignisse dar, welche bestimmte Zustände haben:
- <table>
- <tr><td>calname</td><td>Name des Kalenders</td></tr>
- <tr><td>modeAlarm</td><td>Ereignisse im Alarm-Modus</td></tr>
- <tr><td>modeAlarmOrStart</td><td>Ereignisse im Alarm- oder Startmodus</td></tr>
- <tr><td>modeAlarmed</td><td>Ereignisse, welche gerade in den Alarmmodus gewechselt haben</td></tr>
- <tr><td>modeChanged</td><td>Ereignisse, welche gerade in irgendeiner Form ihren Modus gewechselt haben</td></tr>
- <tr><td>modeEnd</td><td>Ereignisse im Endemodus</td></tr>
- <tr><td>modeEnded</td><td>Ereignisse, welche gerade vom Start- in den Endemodus gewechselt haben</td></tr>
- <tr><td>modeStart</td><td>Ereignisse im Startmodus</td></tr>
- <tr><td>modeStarted</td><td>Ereignisse, welche gerade in den Startmodus gewechselt haben</td></tr>
- <tr><td>modeUpcoming</td><td>Ereignisse im zukünftigen Modus</td></tr>
- </table>
- <p>
- Für Serientermine werden mehrere Termine mit der selben UID erzeugt. In diesem Fall
- wird die UID nur im interessantesten gelesenen Modus-Reading angezeigt.
- Der interessanteste Modus ist der erste zutreffende Modus aus der Liste der Modi start, alarm, upcoming, end.<p>
- Die UID eines Serientermins wird nicht angezeigt, solange sich der Termin im Modus: modeEnd oder modeEnded befindet
- und die Serie nicht beendet ist. Die UID befindet sich in einem der anderen mode... Readings.
- Hieraus ergibts sich, das FHEM-Events nicht auf einem mode... Reading basieren sollten.
- Weiter unten im Text gibt es hierzu eine Empfehlung.<p>
- </ul>
- <b>Events</b>
- <ul><br>
- Wenn der Kalendar neu geladen oder aktualisiert oder eine Alarm-, Start- oder Endezeit
- erreicht wurde, wird ein FHEM-Event erzeugt:<p>
- <code>triggered</code><br><br>
- Man kann sich darauf verlassen, dass alle Readings des Kalenders in einem konsistenten und aktuellen
- Zustand befinden, wenn dieses Event empfangen wird.<p>
- Wenn ein Termin geändert wurde, werden zwei FHEM-Events erzeugt:<p>
- <code>changed: UID <mode></code><br>
- <code><mode>: UID</code><br><br>
- <mode> ist der aktuelle Modus des Termins nach der änderung. Bitte beachten: Im FHEM-Event befindet sich ein Doppelpunkt gefolgt von einem Leerzeichen.<p>
- FHEM-Events sollten nur auf den vorgenannten Events basieren und nicht auf FHEM-Events, die durch ändern eines mode... Readings ausgelöst werden.
- <p>
- </ul>
- <a name="CalendarPlugIns"></a>
- <b>Plug-ins</b>
- <ul>
- <br>
- Experimentell, bitte mit Vorsicht nutzen.<p>
- Ein Plug-In ist ein kleines Perl-Programm, dass Termine nebenher verändern kann.
- Das Perl-Programm arbeitet mit der Hash-Referenz <code>$e</code>.<br>
- Die wichtigsten Elemente sind:
- <table>
- <tr><th>code</th><th>description</th></tr>
- <tr><td>$e->{start}</td><td>Startzeit des Termins, in Sekunden seit 1.1.1970</td></tr>
- <tr><td>$e->{end}</td><td>Endezeit des Termins, in Sekunden seit 1.1.1970</td></tr>
- <tr><td>$e->{alarm}</td><td>Alarmzeit des Termins, in Sekunden seit 1.1.1970</td></tr>
- <tr><td>$e->{summary}</td><td>die Zusammenfassung (Betreff, Titel) des Termins</td></tr>
- <tr><td>$e->{location}</td><td>Der Ort des Termins</td></tr>
- </table><br>
- Um für alle Termine mit dem Text "Tonne" in der Zusammenfassung die Alarmzeit zu ergänzen / zu ändern,
- kann folgendes Plug-In benutzt werden:<br><br>
- <code>attr MyCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 if($e->{summary} =~ /Tonne/);; }</code><br>
- <br>Das doppelte Semikolon maskiert das Semikolon. <a href="#perl">Perl specials</a> können nicht genutzt werden.<br>
- </ul>
- <br><br>
- <b>Anwendungsbeispiele</b>
- <ul><br>
- <i>Alle Termine inkl. Details anzeigen</i><br><br>
- <ul>
- <code>
- get MyCalendar full all<br>
- 2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom known alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee<br>
- 992hydf4y44awer5466lhfdsr­gl7tin6b6mckf8glmhui4­googlecom known upcoming 08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation
- </code><br><br>
- </ul>
- <i>Zeige Termine in Deinem Bilderrahmen</i><br><br>
- <ul>
- Füge eine Zeile in die <a href="#RSSlayout">layout description</a> ein, um Termine im Alarm- oder Startmodus anzuzeigen:<br><br>
- <code>text 20 60 { fhem("get MyCalendar text next 2") }</code><br><br>
- Dies kann dann z.B. so aussehen:<br><br>
- <code>
- 07.06.12 16:30 Erna zum Kaffee<br>
- 08.06.12 00:00 Urlaub
- </code><br><br>
- </ul>
- <i>Schalte das Licht ein, wenn Erna kommt</i><br><br>
- <ul>
- Finde zuerst die UID des Termins:<br><br>
- <code>
- get MyCalendar find .*Erna.*<br>
- 2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom
- </code><br><br>
- Definiere dann ein notify: (Der Punkt nach dem zweiten Doppelpunkt steht für ein Leerzeichen)<br><br>
- <code>
- define ErnaComes notify MyCalendar:start:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom.* set MyLight on
- </code><br><br>
- Du kannst auch ein Logging aufsetzen:<br><br>
- <code>
- define LogErna notify MyCalendar:alarm:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom.* { Log3 $NAME, 1, "ALARM name=$NAME event=$EVENT part1=$EVTPART0 part2=$EVTPART1" }
- </code><br><br>
- </ul>
- <i>Schalte die Aktoren an und aus</i><br><br>
- <ul>
- Stell Dir einen Kalender vor, dessen Zusammenfassungen (Betreff, Titel) die Namen von Devices in Deiner fhem-Installation sind.
- Du willst nun die entsprechenden Devices an- und ausschalten, wenn das Kalender-Ereignis beginnt bzw. endet.<br><br>
- <code>
- define SwitchActorOn notify MyCalendar:start:.* {}<br>
- </code>
- Dann auf DEF klicken und im DEF-Editor folgendes zwischen die beiden geschweiften Klammern {} eingeben:
- <code>
- my $reading="$EVTPART0";
- my $uid= "$EVTPART1";
- my $actor= fhem("get MyCalendar summary $uid");
- if(defined $actor) {
- fhem("set $actor on")
- }
- <br><br>
- define SwitchActorOff notify MyCalendar:end:.* {}<br>
- </code>
- Dann auf DEF klicken und im DEF-Editor folgendes zwischen die beiden geschweiften Klammern {} eingeben:
- <code>
- my $reading="$EVTPART0";
- my $uid= "$EVTPART1";
- my $actor= fhem("get MyCalendar summary $uid");
- if(defined $actor) {
- fhem("set $actor off")
- }
- </code><br><br>
- Auch hier kann ein Logging aufgesetzt werden:<br><br>
- <code>
- define LogActors notify MyCalendar:(start|end).* {}<br>
- </code>
- Dann auf DEF klicken und im DEF-Editor folgendes zwischen die beiden geschweiften Klammern {} eingeben:
- <code>
- my $reading= "$EVTPART0";
- my $uid= "$EVTPART1";
- my $actor= fhem("get MyCalendar summary $uid");
- Log 3 $NAME, 1, "Actor: $actor, Reading $reading";
- </code><br><br>
- </ul>
- </ul>
- <b>Eingebettetes HTML</b>
- <ul><br>
- Das Modul stellt eine zusätzliche Funktion <code>CalendarAsHtml(<name>,<options>)</code> bereit.
- Diese gibt den HTML-Kode für eine Liste von Terminen zurück. <code><name></code> ist der Name des
- Kalendar-Device und <code><options></code> ist das, was Du hinter <code>get <name> text ...</code>
- schreiben würdest.
- <br><br>
- Beispiel: <code>define MyCalendarWeblink weblink htmlCode { CalendarAsHtml("MyCalendar","next 3") }</code>
- <br><br>
- Dies ist eine rudimentäre Funktion, die vielleicht in künftigen Versionen erweitert wird.
- <p>
- </ul>
- </ul>
- <p><a name="ComfoAir"></a>
- <h3>ComfoAir</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ComfoAir'>ComfoAir</a><br/>
- </ul>
- <a name="CustomReadings"></a>
- <h3>CustomReadings</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#CustomReadings'>CustomReadings</a><br/>
- </ul>
- <a name="DBPlan"></a>
- <h3>DBPlan</h3>
- <div class='langLinks'>[<a href='commandref.html#DBPlan'>EN</a> DE]</div>
- <ul>
- Das Modul holt von der Infoseite der DB <https://reiseauskunft.bahn.de/bin/query.exe/dox?S=departure&Z=destination&start=1&rt=1>
- aktuelle Informationen zu einer angegeben Verbindung und legt sie in Fhem readings ab.
- Die Datei mit den IBNR-Codes und Stationen der Deutschen Bahn kann unter http://www.michaeldittrich.de/ibnr abgerufen werden.
- <br><br>
- <b>Prerequisites</b>
- <ul>
- <br>
- <li>
- Dieses Modul verwendet die nicht blockierende HTTP-Funktion HttpUtils_NonblockingGet von FHEM's HttpUtils in der aktuellen Version.<br>
- Falls das Modul noch nicht in Ihrer Fhem-Umgebung vorhanden ist, aktualisieren Sie bitte FHEM über den Update Befehl.<br>
- </li>
-
- </ul>
- <br>
- Der device status (DevState):
- <ul>
- <li><b>initialized</b></li>
- Das Device ist definiert, aber es wurde keine erfolgreichen Anfragen und Analysen durchgeführt<br>
- Dieser Zustand wird auch beim Wechsel von <inactive> auf <active> und <disabled> auf <enabled> gesetzt<br>
- <li><b>active</b></li>
- Das Device arbeitet<br>
- <li><b>stopped</b></li>
- Der Device Time wurde angehalten. Ein reread ist jedoch möglich<br>
- <li><b>disabled</b></li>
- Das Device wurde deaktiviert.<br>
- </ul>
- <br>
- <a name="DBPlandefine"></a>
- <b>Define</b>
- <ul>
- <br>
- <code>define <name> DBPlan <Refresh interval in seconds [time offset in minutes]></code>
- <br><br>
- Das Modul holt nach angegebenen "Intervall"-Sekunden über die DB URL die Fahrpläne. Ist time_offset definiert werden
- die Fahrpläne für die aktuelle Zeit plus Offset in Minuten gelesen.<br>
- <br>
- Example:<br>
- <br>
- <ul><code>define DBPlan_Test DBPlan 60</code></ul>
- </ul>
- <br>
- <a name="DBPlanconfiguration"></a>
- <b>Konfiguration von DBPlan</b><br><br>
- <ul>
- Beispiel für eine Fahrplanabfrage:<br><br>
- <ul><code>
- attr DB_Test dbplan_station Köln-Weiden West
- attr DB_Test dbplan_destination Köln HBF
- attr DB_Test room OPNV
- </code></ul>
- </ul>
- <br>
- <a name="DBPlanset"></a>
- <b>Set-Commands</b><br>
- <ul>
- <li><b>interval</b></li>
- setzen einer anderen Intervallzeit für das Holen und Parsen der DB Informationen<br>
- <li><b>timeOffset</b></li>
- Start der Suche: aktuelle Zeit plus time_offset.<br>
- <li><b>reread</b></li>
- Holen und Parsen der DB Informationen. Nur aktiv, wenn kein Status: disabled<br>
- <li><b>stop</b></li>
- Stoppt den Timer. Nur aktiv, wenn Status: active<br>
- <li><b>start</b></li>
- Neustart des Timers. Nur aktiv, wenn Status: stopped<br>
- </ul>
- <br>
- <a name="DBPlanget"></a>
- <b>Get-Commands</b><br>
- <ul>
- <li><b>PlainText</b></li>
- Die ermittelten Informationen werden als "plain Text" ausgegeben<br>
- <li><b>searchStation</b></li>
- suche in der Bahnhofstabelle. Wird kein Suchbegriff eingegen, werden alle Bahnhöfe angezeigt.<br>
- </ul>
- <br>
- <a name="DBPlanattr"></a>
- <b>Attributes</b><br><br>
- <ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <br>
- <li><b>dbplan_station</b></li>
- Abfahrtsbahnhof / Haltestelle<br>
- <li><b>dbplan_destination </b></li>
- Ankunftsbahnhof / Haltestelle<br>
- <li><b>dbplan_via_1 </b></li>
- 1. Zwischenhalt in Bahnhof / Haltestelle<br>
- <li><b>dbplan_via_2 </b></li>
- 2. Zwischenhalt in Bahnhof / Haltestelle<br>
- <li><b>dbplan_journey_prod </b></li>
- Verkehrsmittel, wie z.B.: ICE, Bus, Straßenbahn<br>
- <li><b>dbplan_journey_opt </b></li>
- Reiseoptionen wie z.B.: direct connection<br>
- <li><b>dbplan_tariff_class </b></li>
- 1. oder 2. Klasse<br>
- <li><b>dbplan_board_type </b></li>
- Fahrplansuche bzw. Bahnhofsanzeige für Abfahrts- oder Ankunftszeit (depart / arrive).<br>
- <li><b>dbplan_delayed_Journey </b></li>
- Bei off werden nur pünktliche Verbindungen angezeigt.<br>
- <li><b>dbplan_max_Journeys </b></li>
- Anzahl der angezeigten Zugverbindungen in der Bahnhofsansicht.<br>
- <li><b>dbplan_reg_train </b></li>
- die Zugbezeichnung, z.B. S für alles was S- und Straßenbahnen angeht, ICE alle ICE oder ICE mit Zugnummer. Usw.<br>
- <li><b>dbplan_travel_date </b></li>
- Reisedatum in der Angabe: dd.mm.yy<br>
- <li><b>dbplan_travel_time </b></li>
- Abfahtrtszeit in der Angabe: hh.mm<br>
- <li><b>dbplan_addon_options </b></li>
- weitere Optionen, wie sie im API-Dokument der DB beschrieben sind.<br>
- <br>
- <li><b>Steuernde Attribute:</b></li>
- <li><b>dbplan-disable </b></li>
- Device aktivieren / deaktivieren (s. auch FHEM-Doku)<br>
- <li><b>dbplan-reading-deselect </b></li>
- delsektieren von Readings<br>
- <li><b>dbplan-default-char </b></li>
- Hinweis, der angezeigt wird, wenn keine Information für ein reading zur Verfügung steht.<br>
- - "none" ist der Standardhinweis.<br>
- Sofern folgende spezielle Einträge gemacht werden:
- - "delete" nicht genutzte readings werden auch nicht angezeigt.<br>
- - "nochar" das Reading wird mit leerem Inhalt angezeigt.<br>
- <li><b>dbplan-tabel-headers </b></li>
- internes Attribut um die Spaltenbezeichnungen für HTML::TableExtract<br>
- <li><b>dbplan-station-file </b></li>
- Pfad zur Bahnhofstabelle der Deutschen Bahn (evtl. nicht vollständig). Für Für andere Verkehrsunternehmen liegen keine Tabellen vor.<br>
- Diese Tabelle ist als Hilfe für die Suche nach Bahnhöfen anzusehen und hat keine weitere Funktion im Modul.<br>
- <li><b>dbplan-base-type </b></li>
- Anzeige als Bahnhofstabelle (table) oder Verbindungsinformation (plan)<br>
- <br>
- <li><b>HTTPMOD Attribute, siehe entsprechende Doku</b></li>
- <li><b>dbplan-remote-timeout</b></li>
- <li><b>dbplan-remote-noshutdown</b></li>
- <li><b>dbplan-remote-loglevel</b></li>
- <li><b>dbplan-remote-buf</b></li>
- </ul>
- <br>
- <a name="DBPlanReadings"></a>
- <b>Readings</b><br><br>
- <ul>
- <li><a href="#internalReadings">internalReadings</a></li>
- <br>
- <li><b>plan_departure_(1..3) </b></li>
- Abfahrtszeit<br>
- <li><b>plan_arrival_(1..3) </b></li>
- Ankunftszeit<br>
- <li><b>plan_connection_(1..3) </b></li>
- Verbindungstyp<br>
- <li><b>plan_departure_delay_(1..3) </b></li>
- Verspätung in der Abfahrtszeit<br>
- <li><b>plan_arrival_delay_(1..3) </b></li>
- Verspätung in der Ankunftszeit<br>
- <li><b>plan_travel_duration_(1..3) </b></li>
- Reisezeit<br>
- <li><b>plan_travel_change_(1..3) </b></li>
- Anzahl der Umstiege<br>
- <br>
- <li><b>travel_note_(1..3) </b></li>
- Hinweise für die Verbindung<br>
- <li><b>travel_note_link_(1..3) </b></li>
- Link zu den weiteren Verbindungsinformationen<br>
- <li><b>travel_note_text_(1..3) </b></li>
- Verbindungshinweis<br>
- <li><b>travel_note_error_(1..3) </b></li>
- Fehlertext der Detailinformation<br>
- <br>
- <li><b>travel_departure_(1..3) </b></li>
- Informationen über den Abfahtsbahnhof und das Ankunftsgleis<br>
- <li><b>travel_destination_(1..3) </b></li>
- Informationen über den Zielbahnhof und das Ankunftsgleis<br>
- <li><b>travel_price_(1..3) </b></li>
- Fahrpreis<br>
- </ul>
- </ul>
- <p><a name="DFPlayerMini"></a>
- <h3>DFPlayerMini - FN-M16P Embedded MP3 Audio Module</h3>
- <div class='langLinks'>[<a href='commandref.html#DFPlayerMini'>EN</a> DE]</div>
- Dieses Modul integriert den <a href="http://www.flyrontech.com/eproducts/84.html">DFPlayerMini - FN-M16P Embedded MP3 Audio Modul</a> in fhem.
- Siehe auch das <a href="http://www.flyrontech.com/edownload/6.html">Datenblatt</a> des Moduls für technische Details.
- <br>
- Der MP3-Spieler kann direkt mit einer seriellen Schnittstelle verbunden werden oder per Ethernet/WiFi mittels einer Hardware die eine transparente
- serielle Übertragung per TCP/IP zur Verfügung stellt, z. B. <a href="http://www.letscontrolit.com/wiki/index.php/Ser2Net">ESPEasy Ser2Net</a>.
- <br><br>
- Es ist auch möglich ein anderes fhem Device für den Datentransport zu nutzen, z. B. <a href="#MYSENSORS">MYSENSORS</a>.
- <br><br>
- Das Modul unterstützt alle Kommandos des DFPlayers und bietet weitere Funktionen wie
- <ul>
- <li>Integration von <a href="#Text2Speech">Text2Speech</a> um einfach Sprach-MP3-Dateien herunterzuladen</li>
- <li>einfachere Kontrolle darüber welche Dateien abgespielt werden sollen</li>
- <li>Verwaltung aller Dateien die der DFPlayer abspielen kann</li>
- <li>Abspielen mehrerer Dateien hintereinander (playlist)</li>
- <li>Erzeugung und Abspielen von Sprachschnipseln um beliebige Zahlen per Sprache auszugeben</li>
- </ul>
- <br>
- <a name="DFPlayerMinidefine"></a>
- <b>Define</b><br>
- <code>define <name> DFPlayerMini {none | devicename[\@baudrate] | devicename\@directio | hostname:port} </code>
- <br>
- <ul>
- <li>
- Wenn der Player direkt angeschlossen ist wird per <devicename> der Name der seriellen Schnittstelle angegeben
- an die der DFPlayer Mini angeschlossen ist.
- Der Name der seriellen Schnittstelle hängt von der Betriebssystemdistribution ab, unter Linux ist
- das cdc_acm kernel Modul verantwortlich, und normalerweise wird ein
- /dev/ttyACM0 oder /dev/ttyUSB0 Device angelegt.
- Man kann auch eine Baudrate angeben in dem dem im Devicenamen nach dem @ Zeichen die Baudrate angegeben wird, z. B.
- /dev/ttyACM0@9600<br><br>Das ist auch die standard Baudrate und sollte normalerweise nicht geändert werden da diese Baudrate beim
- DFPlayer fest eingestellt ist.
- Wenn als Baudrate "directio" angegeben wird (z. B.: /dev/ttyACM0@directio) dann wird das
- perl Modul Device::SerialPort nicht benötigt und fhem öffnet das Device
- mit simple file io. Das kann funktionieren wenn das Betriebssystem sinnvolle Voreinstellungen für die Parameter der
- seriellen Schnittstelle verwendet, z. B. einige Linux Distributionen und OSX.<br>
- </li>
- <li>
- Wenn die Verbindung über TCP/IP statt findet spezifiziert <hostname:port> die IP Adresse und den Port des Device das
- die transparente serielle Verbindung zum DFP bereit stellt, e.g. 192.168.2.28:23
- </li>
- <li>
- Für andere Arten des Datentransports kann <code>none</code> als Device angegeben werden.
- In diesem Fall sollte das Attribute <code>sendCmd</code> angegeben werden. Antworten vom DFPlayer sollten per <code>set response</code>
- zurück an dieses Module übergeben werden.
- </li>
- </ul>
- <br>
- <a name="DFPlayerMiniattr"></a>
- <b>Attribute</b>
- <ul>
- <li>TTSDev<br>
- Der Name eines Text2Speech Devices. Dieses muss bereits vorher mit none als <alsadevice> als Server Device angelegt worden sein. Es sollte ausschließlich
- für dieses Modul zur Verfügung stehen und nicht für andere Zwecke verwendet werden.
- </li>
- <li>requestAck<br>
- Der DFPlayer kann fü jedes Kommando eine Bestätigung senden. Da das zu erhöhter Kommunikation führt kann es über dieses
- Attribut abgeschaltet werden. Wenn es eingeschaltet ist wird das nächste Kommando erst dann zum DFPlayer wenn das vorherige bestätigt wurde.
- Das stellt sicher, dass kein Kommando verloren geht selbst wenn der DFPlayer ausgelastet oder im Schlafzustand ist.
- </li>
- <li>sendCmd<br>
- Ein fhem Kommando das verwendet wird um ein durch diese Modul erzeugtes DFPlayer Kommando an die DFPlayer Hardware zu senden.
- Wenn dieses Attribut gesetzt ist wird kein andere Art der Kommunikation mit dem DFPlayer verwendet.
- Es kann verwendet werden um andere fhem Devices für den Datentransport zu nutzen.<br>
- Um z. B. mittels eines MySensor Devices mit dem Namen mys_dfp zu kommunizieren kann <br>
- <code>
- attr <dfp> sendCmd set mys_dfp value11 $msg
- </code><br>
- verwendet werden. Auf dem MySensors Devices muss eine passende Firmware installiert sein.<br>
- Dieses Modul wird dann ein Kommando an den DFP senden in dem $msg mit dem tatsächlichen Kommando <payload> ersetzt wird und dann das fhem Kommando
- <code>
- set mys_dfp value11 <payload>
- </code>
- <br>
- ausgeführt wird.
- Siehe <code>set response</code> für einen Weg um die Antwort des DFPlayers zurück an dieses Modul zu senden.
- </li>
- <li>uploadPath<br>
- Der DFPlayer spielt Dateien von einer an ihn angeschlossenen SD-Karte oder USB-Stick ab. Die mp3/wav Dateien müssen vom Anwender auf dieses Speichermedium
- kopiert werden.
- Der Player erwartet die Dateien mit speziellen Namen und in spezifischen Verzeichnissen, im Datenblatt stehen die Einzelheiten.
- Das Kopieren der Dateien kann auch von diesem Modul durchgeführt werden. Dazu muss das Speichermedium mit dem Rechner verbunden sein auf dem
- fhem ausgeführt wird. Es muss dazu in dem Pfad gemounted sein der durch diese Attribut angegeben ist.
- <br>
- Siehe auch uploadTTS, uploadTTScache und readFiles Kommandos wo es verwendet wird.
- </li>
- <li>rememberMissingTTS<br>
- Wenn gesetzt erzeugen <code>tts</code> Kommandos ohne eine passende Datei ein spezielles Reading. Siehe <code>set tts</code> und <code>set uploadTTScache</code>.
- </li>
- <li>keepAliveInterval<br>
- Gibt das Intervall in Sekunden zwischen KeepAlive Kommandos an den DFP an. Das kann verwendet werden um automatisch zu prüfen, ob der DFP noch
- funktioniert und erreichbar ist.<br>
- Nach drei fehlenden Antwortden wird der Status auf disconnected gesetzt.<br>
- Interval 0 schaltet die Funktion ab, die Voreinstellung ist 60 Sekunden.
- </li>
- </ul>
- <a name="DFPlayerMiniget"></a>
- <br>
- <b>Get</b>
- <br><br>
- Alle Abfrage Kommandos die vom DFP unterstützt werden haben ein zugehöriges get Kommando:
- <table>
- <tr><th>get</th><th>DFP cmd byte</th><th>Parameter</th><th>Kommentar</th></tr>
- <tr><td>storage</td><td>0x3F</td><td></td><td></td></tr>
- <tr><td>status</td><td>0x42</td><td></td><td></td></tr>
- <tr><td>volume</td><td>0x43</td><td></td><td></td></tr>
- <tr><td>equalizer</td><td>0x44</td><td></td><td></td></tr>
- <tr><td>noTracksRootUsb</td><td>0x47</td><td></td><td></td></tr>
- <tr><td>noTracksRootSd</td><td>0x48</td><td></td><td></td></tr>
- <tr><td>currentTrackUsb</td><td>0x4B</td><td></td><td></td></tr>
- <tr><td>currentTrackSd</td><td>0x4C</td><td></td><td></td></tr>
- <tr><td>noTracksInFolder</td><td>0x4E</td><td>Verzeichnisnummer</td><td>1-99</td></tr>
- <tr><td>noFolders</td><td>0x4F</td><td></td><td></td></tr>
- </table>
- <a name="DFPlayer Miniset"></a>
- <br>
- <b>Set</b>
- <br><br>
- Alle Kommandos die vom DFP angeboten werden haben ein zugehöriges set Kommando:
- <br>
- <table>
- <tr><th>set</th><th>DFP cmd byte</th><th>Parameter</th><th>Kommentar</th></tr>
- <tr><td>next</td><td>0x01</td><td>-</td><td></td></tr>
- <tr><td>prev</td><td>0x02</td><td>-</td><td></td></tr>
- <tr><td>trackNum</td><td>0x03</td><td>Nummer der Datei im Wurzelverzeichnis</td><td>zwischen 1 und 3000 (es wird die Reihenfolge verwendet in der die Dateien angelegt wurden!)</td></tr>
- <tr><td>volumeUp</td><td>0x04</td><td>-</td><td></td></tr>
- <tr><td>volumeDown</td><td>0x05</td><td>-</td><td></td></tr>
- <tr><td>volumeStraight</td><td>0x06</td><td>Lautstärke</td><td>0-30</td></tr>
- <tr><td>equalizer</td><td>0x07</td><td>Name des Equalizermodus</td><td>Normal, Pop, Rock, Jazz, Classic, Bass</td></tr>
- <tr><td>repeatSingle</td><td>0x08</td><td>-</td><td></td></tr>
- <tr><td>storage</td><td>0x09</td><td>SD oder USB</td><td></td></tr>
- <tr><td>sleep</td><td>0x0A</td><td>-</td><td>vom DFP nicht unterstützt, danach muss er stromlos gemacht werden um wieder zu funktionieren</td></tr>
- <tr><td>wake</td><td>0x0B</td><td>-</td><td>vom DFP nicht unterstützt, aber wahrscheinlich vom FN-M22P</td></tr>
- <tr><td>reset</td><td>0x0C</td><td>-</td><td></td></tr>
- <tr><td>play</td><td>0x0D</td><td>-</td><td>spielt die aktuelle Datei</td></tr>
- <tr><td>play</td><td>0x0F, 0x12, 0x13, 0x14</td><td>Eine durch Leerzeichen getrennte Liste von Dateien die nacheinander abgespielt werden</td><td>Das korrekte DFP Kommando wird automatisch ermittelt.
- Dateien können über den Namen ihres Readings, den Readingwert oder Verzeichnisname/Dateinummer angegeben werden. Siehe set readFiles</td></tr>
- <tr><td>pause</td><td>0x0E</td><td>-</td><td></td></tr>
- <tr><td>amplification</td><td>0x10</td><td>Verstärkungsstufe</td><td>0-31</td></tr>
- <tr><td>repeatRoot</td><td>0x11</td><td>on, off</td><td></td></tr>
- <tr><td>MP3TrackNum</td><td>0x12</td><td>Dateinummer</td><td>1-3000, aus dem Verzeichnis MP3</td></tr>
- <tr><td>intercutAdvert</td><td>0x13</td><td>Dateinummer</td><td>1-3000, aus dem Verzeichnis ADVERT</td></tr>
- <tr><td>folderTrackNum</td><td>0x0F</td><td>Verzeichnisnummer Dateinummer</td><td>Verzeichnis: 1-99, Datei: 1-255</td></tr>
- <tr><td>folderTrackNum3000</td><td>0x14</td><td>Verzeichnisnummer Dateinummer</td><td>Verzeichnis: 1-15, Datei: 1-3000</td></tr>
- <tr><td>stopAdvert</td><td>0x15</td><td>-</td><td></td></tr>
- <tr><td>stop</td><td>0x16</td><td>-</td><td></td></tr>
- <tr><td>repeatFolder</td><td>0x17</td><td>Verzeichnisnummer</td><td>1-99</td></tr>
- <tr><td>shuffle</td><td>0x18</td><td>-</td><td></td></tr>
- <tr><td>repeatCurrentTrack</td><td>0x19</td><td>on, off</td><td></td></tr>
- <tr><td>DAC</td><td>0x1A</td><td>on, off</td><td></td></tr>
- </table>
- <br>
- Alle anderen set Kommandos werden nicht an den DFPlayer geschickt sondern bieten Komfortfunktionen:
- <br>
- <ul>
- <li>
- close
- </li>
- <li>
- raw <br>sendet ein in Hexadezimal kodiertes Kommando direkt und ohne Prüfung an den DFP
- </li>
- <li>
- reopen
- </li>
- <li>
- readFiles <br>
- ließt alle Dateien auf dem Speichermedium das in <code>uploadPath</code> gemounted ist. Wenn diese Dateien durch den DFP addressiert werden
- können (d.h. sie entprechen den Namenskonventionen) so wird ein Reading dafür angelegt.
- Der Readingname ist File_<Verzeichnis>/<Dateinummer>.
- Das Verzeichnis kann ., MP3, ADVERT oder 00 bis 99 sein.
- Der Readingwert ist der Dateiname ohne die Dateinummer und das Suffix.<br>
- Beispiel:<br>
- Für die Datei MP3/0003SongTitle.mp3 wird das Reading File_MP3/0003 mit dem Wert SongTitle angelegt.
- <br>
- Das <code>set <dfp> play</code> Kommando kann diese Readings verwenden, d.h. es ist möglich entweder <code>set <dfp> play File_MP3/0003</code>,
- <code>set <dfp> play MP3/3</code> oder <code>set <dfp> play SongTitle</code> zu verwenden, um die selbe Datei abzuspielen.
- </li>
- <li>
- uploadTTS <destination path> <Text der in Sprache umgewandelt werden soll><br>
- Der angegebene Text wird in eine MP3 Sprachdatei umgewandelt. Dafür wird das Text2Speech Device verwendet das mit attr <code>TTSDev</code> angegebene wurde.
- Die MP3 Datei wird dann in das angegebene Zielverzeichnis unterhalb von uploadPath kopiert.
- <br>
- Beispiele:<br>
- <code>set <dfp> 01/0001Test Dies ist ein Test</code><br>
- <code>set <dfp> ADVERT/0099Hinweis Achtung</code>
- </li>
- <li>
- uploadTTScache<br>
- Kopiert alle Dateien aus dem cache Verzeichnis des <code>TTSDev</code> in <code>uploadPath</code>. Es wird zuerst in das Verzeichnis 01 kopiert.
- Nach 3000 Dateien wird das nächste Verzeichnis verwendet. Der MD5 Hash wird als Dateiname verwendet. Zum Schluss wird <code>set readFiles</code> ausgeführt.
- Das Kommando <code>set tts</code> verwendet die dadurch angelegten Readings.
- </li>
- <li>
- tts <Text der in Sprache übersetzt werden soll><br>
- <code>TTSDev</code> wird verwendet um den MD5 Hash von <Text der in Sprache übersetzt werden soll> zu berechnen. Anschließend wird versucht die Datei mit diesem Hash abzuspielen.
- Wenn kein Reading für diesen Hash existiert und das wenn das Attribute <code>rememberMissingTTS</code> gesetzt ist dann wird ein neues Reading Missing_MD5<md5>
- mit dem Wert <Text der in Sprache übersetzt werden soll> angelegt.
- <br>Voraussetzungen:<br>
- Das funktioniert nur, wenn vorher der zu übersetzende Text bereits einmal übersetzt wurde und die daraus resultierende MP3 Datei im cache Verzeichnis
- des TTSDev gespeichert wurde,
- Die Dateien aus dem Cache müssen auf das Speichermedium mittels <code>set uploadTTScache</code> kopiert werden
- </li>
- <li>
- uploadNumbers Zielverzeichnis<br>
- erzeugt MP3 Dateien für alle Sprachschnipsel die benötigt werden um beliebige deutsche Zahlen zu sprechen.<br>
- Beispiel:<br>
- <code>set <dfp> uploadNumbers 99</code>
- <br>
- erzeugt die benötigten 31 MP3 Dateien im Verzeichnis 99.
- </li>
- <li>
- sayNumber Zahl<br>
- übersetzt eine Zahl in Sprache und spielt die benötigten Dateien ab. Setzt voraus, dass vorher uploadNumbers verwendet wurde um die Sprachdateien zu erzeugen.
- <br>
- Beispiel:
- <br>
- <code>sayNumber -34.7</code>
- <br>
- entspricht
- <br>
- <code>play minus vier und dreissig komma sieben</code>
- </li>
- <li>
- response<br> 10 Byte Antwortnachricht vom DFP hexadezimal kodiert
- </li>
- </ul>
- <p><a name="DLNARenderer"></a>
- <h3>DLNARenderer</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#DLNARenderer'>DLNARenderer</a><br/>
- </ul>
- <a name="DOIF"></a>
- <h3>DOIF</h3>
- <div class='langLinks'>[<a href='commandref.html#DOIF'>EN</a> DE]</div>
- <ul>
- DOIF (ausgeprochen: du if, übersetzt: tue wenn) ist ein universelles Modul mit UI, welches ereignis- und zeitgesteuert in Abhängigkeit definierter Bedingungen Anweisungen ausführt.<br>
- <br>
- In einer Hausautomatisation geht es immer wieder um die Ausführung von Befehlen abhängig von einem Ereignis. Oft reicht aber eine einfache Abfrage der Art: "wenn Ereignis eintritt, dann Befehl ausführen" nicht aus.
- Ebenso häufig möchte man eine Aktion nicht nur von einem einzelnen Ereignis abhängig ausführen, sondern abhängig von mehreren Bedingungen, z. B. "schalte Außenlicht ein, wenn es dunkel wird, aber nicht vor 18:00 Uhr"
- oder "schalte die Warmwasserzirkulation ein, wenn die Rücklauftemperatur unter 38 Grad fällt und jemand zuhause ist".
- In solchen Fällen muss man mehrere Bedingung logisch miteinander verknüpfen. Ebenso muss sowohl auf Ereignisse wie auch auf Zeittrigger gleichermaßen reagiert werden.
- <br><br>
- An dieser Stelle setzt das Modul DOIF an. Es stellt eine eigene Benutzer-Schnittstelle zur Verfügung ohne Programmierkenntnisse in Perl unmittelbar vorauszusetzen.
- Mit diesem Modul ist es möglich, sowohl Ereignis- als auch Zeitsteuerung mit Hilfe logischer Abfragen miteinander zu kombinieren.
- Damit können komplexere Problemstellungen innerhalb eines DOIF-Moduls gelöst werden, ohne Perlcode in Kombination mit anderen Modulen programmieren zu müssen.
- <br><br>
- Das DOIF-Modul bedient sich selbst des Perlinterpreters, damit sind beliebige logische Abfragen möglich. Logische Abfragen werden in DOIF/DOELSEIF-Bedingungen vornehmlich mit Hilfe von and/or-Operatoren erstellt.
- Diese werden mit Angaben von Status, Readings, Internals, Events oder Zeiten kombiniert.
- Sie werden grundsätzlich in eckigen Klammern angegeben und führen zur Triggerung des Moduls und damit zur Auswertung der dazugehörigen Bedingung.
- Zusätzlich können in einer Bedingung Perl-Funktionen angegeben werden, die in FHEM definiert sind.
- Wenn eine Bedingung wahr wird, so werden die dazugehörigen Befehle ausgeführt.<br>
- <br>
- Das DOIF-Modul verfügt inzwischen über ein eigenes User Interface für Visualierung und Bedienung von FHEM-Devices, siehe <a href="#DOIF_uiTable"><b>[NEU]</b> uiTable, das User Interface</a><br>
- <br>
- Syntax:<br>
- <br>
- <ol><code>define <name> DOIF (<Bedingung>) (<Befehle>) DOELSEIF (<Bedingung>) (<Befehle>) DOELSEIF ... DOELSE (<Befehle>)</code></ol>
- <br>
- Die Angaben werden immer von links nach rechts abgearbeitet. Zu beachten ist, dass nur die Bedingungen überprüft werden,
- die zum ausgelösten Event das dazughörige Device bzw. die dazugehörige Triggerzeit beinhalten.
- Kommt ein Device in mehreren Bedingungen vor, so wird immer nur ein Kommando ausgeführt, und zwar das erste,
- für das die dazugehörige Bedingung in der abgearbeiteten Reihenfolge wahr ist.<br><br>
- Das DOIF-Modul arbeitet mit Zuständen. Jeder Ausführungszweig DOIF/DOELSEIF..DOELSEIF/DOELSE stellt einen eigenen Zustand dar (cmd_1, cmd_2, usw.).
- Das Modul merkt sich den zuletzt ausgeführten Ausführungszweig und wiederholt diesen standardmäßig nicht.
- Ein Ausführungszweig wird erst dann wieder ausgeführt, wenn zwischenzeitlich ein anderer Ausführungszweig ausgeführt wurde, also ein Zustandswechsel stattgefunden hat.
- Dieses Verhalten ist sinnvoll, um zu verhindern, dass zyklisch sendende Sensoren (Temperatur, Feuchtigkeit, Helligkeit, usw.) zu ständiger Wiederholung des selben Befehls oder Befehlsabfolge führen.<br>
- <br>
- <u>Einfache Anwendungsbeispiele:</u><ol>
- <br>
- Fernbedienung (Ereignissteuerung)<br>
- <br>
- <code>define di_rc_tv DOIF ([remotecontol:"on"]) (set tv on) DOELSE (set tv off)</code><br>
- <br>
- Zeitschaltuhr (Zeitsteuerung)<br>
- <br>
- <code>define di_clock_radio DOIF ([06:30|Mo Di Mi] or [08:30|Do Fr Sa So]) (set radio on) DOELSEIF ([08:00|Mo Di Mi] or [09:30|Do Fr Sa So]) (set radio off)</code><br>
- <br>
- Kombinierte Ereignis- und Zeitsteuerung<br>
- <br>
- <code>define di_lamp DOIF ([06:00-09:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)</code><br>
- </ol><br>
- Eine ausführliche Erläuterung der obigen Anwendungsbeispiele kann hier nachgelesen werden:
- <a href="https://wiki.fhem.de/wiki/DOIF/Einsteigerleitfaden,_Grundfunktionen_und_Erl%C3%A4uterungen#Erste_Schritte_mit_DOIF:_Zeit-_und_Ereignissteuerung">Erste Schritte mit DOIF</a><br><br>
- <br>
- <a name="DOIF_Inhaltsuebersicht"></a>
- <b>Inhaltsübersicht</b><br>
- <ul><br>
- <a href="#DOIF_Features">Features</a><br>
- <a href="#DOIF_Lesbarkeit_der_Definitionen">Lesbarkeit der Definitionen</a><br>
- <a href="#DOIF_Ereignissteuerung">Ereignissteuerung</a><br>
- <a href="#DOIF_Teilausdruecke_abfragen">Teilausdrücke abfragen</a><br>
- <a href="#DOIF_Ereignissteuerung_ueber_Auswertung_von_Events">Ereignissteuerung über Auswertung von Events</a><br>
- <a href="#DOIF_Angaben_im_Ausfuehrungsteil">Angaben im Ausführungsteil</a><br>
- <a href="#DOIF_Filtern_nach_Zahlen">Filtern nach Ausdrücken mit Ausgabeformatierung</a><br>
- <a href="#DOIF_aggregation">Aggregieren von Werten</a><br>
- <a href="#DOIF_Zeitsteuerung">Zeitsteuerung</a><br>
- <a href="#DOIF_Relative_Zeitangaben">Relative Zeitangaben</a><br>
- <a href="#DOIF_Zeitangaben_nach_Zeitraster_ausgerichtet">Zeitangaben nach Zeitraster ausgerichtet</a><br>
- <a href="#DOIF_Relative_Zeitangaben_nach_Zeitraster_ausgerichtet">Relative Zeitangaben nach Zeitraster ausgerichtet</a><br>
- <a href="#DOIF_Zeitangaben_nach_Zeitraster_ausgerichtet_alle_X_Stunden">Zeitangaben nach Zeitraster ausgerichtet alle X Stunden</a><br>
- <a href="#DOIF_Wochentagsteuerung">Wochentagsteuerung</a><br>
- <a href="#DOIF_Zeitsteuerung_mit_Zeitintervallen">Zeitsteuerung mit Zeitintervallen</a><br>
- <a href="#DOIF_Indirekten_Zeitangaben">Indirekten Zeitangaben</a><br>
- <a href="#DOIF_Zeitsteuerung_mit_Zeitberechnung">Zeitsteuerung mit Zeitberechnung</a><br>
- <a href="#DOIF_Kombination_von_Ereignis_und_Zeitsteuerung_mit_logischen_Abfragen">Kombination von Ereignis- und Zeitsteuerung mit logischen Abfragen</a><br>
- <a href="#DOIF_Zeitintervalle_Readings_und_Status_ohne_Trigger">Zeitintervalle, Readings und Status ohne Trigger</a><br>
- <a href="#DOIF_Nutzung_von_Readings_Status_oder_Internals_im_Ausfuehrungsteil">Nutzung von Readings, Status oder Internals im Ausführungsteil</a><br>
- <a href="#DOIF_Berechnungen_im_Ausfuehrungsteil">Berechnungen im Ausführungsteil</a><br>
- <a href="#DOIF_notexist">Ersatzwert für nicht existierende Readings oder Status</a><br>
- <a href="#DOIF_wait">Verzögerungen</a><br>
- <a href="#DOIF_timerWithWait">Verzögerungen von Timern</a><br>
- <a href="#DOIF_do_resetwait">Zurücksetzen des Waittimers für das gleiche Kommando</a><br>
- <a href="#DOIF_repeatcmd">Wiederholung von Befehlsausführung</a><br>
- <a href="#DOIF_cmdpause">Zwangspause für das Ausführen eines Kommandos seit der letzten Zustandsänderung</a><br>
- <a href="#DOIF_repeatsame">Begrenzung von Wiederholungen eines Kommandos</a><br>
- <a href="#DOIF_waitsame">Ausführung eines Kommandos nach einer Wiederholung einer Bedingung</a><br>
- <a href="#DOIF_waitdel">Löschen des Waittimers nach einer Wiederholung einer Bedingung</a><br>
- <a href="#DOIF_checkReadingEvent">Readingauswertung nur beim Event des jeweiligen Readings</a><br>
- <a href="#DOIF_addStateEvent">Eindeutige Statuserkennung</a><br>
- <a href="#DOIF_selftrigger">Triggerung durch selbst ausgelöste Events</a><br>
- <a href="#DOIF_timerevent">Setzen der Timer mit Event</a><br>
- <a href="#DOIF_Zeitspanne_eines_Readings_seit_der_letzten_Aenderung">Zeitspanne eines Readings seit der letzten Änderung</a><br>
- <a href="#DOIF_setList__readingList">Darstellungselement mit Eingabemöglichkeit im Frontend und Schaltfunktion</a><br>
- <a href="#DOIF_cmdState">Status des Moduls</a><br>
- <a href="#DOIF_uiTable"><b>[NEU]</b> uiTable, das User Interface</a><br>
- <a href="#DOIF_Reine_Statusanzeige_ohne_Ausfuehrung_von_Befehlen">Reine Statusanzeige ohne Ausführung von Befehlen</a><br>
- <a href="#DOIF_state">Anpassung des Status mit Hilfe des Attributes <code>state</code></a><br>
- <a href="#DOIF_Readings"><b>[NEU]</b> Erzeugen berechneter Readings<br>
- <a href="#DOIF_initialize">Vorbelegung des Status mit Initialisierung nach dem Neustart mit dem Attribut <code>initialize</code></a><br>
- <a href="#DOIF_disable">Deaktivieren des Moduls</a><br>
- <a href="#DOIF_setcmd">Bedingungslose Ausführen von Befehlszweigen</a><br>
- <a href="#DOIF_Initialisieren_des_Moduls">Initialisieren des Moduls</a><br>
- <a href="#DOIF_Weitere_Anwendungsbeispiele">Weitere Anwendungsbeispiele</a><br>
- <a href="#DOIF_Zu_beachten">Zu beachten</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIF">DOIF im FHEM-Wiki</a><br>
- <a href="https://forum.fhem.de/index.php/board,73.0.html">DOIF im FHEM-Forum</a><br>
- <a href="#DOIF_Kurzreferenz">Kurzreferenz</a><br>
- <a href="#DOIF_PerlFunktionen_kurz">Perl-Funktionen</a><br>
- <!-- Vorlage Inhaltsübersicht und Sprungmarke-->
- <a href="#DOIF_"></a><br>
- <a name="DOIF_"></a>
- <!-- Vorlage Rücksprung zur Inhaltsübersicht-->
- <!-- <a href="#DOIF_Inhaltsuebersicht">back</a><br>-->
- </ul>
- <a name="DOIF_Attribute"></a>
- <a href="#DOIF_Attribute_kurz"><b>Attribute</b></a><br>
- <ul>
- <a href="#DOIF_addStateEvent">addStateEvent</a>
- <a href="#DOIF_checkall">checkall</a>
- <a href="#DOIF_checkReadingEvent">checkReadingEvent</a>
- <a href="#DOIF_cmdpause">cmdpause</a>
- <a href="#DOIF_cmdState">cmdState</a>
- <a href="#DOIF_Readings">DOIF_Readings</a>
- <a href="#DOIF_disable">disable</a>
- <a href="#DOIF_do_always">do always</a>
- <a href="#DOIF_do_resetwait">do resetwait</a>
- <a href="#DOIF_initialize">initialize</a>
- <a href="#DOIF_notexist">notexist</a>
- <a href="#DOIF_repeatcmd">repeatcmd</a>
- <a href="#DOIF_repeatsame">repeatsame</a>
- <a href="#DOIF_selftrigger">selftrigger</a>
- <a href="#DOIF_setList__readingList">readingList</a>
- <a href="#DOIF_setList__readingList">setList</a>
- <a href="#DOIF_startup">startup</a>
- <a href="#DOIF_state">state</a>
- <a href="#DOIF_timerevent">timerevent</a>
- <a href="#DOIF_timerWithWait">timerWithWait</a>
- <a href="#DOIF_uiTable">uiTable</a>
- <a href="#DOIF_wait">wait</a>
- <a href="#DOIF_waitdel">waitdel</a>
- <a href="#DOIF_waitsame">waitsame</a>
- <a href="#DOIF_weekdays">weekdays</a>
- <br><a href="#readingFnAttributes">readingFnAttributes</a>
- </ul>
- <br>
- <a href="#DOIF_setBefehle"><b>Set Befehle</b></a><br>
- <ul>
- <a href="#DOIF_setcheckall">checkall</a>
- <a href="#DOIF_setdisable">disable</a>
- <a href="#DOIF_setenable">enable</a>
- <a href="#DOIF_Initialisieren_des_Moduls">initialize</a>
- <a href="#DOIF_setcmd">cmd</a>
- </ul>
- <br>
- <a href="#DOIF_getBefehle"><b>Get Befehle</b></a><br>
- <ul>
- <a href="#HTML-Code von uiTable">html</a>
- </ul>
- <br>
- <a name="DOIF_Features"></a>
- <b>Features</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <ol><br>
- + Syntax angelehnt an Verzweigungen if - elseif - ... - elseif - else in höheren Programmiersprachen<br>
- + Pro Modul können beliebig viele Zeit- und beliebig viele Ereignis-Angaben logisch miteinander kombiniert werden<br>
- + Das Modul reagiert sowohl auf Ereignisse als auch auf Zeittrigger<br>
- + Bedingungen werden vom Perl-Interpreter ausgewertet, daher sind beliebige logische Abfragen möglich<br>
- + Es können beliebig viele DOELSEIF-Angaben gemacht werden, sie sind, wie DOELSE am Ende der Kette, optional<br>
- + Verzögerungsangaben mit Zurückstellung sind möglich (watchdog-Funktionalität)<br>
- + Der Ausführungsteil kann jeweils ausgelassen werden. Damit kann das Modul für reine Statusanzeige genutzt werden<br>
- </ol><br>
- <a name="DOIF_Lesbarkeit_der_Definitionen"></a>
- <b>Lesbarkeit der Definitionen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Da die Definitionen im Laufe der Zeit recht umfangreich werden können, sollten die gleichen Regeln, wie auch beim Programmieren in höheren Programmiersprachen, beachtet werden.
- Dazu zählen: das Einrücken von Befehlen, Zeilenumbrüche sowie das Kommentieren seiner Definition, damit man auch später noch die Funktionalität seines Moduls nachvollziehen kann.<br>
- <br>
- Das Modul unterstützt dazu Einrückungen, Zeilenumbrüche an beliebiger Stelle und Kommentierungen beginnend mit ## bis zum Ende der Zeile.
- Die Formatierungen lassen sich im DEF-Editor der Web-Oberfläche vornehmen.<br>
- <br>
- So könnte eine Definition aussehen:<br>
- <br>
- <code>define di_Modul DOIF ([Switch1] eq "on" and [Switch2] eq "on") ## wenn Schalter 1 und Schalter 2 on ist<br>
- <br>
- <ol>(set lamp on) ## wird Lampe eingeschaltet</ol>
- <br>
- DOELSE ## im sonst-Fall, also wenn einer der Schalter off ist<br>
- <br>
- <ol>(set lamp off) ## wird die Lampe ausgeschaltet</ol></code>
- <br>
- Im Folgenden wird die Funktionalität des Moduls im Einzelnen an vielen praktischen Beispielen erklärt.<br>
- <br>
- <a name="DOIF_Ereignissteuerung"></a>
- <b>Ereignissteuerung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Vergleichende Abfragen werden, wie in Perl gewohnt, mit Operatoren <code>==, !=, <, <=, >, >=</code> bei Zahlen und mit <code>eq, ne, lt, le, gt, ge, =~, !~</code> bei Zeichenketten angegeben.
- Logische Verknüpfungen sollten zwecks Übersichtlichkeit mit <code>and</code> bzw. <code>or</code> vorgenommen werden.
- Selbstverständlich lassen sich auch alle anderen Perl-Operatoren verwenden, da die Auswertung der Bedingung vom Perl-Interpreter vorgenommen wird.
- Die Reihenfolge der Auswertung wird, wie in höheren Sprachen üblich, durch runde Klammern beeinflusst.
- Status werden mit <code>[<devicename>]</code>, Readings mit <code>[<devicename>:<readingname>]</code>,
- Internals mit <code>[<devicename>:&<internal>]</code> angegeben.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Einfache Ereignissteuerung mit einmaliger Ausführung beim Zustandswechsel, "remotecontrol" ist hier ein Device, es wird in eckigen Klammern angegeben. Ausgewertet wird der Status des Devices - nicht das Event.<br>
- <br>
- <code>define di_garage DOIF ([remotecontrol] eq "on") (set garage on) DOELSEIF ([remotecontrol] eq "off") (set garage off)</code><br>
- <br>
- Das Modul wird getriggert, sobald das angegebene Device hier "remotecontrol" ein Event erzeugt. Das geschieht, wenn irgendein Reading oder der Status von "remotecontrol" aktualisiert wird.
- Ausgewertet wird hier der Zustand des Status von remotecontrol nicht das Event selbst. Die Ausführung erfolgt standardmäßig einmalig nur nach Zustandswechsel des Moduls.
- Das bedeutet, dass ein mehrmaliges Drücken der Fernbedienung auf "on" nur einmal "set garage on" ausführt. Die nächste mögliche Ausführung ist "set garage off", wenn Fernbedienung "off" liefert.
- <a name="DOIF_do_always"></a>
- Wünscht man eine Ausführung des gleichen Befehls mehrfach nacheinander bei jedem Trigger, unabhängig davon welchen Zustand das DOIF-Modul hat,
- weil z. B. Garage nicht nur über die Fernbedienung geschaltet wird, dann muss man das per "do always"-Attribut angeben:<br>
- <br>
- <code>attr di_garage do always</code><br>
- <br>
- Bei der Angabe von zyklisch sendenden Sensoren (Temperatur, Feuchtigkeit, Helligkeit usw.) wie z. B.:<br>
- <br>
- <code>define di_heating DOIF ([sens:temperature] < 20) (set heating on)</code><br>
- <br>
- ist die Nutzung des Attributes <code>do always</code> nicht sinnvoll, da das entsprechende Kommando hier: "set heating on" jedes mal ausgeführt wird,
- wenn der Temperatursensor in regelmäßigen Abständen eine Temperatur unter 20 Grad sendet.
- Ohne <code>do always</code> wird hier dagegen erst wieder "set heating on" ausgeführt, wenn der Zustand des Moduls auf "cmd_2" gewechselt hat, also die Temperatur zwischendurch größer oder gleich 20 Grad war.<br>
- <br>
- Soll bei Nicht-Erfüllung aller Bedingungen ein Zustandswechsel erfolgen, so muss man ein DOELSE am Ende der Definition anhängen. Ausnahme ist eine einzige Bedingung ohne do always, wie im obigen Beispiel,
- hierbei wird intern ein virtuelles DOELSE angenommen, um bei Nicht-Erfüllung der Bedingung einen Zustandswechsel in cmd_2 zu provozieren, da sonst nur ein einziges Mal geschaltet werden könnte, da das Modul aus dem cmd_1-Zustand nicht mehr herauskäme.<br>
- <br>
- <a name="DOIF_Teilausdruecke_abfragen"></a>
- <b>Teilausdrücke abfragen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Abfragen nach Vorkommen eines Wortes innerhalb einer Zeichenkette können mit Hilfe des Perl-Operators <code>=~</code> vorgenommen werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Garage soll beim langen Tastendruck öffnen, hier: wenn das Wort "Long" im Status vorkommt (bei HM-Komponenten stehen im Status noch weitere Informationen).<br>
- <br>
- <code>define di_garage DOIF ([remotecontrol] =~ "Long") (set garage on)<br>
- attr di_garage do always</code><br>
- <br>
- Weitere Möglichkeiten bei der Nutzung des Perl-Operators: <code>=~</code>, insbesondere in Verbindung mit regulären Ausdrücken, können in der Perl-Dokumentation nachgeschlagen werden.<br>
- <br>
- <a name="DOIF_Ereignissteuerung_ueber_Auswertung_von_Events"></a>
- <b>Ereignissteuerung über Auswertung von Events</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Eine Alternative zur Auswertung von Status oder Readings ist das Auswerten von Ereignissen (Events) mit Hilfe von regulären Ausdrücken. Der Suchstring wird als regulärer Ausdruck in Anführungszeichen angegeben.
- Die Syntax lautet: <code>[<devicename>:"<regex>"]</code><br>
- <br>
- <u>Anwendungsbeispiel</u>: wie oben, jedoch wird hier nur das Ereignis (welches im Eventmonitor erscheint) ausgewertet und nicht der Status von "remotecontrol" wie im vorherigen Beispiel<br>
- <br>
- <code>define di_garage DOIF ([remotecontrol:"on"]) (set garage on) DOELSEIF ([remotecontrol:"off"]) (set garage off)</code><br>
- <br>
- In diesem Beispiel wird nach dem Vorkommen von "on" innerhalb des Events gesucht.
- Falls "on" gefunden wird, wird der Ausdruck wahr und der DOIF-Fall wird ausgeführt, ansonsten wird der DOELSEIF-Fall entsprechend ausgewertet.
- Die Auswertung von reinen Ereignissen bietet sich dann an, wenn ein Modul keinen Status oder Readings benutzt, die man abfragen kann, wie z. B. beim Modul "sequence".
- Die Angabe von regulären Ausdrücken kann recht komplex werden und würde die Aufzählung aller Möglichkeiten an dieser Stelle den Rahmen sprengen.
- Weitere Informationen zu regulären Ausdrücken sollten in der Perl-Dokumentation nachgeschlagen werden.
- Die logische Verknüpfung "and" mehrerer Ereignisse ist nicht sinnvoll, da zu einem Zeitpunkt immer nur ein Ereignis zutreffen kann.<br>
- <br>
- Die alte Syntax <code>[<devicename>:?<regex>]</code> wird aus Kompatibilitätsgründen noch unterstützt, sollte aber nicht mehr benutzt werden.<br>
- <br>
- Sollen Events verschiedener Devices ausgewertet werden, so lässt sich folgende Syntax anwenden: <code>["<device regex>:<event regex>"]</code><br>
- <br>
- Im Gegensatz zum notify werden vom DOIF-Modul selbst keine Regex-Sonderzeichen hinzugefügt. Insb. wird kein ^ für Anfang vorangestellt, bzw. kein $ für Ende angehängt.<br>
- <br>
- Beispiele für Regex-Angaben: <br>
- <br>
- ["FS"] triggert auf alle Devices, die "FS" im Namen beinhalten <br>
- ["^FS"] triggert auf alle Devices, die mit "FS" im Namen anfangen <br>
- ["FS:temp"] triggert auf alle Devices, die "FS" im Namen und "temp" im Event beinhalten <br>
- ([":^temp"]) triggert auf beliebige Devices, die im Event mit "temp" beginnen <br>
- (["^FS$:^temp$"] triggert auf Devices, die genau "FS" heißen und im Event genau "temp" vorkommt <br>
- [""] triggert auf alles<br>
- <br>
- In der Bedingung und im Ausführungsteil werden die Schlüsselwörter $SELF durch den eigenen Namen des DOIF-Moduls, $DEVICE durch das aktuelle Device, $EVENT durch die passende Eventzeile, $EVENTS kommagetrennt durch alle Eventzeilen des Triggers ersetzt.<br>
- <br>
- Entsprechend können Perl-Variablen in der DOIF-Bedingung ausgewertet werden, sie werden in Kleinbuchstaben geschrieben. Sie lauten: $device, $event, $events<br>
- <br>
- <u>Anwendungsbeispiele</u>:<br>
- <br>
- Loggen aller Ereignisse in FHEM<br>
- <br>
- <code>define di_all_events DOIF ([""]) ({Log 3,"Events from device $DEVICE:$EVENTS"})<br>
- <br>
- attr di_all_events do always<br></code>
- <br>
- "Fenster offen"-Meldung<br>
- <br>
- <code>define di_window_open (["^window_:open"]) (set Pushover msg 'alarm' 'open windows $DEVICE' '' 2 'persistent' 30 3600)<br>
- <br>
- attr di_window_open do always</code><br>
- <br>
- Hier werden alle Fenster, die mit dem Device-Namen "window_" beginnen auf "open" im Event überwacht.<br>
- <br>
- Rollladen auf Lüften stellen<br>
- <br>
- <code>define di_air DOIF (["^window_contact_:open|tilted"]) (set {("$DEVICE"=~/^window_contact_(.*)/;"shutters_$1")} 10)<br>
- <br>
- attr di_air do always</code><br>
- <br>
- Hier werden alle Fensterkontakte, die mit dem Device-Namen "window_contact_" beginnen auf "open" oder "tilted" im Event überwacht
- und der entsprechende Rollladen mit der gleichen Endung auf Lüften per <code>set shutters_<postfix> 10</code> gestellt.
- In diesem Beispiel wird die Möglichkeit genutzt bei FHEM-Befehlen Perlcode innerhalb der Klammern {(...)} einzufügen. Siehe <a href="#DOIF_Berechnungen_im_Ausfuehrungsteil">Berechnungen im Ausführungsteil</a><br>
- <br>
- Verzögerte "Fenster offen"-Meldung<br>
- <br>
- <code>define di_window_open DOIF ["^window_:open|tilted"])<br>
- (defmod at_$DEVICE at +00:05 set send window $DEVICE open)<br>
- DOELSEIF (["^window_:closed"])<br>
- (delete at_$DEVICE)<br>
- <br>
- attr di_window_open do always</code><br>
- <br>
- Alternative mit sleep<br>
- <br>
- <code>define di_window_open DOIF ["^window_:open|tilted"])<br>
- (sleep 300 $DEVICE quiet;set send window $DEVICE open)<br>
- DOELSEIF (["^window_:closed"])<br>
- (cancel $DEVICE quiet)<br>
- <br>
- attr di_window_open do always</code><br>
- <br>
- In den obigen beiden Beispielen ist eine Verzögerung über das Attribut wait nicht sinnvoll, da pro Fenster ein eigener Timer (hier mit Hilfe von at/sleep) gesetzt werden muss.<br>
- <br>
- Batteriewarnung per E-Mail verschicken<br>
- <br>
- <code>define di_battery DOIF ([":battery: low"] and [?$SELF:B_$DEVICE] ne "low")<br>
- <ol>({DebianMail('yourname@gmail.com', 'FHEM - battery warning from device: $DEVICE')}, setreading $SELF B_$DEVICE low)</ol>
- DOELSEIF ([":battery: ok"] and [?$SELF:B_$DEVICE] ne "ok")<br>
- <ol>(setreading $SELF B_$DEVICE ok)</ol>
- <br>
- attr di_battery do always</code><br>
- <br>
- Eine aktuelle Übersicht aller Batterie-Status entsteht gleichzeitig in den Readings des di_battery-DOIF-Moduls.<br>
- <br>
- <br>
- Allgemeine Ereignistrigger können ebenfalls so definiert werden, dass sie nicht nur wahr zum Triggerzeitpunkt und sonst nicht wahr sind,
- sondern Inhalte des Ereignisses zurückliefern. Initiiert wird dieses Verhalten durch die Angabe eines Default-Wertes.<br>
- <br>
- Syntax:<br>
- <br>
- <code>["regex for trigger",<default value>]</code><br>
- <br>
- Anwendungsbeispiel:<br>
- <br>
- <code>define di_warning DOIF ([":^temperature",0]< 0 and [06:00-09:00] ) (set pushmsg danger of frost)</code><br>
- <br>
- Damit wird auf alle Devices getriggert, die mit "temperature" im Event beginnen. Zurückgeliefert wird der Wert, der im Event hinter "temperature: " steht.
- Wenn kein Event stattfindet, wird der Defaultwert, hier 0, zurückgeliefert.
- <br>
- Ebenfalls kann ein Ereignisfilter mit Ausgabeformatierung angegeben werden.<br>
- <br>
- Syntax:<br>
- <br>
- <code>["regex for trigger":"<regex filter>":<output>,<default value>]</code><br>
- <br>
- Regex-Filter- und Output-Parameter sind optional. Der Default-Wert ist verpflichtend.<br>
- <br>
- Die Angaben zum Filter und Output funktionieren, wie die beim Reading-Filter. Siehe: <a href="#DOIF_Filtern_nach_Zahlen">Filtern nach Ausdrücken mit Ausgabeformatierung</a><br>
- <br>
- Wenn kein Filter, wie obigen Beispiel, angegeben wird, so wird intern folgende Regex vorbelegt: "[^\:]*: (.*)" Damit wird der Wert hinter der Readingangabe genommen.
- Durch eigene Regex-Filter-Angaben kann man beliebige Teile des Events herausfiltern, ggf. über Output formatieren und in der Bedingung entsprechend auswerten,
- ohne auf Readings zurückgreifen zu müssen.<br>
- <br>
- <a name="DOIF_Filtern_nach_Zahlen"></a>
- <b>Filtern nach Ausdrücken mit Ausgabeformatierung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Syntax: <code>[<device>:<reading>|<internal>:d<number>|"<regex>":<output>]</code><br>
- <br>
- d - Der Buchstabe "d" ist ein Synonym für das Filtern nach Dezimalzahlen, es entspricht intern dem regulären Ausdruck "(-?\d+(\.\d+)?)". Ebenfalls lässt sich eine Dezimalzahl auf eine bestimmte Anzahl von Nachkommastellen runden. Dazu wird an das "d" eine Ziffer angehängt. Mit der Angabe d0 wird die Zahl auf ganze Zahlen gerundet.<br>
- <Regex>- Der reguläre Ausdruck muss in Anführungszeichen angegeben werden. Dabei werden Perl-Mechanismen zu regulären Ausdrücken mit Speicherung der Ergebnisse in Variablen $1, $2 usw. genutzt.<br>
- <Output> - ist ein optionaler Parameter, hier können die in den Variablen $1, $2, usw. aus der Regex-Suche gespeicherten Informationen für die Aufbereitung genutzt werden. Sie werden in Anführungszeichen bei Texten oder in Perlfunktionen angegeben. Wird kein Output-Parameter angegeben, so wird automatisch $1 genutzt.<br>
- <br>
- Beispiele:<br>
- <br>
- Es soll aus einem Reading, das z. B. ein Prozentzeichen beinhaltet, nur der Zahlenwert für den Vergleich genutzt werden:<br>
- <br>
- <code>define di_heating DOIF ([adjusting:actuator:d] < 10) (set heating off) DOELSE (set heating on)</code><br>
- <br>
- Alternativen für die Nutzung der Syntax am Beispiel des Filterns nach Zahlen:<br>
- <br>
- <code>[mydevice:myreading:d]</code><br>
- entspricht:<br>
- <code>[mydevice:myreading:"(-?\d+(\.\d+)?)"]</code><br>
- entspricht:<br>
- <code>[mydevice:myreading:"(-?\d+(\.\d+)?)":$1]</code><br>
- entspricht:<br>
- <code>[mydevice:myreading:"(-?\d+(\.\d+)?)":"$1"]</code><br>
- entspricht:<br>
- <code>[mydevice:myreading:"(-?\d+(\.\d+)?)":sprintf("%s":$1)]</code><br>
- <br>
- Es soll die Zahl aus einem Reading auf 3 Nachkommastellen formatiert werden:<br>
- <br>
- <code>[mydevice:myreading:d3]</code><br>
- <br>
- Es soll aus einem Text eine Zahl herausgefiltert werden und anschließend gerundet auf zwei Nachkommastellen mit der Einheit °C ausgeben werden:<br>
- <br>
- <code>... (set mydummy [mydevice:myreading:d2:"$1 °C"])</code><br>
- <br>
- Es sollen aus einem Reading der Form "HH:MM:SS" die Stunden, Minuten und Sekunden separieret werden:<br>
- <br>
- <code>[mydevice:myreading:"(\d\d):(\d\d):(\d\d)":"hours: $1, minutes $2, seconds: $3"]</code><br>
- <br>
- Der Inhalt des Dummys Alarm soll in einem Text eingebunden werden:<br>
- <br>
- <code>[alarm:state:"(.*)":"state of alarm is $1"]</code><br>
- <br>
- Die Definition von regulären Ausdrücken mit Nutzung der Perl-Variablen $1, $2 usw. kann in der Perldokumentation nachgeschlagen werden.<br>
- <br>
- <a name="DOIF_Angaben_im_Ausfuehrungsteil"></a>
- <b>Angaben im Ausführungsteil</b>: <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Der Ausführungsteil wird durch runde Klammern eingeleitet. Es werden standardmäßig FHEM-Befehle angegeben, wie z. B.: <code>...(set lamp on)</code><br>
- <br>
- Sollen mehrere FHEM-Befehle ausgeführt werden, so werden sie mit Komma statt mit Semikolon angegeben <code>... (set lamp1 on, set lamp2 off)</code><br>
- <br>
- Falls ein Komma nicht als Trennzeichen zwischen FHEM-Befehlen gelten soll, so muss der FHEM-Ausdruck zusätzlich in runde Klammern gesetzt werden: <code>...((set lamp1,lamp2 on),set switch on)</code><br>
- <br>
- Perlbefehle werden in geschweifte Klammern gesetzt: <code>... {system ("wmail Peter is at home")}</code>. In diesem Fall können die runden Klammern des Ausführungsteils weggelassen werden.<br>
- <br>
- Perlcode kann im DEF-Editor wie gewohnt programmiert werden: <code>...{my $name="Peter"; system ("wmail $name is at home");}</code><br>
- <br>
- FHEM-Befehle lassen sich mit Perl-Befehlen kombinieren: <code>... ({system ("wmail Peter is at home")}, set lamp on)</code><br>
- <br>
- <a name="DOIF_aggregation"></a><br>
- <b>Aggregieren von Werten</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit Hilfe der Aggregationsfunktion können mehrere gleichnamige Readings im System ausgewertet werden, die einem bestimmten Kriterium entsprechen. Sie wird in eckigen Klammern durch ein # (aggregierter Wert) oder @ (Liste der passeden Devices) eingeleitet.
- Es kann bestimmt werden: die Anzahl der Readings bzw. Devices, Durchschnittswert, Summe, höchster Wert, niedrigster Wert oder eine Liste der dazugehörigen Devices.
- Die Aggregationsfunktion kann in einer DOIF-Bedingungen, im Ausführungsteil oder mit Hilfe des state-Attributs im Status angegeben werden. In der Bedingung und im Status reagiert sie auf Ereignistrigger. Das lässt sich durch ein vorangestelltes Fragezeichen unterbinden.
- Die Angabe des Readings kann weggelassen werden, dann wird lediglich nach entsprechenden Devices gesucht.<br>
- <br>
- Syntax:<br>
- <br>
- <code>[<function>:<format>:"<regex device>:<regex event>":<reading>|"<regex reading>":<condition>,<default>]</code><br>
- <br>
- <function>:<br>
- <br>
- <b>#</b> Anzahl der betroffenen Devices, der folgende Doppelpunkt kann weggelassen werden<br>
- <b>@</b> kommagetrennte Liste Devices, der folgende Doppelpunkt kann weggelassen werden<br>
- <b>#sum</b> Summe <br>
- <b>#max</b> höchster Wert<br>
- <b>#min</b> niedrigster Wert<br>
- <b>#average</b> Durchschnitt<br>
- <b>@max</b> Device des höchsten Wertes<br>
- <b>@min</b> Device de niedrigsten Wertes<br>
- <br>
- <format> <code>d<number></code> zum Runden des Wertes mit Nachkommastellen, <code>a</code> für Aliasnamen bei Devicelisten, <code>s(<splittoken>)</code> <splittoken> sind Trennzeichen in der Device-Liste<br>
- <br>
- "<regex Device>:<regex Event>" spezifiziert sowohl die betroffenen Devices, als auch den Ereignistrigger, die Syntax entspricht der DOIF-Syntax für Ereignistrigger.<br>
- Die Angabe <regex Event> ist im Ausführungsteil nicht sinnvoll und sollte weggelassen werden.<br>
- <br>
- <reading> Reading, welches überprüft werden soll<br>
- <br>
- "<regex reading>"; Regex für Readings, die überprüft werden sollen<br>
- <br>
- <condition> Aggregations-Bedingung, $_ ist der Platzhalter für den aktuellen Wert des internen Schleifendurchlaufs, Angaben in Anführungszeichen der Art "<value>" entsprechen $_ =~ "<value>" , hier sind alle Perloperatoren möglich.<br>
- <br>
- <default> Default-Wert, falls kein Device gefunden wird, entspricht der Syntax des Default-Wertes bei Readingangaben<br>
- <br>
- <format>, <reading>, <condition>, <default> sind optional<br>
- <br>
- <u>Syntax-Beispiele im Ausführungteil</u><br>
- <br>
- Anzahl der Devices, die mit "window" beginnen:<br>
- <br>
- <code>[#"^window"]</code><br>
- <br>
- Liste der Devices, die mit "window" beginnen, es werden Aliasnamen ausgegeben, falls definiert:<br>
- <br>
- <code>[@:a"^window"]</code><br>
- <br>
- Liste der Devices, die mit "windows" beginnen und ein Reading "myreading" beinhalten:<br>
- <br>
- <code>[@"^window":myreading]</code><br>
- <br>
- Liste der Devices, die mit "windows" beginnen und im Status das Wort "open" vorkommt:<br>
- <br>
- <code>[@"^window":state:"open"]</code><br>
- <br>
- entspricht:<br>
- <br>
- <code>[@"^window":state:$_ =~ "open"]</code> siehe Aggregationsbedingung.<br>
- <br>
- Kleinster Wert der Readings des Devices "abfall", in deren Namen "Gruenschnitt" vorkommt und die mit "_days" enden:<br>
- <br>
- <code>[#min:"^abfall$":"Gruenschnitt.*_days$"]</code><br>
- <br>
- Durchschnitt von Readings aller Devices, die mit "T_" beginnen, in deren Reading-Namen "temp" vorkommt:<br>
- <br>
- <code>[#average:"^T_":"temp"]</code><br>
- <br>
- In der Aggregationsbedingung <condition> können alle in FHEM definierten Perlfunktionen genutzt werden. Folgende Variablen sind vorbelegt und können ebenfalls benutzt werden:<br>
- <br>
- <b>$_</b> Inhalt des angegebenen Readings (s.o.)<br>
- <b>$number</b> Nach Zahl gefilteres Reading<br>
- <b>$name</b> Name des Devices<br>
- <b>$TYPE</b> Devices-Typ<br>
- <b>$STATE</b> Status des Devices (nicht das Reading state)<br>
- <b>$room</b> Raum des Devices<br>
- <b>$group</b> Gruppe des Devices<br>
- <br>
- <u>Beispiele für Definition der Aggregationsbedingung <condition>:</u><br>
- <br>
- Liste der Devices, die mit "rooms" enden und im Reading "temperature" einen Wert größer 20 haben:<br>
- <br>
- <code>[@"rooms$":temperature:$_ > 20]</code><br>
- <br>
- Liste der Devices im Raum "livingroom", die mit "rooms" enden und im Reading "temperature" einen Wert größer 20 haben:<br>
- <br>
- <code>[@"rooms$":temperature:$_ > 20 and $room eq "livingroom"]</code><br>
- <br>
- Liste der Devices in der Gruppe "windows", die mit "rooms" enden, deren Status (nicht state-Reading) "on" ist:<br>
- <br>
- <code>[@"rooms$"::$STATE eq "on" and $group eq "windows"]</code><br>
- <br>
- Liste der Devices, deren state-Reading "on" ist und das Attribut disable nicht auf "1" gesetzt ist:<br>
- <br>
- <code>[@"":state:$_ eq "on" and AttrVal($name,"disable","") ne "1"]</code><br>
- <br>
- <br>
- Aggregationsangaben in der DOIF-Bedingung reagieren zusätzlich auf Ereignistrigger, hier sollte die regex-Angabe für das Device um eine regex-Angabe für das zu triggernde Event erweitert werden.<br>
- <br>
- Anzahl der Devices, die mit "window" beginnen. Getriggert wird, wenn eine Eventzeile beginnend mit "window" und dem Wort "open" vorkommt:<br>
- <br>
- <code>[#"^window:open"]</code><br>
- <br>
- <u>Anwendungsbeispiele</u><br>
- <br>
- Statusanzeige: Offene Fenster:<br>
- <br>
- <code>define di_window DOIF<br>
- <br>
- attr di_window state Offene Fenster: [@"^window:open":state:"open","keine"]</code><br>
- <br>
- Statusanzeige: Alle Devices, deren Batterie nicht ok ist:<br>
- <br>
- <code>define di_battery DOIF<br>
- <br>
- attr di_battery state [@":battery":battery:$_ ne "ok","alle OK"]</code><br>
- <br>
- Statusanzeige: Durchschnittstemperatur aller Temperatursensoren in der Gruppe "rooms":<br>
- <br>
- <code>define di_average_temp DOIF<br>
- <br>
- attr di_average_temp state [#average:d2:":temperature":temperature:$group eq "rooms"]</code><br>
- <br>
- Fenster Status/Meldung:<br>
- <br>
- <code>define di_Fenster DOIF (["^Window:open"]) <br>
- (push "Fenster $DEVICE wurde geöffnet. Es sind folgende Fenster offen: [@"^Window":state:"open"]")<br>
- DOELSEIF ([#"^Window:closed":state:"open"] == 0)<br>
- (push "alle Fenster geschlossen")</code><br>
- <br>
- attr di_Fenster do always<br>
- attr di_Fenster cmdState $DEVICE zuletzt geöffnet|alle geschlossen</code><br>
- <br>
- Raumtemperatur-Überwachung:<br>
- <br>
- <code>define di_temp DOIF (([08:00] or [20:00]) and [?#"^Rooms":temperature: $_ < 20] != 0)<br>
- (push "In folgenden Zimmern ist zu kalt [@"^Rooms":temperature:$_ < 20,"keine"]")<br>
- DOELSE<br>
- (push "alle Zimmmer sind warm")<br>
- <br>
- attr di_temp do always<br>
- attr di_Raumtemp state In folgenden Zimmern ist zu kalt: [@"^Rooms":temperature:$_ < 20,"keine"])</code><br>
- <br>
- Es soll beim Öffnen eines Fensters eine Meldung über alle geöffneten Fenster erfolgen:<br>
- <br>
- <code>define di_Fenster DOIF (["^Window:open"]) (push "Folgende Fenster: [@"^Window:state:"open"] sind geöffnet")</code><br>
- <br>
- attr di_Fenster do always<br>
- <br>
- Wenn im Wohnzimmer eine Lampe ausgeschaltet wird, sollen alle anderen Lampen im Wohnzimmer ebenfalls ausgeschaltet werden, die noch an sind:<br>
- <br>
- <code>define di_lamp DOIF (["^lamp_livingroom: off"]) (set [@"^lamp_livingroom":state:"on","defaultdummy"] off)<br>
- <br>
- attr di_lamp DOIF do always</code><br>
- <br>
- Mit der Angabe des Default-Wertes "defaultdummy", wird verhindert, dass der set-Befehl eine Fehlermeldung liefert, wenn die Device-Liste leer ist. Der angegebene Default-Dummy muss zuvor definiert werden.<br>
- <br>
- Für reine Perlangaben gibt es eine entsprechende Perlfunktion namens <code>AggrDoIf(<function>,<regex Device>,<reading>,<condition>,<default>)</code> diese liefert bei der Angabe @ ein Array statt einer Stringliste, dadurch lässt sie sich gut bei foreach-Schleifen verwenden.<br>
- <br>
- <u>Beispiele</u><br>
- <br>
- <code>define di_Fenster DOIF (["^Window:open"]) {foreach (AggrDoIf('@','^windows','state','"open"')) {Log3 "di_Fenster",3,"Das Fenster $_ ist noch offen"}}</code><br>
- <br>
- <code>define di_Temperature DOIF (["^room:temperature"]) {foreach (AggrDoIf('@','^room','temperature','$_ < 15')) {Log3 "di_Temperatur",3,"im Zimmer $_ ist zu kalt"}}</code><br>
- <br>
- <a name="DOIF_Zeitsteuerung"></a>
- <b>Zeitsteuerung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Zeitangaben in der Bedingung im Format: <code>[HH:MM:SS]</code> oder <code>[HH:MM]</code> oder <code>[Zahl]</code><br>
- <br>
- <u>Anwendungsbeispiele</u>:<br>
- <br>
- Einschalten um 8:00 Uhr, ausschalten um 10:00 Uhr.<br>
- <br>
- <code>define di_light DOIF ([08:00]) (set switch on) DOELSEIF ([10:00]) (set switch off)</code><br>
- <br>
- Zeitsteuerung mit mehreren Zeitschaltpunkten:<br>
- <br>
- <code>define di_light DOIF ([08:00] or [10:00] or [20:00]) (set switch on) DOELSEIF ([09:00] or [11:00] or [00:00]) (set switch off)</code><br>
- <br>
- Zeitangaben können ebenfalls in Sekunden angegeben werden. Es handelt sich dann um Sekundenangaben nach Mitternacht, hier also um 01:00 Uhr:<br>
- <br>
- <code>define di_light DOIF ([3600]) (set lamp on)</code><br>
- <br>
- <a name="DOIF_Relative_Zeitangaben"></a>
- <b>Relative Zeitangaben</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Zeitangaben, die mit Pluszeichen beginnen, werden relativ behandelt, d. h. die angegebene Zeit wird zum aktuellen Zeitpunkt hinzuaddiert.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Automatisches Speichern der Konfiguration im Stundentakt:<br>
- <br>
- <code>define di_save DOIF ([+01:00]) (save)<br>
- attr di_save do always</code><br>
- <br>
- Ebenfalls lassen sich relative Angaben in Sekunden angeben. Das obige Beispiel entspricht:<br>
- <br>
- <code>define di_save DOIF ([+3600]) (save)</code><br>
- <br>
- <a name="DOIF_Zeitangaben_nach_Zeitraster_ausgerichtet"></a>
- <b>Zeitangaben nach Zeitraster ausgerichtet</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Das Format lautet: [:MM] MM sind Minutenangaben zwischen 00 und 59.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Viertelstunden-Gong<br>
- <br>
- <code>define di_gong DOIF ([:00])<br>
- <ol>({system ("mplayer /opt/fhem/Sound/BigBen_00.mp3 -volume 90 −really−quiet &")})</ol>
- DOELSEIF ([:15])<br>
- <ol>({system ("mplayer /opt/fhem/Sound/BigBen_15.mp3 -volume 90 −really−quiet &")})</ol>
- DOELSEIF ([:30])<br>
- <ol>({system ("mplayer /opt/fhem/Sound/BigBen_30.mp3 -volume 90 −really−quiet &")})</ol>
- DOELSEIF ([:45])<br>
- <ol>({system ("mplayer /opt/fhem/Sound/BigBen_45.mp3 -volume 90 −really−quiet &")})</ol></code>
- <br>
- <a name="DOIF_Relative_Zeitangaben_nach_Zeitraster_ausgerichtet"></a>
- <b>Relative Zeitangaben nach Zeitraster ausgerichtet</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Das Format lautet: [+:MM] MM sind Minutenangaben zwischen 1 und 59.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Gong alle fünfzehn Minuten um XX:00 XX:15 XX:30 XX:45<br>
- <br>
- <code>define di_gong DOIF ([+:15]) (set Gong_mp3 playTone 1)<br>
- attr di_gong do always</code><br>
- <br>
- <a name="DOIF_Zeitangaben_nach_Zeitraster_ausgerichtet_alle_X_Stunden"></a>
- <b>Zeitangaben nach Zeitraster ausgerichtet alle X Stunden</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Format: [+[h]:MM] mit: h sind Stundenangaben zwischen 2 und 23 und MM Minuten zwischen 00 und 59<br>
- <br>
- <u>Anwendungsbeispiel</u>: Es soll immer fünf Minuten nach einer vollen Stunde alle 2 Stunden eine Pumpe eingeschaltet werden, die Schaltzeiten sind 00:05, 02:05, 04:05 usw.<br>
- <br>
- <code>define di_gong DOIF ([+[2]:05]) (set pump on-for-timer 300)<br>
- attr di_gong do always</code><br>
- <br>
- <a name="DOIF_Wochentagsteuerung"></a>
- <b>Wochentagsteuerung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Hinter der Zeitangabe kann ein oder mehrere Wochentage getrennt mit einem Pipezeichen | angegeben werden. Die Syntax lautet:<br>
- <br>
- <code>[<time>|012345678]</code> 0-8 entspricht: 0-Sonntag, 1-Montag, ... bis 6-Samstag sowie 7 für Wochenende und Feiertage (entspricht $we) und 8 für Arbeitstage (entspricht !$we)<br>
- <br>
- alternativ mit Buchstaben-Kürzeln:<br>
- <br>
- <code>[<time>|So Mo Di Mi Do Fr Sa WE AT]</code> WE entspricht der Ziffer 7 und AT der Ziffer 8<br>
- <br>
- <a name="DOIF_weekdays"></a>
- Mit Hilfe des Attributes <code>weekdays</code> können beliebige Wochentagbezeichnungen definiert werden. Die Syntax lautet:<br>
- <br>
- <code>weekdays <Bezeichnung für Sonntag>,<Bezeichnung für Montag>,...,<Bezeichnung für Wochenende>,<Bezeichnung für Arbeitstage></code><br>
- <br>
- Beispiel: <code>di_mydoif attr weekdays Son,Mon,Die,Mit,Don,Fre,Sam,Wochenende,Arbeitstag</code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Radio soll am Wochenende und an Feiertagen um 08:30 Uhr eingeschaltet und um 09:30 Uhr ausgeschaltet werden. Am Montag und Mittwoch soll das Radio um 06:30 Uhr eingeschaltet und um 07:30 Uhr ausgeschaltet werden. Hier mit englischen Bezeichnern:<br>
- <br>
- <code>define di_radio DOIF ([06:30|Mo We] or [08:30|WE]) (set radio on) DOELSEIF ([07:30|Mo We] or [09:30|WE]) (set radio off)</code><br>
- <br>
- <code>attr di_radio weekdays Su,Mo,Tu,We,Th,Fr,Sa,WE,WD</code><br>
- <br>
- Bemerkung: Es ist unerheblich wie die definierten Wochenttagbezeichner beim Timer angegeben werden. Sie können mit beliebigen Trennzeichen oder ohne Trennzeichen direkt aneinander angegeben werden.<br>
- <br>
- Anstatt einer direkten Wochentagangabe, kann ein Status oder Reading in eckigen Klammern angegeben werden. Dieser muss zum Triggerzeitpunkt mit der gewünschten Angabe für Wochentage, wie oben definiert, belegt sein.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Der Wochentag soll über einen Dummy bestimmt werden.<br>
- <br>
- <code>define dummy myweekday<br>
- set myweekday monday wednesday thursday weekend<br>
- <br>
- define di_radio DOIF ([06:30|[myweekday]]) (set radio on) DOELSEIF ([07:30|[myweekday]]) (set radio off)<br>
- <br>
- attr di_radio weekdays sunday,monday,thuesday,wednesday,thursday,friday,saturday,weekend,workdays</code><br>
- <br>
- <a name="DOIF_Zeitsteuerung_mit_Zeitintervallen"></a>
- <b>Zeitsteuerung mit Zeitintervallen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Zeitintervalle werden im Format angegeben: <code>[<begin>-<end>]</code>,
- für <code><begin></code> bzw. <code><end></code> wird das gleiche Zeitformat verwendet,
- wie bei einzelnen Zeitangaben. Getriggert wird das Modul zum Zeitpunkt <code><begin></code> und zum Zeitpunkt <code><end></code>.
- Soll ein Zeitintervall ohne Zeittrigger lediglich zur Abfrage dienen, so muss hinter der eckigen Klammer ein Fragezeichen angegeben werden (siehe Beispiele weiter unten).
- Das Zeitintervall ist als logischer Ausdruck ab dem Zeitpunkt <code><begin></code> wahr und ab dem Zeitpunkt <code><end></code> nicht mehr wahr.<br>
- <br>
- <u>Anwendungsbeispiele</u>:<br>
- <br>
- Radio soll zwischen 8:00 und 10:00 Uhr an sein:<br>
- <br>
- <code>define di_radio DOIF ([08:00-10:00]) (set radio on) DOELSE (set radio off) </code><br>
- <br>
- mit mehreren Zeitintervallen:<br>
- <br>
- <code>define di_radio DOIF ([08:00-10:00] or [20:00-22:00]) (set radio on) DOELSE (set radio off) </code><br>
- <br>
- Radio soll nur sonntags (0) eingeschaltet werden:<br>
- <br>
- <code>define di_radio DOIF ([08:00-10:00|0]) (set radio on) DOELSE (set radio off) </code><br>
- <br>
- Nur montags, mittwochs und freitags:<br>
- <br>
- <code>define di_radio DOIF ([08:00-10:00|135]) (set radio on) DOELSE (set radio off) </code><br>
- <br>
- Nur am Wochenende bzw. an Feiertagen lt. holiday-Datei (7 entspricht $we):<br>
- <br>
- <code>define di_radio DOIF ([08:00-10:00|7]) (set radio on) DOELSE (set radio off) </code><br>
- <br>
- Zeitintervalle über Mitternacht:<br>
- <br>
- <code>define di_light DOIF ([22:00-07:00]) (set light on) DOELSE (set light off) </code><br>
- <br>
- in Verbindung mit Wochentagen (einschalten am Freitag ausschalten am Folgetag):<br>
- <br>
- <code>define di_light DOIF ([22:00-07:00|5]) (set light on) DOELSE (set light off) </code><br>
- <br>
- Zeitintervalle über mehrere Tage müssen als Zeitpunkte angegeben werden.<br>
- <br>
- Einschalten am Freitag ausschalten am Montag:<br>
- <br>
- <code>define di_light DOIF ([22:00|5]) (set light on) DOELSEIF ([10:00|1]) (set light off) </code><br>
- <br>
- Schalten mit Zeitfunktionen, hier: bei Sonnenaufgang und Sonnenuntergang:<br>
- <br>
- <code>define di_light DOIF ([+{sunrise_rel(900,"06:00","08:00")}]) (set outdoorlight off) DOELSEIF ([+{sunset_rel(900,"17:00","21:00")}]) (set outdoorlight on)</code><br>
- <br>
- <a name="DOIF_Indirekten_Zeitangaben"></a>
- <b>Indirekten Zeitangaben</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Oft möchte man keine festen Zeiten im Modul angeben, sondern Zeiten, die man z. B. über Dummys über die Weboberfläche verändern kann.
- Statt fester Zeitangaben können Status, Readings oder Internals angegeben werden. Diese müssen eine Zeitangabe im Format HH:MM oder HH:MM:SS oder eine Zahl beinhalten.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Lampe soll zu einer bestimmten Zeit eingeschaltet werden. Die Zeit soll über den Dummy <code>time</code> einstellbar sein:<br>
- <br>
- <code>define time dummy<br>
- set time 08:00<br>
- define di_time DOIF ([[time]])(set lamp on)<br>
- attr di_time do always</code><br>
- <br>
- Die indirekte Angabe kann ebenfalls mit einer Zeitfunktion belegt werden. Z. B. <br>
- <br>
- <code>set time {sunset()}</code><br>
- <br>
- Das Dummy kann auch mit einer Sekundenzahl belegt werden, oder als relative Zeit angegeben werden, hier z. B. schalten alle 300 Sekunden:<br>
- <br>
- <code>define time dummy<br>
- set time 300<br>
- define di_time DOIF ([+[time]])(save)</code><br>
- <br>
- Ebenfalls funktionieren indirekte Zeitangaben mit Zeitintervallen. Hier wird die Ein- und Ausschaltzeit jeweils über einen Dummy bestimmt:<br>
- <br>
- <code>define begin dummy<br>
- set begin 08:00<br>
- <br>
- define end dummy<br>
- set end 10:00<br>
- <br>
- define di_time DOIF ([[begin]-[end]]) (set radio on) DOELSE (set radio off)</code><br>
- <br>
- Indirekte Zeitangaben können auch als Übergabeparameter für Zeitfunktionen, wie z. B. sunset oder sunrise übergeben werden:<br>
- <br>
- <code>define di_time DOIF ([{sunrise(0,"[begin]","09:00")}-{sunset(0,"18:00","[end]")}]) (set lamp off) DOELSE (set lamp on) </code><br>
- <br>
- Bei einer Änderung des angegebenen Status oder Readings wird die geänderte Zeit sofort im Modul aktualisiert.<br>
- <br>
- Angabe eines Readings als Zeitangabe. Beispiel: Schalten anhand eines Twilight-Readings:<br>
- <br>
- <code>define di_time DOIF ([[myTwilight:ss_weather]])(set lamp on)</code><br>
- <br>
- Dynamische Änderung einer Zeitangabe.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Die Endzeit soll abhängig von der Beginnzeit mit Hilfe einer eigenen Perl-Funktion, hier: <code>OffTime()</code>, bestimmt werden. <code>begin</code> und <code>end</code> sind Dummys, wie oben definiert:<br>
- <br>
- <code>define di_time DOIF ([[begin]-[end]]) (set lamp on, set end {(OffTime("[begin]"))}) DOELSE (set lamp off)</code><br>
- <br>
- Indirekte Zeitangaben lassen sich mit Wochentagangaben kombinieren, z. B.:<br>
- <br>
- <code>define di_time DOIF ([[begin]-[end]|7]) (set radio on) DOELSE (set radio off)</code><br>
- <br>
- <a name="DOIF_Zeitsteuerung_mit_Zeitberechnung"></a>
- <b>Zeitsteuerung mit Zeitberechnung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Zeitberechnungen werden innerhalb der eckigen Klammern zusätzlich in runde Klammern gesetzt. Die berechneten Triggerzeiten können absolut oder relativ mit einem Pluszeichen vor den runden Klammern angegeben werden.
- Es können beliebige Ausdrücke der Form HH:MM und Angaben in Sekunden als ganze Zahl in Perl-Rechenoperationen kombiniert werden.
- Perlfunktionen, wie z. B. sunset(), die eine Zeitangabe in HH:MM liefern, werden in geschweifte Klammern gesetzt.
- Zeiten im Format HH:MM bzw. Status oder Readings, die Zeitangaben in dieser Form beinhalten werden in eckige Klammern gesetzt.<br>
- <br>
- <u>Anwendungsbeispiele</u>:<br>
- <br>
- Lampe wird nach Sonnenuntergang zwischen 900 und 1500 (900+600) Sekunden zufällig zeitverzögert eingeschaltet. Ausgeschaltet wird die Lampe nach 23:00 Uhr um bis zu 600 Sekunden zufällig verzögert:<br>
- <br>
- <code>define di_light DOIF ([({sunset()}+900+int(rand(600)))])<br>
- <ol>(set lamp on)</ol>
- DOELSEIF ([([23:00]+int(rand(600)))])<br>
- <ol>(set lamp off) </ol></code>
- <br>
- Zeitberechnung können ebenfalls in Zeitintervallen genutzt werden.<br>
- <br>
- Licht soll eine Stunde vor gegebener Zeit eingeschaltet werden und eine Stunde danach wieder ausgehen:<br>
- <br>
- <code>define Fixtime dummy<br>
- set Fixtime 20:00<br>
- <br>
- define di_light DOIF ([([Fixtime]-[01:00]) - ([Fixtime]+[01:00])])<br>
- <ol>(set lampe on)</ol>
- DOELSE<br>
- <ol>(set lampe off)</ol>
- </code>
- <br>
- Hier das Gleiche wie oben, zusätzlich mit Zufallsverzögerung von 300 Sekunden und nur an Wochenenden:<br>
- <br>
- <code>define di_light DOIF ([([Fixtime]-[01:00]-int(rand(300))) - ([Fixtime]+[01:00]+int(rand(300)))]|7])<br>
- <ol>(set lampe on)</ol>
- DOELSE<br>
- <ol>(set lampe off)</ol>
- </code>
- <br>
- Ein Änderung des Dummys Fixtime z. B. durch "set Fixtime ...", führt zur sofortiger Neuberechnung der Timer im DOIF-Modul.<br>
- <br>
- Für die Zeitberechnung wird der Perlinterpreter benutzt, daher sind für die Berechnung der Zeit keine Grenzen gesetzt.<br>
- <br>
- <a name="DOIF_Kombination_von_Ereignis_und_Zeitsteuerung_mit_logischen_Abfragen"></a>
- <b>Kombination von Ereignis- und Zeitsteuerung mit logischen Abfragen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- <u>Anwendungsbeispiel</u>: Lampe soll ab 6:00 Uhr angehen, wenn es dunkel ist und wieder ausgehen, wenn es hell wird, spätestens aber um 9:00 Uhr:<br>
- <br>
- <code>define di_lamp DOIF ([06:00-09:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)</code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Rollläden sollen an Arbeitstagen nach 6:25 Uhr hochfahren, wenn es hell wird, am Wochenende erst um 9:00 Uhr, herunter sollen sie wieder, wenn es dunkel wird:<br>
- <br>
- <code>define di_shutters DOIF ([sensor:brightness]>100 and [06:25-09:00|8] or [09:00|7]) (set shutters up) DOELSEIF ([sensor:brightness]<50) (set shutters down)</code><br>
- <br>
- <a name="DOIF_Zeitintervalle_Readings_und_Status_ohne_Trigger"></a>
- <b>Zeitintervalle, Readings und Status ohne Trigger</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Angaben in eckigen Klammern, die mit einem Fragezeichen beginnen, führen zu keiner Triggerung des Moduls, sie dienen lediglich der Abfrage.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Licht soll zwischen 06:00 und 10:00 angehen, getriggert wird nur durch den Taster nicht um 06:00 bzw. 10:00 Uhr und nicht durch das Device Home<br>
- <br>
- <code>define di_motion DOIF ([?06:00-10:00] and [button] and [?Home] eq "present")(set lamp on-for-timer 600)<br>
- attr di_motion do always</code><br>
- <br>
- <a name="DOIF_Nutzung_von_Readings_Status_oder_Internals_im_Ausfuehrungsteil"></a>
- <b>Nutzung von Readings, Status oder Internals im Ausführungsteil</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- <u>Anwendungsbeispiel</u>: Wenn ein Taster betätigt wird, soll Lampe1 mit dem aktuellen Zustand der Lampe2 geschaltet werden:<br>
- <br>
- <code>define di_button DOIF ([button]) (set lamp1 [lamp2])<br>
- attr di_button do always</code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Benachrichtigung beim Auslösen eines Alarms durch Öffnen eines Fensters:<br>
- <br>
- <code>define di_pushmsg DOIF ([window] eq "open" and [alarm] eq "armed") (set Pushover msg 'alarm' 'open windows [window:LastDevice]' '' 2 'persistent' 30 3600)</code><br>
- <br>
- <a name="DOIF_Berechnungen_im_Ausfuehrungsteil"></a>
- <b>Berechnungen im Ausführungsteil</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Berechnungen können in geschweiften Klammern erfolgen. Aus Kompatibilitätsgründen, muss die Berechnung unmittelbar mit einer runden Klammer beginnen.
- Innerhalb der Perlberechnung können Readings, Status oder Internals wie gewohnt in eckigen Klammern angegeben werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Es soll ein Vorgabewert aus zwei verschiedenen Readings ermittelt werden und an das set Kommando übergeben werden:<br>
- <br>
- <code>define di_average DOIF ([08:00]) (set TH_Modul desired {([default:temperature]+[outdoor:temperature])/2})<br>
- attr di_average do always</code><br>
- <br>
- <a name="DOIF_notexist"></a>
- <b>Ersatzwert für nicht existierende Readings oder Status</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Es kommt immer wieder vor, dass in der Definition des DOIF-Moduls angegebene Readings oder Status zur Laufzeit nicht existieren. Der Wert ist dann leer.
- Bei der Definition von Status oder Readings kann für diesen Fall ein Vorgabewert oder sogar eine Perlberechnung am Ende des Ausdrucks kommagetrennt angegeben werden.<br>
- <br>
- Syntax:<br>
- <br>
- <code>[<device>,<default value>]</code><br>
- oder <br>
- <code>[<device>:<reading>,<default value>]</code><br>
- <br>
- Beispiele:<br>
- <br>
- <code>
- [lamp,"off"]<br>
- [room:temperatur,20]<br>
- [brightness,3*[myvalue]+2]<br>
- [heating,AttrVal("mydevice","myattr","")]<br>
- [[mytime,"10:00"]]<br>
- </code><br>
- Möchte man stattdessen einen bestimmten Wert global für das gesamte Modul definieren,
- so lässt sich das über das Attribut <code>notexist</code> bewerkstelligen. Ein angegebener Default-Wert beim Status oder beim Reading übersteuert das "notexist"-Attribut.<br>
- <br>
- Syntax: <code>attr <DOIF-module> notexist "<default value>"</code> <br>
- <br>
- <a name="DOIF_wait"></a>
- <b>Verzögerungen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Verzögerungen für die Ausführung von Kommandos werden pro Befehlsfolge über das Attribut "wait" definiert. Syntax:<br>
- <br>
- <code>attr <DOIF-module> wait <Sekunden für Befehlsfolge des ersten DO-Falls>:<Sekunden für Befehlsfolge des zweiten DO-Falls>:...<br></code>
- <br>
- Sollen Verzögerungen innerhalb von Befehlsfolgen stattfinden, so müssen diese Kommandos in eigene Klammern gesetzt werden, das Modul arbeitet dann mit Zwischenzuständen.<br>
- <br>
- Beispiel: Bei einer Befehlssequenz, hier: <code>(set lamp1 on, set lamp2 on)</code>, soll vor dem Schalten von <code>lamp2</code> eine Verzögerung von einer Sekunde stattfinden.
- Die Befehlsfolge muss zunächst mit Hilfe von Klammerblöcke in eine Befehlssequenz aufgespalten werden: <code>(set lamp1 on)(set lamp2 on)</code>.
- Nun kann mit dem wait-Attribut nicht nur für den Beginn der Sequenz, sondern für jeden Klammerblock eine Verzögerung, getrennt mit Komma, definieren werden,
- hier also: <code>wait 0,1</code>. Damit wird <code>lamp1</code> sofort, <code>lamp2</code> eine Sekunde danach geschaltet. Die Verzögerungszeit bezieht sich immer auf den vorherigen Befehl.<br>
- <br>
- Beispieldefinition bei mehreren DO-Blöcken mit Befehlssequenzen:<br>
- <br>
- <code>DOIF (Bedingung1)<br>
- (set ...) ## erster Befehl der ersten Sequenz soll um eine Sekunde verzögert werden<br>
- (set ...) ## zweiter Befehl der ersten Sequenz soll um 2 Sekunden nach dem ersten Befehl verzögert werden<br>
- DOELSEIF (Bedingung2)<br>
- (set ...) ## erster Befehl der zweiten Sequenz soll um 3 Sekunden verzögert werden<br>
- (set ...) ## zweiter Befehl der zweiten Sequenz soll um 0,5 Sekunden nach dem ersten Befehl verzögert werden<br>
- <br>
- attr <DOIF-module> wait 1,2:3,0.5</code><br>
- <br>
- Das Aufspalten einer kommagetrennten Befehlskette in eine Befehlssequenz, wie im obigen Beispiel, sollte nicht vorgenommen werden, wenn keine Verzögerungen zwischen den Befehlen benötigt werden.
- Denn bei einer Befehlssequenz werden Zwischenzustände cmd1_1, cmd1_2 usw. generiert, die Events erzeugen und damit unnötig FHEM-Zeit kosten.<br>
- <br>
- Für Kommandos, die nicht verzögert werden sollen, werden Sekundenangaben ausgelassen oder auf Null gesetzt. Die Verzögerungen werden nur auf Events angewandt und nicht auf Zeitsteuerung. Eine bereits ausgelöste Verzögerung wird zurückgesetzt, wenn während der Wartezeit ein Kommando eines anderen DO-Falls, ausgelöst durch ein neues Ereignis, ausgeführt werden soll.<br>
- <br>
- Statt Sekundenangaben können ebenfalls Status, Readings in eckigen Klammern, Perl-Funktionen sowie Perl-Berechnung angegeben werden. Dabei werden die Trennzeichen Komma und Doppelpunkt in Klammern geschützt und gelten dort nicht als Trennzeichen.
- Diese Angaben können ebenfalls bei folgenden Attributen gemacht werden: cmdpause, repeatcmd, repeatsame, waitsame, waitdel<br>
- <br>
- Beispiel:<br>
- <br>
- <code>attr my_doif wait 1:[mydummy:state]*3:rand(600)+100,Attr("mydevice","myattr","")</code><br>
- <br>
- <a name="DOIF_timerWithWait"></a>
- <br>
- <b>Verzögerungen von Timern</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Verzögerungen können mit Hilfe des Attributs <code>timerWithWait</code> auf Timer ausgeweitet werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Lampe soll zufällig nach Sonnenuntergang verzögert werden.<br>
- <br>
- <code>define di_rand_sunset DOIF ([{sunset()}])(set lamp on)<br>
- attr di_rand_sunset wait rand(1200)<br>
- attr di_rand_sunset timerWithWait 1<br>
- attr di_rand_sunset do always</code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Benachrichtigung "Waschmaschine fertig", wenn Verbrauch mindestens 5 Minuten unter 2 Watt (Perl-Code wird in geschweifte Klammern gesetzt):<br>
- <br>
- <code>define di_washer DOIF ([power:watt]<2) ({system("wmail washer finished")})<br>
- attr di_washer wait 300</code><br>
- <br>
- Eine erneute Benachrichtigung wird erst wieder ausgelöst, wenn zwischendurch der Verbrauch über 2 Watt angestiegen war.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Rollladen um 20 Minuten zeitverzögert bei Sonne runter- bzw. hochfahren (wenn der Zustand der Sonne wechselt, wird die Verzögerungszeit zurückgesetzt):<br>
- <br>
- <code>define di_shutters DOIF ([Sun] eq "on") (set shutters down) DOELSE (set shutters up) <br>
- attr di_shutters wait 1200:1200</code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Beschattungssteuerung abhängig von der Temperatur. Der Rollladen soll runter von 11:00 Uhr bis Sonnenuntergang, wenn die Temperatur über 26 Grad ist. Temperaturschwankungen um 26 Grad werden mit Hilfe des wait-Attributes durch eine 15 minutige Verzögerung ausgeglichen. <br>
- <br>
- <code>define di_shutters DOIF ([sensor:temperature] > 26 and [11:00-{sunset_abs()}] (set shutters down) DOELSE (set shutters up)<br>
- attr di_shutters wait 900:900 </code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Belüftung in Kombination mit einem Lichtschalter mit Nachlaufsteuerung. Der Lüfter soll angehen, wenn das Licht mindestens 2 Minuten lang brennt oder die Luftfeuchtigkeit 65 % überschreitet, der Lüfter soll ausgehen, drei Minuten nachdem die Luftfeuchtigkeit unter 60 % fällt und das Licht aus ist bzw. das Licht ausgeht und die Luftfeuchtigkeit unter 60% ist. Definitionen lassen sich über die Weboberfläche (DEF-Eingabebereich) übersichtlich gestalten:<br>
- <br>
- <code>define di_fan DOIF ([light] eq "on")<br>
- <ol>
- (set fan on)<br>
- </ol>
- DOELSEIF ([sensor:humidity]>65)<br>
- <ol>
- (set fan on)<br>
- </ol>
- DOELSEIF ([light] eq "off" and [sensor:humidity]<60)<br> <ol>
- (set fan off)<br>
- </ol>
- <br>
- attr di_fan wait 120:0:180</code><br>
- <br>
- <a name="DOIF_do_resetwait"></a>
- <b>Zurücksetzen des Waittimers für das gleiche Kommando</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Im Gegensatz zu <code>do always</code> wird ein Waittimer mit dem Attribut <code>do resetwait</code> auch dann zurückgesetzt, wenn die gleiche Bedingung wiederholt wahr wird.<br>
- Damit können Ereignisse ausgelöst werden, wenn etwas innerhalb einer Zeitspanne nicht passiert.<br>
- Das Attribut <code>do resetwait</code> impliziert eine beliebige Wiederholung wie <code>do always</code>. Diese lässt sich allerdings mit dem Attribut <code>repeatsame</code> einschränken s. u.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Meldung beim Ausbleiben eines Events<br>
- <br>
- <code>define di_push DOIF ([Tempsensor])(set pushmsg "sensor failed again")<br>
- attr di_push wait 1800<br>
- attr di_push do resetwait</code><br>
- <br>
- <a name="DOIF_repeatcmd"></a>
- <b>Wiederholung von Befehlsausführung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Wiederholungen der Ausführung von Kommandos werden pro Befehlsfolge über das Attribut "repeatcmd" definiert. Syntax:<br>
- <br>
- <code>attr <DOIF-modul> repeatcmd <Sekunden für Befehlsfolge des ersten DO-Falls>:<Sekunden für Befehlsfolge des zweiten DO-Falls>:...<br></code>
- <br>
- Statt Sekundenangaben können ebenfalls Status in eckigen Klammen oder Perlbefehle angegeben werden.<br>
- <br>
- Die Wiederholung findet so lange statt, bis der Zustand des Moduls in einen anderen DO-Fall wechselt.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Nach dem Eintreffen des Ereignisses wird die push-Meldung stündlich wiederholt, bis Frost ungleich "on" ist.<br>
- <br>
- <code>define di_push DOIF ([frost] eq "on")(set pushmsg "danger of frost")<br>
- attr di_push repeatcmd 3600</code><br>
- <br>
- Eine Begrenzung der Wiederholungen kann mit dem Attribut repeatsame vorgenommen werden<br>
- <code>attr di_push repeatsame 3</code><br>
- <br>
- Ebenso lässt sich das repeatcmd-Attribut mit Zeitangaben kombinieren.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Wiederholung ab einem Zeitpunkt<br>
- <br>
- <code>define di_alarm_clock DOIF ([08:00])(set alarm_clock on)<br>
- attr di_alarm_clock repeatcmd 300<br>
- attr di_alarm_clock repeatsame 3<br>
- attr di_alarm_clock do always</code><br>
- <br>
- Ab 8:00 Uhr wird 3 mal der Weckton jeweils nach 5 Minuten wiederholt.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Warmwasserzirkulation<br>
- <br>
- <code>define di_pump_circ DOIF ([05:00-22:00])(set pump on)(set pump off) DOELSE (set pump off)<br>
- attr di_pump_circ wait 0,300<br>
- attr di_pump_circ repeatcmd 3600</code><br>
- <br>
- Zwischen 5:00 und 22:00 Uhr läuft die Zirkulationspumpe alle 60 Minuten jeweils 5 Minuten lang.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Anwesenheitssimulation<br>
- <br>
- <code>define di_presence_simulation DOIF ([19:00-00:00])(set lamp on-for-timer {(int(rand(1800)+300))}) DOELSE (set lamp off)<br>
- attr di_presence_simulation repeatcmd rand(3600)+2200</code><br>
- <br>
- <br>
- <a name="DOIF_cmdpause"></a>
- <b>Zwangspause für das Ausführen eines Kommandos seit der letzten Zustandsänderung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit dem Attribut <code>cmdpause <Sekunden für cmd_1>:<Sekunden für cmd_2>:...</code> wird die Zeitspanne in Sekunden angegeben für eine Zwangspause seit der letzten Zustandsänderung.
- In der angegebenen Zeitspanne wird ein Kommando nicht ausgeführt, auch wenn die dazugehörige Bedingung wahr wird.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Meldung über Frostgefahr alle 60 Minuten<br>
- <br>
- <code>define di_frost DOIF ([outdoor:temperature] < 0) (set pushmsg "danger of frost")<br>
- attr di_frost cmdpause 3600<br>
- attr di_frost do always</code><br>
- <br>
- <a name="DOIF_repeatsame"></a>
- <b>Begrenzung von Wiederholungen eines Kommandos</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit dem Attribut <code>repeatsame <maximale Anzahl von cmd_1>:<maximale Anzahl von cmd_2>:...</code> wird die maximale Anzahl hintereinander folgenden Ausführungen festgelegt.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Die Meldung soll maximal dreimal erfolgen mit einer Pause von mindestens 10 Minuten <br>
- <br>
- <code>define di_washer DOIF ([Watt]<2) (set pushmeldung "washer finished")<br>
- attr di_washer repeatsame 3<br>
- attr di_washer cmdpause 600 </code><br>
- <br>
- Das Attribut <code>repeatsame</code> lässt sich mit <code>do always</code> oder <code>do resetwait</code> kombinieren.
- Wenn die maximale Anzahl für ein Kommando ausgelassen oder auf Null gesetzt wird, so gilt für dieses Kommando der Defaultwert "einmalige Wiederholung";
- in Kombination mit <code>do always</code> bzw. <code>do resetwait</code> gilt für dieses Kommando "beliebige Wiederholung".<br>
- <br>
- <u>Anwendungsbeispiel</u>: cmd_1 soll beliebig oft wiederholt werden, cmd_2 maximal zweimal<br>
- <br>
- <code>attr di_repeat repeatsame 0:2<br>
- attr di_repeat do always</code><br>
- <br>
- <a name="DOIF_waitsame"></a>
- <b>Ausführung eines Kommandos nach einer Wiederholung einer Bedingung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit dem Attribut <code>waitsame <Zeitspanne in Sekunden für cmd_1>:<Zeitspanne in Sekunden für das cmd_2>:...</code> wird ein Kommando erst dann ausgeführt, wenn innerhalb einer definierten Zeitspanne die entsprechende Bedingung zweimal hintereinander wahr wird.<br>
- Für Kommandos, für die <code>waitsame</code> nicht gelten soll, werden die entsprechenden Sekundenangaben ausgelassen oder auf Null gesetzt.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Rollladen soll hoch, wenn innerhalb einer Zeitspanne von 2 Sekunden ein Taster betätigt wird<br>
- <br>
- <code>define di_shuttersup DOIF ([Button])(set shutters up)<br>
- attr di_shuttersup waitsame 2<br>
- attr di_shuttersup do always</code><br>
- <br>
- <a name="DOIF_waitdel"></a>
- <b>Löschen des Waittimers nach einer Wiederholung einer Bedingung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Das Gegenstück zum <code>repeatsame</code>-Attribut ist das Attribut <code>waitdel</code>. Die Syntax mit Sekundenangaben pro Kommando entspricht der, des wait-Attributs. Im Gegensatz zum wait-Attribut, wird ein laufender Timer gelöscht, falls eine Bedingung wiederholt wahr wird.
- Sekundenangaben können pro Kommando ausgelassen oder auf Null gesetzt werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Rollladen soll herunter, wenn ein Taster innerhalb von zwei Sekunden nicht wiederholt wird<br>
- <br>
- <code>define di_shuttersdown DOIF ([Button])(set shutters down)<br>
- attr di_shuttersdown waitdel 2<br>
- attr di_shuttersdown do always</code><br>
- <br>
- "di_shuttersdown" kann nicht mit dem vorherigen Anwendungsbeispiel "di_shuttersup" innerhalb eines DOIF-Moduls kombiniert werden, da in beiden Fällen die gleiche Bedingung vorkommt.<br>
- <br>
- Die Attribute <code>wait</code> und <code>waitdel</code> lassen sich für verschiedene Kommandos kombinieren. Falls das Attribut für ein Kommando nicht gesetzt werden soll, kann die entsprechende Sekundenzahl ausgelassen oder eine Null angegeben werden.<br>
- <br>
- <u>Beispiel</u>: Für cmd_1 soll <code>wait</code> gelten, für cmd_2 <code>waitdel</code><br>
- <br>
- <code>attr di_cmd wait 2:0<br>
- attr di_cmd waitdel 0:2</code><br>
- <a name="DOIF_checkReadingEvent"></a>
- <br>
- <b>Readingauswertung nur beim Event des jeweiligen Readings</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Standardmäßig werden angegebene Readings ausgewertet, wenn irgendein Event des angegebenen Devices triggert.
- Möchte man gezielt nur dann ein angegebenes Reading auswerten, wenn sich nur dieses ändert, so lässt sich das mit dem Attribut <code>checkReadingEvent</code> einschränken.
- Das ist insb. dann interessant, wenn ein Modul verschiedene Readings zu unterschiedlichen Zeitpunkten aktualisiert.<br>
- <br>
- <u>Beispiel</u>:<br>
- <br>
- <code>define di_lamp DOIF ([mytwilight:light] < 3) (set lamp on) DOELSEIF ([mytwilight:light] > 3) (set lamp off)<br>
- attr di_lamp checkReadingEvent 1</code><br>
- <br>
- Bei der Angabe von indirekten Timern wird grundsätzlich intern <code>checkReadingEvent</code> benutzt:<br>
- <br>
- <code>define di_lamp ([[mytwilight:ss_weather]]) (set lamp on)<br>
- attr di_lamp do always</code><br>
- <br>
- Hier braucht das Attribut <code>checkReadingEvent</code> nicht explizit gesetzt werden.
- Die Zeit wird nur dann neu gesetzt, wenn sich tatsächlich das Reading ss_weather ändert.<br>
- <br>
- <a name="DOIF_addStateEvent"></a>
- <b>Eindeutige Statuserkennung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Bei Änderungen des Readings state wird in FHEM standardmäßig, im Gegensatz zu allen anderen Readings, der Readingname hier: "state: " im Event nicht vorangestellt.
- Möchte man eindeutig eine Statusänderung eines Moduls erkennen, so lässt sich das mit dem Attribut <code>addStateEvent</code> bewerksteligen.
- Bei Statusänderungen eines Devices wird bei der Angabe des Attributes <code>addStateEvent</code> im Event "state: " vorangestellt, darauf kann man dann gezielt im DOIF-Modul triggern.<br>
- <br>
- <u>Beispiel</u>:<br>
- <br>
- <code>define di_lamp ([FB:"^state: on$"]) (set lamp on)<br>
- attr di_lamp do always<br>
- attr di_lamp addStateEvent</code><br>
- <br>
- <a name="DOIF_selftrigger"></a>
- <b>Triggerung durch selbst ausgelöste Events</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Standardmäßig unterbindet das DOIF-Modul Selbsttriggerung. D. h. das Modul reagiert nicht auf Events, die es selbst direkt oder indirekt auslöst. Dadurch werden Endlosschleifen verhindert.
- Wenn das Attribut <code>selftrigger wait</code> gesetzt ist, kann das DOIF-Modul auf selbst ausgelöste Events reagieren. Dazu müssen die entsprchenden Kommandos mit wait verzögert werden.
- Bei der Angabe <code>selftrigger all</code> reagiert das Modul grundsätzlich alle selbst ausgelösten Trigger.<br>
- <br>
- Zu beachten ist, dass der Zustand des Moduls erst nach der Ausführung des Befehls gesetzt wird, dadurch wird die Zustandsverwaltung (ohne do always) ausgehebelt.
- Die Auswertung des eigenen Zustands z. B. über [$SELF:cmd] funktioniert dagegen korrekt, weil dieser immer bei der eigenen Triggerung bereits gesetzt ist.
- Bei der Verwendung des Attributes <code>selftrigger all</code> sollte beachtet werden, dass bereits in der zweiten Rekursion,
- wenn ein Befehl nicht durch wait verzögert wird, FHEM eine weitere Triggerung unterbindet, um Endlosschleifen zu verhindern.<br>
- <br>
- <a name="DOIF_timerevent"></a>
- <b>Setzen der Timer mit Event</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Wenn das Attribut <code>timerevent</code> ungleich Null gesetzt ist, wird beim Setzen der Timer im DOIF-Modul ein Event erzeugt. Das kann z. B. bei FHEM2FHEM nützlich sein, um die Timer-Readings zeitnah zu aktualisieren.<br>
- <br>
- <a name="DOIF_Zeitspanne_eines_Readings_seit_der_letzten_Aenderung"></a>
- <b>Zeitspanne eines Readings seit der letzten Änderung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Bei Readingangaben kann die Zeitspanne mit <code>[<Device>:<Reading>:sec]</code> in Sekunden seit der letzten Änderung bestimmt werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Licht soll angehen, wenn der Status des Bewegungsmelders in den letzten fünf Sekunden upgedatet wurde.<br>
- <br>
- <code>define di_lamp DOIF ([BM:state:sec] < 5) (set lamp on-for-timer 300)<br>
- attr di_lamp do always</code><br>
- <br>
- Bei HM-Bewegungsmelder werden periodisch Readings aktualisiert, dadurch wird das Modul getrigger, auch wenn keine Bewegung stattgefunden hat.
- Der Status bleibt dabei auf "motion". Mit der obigen Abfrage lässt sich feststellen, ob der Status aufgrund einer Bewegung tatsächlich upgedatet wurde.<br>
- <br>
- <a name="DOIF_checkall"></a>
- <b>Alle Bedingungen prüfen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Bei der Abarbeitung der Bedingungen, werden nur die Bedingungen überprüft,
- die zum ausgelösten Event das dazughörige Device bzw. die dazugehörige Triggerzeit beinhalten. Mit dem Attribut <b>checkall</b> lässt sich das Verhalten so verändern,
- dass bei einem Event-Trigger auch Bedingungen geprüft werden, die das triggernde Device nicht beinhalten.
- Folgende Parameter können angegeben werden:<br>
- <br>
- <code>checkall event</code> Es werden alle Bedingungen geprüft, wenn ein Event-Trigger auslöst.<br>
- <code>checkall timer</code> Es werden alle Bedingungen geprüft, wenn ein Timer-Trigger auslöst.<br>
- <code>checkall all </code> Es werden grundsätzlich alle Bedingungen geprüft.<br>
- <br>
- Zu beachten ist, dass bei einer wahren Bedingung die dazugehörigen Befehle ausgeführt werden und die Abarbeitung immer beendet wird -
- es wird also grundsätzlich immer nur ein Befehlszweig ausgeführt und niemals mehrere.<br>
- <br>
- <a name="DOIF_setList__readingList"></a>
- <b>Darstellungselement mit Eingabemöglichkeit im Frontend und Schaltfunktion</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Die unter <a href="#dummy">Dummy</a> beschriebenen Attribute <a href="#readingList">readingList</a> und <a href="#setList">setList</a> stehen auch im DOIF zur Verfügung. Damit wird erreicht, dass DOIF im WEB-Frontend als Eingabeelement mit Schaltfunktion dienen kann. Zusätzliche Dummys sind nicht mehr erforderlich. Es können im Attribut <a href="#setList">setList</a>, die in <a href="#FHEMWEB">FHEMWEB</a> angegebenen Modifier des Attributs <a href="#widgetOverride">widgetOverride</a> verwendet werden. Siehe auch das <a href="http://www.fhemwiki.de/wiki/DOIF/Ein-_und_Ausgabe_in_FHEMWEB_und_Tablet-UI_am_Beispiel_einer_Schaltuhr">weiterführende Beispiel für Tablet-UI</a>. Für die Verwendung moduleigener Readings ist die Funktionalität nicht gewährleistet, siehe <a href="#DOIF_Benutzerreadings">benutzerdefinierte Readings</a>.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Eine Schaltuhr mit time-Widget für die Ein- u. Ausschaltzeiten und der Möglichkeit über eine Auswahlliste manuell ein und aus zu schalten.<br>
- <br>
- <code>
- define time_switch DOIF (["$SELF:mybutton: on"] or [[$SELF:mybegin,"00:00"]])
- <ol>(set lamp on)</ol>
- DOELSEIF (["$SELF:mybutton: off"] or [[$SELF:myend,"00:00"]])
- <ol>(set lamp off)</ol>
- <br>
- attr time_switch cmdState on|off<br>
- attr time_switch readingList mybutton mybegin myend<br>
- attr time_switch setList mybutton:on,off mybegin:time myend:time<br>
- attr time_switch webCmd mybutton:mybegin:myend
- </code><br>
- <br>
- <u>Anwendungsbeispiel</u>: Ausführung von Befehlen abhängig einer Auswahl ohne Zusatzreading<br>
- <br>
- <code>define di_web DOIF ([$SELF:"myInput first"]) (do something) DOELSEIF ([$SELF:"myInput second"]) (do something else)<br>
- <br>
- attr di_web setList myInput:first,second</code><br>
- <br>
- <a name="DOIF_uiTable"></a>
- <b>uiTable, das User Interface</a></b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit dem Attribut uiTable kann innerhalb eines DOIF-Moduls ein User Interface in Form einer Tabelle erstellt werden. Die Definition der Tabelle wird mit Hilfe von Perl sowie FHEM-Widgets kombiniert mit DOIF-Syntax vorgenommen.<br>
- <br>
- Features:<br>
- <br>
- - pro DOIF eine beliebige UI-Tabelle definierbar<br>
- - alle FHEM-Widgets nutzbar<br>
- - alle FHEM-Icons nutzbar<br>
- - DOIF-Syntax verwendbar<br>
- - alle Devices und Readings in FHEM direkt darstellbar und ansprechbar<br>
- - dynamische Styles (z. B. Temperaturfarbe abhängig vom Temperaturwert)<br>
- - es brauchen keine eigenen CSS- oder js-Dateien definiert werden<br>
- - Nutzung vordefinierter Templates aus Template-Dateien<br>
- <br>
- <b>Aufbau des uiTable-Attributs<br></b>
- <br>
- <code>{<br>
- <Perlblock für Definition von Template-Attributen, Zellenformatierungen, eigenen Perlfunktionen><br>
- }<br>
- <br>
- <Template-Methoden><br>
- <br>
- <Tabellendefinition><br>
- <br></code>
- <br>
- Der Perlblock ist optional. Er wird in geschweiften Klammern mit wenigen Ausnahmen in Perl definiert. Hier können Template-Attribute für Zeichenketten, das Layout der Tabelle über HMTL-Zellenformatierungen sowie eigene Perlfunktionen definiert werden.
- Im Anschluß an den Perlblock können optional Template-Methoden definiert werden, um komplexere wiederverwendbare Widget-Definitionen zu formulieren. Diese werden in der Tabellendefinition benutzt.
- Die eigentliche Tabellendefinition wird über die Definition von Zellen vorgenommen. Zellen werden mit | voneinander abgegrenzt. Kommentare können an beliebiger Stelle beginnend mit ## bis zum Zeilenende eingefügt werden.<br>
- <br>
- <b>Die Tabellendefinition</b><br>
- <br><code>
- <Zellendefinition erste Zeile erste Spalte> | <Zellendefinition erste Zeile zweite Spalte | ... # Definition der ersten Tabellenzeile<br>
- <Zellendefinition zweite Zeile erste Spalte> | <Zellendefinition zweite Zeile zweite Spalte | ... # Definition der zweiten Tabellenzeile<br>
- usw.<br></code>
- <br>
- Endet eine Zeile mit |, so wird deren Definition in der nächsten Zeile fortgesetzt. Dadurch können längere Zeilendefinition einer Tabelle auf mehrerer Zeilen aufgeteilt werden.<br>
- <br>
- Eine Zellendefinition kann sein:<br>
- <br>
- 1) <code><Perlausdruck mit [DOIF-Syntax]><br></code>
- <br>
- 2) <code>STY(<Perlausdruck mit [DOIF-Syntax]>,<css-Style-Definition mit [DOIF-Syntax]>)<br></code>
- <br>
- 3) <code>WID([<DEVICE>:<READING>],<FHEM-Widget-Definition mit [DOIF-Syntax]>,"<set-/setreading-Kommando optional>")<br></code>
- <br>
- Die oberen Definitionen können innerhalb einer Zelle mit Punkt bzw. Komma beliebig kombiniert werden. Beim Punkt werden die Ausdrücke aneinandergereiht, bei Komma werden die Ausdrücke mit Zeilenumbruch untereinander innerhalb einer Zelle angeordnet.<br>
- <br>
- Zu 1)<br>
- <br>
- Diese Definition wird verwendet für: Texte, Inhalte von Readings oder Rechenausdrücke. Angaben, die die Zelle aktualisieren sollen, müssen in gewohnte DOIF-Syntax angegeben werden.
- <br>
- Beispiele:<br>
- <br>
- Einfacher Text: <br>
- <br>
- <code>"Status"<br></code>
- <br>
- Reading:<br>
- <br>
- <code>[outdoor:temperature]<br></code>
- <br>
- Berechnung:<br>
- <br>
- <code>([livingroom:temperature]+[kitchen:temperature])/2<br></code>
- <br>
- Perlfunktion:<br>
- <br>
- <code>min([livingroom:temperature],[ktichen:temperature])<br></code>
- <br>
- Mehrere Angaben einer Zelle können mit einem Punkt, wie auch in Perl bei Zeichenketten üblich, konkateniert werden:<br>
- <br>
- <code>"Temperature: ".[outdoor:temperatur]<br></code>
- <br>
- <code>"Die maximale Temperatur der Kinderzimmer beträgt: ".max([child1:temperature],[child2:temperature])<br></code>
- <br>
- Zu 2)<br>
- <br>
- Über die Funktion STY werden Angaben mit Formatierungen über das CSS-Style-Attribut vorgenommen.<br>
- <br>
- Beispiele:<br>
- <br>
- Formatierter Text:<br>
- <br>
- <code>STY("diningroom","font-weight:bold;font-size:16pt;color:#0000FF")<br></code>
- <br>
- Formatiertes Reading:<br>
- <br>
- <code>STY([fridge:temperature],"color:#0000FF")<br></code>
- <br>
- Formatiertes Reading mit dynamischer Farbgebung abhängig von der Temperatur<br>
- <br>
- <code>STY([basement:humidity],"color:".DOIF_hsv([basement:humidity],50,75,40,264,60,90))<br></code>
- <br>
- DOIF_hsv ist eine DOIF-Funktion, bei der man den Farbverlauf definieren kann.<br>
- <br>
- Syntax für die DOIF_hsv Funktion:<br>
- <br>
- <code>DOIF_hsv(<value>,<min_value>,<max_value>,<min_hsv>,<max_hsv>,<saturation>,<lightness>)<br></code>
- <br>
- Es wird durch eine feste Vorgabe von saturation und lightness, linear ein Farbton (Hue) für value errechnet, dabei entspricht min_value min_hsv und max_value max_hsv.<br>
- <br>
- Die gewünschten Werte für <min_hsv>,<max_hsv>,<saturation>,<lightness> können mit Hilfe eines Color-Pickers bestimmt werden.<br>
- <br>
- Weiterhin lässt sich ebenfalls jede andere Perlfunktion verwenden, die eine beliebige css-Style-Formatierung vornimmt.<br>
- <br>
- Zu 3)<br>
- <br>
- Über die Funktion WID werden FHEM-Widgets definiert. Es können alle in FHEM vorhanden FHEM-Widgets verwendet werden.<br>
- <br>
- Beispiele:<br>
- <br>
- Brennericon<br>
- <br>
- <code>WID([burner:state],"iconLabel,closed,sani_boiler_temp\@DarkOrange,open,sani_boiler_temp")<br></code>
- <br>
- Die Widget-Definition entspricht der FHEM-Widget-Syntax, siehe: <a href="https://wiki.fhem.de/wiki/FHEMWEB/Widgets">FHEMWEB-Widgets</a><br>
- <br>
- Thermostatdefinition mit Hilfe des knob-Widgets:<br>
- <br>
- <code>WID([TH_Bathroom_HM:desired-temp],"knob,min:17,max:25,width:45,height:40,step:0.5,fgColor:DarkOrange,bgcolor:grey,anglearc:270,angleOffset:225,cursor:10,thickness:.3","set")<br></code>
- <br>
- <b>Der Perlblock: Definition von Template-Attributen, Zellenformatierungen und Perl-Funktionen<br></b>
- <br>
- Im ersten Bereich werden sog. Template-Attribute als Variablen definiert, um wiederholende Zeichenketten in Kurzform anzugeben. Template-Attribute werden intern als hash-Variablen abgelegt. Die Syntax entspricht weitgehend der Perl-Syntax.<br>
- <br>
- Die Syntax lautet:<br>
- <br>
- <code>$TPL{<name>}=<Perlsyntax für Zeichenketten><br></code>
- <br>
- <code><name></code> ist beliebig wählbar. <br>
- <br>
- Bsp.<br>
- <code>$TPL{HKnob}="knob,min:17,max:25,width:45,height:40,step:0.5,fgColor:DarkOrange,bgcolor:grey,anglearc:270,angleOffset:225,cursor:10,thickness:.3";<br></code>
- <br>
- Damit würde die obige Beispiel-Definition des Thermostat-Widgets wie folgt aussehen:<br>
- <br>
- <code>WID([TH_Bad_HM:desired-temp],$TPL{HKnob},"set")<br></code>
- <br>
- Weiterhin können die Tabelle, einzelne Zellen-, Zeilen- oder Spaltenformatierungen definiert werden, dazu werden folgende Bezeichner benutzt:<br>
- <br>
- <code>$TABLE="<CSS-Attribute>"<br>
- $TD{<Zellenbereich für Zeilen>}{<Zellenbereich für Spalten>}="<CSS-Attribute der Zellen>"<br>
- $TC{<Zellenbereich für Spalten>}="<CSS-Attribute der Spalten>"<br>
- $TR{Zeilenbereich}="<CSS-Attribute der Zeilen>"<br></code>
- <br>
- mit <br>
- <br>
- <code><Zellen/Spalten/Zeilen-Bereich>: Zahl|kommagetrennte Aufzählung|Bereich von..bis<br></code>
- <br>
- Beispiele:<br>
- <code>
- $TABLE = "width:300px; height:300px; background-image:url(/fhem/www/pgm2/images/Grundriss.png); background-size: 300px 300px;";<br>
- $TD{0}{0} = "style='border-right-style:solid; border-right-width:10px'";<br>
- $TR{0} = "class='odd' style='font-weight:bold'";<br>
- $TC{1..5} = "align='center'";<br>
- $TC{1,3,5} = "align='center'";<br>
- $TC{last} = "style='font-weight:bold'";<br></code>
- <br>
- Es können ebenfalls beliebige Perl-Funktionen definiert werden, die innerhalb der Tabellendefinition genutzt werden können. Sie sollten mit FUNC_ beginnen. Damit wird sichergestellt, dass die Funktionen systemweit eindeutig sind.<br>
- <br>
- Bsp.<br>
- <br>
- Funktion für temperaturabhängige Farbgebung<br>
- <br>
- <code>
- sub FUNC_temp<br>
- {<br>
- my ($temp)=@_<br>
- return ("font-weight:bold;font-size:12pt;color:".DOIF_hsv ($temp,15,35,210,360,60,90));<br>
- }<br>
- <br></code>
- <b>Steuerungsattribute<br></b>
- <br>
- Ausblenden des Status in der Devicezeile:<br>
- <br>
- <code>$SHOWNOSTATE=1;</code><br>
- <br>
- Standardmäßig werden Texte innerhalb der Tabelle, die einem vorhandenen FHEM-Device entsprechen als Link zur Details-Ansicht dargestellt. Soll diese Funktionalität unterbunden werden, so kann man dies über folgendes Attribut unterbinden:<br>
- <br>
- <code>$SHOWNODEVICELINK=1;</code><br>
- <br>
- Die Gerätezeile wird ausgeblendet, wenn der "Reguläre Ausdruck" <regex room> zum Raumnamen passt, gilt nicht für den Raum <i>Everything</i>.<br>
- <br>
- <code>$SHOWNODEVICELINE = "<regex room>";</code><br>
- <br>
- Die Detailansicht wird umorganisiert, hilfreich beim Editieren längerer uiTable-Definitionen.<br>
- <br>
- <code>$ATTRIBUTESFIRST = 1;</code><br>
- <br>
- <b>Template-Methoden<br></b>
- <br>
- Bei Widgetdefinition, die mehrfach verwendet werden sollen, können Template-Methoden definiert werden. Die Definition beginnt mit dem Schlüsselwort <code>DEF</code>. Die Template_Methode muss mit <code>TPL_</code> beginnen.<br>
- <br>
- Syntax<br>
- <br>
- <code>DEF TPL_<name>(<Definition mit Platzhaltern $1,$2 usw.>)<br></code>
- <br>
- <code><name></code> ist beliebig wählbar.<br>
- <br>
- In der Tabellendefinition können die zuvor definierten Template-Methoden genutzt werden. Die Übergabeparameter werden an Stelle der Platzhalter $1, $2 usw. eingesetzt.<br>
- <br>
- Beispiel<br>
- <br>
- Template-Methoden-Definition:<br>
- <br>
- <code>DEF TPL_Thermostat(WID($1,$TPL{HKnob},"set"))<br></code>
- <br>
- Nutzung der Template-Methode in der Tabellendefinition:<br>
- <br>
- <code>
- "Bathroom" | TPL_Thermostat([TH_Bathroom_HM:desired-temp])<br>
- "Kitchen" | TPL_Thermostat([TH_Kitchen_HM:desired-temp])<br>
- "Livingroom" | TPL_Thermostat([TH_Livingroom_HM:desired-temp])<br></code>
- <br>
- <b>Import von Templates und Funktionen<br></b>
- <br>
- Mit Hilfe des Befehls IMPORT können Definitionen aus Dateien importiert werden. Damit kann der Perlblock sowie Template-Methoden in eine Datei ausgelagert werden. Der Aufbau der Datei entspricht dem des uiTable-Attributes. Tabellendefinitionen selbst können nicht importiert werden.
- Der IMPORT-Befehl kann vor dem Perlblock oder vor dem Tabellendefintionsbereich angegeben werden. Ebenso können mehrere IMPORT-Befehle angegeben werden. Gleiche Definitionen von Funktionen, Templates usw. aus einer IMPORT-Datei überlagern die zuvor definierten.
- Der IMPORT-Befehl kann ebenfalls innerhalb einer Import-Datei angegeben werden.<br>
- <br>
- Syntax<br>
- <br>
- <code>IMPORT <Pfad mit Dateinamen><br></code>
- <br>
- Bespiel:<br>
- <br>
- in uiTable<br>
- <br>
- <code>IMPORT /fhem/contrib/DOIF/mytemplates.tpl<br>
- <br>
- ## table definition<br>
- <br>
- "outdoor" | TPL_temp([outdoor:temperature])<br>
- <br></code>
- in mytemplates.tpl<br>
- <br>
- <code>## templates and functions<br>
- {<br>
- $TPL{unit}="°C";<br>
- sub FUNC_temp<br>
- {
- my ($temp)=@_;<br>
- return ("height:6px;font-weight:bold;font-size:16pt;color:".DOIF_hsv ($temp,-10,30,210,360,60,90));<br>
- }<br>
- }<br>
- <br>
- ## template methode<br>
- DEF TPL_temp(STY($1.$TPL{unit},FUNC_temp($1)))<br></code>
- <br>
- <br>
- <a name="DOIF_cmdState"></a>
- <b>Status des Moduls</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Der Status des Moduls wird standardmäßig mit cmd_1, cmd_2, usw., bzw. cmd1_1 cmd1_2 usw. für Befehlssequenzen belegt. Dieser lässt sich über das Attribut "cmdState" mit Komma bzw. | getrennt umdefinieren:<br>
- <br>
- attr <DOIF-modul> cmdState <Status für cmd1_1>,<Status für cmd1_2>,...| <Status für cmd2_1>,<Status für cmd2_2>,...|...<br>
- <br>
- Beispiele:<br>
- <br>
- <code>attr di_lamp cmdState on|off</code><br>
- <br>
- Pro Status können ebenfalls Status oder Readings in eckigen Klammern oder Perlfunktionen sowie Berechnungen in Klammern der Form {(...)} angegeben werden.<br>
- Die Trennzeichen Komma und | sind in Klammern und Anführungszeichen geschützt und gelten dort nicht als Trennzeichen.<br>
- <br>
- Zustände cmd1_1, cmd1 und cmd2 sollen wie folgt umdefiniert werden:<br>
- <br>
- <code>attr di_mytwilight cmdState [mytwilight:ss_astro], {([mytwilight:twilight_weather]*2+10)}|My attribut is: {(Attr("mydevice","myattr",""))}</code><br>
- <br>
- <a name="DOIF_Reine_Statusanzeige_ohne_Ausfuehrung_von_Befehlen"></a>
- <b>Reine Statusanzeige ohne Ausführung von Befehlen</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Der Ausführungsteil kann jeweils ausgelassen werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Aktuelle Außenfeuchtigkeit im Status<br>
- <br>
- <code>define di_hum DOIF ([outdoor:humidity]>70) DOELSEIF ([outdoor:humidity]>50) DOELSE<br>
- attr di_hum cmdState wet|normal|dry</code><br>
- <br>
- <a name="DOIF_state"></a>
- <b>Anpassung des Status mit Hilfe des Attributes <code>state</code></b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Es können beliebige Reading und Status oder Internals angegeben werden.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Aktuelle Außenfeuchtigkeit inkl. Klimazustand (Status des Moduls wurde mit cmdState definiert s. o.)<br>
- <br>
- <code>attr di_hum state The current humidity is [outdoor:humidity], it is [di_hum]</code><br>
- <br>
- Es können beim Attribut state ebenfalls Berechnungen in geschweiften Klammern durchgeführt werden. Aus Kompatibilitätsgründen, muss die Berechnung mit einer runden Klammer beginnen.<br>
- <br>
- <u>Anwendungsbeispiel</u>: Berechnung des Mittelwertes zweier Readings:<br>
- <br>
- <code>define di_average DOIF <br>
- attr di_average state Average of the two rooms is {([room1:temperature]+[room2:temperature])/2}</code><br>
- <br>
- Der Status wird automatisch aktualisiert, sobald sich eine der Temperaturen ändert<br>
- <br>
- Da man beliebige Perl-Ausdrücke verwenden kann, lässt sich z. B. der Mittelwert auf eine Stelle mit der Perlfunktion sprintf formatieren:<br>
- <br>
- <code>attr di_average state Average of the two rooms is {(sprintf("%.1f",([room1:temperature]+[room2:temperature])/2))}</code><br>
- <br>
- <a name="DOIF_Readings"></a>
- <b>Erzeugen berechneter Readings</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit Hilfe des Attributes DOIF_Readings können eigene Readings innerhalb des DOIF definiert werden, auf die man im selben DOIF-Moduls zugreifen kann.
- Die Nutzung ist insbesondere dann sinnvoll, wenn mehrfach die gleichen Berechnungen innerhalb eines DOIF-Modus vorgenommen werden sollen.
- DOIF_Readings-Berechnungen funktionieren ressourcenschonend ohne Erzeugung FHEM-Events nach außen. Änderungen dieser Readings triggern allerdings das eigene DOIF-Modul, wenn sich deren Inhalt ändert.<br>
- <br>
- Syntax<br>
- <br>
- <code>attr <DOIF-Modul> DOIF_Readings <readingname1>:<definiton>, <readingname2>:<definition>,...</code><br>
- <br>
- <code><definition></code>: Beliebiger Perlausdruck ergänzt um DOIF-Syntax in eckigen Klammern. Angaben in eckigen Klammern wirken triggernd und aktualisieren das definierte Reading.<br>
- <br>
- Beispiel: Push-Mitteilung über die durchschnittliche Temperatur aller Zimmer<br>
- <br>
- <code>define di_temp DOIF ([$SELF:temperature]>20) (push "Die Durchschnittstemperatur ist höher als 20 Grad, sie beträgt [$SELF:temperature]")<br>
- DOELSE<br>
- <br>
- attr di_temp DOIF_Readings temperature:[#average:d2:":temperature":temperature]<br></code>
- <br>
- Hierbei wird der aufwändig berechnete Durchschnittswert nur einmal berechnet, statt zwei mal, wenn man die Aggregationsfunktion direkt in der Bedingung und im Ausführungsteil angeben würde.<br>
- <br>
- Mit DOIF_Readings ist es ebenfalls möglich eine Wiederholung des Schaltens eines DOIF-Moduls mit do always zu provozieren und gleichzeitig zyklisch sendende Sensoren abzufragen.<br>
- <br>
- Beispiel<br>
- <br>
- <code>define heating DOIF ([switch] eq "on" and [$SELF:frost] eq "on") (set heating on) DOELSE (set heating off)<br>
- attr heating do always<br>
- attr heating DOIF_Readings frost:([outdoor:temperature] < 0 ? "on" : "off")</code><br>
- <br>
- Das Attribut do always ist in diesem Beispiel unkritisch, obwohl Temperatur zyklisch gesendet wird, da das Reading "frost" nur dann die Bedingung triggert, wenn sich dessen Inhalt ändert<br>
- <br>
- <a name="DOIF_initialize"></a>
- <b>Vorbelegung des Status mit Initialisierung nach dem Neustart mit dem Attribut <code>initialize</code></b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- <u>Anwendungsbeispiel</u>: Nach dem Neustart soll der Zustand von <code>di_lamp</code> mit "initialized" vorbelegt werden. Das Reading <code>cmd_nr</code> wird auf 0 gesetzt, damit wird ein Zustandswechsel provoziert, das Modul wird initialisiert - der nächste Trigger führt zum Ausführen eines Kommandos.<br>
- <br>
- <code>attr di_lamp intialize initialized</code><br>
- <br>
- Das ist insb. dann sinnvoll, wenn das System ohne Sicherung der Konfiguration (unvorhergesehen) beendet wurde und nach dem Neustart die zuletzt gespeicherten Zustände des Moduls nicht mit den tatsächlichen übereinstimmen.<br>
- <br>
- <a name="DOIF_startup"></a>
- <b>Ausführen von Befehlsketten beim Starten von FHEM</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Beim Hochfahren von FHEM lässt sich eine bestimme Aktion ausführen. Es kann dazu genutzt werden, um sofort nach dem Hochfahren des Systems einen definierten Zustand des Moduls zu erreichen.
- Dabei wird sichergestellt, dass die angegebenen Befehle erst dann ausgeführt werden, wenn FHEM komplett hochgefahren ist.<br>
- <br>
- Symtax:<br>
- <br>
- <code>attr <DOIF-Modul> startup <FHEM-Befehl oder Perl-Befehl in geschweiften Klammern mit DOIF-Syntax></code><br>
- <br>
- Die Syntax entspricht der eines DOIF-Ausführungsteils (runde Klammern brauchen nicht angegeben werden).<br>
- <br>
- Beispiele:<br>
- <br>
- <code>attr di_test startup set $SELF cmd_1</code><br>
- <code>attr di_test startup set $SELF checkall</code><br>
- <code>attr di_test startup sleep 60;set lamp1 off;set lamp2 off</code><br>
- <code>attr di_test startup {myfunction()},set lamp1 on,set lamp2 on</code><br>
- <br>
- <a name="DOIF_disable"></a>
- <b>Deaktivieren des Moduls</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Ein DOIF-Modul kann mit Hilfe des Attributes disable, deaktiviert werden. Dabei werden alle Timer und Readings des Moduls gelöscht.
- Soll das Modul nur vorübergehend deaktiviert werden, so kann das durch <code>set <DOIF-modul> disable</code> geschehen.
- <br>
- <br>
- <a name="DOIF_setBefehle"></a>
- <b>Set-Befehle</b><br>
- <br>
- <a name="DOIF_setcheckall"></a>
- <b>Überprüfung aller DOIF-Bedingungen mit Ausführung eines DOIF-Zweiges</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- mit dem set-Befehl <code>checkall</code> werden wie beim gleichnamigen Attribut alle DOIF-Bedingung überprüft, sobald eine Bedingung als wahr geprüft ist, wird das dazugehörige Kommando ausgeführt.
- Zu beachten ist, dass nur der erste wahre DOIF-Zweig ausgeführt wird und dass nur Zustandsabfragen sowie Zeitintervalle sinnvoll überprüft werden können.
- Ereignisabfragen sowie Zeitpunkt-Definitionen, sind zum Zeitpunkt der checkall-Abfrage normalerweise nicht wahr.<br>
- <br>
- Beispiel:<br>
- <br>
- <code>attr di_test startup set $SELF checkall</code><br>
- <br>
- <a name="DOIF_setdisable"></a>
- <b>Inaktivieren des Moduls</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- mit dem set-Befehl <code>disable</code> wird ein DOIF-Modul inaktiviert. Hierbei bleiben alle Timer aktiv, sie werden aktualisiert - das Modul bleibt im Takt, allerdings werden keine Befehle ausgeführt.
- Das Modul braucht mehr Rechenzeit, als wenn es komplett über das Attribut <code>disable</code> deaktiviert wird. Ein inaktiver Zustand bleibt nach dem Neustart erhalten.
- Ein inaktives Modul kann über set-Befehle <code>enable</code> bzw. <code>initialize</code> wieder aktiviert werden.<br>
- <br>
- <a name="DOIF_setenable"></a>
- <b>Aktivieren des Moduls</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- mit dem set-Befehl <code>enable</code> wird ein inaktives DOIF-Modul wieder aktiviert. Im Gegensatz zum set-Befehl <code>initialize</code> wird der letzte Zustand vor der Inaktivierung des Moduls wieder hergestellt.<br>
- <br>
- <a name="DOIF_Initialisieren_des_Moduls"></a>
- <b>Initialisieren des Moduls</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- mit dem set-Befehl <code>initialize</code> wird ein DOIF-Modul initialisiert. Ein inaktives DOIF-Modul wieder aktiviert.
- Im Gegensatz zum set-Befehl <code>enable</code> wird der letzte Zustand des Moduls gelöscht, damit wird ein Zustandswechsel herbeigeführt, der nächste Trigger führt zur Ausführung eines wahren DOIF-Zweiges.
- Diese Eigenschaft kann auch dazu genutzt werden, ein bereits aktives Modul zu initialisieren.<br>
- <br>
- <a name="DOIF_setcmd"></a>
- <b>Auführen von Befehlszweigen ohne Auswertung der Bedingung</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Mit <code>set <DOIF-modul> cmd_<nr></code> lässt sich ein Befehlszweig (cmd_1, cmd_2, usw.) bedingunglos ausführen.<br>
- <br>
- Der Befehl hat folgende Eigenschaften:<br>
- <br>
- 1) der set-Befehl übersteuert alle Attribute wie z. B. wait, do, usw.<br>
- 2) ein laufender Wait-Timer wird unterbrochen<br>
- 3) beim deaktivierten oder im Modus disable befindlichen Modul wird der set Befehl ignoriert<br>
- <br>
- <u>Anwendungsbeispiel</u>: Schaltbare Lampe über Fernbedienung und Webinterface<br>
- <br>
- <code>
- define di_lamp DOIF ([FB:"on"]) (set lamp on) DOELSEIF ([FB:"off"]) (set lamp off)<br>
- <br>
- attr di_lamp devStateIcon cmd_1:on:cmd_2 initialized|cmd_2:off:cmd_1<br>
- </code><br>
- Mit der Definition des Attributes <code>devStateIcon</code> führt das Anklicken des on/off-Lampensymbol zum Ausführen von <code>set di_lamp cmd_1</code> bzw. <code>set di_lamp cmd_2</code> und damit zum Schalten der Lampe.<br>
- <br>
- Wenn mit <code>cmdState</code> eigene Zuständsbezeichnungen definiert werden, so können diese ebenfalls per set-Befehl angegeben werden.<br>
- <br>
- <code>
- define di_lamp DOIF ([FB:"on"]) (set lamp on) DOELSEIF ([FB:"off"]) (set lamp off)<br>
- <br>
- attr di_lamp cmdState on|off<br>
- attr di_lamp setList on off<br>
- </code>
- <br>
- <code>set di_lamp on</code> entspricht hier <code>set di_lamp cmd_1</code> und <code>set di_lamp off set di_lamp cmd_2</code><br>
- Zusätzlich führt die Definition von <code>setList</code> zur Ausführung von <code>set di_lamp on/off</code> durch das Anlicken des Lampensymbols wie im vorherigen Beispiel.<br>
- <br>
- <br>
- <a name="DOIF_Weitere_Anwendungsbeispiele"></a>
- <b>Weitere Anwendungsbeispiele</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- Zweipunktregler a la THRESHOLD<br>
- <br>
- <code>define di_threshold DOIF ([sensor:temperature]<([$SELF:desired]-1))<br>
- (set heating on)<br>
- DOELSEIF ([sensor:temperature]>[$SELF:desired])<br>
- (set heating off)<br>
- <br>
- attr di_threshold cmdState on|off<br>
- attr di_threshold readingList desired<br>
- attr di_threshold setList desired:17,18,19,20,21,22<br>
- attr di_threshold webCmd desired<br>
- </code><br>
- Die Hysterese ist hier mit einem Grad vorgegeben. Die Vorwahltemperatur wird per Dropdown-Auswahl eingestellt.<br>
- <br>
- on-for-timer<br>
- <br>
- Die Nachbildung eines on-for-timers lässt sich wie folgt realisieren:<br>
- <br>
- <code>define di_on_for_timer ([detector:"motion"])<br>
- (set light on)<br>
- (set light off)<br>
- attr di_on_for_timer do resetwait<br>
- attr di_on_for_timer wait 0,30</code><br>
- <br>
- Hiermit wird das Licht bei Bewegung eingeschaltet. Dabei wird, solange es brennt, bei jeder Bewegung die Ausschaltzeit neu auf 30 Sekunden gesetzt, "set light on" wird dabei nicht unnötig wiederholt.<br>
- <br>
- Die Beispiele stellen nur eine kleine Auswahl von möglichen Problemlösungen dar. Da sowohl in der Bedingung (hier ist die komplette Perl-Syntax möglich), als auch im Ausführungsteil, keine Einschränkungen gegeben sind, sind die Möglichkeiten zur Lösung eigener Probleme mit Hilfe des Moduls sehr vielfältig.<br>
- <br>
- <a name="DOIF_Zu_beachten"></a>
- <b>Zu beachten</b> <a href="#DOIF_Inhaltsuebersicht">back</a><br>
- <br>
- In jeder Bedingung muss mindestens ein Trigger angegeben sein (Angaben in eckigen Klammern). Die entsprechenden DO-Fälle werden nur dann ausgewertet, wenn auch das entsprechende Event oder Zeit-Trigger ausgelöst wird.<br>
- <br>
- Zeitangaben der Art: <br>
- <br>
- <code>define di_light DOIF ([08:00] and [10:00]) (set switch on)</code><br>
- <br>
- sind nicht sinnvoll, da diese Bedingung nie wahr sein wird.<br>
- <br>
- Angaben, bei denen aufgrund der Definition kein Zustandswechsel erfolgen kann z. B.:<br>
- <br>
- <code>define di_light DOIF ([08:00]) (set switch on)<br>
- attr di_light do always</code><br>
- <br>
- müssen mit Attribut <code>do always</code> definiert werden, damit sie nicht nur einmal, sondern jedes mal (hier jeden Tag) ausgeführt werden.<br>
- <br>
- Bei Devices, die mit Zwischenzuständen arbeiten, insbesondere HM-Komponenten (Zwischenzustand: set_on, set_off), sollte die Definition möglichst genau formuliert werden, um unerwünschte Effekte zu vermeiden: <br>
- <br>
- statt:<br>
- <br>
- <code>define di_lamp DOIF ([HM_switch] eq "on") (set lamp on) DOELSE (set lamp off)</code><br>
- <br>
- konkreter spezifizieren:<br>
- <br>
- <code>define di_lamp DOIF ([HM_switch] eq "on") (set lamp on) DOELSEIF ([HM_switch] eq "off") (set lamp off)</code><br>
- <br>
- Namenskonvention: Da der Doppelpunkt bei Readingangaben als Trennzeichen gilt, darf er nicht im Namen des Devices vorkommen. In solchen Fällen bitte das Device umbenennen.<br>
- <br>
- Standardmäßig, ohne das Attribut <code>do always</code>, wird das Wiederholen desselben Kommmandos vom Modul unterbunden. Daher sollte nach Möglichkeit eine Problemlösung mit Hilfe eines und nicht mehrerer DOIF-Module realisiert werden, getreu dem Motto "wer die Lampe einschaltet, soll sie auch wieder ausschalten".
- Dadurch wird erreicht, dass unnötiges (wiederholendes) Schalten vom Modul unterbunden werden kann, ohne dass sich der Anwender selbst darum kümmern muss.<br>
- <br>
- Mehrere Bedingungen, die zur Ausführung gleicher Kommandos führen, sollten zusammengefasst werden. Dadurch wird ein unnötiges Schalten aufgrund verschiedener Zustände verhindert.<br>
- <br>
- Beispiel:<br>
- <br>
- <code>define di_lamp DOIF ([brightness] eq "off") (set lamp on) DOELSEIF ([19:00]) (set lamp on) DOELSE (set lamp off)</code><br>
- <br>
- Hier wird um 19:00 Uhr Lampe eingeschaltet, obwohl sie evtl. vorher schon durch das Ereignis brightness "off" eingeschaltet wurde.<br>
- <br>
- <code>define di_lamp DOIF ([brightness] eq "off" or [19:00]) (set lamp on) DOELSE (set lamp off)</code><br>
- <br>
- Hier passiert das nicht mehr, da die ursprünglichen Zustände cmd_1 und cmd_2 jetzt nur noch einen Zustand cmd_1 darstellen und dieser wird nicht wiederholt.<br>
- <br>
- <!-- Beginn der Kurzreferenz -->
- <a name="DOIF_Kurzreferenz"></a>
- <b>Kurzreferenz</b> <a href="#DOIF_Inhaltsuebersicht">back</a></br>
- <ul>
- ⟨⟩ kennzeichnet optionale Angaben
- </ul>
- </br>
- <u><a href="#DOIF">Definition</a></u>
- <ul>
- <dl>
- <dt> <code><b>define</b> <name> <b>DOIF </b>⟨<b>(</b><Bedingung><b>) </b>⟨⟨<b>(</b>⟨<Befehle>⟩<b>)</b>⟩ ⟨⟨⟨<b>DOELSEIF (</b><Bedingung><b>) </b>⟨<b>(</b>⟨<Befehle>⟩<b>)</b>⟩⟩ ... ⟩⟨<b>DOELSE </b>⟨<b>(</b>⟨<Befehle>⟩<b>)</b>⟩⟩⟩⟩⟩</code>
- </dt>
- <dd>Befehlstrennzeichen ist das Komma<code><b> (</b><Befehl><b>,</b> <Befehl>, ...<b>)</b></code>
- </dd>
- <dd>Befehlssequenzen werden in runde Klammern gesetzt <code><b>(</b><Befehlssequenz A><b>) (</b><Befehlssequenz B><b>) ...</b></code>
- </dd>
- <dd>Enthält ein Befehl Kommata, ist er zusätzlich in runde Klammern einzuschliessen <code><b>(</b><Befehlsteil a><b>, </b><Befehlsteil b> ... <b>)</b></code>
- </dd>
- <dd>Perl-Befehle <code><b>{</b><Perl-Befehl><b>}</b></code> sind in geschweifte Klammern einzuschliessen
- </dd>
- <dd>Jede <a href="#DOIF_Berechnungen_im_Ausfuehrungsteil">Berechnung</a> <code><b>{(</b><Berechnung><b>)</b>⟨<Berechnung>⟩<b>}</b></code> in einem Befehl ist in geschweifte Klammern einzuschliessen und muss mit einer geöffneten runden Klammer beginnen.
- </dd>
- </dl>
- </ul>
- </br>
- <u>Readings</u>
- <ul>
- <dl>
- <dt>Device</dt>
- <dd>Name des auslösenden Gerätes</dd>
- </br>
- <dt>cmd</dt>
- <dd>Nr. des letzten ausgeführten Befehls als Dezimalzahl oder 0 nach Initialisierung des DOIF, in der Form <Nr. des Befehlszweiges>⟨.<Nr. der Sequenz>⟩</dd>
- </br>
- <dt>cmd_event</dt>
- <dd>Angabe des auslösenden Ereignisses</dd>
- </br>
- <dt>cmd_nr</dt>
- <dd>Nr. des letzten ausgeführten Befehlszweiges</dd>
- </br>
- <dt>cmd_seqnr</dt>
- <dd>Nr. der letzten ausgeführten Befehlssequenz</dd>
- </br>
- <dt>e_<Device>_<Reading>|<Internal>|Events</dt>
- <dd>Bezeichner und Wert der auslösenden Geräte mit Readings, Internals oder Events</dd>
- </br>
- <dt>error</dt>
- <dd>Enthält Fehlermeldungen oder Rückgabewerte von Befehlen, siehe <a href="http://www.fhemwiki.de/wiki/DOIF/Tools_und_Fehlersuche#Besonderheit_des_Error-Reading">Besonderheit des Error-Reading</a></dd>
- </br>
- <dt>last_cmd</dt>
- <dd>letzter Status</dd>
- </br>
- <dt>matched_event_c<lfd. Nr. der Bedingung>_<lfd. Nr. des Events></dt>
- <dd>Wert, der mit dem Regulären Ausdruck übereinstimmt</dd>
- </br>
- <dt>mode</dt>
- <dd>der Modus, in dem sich DOIF befindet: <enabled|disabled|deactivated></dd>
- </br>
- <dt>state</dt>
- <dd>Status des DOIF nach Befehlsausführung, Voreinstellung: cmd_<Nr. des Befehlszweiges>⟨_<Nr. der Befehlssequenz>⟩</dd>
- </br>
- <dt>timer_<lfd. Nr.>_c<Nr. des Befehlszweiges></dt>
- <dd>verwendete Timer mit Angabe des nächsten Zeitpunktes</dd>
- </br>
- <dt>wait_timer</dt>
- <dd>Angabe des aktuellen Wait-Timers</dd>
- </br>
- <dt>warning</dt>
- <dd>Perl-Warnung bei der Auswertung einer Bedingung</dd>
- </br>
- <a name="DOIF_Benutzerreadings"></a>
- <dt><A-Z>_<readingname></dt>
- <dd>Readings, die mit einem Großbuchstaben und nachfolgendem Unterstrich beginnen, sind für User reserviert und werden auch zukünftig nicht vom Modul selbst benutzt.</dd>
- </dl>
- </br>
- </ul>
- <u>Operanden in der Bedingung und den Befehlen</u>
- <ul>
- <dl>
- <dt><a href="#DOIF_Ereignissteuerung">Status</a> <code><b>[</b><Device>⟨<b>,</b><Default>⟩<b>]</b></code></dt>
- <dd></dd>
- </br>
- <dt><a href="#DOIF_Ereignissteuerung">Readings</a> <code><b>[</b><Device><b>:</b><Reading>⟨<b>,</b><Default>⟩<b>]</b></code></dt>
- <dd></dd>
- </br>
- <dt><a href="#DOIF_Ereignissteuerung">Internals</a> <code><b>[</b><Device><b>:&</b><Internal>⟨<b>,</b><Default>⟩<b>]</b></code></dt>
- <dd></dd>
- </br>
- <dt><a href="#DOIF_Filtern_nach_Zahlen">Filtern allgemein</a> nach Ausdrücken mit Ausgabeformatierung: <code><b>[</b><Device>:<Reading>|<Internal>:"<Filter>"⟨:<Output>⟩⟨<b>,</b><Default>⟩<b>]</b></code></dt>
- </br>
- <dt><a href="#DOIF_Filtern_nach_Zahlen">Filtern einer Zahl</a> <code><b>[</b><Device><b>:</b><Reading><b>:d</b>⟨<b>,</b><Default>⟩<b>]</b></code></dt>
- </br>
- <dt><a href="#DOIF_Zeitspanne_eines_Readings_seit_der_letzten_Aenderung">Zeitspanne eines Readings seit der letzten Änderung</a> <code><b>[</b><Device><b>:</b><Reading><b>:sec</b>⟨<b>,</b><Default>⟩<b>]</b></code></dt>
- </br>
- <dt>$DEVICE</dt>
- <dd>für den Gerätenamen</dd>
- </br>
- <dt>$EVENT</dt>
- <dd>für das zugehörige Ereignis</dd>
- </br>
- <dt>$EVENTS</dt>
- <dd>für alle zugehörigen Ereignisse eines Triggers</dd>
- </br>
- <dt>$SELF</dt>
- <dd>für den Gerätenamen des DOIF</dd>
- </br>
- <dt><Perl-Funktionen></dt>
- <dd>vorhandene und selbsterstellte Perl-Funktionen</dd>
- </dl>
- </br>
- </ul>
- <u>Operanden in der Bedingung</u>
- <ul>
- <dl>
- <dt><a href="#DOIF_Ereignissteuerung_ueber_Auswertung_von_Events">Events</a> <code><b>[</b><Device><b>:"</b><Regex-Events>"<b>]</b></code> oder <code><b>["</b><Regex-Devices><b>:</b><Regex-Events><b>"]</b></code> oder <code><b>["</b><Regex-Devices><b>"</b>⟨<b>:"</b><Regex-Filter><b>"</b>⟩⟨<b>:</b><Output>⟩<b>,</b><Default><b>]</b></code></dt>
- <dd>für <code><Regex></code> gilt: <code><b>^</b><ist eindeutig><b>$</b></code>, <code><b>^</b><beginnt mit></code>, <code><endet mit><b>$</b></code>, <code><b>""</b></code> entspricht <code><b>".*"</b></code>, Regex-Filter ist mit <code><b>[^\:]*: (.*)</b></code> vorbelegt siehe auch <a target=blank href="https://wiki.selfhtml.org/wiki/Perl/Regul%C3%A4re_Ausdr%C3%BCcke">Reguläre Ausdrücke</a> und Events des Gerätes <a target=blank href="#global">global</a>
- </dd>
- </br>
- <dt><a href="#DOIF_Zeitsteuerung">Zeitpunkte</a> <code><b>[</b><time><b>]</b> </code></dt>
- <dd>als <code><b>[HH:MM]</b></code>, <code><b>[HH:MM:SS]</b></code> oder <code><b>[Zahl] </b></code> in Sekunden nach Mitternacht</dd>
- </br>
- <dt><a href="#DOIF_Zeitsteuerung_mit_Zeitintervallen">Zeitintervalle</a> <code><b>[</b><begin><b>-</b><end><b>]</b></code></dt>
- <dd>als <code><b>[HH:MM]</b></code>, <code><b>[HH:MM:SS]</b></code> oder <code><b>[Zahl]</b></code> in Sekunden nach Mitternacht</dd>
- </br>
- <dt><a href="#DOIF_Indirekten_Zeitangaben">indirekte Zeitangaben</a> <code><b>[[</b><indirekte Zeit><b>]]</b></code></dt>
- <dd>als <code><b>[HH:MM]</b></code>, <code><b>[HH:MM:SS]</b></code> oder <code><b>[Zahl]</b></code> in Sekunden nach Mitternacht, <code><indirekte Zeit></code> ist ein Status, Reading oder Internal</dd>
- </br>
- <dt><a href="#DOIF_Relative_Zeitangaben">relative Zeitangaben</a> <code><b>[+</b><time><b>]</b></code></dt>
- <dd>als <code><b>[HH:MM]</b></code>, <code><b>[HH:MM:SS]</b></code> oder <code><b>[Zahl]</b></code> in Sekunden</dd>
- </br>
- <dt><a href="#DOIF_Zeitangaben_nach_Zeitraster_ausgerichtet">ausgerichtete Zeitraster</a> <code><b>[:MM]</b></code></dt>
- <dd>in Minuten zwischen 00 und 59</dd>
- </br>
- <dt><a href="#DOIF_Relative_Zeitangaben_nach_Zeitraster_ausgerichtet">rel. Zeitraster ausgerichtet</a> <code><b>[+:MM]</b></code></dt>
- <dd>in Minuten zwischen 1 und 59</dd>
- </br>
- <dt><a href="#DOIF_Zeitangaben_nach_Zeitraster_ausgerichtet_alle_X_Stunden">rel. Zeitraster ausgerichtet alle X Stunden</a> <code><b>[+[h]:MM]</b></code></dt>
- <dd><b>MM</b> in Minuten zwischen 1 und 59, <b>h</b> in Stunden zwischen 2 und 23</dd>
- </br>
- <dt><a href="#DOIF_Wochentagsteuerung">Wochentagsteuerung</a> <code><b>[</b><time><b>|012345678]</b></code>, <code><b>[</b><begin><b>-</b><end><b>]</b><b>|012345678]</b></code></dt>
- <dd>Pipe, gefolgt von ein o. mehreren Ziffern. Bedeutung: 0 bis 6 für So. bis Sa., 7 für $we, Wochenende oder Feiertag, 8 für !$we, Werktags.</dd>
- </br>
- <dt><a href="#DOIF_Zeitsteuerung_mit_Zeitberechnung">berechnete Zeitangaben</a> <code><b>[(</b><Berechnung, gibt Zeit in Sekunden zurück, im Sinne von <a target=blank href="http://perldoc.perl.org/functions/time.html">time</a>><b>)]</b></code></dt>
- <dd>Berechnungen sind mit runden Klammern einzuschliessen. Perlfunktionen, die HH:MM zurückgeben sind mit geschweiften Klammern einzuschliessen.</dd>
- </br>
- <dt><a href="#DOIF_Zeitintervalle_Readings_und_Status_ohne_Trigger">Trigger verhindern</a> <code><b>[?</b><devicename><b>]</b></code>, <code><b>[?</b><devicename><b>:</b><readingname><b>]</b></code>, <code><b>[?</b><devicename><b>:&</b><internalname><b>]</b></code>, <code><b>[?</b><time specification><b>]</b></code></dt>
- <dd>Werden Status, Readings, Internals und Zeitangaben in der Bedingung mit einem Fragezeichen eingeleitet, triggern sie nicht.</dd>
- </br>
- <dt>$device, $event, $events</dt>
- <dd>Perl-Variablen mit der Bedeutung der Schlüsselworte $DEVICE, $EVENT, $EVENTS</dd>
- </br>
- <dt>$cmd</dt>
- <dd>Perl-Variablen mit der Bedeutung [$SELF:cmd]</dd>
- </br>
- <dt><Perl-Zeitvariablen></dt>
- <dd>Variablen für Zeit- und Datumsangaben, $sec, $min, $hour, $mday, $month, $year, $wday, $yday, $isdst, $week, $hms, $hm, $md, $ymd</dd>
- </dl>
- </br>
- </ul>
- <u>set-Befehle</u>
- <ul>
- <dl>
- <dt><a href="#DOIF_setcheckall">disable</a> <code><b> set </b><name><b> checkall</b></code></dt>
- <dd>Überprüfung aller DOIF-Bedingungen mit Ausführung eines wahren DOIF-Zweiges</dd>
- </br>
- <dt><a href="#DOIF_setdisable">disable</a> <code><b> set </b><name><b> disable</b></code></dt>
- <dd>blockiert die Befehlsausführung</dd>
- </br>
- <dt><a href="#DOIF_Initialisieren_des_Moduls">initialize</a> <code><b> set </b><name><b> initialize</b></code></dt>
- <dd>initialisiert das DOIF und aktiviert die Befehlsausführung</dd>
- </br>
- <dt><a href="#DOIF_setenable">enable</a> <code><b> set </b><name><b> enable</b></code></dt>
- <dd>aktiviert die Befehlsausführung, im Gegensatz zur obigen Initialisierung bleibt der letzte Zustand des Moduls erhalten</dd>
- </br>
- <dt><a href="#DOIF_setcmd">cmd_<nr></a> <code><b> set </b><name><b> cmd_<nr></b></code></dt>
- <dd>führt ohne Auswertung der Bedingung den Befehlszweig mit der Nummer <nr> aus</dd>
- </dl>
- </br>
- </ul>
- <a name="DOIF_getBefehle"></a>
- <u>get-Befehle</u>
- <ul>
- <dl>
- <dt><a name="HTML-Code von uiTable">html</a></dt>
- <dd>liefert HTML-Code einer definierten uiTable zurück.</dd>
- </dl>
- </br>
- </ul>
- <a name="DOIF_Attribute_kurz"></a>
- <u>Attribute</u>
- <ul>
- <dl>
- <dt><a href="#DOIF_wait">Verzögerungen</a> <code><b>attr</b> <name> <b>wait </b><timer_1_1><b>,</b><timer_1_2><b>,...:</b><timer_2_1><b>,</b><timer_2_2><b>,...:...</b></code></dt>
- <dd>Zeit in Sekunden als direkte Angabe oder Berechnung, ein Doppelpunkt trennt die Timer der Bedingungsweige, ein Komma die Timer der Befehlssequenzen eines Bedingungszweiges.</dd>
- </br>
- <dt><a href="#DOIF_timerWithWait">Verzögerung von Timern</a> <code><b>attr</b> <name> <b>timerWithWait</b></code></dt>
- <dd>erweitert <code>wait</code> auf Zeitangaben</dd>
- </br>
- <dt><a href="#DOIF_do_always">Befehlswiederholung zulassen</a> <code><b>attr</b> <name> <b>do always</b></code></dt>
- <dd>wiederholt den Ausführungsteil, wenn die selbe Bedingung wiederholt wahr wird.</dd>
- </br>
- <dt><a href="#DOIF_do_resetwait">Zurücksetzen des Waittimers bei Wiederholung</a> <code><b>attr</b> <name> <b>do resetwait</b></code></dt>
- <dd>setzt den Waittimer zurück, wenn die selbe Bedingung wiederholt wahr wird.</dd>
- </br>
- <dt><a href="#DOIF_repeatcmd">Befehle wiederholen</a> <code><b>attr</b> <name> <b>repeatcmd </b><timer Bedingungszweig 1><b>:</b><timer Bedingungszweig 2><b>:...</b></code></dt>
- <dd>Zeit in Sekunden als direkte Angabe oder Berechnung, nach der Befehle wiederholt werden.</dd>
- </br>
- <dt><a href="#DOIF_cmdpause">Pause für Wiederholung</a> <code><b>attr</b> <name> <b>cmdpause </b><Pause cmd_1><b>:</b><Pause cmd_2><b>:...</b></code></dt>
- <dd>Zeit in Sekunden als direkte Angabe oder Berechnung, blockiert die Befehlsausführung während der Pause.</dd>
- </br>
- <dt><a href="#DOIF_repeatsame">Begrenzung von Wiederholungen</a> <code><b>attr</b> <name> <b>repeatsame </b><maximale Anzahl von cmd_1><b>:</b><maximale Anzahl von cmd_2><b>:...</b></code></dt>
- <dd>Anzahl als direkte Angabe oder Berechnung, begrenzt die maximale Anzahl unmittelbar folgender Befehlsausführungen.</dd>
- </br>
- <dt><a href="#DOIF_waitsame">Warten auf Wiederholung</a> <code><b>attr</b> <name> <b>waitsame </b><Wartezeit cmd_1><b>:</b><Wartezeit cmd_2><b>:...</b></code></dt>
- <dd>Wartezeit in Sekunden als direkte Angabe oder Berechnung, für ein unmittelbar wiederholtes Zutreffen einer Bedingung.</dd>
- </br>
- <dt><a href="#DOIF_waitdel">Löschen des Waittimers</a> <code><b>attr</b> <name> <b>waitdel </b><timer_1_1><b>,</b><timer_1_2><b>,...:</b><timer_2_1><b>,</b><timer_2_2><b>,...:...</b></code></dt>
- <dd>Zeit in Sekunden als direkte Angabe oder Berechnung, ein laufender Timer wird gelöscht und die Befehle nicht ausgeführt, falls eine Bedingung vor Ablauf des Timers wiederholt wahr wird.</dd>
- </br>
- <dt><a href="#DOIF_checkReadingEvent">Auswertung von Readings auf passende Events beschränken</a> <code><b>attr</b> <name> <b>checkReadingEvent </b><<b>0</b>|<b>ungleich Null</b>></code></dt>
- <dd>ungleich Null aktiviert, 0 deaktiviert</dd>
- </br>
- <dt><a href="#DOIF_selftrigger">Selbsttriggerung</a> <code><b>attr</b> <name> <b>selftrigger </b><<b>wait</b>|<b>all</b>></code></dt>
- <dd>lässt die Triggerung des Gerätes durch sich selbst zu. <code>wait</code> zugelassen für verzögerte Befehle, <code>all</code> zugelassen auch für nicht durch wait verzögerte Befehle; es ist nur eine Rekusion möglich</dd>
- </br>
- <dt><a href="#DOIF_timerevent">Event beim Setzen eines Timers</a> <code><b>attr</b> <name> <b>timerevent </b><<b>0</b>|<b>ungleich Null</b>></code></dt>
- <dd>erzeugt beim Setzen eines Timers ein Event. ungleich Null aktiviert, 0 deaktiviert</dd>
- </br>
- <dt><a href="#DOIF_cmdState">Gerätestatus ersetzen</a> <code><b>attr</b> <name> <b>cmdState </b><Ersatz cmd_1_1><b>,</b>...<b>,</b><Ersatz cmd_1><b>|</b><Ersatz cmd_2_1><b>,</b>...<b>,</b><Ersatz cmd_2><b>|...</b></code></dt>
- <dd>ersetzt die Standartwerte des Gerätestatus als direkte Angabe oder Berechnung, die Ersatzstatus von Befehlssequenzen werden durch Kommata, die von Befehlszweigen durch Pipe Zeichen getrennt.</dd>
- </br>
- <dt><a href="#DOIF_state">dynamischer Status </a> <code><b>attr</b> <name> <b>state </b><content></code></dt>
- <dd><content> ist das Ergebnis eines Perl-Ausdrucks, DOIF-Syntax ([<device>:<reading>], usw.) triggert bei Event die Berechnung.</dd>
- </br>
- <dt><a href="#DOIF_Readings">Erzeugen berechneter Readings </a> <code><b>attr</b> <name> <b>DOIF_Readings </b><readingname_1><b>:</b><content_1><b>,</b><readingname_2><b>:</b><content_2> ...</code></dt>
- <dd><content_n> ist das Ergebnis von Perl-Ausdrücken, DOIF-Syntax ([<device>:<reading>], usw.) triggert bei Event die Berechnung.</dd>
- </br>
- <dt><a href="#DOIF_notexist">Ersatzwert für nicht existierende Readings oder Status</a> <code><b>attr</b> <name> <b>notexist </b>"<Ersatzwert>"</code></dt>
- <dd></dd>
- </br>
- <dt><a href="#DOIF_initialize">Status Initialisierung nach Neustart</a> <code><b>attr</b> <name> <b>intialize </b><Status nach Neustart></code></dt>
- <dd></dd>
- </br>
- <dt><a href="#DOIF_disable">Gerät vollständig deaktivieren</a> <code><b>attr</b> <name> <b>disable </b><<b>0</b>|<b>1</b>></code></dt>
- <dd>1 deaktiviert das Modul vollständig, 0 aktiviert es.</dd>
- </br>
- <dt><a href="#DOIF_checkall">Alle Bedingungen prüfen</a> <code><b>attr</b> <name> <b>checkall </b><<b>event</b>|<b>timer</b>|<b>all</b>></code></dt>
- <dd><code>event</code> Alle Bedingungen werden geprüft, wenn ein Event-Trigger (Ereignisauslöser) auslöst.<br>
- <code>timer</code> Alle Bedingungen werden geprüft, wenn ein Timer-Trigger (Zeitauslöser) auslöst.<br>
- <code>all </code> Alle Bedingungen werden geprüft.<br>
- Die Befehle nach der ersten wahren Bedingung werden ausgeführt.
- </dd>
- </br>
- <dt><a href="#DOIF_addStateEvent">Eindeutige Statuserkennung</a> <code><b>attr</b> <name> <b>addStateEvent </b><<b>0</b>|<b>ungleich Null</b>></code></dt>
- <dd>fügt einem Gerätestatus-Event "state:" hinzu. ungleich Null aktiviert, 0 deaktiviert, siehe auch <a href="#addStateEvent">addStateEvent</a></dd>
- </br>
- <dt><a href="#DOIF_setList__readingList">Readings, die mit set gesetzt werden können</a> <code><b>attr</b> <name> <b>readingList </b><Reading1> <Reading2> ...</code></dt>
- <dd>fügt zum set-Befehl direkt setzbare, durch Leerzeichen getrennte Readings hinzu. siehe auch <a href="#readingList">readingList</a></dd>
- </br>
- <dt><a href="#DOIF_setList__readingList">Readings mit Werteliste und optionaler Widgetangabe</a> <code><b>attr</b> <name> <b>setList </b><Reading1><b>:</b>⟨<Modifier1><b>,</b>⟩<Value1><b>,</b><Value2><b>,</b><...><b> </b><Reading2><b>:</b>⟨<Modifier2><b>,</b>⟩<Value1><b>,</b><Value2><b>,</b><...> ...</code></dt>
- <dd>fügt einem Reading einen optionalen Widgetmodifier und eine Werteliste (, getrennt) hinzu, siehe auch <a href="#setList">setList</a>, <a href="#widgetOverride">widgetOverride</a>, und <a href="#webCmd">webCmd</a></dd>
- <br>
- <dt><a href="#DOIF_uiTable">User Interface für DOIF</a> <code><b>attr</b> <name> <b>uiTable</b> ⟨<b>{</b><perl code (format specification, template specification, function definition, control variable, ...)><b>}\n</b>⟩<template file import, method definition, table definition></code></dt>
- <dd><u>format specification:</u></dd>
- <dd><code>$TABLE = "<CSS-Attribute>"</code> ergänzt das table-Elemente um CSS-Attribute.</dd>
- <dd><code>$TD{<rows>}{<columns>} = "<HTML Attribute>"</code> ergänzt td-Elemente um HTML-Attribute.</dd>
- <dd><code>$TR{<rows>} = "<HTML Attribute>"</code> ergänzt tr-Elemente um HTML-Attribute.</dd>
- <dd><code>$TC{<columns>} = "<HTML Attribute>"</code> ergänzt zu columns gehörende td-Elemente um HTML-Attribute.</dd>
- <dd><u>template specification:</u></dd>
- <dd><code>$TPL{<name>} = "<Zeichenkette>"</code> speichert ein Template.</dd>
- <dd><u>function definition:</u></dd>
- <dd><code>sub FUNC_<name> {<function BLOCK>}</code> definiert eine Funktion.</dd>
- <dd><u>control variables:</u></dd>
- <dd><code>$ATTRIBUTESFIRST = 1;</code> organisiert die Detailansicht um.</dd>
- <dd><code>$SHOWNOSTATE = 1;</code> blendet den Status in der Gerätezeile aus.</dd>
- <dd><code>$SHOWNODEVICELINE = "<regex room>";</code> blendet die Gerätezeile aus, wenn <regex room> zum Raumnamen passt, gilt nicht für den Raum <i>Everything</i>.</dd>
- <dd><code>$SHOWNODEVICELINK = 1;</code> schaltet das Ersetzen des Gerätenamen durch einen Link auf die Detailseite aus.</dd>
- <br>
- <dd><u>template file import:</u></dd>
- <dd><code>IMPORT <path with filename></code> importiert eine Templatedatei.</dd>
- <dd><u>method definition:</u></dd>
- <dd><code>DEF TPL_<name>(<definition with place holder $1,$2 usw.>)</code> erzeugt ein Methodentemplate zur wiederholten Nutzung in der Tabellendefinition.</dd>
- <dd><u>table definition:</u></dd>
- <dd>Schreiben die nachstehenden Elemente HTML-Code in die Tabellenzelle, so wird er interpretiert.</dd>
- <dd><code>↵</code> oder <code>↵↵</code> trennt Tabellenzeilen.</dd>
- <dd><code>|</code> oder <code>|↵</code> trennt Tabellenzellen.</dd>
- <dd><code>>↵</code> oder <code>,↵</code> sind zur Textstrukturierung zugelassen.</dd>
- <dd><code>WID([<device>:<reading>],"<widget modifier>"⟨,"<command>"⟩)</code> bindet ein Widget an <device>:<reading>, <command> steht für <i>set</i> oder <i>setreading</i>, siehe <a href="#widgetOverride"> widgetOverride </a> und <a href="https://wiki.fhem.de/wiki/FHEMWEB/Widgets"> FHEMWEB-Widgets </a></dd>
- <dd><code>STY(<content>,<CSS style attributes>)</code> schreibt den Inhalt von <content> in die Zelle und formatiert ihn mit <CSS style attributes>.</dd>
- <dd><code><content></code> schreibt den Inhalt von <content> in die Zelle.</dd>
- <dd><content> und <CSS style attributes> sind das Ergebnis von Perl-Ausdrücken. Enthalten sie DOIF-Syntax ([<device>:<reading>], usw.), werden sie dynamisch erzeugt.</dd>
- <dd><code>PUP(<DOIF-name to show interface table>, <iconname[@color number]>)</code></dd>
- <dd>gibt ein Link zum Öffnen eines Popup-Fensters zurück.</dd>
- <dd><DOIF-name to show interface table> Name des DOIF-Gerätes dessen Benutzerschnittstelle angezeigt werden soll.</dd>
- <dd><iconname[@color number]|string> gibt ein Icon an, wenn das Icon nicht verfügbar ist, wird <string> angezeigt.</dd>
- <br>
- <dt><a href="#readingFnAttributes">readingFnAttributes</a></dt>
- <dd></dd>
- </dl>
- <br>
- </ul>
- <a name="DOIF_PerlFunktionen_kurz"></a>
- <u>Perl-Funktionen</u>
- <ul>
- <dl>
- <dt><code>DOIF_hsv(<current value>, <lower value>, <upper value>, <lower HUE value>, <upper HUE value>, <saturation>, <lightness>)</code></dt>
- <dd>gibt eine im HSV-Raum interpolierte HTML Farbnummer zurück, mit Prefix <b>#</b></dd>
- <dd><current value> aktueller Wert, für den die Farbnummer erzeugt wird.</dd>
- <dd><lower value> unterer Wert, des Bereiches auf den die Farbnummer skaliert wird.</dd>
- <dd><upper value> oberer Wert, des Bereiches auf den die Farbnummer skaliert wird.</dd>
- <dd><lower HUE value> unterer HUE-Wert, der mit dem unteren Wert korrespondiert (0-360).</dd>
- <dd><upper HUE value> oberer HUE-Wert, der mit dem oberen Wert korrespondiert (0-360).</dd>
- <dd><saturation> Farbsättigung (0-100).</dd>
- <dd><lightness> Hellwert (0-100).</dd>
- <br>
- <dt><code>DOIF_rgb(<start color number>, <end color number>, <lower value>, <upper value>, <current value>)</code></dt>
- <dd>gibt eine linear interpolierte RGB Farbnummer zurück, abhängig vom Prefix der Start- o. Endfarbnummer mit oder ohne Prefix <b>#</b>.</dd>
- <dd><start color number> Startfarbnummer des Farbbereiches, mit oder ohne Prefix <b>#</b>.</dd>
- <dd><end color number> Endfarbnummer des Farbbereiches, mit oder ohne Prefix <b>#</b>.</dd>
- <dd><lower value> unterer Wert, des Bereiches auf den die Farbnummer skaliert wird.</dd>
- <dd><upper value> oberer Wert, des Bereiches auf den die Farbnummer skaliert wird.</dd>
- <dd><current value> aktueller Wert, für den die Farbnummer erzeugt wird.</dd>
- <br>
- <dt><code>FW_makeImage(<iconname[@color number]>)</code></dt>
- <dd>gibt HTML-Code zurück, der ein FHEM icon einbindet.</dd>
- <dd><color number> optionale Farbnummer in Großschreibung, mit oder ohne Prefix <b>#</b>.</dd>
- <dd>weitere Infos im Quelltext von 01_FHEMWEB.pm.</dd>
- </dl>
- </ul>
- <!-- Ende der Kurzreferenz -->
- </ul>
- <p><a name="DOIFtools"></a>
- <h3>DOIFtools</h3>
- <div class='langLinks'>[<a href='commandref.html#DOIFtools'>EN</a> DE]</div>
- <ul>
- DOIFtools stellt Funktionen zur Unterstützung von DOIF-Geräten bereit.<br>
- <br>
- <ul>
- <li>erstellen von readingsGroup Definitionen, zur Beschriftung von Frontendelementen.</li>
- <li>erstellen eines Debug-Logfiles, in dem mehrere DOIF und zugehörige Geräte geloggt werden.</li>
- <li>optionales DOIF-Listing bei jeder Status und Wait-Timer Aktualisierung im Debug-Logfile.</li>
- <li>Navigation zwischen den DOIF-Listings im Logfile, wenn es über DOIFtools geöffnet wird.</li>
- <li>erstellen von userReadings in DOIF-Geräten zur Anzeige des realen Datums bei Wochentag behafteten Timern.</li>
- <li>löschen von benutzerdefinierten Readings in DOIF-Definitionen über eine Mehrfachauswahl.</li>
- <li>löschen von Readings in anderen Geräten über eine Mehrfachauswahl, nicht <i>state</i>.</li>
- <li>erfassen statistischer Daten über Events.</li>
- <li>Begrenzung der Datenaufzeichnungsdauer.</li>
- <li>erstellen eines Statistikreports.</li>
- <li>Liste aller DOIF-Definitionen in <i>probably associated with</i>.</li>
- <li>Zugriff auf DOIFtools aus jeder DOIF-Definition über die Liste in <i>probably associated with</i>.</li>
- <li>Zugriff aus DOIFtools auf vorhandene DOIFtoolsLog-Logdateien.</li>
- <li>zeigt den Event Monitor in der Detailansicht von DOIFtools.</li>
- <li>ermöglicht den Zugriff auf den Event Monitor in der Detailansicht von DOIF.</li>
- <li>erzeugt DOIF-Operanden aus einer Event-Zeile des Event-Monitors.</li>
- <ul>
- <li>Ist der <b>Event-Monitor in DOIF</b> geöffnet, dann kann die Definition des <b>DOIF geändert</b> werden.</li>
- <li>Ist der <b>Event-Monitor in DOIFtools</b> geöffnet, dann kann die Definition eines <b>DOIF erzeugt</b> werden.</li>
- </ul>
- <li>prüfen der DOIF Definitionen mit Empfehlungen.</li>
- <li>erstellen von Shortcuts</li>
- <li>optionalen Menüeintrag erstellen</li>
- <li>Liste der laufenden Wait-Timer anzeigen</li>
- <li>skaliert Werte zu Farbnummern und RGB Werten zum Einfärben, z.B. von Icons.</li>
- </ul>
- <br>
- <b>Inhalt</b><br>
- <ul>
- <a href="#DOIFtoolsBedienungsanleitung">Bedienungsanleitung</a><br>
- <a href="#DOIFtoolsDefinition">Definition</a><br>
- <a href="#DOIFtoolsSet">Set-Befehl</a><br>
- <a href="#DOIFtoolsGet">Get-Befehl</a><br>
- <a href="#DOIFtoolsAttribute">Attribute</a><br>
- <a href="#DOIFtoolsReadings">Readings</a><br>
- <a href="#DOIFtoolsLinks">Links</a><br>
- </ul><br>
- <a name="DOIFtoolsBedienungsanleitung"></a>
- <b>Bedienungsanleitung</b>
- <br>
- <ul>
- Eine <a href="https://wiki.fhem.de/wiki/DOIFtools">Bedienungsanleitung für DOIFtools</a> gibt es im FHEM-Wiki.
- </ul>
- <br>
- <a name="DOIFtoolsDefinition"></a>
- <b>Definition</b>
- <br>
- <ul>
- <code>define <name> DOIFtools</code><br>
- Es ist nur eine Definition pro FHEM Installation möglich. Die Definition wird mit den vorhanden DOIF-Namen ergänzt, daher erscheinen alle DOIF-Geräte in der Liste <i>probably associated with</i>. Zusätzlich wird in jedem DOIF-Gerät in dieser Liste auf das DOIFtool verwiesen.<br>
- <br>
- <u>Definitionsvorschlag</u> zum Import mit <a href="https://wiki.fhem.de/wiki/DOIF/Import_von_Code_Snippets">Raw definition</a>:<br>
- <code>
- defmod DOIFtools DOIFtools<br>
- attr DOIFtools DOIFtoolsEventMonitorInDOIF 1<br>
- attr DOIFtools DOIFtoolsExecuteDefinition 1<br>
- attr DOIFtools DOIFtoolsExecuteSave 1<br>
- attr DOIFtools DOIFtoolsMenuEntry 1<br>
- attr DOIFtools DOIFtoolsMyShortcuts ##My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools<br>
- </code>
- </ul>
- <br>
- <a name="DOIFtoolsSet"></a>
- <b>Set</b>
- <br>
- <ul>
- <code>set <name> deleteReadingInTargetDOIF <readings to delete name></code><br>
- <b>deleteReadingInTargetDOIF</b> löscht die benutzerdefinierten Readings im Ziel-DOIF<br>
- <br>
- <code>set <name> targetDOIF <target name></code><br>
- <b>targetDOIF</b> vor dem Löschen der Readings muss das Ziel-DOIF gesetzt werden.<br>
- <br>
- <code>set <name> deleteReadingInTargetDevice <readings to delete name></code><br>
- <b>deleteReadingInTargetDevice</b> löscht sichtbare Readings, ausser <i>state</i> im Ziel-Gerät. Bitte den Gefahrenhinweis zum Befehl <a href="https://fhem.de/commandref_DE.html#deletereading">deletereading</a> beachten!<br>
- <br>
- <code>set <name> targetDevice <target name></code><br>
- <b>targetDevice</b> vor dem Löschen der Readings muss das Ziel-Gerät gesetzt werden.<br>
- <br>
- <code>set <name> sourceAttribute <readingList> </code><br>
- <b>sourceAttribute</b> vor dem Erstellen einer ReadingsGroup muss das Attribut gesetzt werden aus dem die Readings gelesen werden, um die ReadingsGroup zu erstellen und zu beschriften. <b>Default, readingsList</b><br>
- <br>
- <code>set <name> statisticsDeviceFilterRegex <regular expression as device filter></code><br>
- <b>statisticsDeviceFilterRegex</b> setzt einen Filter auf Gerätenamen, nur die gefilterten Geräte werden im Bericht ausgewertet. <b>Default, ".*"</b>.<br>
- <br>
- <code>set <name> statisticsTYPEs <List of TYPE used for statistics generation></code><br>
- <b>statisticsTYPEs</b> setzt eine Liste von TYPE für die Statistikdaten erfasst werden, bestehende Statistikdaten werden gelöscht. <b>Default, ""</b>.<br>
- <br>
- <code>set <name> statisticsShowRate_ge <integer value for event rate></code><br>
- <b>statisticsShowRate_ge</b> setzt eine Event-Rate, ab der ein Gerät in die Auswertung einbezogen wird. <b>Default, 0</b>.<br>
- <br>
- <code>set <name> specialLog <0|1></code><br>
- <b>specialLog</b> <b>1</b> DOIF-Listing bei Status und Wait-Timer Aktualisierung im Debug-Logfile. <b>Default, 0</b>.<br>
- <br>
- <code>set <name> doStatistics <enabled|disabled|deleted></code><br>
- <b>doStatistics</b><br>
-  <b>deleted</b> setzt die Statistik zurück und löscht alle <i>stat_</i> Readings.<br>
-  <b>disabled</b> pausiert die Statistikdatenerfassung.<br>
-  <b>enabled</b> startet die Statistikdatenerfassung.<br>
- <br>
- <code>set <name> recording_target_duration <hours></code><br>
- <b>recording_target_duration</b> gibt an wie lange Daten erfasst werden sollen. <b>Default, 0</b> die Dauer ist nicht begrenzt.<br>
- <br>
- </ul>
- <a name="DOIFtoolsGet"></a>
- <b>Get</b>
- <br>
- <ul>
- <code>get <name> DOIF_to_Log <DOIF names for logging></code><br>
- <b>DOIF_to_Log</b> erstellt eine FileLog-Definition, die für alle angegebenen DOIF-Definitionen loggt. Der <i>Reguläre Ausdruck</i> wird aus den, direkt in den DOIF-Greräte angegebenen und den wahrscheinlich verbundenen Geräten, ermittelt.<br>
- <br>
- <code>get <name> checkDOIF</code><br>
- <b>checkDOIF</b> führt eine einfache Syntaxprüfung durch und empfiehlt Änderungen.<br>
- <br>
- <code>get <name> readingsGroup_for <DOIF names to create readings groups></code><br>
- <b>readingsGroup_for</b> erstellt readingsGroup-Definitionen für die angegebenen DOIF-namen. <b>sourceAttribute</b> verweist auf das Attribut, dessen Readingsliste als Basis verwendet wird. Die Eingabeelemente im Frontend werden mit den Readingsnamen beschriftet.<br>
- <br>
- <code>get <name> userReading_nextTimer_for <DOIF names where to create real date timer readings></code><br>
- <b>userReading_nextTimer_for</b> erstellt userReadings-Attribute für Timer-Readings mit realem Datum für Timer, die mit Wochentagangaben angegeben sind, davon ausgenommen sind indirekte Wochentagsangaben.<br>
- <br>
- <code>get <name> statisticsReport </code><br>
- <b>statisticsReport</b> erstellt einen Bericht aus der laufenden Datenerfassung.<br><br>Die Statistik kann genutzt werden, um Geräte mit hohen Ereignisaufkommen zu erkennen. Bei einer hohen Rate, sollte im Interesse der Systemperformance geprüft werden, ob die <a href="https://wiki.fhem.de/wiki/Event">Events</a> eingeschränkt werden können. Werden keine Events eines Gerätes weiterverarbeitet, kann das Attribut <i>event-on-change-reading</i> auf <i>none</i> oder eine andere Zeichenfolge, die im Gerät nicht als Readingname vorkommt, gesetzt werden.<br>
- <br>
- <code>get <name> runningTimerInDOIF</code><br>
- <b>runningTimerInDOIF</b> zeigt eine Liste der laufenden Timer. Damit kann entschieden werden, ob bei einem Neustart wichtige Timer gelöscht werden und der Neustart ggf. verschoben werden sollte. Zeigt nachrichtlich das Ergebnis von blockinginfo an.<br>
- <br>
- <code>get <name> SetAttrIconForDOIF <DOIF names for setting the attribute icon to helper_doif></code><br>
- <b>SetAttrIconForDOIF</b> setzt für die ausgewählten DOIF das Attribut <i>icon</i> auf <i>helper_doif</i>.<br>
- <br>
- <code>get <name> linearColorGradient <start color number>,<end color number>,<minimal value>,<maximal value>,<step width></code><br>
- <b>linearColorGradient</b> erzeugt eine Tabelle mit linear abgestuften Farbnummern und RGB-Werten.<br>
- <start color number>, ist eine HTML-Farbnummer, Beispiel: #0000FF für Blau.<br>
- <end color number>, , ist eine HTML-Farbnummer, Beispiel: #FF0000 für Rot.<br>
- <minimal value>, der Minimalwert auf den die Startfarbnummer skaliert wird, Beispiel: 7.<br>
- <maximal value>, der Maximalwert auf den die Endfarbnummer skaliert wird, Beispiel: 30.<br>
- <step width>, für jeden Schritt wird ein Farbwert erzeugt, Beispiel: 0.5.
- <br>
- Beispiel: <code>get DOIFtools linearColorGradient #0000FF,#FF0000,7,30,0.5</code><br>
- <br>
- <code>get <name> modelColorGradient <minimal value>,<middle value>,<maximal value>,<step width>,<color model></code><br>
- <b>modelColorGradient</b> erzeugt eine Tabelle mit modellbedingt abgestuften Farbnummern und RGB-Werten, siehe FHEM-Wiki<a href="https://wiki.fhem.de/wiki/Color#Farbskala_mit_Color::pahColor"> Farbskala mit Color::pahColor </a><br>
- <minimal value>, der Minimalwert auf den die Startfarbnummer skaliert wird, Beispiel: 7.<br>
- <middle value>, der Mittenwert ist ein Fixpunkt zwischen Minimal- u. Maximalwert, Beispiel: 20.<br>
- <maximal value>, der Maximalwert auf den die Endfarbnummer skaliert wird, Beispiel: 30.<br>
- <step width>, für jeden Schritt wird ein Farbwert erzeugt, Beispiel: 1.<br>
- <color model>, die Angabe eines vordefinierten Modells <0|1|2> oder fünf RGB-Werte als Array [r1,g1,b1,r2,g2,b2,r3,g3,b3,r4,g4,b4,r5,g5,b5] für ein eigenes Model.<br>
- <br>
- Beispiele:<br>
- <code>get DOIFtools modelColorGradient 7,20,30,1,0</code><br>
- <code>get DOIFtools modelColorGradient 0,50,100,5,[255,255,0,127,255,0,0,255,0,0,255,255,0,127,255]</code><br>
- <br>
- <code>get <name> hsvColorGradient <HUE start value>,<HUE end value>,<minimal value>,<maximal value>,<step width>,<saturation>,<lightness></code><br>
- <b>hsvColorGradient</b> erzeugt eine Tabelle über HUE-Werte abgestufte Farbnummern und RGB-Werten.<br>
- <Hue start value>, der HUE-Startwert, Beispiel: 240 für Blau.<br>
- <HUE end value>, der HUE-Endwert, Beispiel: 360 für Rot.<br>
- <minimal value>, der Minimalwert auf den der HUE-Startwert skaliert wird, Beispiel: 7.<br 20.<br>
- <maximal value>, der Maximalwert auf den der HUE-Endwert skaliert wird, Beispiel: 30.<br>
- <step width>, für jeden Schritt wird ein Farbwert erzeugt, Beispiel: 1.<br>
- <saturation>, die Angabe eines Wertes für die Farbsättigung <0-100>, Beispiel 80.<br>
- <lightness>, die Angabe eines Wertes für die Helligkeit <0-100>, Beispiel 80.<br>
- <br>
- Beispiele:<br>
- <code>get DOIFtools hsvColorGradient 240,360,7,30,1,80,80</code><br>
- <br>
-
- </ul>
- <a name="DOIFtoolsAttribute"></a>
- <b>Attribute</b><br>
- <ul>
- <code>attr <name> DOIFtoolsExecuteDefinition <0|1></code><br>
- <b>DOIFtoolsExecuteDefinition</b> <b>1</b> führt die erzeugten Definitionen aus. <b>Default 0</b>, zeigt die erzeugten Definitionen an, sie können mit <i>Raw definition</i> importiert werden.<br>
- <br>
- <code>attr <name> DOIFtoolsExecuteSave <0|1></code><br>
- <b>DOIFtoolsExecuteSave</b> <b>1</b>, die Definitionen werden automatisch gespeichert. <b>Default 0</b>, der Benutzer kann die Definitionen speichern.<br>
- <br>
- <code>attr <name> DOIFtoolsTargetGroup <group names for target></code><br>
- <b>DOIFtoolsTargetGroup</b> gibt die Gruppen für die zu erstellenden Definitionen an. <b>Default</b>, die Gruppe der Ursprungs Definition.<br>
- <br>
- <code>attr <name> DOIFtoolsTargetRoom <room names for target></code><br>
- <b>DOIFtoolsTargetRoom</b> gibt die Räume für die zu erstellenden Definitionen an. <b>Default</b>, der Raum der Ursprungs Definition.<br>
- <br>
- <code>attr <name> DOIFtoolsReadingsPrefix <user defined prefix></code><br>
- <b>DOIFtoolsReadingsPrefix</b> legt den Präfix der benutzerdefinierten Readingsnamen für die Zieldefinition fest. <b>Default</b>, DOIFtools bestimmt den Präfix.<br>
- <br>
- <code>attr <name> DOIFtoolsEventMonitorInDOIF <1|0></code><br>
- <b>DOIFtoolsEventMonitorInDOIF</b> <b>1</b>, die Anzeige des Event-Monitors wird in DOIF ermöglicht. <b>Default 0</b>, kein Zugriff auf den Event-Monitor im DOIF.<br>
- <br>
- <code>attr <name> DOIFtoolsEMbeforeReadings <1|0></code><br>
- <b>DOIFtoolsEMbeforeReading</b> <b>1</b>, die Anzeige des Event-Monitors wird in DOIF direkt über den Readings angezeigt. <b>Default 0</b>, anzeige des Event-Monitors über den Internals.<br>
- <br>
- <code>attr <name> DOIFtoolsHideGetSet <0|1></code><br>
- <b>DOIFtoolsHideModulGetSet</b> <b>1</b>, verstecken der Set- und Get-Shortcuts. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsNoLookUp <0|1></code><br>
- <b>DOIFtoolsNoLookUp</b> <b>1</b>, es werden keine Lookup-Fenster in DOIFtools geöffnet. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsNoLookUpInDOIF <0|1></code><br>
- <b>DOIFtoolsNoLookUpInDOIF</b> <b>1</b>, es werden keine Lookup-Fenster in DOIF geöffnet. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsHideModulShortcuts <0|1></code><br>
- <b>DOIFtoolsHideModulShortcuts</b> <b>1</b>, verstecken der DOIFtools Shortcuts. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsHideStatReadings <0|1></code><br>
- <b>DOIFtoolsHideStatReadings</b> <b>1</b>, verstecken der <i>stat_</i> Readings. Das Ändern des Attributs löscht eine bestehende Event-Aufzeichnung. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsEventOnDeleted <0|1></code><br>
- <b>DOIFtoolsEventOnDeleted</b> <b>1</b>, es werden Events für alle <i>stat_</i> erzeugt, bevor sie gelöscht werden. Damit könnten die erfassten Daten geloggt werden. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsMyShortcuts <shortcut name>,<command>, ...</code><br>
- <b>DOIFtoolsMyShortcuts</b> <Bezeichnung><b>,</b><Befehl><b>,...</b> anzeigen eigener Shortcuts, siehe globales Attribut <a href="#menuEntries">menuEntries</a>.<br>
- Zusätzlich gilt, wenn ein Eintrag mit ## beginnt und mit ,, endet, wird er als HTML interpretiert.<br>
- <u>Beispiel:</u><br>
- <code>attr DOIFtools DOIFtoolsMyShortcuts ##<br>My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools</code><br>
- <br>
- <code>attr <name> DOIFtoolsMenuEntry <0|1></code><br>
- <b>DOIFtoolsMenuEntry</b> <b>1</b>, erzeugt einen Menüeintrag im FHEM-Menü. <b>Default 0</b>.<br>
- <br>
- <code>attr <name> DOIFtoolsLogDir <path to DOIFtools logfile></code><br>
- <b>DOIFtoolsLogDir</b> <b><path></b>, gibt den Pfad zum Logfile an <b>Default <i>./log</i> oder der Pfad aus dem Attribut <i>global logdir</i></b>.<br>
- <br>
- <a href="#disabledForIntervals"><b>disabledForIntervals</b></a> pausiert die Statistikdatenerfassung.<br>
- <br>
- </ul>
- <a name="DOIFtoolsReadings"></a>
- <b>Readings</b>
- <br>
- <ul>
- DOIFtools erzeugt bei der Aktualisierung von Readings keine Events, daher muss die Seite im Browser aktualisiert werden, um aktuelle Werte zu sehen.<br>
- <br>
- <li><b>Action</b> zeigt den Status der Event-Aufzeichnung an.</li>
- <li><b>DOIF_version</b> zeigt die Version des DOIF an.</li>
- <li><b>FHEM_revision</b> zeigt die Revision von FHEM an.</li>
- <li><b>doStatistics</b> zeigt den Status der Statistikerzeugung an</li>
- <li><b>logfile</b> gibt den Pfad und den Dateinamen mit Ersetzungszeichen an.</li>
- <li><b>recording_target_duration</b> gibt an wie lange Daten erfasst werden sollen.</li>
- <li><b>stat_</b><<b>devicename</b>> zeigt die Anzahl der gezählten Ereignisse, die das jeweilige Gerät erzeugt hat.</li>
- <li><b>statisticHours</b> zeigt die kumulierte Zeit für den Status <i>enabled</i> an, während der, Statistikdaten erfasst werden.</li>
- <li><b>statisticShowRate_ge</b> zeigt die Event-Rate, ab der Geräte in die Auswertung einbezogen werden.</li>
- <li><b>statisticsDeviceFilterRegex</b> zeigt den aktuellen Gerätefilterausdruck an.</li>
- <li><b>statisticsTYPEs</b> zeigt eine Liste von <i>TYPE</i> an, für deren Geräte die Statistik erzeugt wird.</li>
- <li><b>targetDOIF</b> zeigt das Ziel-DOIF, bei dem Readings gelöscht werden sollen.</li>
- <li><b>targetDevice</b> zeigt das Ziel-Gerät, bei dem Readings gelöscht werden sollen.</li>
- </ul>
- </br>
- <a name="DOIFtoolsLinks"></a>
- <b>Links</b>
- <br>
- <ul>
- <a href="https://forum.fhem.de/index.php/topic,63938.0.html">DOIFtools im FHEM-Forum</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIFtools">DOIFtools im FHEM-Wiki</a><br>
- <br>
- <a href="https://wiki.fhem.de/wiki/DOIF">DOIF im FHEM-Wiki</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIF/Einsteigerleitfaden,_Grundfunktionen_und_Erl%C3%A4uterungen#Erste_Schritte_mit_DOIF:_Zeit-_und_Ereignissteuerung">Erste Schritte mit DOIF</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIF/Einsteigerleitfaden,_Grundfunktionen_und_Erl%C3%A4uterungen">DOIF: Einsteigerleitfaden, Grundfunktionen und Erläuterungen</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIF/Labor_-_ausf%C3%BChrbare,_praxisnahe_Beispiele_als_Probleml%C3%B6sung_zum_Experimentieren">DOIF-Labor - ausführbare, praxisnahe Beispiele als Problemlösung zum Experimentieren</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIF/Tipps_zur_leichteren_Bedienung">DOIF: Tipps zur leichteren Bedienung</a><br>
- <a href="https://wiki.fhem.de/wiki/DOIF/Tools_und_Fehlersuche">DOIF: Tools und Fehlersuche</a><br>
- </ul>
- </ul>
- <p><a name="DUOFERN"></a>
- <h3>DUOFERN</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#DUOFERN'>DUOFERN</a><br/>
- </ul>
- <a name="DUOFERNSTICK"></a>
- <h3>DUOFERNSTICK</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#DUOFERNSTICK'>DUOFERNSTICK</a><br/>
- </ul>
- <a name="Dashboard"></a>
- <h3>Dashboard</h3>
- <div class='langLinks'>[<a href='commandref.html#Dashboard'>EN</a> DE]</div>
- <ul>
- Erstellt eine Übersicht in der Gruppen angeordnet werden können. Dabei können die Gruppen mit Drag'n Drop frei positioniert<br>
- und in mehreren Spalten angeordnet werden. Auch kann die Breite und Höhe einer Gruppe über die Mindestgröße hinaus gezogen werden. <br>
- <br>
-
- <a name="Dashboarddefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Dashboard</code>
- <br><br>
- Beispiel:<br>
- <ul>
- <code>define anyViews Dashboard</code>
- </ul><br>
-
- <b>Bestpractice Anfängerkonfiguration</b>
- <br><br>
- <code>
- define anyViews Dashboard<br>
- attr anyViews dashboard_colcount 2<br>
- attr anyViews dashboard_rowcentercolwidth 30,70<br>
- attr anyViews dashboard_tab1groups <Group1>,<Group2>,<Group3><br>
- </code>
- </ul>
- <br>
- <a name="Dashboardset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> lock</code><br><br>
- Sperrt das Dashboard so das keine Positionsänderungen vorgenommen werden können<br>
- <code>set <name> unlock</code><br><br>
- Entsperrt das Dashboard<br>
- </ul>
- <br>
-
- <a name="Dashboardget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="Dashboardattr"></a>
- <b>Attributes</b>
- <ul>
- <a name="dashboard_tabcount"></a>
- <li>dashboard_tabcount<br>
- Gibt die Anzahl der angezeigten Tabs an. (Dieser Parameter is veraletet, die Anzahl der Tabs wird aus der Dashboard-Konfiguration gelesen)
- Standard: 1
- </li><br>
- <a name="dashboard_activetab"></a>
- <li>dashboard_activetab<br>
- Gibt an welches Tab aktiviert ist. Kann manuell gesetzt werden, wird aber auch durch den Schalter "Set" auf das gerade aktive Tab gesetzt.
- Standard: 1
- </li><br>
- <a name="dashboard_tabXname"></a>
- <li>dashboard_tabXname<br>
- Titel des X. Tab.
- </li><br>
- <a name="dashboard_tabXsorting"></a>
- <li>dashboard_tabXsorting<br>
- Enthält die Poistionierung jeder Gruppe im Tab X. Der Wert wird mit der Schaltfläche "Set" geschrieben. Es wird nicht empfohlen dieses Attribut manuelle zu ändern
- </li><br>
- <a name="dashboard_row"></a>
- <li>dashboard_row<br>
- Auswahl welche Zeilen angezeigt werden sollen. top (nur Oben), center (nur Mitte), bottom (nur Unten) und den Kombinationen daraus.<br>
- Standard: center
- </li><br>
- <a name="dashboard_width"></a>
- <li>dashboard_width<br>
- Zum bestimmen der Dashboardbreite. Der Wert kann in % (z.B. 80%) angegeben werden oder als absolute Breite (z.B. 1200) in Pixel.<br>
- Standard: 100%
- </li><br>
- <a name="dashboard_rowcenterheight"></a>
- <li>dashboard_rowcenterheight<br>
- Höhe der mittleren Zeile, in der die Gruppen angeordnet werden. <br>
- Standard: 400
- </li><br>
- <a name="dashboard_rowcentercolwidth"></a>
- <li>dashboard_rowcentercolwidth<br>
- Über dieses Attribut wird die Breite der einzelnen Spalten der mittleren Dashboardreihe festgelegt. Dabei kann je Spalte ein separater Wert hinterlegt werden.
- Die Werte sind durch ein Komma (ohne Leerzeichen) zu trennen. Jeder Wert bestimmt die Spaltenbreite in %! Der erste Wert gibt die Breite der ersten Spalte an,
- der zweite Wert die Breite der zweiten Spalte usw. Ist die Summe der Breite größer als 100 werden die Spaltenbreiten reduziert.
- Sind mehr Spalten als Breiten definiert werden die fehlenden Breiten um die Differenz zu 100 festgelegt. Sind hingegen weniger Spalten als Werte definiert werden
- die überschüssigen Werte ignoriert.<br>
- Standard: 100
- </li><br>
- <a name="dashboard_rowtopheight"></a>
- <li>dashboard_rowtopheight<br>
- Höhe der oberen Zeile, in der die Gruppen angeordnet werden. <br>
- Standard: 250
- </li><br>
- <a name="dashboard_rowbottomheight"></a>
- <li>"dashboard_rowbottomheight<br>
- Höhe der unteren Zeile, in der die Gruppen angeordnet werden.<br>
- Standard: 250
- </li><br>
- <a name="dashboard_tabXgroups"></a>
- <li>dashboard_tab1groups<br>
- Durch Komma getrennte Liste mit den Namen der Gruppen, die im Tab 1 angezeigt werden. Falsche Gruppennamen werden hervorgehoben.<br>
- Jede Gruppe kann zusätzlich ein Icon anzeigen, dazu muss der Gruppen name um ":<icon>@<farbe>"ergänzt werden<br>
- Beispiel: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow<br/>
- Der Gruppenname kann ebenfalls einen regulären Ausdruck beinhalten, um alle Gruppen anzuzeigen, die darauf passen.<br/>
- Beispiel: .*Licht.* zeigt alle Gruppen an, die das Wort "Licht" im Namen haben.
- </li><br>
- <a name="dashboard_tabXdevices"></a>
- <li>dashboard_tabXdevices<br>
- devspec Liste von Geräten, die im Tab angezeigt werden sollen. Das format ist:<br/>
- GROUPNAME:devspec1,devspec2,...,devspecN:ICONNAME</br/>
- Das Icon ist optional. Auch der Gruppenname muss nicht vorhanden sein. Im Falle dass dieser fehlt, werden die gefunden Geräte nicht gruppiert sondern als einzelne Widgets im Tab angezeigt. Für weitere Details bezüglich devspec:
- <a href="#devspec">Dev-Spec</a>
- </li><br>
- <a name="dashboard_tabXicon"></a>
- <li>dashboard_tabXicon<br>
- Zeigt am Tab ein Icon an. Es muss sich dabei um ein exisitereindes Icon mit modpath Verzeichnis handeln. Handelt es sich um ein SVG Icon kann der Suffix @colorname für die Farbe des Icons angegeben werden.
- </li><br>
- <a name="dashboard_colcount"></a>
- <li>dashboard_colcount<br>
- Die Anzahl der Spalten in der Gruppen dargestellt werden können. Dennoch ist es möglich, mehrere Gruppen <br>
- in einer Spalte nebeneinander zu positionieren. Dies ist abhängig von der Breite der Spalten und Gruppen. <br>
- Gilt nur für die mittlere Spalte! <br>
- Standard: 1
- </li><br>
- <a name="dashboard_tabXcolcount"></a>
- <li>dashboard_tabXcolcount<br>
- Die Anzahl der Spalten im Tab X in der Gruppen dargestellt werden können. Dennoch ist es möglich, mehrere Gruppen <br>
- in einer Spalte nebeneinander zu positionieren. Dies ist abhängig von der Breite der Spalten und Gruppen. <br>
- Gilt nur für die mittlere Spalte! <br>
- Standard: <dashboard_colcount>
- </li><br>
- <a name="dashboard_tabXbackgroundimage"></a>
- <li>dashboard_tabXbackgroundimage<br>
- Zeigt ein Hintergrundbild für den X-ten Tab an. Das Bild wird nicht gestreckt, es sollte also auf die Größe des Tabs passen oder diese überschreiten.
- Standard:
- </li><br>
- <a name="dashboard_flexible"></a>
- <li>dashboard_flexible<br>
- Hat dieser Parameter einen Wert > 0, dann können die Widgets in den Tabs frei positioniert werden und hängen nicht mehr an den Spalten fest. Der Wert gibt ebenfalls das Raster an, in dem die Positionierung "zu schnappt".
- Standard: 0
- </li><br>
- <a name="dashboard_showfullsize"></a>
- <li>dashboard_showfullsize<br>
- Blendet die FHEMWEB Raumliste (kompleter linker Bereich der Seite) und den oberen Bereich von FHEMWEB aus wenn der Wert auf 1 gesetzt ist.<br>
- Default: 0
- </li><br>
- <a name="dashboard_showtabs"></a>
- <li>dashboard_showtabs<br>
- Zeigt die Tabs/Schalterleiste des Dashboards oben oder unten an, oder blendet diese aus. Wenn die Schalterleiste ausgeblendet wird ist das Dashboard gespert.<br>
- Standard: tabs-and-buttonbar-at-the-top
- </li><br>
- <a name="dashboard_showtogglebuttons"></a>
- <li>dashboard_showtogglebuttons<br>
- Zeigt eine Schaltfläche in jeder Gruppe mit der man diese auf- und zuklappen kann.<br>
- Standard: 0
- </li><br>
- <a name="dashboard_backgroundimage"></a>
- <li>dashboard_backgroundimage<br>
- Zeig in Hintergrundbild im Dashboard an. Das Bild wird nicht gestreckt, es sollte daher auf die Größe des Dashboards passen oder diese überschreiten.
- Default:
- </li><br>
- <a name="dashboard_debug"></a>
- <li>dashboard_debug<br>
- Zeigt Debug-Felder an. Sollte nicht gesetzt werden!<br>
- Standard: 0
- </li><br>
- </ul>
- </ul>
- <p><a name="DbLog"></a>
- <h3>DbLog</h3>
- <div class='langLinks'>[<a href='commandref.html#DbLog'>EN</a> DE]</div>
- <ul>
- <br>
- Mit DbLog werden Events in einer Datenbank gespeichert. Es wird SQLite, MySQL/MariaDB und PostgreSQL unterstützt. <br><br>
-
- <b>Voraussetzungen</b> <br><br>
-
- Die Perl-Module <code>DBI</code> und <code>DBD::<dbtype></code> müssen installiert werden (use <code>cpan -i <module></code>
- falls die eigene Distribution diese nicht schon mitbringt).
- <br><br>
-
- Auf einem Debian-System können diese Module z.Bsp. installiert werden mit: <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>DBI</b> </td><td>: <code> sudo apt-get install libdbi-perl </code> </td></tr>
- <tr><td> <b>MySQL</b> </td><td>: <code> sudo apt-get install [mysql-server] mysql-client libdbd-mysql libdbd-mysql-perl </code> (mysql-server nur bei lokaler MySQL-Server-Installation) </td></tr>
- <tr><td> <b>SQLite</b> </td><td>: <code> sudo apt-get install sqlite3 libdbi-perl libdbd-sqlite3-perl </code> </td></tr>
- <tr><td> <b>PostgreSQL</b> </td><td>: <code> sudo apt-get install libdbd-pg-perl </code> </td></tr>
- </table>
- </ul>
- <br>
- <br>
-
- <b>Vorbereitungen</b> <br><br>
-
- Zunächst muss die Datenbank angelegt werden. <br>
- Beispielcode bzw. Scripts zum Erstellen einer MySQL/PostgreSQL/SQLite Datenbank ist im
- <a href="https://svn.fhem.de/trac/browser/trunk/fhem/contrib/dblog">SVN -> contrib/dblog/db_create_<DBType>.sql</a>
- enthalten. <br>
- (<b>Achtung:</b> Die lokale FHEM-Installation enthält im Unterverzeichnis ./contrib/dblog nicht die aktuellsten
- Scripte !!) <br><br>
-
- Die Datenbank beinhaltet 2 Tabellen: <code>current</code> und <code>history</code>. <br>
- Die Tabelle <code>current</code> enthält den letzten Stand pro Device und Reading. <br>
- In der Tabelle <code>history</code> sind alle Events historisch gespeichert. <br>
- Beachten sie bitte unbedingt das <a href="#DbLogattr">Attribut</a> DbLogType um die Benutzung der Tabellen
- <code>current</code> und <code>history</code> festzulegen.
- <br><br>
-
- Die Tabellenspalten haben folgende Bedeutung: <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> TIMESTAMP </td><td>: Zeitpunkt des Events, z.B. <code>2007-12-30 21:45:22</code> </td></tr>
- <tr><td> DEVICE </td><td>: Name des Devices, z.B. <code>Wetterstation</code> </td></tr>
- <tr><td> TYPE </td><td>: Type des Devices, z.B. <code>KS300</code> </td></tr>
- <tr><td> EVENT </td><td>: das auftretende Event als volle Zeichenkette, z.B. <code>humidity: 71 (%)</code> </td></tr>
- <tr><td> READING </td><td>: Name des Readings, ermittelt aus dem Event, z.B. <code>humidity</code> </td></tr>
- <tr><td> VALUE </td><td>: aktueller Wert des Readings, ermittelt aus dem Event, z.B. <code>humidity</code> </td></tr>
- <tr><td> UNIT </td><td>: Einheit, ermittelt aus dem Event, z.B. <code>%</code> </td></tr>
- </table>
- </ul>
- <br>
- <br>
-
- <b>Index anlegen</b> <br>
- Für die Leseperformance, z.B. bei der Erstellung von SVG-PLots, ist es von besonderer Bedeutung dass der <b>Index "Search_Idx"</b>
- oder ein vergleichbarer Index (z.B. ein Primary Key) angelegt ist. <br><br>
-
- Der Index "Search_Idx" kann mit diesen Statements, z.B. in der Datenbank 'fhem', angelegt werden (auch nachträglich): <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>MySQL</b> </td><td>: <code> CREATE INDEX Search_Idx ON `fhem`.`history` (DEVICE, READING, TIMESTAMP); </code> </td></tr>
- <tr><td> <b>SQLite</b> </td><td>: <code> CREATE INDEX Search_Idx ON `history` (DEVICE, READING, TIMESTAMP); </code> </td></tr>
- <tr><td> <b>PostgreSQL</b> </td><td>: <code> CREATE INDEX "Search_Idx" ON history USING btree (device, reading, "timestamp"); </code> </td></tr>
- </table>
- </ul>
- <br>
-
- Der Code zur Anlage ist ebenfalls in den Scripten
- <a href="https://svn.fhem.de/trac/browser/trunk/fhem/contrib/dblog">SVN -> contrib/dblog/db_create_<DBType>.sql</a>
- enthalten. <br><br>
-
- Für die Verbindung zur Datenbank wird eine <b>Konfigurationsdatei</b> verwendet.
- Die Konfiguration ist in einer sparaten Datei abgelegt um das Datenbankpasswort nicht in Klartext in der
- FHEM-Haupt-Konfigurationsdatei speichern zu müssen.
- Ansonsten wäre es mittels des <a href="https://fhem.de/commandref_DE.html#list">list</a> Befehls einfach auslesbar.
- <br><br>
-
- Die <b>Konfigurationsdatei</b> wird z.B. nach /opt/fhem kopiert und hat folgenden Aufbau, den man an seine Umgebung
- anpassen muß (entsprechende Zeilen entkommentieren und anpassen): <br><br>
-
- <pre>
- ####################################################################################
- # database configuration file
- #
- # NOTE:
- # If you don't use a value for user / password please delete the leading hash mark
- # and write 'user => ""' respectively 'password => ""' instead !
- #
- #
- ## for MySQL
- ####################################################################################
- #%dbconfig= (
- # connection => "mysql:database=fhem;host=<database host>;port=3306",
- # user => "fhemuser",
- # password => "fhempassword",
- # # optional enable(1) / disable(0) UTF-8 support (at least V 4.042 is necessary)
- # utf8 => 1
- #);
- ####################################################################################
- #
- ## for PostgreSQL
- ####################################################################################
- #%dbconfig= (
- # connection => "Pg:database=fhem;host=<database host>",
- # user => "fhemuser",
- # password => "fhempassword"
- #);
- ####################################################################################
- #
- ## for SQLite (username and password stay empty for SQLite)
- ####################################################################################
- #%dbconfig= (
- # connection => "SQLite:dbname=/opt/fhem/fhem.db",
- # user => "",
- # password => ""
- #);
- ####################################################################################
- </pre>
- <br>
-
- <a name="DbLogdefine"></a>
- <b>Define</b>
- <ul>
- <br>
-
- <code>define <name> DbLog <configfilename> <regexp></code>
- <br><br>
- <code><configfilename></code> ist die vorbereitete <b>Konfigurationsdatei</b>. <br>
- <code><regexp></code> ist identisch <a href="https://fhem.de/commandref_DE.html#FileLog">FileLog</a> der Filelog-Definition.
- <br><br>
-
- <b>Beispiel:</b>
- <ul>
- <code>define myDbLog DbLog /etc/fhem/db.conf .*:.*</code><br>
- speichert alles in der Datenbank
- </ul>
- <br>
-
- Nachdem das DbLog-Device definiert wurde, ist empfohlen einen <b>Konfigurationscheck</b> auszuführen: <br><br>
- <ul>
- <code>set <name> configCheck</code> <br>
- </ul>
- <br>
- Dieser Check prüft einige wichtige Einstellungen des DbLog-Devices und gibt Empfehlungen für potentielle Verbesserungen.
- <br><br>
- <br>
-
- DbLog unterscheidet den synchronen (Default) und asynchronen Logmodus. Der Logmodus ist über das
- <a href="#DbLogattr">Attribut</a> asyncMode einstellbar. Ab Version 2.13.5 unterstützt DbLog einen gesetzten
- Primary Key (PK) in den Tabellen Current und History. Soll PostgreSQL mit PK genutzt werden, muss PostgreSQL mindestens
- Version 9.5 sein.
- <br><br>
-
- Der gespeicherte Wert des Readings wird optimiert für eine automatisierte Nachverarbeitung, z.B. <code>yes</code> wird transformiert
- nach <code>1</code>. <br><br>
-
- Die gespeicherten Werte können mittels GET Funktion angezeigt werden:
- <ul>
- <code>get myDbLog - - 2012-11-10 2012-11-10 KS300:temperature</code>
- </ul>
- <br>
-
- <b>FileLog-Dateien nach DbLog übertragen</b> <br><br>
- Zur Übertragung von vorhandenen Filelog-Daten in die DbLog-Datenbank steht das spezielle Modul 98_FileLogConvert.pm
- zur Verfügung. <br>
- Dieses Modul kann <a href="https://svn.fhem.de/trac/browser/trunk/fhem/contrib/98_FileLogConvert.pm"> hier</a>
- bzw. aus dem Verzeichnis ./contrib geladen werden.
- Weitere Informationen und Hilfestellung gibt es im entsprechenden <a href="https://forum.fhem.de/index.php/topic,66383.0.html">
- Forumthread </a>. <br><br><br>
-
- <b>Reporting und Management von DbLog-Datenbankinhalten</b> <br><br>
- Mit Hilfe <a href="https://fhem.de/commandref_DE.html#SVG">SVG</a> können Datenbankinhalte visualisiert werden. <br>
- Darüber hinaus kann das Modul <a href="https://fhem.de/commandref_DE.html#DbRep">DbRep</a> genutzt werden um tabellarische
- Datenbankauswertungen anzufertigen oder den Datenbankinhalt mit den zur Verfügung stehenden Funktionen zu verwalten.
- <br><br><br>
-
- <b>Troubleshooting</b> <br><br>
- Wenn nach der erfolgreichen Definition das DbLog-Device nicht wie erwartet arbeitet,
- können folgende Hinweise hilfreich sein: <br><br>
-
- <ul>
- <li> Wurden die vorbereitenden Schritte gemacht, die in der commandref beschrieben sind ? (Softwarekomponenten installieren, Tabellen, Index anlegen) </li>
- <li> Wurde ein "set <name> configCheck" nach dem Define durchgeführt und eventuelle Fehler beseitigt bzw. Empfehlungen umgesetzt ? </li>
- <li> Falls configDB in Benutzung ... wurde das DB-Konfigurationsfile in configDB importiert (z.B. mit "configDB fileimport ./db.conf") ? </li>
- <li> Beim Anlegen eines SVG-Plots erscheint keine Drop-Down Liste mit Vorschlagswerten -> Attribut "DbLogType" auf "Current/History" setzen. </li>
- </ul>
- <br>
-
- Sollten diese Hinweise nicht zum Erfolg führen, bitte den verbose-Level im DbLog Device auf 4 oder 5 hochsetzen und
- die Einträge bezüglich des DbLog-Device im Logfile beachten.
-
- Zur Problemanalyse bitte die Ausgabe von "list <name>", das Ergebnis von "set <name> configCheck" und die
- Ausgaben des DbLog-Device im Logfile im Forumthread posten.
- <br><br>
-
- </ul>
- <br>
- <br>
- <a name="DbLogset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> addCacheLine YYYY-MM-DD HH:MM:SS|<device>|<type>|<event>|<reading>|<value>|[<unit>] </code><br><br>
- <ul> Im asynchronen Modus wird ein neuer Datensatz in den Cache eingefügt und beim nächsten Synclauf mit abgearbeitet.
- <br><br>
-
- <b>Beispiel:</b> <br>
- set <name> addCacheLine 2017-12-05 17:03:59|MaxBathRoom|MAX|valveposition: 95|valveposition|95|% <br>
- </ul><br>
-
- <code>set <name> addLog <devspec>:<Reading> [Value] </code><br><br>
- <ul> Fügt einen zusatzlichen Logeintrag einer Device/Reading-Kombination in die Datenbank ein.
- Optional kann "Value" für den Readingwert angegeben werden. Ist Value nicht angegeben, wird der aktuelle
- Wert des Readings in die DB eingefügt. Das Feld "$EVENT" wird automatisch mit "addLog" belegt. Das Device kann
- als <a href="#devspec">Geräte-Spezifikation</a> angegeben werden. "Reading" wird als regulärer Ausdruck ausgewertet.
- Es wird KEIN zusätzlicher Event im System erzeugt !<br><br>
-
- <b>Beispiele:</b> <br>
- set <name> addLog SMA_Energymeter:Bezug_Wirkleistung <br>
- set <name> addLog TYPE=SSCam:state <br>
- set <name> addLog MyWetter:(fc10.*|fc8.*) <br>
- set <name> addLog MyWetter:(wind|wind_ch.*) 20 <br>
- set <name> addLog TYPE=CUL_HM:FILTER=model=HM-CC-RT-DN:FILTER=subType!=(virtual|):(measured-temp|desired-temp|actuator) <br>
- </ul><br>
-
- <code>set <name> clearReadings </code><br><br>
- <ul> Leert Readings die von verschiedenen DbLog-Funktionen angelegt wurden. </ul><br>
-
- <code>set <name> eraseReadings </code><br><br>
- <ul> Löscht alle Readings außer dem Reading "state". </ul><br>
-
- <code>set <name> commitCache </code><br><br>
- <ul>Im asynchronen Modus (<a href="#DbLogattr">Attribut</a> asyncMode=1), werden die im Speicher gecachten Daten in die Datenbank geschrieben
- und danach der Cache geleert. Der interne Timer des asynchronen Modus wird dabei neu gesetzt.
- Der Befehl kann nützlich sein um manuell oder z.B. über ein AT den Cacheinhalt zu einem definierten Zeitpunkt in die
- Datenbank zu schreiben. </ul><br>
- <code>set <name> configCheck </code><br><br>
- <ul>Es werden einige wichtige Einstellungen geprüft und Empfehlungen gegeben falls potentielle Verbesserungen
- identifiziert wurden.
- </ul><br/>
- <code>set <name> count </code><br><br>
- <ul>Zählt die Datensätze in den Tabellen current und history und schreibt die Ergebnisse in die Readings
- countCurrent und countHistory.</ul><br>
-
- <code>set <name> countNbl </code><br/><br>
- <ul>Die non-blocking Ausführung von "set <name> count".</ul><br>
- <code>set <name> deleteOldDays <n></code><br/><br>
- <ul>Löscht Datensätze in Tabelle history, die älter sind als <n> Tage sind.
- Die Anzahl der gelöschten Datensätze wird in das Reading lastRowsDeleted geschrieben.</ul><br>
- <code>set <name> deleteOldDaysNbl <n></code><br><br>
- <ul>Identisch zu Funktion "deleteOldDays" wobei deleteOldDaysNbl nicht blockierend ausgeführt wird. </ul><br>
- <a name="DbLogsetexportCache"></a>
- <code>set <name> exportCache [nopurge | purgecache] </code><br><br>
- <ul>Wenn DbLog im asynchronen Modus betrieben wird, kann der Cache mit diesem Befehl in ein Textfile geschrieben
- werden. Das File wird per Default in dem Verzeichnis (global->modpath)/log/ erstellt. Das Zielverzeichnis kann mit
- dem <a href="#DbLogattr">Attribut</a> "expimpdir" geändert werden. <br>
- Der Name des Files wird automatisch generiert und enthält den Präfix "cache_", gefolgt von dem DbLog-Devicenamen und
- dem aktuellen Zeitstempel, z.B. "cache_LogDB_2017-03-23_22-13-55". <br>
- Mit den Optionen "nopurge" bzw. "purgecache" wird festgelegt, ob der Cacheinhalt nach dem Export gelöscht werden
- soll oder nicht. Mit "nopurge" (default) bleibt der Cacheinhalt erhalten. <br>
- Das <a href="#DbLogattr">Attribut</a> "exportCacheAppend" bestimmt dabei, ob mit jedem Exportvorgang ein neues Exportfile
- angelegt wird (default) oder der Cacheinhalt an das bestehende (neueste) Exportfile angehängt wird.
- </ul><br>
-
- <code>set <name> importCachefile <file> </code><br><br>
- <ul>Importiert ein mit "exportCache" geschriebenes File in die Datenbank.
- Die verfügbaren Dateien werden per Default im Verzeichnis (global->modpath)/log/ gesucht und eine Drop-Down Liste
- erzeugt sofern Dateien gefunden werden. Das Quellverzeichnis kann mit dem <a href="#DbLogattr">Attribut</a> expimpdir geändert werden. <br>
- Es werden nur die Dateien angezeigt, die dem Muster "cache_", gefolgt von dem DbLog-Devicenamen entsprechen. <br>
- Zum Beispiel "cache_LogDB_2017-03-23_22-13-55", falls das Log-Device "LogDB" heißt. <br>
- Nach einem erfolgreichen Import wird das File mit dem Präfix "impdone_" versehen und erscheint dann nicht mehr
- in der Drop-Down Liste. Soll ein Cachefile in eine andere als der Quelldatenbank importiert werden, kann das
- DbLog-Device im Filenamen angepasst werden damit dieses File den Suchktiterien entspricht und in der Drop-Down Liste
- erscheint. </ul><br>
-
- <code>set <name> listCache </code><br><br>
- <ul>Wenn DbLog im asynchronen Modus betrieben wird (Attribut asyncMode=1), können mit diesem Befehl die im Speicher gecachten Events
- angezeigt werden.</ul><br>
- <code>set <name> purgeCache </code><br><br>
- <ul>Im asynchronen Modus (<a href="#DbLogattr">Attribut</a> asyncMode=1), werden die im Speicher gecachten Daten gelöscht.
- Es werden keine Daten aus dem Cache in die Datenbank geschrieben. </ul><br>
-
- <code>set <name> reduceLog <n> [average[=day]] [exclude=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...]</code><br><br>
- <ul>Reduziert historische Datensaetze, die älter sind als <n> Tage auf einen Eintrag pro Stunde (den ersten) je Device & Reading.<br><br>
- <b>ACHTUNG:</b> Es wird dringend empfohlen zu überprüfen ob der standard INDEX 'Search_Idx' in der Tabelle 'history' existiert! <br>
- Die Abarbeitung dieses Befehls dauert unter Umständen (ohne INDEX) extrem lange. FHEM wird durch den Befehl bis
- zur Fertigstellung <b>komplett blockiert !</b> <br><br>
-
- Das Reading "reduceLogState" zeigt den Ausführungsstatus des letzten reduceLog-Befehls. <br><br>
- Durch die optionale Angabe von 'average' wird nicht nur die Datenbank bereinigt, sondern alle numerischen Werte
- einer Stunde werden auf einen einzigen Mittelwert reduziert. <br>
- Durch die optionale Angabe von 'average=day' wird nicht nur die Datenbank bereinigt, sondern alle numerischen
- Werte eines Tages auf einen einzigen Mittelwert reduziert. (impliziert 'average') <br>
- Optional kann als letzer Parameter "EXCLUDE=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...."
- angegeben werden um device/reading Kombinationen von reduceLog auszuschließen. <br>
- Optional kann als letzer Parameter "INCLUDE=Database-deviceRegExp:Database-ReadingRegExp" angegeben werden um
- die auf die Datenbank ausgeführte SELECT-Abfrage einzugrenzen, was die RAM-Belastung verringert und die
- Performance erhöht. (Wildcards sind % und _) <br>
- </ul><br>
-
- <code>set <name> reduceLogNbl <n> [average[=day]] [exclude=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...]</code><br><br>
- <ul>
- Führt die gleiche Funktion wie "set <name> reduceLog" aus. Im Gegensatz zu reduceLog wird mit FHEM wird durch den Befehl reduceLogNbl nicht
- mehr blockiert da diese Funktion non-blocking implementiert ist ! <br>
- </ul><br>
-
- <code>set <name> reopen [n]</code><br/><br/>
- <ul>Schließt die Datenbank und öffnet sie danach sofort wieder wenn keine Zeit [n] in Sekunden angegeben wurde.
- Dabei wird die Journaldatei geleert und neu angelegt.<br/>
- Verbessert den Datendurchsatz und vermeidet Speicherplatzprobleme. <br>
- Wurde eine optionale Verzögerungszeit [n] in Sekunden angegeben, wird die Verbindung zur Datenbank geschlossen und erst
- nach Ablauf von [n] Sekunden wieder neu verbunden.
- Im synchronen Modus werden die Events in dieser Zeit nicht gespeichert.
- Im asynchronen Modus werden die Events im Cache gespeichert und nach dem Reconnect in die Datenbank geschrieben. </ul><br>
- <code>set <name> rereadcfg </code><br/><br/>
- <ul>Schließt die Datenbank und öffnet sie danach sofort wieder. Dabei wird die Journaldatei geleert und neu angelegt.<br/>
- Verbessert den Datendurchsatz und vermeidet Speicherplatzprobleme.<br/>
- Zwischen dem Schließen der Verbindung und dem Neuverbinden werden die Konfigurationsdaten neu gelesen</ul><br/>
- <code>set <name> userCommand <validSqlStatement></code><br/><br/>
- <ul><b>BENUTZE DIESE FUNKTION NUR, WENN DU WIRKLICH (WIRKLICH!) WEISST, WAS DU TUST!!!</b><br/><br/>
- Führt einen beliebigen (!!!) sql Befehl in der Datenbank aus. Der Befehl und ein zurückgeliefertes
- Ergebnis wird in das Reading "userCommand" bzw. "userCommandResult" geschrieben. Das Ergebnis kann nur
- einzeilig sein.
- Für SQL-Statements, die mehrzeilige Ergebnisse liefern, kann das Auswertungsmodul
- <a href=https://fhem.de/commandref_DE.html#DbRep>DbRep</a> genutzt werden.</br>
- Wird von der Datenbankschnittstelle kein Ergebnis (undef) zurückgeliefert, erscheint die Meldung "no result"
- im Reading "userCommandResult".
- </ul><br>
- </ul><br>
- <a name="DbLogget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> ReadingsVal <device> <reading> <default></code><br/>
- <code>get <name> ReadingsTimestamp <device> <reading> <default></code><br/>
- <br/>
- Liest einen einzelnen Wert aus der Datenbank, Benutzung und Syntax sind weitgehend identisch zu ReadingsVal() und ReadingsTimestamp().<br/>
- </ul>
- <br/>
- <br/>
- <ul>
- <code>get <name> <infile> <outfile> <from>
- <to> <column_spec> </code>
- <br><br>
- Liesst Daten aus der Datenbank. Wird durch die Frontends benutzt um Plots
- zu generieren ohne selbst auf die Datenank zugreifen zu müssen.
- <br>
- <ul>
- <li><in><br>
- Ein Parameter um eine Kompatibilität zum Filelog herzustellen.
- Dieser Parameter ist per default immer auf <code>-</code> zu setzen.<br>
- Folgende Ausprägungen sind zugelassen:<br>
- <ul>
- <li>current: die aktuellen Werte aus der Tabelle "current" werden gelesen.</li>
- <li>history: die historischen Werte aus der Tabelle "history" werden gelesen.</li>
- <li>-: identisch wie "history"</li>
- </ul>
- </li>
-
- <li><out><br>
- Ein Parameter um eine Kompatibilität zum Filelog herzustellen.
- Dieser Parameter ist per default immer auf <code>-</code> zu setzen um die
- Ermittlung der Daten aus der Datenbank für die Plotgenerierung zu prüfen.<br>
- Folgende Ausprägungen sind zugelassen:<br>
- <ul>
- <li>ALL: Es werden alle Spalten der Datenbank ausgegeben. Inclusive einer Überschrift.</li>
- <li>Array: Es werden alle Spalten der Datenbank als Hash ausgegeben. Alle Datensätze als Array zusammengefasst.</li>
- <li>INT: intern zur Plotgenerierung verwendet</li>
- <li>-: default</li>
- </ul>
- </li>
-
- <li><from> / <to><br>
- Wird benutzt um den Zeitraum der Daten einzugrenzen. Es ist das folgende
- Zeitformat oder ein Teilstring davon zu benutzen:<br>
- <ul><code>YYYY-MM-DD_HH24:MI:SS</code></ul></li>
-
- <li><column_spec><br>
- Für jede column_spec Gruppe wird ein Datenset zurückgegeben welches
- durch einen Kommentar getrennt wird. Dieser Kommentar repräsentiert
- die column_spec.<br>
- Syntax: <device>:<reading>:<default>:<fn>:<regexp><br>
- <ul>
- <li><device><br>
- Der Name des Devices. Achtung: Gross/Kleinschreibung beachten!<br>
- Es kann ein % als Jokerzeichen angegeben werden.</li>
- <li><reading><br>
- Das Reading des angegebenen Devices zur Datenselektion.<br>
- Es kann ein % als Jokerzeichen angegeben werden.<br>
- Achtung: Gross/Kleinschreibung beachten!
- </li>
- <li><default><br>
- Zur Zeit noch nicht implementiert.
- </li>
- <li><fn>
- Angabe einer speziellen Funktion:
- <ul>
- <li>int<br>
- Ermittelt den Zahlenwert ab dem Anfang der Zeichenkette aus der
- Spalte "VALUE". Benutzt z.B. für Ausprägungen wie 10%.
- </li>
- <li>int<digit><br>
- Ermittelt den Zahlenwert ab dem Anfang der Zeichenkette aus der
- Spalte "VALUE", inclusive negativen Vorzeichen und Dezimaltrenner.
- Benutzt z.B. für Auspägungen wie -5.7°C.
- </li>
- <li>delta-h / delta-d<br>
- Ermittelt die relative Veränderung eines Zahlenwertes pro Stunde
- oder pro Tag. Wird benutzt z.B. für Spalten die einen
- hochlaufenden Zähler enthalten wie im Falle für ein KS300 Regenzähler
- oder dem 1-wire Modul OWCOUNT.
- </li>
- <li>delta-ts<br>
- Ermittelt die vergangene Zeit zwischen dem letzten und dem aktuellen Logeintrag
- in Sekunden und ersetzt damit den originalen Wert.
- </li>
- </ul></li>
- <li><regexp><br>
- Diese Zeichenkette wird als Perl Befehl ausgewertet.
- Die regexp wird vor dem angegebenen <fn> Parameter ausgeführt.
- <br>
- Bitte zur Beachtung: Diese Zeichenkette darf keine Leerzeichen
- enthalten da diese sonst als <column_spec> Trennung
- interpretiert werden und alles nach dem Leerzeichen als neue
- <column_spec> gesehen wird.<br>
-
- <b>Schlüsselwörter</b>
- <li>$val ist der aktuelle Wert die die Datenbank für ein Device/Reading ausgibt.</li>
- <li>$ts ist der aktuelle Timestamp des Logeintrages.</li>
- <li>Wird als $val das Schlüsselwort "hide" zurückgegeben, so wird dieser Logeintrag nicht
- ausgegeben, trotzdem aber für die Zeitraumberechnung verwendet.</li>
- <li>Wird als $val das Schlüsselwort "ignore" zurückgegeben, so wird dieser Logeintrag
- nicht für eine Folgeberechnung verwendet.</li>
- </li>
- </ul></li>
-
- </ul>
- <br><br>
- <b>Beispiele:</b>
- <ul>
- <li><code>get myDbLog - - 2012-11-10 2012-11-20 KS300:temperature</code></li>
-
- <li><code>get myDbLog current ALL - - %:temperature</code></li><br>
- Damit erhält man alle aktuellen Readings "temperature" von allen in der DB geloggten Devices.
- Achtung: bei Nutzung von Jokerzeichen auf die history-Tabelle kann man sein FHEM aufgrund langer Laufzeit lahmlegen!
-
- <li><code>get myDbLog - - 2012-11-10_10 2012-11-10_20 KS300:temperature::int1</code><br>
- gibt Daten aus von 10Uhr bis 20Uhr am 10.11.2012</li>
-
- <li><code>get myDbLog - all 2012-11-10 2012-11-20 KS300:temperature</code></li>
-
- <li><code>get myDbLog - - 2012-11-10 2012-11-20 KS300:temperature KS300:rain::delta-h KS300:rain::delta-d</code></li>
-
- <li><code>get myDbLog - - 2012-11-10 2012-11-20 MyFS20:data:::$val=~s/(on|off).*/$1eq"on"?1:0/eg</code><br>
- gibt 1 zurück für alle Ausprägungen von on* (on|on-for-timer etc) und 0 für alle off*</li>
-
- <li><code>get myDbLog - - 2012-11-10 2012-11-20 Bodenfeuchte:data:::$val=~s/.*B:\s([-\.\d]+).*/$1/eg</code><br>
- Beispiel von OWAD: Ein Wert wie z.B.: <code>"A: 49.527 % B: 66.647 % C: 9.797 % D: 0.097 V"</code><br>
- und die Ausgabe ist für das Reading B folgende: <code>2012-11-20_10:23:54 66.647</code></li>
-
- <li><code>get DbLog - - 2013-05-26 2013-05-28 Pumpe:data::delta-ts:$val=~s/on/hide/</code><br>
- Realisierung eines Betriebsstundenzählers. Durch delta-ts wird die Zeit in Sek zwischen den Log-
- Einträgen ermittelt. Die Zeiten werden bei den on-Meldungen nicht ausgegeben welche einer Abschaltzeit
- entsprechen würden.</li>
- </ul>
- <br><br>
- </ul>
- <b>Get</b> für die Nutzung von webcharts
- <ul>
- <code>get <name> <infile> <outfile> <from>
- <to> <device> <querytype> <xaxis> <yaxis> <savename> </code>
- <br><br>
- Liest Daten aus der Datenbank aus und gibt diese in JSON formatiert aus. Wird für das Charting Frontend genutzt
- <br>
- <ul>
- <li><name><br>
- Der Name des definierten DbLogs, so wie er in der fhem.cfg angegeben wurde.</li>
-
- <li><in><br>
- Ein Dummy Parameter um eine Kompatibilität zum Filelog herzustellen.
- Dieser Parameter ist immer auf <code>-</code> zu setzen.</li>
-
- <li><out><br>
- Ein Dummy Parameter um eine Kompatibilität zum Filelog herzustellen.
- Dieser Parameter ist auf <code>webchart</code> zu setzen um die Charting Get Funktion zu nutzen.
- </li>
-
- <li><from> / <to><br>
- Wird benutzt um den Zeitraum der Daten einzugrenzen. Es ist das folgende
- Zeitformat zu benutzen:<br>
- <ul><code>YYYY-MM-DD_HH24:MI:SS</code></ul></li>
-
- <li><device><br>
- Ein String, der das abzufragende Device darstellt.</li>
-
- <li><querytype><br>
- Ein String, der die zu verwendende Abfragemethode darstellt. Zur Zeit unterstützte Werte sind: <br>
- <code>getreadings</code> um für ein bestimmtes device alle Readings zu erhalten<br>
- <code>getdevices</code> um alle verfügbaren devices zu erhalten<br>
- <code>timerange</code> um Chart-Daten abzufragen. Es werden die Parameter 'xaxis', 'yaxis', 'device', 'to' und 'from' benötigt<br>
- <code>savechart</code> um einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration abzuspeichern<br>
- <code>deletechart</code> um einen zuvor gespeicherten Chart unter Angabe einer id zu löschen<br>
- <code>getcharts</code> um eine Liste aller gespeicherten Charts zu bekommen.<br>
- <code>getTableData</code> um Daten aus der Datenbank abzufragen und in einer Tabelle darzustellen. Benötigt paging Parameter wie start und limit.<br>
- <code>hourstats</code> um Statistiken für einen Wert (yaxis) für eine Stunde abzufragen.<br>
- <code>daystats</code> um Statistiken für einen Wert (yaxis) für einen Tag abzufragen.<br>
- <code>weekstats</code> um Statistiken für einen Wert (yaxis) für eine Woche abzufragen.<br>
- <code>monthstats</code> um Statistiken für einen Wert (yaxis) für einen Monat abzufragen.<br>
- <code>yearstats</code> um Statistiken für einen Wert (yaxis) für ein Jahr abzufragen.<br>
- </li>
-
- <li><xaxis><br>
- Ein String, der die X-Achse repräsentiert</li>
-
- <li><yaxis><br>
- Ein String, der die Y-Achse repräsentiert</li>
-
- <li><savename><br>
- Ein String, unter dem ein Chart in der Datenbank gespeichert werden soll</li>
-
- <li><chartconfig><br>
- Ein jsonstring der den zu speichernden Chart repräsentiert</li>
-
- <li><pagingstart><br>
- Ein Integer um den Startwert für die Abfrage 'getTableData' festzulegen</li>
-
- <li><paginglimit><br>
- Ein Integer um den Limitwert für die Abfrage 'getTableData' festzulegen</li>
- </ul>
- <br><br>
- Beispiele:
- <ul>
- <li><code>get logdb - webchart "" "" "" getcharts</code><br>
- Liefert alle gespeicherten Charts aus der Datenbank</li>
-
- <li><code>get logdb - webchart "" "" "" getdevices</code><br>
- Liefert alle verfügbaren Devices aus der Datenbank</li>
-
- <li><code>get logdb - webchart "" "" ESA2000_LED_011e getreadings</code><br>
- Liefert alle verfügbaren Readings aus der Datenbank unter Angabe eines Gerätes</li>
-
- <li><code>get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e timerange TIMESTAMP day_kwh</code><br>
- Liefert Chart-Daten, die auf folgenden Parametern basieren: 'xaxis', 'yaxis', 'device', 'to' und 'from'<br>
- Die Ausgabe erfolgt als JSON, z.B.: <code>[{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]</code></li>
-
- <li><code>get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh</code><br>
- Speichert einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration</li>
-
- <li><code>get logdb - webchart "" "" "" deletechart "" "" 7</code><br>
- Löscht einen zuvor gespeicherten Chart unter Angabe einer id</li>
- </ul>
- <br><br>
- </ul>
- <a name="DbLogattr"></a>
- <b>Attribute</b>
- <br><br>
-
- <ul><b>addStateEvent</b>
- <ul>
- <code>attr <device> addStateEvent [0|1]
- </code><br>
- Bekanntlich wird normalerweise bei einem Event mit dem Reading "state" der state-String entfernt, d.h.
- der Event ist nicht zum Beispiel "state: on" sondern nur "on". <br>
- Meistens ist es aber hilfreich in DbLog den kompletten Event verarbeiten zu können. Deswegen übernimmt DbLog per Default
- den Event inklusive dem Reading-String "state". <br>
- In einigen Fällen, z.B. alten oder speziellen Modulen, ist es allerdings wünschenswert den state-String wie gewöhnlich
- zu entfernen. In diesen Fällen bitte addStateEvent = "0" setzen.
- Versuchen sie bitte diese Einstellung, falls es mit dem Standard Probleme geben sollte.
- <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>asyncMode</b>
- <ul>
- <code>attr <device> asyncMode [1|0]
- </code><br>
-
- Dieses Attribut stellt den Arbeitsmodus von DbLog ein. Im asynchronen Modus (asyncMode=1), werden die zu speichernden Events zunächst in Speicher
- gecacht. Nach Ablauf der Synchronisationszeit (Attribut syncInterval) oder bei Erreichen der maximalen Anzahl der Datensätze im Cache
- (Attribut cacheLimit) werden die gecachten Events im Block in die Datenbank geschrieben.
- Ist die Datenbank nicht verfügbar, werden die Events weiterhin im Speicher gehalten und nach Ablauf des Syncintervalls in die Datenbank
- geschrieben falls sie dann verfügbar ist. <br>
- Im asynchronen Mode werden die Daten nicht blockierend mit einem separaten Hintergrundprozess in die Datenbank geschrieben.
- Det Timeout-Wert für diesen Hintergrundprozess kann mit dem Attribut "timeout" (Default 86400s) eingestellt werden.
- Im synchronen Modus (Normalmodus) werden die Events nicht gecacht und sofort in die Datenbank geschrieben. Ist die Datenbank nicht
- verfügbar gehen sie verloren.<br>
- </ul>
- </ul>
- <br>
-
- <ul><b>commitMode</b>
- <ul>
- <code>attr <device> commitMode [basic_ta:on | basic_ta:off | ac:on_ta:on | ac:on_ta:off | ac:off_ta:on]
- </code><br>
-
- Ändert die Verwendung der Datenbank Autocommit- und/oder Transaktionsfunktionen.
- Dieses Attribut ist ein advanced feature und sollte nur im konkreten Bedarfs- bzw. Supportfall geändert werden.<br><br>
-
- <ul>
- <li>basic_ta:on - Autocommit Servereinstellung / Transaktion ein (default) </li>
- <li>basic_ta:off - Autocommit Servereinstellung / Transaktion aus </li>
- <li>ac:on_ta:on - Autocommit ein / Transaktion ein </li>
- <li>ac:on_ta:off - Autocommit ein / Transaktion aus </li>
- <li>ac:off_ta:on - Autocommit aus / Transaktion ein (Autocommit aus impliziert Transaktion ein) </li>
- </ul>
-
- </ul>
- </ul>
- <br>
- <ul><b>cacheEvents</b>
- <ul>
- <code>attr <device> cacheEvents [2|1|0]
- </code><br>
- <ul>
- <li>cacheEvents=1: es werden Events für das Reading CacheUsage erzeugt wenn ein Event zum Cache hinzugefügt wurde. </li>
- <li>cacheEvents=2: es werden Events für das Reading CacheUsage erzeugt wenn im asynchronen Mode der Schreibzyklus in die
- Datenbank beginnt. CacheUsage enthält zu diesem Zeitpunkt die Anzahl der in die Datenbank zu schreibenden
- Datensätze. </li><br>
- </ul>
- </ul>
- </ul>
- <br>
-
- <ul><b>cacheLimit</b>
- <ul>
- <code>
- attr <device> cacheLimit <n>
- </code><br>
-
- Im asynchronen Logmodus wird der Cache in die Datenbank weggeschrieben und geleert wenn die Anzahl <n> Datensätze
- im Cache erreicht ist (Default: 500). Der Timer des asynchronen Logmodus wird dabei neu auf den Wert des Attributs "syncInterval"
- gesetzt. Im Fehlerfall wird ein erneuter Schreibversuch frühestens nach syncInterval/2 gestartet. <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>colEvent</b>
- <ul>
- <code>
- attr <device> colEvent <n>
- </code><br>
-
- Die Feldlänge für das DB-Feld EVENT wird userspezifisch angepasst. Mit dem Attribut kann der Default-Wert im Modul
- verändert werden wenn die Feldlänge in der Datenbank manuell geändert wurde. Mit colEvent=0 wird das Datenbankfeld
- EVENT nicht gefüllt. <br>
- <b>Hinweis:</b> <br>
- Mit gesetztem Attribut gelten alle Feldlängenbegrenzungen auch für SQLite DB wie im Internal COLUMNS angezeigt ! <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>colReading</b>
- <ul>
- <code>
- attr <device> colReading <n>
- </code><br>
-
- Die Feldlänge für das DB-Feld READING wird userspezifisch angepasst. Mit dem Attribut kann der Default-Wert im Modul
- verändert werden wenn die Feldlänge in der Datenbank manuell geändert wurde. Mit colReading=0 wird das Datenbankfeld
- READING nicht gefüllt. <br>
- <b>Hinweis:</b> <br>
- Mit gesetztem Attribut gelten alle Feldlängenbegrenzungen auch für SQLite DB wie im Internal COLUMNS angezeigt ! <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>colValue</b>
- <ul>
- <code>
- attr <device> colValue <n>
- </code><br>
-
- Die Feldlänge für das DB-Feld VALUE wird userspezifisch angepasst. Mit dem Attribut kann der Default-Wert im Modul
- verändert werden wenn die Feldlänge in der Datenbank manuell geändert wurde. Mit colValue=0 wird das Datenbankfeld
- VALUE nicht gefüllt. <br>
- <b>Hinweis:</b> <br>
- Mit gesetztem Attribut gelten alle Feldlängenbegrenzungen auch für SQLite DB wie im Internal COLUMNS angezeigt ! <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>DbLogType</b>
- <ul>
- <code>
- attr <device> DbLogType [Current|History|Current/History|SampleFill/History]
- </code><br>
-
- Dieses Attribut legt fest, welche Tabelle oder Tabellen in der Datenbank genutzt werden sollen. Ist dieses Attribut nicht gesetzt, wird
- per default die Einstellung <i>history</i> verwendet. <br><br>
-
- Bedeutung der Einstellungen sind: <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=10%> <col width=90%> </colgroup>
- <tr><td> <b>Current</b> </td><td>Events werden nur in die current-Tabelle geloggt.
- Die current-Tabelle wird bei der SVG-Erstellung ausgewertet. </td></tr>
- <tr><td> <b>History</b> </td><td>Events werden nur in die history-Tabelle geloggt. Es wird keine DropDown-Liste mit Vorschlägen bei der SVG-Erstellung
- erzeugt. </td></tr>
- <tr><td> <b>Current/History</b> </td><td>Events werden sowohl in die current- also auch in die hitory Tabelle geloggt.
- Die current-Tabelle wird bei der SVG-Erstellung ausgewertet.</td></tr>
- <tr><td> <b>SampleFill/History</b> </td><td>Events werden nur in die history-Tabelle geloggt. Die current-Tabelle wird bei der SVG-Erstellung ausgewertet und
- kann zur Erzeugung einer DropDown-Liste mittels einem
- <a href="http://fhem.de/commandref_DE.html#DbRep">DbRep-Device</a> <br> "set <DbRep-Name> tableCurrentFillup" mit
- einem einstellbaren Extract der history-Tabelle gefüllt werden (advanced Feature). </td></tr>
- </table>
- </ul>
- <br>
- <br>
-
- <b>Hinweis:</b> <br>
- Die Current-Tabelle muß genutzt werden um eine Device:Reading-DropDownliste zur Erstellung eines
- SVG-Plots zu erhalten. <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>DbLogSelectionMode</b>
- <ul>
- <code>
- attr <device> DbLogSelectionMode [Exclude|Include|Exclude/Include]
- </code><br>
-
- Dieses, fuer DbLog-Devices spezifische Attribut beeinflußt, wie die Device-spezifischen Attributes
- DbLogExclude und DbLogInclude (s.u.) ausgewertet werden.<br>
- Fehlt dieses Attribut, wird dafuer "Exclude" als Default angenommen. <br>
-
- <ul>
- <li>Exclude: DbLog verhaelt sich wie bisher auch, alles was ueber die RegExp im DEF angegeben ist, wird geloggt, bis auf das,
- was ueber die RegExp in DbLogExclude ausgeschlossen wird. <br>
- Das Attribut DbLogInclude wird in diesem Fall nicht beruecksichtigt</li>
- <li>Include: Es wird nur das geloggt was ueber die RegExp in DbLogInclude eingeschlossen wird. <br>
- Das Attribut DbLogExclude wird in diesem Fall ebenso wenig beruecksichtigt wie die Regex im DEF. </li>
- <li>Exclude/Include: Funktioniert im Wesentlichen wie "Exclude", nur das sowohl DbLogExclude als auch DbLogInclude
- geprueft werden. Readings die durch DbLogExclude zwar ausgeschlossen wurden, mit DbLogInclude aber wiederum eingeschlossen werden,
- werden somit dennoch geloggt. </li>
- </ul>
- </ul>
- </ul>
- <br>
-
- <ul><b>DbLogInclude</b>
- <ul>
- <code>
- attr <device> DbLogInclude regex:MinInterval,[regex:MinInterval] ...
- </code><br>
-
- Wenn DbLog genutzt wird, wird in allen Devices das Attribut <i>DbLogInclude</i> propagiert.
- DbLogInclude funktioniert im Endeffekt genau wie DbLogExclude, ausser dass eben readings mit diesen RegExp
- in das Logging eingeschlossen werden koennen, statt ausgeschlossen.
- Siehe dazu auch das DbLog-Device-Spezifische Attribut DbLogSelectionMode, das beeinflußt wie
- DbLogExclude und DbLogInclude ausgewertet werden. <br>
- <b>Beispiel</b> <br>
- <code>attr MyDevice1 DbLogInclude .*</code> <br>
- <code>attr MyDevice2 DbLogInclude state,(floorplantext|MyUserReading):300,battery:3600</code>
- </ul>
- </ul>
- <br>
-
- <ul><b>DbLogExclude</b>
- <ul>
- <code>
- attr <device> DbLogExclude regex:MinInterval,[regex:MinInterval] ...
- </code><br>
-
- Wenn DbLog genutzt wird, wird in alle Devices das Attribut <i>DbLogExclude</i> propagiert.
- Der Wert des Attributes wird als Regexp ausgewertet und schliesst die damit matchenden Readings von einem Logging aus.
- Einzelne Regexp werden durch Kommata getrennt. Ist MinIntervall angegeben, so wird der Logeintrag nur
- dann nicht geloggt, wenn das Intervall noch nicht erreicht und der Wert des Readings sich nicht verändert hat. <br><br>
-
- <b>Beispiel</b> <br>
- <code>attr MyDevice1 DbLogExclude .*</code> <br>
- <code>attr MyDevice2 DbLogExclude state,(floorplantext|MyUserReading):300,battery:3600</code>
- </ul>
- </ul>
- <br>
-
- <ul><b>excludeDevs</b>
- <ul>
- <code>
- attr <device> excludeDevs <devspec1>,<devspec2>,<devspec..>
- </code><br>
-
- Die Devices "devspec1", "devspec2" bis "devspec.." werden vom Logging in die Datenbank ausgeschlossen.
- Diese Attribut wirkt nur wenn kein Internal "NOTIFYDEV" vorhanden ist.
- Dadurch können Devices explizit vom Logging ausgeschlossen werden.
- Die auszuschließenden Devices können als <a href="#devspec">Geräte-Spezifikation</a> angegeben werden.
- Für weitere Details bezüglich devspec siehe <a href="#devspec">Geräte-Spezifikation</a>. <br><br>
-
- <b>Beispiel</b> <br>
- <code>
- attr <device> excludeDevs global,Log.*,Cam.*,TYPE=DbLog
- </code><br>
- # Es werden die Devices global bzw. Devices beginnend mit "Log" oder "Cam" bzw. Devices vom Typ "DbLog" vom Datenbanklogging ausgeschlossen. <br>
- </ul>
- </ul>
- <br>
- <ul><b>expimpdir</b>
- <ul>
- <code>
- attr <device> expimpdir <directory>
- </code><br>
-
- In diesem Verzeichnis wird das Cachefile beim Export angelegt bzw. beim Import gesucht. Siehe set-Kommandos
- <a href="#DbLogsetexportCache">"exportCache"</a> bzw. "importCachefile". Das Default-Verzeichnis ist "(global->modpath)/log/".
- Das im Attribut angegebene Verzeichnis muss vorhanden und beschreibbar sein. <br><br>
-
- <b>Beispiel</b> <br>
- <code>
- attr <device> expimpdir /opt/fhem/cache/
- </code><br>
- </ul>
- </ul>
- <br>
-
- <ul><b>exportCacheAppend</b>
- <ul>
- <code>
- attr <device> exportCacheAppend [1|0]
- </code><br>
-
- Wenn gesetzt, wird beim Export des Cache ("set <device> exportCache") der Cacheinhalt an das neueste bereits vorhandene
- Exportfile angehängt. Ist noch kein Exportfile vorhanden, wird es neu angelegt. <br>
- Ist das Attribut nicht gesetzt, wird bei jedem Exportvorgang ein neues Exportfile angelegt. (default)<br/>
- </ul>
- </ul>
- <br>
-
- <ul><b>noNotifyDev</b>
- <ul>
- <code>
- attr <device> noNotifyDev [1|0]
- </code><br>
-
- Erzwingt dass NOTIFYDEV nicht gesetzt und somit nicht verwendet wird.<br>
- </ul>
- </ul>
- <br>
-
- <ul><b>noSupportPK</b>
- <ul>
- <code>
- attr <device> noSupportPK [1|0]
- </code><br>
-
- Deaktiviert die programmtechnische Unterstützung eines gesetzten Primary Key durch das Modul.<br>
- </ul>
- </ul>
- <br>
-
- <ul><b>shutdownWait</b>
- <ul>
- <code>
- attr <device> shutdownWait <n>
- </code><br>
-
- FHEM wartet während des shutdowns fuer n Sekunden, um die Datenbank korrekt zu beenden<br/>
- </ul>
- </ul>
- <br>
-
- <ul><b>showproctime</b>
- <ul>
- <code>attr <device> showproctime [1|0]
- </code><br>
-
- Wenn gesetzt, zeigt das Reading "sql_processing_time" die benötigte Abarbeitungszeit (in Sekunden) für die SQL-Ausführung der
- durchgeführten Funktion. Dabei wird nicht ein einzelnes SQL-Statement, sondern die Summe aller notwendigen SQL-Abfragen innerhalb der
- jeweiligen Funktion betrachtet. Das Reading "background_processing_time" zeigt die im Kindprozess BlockingCall verbrauchte Zeit.<br>
-
- </ul>
- </ul>
- <br>
-
- <ul><b>showNotifyTime</b>
- <ul>
- <code>attr <device> showNotifyTime [1|0]
- </code><br>
-
- Wenn gesetzt, zeigt das Reading "notify_processing_time" die benötigte Abarbeitungszeit (in Sekunden) für die
- Abarbeitung der DbLog Notify-Funktion. Das Attribut ist für Performance Analysen geeignet und hilft auch die Unterschiede
- im Zeitbedarf bei der Umschaltung des synchronen in den asynchronen Modus festzustellen. <br>
-
- </ul>
- </ul>
- <br>
-
- <ul><b>syncEvents</b>
- <ul>
- <code>attr <device> syncEvents [1|0]
- </code><br>
-
- es werden Events für Reading NextSync erzeugt. <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>syncInterval</b>
- <ul>
- <code>attr <device> syncInterval <n>
- </code><br>
-
- Wenn DbLog im asynchronen Modus betrieben wird (Attribut asyncMode=1), wird mit diesem Attribut das Intervall in Sekunden zur Speicherung
- der im Speicher gecachten Events in die Datenbank eingestellt. Der Defaultwert ist 30 Sekunden. <br>
-
- </ul>
- </ul>
- <br>
-
- <ul><b>suppressAddLogV3</b>
- <ul>
- <code>attr <device> suppressAddLogV3 [1|0]
- </code><br>
-
- Wenn gesetzt werden verbose3-Logeinträge durch die addLog-Funktion unterdrückt. <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>suppressUndef</b>
- <ul>
- <code>attr <device> ignoreUndef <n>
- </code><br>
- Unterdrueckt alle undef Werte die durch eine Get-Anfrage zb. Plot aus der Datenbank selektiert werden <br>
- <b>Beispiel</b> <br>
- <code>#DbLog eMeter:power:::$val=($val>1500)?undef:$val</code>
- </ul>
- </ul>
- <br>
-
- <ul><b>timeout</b>
- <ul>
- <code>
- attr <device> timeout <n>
- </code><br>
- Setzt den Timeout-Wert für den Schreibzyklus in die Datenbank im asynchronen Modus (default 86400s). <br>
- </ul>
- </ul>
- <br>
-
- <ul><b>useCharfilter</b>
- <ul>
- <code>
- attr <device> useCharfilter [0|1] <n>
- </code><br>
- wenn gesetzt, werden nur ASCII Zeichen von 32 bis 126 im Event akzeptiert. (default: 0) <br>
- Das sind die Zeichen " A-Za-z0-9!"#$%&'()*+,-.\/:;<=>?@[\\]^_`{|}~". <br>
- Umlaute und "€" werden umgesetzt (z.B. ä nach ae, € nach EUR). <br>
- </ul>
- </ul>
- <br>
- <ul><b>valueFn</b>
- <ul>
- <code>
- attr <device> valueFn {}
- </code><br>
-
- Es kann über einen Perl-Ausdruck auf die Variablen $TIMESTAMP, $DEVICE, $DEVICETYPE, $READING, $VALUE (Wert des Readings) und
- $UNIT (Einheit des Readingswert) zugegriffen werden und diese verändern, d.h. die veränderten Werte werden geloggt.
- Außerdem hat man lesenden Zugriff auf $EVENT für eine Auswertung im Perl-Ausdruck.
- Diese Variable kann aber nicht verändert werden. <br>
- Soll $TIMESTAMP verändert werden, muss die Form "yyyy-mm-dd hh:mm:ss" eingehalten werden, ansonsten wird der
- geänderte $timestamp nicht übernommen.
- Zusätzlich kann durch Setzen der Variable "$IGNORE=1" ein Datensatz vom Logging ausgeschlossen werden. <br><br>
-
- <b>Beispiele</b> <br>
- <code>
- attr <device> valueFn {if ($DEVICE eq "living_Clima" && $VALUE eq "off" ){$VALUE=0;} elsif ($DEVICE eq "e-power"){$VALUE= sprintf "%.1f", $VALUE;}}
- </code> <br>
- # ändert den Reading-Wert des Gerätes "living_Clima" von "off" zu "0" und rundet den Wert vom Gerät "e-power" <br><br>
- <code>
- attr <device> valueFn {if ($DEVICE eq "SMA_Energymeter" && $READING eq "state"){$IGNORE=1;}}
- </code><br>
- # der Datensatz wird nicht geloggt wenn Device = "SMA_Energymeter" und das Reading = "state" ist <br><br>
- <code>
- attr <device> valueFn {if ($DEVICE eq "Dum.Energy" && $READING eq "TotalConsumption"){$UNIT="W";}}
- </code><br>
- # setzt die Einheit des Devices "Dum.Energy" auf "W" wenn das Reading = "TotalConsumption" ist <br><br>
- </ul>
- </ul>
- <br>
-
- <ul><b>verbose4Devs</b>
- <ul>
- <code>
- attr <device> verbose4Devs <device1>,<device2>,<device..>
- </code><br>
-
- Mit verbose Level 4 werden nur Ausgaben bezüglich der in diesem Attribut aufgeführten Devices im Logfile protokolliert. Ohne dieses
- Attribut werden mit verbose 4 Ausgaben aller relevanten Devices im Logfile protokolliert.
- Die angegebenen Devices werden als Regex ausgewertet. <br>
-
- <b>Beispiel</b> <br>
- <code>
- attr <device> verbose4Devs sys.*,.*5000.*,Cam.*,global
- </code><br>
- # Es werden Devices beginnend mit "sys", "Cam" bzw. Devices die "5000" enthalten und das Device "global" protokolliert falls verbose=4
- eingestellt ist. <br>
- </ul>
- </ul>
- <br>
-
- </ul>
- <p><a name="DbRep"></a>
- <h3>DbRep</h3>
- <div class='langLinks'>[<a href='commandref.html#DbRep'>EN</a> DE]</div>
- <ul>
- <br>
- Zweck des Moduls ist es, den Inhalt von DbLog-Datenbanken nach bestimmten Kriterien zu durchsuchen, zu managen, das Ergebnis hinsichtlich verschiedener
- Aggregationen auszuwerten und als Readings darzustellen. Die Abgrenzung der zu berücksichtigenden Datenbankinhalte erfolgt durch die Angabe von Device, Reading und
- die Zeitgrenzen für Auswertungsbeginn bzw. Auswertungsende. <br><br>
-
- Alle Datenbankoperationen werden nichtblockierend ausgeführt. Die Ausführungszeit der (SQL)-Hintergrundoperationen kann optional ebenfalls als Reading bereitgestellt
- werden (siehe <a href="#DbRepattr">Attribute</a>). <br>
- Alle vorhandenen Readings werden vor einer neuen Operation gelöscht. Durch das Attribut "readingPreventFromDel" kann eine Komma separierte Liste von Readings
- angegeben werden die nicht gelöscht werden sollen. <br><br>
-
- Aktuell werden folgende Operationen unterstützt: <br><br>
-
- <ul><ul>
- <li> Selektion aller Datensätze innerhalb einstellbarer Zeitgrenzen </li>
- <li> Darstellung der Datensätze einer Device/Reading-Kombination innerhalb einstellbarer Zeitgrenzen. </li>
- <li> Selektion der Datensätze unter Verwendung von dynamisch berechneter Zeitgrenzen zum Ausführungszeitpunkt. </li>
- <li> Dubletten-Hervorhebung bei Datensatzanzeige (fetchrows) </li>
- <li> Berechnung der Anzahl von Datensätzen einer Device/Reading-Kombination unter Berücksichtigung von Zeitgrenzen
- und verschiedenen Aggregationen. </li>
- <li> Die Berechnung von Summen-, Differenz-, Maximum-, Minimum- und Durchschnittswerten numerischer Readings
- in Zeitgrenzen und verschiedenen Aggregationen. </li>
- <li> Speichern von Summen-, Differenz- , Maximum- , Minimum- und Durchschnittswertberechnungen in der Datenbank </li>
- <li> Löschung von Datensätzen. Die Eingrenzung der Löschung kann durch Device und/oder Reading sowie fixer oder
- dynamisch berechneter Zeitgrenzen zum Ausführungszeitpunkt erfolgen. </li>
- <li> Export von Datensätzen in ein File im CSV-Format </li>
- <li> Import von Datensätzen aus File im CSV-Format </li>
- <li> Umbenennen von Device/Readings in Datenbanksätzen </li>
- <li> Ändern von Reading-Werten (VALUES) in der Datenbank </li>
- <li> automatisches Umbenennen von Device-Namen in Datenbanksätzen und DbRep-Definitionen nach FHEM "rename"
- Befehl (siehe <a href="#DbRepAutoRename">DbRep-Agent</a>) </li>
- <li> Ausführen von beliebigen Benutzer spezifischen SQL-Kommandos </li>
- <li> Backups der FHEM-Datenbank im laufenden Betrieb erstellen (MySQL, SQLite) </li>
- <li> senden des Dumpfiles zu einem FTP-Server nach dem Backup incl. Versionsverwaltung </li>
- <li> Restore von SQLite-Dumps und MySQL serverSide-Backups </li>
- <li> Optimierung der angeschlossenen Datenbank (optimizeTables, vacuum) </li>
- <li> Ausgabe der existierenden Datenbankprozesse (MySQL) </li>
- <li> leeren der current-Tabelle </li>
- <li> Auffüllen der current-Tabelle mit einem (einstellbaren) Extrakt der history-Tabelle</li>
- <li> Bereinigung sequentiell aufeinander folgender Datensätze mit unterschiedlichen Zeitstempel aber gleichen Werten (sequentielle Dublettenbereinigung) </li>
- <li> Reparatur einer korrupten SQLite Datenbank ("database disk image is malformed") </li>
- <li> Übertragung von Datensätzen aus der Quelldatenbank in eine andere (Standby) Datenbank (syncStandby) </li>
- </ul></ul>
- <br>
-
- Zur Aktivierung der Funktion "Autorename" wird dem definierten DbRep-Device mit dem Attribut "role" die Rolle "Agent" zugewiesen. Die Standardrolle nach Definition
- ist "Client". Mehr ist dazu im Abschnitt <a href="#DbRepAutoRename">DbRep-Agent</a> beschrieben. <br><br>
-
- DbRep stellt dem Nutzer einen UserExit zur Verfügung. Über diese Schnittstelle kann der Nutzer in Abhängigkeit von
- frei definierbaren Reading/Value-Kombinationen (Regex) eigenen Code zur Ausführung bringen. Diese Schnittstelle arbeitet
- unabhängig von einer Eventgenerierung. Weitere Informationen dazu ist unter <a href="#DbRepattr">Attribut</a>
- "userExitFn" beschrieben. <br><br>
-
- FHEM-Forum: <br>
- <a href="https://forum.fhem.de/index.php/topic,53584.msg452567.html#msg452567">Modul 93_DbRep - Reporting und Management von Datenbankinhalten (DbLog)</a>. <br><br>
-
- FHEM-Wiki: <br>
- <a href="https://wiki.fhem.de/wiki/DbRep_-_Reporting_und_Management_von_DbLog-Datenbankinhalten">DbRep - Reporting und Management von DbLog-Datenbankinhalten</a>. <br><br>
-
- <b>Voraussetzungen </b> <br><br>
-
- Das Modul setzt den Einsatz einer oder mehrerer DbLog-Instanzen voraus. Es werden die Zugangsdaten dieser
- Datenbankdefinition genutzt. <br>
- Es werden nur Inhalte der Tabelle "history" berücksichtigt wenn nichts anderes beschrieben ist. <br><br>
-
- Überblick welche anderen Perl-Module DbRep verwendet: <br><br>
-
- Net::FTP (nur wenn FTP-Transfer nach Datenbank-Dump genutzt wird) <br>
- Net::FTPSSL (nur wenn FTP-Transfer mit Verschlüsselung nach Datenbank-Dump genutzt wird) <br>
- POSIX <br>
- Time::HiRes <br>
- Time::Local <br>
- Scalar::Util <br>
- DBI <br>
- Color (FHEM-Modul) <br>
- IO::Compress::Gzip <br>
- IO::Uncompress::Gunzip <br>
- Blocking (FHEM-Modul) <br><br>
-
- Aus Performancegründen sollten zusätzlich folgender Index erstellt werden: <br>
- <code>
- CREATE INDEX Report_Idx ON `history` (TIMESTAMP, READING) USING BTREE;
- </code>
- </ul>
- <br>
- <a name="DbRepdefine"></a>
- <b>Definition</b>
- <br>
- <ul>
- <code>
- define <name> DbRep <Name der DbLog-Instanz>
- </code>
-
- <br><br>
- (<Name der DbLog-Instanz> - es wird der Name der auszuwertenden DBLog-Datenbankdefinition angegeben <b>nicht</b> der Datenbankname selbst)
- </ul>
- <br><br>
- <a name="DbRepset"></a>
- <b>Set </b>
- <ul>
- Zur Zeit gibt es folgende Set-Kommandos. Über sie werden die Auswertungen angestoßen und definieren selbst die Auswertungsvariante.
- Nach welchen Kriterien die Datenbankinhalte durchsucht werden und die Aggregation erfolgt, wird durch <a href="#DbRepattr">Attribute</a> gesteuert.
- <br><br>
-
- <ul><ul>
- <li><b> averageValue [display | writeToDB]</b>
- - berechnet einen Durchschnittswert des Datenbankfelds "VALUE" in den
- gegebenen Zeitgrenzen ( siehe <a href="#DbRepattr">Attribute</a>).
- Es muss das auszuwertende Reading über das <a href="#DbRepattr">Attribut</a> "reading"
- angegeben sein. <br>
- Mit dem Attribut "averageCalcForm" wird die Berechnungsvariante zur Mittelwertermittlung definiert.
- Zur Zeit sind folgende Varianten implementiert: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>avgArithmeticMean</b> </td><td>: es wird der arithmetische Mittelwert berechnet
- (default) </td></tr>
- <tr><td> <b>avgDailyMeanGWS</b> </td><td>: berechnet die Tagesmitteltemperatur entsprechend den
- <a href='https://www.dwd.de/DE/leistungen/klimadatendeutschland/beschreibung_tagesmonatswerte.html'>Vorschriften</a> des Deutschen Wetterdienstes. <br>
- Diese Variante verwendet automatisch die Aggregation "day". </td></tr>
- <tr><td> <b>avgTimeWeightMean</b> </td><td>: berechnet den zeitgewichteten Mittelwert </td></tr>
- </table>
- </ul>
- <br>
-
- Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit
- der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen
- in der Datenbank gespeichert. <br>
- Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet.
- Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen. <br>
- Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode
- abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann.
- Das Feld "EVENT" wird mit "calculated" gefüllt.<br><br>
-
- <ul>
- <b>Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":</b> <br>
- avgam_day_totalpac <br>
- # <Bildungsfunktion>_<Aggregation>_<Originalreading> <br>
- </li> <br>
- </ul>
- <li><b> cancelDump </b> - bricht einen laufenden Datenbankdump ab. </li> <br>
-
- <li><b> changeValue </b> - ändert den gespeicherten Wert eines Readings.
- Ist die Selektion auf bestimmte Device/Reading-Kombinationen durch die
- <a href="#DbRepattr">Attribute</a> "device" bzw. "reading" beschränkt, werden sie genauso
- berücksichtigt wie gesetzte Zeitgrenzen (Attribute time.*). <br>
- Fehlen diese Beschränkungen, wird die gesamte Datenbank durchsucht und der angegebene Wert
- geändert. <br><br>
-
- <ul>
- <b>Syntax: </b> <br>
- set <name> changeValue "<alter String>","<neuer String>" <br><br>
-
- Die Strings werden in Doppelstrich eingeschlossen und durch Komma getrennt.
- Dabei kann "String" sein: <br>
-
- <pre>
- <alter String> : * ein einfacher String mit/ohne Leerzeichen, z.B. "OL 12"
- * ein String mit Verwendung von SQL-Wildcard, z.B. "%OL%"
-
- <neuer String> : * ein einfacher String mit/ohne Leerzeichen, z.B. "12 kWh"
- * Perl Code eingeschlossen in {}, z.B. {$VALUE = (split(",",$VALUE))[1]}.
- Dem Perl-Ausdruck werden die Variablen $VALUE und $UNIT übergeben. Sie können innerhalb
- des Perl-Code geändert werden. Der zurückgebene Wert von $VALUE und $UNIT wird in dem Feld
- VALUE bzw. UNIT des Datensatzes gespeichert.
- </pre>
-
- <b>Beispiele: </b> <br>
- set <name> changeValue "OL","12 OL" <br>
- # der alte Feldwert "OL" wird in "12 OL" geändert. <br><br>
-
- set <name> changeValue "%OL%","12 OL" <br>
- # enthält das Feld VALUE den Teilstring "OL", wird es in "12 OL" geändert. <br><br>
-
- set <name> changeValue "12 kWh","{$VALUE,$UNIT = split(" ",$VALUE)}" <br>
- # der alte Feldwert "12 kWh" wird in VALUE=12 und UNIT=kWh gesplittet und in den Datenbankfeldern gespeichert <br><br>
- set <name> changeValue "24%","{$VALUE = (split(" ",$VALUE))[0]}" <br>
- # beginnt der alte Feldwert mit "24", wird er gesplittet und VALUE=24 gespeichert (z.B. "24 kWh")
- <br><br>
-
- Zusammengefasst sind die zur Steuerung von changeValue relevanten Attribute: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>device</b> </td><td>: Selektion nur von Datensätzen die <device> enthalten </td></tr>
- <tr><td> <b>reading</b> </td><td>: Selektion nur von Datensätzen die <reading> enthalten </td></tr>
- <tr><td> <b>time.*</b> </td><td>: eine Reihe von Attributen zur Zeitabgrenzung </td></tr>
- <tr><td> <b>executeBeforeProc</b> </td><td>: ausführen FHEM Kommando (oder perl-Routine) vor Start changeValue </td></tr>
- <tr><td> <b>executeAfterProc</b> </td><td>: ausführen FHEM Kommando (oder perl-Routine) nach Ende changeValue </td></tr>
- </table>
- </ul>
- <br>
- <br>
-
- <b>Hinweis:</b> <br>
- Obwohl die Funktion selbst non-blocking ausgelegt ist, sollte das zugeordnete DbLog-Device
- im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden (Tabellen-Lock). <br><br>
- </li> <br>
- </ul>
-
- <li><b> countEntries [history | current] </b>
- - liefert die Anzahl der Tabelleneinträge (default: history) in den gegebenen
- Zeitgrenzen (siehe <a href="#DbRepattr">Attribute</a>).
- Sind die Timestamps nicht gesetzt werden alle Einträge gezählt.
- Beschränkungen durch die <a href="#DbRepattr">Attribute</a> Device bzw. Reading
- gehen in die Selektion mit ein. </li> <br>
- <li><b> delEntries </b> - löscht alle oder die durch die <a href="#DbRepattr">Attribute</a> device und/oder
- reading definierten Datenbankeinträge. Die Eingrenzung über Timestamps erfolgt
- folgendermaßen: <br><br>
-
- <ul>
- "timestamp_begin" gesetzt: gelöscht werden DB-Einträge <b>ab</b> diesem Zeitpunkt bis zum aktuellen Datum/Zeit <br>
- "timestamp_end" gesetzt : gelöscht werden DB-Einträge <b>bis</b> bis zu diesem Zeitpunkt <br>
- beide Timestamps gesetzt : gelöscht werden DB-Einträge <b>zwischen</b> diesen Zeitpunkten <br>
-
- <br>
- Aus Sicherheitsgründen muss das <a href="#DbRepattr">Attribut</a> "allowDeletion"
- gesetzt sein um die Löschfunktion freizuschalten. <br>
- </li>
- <br>
- </ul>
-
- <li><b> delSeqDoublets [adviceRemain | adviceDelete | delete]</b> - zeigt bzw. löscht aufeinander folgende identische Datensätze.
- Dazu wird Device,Reading und Value ausgewertet. Nicht gelöscht werden der erste und der letzte Datensatz
- einer Aggregationsperiode (z.B. hour, day, week usw.) sowie die Datensätze vor oder nach einem Wertewechsel
- (Datenbankfeld VALUE). <br>
- Die <a href="#DbRepattr">Attribute</a> zur Aggregation,Zeit-,Device- und Reading-Abgrenzung werden dabei
- berücksichtigt. Ist das Attribut "aggregation" nicht oder auf "no" gesetzt, wird als Standard die Aggregation
- "day" verwendet. Für Datensätze mit numerischen Werten kann mit dem <a href="#DbRepattr">Attribut</a>
- "seqDoubletsVariance" eine Abweichung eingestellt werden, bis zu der aufeinander folgende numerische Werte als
- identisch angesehen und gelöscht werden sollen.
- <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>adviceRemain</b> </td><td>: simuliert die nach der Operation in der DB verbleibenden Datensätze (es wird nichts gelöscht !) </td></tr>
- <tr><td> <b>adviceDelete</b> </td><td>: simuliert die zu löschenden Datensätze (es wird nichts gelöscht !) </td></tr>
- <tr><td> <b>delete</b> </td><td>: löscht die sequentiellen Dubletten (siehe Beispiel) </td></tr>
- </table>
- </ul>
- <br>
- Aus Sicherheitsgründen muss das <a href="#DbRepattr">Attribut</a> "allowDeletion" für die "delete" Option
- gesetzt sein. <br>
- Die Anzahl der anzuzeigenden Datensätze der Kommandos "delSeqDoublets adviceDelete", "delSeqDoublets adviceRemain" ist
- zunächst begrenzt (default 1000) und kann durch das <a href="#DbRepattr">Attribut</a> "limit" angepasst werden.
- Die Einstellung von "limit" hat keinen Einfluss auf die "delSeqDoublets delete" Funktion, sondern beeinflusst <b>NUR</b> die
- Anzeige der Daten. <br>
- Vor und nach der Ausführung von "delSeqDoublets" kann ein FHEM-Kommando bzw. Perl-Routine ausgeführt werden.
- (siehe <a href="#DbRepattr">Attribute</a> "executeBeforeProc", "executeAfterProc")
- <br><br>
-
- <ul>
- <b>Beispiel</b> - die nach Verwendung der delete-Option in der DB verbleibenden Datensätze sind <b>fett</b>
- gekennzeichnet:<br><br>
- <ul>
- <b>2017-11-25_00-00-05__eg.az.fridge_Pwr__power 0 </b> <br>
- 2017-11-25_00-02-26__eg.az.fridge_Pwr__power 0 <br>
- 2017-11-25_00-04-33__eg.az.fridge_Pwr__power 0 <br>
- 2017-11-25_01-06-10__eg.az.fridge_Pwr__power 0 <br>
- <b>2017-11-25_01-08-21__eg.az.fridge_Pwr__power 0 </b> <br>
- <b>2017-11-25_01-08-59__eg.az.fridge_Pwr__power 60.32 </b> <br>
- <b>2017-11-25_01-11-21__eg.az.fridge_Pwr__power 56.26 </b> <br>
- <b>2017-11-25_01-27-54__eg.az.fridge_Pwr__power 6.19 </b> <br>
- <b>2017-11-25_01-28-51__eg.az.fridge_Pwr__power 0 </b> <br>
- 2017-11-25_01-31-00__eg.az.fridge_Pwr__power 0 <br>
- 2017-11-25_01-33-59__eg.az.fridge_Pwr__power 0 <br>
- <b>2017-11-25_02-39-29__eg.az.fridge_Pwr__power 0 </b> <br>
- <b>2017-11-25_02-41-18__eg.az.fridge_Pwr__power 105.28</b> <br>
- <b>2017-11-25_02-41-26__eg.az.fridge_Pwr__power 61.52 </b> <br>
- <b>2017-11-25_03-00-06__eg.az.fridge_Pwr__power 47.46 </b> <br>
- <b>2017-11-25_03-00-33__eg.az.fridge_Pwr__power 0 </b> <br>
- 2017-11-25_03-02-07__eg.az.fridge_Pwr__power 0 <br>
- 2017-11-25_23-37-42__eg.az.fridge_Pwr__power 0 <br>
- <b>2017-11-25_23-40-10__eg.az.fridge_Pwr__power 0 </b> <br>
- <b>2017-11-25_23-42-24__eg.az.fridge_Pwr__power 1 </b> <br>
- 2017-11-25_23-42-24__eg.az.fridge_Pwr__power 1 <br>
- <b>2017-11-25_23-45-27__eg.az.fridge_Pwr__power 1 </b> <br>
- <b>2017-11-25_23-47-07__eg.az.fridge_Pwr__power 0 </b> <br>
- 2017-11-25_23-55-27__eg.az.fridge_Pwr__power 0 <br>
- <b>2017-11-25_23-48-15__eg.az.fridge_Pwr__power 0 </b> <br>
- <b>2017-11-25_23-50-21__eg.az.fridge_Pwr__power 59.1 </b> <br>
- <b>2017-11-25_23-55-14__eg.az.fridge_Pwr__power 52.31 </b> <br>
- <b>2017-11-25_23-58-09__eg.az.fridge_Pwr__power 51.73 </b> <br>
- </ul>
- </ul>
-
- </li>
- <br>
- <br>
-
- <li><b> deviceRename </b> - benennt den Namen eines Device innerhalb der angeschlossenen Datenbank (Internal
- DATABASE) um.
- Der Gerätename wird immer in der <b>gesamten</b> Datenbank umgesetzt. Eventuell gesetzte
- Zeitgrenzen oder Beschränkungen durch die <a href="#DbRepattr">Attribute</a> Device bzw.
- Reading werden nicht berücksichtigt. <br><br>
-
- <ul>
- <b>Beispiel: </b><br>
- set <name> deviceRename <alter Devicename>,<neuer Devicename> <br>
- # Die Anzahl der umbenannten Device-Datensätze wird im Reading "device_renamed" ausgegeben. <br>
- # Wird der umzubenennende Gerätename in der Datenbank nicht gefunden, wird eine WARNUNG im Reading "device_not_renamed" ausgegeben. <br>
- # Entsprechende Einträge erfolgen auch im Logfile mit verbose=3
- <br><br>
-
- <b>Hinweis:</b> <br>
- Obwohl die Funktion selbst non-blocking ausgelegt ist, sollte das zugeordnete DbLog-Device
- im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden (Tabellen-Lock). <br><br>
- </li> <br>
- </ul>
-
- <li><b> diffValue [display | writeToDB] </b>
- - berechnet den Differenzwert des Datenbankfelds "VALUE" in den Zeitgrenzen (Attribute) "timestamp_begin", "timestamp_end" bzw "timeDiffToNow / timeOlderThan".
- Es muss das auszuwertende Reading im Attribut "reading" angegeben sein.
- Diese Funktion ist z.B. zur Auswertung von Eventloggings sinnvoll, deren Werte sich fortlaufend erhöhen und keine Wertdifferenzen wegschreiben. <br>
- Es wird immer die Differenz aus dem Value-Wert des ersten verfügbaren Datensatzes und dem Value-Wert des letzten verfügbaren Datensatzes innerhalb der angegebenen
- Zeitgrenzen/Aggregation gebildet, wobei ein Übertragswert der Vorperiode (Aggregation) zur darauf folgenden Aggregationsperiode
- berücksichtigt wird sofern diese einen Value-Wert enhtält. <br>
- Dabei wird ein Zählerüberlauf (Neubeginn bei 0) mit berücksichtigt (vergleiche <a href="#DbRepattr">Attribut</a> "diffAccept"). <br>
- Wird in einer auszuwertenden Zeit- bzw. Aggregationsperiode nur ein Datensatz gefunden, kann die Differenz in Verbindung mit dem
- Differenzübertrag der Vorperiode berechnet werden. in diesem Fall kann es zu einer logischen Ungenauigkeit in der Zuordnung der Differenz
- zu der Aggregationsperiode kommen. Deswegen wird eine Warnung im "state" und das
- Reading "less_data_in_period" mit einer Liste der betroffenen Perioden wird erzeugt. <br><br>
-
- <ul>
- <b>Hinweis: </b><br>
- Im Auswertungs- bzw. Aggregationszeitraum (Tag, Woche, Monat, etc.) sollten dem Modul pro Periode mindestens ein Datensatz
- zu Beginn und ein Datensatz gegen Ende des Aggregationszeitraumes zur Verfügung stehen um eine möglichst genaue Auswertung
- der Differenzwerte vornehmen zu können.
- <br>
- <br>
- </ul>
- Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit
- der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen
- in der Datenbank gespeichert. <br>
- Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet.
- Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen. <br>
- Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode
- abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann.
- Das Feld "EVENT" wird mit "calculated" gefüllt.<br><br>
-
- <ul>
- <b>Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":</b> <br>
- diff_day_totalpac <br>
- # <Bildungsfunktion>_<Aggregation>_<Originalreading> <br>
- </li> <br>
- </ul>
- <li><b> dumpMySQL [clientSide | serverSide]</b>
- - erstellt einen Dump der angeschlossenen MySQL-Datenbank. <br>
- Abhängig von der ausgewählten Option wird der Dump auf der Client- bzw. Serverseite erstellt. <br>
- Die Varianten unterscheiden sich hinsichtlich des ausführenden Systems, des Erstellungsortes, der
- Attributverwendung, des erzielten Ergebnisses und der benötigten Hardwareressourcen. <br>
- Die Option "clientSide" benötigt z.B. eine leistungsfähigere Hardware des FHEM-Servers, sichert aber alle
- Tabellen inklusive eventuell angelegter Views. <br>
- Mit dem Attribut "dumpCompress" kann eine Komprimierung der erstellten Dumpfiles eingeschaltet werden.
- <br><br>
-
- <ul>
- <b><u>Option clientSide</u></b> <br>
- Der Dump wird durch den Client (FHEM-Rechner) erstellt und per default im log-Verzeichnis des Clients
- gespeichert.
- Das Zielverzeichnis kann mit dem <a href="#DbRepattr">Attribut</a> "dumpDirLocal" verändert werden und muß auf
- dem Client durch FHEM beschreibbar sein. <br>
- Vor dem Dump kann eine Tabellenoptimierung (Attribut "optimizeTablesBeforeDump") oder ein FHEM-Kommando
- (Attribut "executeBeforeProc") optional zugeschaltet werden.
- Nach dem Dump kann ebenfalls ein FHEM-Kommando (siehe Attribut "executeAfterProc") ausgeführt werden. <br><br>
-
- <b>Achtung ! <br>
- Um ein Blockieren von FHEM zu vermeiden, muß DbLog im asynchronen Modus betrieben werden wenn die
- Tabellenoptimierung verwendet wird ! </b> <br><br>
-
- Über die <a href="#DbRepattr">Attribute</a> "dumpMemlimit" und "dumpSpeed" kann das Laufzeitverhalten der
- Funktion beeinflusst werden um eine Optimierung bezüglich Performance und Ressourcenbedarf zu erreichen. <br><br>
-
- Die für "dumpMySQL clientSide" relevanten Attribute sind: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> dumpComment </td><td>: User-Kommentar im Dumpfile </td></tr>
- <tr><td> dumpCompress </td><td>: Komprimierung des Dumpfiles nach der Erstellung </td></tr>
- <tr><td> dumpDirLocal </td><td>: das lokale Zielverzeichnis für die Erstellung des Dump </td></tr>
- <tr><td> dumpMemlimit </td><td>: Begrenzung der Speicherverwendung </td></tr>
- <tr><td> dumpSpeed </td><td>: Begrenzung die CPU-Belastung </td></tr>
- <tr><td> dumpFilesKeep </td><td>: Anzahl der aufzubwahrenden Dumpfiles </td></tr>
- <tr><td> executeBeforeProc </td><td>: ausführen FHEM Kommando (oder perl-Routine) vor dem Dump </td></tr>
- <tr><td> executeAfterProc </td><td>: ausführen FHEM Kommando (oder perl-Routine) nach dem Dump </td></tr>
- <tr><td> optimizeTablesBeforeDump </td><td>: Tabelloptimierung vor dem Dump ausführen </td></tr>
- </table>
- </ul>
- <br>
-
- Nach einem erfolgreichen Dump werden alte Dumpfiles gelöscht und nur die Anzahl Files, definiert durch
- das Attribut "dumpFilesKeep" (default: 3), verbleibt im Zielverzeichnis "dumpDirLocal". Falls "dumpFilesKeep = 0"
- gesetzt ist, werden alle Dumpfiles (auch das aktuell erstellte File), gelöscht.
- Diese Einstellung kann sinnvoll sein, wenn FTP aktiviert ist
- und die erzeugten Dumps nur im FTP-Zielverzeichnis erhalten bleiben sollen. <br><br>
-
- Die <b>Namenskonvention der Dumpfiles</b> ist: <dbname>_<date>_<time>.sql[.gzip] <br><br>
-
- Das erzeugte Dumpfile kann z.B. mit: <br><br>
-
- <ul>
- mysql -u <user> -p <dbname> < <filename>.sql <br><br>
- </ul>
-
- auf dem MySQL-Server ausgeführt werden um die Datenbank aus dem Dump wiederherzustellen. <br><br>
- <br>
-
- <b><u>Option serverSide</u></b> <br>
- Der Dump wird durch den MySQL-Server erstellt und per default im Home-Verzeichnis des MySQL-Servers
- gespeichert. <br>
- Es wird die gesamte history-Tabelle (nicht current-Tabelle) <b>im CSV-Format</b> ohne
- Einschränkungen exportiert. <br>
- Vor dem Dump kann eine Tabellenoptimierung (Attribut "optimizeTablesBeforeDump")
- optional zugeschaltet werden . <br><br>
-
- <b>Achtung ! <br>
- Um ein Blockieren von FHEM zu vermeiden, muß DbLog im asynchronen Modus betrieben werden wenn die
- Tabellenoptimierung verwendet wird ! </b> <br><br>
-
- Vor und nach dem Dump kann ein FHEM-Kommando (siehe Attribute "executeBeforeProc", "executeAfterProc") ausgeführt
- werden. <br><br>
- Die für "dumpMySQL serverSide" relevanten Attribute sind: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> dumpDirRemote </td><td>: das Erstellungsverzeichnis des Dumpfile dem entfernten Server </td></tr>
- <tr><td> dumpCompress </td><td>: Komprimierung des Dumpfiles nach der Erstellung </td></tr>
- <tr><td> dumpDirLocal </td><td>: Directory des lokal gemounteten dumpDirRemote-Verzeichnisses </td></tr>
- <tr><td> dumpFilesKeep </td><td>: Anzahl der aufzubwahrenden Dumpfiles </td></tr>
- <tr><td> executeBeforeProc </td><td>: ausführen FHEM Kommando (oder perl-Routine) vor dem Dump </td></tr>
- <tr><td> executeAfterProc </td><td>: ausführen FHEM Kommando (oder perl-Routine) nach dem Dump </td></tr>
- <tr><td> optimizeTablesBeforeDump </td><td>: Tabelloptimierung vor dem Dump ausführen </td></tr>
- </table>
- </ul>
- <br>
-
- Das Zielverzeichnis kann mit dem <a href="#DbRepattr">Attribut</a> "dumpDirRemote" verändert werden.
- Es muß sich auf dem MySQL-Host gefinden und durch den MySQL-Serverprozess beschreibbar sein. <br>
- Der verwendete Datenbankuser benötigt das "FILE"-Privileg. <br><br>
-
- <b>Hinweis:</b> <br>
- Soll die interne Versionsverwaltung und die Dumpfilekompression des Moduls genutzt, sowie die Größe des erzeugten
- Dumpfiles ausgegeben werden, ist das Verzeichnis "dumpDirRemote" des MySQL-Servers auf dem Client zu mounten
- und im <a href="#DbRepattr">Attribut</a> "dumpDirLocal" dem DbRep-Device bekannt zu machen. <br>
- Gleiches gilt wenn der FTP-Transfer nach dem Dump genutzt werden soll (Attribut "ftpUse" bzw. "ftpUseSSL").
- <br><br>
- <ul>
- <b>Beispiel: </b> <br>
- attr <name> dumpDirRemote /volume1/ApplicationBackup/dumps_FHEM/ <br>
- attr <name> dumpDirLocal /sds1/backup/dumps_FHEM/ <br>
- attr <name> dumpFilesKeep 2 <br><br>
-
- # Der Dump wird remote auf dem MySQL-Server im Verzeichnis '/volume1/ApplicationBackup/dumps_FHEM/'
- erstellt. <br>
- # Die interne Versionsverwaltung sucht im lokal gemounteten Verzeichnis '/sds1/backup/dumps_FHEM/'
- vorhandene Dumpfiles und löscht diese bis auf die zwei letzten Versionen. <br>
- <br>
- </ul>
-
- Wird die interne Versionsverwaltung genutzt, werden nach einem erfolgreichen Dump alte Dumpfiles gelöscht
- und nur die Anzahl "dumpFilesKeep" (default: 3) verbleibt im Zielverzeichnis "dumpDirRemote".
- FHEM benötigt in diesem Fall Schreibrechte auf dem Verzeichnis "dumpDirLocal". <br><br>
- Die <b>Namenskonvention der Dumpfiles</b> ist: <dbname>_<date>_<time>.csv[.gzip] <br><br>
-
- Ein Restore der Datenbank aus diesem Backup kann durch den Befehl: <br><br>
- <ul>
- set <name> <restoreMySQL> <filename>.csv[.gzip] <br><br>
- </ul>
-
- gestartet werden. <br><br>
-
- <b><u>FTP Transfer nach Dump</u></b> <br>
- Wenn diese Möglichkeit genutzt werden soll, ist das <a href="#DbRepattr">Attribut</a> "ftpUse" oder
- "ftpUseSSL" zu setzen. Letzteres gilt wenn eine verschlüsselte Übertragung genutzt werden soll. <br>
- Das Modul übernimmt ebenfalls die Versionierung der Dumpfiles im FTP-Zielverzeichnis mit Hilfe des Attributes
- "ftpDumpFilesKeep".
- Für die FTP-Übertragung relevante <a href="#DbRepattr">Attribute</a> sind: <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> ftpUse </td><td>: FTP Transfer nach dem Dump wird eingeschaltet (ohne SSL Verschlüsselung) </td></tr>
- <tr><td> ftpUser </td><td>: User zur Anmeldung am FTP-Server, default: anonymous </td></tr>
- <tr><td> ftpUseSSL </td><td>: FTP Transfer mit SSL Verschlüsselung nach dem Dump wird eingeschaltet </td></tr>
- <tr><td> ftpDebug </td><td>: Debugging des FTP Verkehrs zur Fehlersuche </td></tr>
- <tr><td> ftpDir </td><td>: Verzeichnis auf dem FTP-Server in welches das File übertragen werden soll (default: "/") </td></tr>
- <tr><td> ftpDumpFilesKeep </td><td>: Es wird die angegebene Anzahl Dumpfiles im <ftpDir> belassen (default: 3) </td></tr>
- <tr><td> ftpPassive </td><td>: setzen wenn passives FTP verwendet werden soll </td></tr>
- <tr><td> ftpPort </td><td>: FTP-Port, default: 21 </td></tr>
- <tr><td> ftpPwd </td><td>: Passwort des FTP-Users, default nicht gesetzt </td></tr>
- <tr><td> ftpServer </td><td>: Name oder IP-Adresse des FTP-Servers. <b>notwendig !</b> </td></tr>
- <tr><td> ftpTimeout </td><td>: Timeout für die FTP-Verbindung in Sekunden (default: 30). </td></tr>
- </table>
- </ul>
- <br>
- <br>
-
- </ul>
- </li><br>
-
- <li><b> dumpSQLite </b> - erstellt einen Dump der angeschlossenen SQLite-Datenbank. <br>
- Diese Funktion nutzt die SQLite Online Backup API und ermöglicht es konsistente Backups der SQLite-DB
- in laufenden Betrieb zu erstellen.
- Der Dump wird per default im log-Verzeichnis des FHEM-Rechners gespeichert.
- Das Zielverzeichnis kann mit dem <a href="#DbRepattr">Attribut</a> "dumpDirLocal" verändert werden und muß
- durch FHEM beschreibbar sein.
- Vor dem Dump kann optional eine Tabellenoptimierung (Attribut "optimizeTablesBeforeDump")
- zugeschaltet werden.
- <br><br>
-
- <b>Achtung ! <br>
- Um ein Blockieren von FHEM zu vermeiden, muß DbLog im asynchronen Modus betrieben werden wenn die
- Tabellenoptimierung verwendet wird ! </b> <br><br>
-
- Vor und nach dem Dump kann ein FHEM-Kommando (siehe Attribute "executeBeforeProc", "executeAfterProc")
- ausgeführt werden. <br><br>
-
- Die für diese Funktion relevanten Attribute sind: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> dumpCompress </td><td>: Komprimierung des Dumpfiles nach der Erstellung </td></tr>
- <tr><td> dumpDirLocal </td><td>: Directory des lokal gemounteten dumpDirRemote-Verzeichnisses </td></tr>
- <tr><td> dumpFilesKeep </td><td>: Anzahl der aufzubwahrenden Dumpfiles </td></tr>
- <tr><td> executeBeforeProc </td><td>: ausführen FHEM Kommando (oder perl-Routine) vor dem Dump </td></tr>
- <tr><td> executeAfterProc </td><td>: ausführen FHEM Kommando (oder perl-Routine) nach dem Dump </td></tr>
- <tr><td> optimizeTablesBeforeDump </td><td>: Tabelloptimierung vor dem Dump ausführen </td></tr>
- </table>
- </ul>
- <br>
-
- Nach einem erfolgreichen Dump werden alte Dumpfiles gelöscht und nur die Anzahl Files, definiert durch das
- Attribut "dumpFilesKeep" (default: 3), verbleibt im Zielverzeichnis "dumpDirLocal". Falls "dumpFilesKeep = 0" gesetzt, werden
- alle Dumpfiles (auch das aktuell erstellte File), gelöscht. Diese Einstellung kann sinnvoll sein, wenn FTP aktiviert ist
- und die erzeugten Dumps nur im FTP-Zielverzeichnis erhalten bleiben sollen. <br><br>
-
- Die <b>Namenskonvention der Dumpfiles</b> ist: <dbname>_<date>_<time>.sqlitebkp[.gzip] <br><br>
-
- Die Datenbank kann mit "set <name> restoreSQLite <Filename>" wiederhergestellt
- werden. <br>
- Das erstellte Dumpfile kann auf einen FTP-Server übertragen werden. Siehe dazu die Erläuterungen
- unter "dumpMySQL". <br><br>
- </li><br>
- <li><b> eraseReadings </b> - Löscht alle angelegten Readings im Device, außer dem Reading "state" und Readings, die in der
- Ausnahmeliste definiert mit Attribut "readingPreventFromDel" enthalten sind.
- </li><br>
-
- <li><b> exportToFile </b> - exportiert DB-Einträge im CSV-Format in den gegebenen Zeitgrenzen.
- Einschränkungen durch die <a href="#DbRepattr">Attribute</a> Device bzw. Reading gehen in die Selektion mit ein.
- Der Filename wird durch das <a href="#DbRepattr">Attribut</a> "expimpfile" bestimmt. <br>
- Durch das Attribut "aggregation" wird der Export der Datensätze in Zeitscheiben der angegebenen Aggregation
- vorgenommen. Ist z.B. "aggregation = month" gesetzt, werden die Daten in monatlichen Paketen selektiert und in
- das Exportfile geschrieben. Dadurch wird die Hauptspeicherverwendung optimiert wenn sehr große Datenmengen
- exportiert werden sollen und vermeidet den "died prematurely" Abbruchfehler.
- </li><br>
-
- <li><b> fetchrows [history|current] </b>
- - liefert <b>alle</b> Tabelleneinträge (default: history)
- in den gegebenen Zeitgrenzen bzw. Selektionsbedingungen durch die <a href="#DbRepattr">Attribute</a>
- "device" und "reading".
- Eine evtl. gesetzte Aggregation wird dabei <b>nicht</b> berücksichtigt. <br>
- Die Leserichtung in der Datenbank kann durch das <a href="#DbRepattr">Attribut</a>
- "fetchRoute" bestimmt werden. <br><br>
-
- Jedes Ergebnisreading setzt sich aus dem Timestring des Datensatzes, einem Index, dem Device
- und dem Reading zusammen.
- Die Funktion fetchrows ist in der Lage mehrfach vorkommende Datensätze (Dubletten) zu erkennen.
- Solche Dubletten sind mit einem Index > 1 gekennzeichnet. <br>
- Dubletten können mit dem Attribut "fetchMarkDuplicates" farblich hervorgehoben werden. <br><br>
-
- <b>Hinweis:</b> <br>
- Hervorgehobene Readings werden nach einem Restart bzw. nach rereadcfg nicht mehr angezeigt da
- sie nicht im statefile gesichert werden (Verletzung erlaubter Readingnamen durch Formatierung).
- <br><br>
-
- Dieses Attribut ist mit einigen Farben vorbelegt, kann aber mit dem colorpicker-Widget
- überschrieben werden: <br><br>
-
- <ul>
- <code>
- attr <name> widgetOverride fetchMarkDuplicates:colorpicker
- </code>
- </ul>
- <br>
-
- Die Ergebnisreadings von fetchrows sind nach folgendem Schema aufgebaut: <br><br>
-
- <ul>
- <b>Beispiel:</b> <br>
- 2017-10-22_03-04-43__1__SMA_Energymeter__Bezug_WirkP_Kosten_Diff <br>
- # <Datum>_<Zeit>__<Index>__<Device>__<Reading>
- </ul>
- <br>
- Zur besseren Übersicht sind die zur Steuerung von fetchrows relevanten Attribute hier noch einmal
- dargestellt: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>fetchRoute</b> </td><td>: Leserichtung des Selekts innerhalb der Datenbank </td></tr>
- <tr><td> <b>limit</b> </td><td>: begrenzt die Anzahl zu selektierenden bzw. anzuzeigenden Datensätze </td></tr>
- <tr><td> <b>fetchMarkDuplicates</b> </td><td>: Hervorhebung von gefundenen Dubletten </td></tr>
- <tr><td> <b>device</b> </td><td>: Selektion nur von Datensätzen die <device> enthalten </td></tr>
- <tr><td> <b>reading</b> </td><td>: Selektion nur von Datensätzen die <reading> enthalten </td></tr>
- <tr><td> <b>time.*</b> </td><td>: eine Reihe von Attributen zur Zeitabgrenzung </td></tr>
- </table>
- </ul>
- <br>
- <br>
- <b>Hinweis:</b> <br>
- Auch wenn das Modul bezüglich der Datenbankabfrage nichtblockierend arbeitet, kann eine
- zu große Ergebnismenge (Anzahl Zeilen bzw. Readings) die Browsersesssion bzw. FHEMWEB
- blockieren. Aus diesem Grund wird die Ergebnismenge mit dem
- <a href="#DbRepattrlimit">Attribut</a> "limit" begrenzt. Bei Bedarf kann dieses Attribut
- geändert werden, falls eine Anpassung der Selektionsbedingungen nicht möglich oder
- gewünscht ist. <br><br>
- </li> <br>
-
- <li><b> insert </b> - Manuelles Einfügen eines Datensatzes in die Tabelle "history". Obligatorisch sind Eingabewerte für Datum, Zeit und Value.
- Die Werte für die DB-Felder Type bzw. Event werden mit "manual" gefüllt, sowie die Werte für Device, Reading aus den gesetzten <a href="#DbRepattr">Attributen </a> genommen. <br><br>
-
- <ul>
- <b>Eingabeformat: </b> Datum,Zeit,Value,[Unit] <br>
- # Unit ist optional, Attribute "reading" und "device" müssen gesetzt sein <br>
- # Soll "Value=0" eingefügt werden, ist "Value = 0.0" zu verwenden. <br><br>
-
- <b>Beispiel: </b> 2016-08-01,23:00:09,TestValue,TestUnit <br>
- # Es sind KEINE Leerzeichen im Feldwert erlaubt !<br>
- <br>
-
- <b>Hinweis: </b><br>
- Bei der Eingabe ist darauf zu achten dass im beabsichtigten Aggregationszeitraum (Tag, Woche, Monat, etc.) MINDESTENS zwei
- Datensätze für die Funktion diffValue zur Verfügung stehen. Ansonsten kann keine Differenz berechnet werden und diffValue
- gibt in diesem Fall "0" in der betroffenen Periode aus !
- <br>
- <br>
- </li>
- </ul>
-
- <li><b> importFromFile </b> - importiert Datensätze im CSV-Format aus einem File in die Datenbank. Der Filename wird
- durch das <a href="#DbRepattr">Attribut</a> "expimpfile" bestimmt. <br><br>
-
- <ul>
- <b>Datensatzformat: </b> "TIMESTAMP","DEVICE","TYPE","EVENT","READING","VALUE","UNIT" <br><br>
- # Die Felder "TIMESTAMP","DEVICE","TYPE","EVENT","READING" und "VALUE" müssen gesetzt sein. Das Feld "UNIT" ist optional.
- Der Fileinhalt wird als Transaktion importiert, d.h. es wird der Inhalt des gesamten Files oder, im Fehlerfall, kein Datensatz des Files importiert.
- Wird eine umfangreiche Datei mit vielen Datensätzen importiert sollte KEIN verbose=5 gesetzt werden. Es würden in diesem Fall sehr viele Sätze in
- das Logfile geschrieben werden was FHEM blockieren oder überlasten könnte. <br><br>
-
- <b>Beispiel: </b> "2016-09-25 08:53:56","STP_5000","SMAUTILS","etotal: 11859.573","etotal","11859.573","" <br>
- <br>
- </li> <br>
- </ul>
-
- <li><b> maxValue [display | writeToDB] </b>
- - berechnet den Maximalwert des Datenbankfelds "VALUE" in den Zeitgrenzen
- (Attribute) "timestamp_begin", "timestamp_end" bzw. "timeDiffToNow / timeOlderThan".
- Es muss das auszuwertende Reading über das <a href="#DbRepattr">Attribut</a> "reading"
- angegeben sein.
- Die Auswertung enthält den Zeitstempel des ermittelten Maximumwertes innerhalb der
- Aggregation bzw. Zeitgrenzen.
- Im Reading wird der Zeitstempel des <b>letzten</b> Auftretens vom Maximalwert ausgegeben
- falls dieser Wert im Intervall mehrfach erreicht wird. <br>
-
- Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit
- der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen
- in der Datenbank gespeichert. <br>
- Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet.
- Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen. <br>
- Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode
- abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann.
- Das Feld "EVENT" wird mit "calculated" gefüllt.<br><br>
-
- <ul>
- <b>Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":</b> <br>
- max_day_totalpac <br>
- # <Bildungsfunktion>_<Aggregation>_<Originalreading> <br>
- </li> <br>
- </ul>
-
- <li><b> minValue [display | writeToDB]</b>
- - berechnet den Minimalwert des Datenbankfelds "VALUE" in den Zeitgrenzen
- (Attribute) "timestamp_begin", "timestamp_end" bzw. "timeDiffToNow / timeOlderThan".
- Es muss das auszuwertende Reading über das <a href="#DbRepattr">Attribut</a> "reading"
- angegeben sein.
- Die Auswertung enthält den Zeitstempel des ermittelten Minimumwertes innerhalb der
- Aggregation bzw. Zeitgrenzen.
- Im Reading wird der Zeitstempel des <b>ersten</b> Auftretens vom Minimalwert ausgegeben
- falls dieser Wert im Intervall mehrfach erreicht wird. <br>
-
- Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit
- der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen
- in der Datenbank gespeichert. <br>
- Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet.
- Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen. <br>
- Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode
- abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann.
- Das Feld "EVENT" wird mit "calculated" gefüllt.<br><br>
-
- <ul>
- <b>Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":</b> <br>
- min_day_totalpac <br>
- # <Bildungsfunktion>_<Aggregation>_<Originalreading> <br>
- </li> <br>
- </ul>
-
- <li><b> optimizeTables </b> - optimiert die Tabellen in der angeschlossenen Datenbank (MySQL). <br>
- Vor und nach der Optimierung kann ein FHEM-Kommando ausgeführt werden.
- (siehe <a href="#DbRepattr">Attribute</a> "executeBeforeProc", "executeAfterProc")
- <br><br>
-
- <ul>
- <b>Hinweis:</b> <br>
- Obwohl die Funktion selbst non-blocking ausgelegt ist, muß das zugeordnete DbLog-Device
- im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden. <br><br>
- </li>
- </ul><br>
-
- <li><b> readingRename </b> - benennt den Namen eines Readings innerhalb der angeschlossenen Datenbank (siehe Internal DATABASE) um.
- Der Readingname wird immer in der <b>gesamten</b> Datenbank umgesetzt. Eventuell
- gesetzte Zeitgrenzen oder Beschränkungen durch die <a href="#DbRepattr">Attribute</a>
- Device bzw. Reading werden nicht berücksichtigt. <br><br>
-
- <ul>
- <b>Beispiel: </b><br>
- set <name> readingRename <alter Readingname>,<neuer Readingname> <br>
- # Die Anzahl der umbenannten Device-Datensätze wird im Reading "reading_renamed"
- ausgegeben. <br>
- # Wird der umzubenennende Readingname in der Datenbank nicht gefunden, wird eine
- WARNUNG im Reading "reading_not_renamed" ausgegeben. <br>
- # Entsprechende Einträge erfolgen auch im Logfile mit verbose=3.
- <br><br>
-
- <b>Hinweis:</b> <br>
- Obwohl die Funktion selbst non-blocking ausgelegt ist, sollte das zugeordnete DbLog-Device
- im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden (Tabellen-Lock). <br><br>
- </li> <br>
- </ul>
- <li><b> repairSQLite </b> - repariert eine korrupte SQLite-Datenbank. <br>
- Eine Korruption liegt im Allgemeinen vor wenn die Fehlermitteilung "database disk image is malformed"
- im state des DbLog-Devices erscheint.
- Wird dieses Kommando gestartet, wird das angeschlossene DbLog-Device zunächst automatisch für 10 Stunden
- (36000 Sekunden) von der Datenbank getrennt (Trennungszeit). Nach Abschluss der Reparatur erfolgt
- wieder eine sofortige Neuverbindung zur reparierten Datenbank. <br>
- Dem Befehl kann eine abweichende Trennungszeit (in Sekunden) als Argument angegeben werden. <br>
- Die korrupte Datenbank wird als <database>.corrupt im gleichen Verzeichnis gespeichert. <br><br>
-
- <ul>
- <b>Beispiel: </b><br>
- set <name> repairSQLite <br>
- # Die Datenbank wird repariert, Trennungszeit beträgt 10 Stunden <br>
- set <name> repairSQLite 600 <br>
- # Die Datenbank wird repariert, Trennungszeit beträgt 10 Minuten
- <br><br>
-
- <b>Hinweis:</b> <br>
- Es ist nicht garantiert, dass die Reparatur erfolgreich verläuft und keine Daten verloren gehen.
- Je nach Schwere der Korruption kann Datenverlust auftreten oder die Reparatur scheitern, auch wenn
- kein Fehler im Ablauf signalisiert wird. Ein Backup der Datenbank sollte unbedingt vorhanden
- sein ! <br><br>
- </li> <br>
- </ul>
- <li><b> restoreMySQL <File>.csv[.gzip] </b> - importiert den Inhalt der history-Tabelle aus einem serverSide-Backup. <br>
- Die Funktion stellt über eine Drop-Down Liste eine Dateiauswahl für den Restore zur Verfügung.
- Dazu ist das Verzeichnis "dumpDirRemote" des MySQL-Servers auf dem Client zu mounten
- und im <a href="#DbRepattr">Attribut</a> "dumpDirLocal" dem DbRep-Device bekannt zu machen. <br>
- Es werden alle Files mit der Endung "csv[.gzip]" und deren Name mit der
- verbundenen Datenbank beginnt (siehe Internal DATABASE), aufgelistet . <br><br>
- </li><br>
-
- <li><b> restoreSQLite <File>.sqlitebkp[.gzip] </b> - stellt das Backup einer SQLite-Datenbank wieder her. <br>
- Die Funktion stellt über eine Drop-Down Liste die für den Restore zur Verfügung stehenden Dateien
- zur Verfügung. Die aktuell in der Zieldatenbank enthaltenen Daten werden gelöscht bzw.
- überschrieben.
- Es werden alle Files mit der Endung "sqlitebkp[.gzip]" und deren Name mit dem Namen der
- verbundenen Datenbank beginnt, aufgelistet . <br><br>
- </li><br>
-
- <li><b> sqlCmd </b> - führt ein beliebiges Benutzer spezifisches Kommando aus. <br>
- Enthält dieses Kommando eine Delete-Operation, muss zur Sicherheit das
- <a href="#DbRepattr">Attribut</a> "allowDeletion" gesetzt sein. <br>
- Bei der Ausführung dieses Kommandos werden keine Einschränkungen durch gesetzte Attribute
- "device", "reading", "time.*" bzw. "aggregation" berücksichtigt. <br>
- Sollen die im Modul gesetzten <a href="#DbRepattr">Attribute</a> "timestamp_begin" bzw.
- "timestamp_end" im Statement berücksichtigt werden, können die Platzhalter
- "<b>§timestamp_begin§</b>" bzw. "<b>§timestamp_end§</b>" dafür verwendet werden. <br><br>
-
- Soll ein Datensatz upgedated werden, ist dem Statement "TIMESTAMP=TIMESTAMP" hinzuzufügen um eine Änderung des
- originalen Timestamps zu verhindern. <br><br>
-
- <ul>
- <b>Beispiele für Statements: </b> <br><br>
- <ul>
- <li>set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= "2017-01-06 00:00:00" group by DEVICE having count(*) > 800 </li>
- <li>set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= "2017-05-06 00:00:00" group by DEVICE </li>
- <li>set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= §timestamp_begin§ group by DEVICE </li>
- <li>set <name> sqlCmd select * from history where DEVICE like "Te%t" order by `TIMESTAMP` desc </li>
- <li>set <name> sqlCmd select * from history where `TIMESTAMP` > "2017-05-09 18:03:00" order by `TIMESTAMP` desc </li>
- <li>set <name> sqlCmd select * from current order by `TIMESTAMP` desc </li>
- <li>set <name> sqlCmd select sum(VALUE) as 'Einspeisung am 04.05.2017', count(*) as 'Anzahl' FROM history where `READING` = "Einspeisung_WirkP_Zaehler_Diff" and TIMESTAMP between '2017-05-04' AND '2017-05-05' </li>
- <li>set <name> sqlCmd delete from current </li>
- <li>set <name> sqlCmd delete from history where TIMESTAMP < "2016-05-06 00:00:00" </li>
- <li>set <name> sqlCmd update history set TIMESTAMP=TIMESTAMP,VALUE='Val' WHERE VALUE='TestValue' </li>
- <li>set <name> sqlCmd select * from history where DEVICE = "Test" </li>
- <li>set <name> sqlCmd insert into history (TIMESTAMP, DEVICE, TYPE, EVENT, READING, VALUE, UNIT) VALUES ('2017-05-09 17:00:14','Test','manuell','manuell','Tes§e','TestValue','°C') </li>
- </ul>
- <br>
-
- Das Ergebnis des Statements wird im <a href="#DbRepReadings">Reading</a> "SqlResult" dargestellt.
- Die Ergebnis-Formatierung kann durch das <a href="#DbRepattr">Attribut</a> "sqlResultFormat" ausgewählt, sowie der verwendete
- Feldtrenner durch das <a href="#DbRepattr">Attribut</a> "sqlResultFieldSep" festgelegt werden. <br><br>
-
- Das Modul stellt optional eine Kommando-Historie zur Verfügung sobald ein SQL-Kommando erfolgreich
- ausgeführt wurde.
- Um diese Option zu nutzen, ist das Attribut "sqlCmdHistoryLength" mit der gewünschten Listenlänge
- zu aktivieren. <br><br>
-
- Zur besseren Übersicht sind die zur Steuerung von sqlCmd relevanten Attribute hier noch einmal
- dargestellt: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>allowDeletion</b> </td><td>: aktiviert Löschmöglichkeit </td></tr>
- <tr><td> <b>sqlResultFormat</b> </td><td>: legt die Darstellung des Kommandoergebnis fest </td></tr>
- <tr><td> <b>sqlResultFieldSep</b> </td><td>: Auswahl Feldtrenner im Ergebnis </td></tr>
- <tr><td> <b>sqlCmdHistoryLength</b> </td><td>: Aktivierung Kommando-Historie und deren Umfang</td></tr>
- </table>
- </ul>
- <br>
- <br>
-
- <b>Hinweis:</b> <br>
- Auch wenn das Modul bezüglich der Datenbankabfrage nichtblockierend arbeitet, kann eine
- zu große Ergebnismenge (Anzahl Zeilen bzw. Readings) die Browsersesssion bzw. FHEMWEB
- blockieren. Wenn man sich unsicher ist, sollte man vorsorglich dem Statement ein Limit
- hinzufügen. <br><br>
- </li> <br>
- </ul>
-
- <li><b> sqlCmdHistory </b> - Wenn mit dem <a href="#DbRepattr">Attribut</a> "sqlCmdHistoryLength" aktiviert, kann
- aus einer Liste ein bereits erfolgreich ausgeführtes sqlCmd-Kommando wiederholt werden. <br>
- Mit Ausführung des letzten Eintrags der Liste, "__purge_historylist__", kann die Liste gelöscht
- werden. <br>
- Falls das Statement "," enthält, wird dieses Zeichen aus technischen Gründen in der
- History-Liste als "<c>" dargestellt. <br>
- </li><br>
-
- <li><b> sumValue [display | writeToDB]</b>
- - Berechnet die Summenwerte des Datenbankfelds "VALUE" in den Zeitgrenzen
- (Attribute) "timestamp_begin", "timestamp_end" bzw. "timeDiffToNow / timeOlderThan".
- Es muss das auszuwertende Reading im <a href="#DbRepattr">Attribut</a> "reading"
- angegeben sein. Diese Funktion ist sinnvoll wenn fortlaufend Wertedifferenzen eines
- Readings in die Datenbank geschrieben werden. <br>
-
- Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit
- der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen
- in der Datenbank gespeichert. <br>
- Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet.
- Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen. <br>
- Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode
- abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann.
- Das Feld "EVENT" wird mit "calculated" gefüllt.<br><br>
-
- <ul>
- <b>Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":</b> <br>
- sum_day_totalpac <br>
- # <Bildungsfunktion>_<Aggregation>_<Originalreading> <br>
- </li> <br>
- </ul>
- <br>
-
- <li><b> syncStandby <DbLog-Device Standby> </b>
- - Es werden die Datensätze aus der angeschlossenen Datenbank (Quelle) direkt in eine weitere
- Datenbank (Standby-Datenbank) übertragen.
- Dabei ist "<DbLog-Device Standby>" das DbLog-Device, welches mit der Standby-Datenbank
- verbunden ist. <br><br>
- Es werden alle Datensätze übertragen, die durch Timestamp-<a href="#DbRepattrlimit">Attribute</a>
- bzw. die Attribute "device", "reading" bestimmt sind. <br>
- Die Datensätze werden dabei in Zeitscheiben entsprechend der eingestellten Aggregation übertragen.
- Hat das Attribut "aggregation" den Wert "no" oder "month", werden die Datensätze automatisch
- in Tageszeitscheiben zur Standby-Datenbank übertragen.
- Quell- und Standby-Datenbank können unterschiedlichen Typs sein.
- <br><br>
- Die zur Steuerung der syncStandby Funktion relevanten Attribute sind: <br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> <b>aggregation</b> </td><td>: Einstellung der Zeitscheiben zur Übertragung (hour,day,week) </td></tr>
- <tr><td> <b>device</b> </td><td>: Übertragung nur von Datensätzen die <device> enthalten </td></tr>
- <tr><td> <b>reading</b> </td><td>: Übertragung nur von Datensätzen die <reading> enthalten </td></tr>
- <tr><td> <b>time.*</b> </td><td>: Attribute zur Zeitabgrenzung der zu übertragenden Datensätze. </td></tr>
- </table>
- </ul>
- <br>
- <br>
- </li> <br>
-
- <li><b> tableCurrentFillup </b> - Die current-Tabelle wird mit einem Extrakt der history-Tabelle aufgefüllt.
- Die <a href="#DbRepattr">Attribute</a> zur Zeiteinschränkung bzw. device, reading werden ausgewertet.
- Dadurch kann der Inhalt des Extrakts beeinflusst werden. Im zugehörigen DbLog-Device sollte sollte das Attribut
- "DbLogType=SampleFill/History" gesetzt sein. </li> <br>
-
- <li><b> tableCurrentPurge </b> - löscht den Inhalt der current-Tabelle. Es werden keine Limitierungen, z.B. durch die Attribute "timestamp_begin",
- "timestamp_end", device, reading, usw. , ausgewertet. </li> <br>
-
- <li><b> vacuum </b> - optimiert die Tabellen in der angeschlossenen Datenbank (SQLite, PostgreSQL). <br>
- Vor und nach der Optimierung kann ein FHEM-Kommando ausgeführt werden.
- (siehe <a href="#DbRepattr">Attribute</a> "executeBeforeProc", "executeAfterProc")
- <br><br>
-
- <ul>
- <b>Hinweis:</b> <br>
- Obwohl die Funktion selbst non-blocking ausgelegt ist, muß das zugeordnete DbLog-Device
- im asynchronen Modus betrieben werden um ein Blockieren von FHEM zu vermeiden. <br><br>
- </li>
- </ul><br>
-
- <br>
- </ul></ul>
-
- <b>Für alle Auswertungsvarianten (Ausnahme sqlCmd,deviceRename,readingRename) gilt: </b> <br>
- Zusätzlich zu dem auszuwertenden Reading kann das Device mit angegeben werden um das Reporting nach diesen Kriterien einzuschränken.
- Sind keine Zeitgrenzen-Attribute angegeben jedoch das Aggregations-Attribut gesetzt, wird der Zeitstempel des ältesten
- Datensatzes in der Datenbank als Startdatum und das aktuelle Datum/die aktuelle Zeit als Zeitgrenze genutzt.
- Konnte der älteste Datensatz in der Datenbank nicht ermittelt werden, wird '1970-01-01 01:00:00' als Selektionsstart
- genutzt (siehe get <name> minTimestamp).
- Sind weder Zeitgrenzen-Attribute noch Aggregation angegeben, wird die Datenselektion ohne Timestamp-Einschränkungen
- ausgeführt.
- <br><br>
-
- <b>Hinweis: </b> <br>
-
- In der Detailansicht kann ein Browserrefresh nötig sein um die Operationsergebnisse zu sehen sobald im DeviceOverview "state = done" angezeigt wird.
- <br><br>
- </ul>
- <a name="DbRepget"></a>
- <b>Get </b>
- <ul>
- Die Get-Kommandos von DbRep dienen dazu eine Reihe von Metadaten der verwendeten Datenbankinstanz abzufragen.
- Dies sind zum Beispiel eingestellte Serverparameter, Servervariablen, Datenbankstatus- und Tabelleninformationen. Die verfügbaren get-Funktionen
- sind von dem verwendeten Datenbanktyp abhängig. So ist für SQLite z.Zt. nur "svrinfo" verfügbar. Die Funktionen liefern nativ sehr viele Ausgabewerte,
- die über über funktionsspezifische <a href="#DbRepattr">Attribute</a> abgrenzbar sind. Der Filter ist als kommaseparierte Liste anzuwenden.
- Dabei kann SQL-Wildcard (%) verwendet werden.
- <br><br>
-
- <b>Hinweis: </b> <br>
- Nach der Ausführung einer get-Funktion in der Detailsicht einen Browserrefresh durchführen um die Ergebnisse zu sehen !
- <br><br>
-
-
- <ul><ul>
- <li><b> blockinginfo </b> - Listet die aktuell systemweit laufenden Hintergrundprozesse (BlockingCalls) mit ihren Informationen auf.
- Zu lange Zeichenketten (z.B. Argumente) werden gekürzt ausgeschrieben.
- </li>
- <br><br>
-
- <li><b> dbstatus </b> - Listet globale Informationen zum MySQL Serverstatus (z.B. Informationen zum Cache, Threads, Bufferpools, etc. ).
- Es werden zunächst alle verfügbaren Informationen berichtet. Mit dem <a href="#DbRepattr">Attribut</a> "showStatus" kann die
- Ergebnismenge eingeschränkt werden, um nur gewünschte Ergebnisse abzurufen. Detailinformationen zur Bedeutung der einzelnen Readings
- sind <a href=http://dev.mysql.com/doc/refman/5.7/en/server-status-variables.html>hier</a> verfügbar. <br>
-
- <br><ul>
- <b>Bespiel</b> <br>
- get <name> dbstatus <br>
- attr <name> showStatus %uptime%,%qcache% <br>
- # Es werden nur Readings erzeugt die im Namen "uptime" und "qcache" enthalten
- </li>
- <br><br>
- </ul>
-
- <li><b> dbvars </b> - Zeigt die globalen Werte der MySQL Systemvariablen. Enthalten sind zum Beispiel Angaben zum InnoDB-Home, dem Datafile-Pfad,
- Memory- und Cache-Parameter, usw. Die Ausgabe listet zunächst alle verfügbaren Informationen auf. Mit dem
- <a href="#DbRepattr">Attribut</a> "showVariables" kann die Ergebnismenge eingeschränkt werden um nur gewünschte Ergebnisse
- abzurufen. Weitere Informationen zur Bedeutung der ausgegebenen Variablen sind
- <a href=http://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html>hier</a> verfügbar. <br>
-
- <br><ul>
- <b>Bespiel</b> <br>
- get <name> dbvars <br>
- attr <name> showVariables %version%,%query_cache% <br>
- # Es werden nur Readings erzeugt die im Namen "version" und "query_cache" enthalten
- </li>
- <br><br>
- </ul>
- <li><b> minTimestamp </b> - Ermittelt den Zeitstempel des ältesten Datensatzes in der Datenbank (wird implizit beim Start von
- FHEM ausgeführt).
- Der Zeitstempel wird als Selektionsbeginn verwendet wenn kein Zeitattribut den Selektionsbeginn
- festlegt.
- </li>
- <br><br>
- <li><b> procinfo </b> - Listet die existierenden Datenbank-Prozesse in einer Tabelle auf (nur MySQL). <br>
- Typischerweise werden nur die Prozesse des Verbindungsusers (angegeben in DbLog-Konfiguration)
- ausgegeben. Sollen alle Prozesse angezeigt werden, ist dem User das globale Recht "PROCESS"
- einzuräumen. <br>
- Für bestimmte SQL-Statements wird seit MariaDB 5.3 ein Fortschrittsreporting (Spalte "PROGRESS")
- ausgegeben. Zum Beispiel kann der Abarbeitungsgrad bei der Indexerstellung verfolgt werden. <br>
- Weitere Informationen sind
- <a href=https://mariadb.com/kb/en/mariadb/show-processlist/>hier</a> verfügbar. <br>
- </li>
- <br><br>
-
-
- <li><b> svrinfo </b> - allgemeine Datenbankserver-Informationen wie z.B. die DBMS-Version, Serveradresse und Port usw. Die Menge der Listenelemente
- ist vom Datenbanktyp abhängig. Mit dem <a href="#DbRepattr">Attribut</a> "showSvrInfo" kann die Ergebnismenge eingeschränkt werden.
- Weitere Erläuterungen zu den gelieferten Informationen sind
- <a href=https://msdn.microsoft.com/en-us/library/ms711681(v=vs.85).aspx>hier</a> zu finden. <br>
-
- <br><ul>
- <b>Bespiel</b> <br>
- get <name> svrinfo <br>
- attr <name> showSvrInfo %SQL_CATALOG_TERM%,%NAME% <br>
- # Es werden nur Readings erzeugt die im Namen "SQL_CATALOG_TERM" und "NAME" enthalten
- </li>
- <br><br>
- </ul>
-
- <li><b> tableinfo </b> - ruft Tabelleninformationen aus der mit dem DbRep-Device verbundenen Datenbank ab (MySQL).
- Es werden per default alle in der verbundenen Datenbank angelegten Tabellen ausgewertet.
- Mit dem <a href="#DbRepattr">Attribut</a> "showTableInfo" können die Ergebnisse eingeschränkt werden. Erläuterungen zu den erzeugten
- Readings sind <a href=http://dev.mysql.com/doc/refman/5.7/en/show-table-status.html>hier</a> zu finden. <br>
-
- <br><ul>
- <b>Bespiel</b> <br>
- get <name> tableinfo <br>
- attr <name> showTableInfo current,history <br>
- # Es werden nur Information der Tabellen "current" und "history" angezeigt
- </li>
- <br><br>
- </ul>
-
- <br>
- </ul></ul>
-
- </ul>
- <a name="DbRepattr"></a>
- <b>Attribute</b>
- <br>
- <ul>
- Über die modulspezifischen Attribute wird die Abgrenzung der Auswertung und die Aggregation der Werte gesteuert. <br><br>
-
- <b>Hinweis zur SQL-Wildcard Verwendung:</b> <br>
- Innerhalb der Attribut-Werte für "device" und "reading" kann SQL-Wildcards "%" angegeben werden.
- Dabei wird "%" als Platzhalter für beliebig viele Zeichen verwendet.
- Das Zeichen "_" wird nicht als SQL-Wildcard supported. <br>
- Dies gilt für alle Funktionen <b>ausser</b> "insert", "importFromFile" und "deviceRename". <br>
- Die Funktion "insert" erlaubt nicht, dass die genannten Attribute das Wildcard "%" enthalten. Character "_" wird als normales Zeichen gewertet.<br>
- In Ergebnis-Readings wird das Wildcardzeichen "%" durch "/" ersetzt um die Regeln für erlaubte Zeichen in Readings einzuhalten.
- <br><br>
-
- <ul><ul>
- <li><b>aggregation </b> - Zusammenfassung der Device/Reading-Selektionen in Stunden,Tages,Kalenderwochen,Kalendermonaten oder "no". Liefert z.B. die Anzahl der DB-Einträge am Tag (countEntries), Summation von Differenzwerten eines Readings (sumValue), usw. Mit Aggregation "no" (default) erfolgt keine Zusammenfassung in einem Zeitraum sondern die Ausgabe ergibt alle Werte eines Device/Readings zwischen den definierten Zeiträumen. </li> <br>
- <li><b>allowDeletion </b> - schaltet die Löschfunktion des Moduls frei </li> <br>
-
- <li><b>averageCalcForm </b> - legt die Berechnungsvariante für die Ermittlung des Durchschnittswertes mit "averageValue" fest.
- </li><br>
- <li><b>device </b> - Abgrenzung der DB-Selektionen auf ein bestimmtes Device. <br>
- Es können <a href="https://fhem.de/commandref_DE.html#devspec">Geräte-Spezifikationen (devspec)</a>
- angegeben werden. <br>
- Innerhalb von Geräte-Spezifikationen wird SQL-Wildcard (%) als normales ASCII-Zeichen gewertet.
- Die Devicenamen werden vor der Selektion aus der Geräte-Spezifikationen und den aktuell in FHEM
- vorhandenen Devices abgeleitet. </li> <br>
-
- <ul>
- <b>Beispiele:</b> <br>
- <code>attr <name> device TYPE=DbRep</code> <br>
- <code>attr <name> device MySTP_5000</code> <br>
- <code>attr <name> device SMA.*,MySTP.*</code> <br>
- <code>attr <name> device SMA_Energymeter,MySTP_5000</code> <br>
- <code>attr <name> device %5000</code> <br>
- </ul>
- <br><br>
- <li><b>diffAccept </b> - gilt für Funktion diffValue. diffAccept legt fest bis zu welchem Schwellenwert eine berechnete positive Werte-Differenz
- zwischen zwei unmittelbar aufeinander folgenden Datensätzen akzeptiert werden soll (Standard ist 20). <br>
- Damit werden fehlerhafte DB-Einträge mit einem unverhältnismäßig hohen Differenzwert von der Berechnung ausgeschlossen und
- verfälschen nicht das Ergebnis. Sollten Schwellenwertüberschreitungen vorkommen, wird das Reading "diff_overrun_limit_<diffLimit>"
- erstellt. (<diffLimit> wird dabei durch den aktuellen Attributwert ersetzt)
- Es enthält eine Liste der relevanten Wertepaare. Mit verbose 3 werden diese Datensätze ebenfalls im Logfile protokolliert.
- </li> <br>
- <ul>
- Beispiel Ausgabe im Logfile beim Überschreiten von diffAccept=10: <br><br>
-
- DbRep Rep.STP5000.etotal -> data ignored while calc diffValue due to threshold overrun (diffAccept = 10): <br>
- 2016-04-09 08:50:50 0.0340 -> 2016-04-09 12:42:01 13.3440 <br><br>
-
- # Der erste Datensatz mit einem Wert von 0.0340 ist untypisch gering zum nächsten Wert 13.3440 und führt zu einem zu hohen
- Differenzwert. <br>
- # Es ist zu entscheiden ob der Datensatz gelöscht, ignoriert, oder das Attribut diffAccept angepasst werden sollte.
- </ul><br>
-
- <li><b>disable </b> - deaktiviert das Modul </li> <br>
-
- <li><b>dumpComment </b> - User-Kommentar. Er wird im Kopf des durch den Befehl "dumpMyQL clientSide" erzeugten Dumpfiles
- eingetragen. </li> <br>
-
- <li><b>dumpCompress </b> - wenn gesetzt, werden die Dumpfiles nach "dumpMySQL" bzw. "dumpSQLite" komprimiert </li> <br>
-
- <li><b>dumpDirLocal </b> - Zielverzeichnis für die Erstellung von Dumps mit "dumpMySQL clientSide".
- default: "{global}{modpath}/log/" auf dem FHEM-Server. <br>
- Ebenfalls werden in diesem Verzeichnis alte Backup-Files durch die interne Versionsverwaltung von
- "dumpMySQL" gesucht und gelöscht wenn die gefundene Anzahl den Attributwert "dumpFilesKeep"
- überschreitet. Das Attribut dient auch dazu ein lokal gemountetes Verzeichnis "dumpDirRemote"
- DbRep bekannt zu machen. </li> <br>
-
- <li><b>dumpDirRemote </b> - Zielverzeichnis für die Erstellung von Dumps mit "dumpMySQL serverSide".
- default: das Home-Dir des MySQL-Servers auf dem MySQL-Host </li> <br>
-
- <li><b>dumpMemlimit </b> - erlaubter Speicherverbrauch für SQL-Script zur Generierungszeit (default: 100000 Zeichen).
- Bitte den Parameter anpassen, falls es zu Speicherengpässen und damit verbundenen Performanceproblemen
- kommen sollte. </li> <br>
-
- <li><b>dumpSpeed </b> - Anzahl der abgerufenen Zeilen aus der Quelldatenbank (default: 10000) pro Select durch "dumpMySQL ClientSide".
- Dieser Parameter hat direkten Einfluß auf die Laufzeit und den Ressourcenverbrauch zur Laufzeit. </li> <br>
- <li><b>dumpFilesKeep </b> - Es wird die angegebene Anzahl Dumpfiles im Dumpdir belassen (default: 3). Sind mehr (ältere) Dumpfiles
- vorhanden, werden diese gelöscht nachdem ein neuer Dump erfolgreich erstellt wurde. Das globale
- Attribut "archivesort" wird berücksichtigt. </li> <br>
-
- <li><b>executeAfterProc </b> - Es kann ein FHEM-Kommando angegeben werden welches <b>nach dem Dump</b> ausgeführt werden soll. <br>
- Funktionen sind in {} einzuschließen.<br><br>
- <ul>
- <b>Beispiel:</b> <br><br>
- attr <name> executeAfterProc set og_gz_westfenster off; <br>
- attr <name> executeAfterProc {adump ("<name>")} <br><br>
-
- # "adump" ist eine in 99_myUtils definierte Funktion. <br>
-
- <pre>
- sub adump {
- my ($name) = @_;
- my $hash = $defs{$name};
- # die eigene Funktion, z.B.
- Log3($name, 3, "DbRep $name -> Dump ist beendet");
-
- return;
- }
- </pre>
- </ul>
- </li>
-
- <li><b>executeBeforeProc </b> - Es kann ein FHEM-Kommando angegeben werden welches <b>vor dem Dump</b> ausgeführt werden soll. <br>
- Funktionen sind in {} einzuschließen.<br><br>
- <ul>
- <b>Beispiel:</b> <br><br>
- attr <name> executeBeforeProc set og_gz_westfenster on; <br>
- attr <name> executeBeforeProc {bdump ("<name>")} <br><br>
-
- # "bdump" ist eine in 99_myUtils definierte Funktion. <br>
-
- <pre>
- sub bdump {
- my ($name) = @_;
- my $hash = $defs{$name};
- # die eigene Funktion, z.B.
- Log3($name, 3, "DbRep $name -> Dump startet");
-
- return;
- }
- </pre>
- </ul>
- </li>
-
- <li><b>expimpfile </b> - Pfad/Dateiname für Export/Import in/aus einem File. </li> <br>
-
- <li><b>fetchMarkDuplicates </b>
- - Markierung von mehrfach vorkommenden Datensätzen im Ergebnis des "fetchrows" Kommandos </li> <br>
-
- <li><b>fetchRoute [descent | ascent] </b> - bestimmt die Leserichtung des fetchrows-Befehl. <br><br>
- <ul>
- <b>descent</b> - die Datensätze werden absteigend gelesen (default). Wird
- die durch das Attribut "limit" festgelegte Anzahl der Datensätze
- überschritten, werden die neuesten x Datensätze angezeigt. <br><br>
- <b>ascent</b> - die Datensätze werden aufsteigend gelesen. Wird
- die durch das Attribut "limit" festgelegte Anzahl der Datensätze
- überschritten, werden die ältesten x Datensätze angezeigt. <br>
- </ul>
-
- </li> <br><br>
-
- <li><b>ftpUse </b> - FTP Transfer nach dem Dump wird eingeschaltet (ohne SSL Verschlüsselung). Das erzeugte
- Datenbank Backupfile wird non-blocking zum angegebenen FTP-Server (Attribut "ftpServer")
- übertragen. </li> <br>
-
- <li><b>ftpUseSSL </b> - FTP Transfer mit SSL Verschlüsselung nach dem Dump wird eingeschaltet. Das erzeugte
- Datenbank Backupfile wird non-blocking zum angegebenen FTP-Server (Attribut "ftpServer")
- übertragen. </li> <br>
-
- <li><b>ftpUser </b> - User zur Anmeldung am FTP-Server, default: "anonymous". </li> <br>
-
- <li><b>ftpDebug </b> - Debugging der FTP Kommunikation zur Fehlersuche. </li> <br>
-
- <li><b>ftpDir </b> - Verzeichnis des FTP-Servers in welches das File übertragen werden soll (default: "/"). </li> <br>
-
- <li><b>ftpDumpFilesKeep </b> - Es wird die angegebene Anzahl Dumpfiles im <ftpDir> belassen (default: 3). Sind mehr
- (ältere) Dumpfiles vorhanden, werden diese gelöscht nachdem ein neuer Dump erfolgreich
- übertragen wurde. </li> <br>
-
- <li><b>ftpPassive </b> - setzen wenn passives FTP verwendet werden soll </li> <br>
-
- <li><b>ftpPort </b> - FTP-Port, default: 21 </li> <br>
-
- <li><b>ftpPwd </b> - Passwort des FTP-Users, default nicht gesetzt </li> <br>
-
- <li><b>ftpServer </b> - Name oder IP-Adresse des FTP-Servers. <b>notwendig !</b> </li> <br>
-
- <li><b>ftpTimeout </b> - Timeout für die FTP-Verbindung in Sekunden (default: 30). </li> <br>
-
- <a name="DbRepattrlimit"></a>
- <li><b>limit </b> - begrenzt die Anzahl der resultierenden Datensätze im select-Statement von "fetchrows", bzw. der anzuzeigenden Datensätze
- der Kommandos "delSeqDoublets adviceDelete", "delSeqDoublets adviceRemain" (default 1000).
- Diese Limitierung soll eine Überlastung der Browsersession und ein
- blockieren von FHEMWEB verhindern. Bei Bedarf entsprechend ändern bzw. die
- Selektionskriterien (Zeitraum der Auswertung) anpassen. </li> <br>
-
- <li><b>optimizeTablesBeforeDump </b> - wenn "1", wird vor dem Datenbankdump eine Tabellenoptimierung ausgeführt (default: 0).
- Dadurch verlängert sich die Laufzeit des Dump. <br><br>
- <ul>
- <b>Hinweis </b> <br>
- Die Tabellenoptimierung führt zur Sperrung der Tabellen und damit zur Blockierung von
- FHEM falls DbLog nicht im asynchronen Modus (DbLog-Attribut "asyncMode") betrieben wird !
- <br>
- </ul>
- </li> <br>
-
- <li><b>reading </b> - Abgrenzung der DB-Selektionen auf ein bestimmtes oder mehrere Readings.
- Mehrere Readings werden als Komma separierte Liste angegeben. <br>
- SQL Wildcard (%) wird in einer Liste als normales ASCII-Zeichen gewertet. <br>
- </li> <br>
-
- <ul>
- <b>Beispiele:</b> <br>
- <code>attr <name> reading etotal</code> <br>
- <code>attr <name> reading et%</code> <br>
- <code>attr <name> reading etotal,etoday</code> <br>
- </ul>
- <br><br>
-
- <li><b>readingNameMap </b> - der Name des ausgewerteten Readings wird mit diesem String für die Anzeige überschrieben </li> <br>
-
- <li><b>readingPreventFromDel </b> - Komma separierte Liste von Readings die vor einer neuen Operation nicht gelöscht
- werden sollen </li> <br>
-
- <li><b>role </b> - die Rolle des DbRep-Device. Standard ist "Client". Die Rolle "Agent" ist im Abschnitt
- <a href="#DbRepAutoRename">DbRep-Agent</a> beschrieben. </li> <br>
-
- <li><b>seqDoubletsVariance </b> - akzeptierte Abweichung (+/-) für das Kommando "set <name> delSeqDoublets". <br>
- Der Wert des Attributs beschreibt die Abweichung bis zu der aufeinanderfolgende numerische Werte (VALUE) von
- Datensätze als gleich angesehen und gelöscht werden sollen. "seqDoubletsVariance" ist ein absoluter Zahlenwert,
- der sowohl als positive als auch negative Abweichung verwendet wird. </li> <br>
- <ul>
- <b>Beispiele:</b> <br>
- <code>attr <name> seqDoubletsVariance 0.0014 </code> <br>
- <code>attr <name> seqDoubletsVariance 1.45 </code> <br>
- </ul>
- <br><br>
-
- <li><b>showproctime </b> - wenn gesetzt, zeigt das Reading "sql_processing_time" die benötigte Abarbeitungszeit (in Sekunden)
- für die SQL-Ausführung der durchgeführten Funktion. Dabei wird nicht ein einzelnes
- SQl-Statement, sondern die Summe aller notwendigen SQL-Abfragen innerhalb der jeweiligen
- Funktion betrachtet. </li> <br>
-
- <li><b>showStatus </b> - grenzt die Ergebnismenge des Befehls "get <name> dbstatus" ein. Es können SQL-Wildcard (%) verwendet werden. </li> <br>
- <ul>
- <b>Bespiel: </b> <br>
- attr <name> showStatus %uptime%,%qcache% <br>
- # Es werden nur Readings erzeugt die im Namen "uptime" und "qcache" enthalten <br>
- </ul><br>
-
- <li><b>showVariables </b> - grenzt die Ergebnismenge des Befehls "get <name> dbvars" ein. Es können SQL-Wildcard (%) verwendet werden. </li> <br>
- <ul>
- <b>Bespiel: </b> <br>
- attr <name> showVariables %version%,%query_cache% <br>
- # Es werden nur Readings erzeugt die im Namen "version" und "query_cache" enthalten <br>
- </ul><br>
-
- <li><b>showSvrInfo </b> - grenzt die Ergebnismenge des Befehls "get <name> svrinfo" ein. Es können SQL-Wildcard (%) verwendet werden. </li> <br>
- <ul>
- <b>Bespiel: </b> <br>
- attr <name> showSvrInfo %SQL_CATALOG_TERM%,%NAME% <br>
- # Es werden nur Readings erzeugt die im Namen "SQL_CATALOG_TERM" und "NAME" enthalten <br>
- </ul><br>
-
- <li><b>showTableInfo </b> - grenzt die Ergebnismenge des Befehls "get <name> tableinfo" ein. Es können SQL-Wildcard (%) verwendet werden. </li> <br>
- <ul>
- <b>Bespiel: </b> <br>
- attr <name> showTableInfo current,history <br>
- # Es werden nur Information der Tabellen "current" und "history" angezeigt <br>
- </ul><br>
- <li><b>sqlResultFieldSep </b> - legt den verwendeten Feldseparator (default: "|") im Ergebnis des Kommandos "set ... sqlCmd" fest. </li> <br>
-
- <li><b>sqlCmdHistoryLength </b>
- - aktiviert die Kommandohistorie von "sqlCmd" und legt deren Länge fest </li> <br>
-
- <li><b>sqlResultFormat </b> - legt die Formatierung des Ergebnisses des Kommandos "set <name> sqlCmd" fest.
- Mögliche Optionen sind: <br><br>
-
- <ul>
- <b>separated </b> - die Ergebniszeilen werden als einzelne Readings fortlaufend
- generiert. (default)<br><br>
- <b>mline </b> - das Ergebnis wird als Mehrzeiler im <a href="#DbRepReadings">Reading</a>
- SqlResult dargestellt. <br><br>
- <b>sline </b> - das Ergebnis wird als Singleline im <a href="#DbRepReadings">Reading</a>
- SqlResult dargestellt. Satztrenner ist"]|[". <br><br>
- <b>table </b> - das Ergebnis wird als Tabelle im <a href="#DbRepReadings">Reading</a>
- SqlResult dargestellt. <br><br>
- <b>json </b> - erzeugt das <a href="#DbRepReadings">Reading</a> SqlResult als
- JSON-kodierten Hash.
- Jedes Hash-Element (Ergebnissatz) setzt sich aus der laufenden Nummer
- des Datensatzes (Key) und dessen Wert zusammen. </li><br><br>
-
- Die Weiterverarbeitung des Ergebnisses kann z.B. mit der folgenden userExitFn in 99_myUtils.pm erfolgen: <br>
- <pre>
- sub resfromjson {
- my ($name,$reading,$value) = @_;
- my $hash = $defs{$name};
- if ($reading eq "SqlResult") {
- # nur Reading SqlResult enthält JSON-kodierte Daten
- my $data = decode_json($value);
-
- foreach my $k (keys(%$data)) {
-
- # ab hier eigene Verarbeitung für jedes Hash-Element
- # z.B. Ausgabe jedes Element welches "Cam" enthält
- my $ke = $data->{$k};
- if($ke =~ m/Cam/i) {
- my ($res1,$res2) = split("\\|", $ke);
- Log3($name, 1, "$name - extract element $k by userExitFn: ".$res1." ".$res2);
- }
- }
- }
- return;
- }
- </pre>
-
- </ul><br>
-
- <li><b>timeYearPeriod </b> - Mit Hilfe dieses Attributes wird eine jährliche Zeitperiode für die Datenbankselektion bestimmt.
- Die Zeitgrenzen werden zur Ausführungszeit dynamisch berechnet. Es wird immer eine Jahresperiode
- bestimmt. Eine unterjährige Angabe ist nicht möglich. <br>
- Dieses Attribut ist vor allem dazu gedacht Auswertungen synchron zu einer Abrechnungsperiode, z.B. der eines
- Energie- oder Gaslieferanten, anzufertigen.
- </li> <br>
-
- <ul>
- <b>Beispiel:</b> <br><br>
- attr <name> timeYearPeriod 06-25 06-24 <br><br>
-
- # wertet die Datenbank in den Zeitgrenzen 25. Juni AAAA bis 24. Juni BBBB aus. <br>
- # Das Jahr AAAA bzw. BBBB wird in Abhängigkeit des aktuellen Datums errechnet. <br>
- # Ist das aktuelle Datum >= 25. Juni und =< 31. Dezember, dann ist AAAA = aktuelles Jahr und BBBB = aktuelles Jahr+1 <br>
- # Ist das aktuelle Datum >= 01. Januar und =< 24. Juni, dann ist AAAA = aktuelles Jahr-1 und BBBB = aktuelles Jahr
- </ul>
- <br><br>
-
- <li><b>timestamp_begin </b> - der zeitliche Beginn für die Datenselektion (*) </li> <br>
-
- <li><b>timestamp_end </b> - das zeitliche Ende für die Datenselektion. Wenn nicht gesetzt wird immer die aktuelle
- Datum/Zeit-Kombi für das Ende der Selektion eingesetzt. (*) </li> <br>
-
-
- (*) Das Format von Timestamp ist wie in DbLog "YYYY-MM-DD HH:MM:SS". Für die Attribute "timestamp_begin", "timestamp_end"
- kann ebenso eine der folgenden Eingaben verwendet werden. Dabei wird das timestamp-Attribut dynamisch belegt: <br><br>
- <ul>
- <b>current_year_begin</b> : entspricht "<aktuelles Jahr>-01-01 00:00:00" <br>
- <b>current_year_end</b> : entspricht "<aktuelles Jahr>-12-31 23:59:59" <br>
- <b>previous_year_begin</b> : entspricht "<vorheriges Jahr>-01-01 00:00:00" <br>
- <b>previous_year_end</b> : entspricht "<vorheriges Jahr>-12-31 23:59:59" <br>
- <b>current_month_begin</b> : entspricht "<aktueller Monat erster Tag> 00:00:00" <br>
- <b>current_month_end</b> : entspricht "<aktueller Monat letzter Tag> 23:59:59" <br>
- <b>previous_month_begin</b> : entspricht "<Vormonat erster Tag> 00:00:00" <br>
- <b>previous_month_end</b> : entspricht "<Vormonat letzter Tag> 23:59:59" <br>
- <b>current_week_begin</b> : entspricht "<erster Tag der akt. Woche> 00:00:00" <br>
- <b>current_week_end</b> : entspricht "<letzter Tag der akt. Woche> 23:59:59" <br>
- <b>previous_week_begin</b> : entspricht "<erster Tag Vorwoche> 00:00:00" <br>
- <b>previous_week_end</b> : entspricht "<letzter Tag Vorwoche> 23:59:59" <br>
- <b>current_day_begin</b> : entspricht "<aktueller Tag> 00:00:00" <br>
- <b>current_day_end</b> : entspricht "<aktueller Tag> 23:59:59" <br>
- <b>previous_day_begin</b> : entspricht "<Vortag> 00:00:00" <br>
- <b>previous_day_end</b> : entspricht "<Vortag> 23:59:59" <br>
- <b>current_hour_begin</b> : entspricht "<aktuelle Stunde>:00:00" <br>
- <b>current_hour_end</b> : entspricht "<aktuelle Stunde>:59:59" <br>
- <b>previous_hour_begin</b> : entspricht "<vorherige Stunde>:00:00" <br>
- <b>previous_hour_end</b> : entspricht "<vorherige Stunde>:59:59" <br>
- </ul><br>
-
- Natürlich sollte man immer darauf achten dass "timestamp_begin" < "timestamp_end" ist. <br><br>
- <ul>
- <b>Beispiel:</b> <br><br>
- attr <name> timestamp_begin current_year_begin <br>
- attr <name> timestamp_end current_year_end <br><br>
-
- # Wertet die Datenbank in den Zeitgrenzen des aktuellen Jahres aus. <br>
- </ul>
- <br><br>
-
- <b>Hinweis </b> <br>
-
- Wird das Attribut "timeDiffToNow" gesetzt, werden die eventuell gesetzten anderen Zeit-Attribute
- ("timestamp_begin","timestamp_end","timeYearPeriod") gelöscht.
- Das Setzen von "timestamp_begin" bzw. "timestamp_end" bedingt die Löschung von anderen Zeit-Attribute falls sie vorher gesetzt waren.
- <br><br>
-
- <li><b>timeDiffToNow </b> - der <b>Selektionsbeginn</b> wird auf den Zeitpunkt <b>"<aktuelle Zeit> - <timeDiffToNow>"</b>
- gesetzt (z.b. werden die letzten 24 Stunden in die Selektion eingehen wenn das Attribut auf "86400" gesetzt
- wurde). Die Timestampermittlung erfolgt dynamisch zum Ausführungszeitpunkt. </li> <br>
-
- <ul>
- <b>Eingabeformat Beispiel:</b> <br>
- <code>attr <name> timeDiffToNow 86400</code> <br>
- # die Startzeit wird auf "aktuelle Zeit - 86400 Sekunden" gesetzt <br>
- <code>attr <name> timeDiffToNow d:2 h:3 m:2 s:10</code> <br>
- # die Startzeit wird auf "aktuelle Zeit - 2 Tage 3 Stunden 2 Minuten 10 Sekunden" gesetzt <br>
- <code>attr <name> timeDiffToNow m:600</code> <br>
- # die Startzeit wird auf "aktuelle Zeit - 600 Minuten" gesetzt <br>
- <code>attr <name> timeDiffToNow h:2.5</code> <br>
- # die Startzeit wird auf "aktuelle Zeit - 2,5 Stunden" gesetzt <br>
- </ul>
- <br><br>
-
- <li><b>timeOlderThan </b> - das <b>Selektionsende</b> wird auf den Zeitpunkt <b>"<aktuelle Zeit> - <timeOlderThan>"</b>
- gesetzt. Dadurch werden alle Datensätze bis zu dem Zeitpunkt "<aktuelle
- Zeit> - <timeOlderThan>" berücksichtigt (z.b. wenn auf 86400 gesetzt, werden alle
- Datensätze die älter als ein Tag sind berücksichtigt). Die Timestampermittlung erfolgt
- dynamisch zum Ausführungszeitpunkt. <br>
- Es gelten die gleichen Eingabeformate wie für das Attribut "timeDiffToNow". </li> <br>
-
- <li><b>timeout </b> - das Attribut setzt den Timeout-Wert für die Blocking-Call Routinen in Sekunden
- (Default: 86400) </li> <br>
-
- <li><b>userExitFn </b> - stellt eine Schnittstelle zur Ausführung eigenen Usercodes zur Verfügung. <br>
- Um die Schnittstelle zu aktivieren, wird zunächst die aufzurufende Subroutine in
- 99_myUtls.pm nach folgendem Muster erstellt: <br>
- <pre>
- sub UserFunction {
- my ($name,$reading,$value) = @_;
- my $hash = $defs{$name};
- ...
- # z.B. übergebene Daten loggen
- Log3 $name, 1, "UserExitFn $name called - transfer parameter are Reading: $reading, Value: $value " ;
- ...
- return;
- }
- </pre>
-
- Die Aktivierung der Schnittstelle erfogt durch Setzen des Funktionsnamens im Attribut.
- Optional kann ein Reading:Value Regex als Argument angegeben werden. Wird kein Regex
- angegeben, werden alle Wertekombinationen als "wahr" gewertet (entspricht .*:.*).
- <br><br>
-
- <ul>
- <b>Beispiel:</b> <br>
- attr <device> userExitFn UserFunction .*:.* <br>
- # "UserFunction" ist die Subroutine in 99_myUtils.pm.
- </ul>
- <br>
-
- Grundsätzlich arbeitet die Schnittstelle OHNE Eventgenerierung bzw. benötigt zur Funktion keinen
- Event. Sofern das Attribut gesetzt ist, erfolgt Die Regexprüfung NACH der Erstellung eines
- Readings. Ist die Prüfung WAHR, wird die angegebene Funktion aufgerufen.
- Zur Weiterverarbeitung werden der aufgerufenenen Funktion folgende Variablen übergeben: <br><br>
-
- <ul>
- <li>$name - der Name des DbRep-Devices </li>
- <li>$reading - der Namen des erstellen Readings </li>
- <li>$value - der Wert des Readings </li>
-
- </ul>
- </li>
- <br><br>
- </ul></ul>
- </ul>
- <a name="DbRepReadings"></a>
- <b>Readings</b>
- <br>
- <ul>
- Abhängig von der ausgeführten DB-Operation werden die Ergebnisse in entsprechenden Readings dargestellt. Zu Beginn einer neuen Operation
- werden alle alten Readings einer vorangegangenen Operation gelöscht um den Verbleib unpassender bzw. ungültiger Readings zu vermeiden.
- <br><br>
-
- Zusätzlich werden folgende Readings erzeugt (Auswahl): <br><br>
-
- <ul><ul>
- <li><b>state </b> - enthält den aktuellen Status der Auswertung. Wenn Warnungen auftraten (state = Warning) vergleiche Readings
- "diff_overrun_limit_<diffLimit>" und "less_data_in_period" </li> <br>
- <li><b>errortext </b> - Grund eines Fehlerstatus </li> <br>
- <li><b>background_processing_time </b> - die gesamte Prozesszeit die im Hintergrund/Blockingcall verbraucht wird </li> <br>
- <li><b>diff_overrun_limit_<diffLimit></b> - enthält eine Liste der Wertepaare die eine durch das Attribut "diffAccept" festgelegte Differenz
- <diffLimit> (Standard: 20) überschreiten. Gilt für Funktion "diffValue". </li> <br>
- <li><b>less_data_in_period </b> - enthält eine Liste der Zeitperioden in denen nur ein einziger Datensatz gefunden wurde. Die
- Differenzberechnung berücksichtigt den letzten Wert der Vorperiode. Gilt für Funktion "diffValue". </li> <br>
- <li><b>sql_processing_time </b> - der Anteil der Prozesszeit die für alle SQL-Statements der ausgeführten
- Operation verbraucht wird </li> <br>
-
- <li><b>SqlResult </b> - Ergebnis des letzten sqlCmd-Kommandos. Die Formatierung erfolgt entsprechend
- des <a href="#DbRepattr">Attributes</a> "sqlResultFormat" </li> <br>
-
- <li><b>sqlCmd </b> - das letzte ausgeführte sqlCmd-Kommando </li> <br>
- </ul></ul>
- <br>
- </ul>
- <a name="DbRepAutoRename"></a>
- <b>DbRep Agent - automatisches Ändern von Device-Namen in Datenbanken und DbRep-Definitionen nach FHEM "rename" Kommando</b>
- <br>
- <ul>
- Mit dem Attribut "role" wird die Rolle des DbRep-Device festgelegt. Die Standardrolle ist "Client". Mit der Änderung der Rolle in "Agent" wird das Device
- veranlasst auf Umbenennungen von Geräten in der FHEM Installation zu reagieren. <br><br>
-
- Durch den DbRep-Agenten werden folgende Features aktiviert wenn ein Gerät in FHEM mit "rename" umbenannt wird: <br><br>
-
- <ul><ul>
- <li> in der dem DbRep-Agenten zugeordneten Datenbank (Internal Database) wird nach Datensätzen mit dem alten Gerätenamen gesucht und dieser Gerätename in
- <b>allen</b> betroffenen Datensätzen in den neuen Namen geändert. </li> <br>
-
- <li> in dem DbRep-Agenten zugeordneten DbLog-Device wird in der Definition das alte durch das umbenannte Device ersetzt. Dadurch erfolgt ein weiteres Logging
- des umbenannten Device in der Datenbank. </li> <br>
-
- <li> in den existierenden DbRep-Definitionen vom Typ "Client" wird ein evtl. gesetztes Attribut "device = alter Devicename" in "device = neuer Devicename"
- geändert. Dadurch werden Auswertungsdefinitionen bei Geräteumbenennungen automatisch konstistent gehalten. </li> <br>
- </ul></ul>
-
- Mit der Änderung in einen Agenten sind folgende Restriktionen verbunden die mit dem Setzen des Attributes "role = Agent" eingeschaltet
- und geprüft werden: <br><br>
-
- <ul><ul>
- <li> es kann nur einen Agenten pro Datenbank in der FHEM-Installation geben. Ist mehr als eine Datenbank mit DbLog definiert, können
- ebenso viele DbRep-Agenten eingerichtet werden </li> <br>
-
- <li> mit der Umwandlung in einen Agenten wird nur noch das Set-Komando "renameDevice" verfügbar sein sowie nur ein eingeschränkter Satz von DbRep-spezifischen
- Attributen zugelassen. Wird ein DbRep-Device vom bisherigen Typ "Client" in einen Agenten geändert, werden evtl. gesetzte und nun nicht mehr zugelassene
- Attribute glöscht. </li> <br>
- </ul></ul>
-
- Die Aktivitäten wie Datenbankänderungen bzw. Änderungen an anderen DbRep-Definitionen werden im Logfile mit verbose=3 protokolliert. Damit die renameDevice-Funktion
- bei großen Datenbanken nicht in ein timeout läuft, sollte das Attribut "timeout" entsprechend dimensioniert werden. Wie alle Datenbankoperationen des Moduls
- wird auch das Autorename nonblocking ausgeführt. <br><br>
-
- <ul>
- <b>Beispiel </b> für die Definition eines DbRep-Device als Agent: <br><br>
- <code>
- define Rep.Agent DbRep LogDB <br>
- attr Rep.Agent devStateIcon connected:10px-kreis-gelb .*disconnect:10px-kreis-rot .*done:10px-kreis-gruen <br>
- attr Rep.Agent icon security <br>
- attr Rep.Agent role Agent <br>
- attr Rep.Agent room DbLog <br>
- attr Rep.Agent showproctime 1 <br>
- attr Rep.Agent stateFormat { ReadingsVal("$name","state", undef) eq "running" ? "renaming" : ReadingsVal("$name","state", undef). " »; ProcTime: ".ReadingsVal("$name","sql_processing_time", undef)." sec"} <br>
- attr Rep.Agent timeout 86400 <br>
- </code>
- <br>
- </ul>
-
- <b>Hinweis:</b> <br>
- Obwohl die Funktion selbst non-blocking ausgelegt ist, sollte das zugeordnete DbLog-Device
- im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden (Tabellen-Lock). <br><br>
-
- </ul>
- <p><a name="Dooya"></a>
- <h3>Dooya</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Dooya'>Dooya</a><br/>
- </ul>
- <a name="EC3000"></a>
- <h3>EC3000</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EC3000'>EC3000</a><br/>
- </ul>
- <a name="ECMD"></a>
- <h3>ECMD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ECMD'>ECMD</a><br/>
- </ul>
- <a name="ECMDDevice"></a>
- <h3>ECMDDevice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ECMDDevice'>ECMDDevice</a><br/>
- </ul>
- <a name="EDIPLUG"></a>
- <h3>EDIPLUG</h3>
- <div class='langLinks'>[<a href='commandref.html#EDIPLUG'>EN</a> DE]</div>
- FHEM Module für die Edimax Smart Plug Switches SP-2101W und SP-1101W (http://www.edimax.com)<br>
- FHEM Forum : <a href="http://forum.fhem.de/index.php/topic,29541.0.html">http://forum.fhem.de/index.php/topic,29541.0.html</a><br>
- SP-2101W - Edimax Smart Plug Switch mit Strom Verbrauchsmessung<br>
- SP-1101W - Edimax Smart Plug Switch<br>
- ben&oml;ntigt XML:Simple -> sudo apt-get install libxml-simple-perl
- <br>
- <ul>
- <a name="EDIPLUGdefine"></a>
- <b>Define</b>
- <ul>
- define <name> EDIPLUG IP_des_EDIPlug (oder FQDN Name)<br>
- Beispiel:<br>
- <li>define myediplug EDIPLUG 192.168.0.99</li>
- <li>define myediplug EDIPLUG ediplug.fritz.box</li>
- </ul>
- <br>
- <a name="EDIPLUGset"></a>
- <b>Set</b>
- <ul>
- <li>on => schalte an</li>
- <li>off => schalte aus</li>
- <li>list => erzeugt eine neue Zeitplan Liste mit einem Eintrag : Wochentag(0-6) Startzeit(hh:mm) Endezeit(hh:mm) Kommando(on/off) Bsp. 1 10:00 11:30 on<br>
- mit Wochentag 00:00 24:00 on kann man den kompletten Tag einschalten</li>
- <li>addlist => fügt eine neue Schaltzeit einer bestehenden Zeitplan Liste hinzu : Wochentag(0-6) Startzeit(hh:mm) Endtezeit(hh:mm) Kommando(on/off) Bsp. 1 10:00 11:30 on</li>
- <li>dellist => löscht eine bestimmte Schaltzeit eines Tages : Wochentag(0-6) Startzeit(hh:mm) Endezeit(hh:mm) Bsp. 1 10:00 11:30</li>
- <li>delete => löscht die Liste eines ganzen Tages : Wochentag(0-6)</li>
- <li>day => schaltet die Zeitplanung eines Tages ein oder aus : Wochentag(0-6) on/off Bsp. 5 on</li>
- </ul>
- <br>
- <a name="EDIPLUGget"></a>
- <b>Get</b>
- <ul>
- <li>info => Anzeige von MAC , Firmware Version , Modell , Name</li>
- <li>power => zeigt alle Stromverbrauchswerte ( nur Modell SP-2101W )</li>
- <li>schedule => zeigt alle internen Schaltzeiten (ACHTUNG : Firmware Version beachten !)</li>
- <li>status => zeigt an/aus Status der Schaltdose</li>
- </ul>
- <br>
- <a name="EDIPLUGattr"></a>
- <b>Attributes</b>
- <ul>
- <li>interval => polling interval (default 60)</li>
- <li>timeout => max. Wartezeit in Sekunden (default 2)</li>
- <li>read-only => es ist nur lesen (Get) erlaubt (default 0)</li>
- <li>user => Username (default admin)</li>
- <li>password => Passwort (default 1234)</li>
- </ul>
- <br>
- <b>Readings</b>
- <ul>
- <li>0.So -> Schaltzeiten Sonntag</li>
- <li>0.So.state -> Sonntag an/aus</li>
- <li>.</li>
- <li>.</li>
- <li>.</li>
- <li>6.Sa -> Schaltzeiten Samstag</li>
- <li>6.Sa.state -> Samstag an/aus</li>
- <li>last_Toggle_Time ( nur Modell SP-2101W)</li>
- <li>current (nur Modell SP-2101W)</li>
- <li>power_now (nur Modell SP-2101W)</li>
- <li>power_day (nur Modell SP-2101W)</li>
- <li>power_week (nur Modell SP-2101W)</li>
- <li>power_month (nur Modell SP-2101W)</li>
- </ul>
- </ul>
- <p><a name="EGPM"></a>
- <h3>EGPM Steckdose</h3>
- <div class='langLinks'>[<a href='commandref.html#EGPM'>EN</a> DE]</div>
- <ul>
- Definiert eine einzelne Netzwerk-Steckdose vom EGPM2LAN. Diese Definition wird beim Einrichten eines EGPM2LAN automatisch erstellt,
- wenn das globale FHEM-Attribut AUTOCREATE aktiviert wurde. Für weitere Informationen, siehe Beschreibung von <a href="#EGPM2LAN">EGPM2LAN</a>.
- <br><br>
- <a name="EGPMdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> EGPM <device> <socket-nr></code>
- <br>
- </ul>
- <br>
- <a name="EGPMset"></a>
- <b>Set</b>
- <ul><code>set <name> <[on|off|toggle]></code><br>
- Schaltet die Steckdose ein oder aus.
- </ul>
- <ul><code>set <name> <[on-for-timer|off-for-timer|on-till|off-till|blink|intervals]></code><br>
- Schaltet die Steckdose fü einen bestimmten Zeitraum oder mehrfach hintereinander. Weitere Infos hierzu unter <a href="#setExtensions">set extensions</a>.
- </ul><br>
- Beispiel:
- <ul>
- <code>define lampe1 EGPM steckdose 1</code><br>
- <code>set lampe1 on</code><br>
- </ul>
- <br>
- <a name="EGPMget"></a>
- <b>Get</b> <ul>N/A</ul>
- <br>
- <a name="EGPMattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <a name="EGPM2LANevents"></a>
- <b>Generated events</b>
- <ul>
- <li>EGPM <name> <[on|off]></li>
- </ul>
- </ul>
- <p><a name="EGPM2LAN"></a>
- <h3>EGPM2LAN</h3>
- <div class='langLinks'>[<a href='commandref.html#EGPM2LAN'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="EGPM2LANdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> EGPM2LAN <IP-Address></code><br>
- <br>
- Das Modul erstellt eine Verbindung zu einer Gembird ® <a href="http://energenie.com/item.aspx?id=7557" >Energenie EG-PM2-LAN</a> Steckdosenleiste und steuert 4 angeschlossene Geräte..
- Falls mehrere Steckdosenleisten über das Netzwerk gesteuert werden, ist es ratsam, diese zuerst über die Web-Oberfläche zu konfigurieren und die einzelnen Steckdosen zu benennen. Die Namen werden dann automatisch in die
- Oberfläche von FHEM übernommen. Bitte darauf achten, die Weboberfläche mit <i>Logoff</i> wieder zu verlassen, da der Zugriff sonst blockiert wird.
- </ul><br>
- <a name="EGPM2LANset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <[on|off|toggle]> <socketnr.></code><br>
- Schaltet die gewählte Steckdose ein oder aus.<br>
- <br>
- <code>set <name> <[on|off]> <all></code><br>
- Schaltet alle Steckdosen gleichzeitig ein oder aus.<br>
- <br>
- <code>set <name> password [<mein-passwort>]</code><br>
- Speichert das Passwort verschlüsselt in FHEM ab. Zum Entfernen eines vorhandenen Passworts den Befehl ohne Parameter aufrufen.<br>
- Vor 04/2017 wurde das Passwort im Klartext gespeichert und mit dem DEFINE-Command übergeben.<br>
- <br>
- <code>set <name> <staterequest></code><br>
- Aktualisiert die Statusinformation der Steckdosenleiste.<br>
- Wenn das globale Attribut <a href="#autocreate">autocreate</a> aktiviert ist, wird für jede Steckdose ein <a href="#EGPM">EGPM</a>-Eintrag erstellt.<br>
- <br>
- <code>set <name> <clearreadings></code><br>
- Löscht alle ungültigen Einträge im Abschnitt <readings>.
- </ul>
- <br>
- <a name="EGPM2LANget"></a>
- <b>Get</b>
- <ul><code>get <name> state</code><br>
- Gibt einen Text in diesem Format aus: "1: off 2: on 3: off 4: off" oder enthält die letzte Fehlermeldung.<br>
- </ul><br>
- <a name="EGPM2LANattr"></a>
- <b>Attribute</b>
- <ul>
- <li>stateDisplay</li>
- Default: <b>socketNumer</b> wechselt zwischen <b>socketNumer</b> and <b>socketName</b> für jeden Statuseintrag. Verwende <b>set statusrequest</b>, um die Anzeige zu aktualisieren.
- <li>autocreate</li>
- Default: <b>on</b> <a href="#EGPM">EGPM</a>-Einträge werden automatisch mit dem <b>set</b>-command erstellt.
- <li><a href="#loglevel">loglevel</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <br>
- <br>
- Beispiel:
- <ul>
- <code>define sleiste EGPM2LAN 10.192.192.20</code><br>
- <code>set sleiste password SecretGarden</code><br>
- <code>set sleiste on 1</code><br>
- </ul>
- </ul>
- <p><a name="EIB"></a>
- <h3>EIB</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EIB'>EIB</a><br/>
- </ul>
- <a name="EM"></a>
- <h3>EM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EM'>EM</a><br/>
- </ul>
- <a name="EMEM"></a>
- <h3>EMEM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EMEM'>EMEM</a><br/>
- </ul>
- <a name="EMGZ"></a>
- <h3>EMGZ</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EMGZ'>EMGZ</a><br/>
- </ul>
- <a name="EMT7110"></a>
- <h3>EMT7110</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EMT7110'>EMT7110</a><br/>
- </ul>
- <a name="EMWZ"></a>
- <h3>EMWZ</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EMWZ'>EMWZ</a><br/>
- </ul>
- <a name="ENECSYSGW"></a>
- <h3>ENECSYSGW</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ENECSYSGW'>ENECSYSGW</a><br/>
- </ul>
- <a name="ENECSYSINV"></a>
- <h3>ENECSYSINV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ENECSYSINV'>ENECSYSINV</a><br/>
- </ul>
- <p>
- <a name="ENIGMA2" id="ENIGMA2"></a>
- </p>
- <h3>
- ENIGMA2
- </h3>
- <div class='langLinks'>[<a href='commandref.html#ENIGMA2'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#ENIGMA2'>ENIGMA2</a>
- </ul>
- <p><a name="EQ3BT"></a>
- <h3>EQ3BT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EQ3BT'>EQ3BT</a><br/>
- </ul>
- <a name="ESA2000"></a>
- <h3>ESA2000</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ESA2000'>ESA2000</a><br/>
- </ul>
- <a name="ESPEasy"></a>
- <h3>ESPEasy</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ESPEasy'>ESPEasy</a><br/>
- </ul>
- <a name="ElectricityCalculator"></a>
- <h3>ElectricityCalculator</h3>
- <div class='langLinks'>[<a href='commandref.html#ElectricityCalculator'>EN</a> DE]</div>
- <ul>
- <table>
- <tr>
- <td>
- Das ElectricityCalculator Modul berechnet den Verbrauch an elektrischer Energie (Stromverbrauch) und den verbundenen Kosten von einem oder mehreren Elektrizitätszählern.<BR>
- Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit den Zählimpulse von einem oder mehreren Electrizitätszählern zu finden.<BR>
- <BR>
- Sobald das Modul in der fhem.cfg definiert wurde, reagiert das Modul auf jedes durch das regex definierte event wie beispielsweise ein myOWDEVICE:counter.* etc.<BR>
- <BR>
- Das ElectricityCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Elektrizitätszählern und erstellt die entsprechenden Readings.<BR>
- <BR>
- Um zu verhindern, dass man bis zu 12 Monate warten muss, bis alle Werte der Realität entsprechen, müssen die Readings<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterDay1st</code>,<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterMonth1st</code>,<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterYear1st</code> und<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterMeter1st</code><BR>
- entsprechend mit dem <code>setreading</code> - Befehl korrigiert werden.<BR>
- Diese Werte findet man unter Umständen auf der letzten Abrechnung des Elektrizitätsversorgers. Andernfalls dauert es bis zu 24h für die täglichen, 30 Tage für die monatlichen und bis zu 12 Monate für die jährlichen Werte bis diese der Realität entsprechen.<BR>
- <BR>
- <BR>
- Intervalle kleienr als 10s werden ignoriert um Spitzen zu verhindern die von Blockaden des fhem Systems hervorgerufen werden (z.B. DbLog - reducelog).
- </td>
- </tr>
- </table>
-
- <table>
- <tr><td><a name="ElectricityCalculatorDefine"></a><b>Define</b></td></tr>
- </table>
- <table><tr><td><ul><code>define <name> ElectricityCalculator <regex></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der Name dieses Berechnungs-Device. Empfehlung: "myElectricityCalculator".</td></tr>
- <tr><td><code><regex></code> : </td><td>Eine gültige Regular Expression (regex or regexp) von dem Event wo der Zählerstand gefunden werden kann</td></tr>
- </table>
- </ul></ul>
- <table><tr><td><ul>Beispiel: <code>define myElectricityCalculator ElectricityCalculator myElectricityCounter:countersA.*</code></ul></td></tr></table>
- <BR>
- <table>
- <tr><td><a name="ElectricityCalculatorSet"></a><b>Set</b></td></tr>
- <tr><td>
- <ul>
- Die set - Funktion erlaubt individuelle Readings zu verändern um beispielsweise nach einem Stromausfall Werte zu korrigieren.<BR>
- Die set - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.<BR>
- Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit <code>set</code> - Befehl gesetzt werden.<BR>
- </ul>
- </td></tr>
- </table>
- <BR>
- <table>
- <tr><td><a name="ElectricityCalculatorGet"></a><b>Get</b></td></tr>
- <tr><td>
- <ul>
- Die get - Funktion liefert nur den Wert des jeweiligen Readings zurück.<BR>
- Die get - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.<BR>
- Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit <code>get</code> - Befehl ausgelesen werden.<BR>
- </ul>
- </td></tr>
- </table>
- <BR>
- <table>
- <tr><td><a name="ElectricityCalculatorAttr"></a><b>Attributes</b></td></tr>
- <tr><td>
- <ul>
- Sollten die unten ausfeg&auuml;hrten Attribute bei der Definition eines entsprechenden Gerätes nicht gesetzt sein, so werden sie vom Modul mit Standard Werten automatisch gesetzt<BR>
- Zusätzlich können die globalen Attribute wie <a href="#room">room</a> verwendet werden.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>BasicPricePerAnnum</code> : </li></td><td> Eine gültige float Zahl für die jährliche Grundgebühr in der gewählten Währung für die Elektrizitäts-Versorgung zum Endverbraucher.<BR>
- Dieser Wert stammt vom Elektrizitätsversorger und steht auf der Abrechnung.<BR>
- Der Standard Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>Currency</code> : </li></td><td> Eines der vordefinerten Währungssymbole: [€,£,$].<BR>
- Der Standard Wert ist €<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>disable</code> : </li></td><td> Deaktiviert das device. Das Modul wird nicht mehr auf die Events reagieren die durch die Regular Expression definiert wurde.<BR>
- Der Standard Wert ist 0 = aktiviert.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ElectricityCounterOffset</code> : </li></td><td> Eine gültige float-Zahl für den Unterschied = Offset (Nicht der Unterschied zwischen Zählimpulsen) zwischen dem am mechanischen Elektrizitätszählern und dem angezeigten Wert im Reading dieses Device.<BR>
- Der Offset-Wert wird wie folgt ermittelt: W<sub>Offset</sub> = W<sub>Mechanisch</sub> - W<sub>Module</sub><BR>
- Der Standard-Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ElectricityKwhPerCounts</code> : </li></td><td> Eine gültige float-Zahl für die Menge kWh pro Zählimpulsen.<BR>
- Der Wert ist durch das mechanische Zählwerk des Elektrizitätszählern vorgegeben. ElectricityKwhPerCounts = 0.001 bedeutet, dass jeder Zählimpuls ein Tausendstel einer kWh ist (=Wh).<BR>
- Einige elektronische Zähler (Bsp.: HomeMatic HM-ES-TX-WM) stellen die gezählte Menge an elektrischer Energie als Wh bereit.<BR>
- Aus diesem Grund muss dieses Attribut auf 0.001 gesetzt werden um eine korrekte Transformation in kWh zu ermöglichen.<BR>
- Der Standard-Wert ist 1<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ElectricityPricePerKWh</code> : </li></td><td> Eine gültige float-Zahl für den Preis pro kWh.<BR>
- Dieser Wert stammt vom Elektrizitätsversorger und steht auf der Abrechnung.<BR>
- Der Standard-Wert ist 0.2567<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>MonthlyPayment</code> : </li></td><td> Eine gültige float-Zahl für die monatlichen Abschlagszahlungen in der gewählten Währung an den Elektrizitätsversorger.<BR>
- Der Standard-Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>MonthOfAnnualReading</code> : </li></td><td> Eine gültige Ganz-Zahl für den Monat wenn der mechanische Elektrizitätszähler jedes Jahr durch den Elektrizitätsversorger abgelesen wird.<BR>
- Der Standard-Wert ist 5 (Mai)<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ReadingDestination</code> : </li></td><td> Eines der vordefinerten Device als Ziel der errechneten Readings: [CalculatorDevice,CounterDevice].<BR>
- Das CalculatorDevice ist das mit diesem Modul erstellte Device.<BR>
- Das CounterDevice ist das Device von welchem der mechanische Zähler ausgelesen wird.<BR>
- Der Standard-Wert ist CalculatorDevice.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>SiPrefixPower</code> : </li></td><td> Ein Wert der vorgegebenen Auswahlliste: W (Watt), kW (Kilowatt), MW (Megawatt) or GW (Gigawatt).<BR>
- Es definiert welcher SI-Prefix verwendet werden soll und teilt die Leistung entsprechend durch ein Vielfaches von 1000.
- Der Standard-Wert ist W (Watt).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="ElectricityCalculatorReadings"></a><b>Readings</b></td></tr>
- <tr><td>
- <ul>
- Sobald das Device in der Lage war mindestens 2 Werte des Zählers einzulesen, werden automatisch die entsprechenden Readings erzeugt:<BR>
- Der Platzhalter <code><DestinationDevice></code> steht für das Device, welches man in dem Attribut <code>ReadingDestination</code> oben festgelegt hat. Dieser Platzhalter bleibt leer, sobald man dort CalculatorDevice ausgewählt hat.<BR>
- Der Platzhalter <code><SourceCounterReading></code> steht für das Reading welches mit der Regular Expression definiert wurde.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterCurrent</code> : </li></td><td>Aktueller Zählerstand am mechanischen Zähler. Bei Unterschied muss das Offset-Attribut entspechend korrigiert werden.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterDay1st</code> : </li></td><td>Der erste Zählerstand des laufenden Tages seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterDayLast</code> : </li></td><td>Der letzte Zählerstand des vorherigen Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMeter1st</code> : </li></td><td>Der erste Zählerstand seit Mitternacht des ersten Tages der laufenden Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMeterLast</code> : </li></td><td>Der letzte Zählerstand seit Mitternacht des ersten Tages der vorherigen Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMonth1st</code> : </li></td><td>Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMonthLast</code> : </li></td><td>Der letzte Zählerstand des vorherigen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterYear1st</code> : </li></td><td>Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterYearLast</code> : </li></td><td>Der letzte Zählerstand des letzten Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast</code> : </li></td><td>Elektrische Energiekosten des letzten Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast</code> : </li></td><td>Elektrische Energiekosten der letzten Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast</code> : </li></td><td>Elektrische Energiekosten des letzten Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast</code> : </li></td><td>Elektrische Energiekosten des letzten Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostDay</code> : </li></td><td>Energiekosten in gewählter Währung seit Mitternacht des laufenden Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMeter</code> : </li></td><td>Energiekosten in gewählter Währung seit Beginn der laufenden Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMonth</code> : </li></td><td>Energiekosten in gewählter Währung seit Beginn des laufenden Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostYear</code> : </li></td><td>Energiekosten in gewählter Währung seit Beginn des laufenden Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyDay</code> : </li></td><td>Energieverbrauch seit Beginn der aktuellen Tages (Mitternacht).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyDayLast</code> : </li></td><td>Energieverbrauch in kWh des vorherigen Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMeter</code> : </li></td><td>Energieverbrauch seit Beginn der aktuellen Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMeterLast</code> : </li></td><td>Energieverbrauch in kWh der vorherigen Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMonth</code> : </li></td><td>Energieverbrauch seit Beginn des aktuellen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMonthLast</code> : </li></td><td>Energieverbrauch in kWh des vorherigen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyYear</code> : </li></td><td>Energieverbrauch seit Beginn des aktuellen Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyYearLast</code> : </li></td><td>Energieverbrauch in kWh des vorherigen Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_FinanceReserve</code> : </li></td><td>Finanzielle Reserve basierend auf den Abschlagszahlungen die jeden Monat an den Elektrizitätsversorger gezahlt werden. Bei negativen Werten ist von einer Nachzahlung auszugehen.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_MonthMeterReading</code> : </li></td><td>Anzahl der Monate seit der letzten Zählerablesung. Der Monat der Zählerablesung ist der erste Monat = 1.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerCurrent</code> : </li></td><td>Aktuelle elektrische Leistung. (Mittelwert zwischen aktueller und letzter Messung)<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerDayAver</code> : </li></td><td>Mittlere elektrische Leistung seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerDayMax</code> : </li></td><td>Maximale elektrische Leistungsaufnahme seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerDayMin</code> : </li></td><td>Minimale elektrische Leistungsaufnahme seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- </ul>
- <p><a name="EleroDrive"></a>
- <h3>EleroDrive</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EleroDrive'>EleroDrive</a><br/>
- </ul>
- <a name="EleroStick"></a>
- <h3>EleroStick</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EleroStick'>EleroStick</a><br/>
- </ul>
- <a name="EleroSwitch"></a>
- <h3>EleroSwitch</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EleroSwitch'>EleroSwitch</a><br/>
- </ul>
- <a name="EnOcean"></a>
- <h3>EnOcean</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#EnOcean'>EnOcean</a><br/>
- </ul>
- <a name="FBAHA"></a>
- <h3>FBAHA</h3>
- <div class='langLinks'>[<a href='commandref.html#FBAHA'>EN</a> DE]</div>
- <ul>
- <br>Achtung: ab Fritz!OS 6.90 ist der benötigte Dienst deaktiviert,
- bitte den Nachfolger FBAHAHTTP verwenden.<br>
- Dieses Modul verbindet sich mit dem AHA (AVM Home Automation) Server auf
- einem FRITZ!Box. Es dient als "physikalisches" Gegenstück zum <a
- href="#FBDECT">FBDECT</a> Modul. Als erstes muss der Zugang zu diesen Daten
- in der FRITZ!Box Web-Oberfläche aktiviert werden.
- <br><br>
- <a name="FBAHAdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FBAHA <device></code>
- <br>
- <br>
- <host> ist normalerweise die Adresse der FRITZ!Box, wo das AHA Server
- läuft (fritz.box oder localhost), <port> ist 2002.
- <device> is entweder a eine Kombianation aus <host>:<port>,
- wobei <host> die Adresse der FRITZ!Box ist (localhost AUF dem
- FRITZ.BOX) und <port> 2002 ist, oder
- UNIX:SEQPACKET:/var/tmp/me_avm_home_external.ctl, wobei das nur fuer
- FHEM@FRITZ!BOX zur Verfügung steht. Mit FRITZ!OS 5.50 steht auch der
- Netzwerkport zur Verfügung, auf manchen Laborvarianten nur das UNIX
- socket.<br>
-
- Beispiel:
- <ul>
- <code>define fb1 FBAHA fritz.box:2002</code><br>
- <code>define fb1 FBAHA UNIX:SEQPACKET:/var/tmp/me_avm_home_external.ctl</code><br>
- </ul>
- </ul>
- <br>
- <a name="FBAHAset"></a>
- <b>Set</b>
- <ul>
- <li>createDevs<br>
- legt FHEM Geräte an für jedes auf dem AHA-Server gefundenen DECT
- Eintrag, siehe auch "get devList".
- </li>
- <li>reopen<br>
- Schließt und öffnet die Verbindung zum AHA Server. Nur für
- debugging.
- </li>
- <li>reregister<br>
- Gibt den AHA handle frei, und registriert sich erneut beim AHA Server. Nur
- für debugging.
- </li>
- </ul>
- <br>
- <a name="FBAHAget"></a>
- <b>Get</b>
- <ul>
- <li>devList<br>
- liefert die Liste aller DECT-Einträge der AHA Server zurück, mit
- einem kurzen Info.
- </li>
- </ul>
- <br>
- <a name="FBAHAattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#dummy">dummy</a></li>
- </ul>
- <br>
- <a name="FBAHAevents"></a>
- <b>Generierte Events:</b>
- <ul>
- <li>UNDEFINED FBDECT_$ahaName_${NR} FBDECT $id"
- </li>
- </ul>
- <br>
- Da manchmal die FRITZ!Box die interne Nummer der FBDECT Geräte
- neu vergibt, werden beim Verbindungsaufbau zum AHA Server die gespeicherten
- Namen (FBNAME) mit dem aktuellen Wert verglichen. Damit das funktioniert,
- müssen alle FBDECT Geräte auf dem FRITZ!Box einen eindeutigen Namen
- bekommen, und in FHEM muss für alle Geräte "get FBDECTDEVICE
- devInfo" ausgeführt werden, um FBNAME als Reading zu speichern.<br>
- </ul>
- <p><a name="FBAHAHTTP"></a>
- <h3>FBAHAHTTP</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FBAHAHTTP'>FBAHAHTTP</a><br/>
- </ul>
- <a name="FBDECT"></a>
- <h3>FBDECT</h3>
- <div class='langLinks'>[<a href='commandref.html#FBDECT'>EN</a> DE]</div>
- <ul>
- Dieses Modul wird verwendet, um AVM FRITZ!DECT Geräte via FHEM zu
- steuern, siehe auch das <a href="#FBAHA">FBAHA</a> oder <a
- href="#FBAHAHTTP">FBAHAHTTP</a> Modul für die Anbindung an das FRITZ!Box.
- <br><br>
- <a name="FBDECTdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FBDECT [<FBAHAname>:]<id> props</code>
- <br>
- <br>
- Beispiel:
- <ul>
- <code>define lampe FBDECT 16 switch,powerMeter</code><br>
- </ul>
- <b>Achtung:</b>FBDECT Einträge werden normalerweise per
- <a href="#autocreate">autocreate</a> angelegt. Falls sie die zugeordnete
- FBAHA oder FBAHAHTTP Instanz umbenennen, dann muss die FBDECT Definition
- manuell angepasst werden.
- </ul>
- <br>
- <br
- <a name="FBDECTset"></a>
- <b>Set</b>
- <ul>
- <li>on/off<br>
- Gerät einschalten bzw. ausschalten.</li>
- <li>desired-temp <value><br>
- Gewünschte Temperatur beim Comet DECT setzen (nur mit FBAHAHTTP als
- IODev).
- </li>
- <li>
- Die <a href="#setExtensions">set extensions</a> werden
- unterstützt.
- </li>
- <li>msgInterval <sec><br>
- Anzahl der Sekunden zwischen den Sensornachrichten (nur mit FBAHA als
- IODev).
- </li>
- </ul>
- <br>
- <a name="FBDECTget"></a>
- <b>Get</b>
- <ul>
- <li>devInfo<br>
- meldet Geräte-Informationen (nur mit FBAHA als IODev)</li>
- </ul>
- <br>
- <a name="FBDECTattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#dummy">dummy</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#model">model</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <a name="FBDECTevents"></a>
- <b>Generierte events:</b>
- <ul>
- <li>on</li>
- <li>off</li>
- <li>set_on</li>
- <li>set_off</li>
- <li>current: $v A</li>
- <li>voltage: $v V</li>
- <li>power: $v W</li>
- <li>energy: $v Wh</li>
- <li>powerFactor: $v"</li>
- <li>temperature: $v C ([measured|corrected])</li>
- <li>options: uninitialized</li>
- <li>options: powerOnState:[on|off|last],lock:[none,webUi,remoteFb,button]</li>
- <li>control: disabled</li>
- <li>control: on power < $v delay:$d sec do:state [on|off]</li>
- <li>relaytimes: disabled</li>
- <li>relaytimes: HEX</li>
- </ul>
- </ul>
- <p><a name="FB_CALLLIST"></a>
- <h3>FB_CALLLIST</h3>
- <div class='langLinks'>[<a href='commandref.html#FB_CALLLIST'>EN</a> DE]</div>
- <ul>
- Das FB_CALLLIST Modul erstellt eine Anrufliste für eine konfigurierte <a href="#FB_CALLMONITOR">FB_CALLMONITOR</a> Definition.
- Es speichert alle Anrufe und zeigt sie in einer historischen Tabelle an.
- <br><br>
- Es wird eine bereits konfigurierte FB_CALLMONITOR Definition benötigt, von der FB_CALLLIST die Events entsprechend verarbeiten kann.<br><br>
- Abhängig von der Konfiguration der Attribute wird der Status als Icon oder als Textzeichen ausgegeben.
- Um die Icons korrekt anzeigen zu können, muss das openautomation Icon-Set in der entsprechenden FHEMWEB-Instanz konfiguriert sein (siehe dazu FHEMWEB Attribut <a href="#iconPath">iconPath</a>).
- <br><br>
- Die Icons haben verschiedene Farben:<br><br>
- <ul>
- <li><font color="blue"><b>blau</b></font> - Eingehender Anruf (aktiv oder beendet)</li>
- <li><font color="green"><b>grün</b></font> - Ausgehender Anruf (aktiv oder beendet))</li>
- <li><font color="red"><b>rot</b></font> - Verpasster Anruf (eingehend)</li>
- </ul>
- <br>
- Falls keine Icons verwendet werden sollen (siehe Attribut <a href="#FB_CALLLIST_show-icons">show-icons</a>), wird der Status wie folgt angezeigt:<br><br>
- <ul>
- <li><code><b><= ((o))</b></code></td><td> - Ausgehender Anruf (klingelt)</li>
- <li><code><b>=> ((o))</b></code></td><td> - Eingehender Anruf (klingelt)</li>
- <br>
- <li><code><b><= [=]</b></code></td><td> - Ausgehender Anruf (laufendes Gespräch)</li>
- <li><code><b>=> [=]</b></code></td><td> - Eingehender Anruf (laufendes Gespräch)</li>
- <br>
- <li><code><b><= X</b></code></td><td> - Ausgehender, erfolgloser Anruf (Gegenseite nicht abgenommen)</li>
- <li><code><b>=> X</b></code></td><td> - Eingehender, erfolgloser Anruf (Verpasster Anruf)</li>
- <br>
- <li><code><b>=> O_O</b></code></td><td> - Eingehender Anruf, der durch einen Anrufbeantworter entgegen genommen wurde</li>
- <br>
- <li><code><b><=</b></code></td><td> - Ausgehender Anruf (beendet)</li>
- <li><code><b>=></b></code></td><td> - Eingehender Anruf (beendet)</li>
- </ul>
- <br>
- <a name="FB_CALLLIST_define"></a>
- <b>Definition</b>
- <ul>
- <code>define <Name> FB_CALLLIST <FB_CALLMONITOR Name></code><br>
- </ul>
- <br>
- <a name="FB_CALLLIST_set"></a>
- <b>Set-Kommandos</b><br>
- <ul>
- <li><b>clear</b> - löscht die gesamte Anrufliste</li>
- </ul>
- <br>
- <a name="FB_CALLLIST_get"></a>
- <b>Get</b><br>
- <ul>
- N/A
- </ul>
- <br>
- <a name="FB_CALLLIST_attr"></a>
- <b>Attributes</b><br><br>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <br>
- <li><a name="FB_CALLLIST_answMachine-is-missed-call">answMachine-is-missed-call</a> 0,1</li>
- Sofern aktiviert, werden Anrufe, welche durch einen internen Anrufbeantworter beantwortet werden, als "verpasster Anruf" gewertet. Diese Funktionalität ist nur relevant, wenn <a href="#FB_CALLLIST_list-type">list-type</a> auf "missed-call" gesetzt ist.
- <br><br>
- Mögliche Werte: 0 => deaktiviert, 1 => aktiviert (Anrufbeantworter gilt als "verpasster Anruf").<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLLIST_create-readings">create-readings</a> 0,1</li>
- Sofern aktiviert, werden für alle sichtbaren Anrufe in der Liste entsprechende Readings und Events erzeugt.
- Es wird empfohlen das Attribut <a href="#event-on-change-reading">event-on-change-reading</a> auf den Wert <code>.*</code> zu stellen um die hohe Anzahl an Events in bestimmten Fällen zu minimieren.<br><br>
- Mögliche Werte: 0 => keine Readings erstellen, 1 => Readings und Events werden erzeugt.<br>
- Standardwert ist 0 (keine Readings erstellen)<br><br>
- <li><a name="FB_CALLLIST_connection-mapping">connection-mapping</a> <hash></li>
- Definiert eine eigene Zuordnung der Endgeräte (Reading: internal_connection) zu eigenen Bezeichnungen. Die Zuordnung erfolgt über eine Hash-Struktur.<br><br>
- z.B.<br>
- <ul>
- <code>attr <name> connection-mapping {'DECT_1' => 'Mobilteil Küche', 'FON1' => 'Fax', 'Answering_Machine_1' => 'Anrufbeantworter'}</code>
- </ul><br>
- Die jeweils zugeordnete Bezeichnung wird in der Anrufliste dann entsprechend angezeigt anstatt des originalen Werten von FB_CALLMONITOR.
- <br><br>
- Standardwert ist <i>nicht gesetzt</i> (Keine Zuordnung, es werden die Originalwerte verwendet)
- <br><br>
- <li><a name="FB_CALLLIST_disable">disable</a> 0,1,2,3</li>
- Optionales Attribut zur Deaktivierung der Anrufliste. Sofern aktiviert, werden keine Anruf-Events mehr verarbeitet und die Liste nicht weiter aktualisiert. Je nach gesetztem Wert verhält sich FB_CALLLIST unterschiedlich.
- <br><br>
- Mögliche Werte:<ul>
- <li>0 => Anrufliste ist aktiv, verarbeitet Events und aktualisiert die Darstellung kontinuierlich.</li>
- <li>1 => Events werden NICHT verarbeitet. Die Darstellung wird NICHT aktualisiert (bleibt wie sie ist).</li>
- <li>2 => Events werden NICHT verarbeitet. Die Darstellung zeigt nur "disabled" an (keine Einträge mehr).</li>
- <li>3 => Events werden NICHT verarbeitet. Die Liste wird NICHT mehr angezeigt.</li>
- </ul><br>
- Standardwert ist 0 (aktiv)<br><br>
- <li><a name="FB_CALLLIST_disabledForIntervals">disabledForIntervals</a> HH:MM-HH:MM HH:MM-HH:MM...</li>
- Optionales Attribut zur Deaktivierung der Anrufliste innerhalb von bestimmten Zeitintervallen.
- Das Argument ist eine Leerzeichen-getrennte Liste von Minuszeichen-getrennten HH:MM Paaren (Stunde : Minute).
- Falls die aktuelle Uhrzeit zwischen diese Werte fällt, dann wird die Ausführung, wie bei <a href="#FB_CALLLIST_disable">disable</a> gleich 1, ausgesetzt.
- Statt HH:MM kann man auch HH oder HH:MM:SS angeben.<br><br>
- Um einen Intervall um Mitternacht zu spezifizieren, muss man zwei einzelne Intervalle angeben, z.Bsp.:
- <pre>23:00-24:00 00:00-01:00</pre>
- Standardwert ist <i>nicht gesetzt</i> (dauerhaft aktiv)<br><br>
- <li><a name="FB_CALLLIST_processEventsWhileDisabled">processEventsWhileDisabled</a> 0,1</li>
- Sofern gesetzt, werden Events weiterhin verarbeitet, selbst wenn FB_CALLLIST deaktiviert ist (siehe <a href="FB_CALLLIST_disable">disabled</a> und <a href="FB_CALLLIST_disabledForIntervals">disabledForIntervals</a>).
- Sobald FB_CALLLIST wieder aktiviert wurde, stehen sämtliche Anrufe, während FB_CALLLIST deaktiviert war, zur Verfügung.
- <br><br>
- Mögliche Werte: 0 => keine Eventverabeitung wenn FB_CALLLIST deaktiviert ist, 1 => Events werden trotz deaktiviert FB_CALLLIST intern weiterhin verarbeitet.<br>
- Standardwert ist 0 (keine Eventverabeitung wenn deaktiviert)<br><br>
- <li><a name="FB_CALLLIST_expire-calls-after">expire-calls-after</a> <Zeitfenster></li>
- Optionales Attribut um beendete Anrufe nach einem angegeben Zeitfenster automatisch aus der Anrufliste zu löschen.
- Sobald ein beendetes Gespräch älter ist als das angegebene Zeitfenster, wird es automatisch aus der Liste entfernt.
- <br><br>Ein Zeitfenster kann wie folgt angegeben werden:
- <ul>
- <li>als Minuten: <code>1 minute</code> oder <code>30 minutes</code></li>
- <li>als Stunden: <code>1 hour</code> oder <code>12 hours</code></li>
- <li>als Tage: <code>1 day</code> oder <code>5 days</code></li>
- <li>als Monate: <code>1 month</code> oder <code>6 months</code> (ein Monat entspricht hierbei 30 Tagen month is here equal to 30 days)</li>
- <li>als Jahr: <code>1 year</code> oder <code>2 years</code> (ein Jahr entspricht hierbei 365 Tagen)</li>
- </ul>
- <br>
- <b>WICHTIG:</b> Es wird hierbei der Endezeitpunkt eines Gesprächs betrachtet, nicht der Beginn des Gesprächs.<br><br>
- Wenn keine Einheit angegeben ist, wird die angegebene Zahl als Sekunden interpretiert. Es können auch Fliesskommazahlen mit einem Punkt als Kommastelle angegeben werden (z.B. <code>0.5 day</code>).
- Der Wert <code>0</code> bedeutet, das keine Gespräche nach einem gewissen Zeitfenster gelöscht werden.<br><br>
- Standardwert ist 0 (keine Gespräche werden nach einem Zeitfenster gelöscht)<br><br>
- <li><a name="FB_CALLLIST_external-mapping">external-mapping</a> <hash></li>
- Definiert eine eigene Zuordnung der externen Anschlussbezeichnung (Reading: external_connection) zu eigenen Bezeichnungen. Die Zuordnung erfolgt über eine Hash-Struktur.<br><br>
- z.B.<br>
- <ul>
- <code>attr <name> external-mapping {'ISDN' => 'Festnetz', 'SIP0' => 'Anbieter A', 'SIP1' => 'Anbieter B'}</code>
- </ul><br>
- Die jeweils zugeordnete Bezeichnung wird in der Anrufliste dann entsprechend angezeigt anstatt des originalen Werten von FB_CALLMONITOR.
- <br><br>
- Standardwert ist <i>nicht gesetzt</i> (Keine Zuordnung, es werden die Originalwerte verwendet)
- <br><br>
- <li><a name="FB_CALLLIST_icon-mapping">icon-mapping</a> <hash></li>
- Definiert eine eigene Zuordnung eines Anrufstatus zu einem Icon. Die Zuordnung erfolgt über eine Hash-Struktur.<br><br>
- z.B.<br>
- <ul>
- <code>attr <name> icon-mapping {'incoming.connected' => 'phone_ring_in@yellow', 'outgoing.missed' => 'phone_missed_out@red'}</code>
- </ul><br>
- Das entsprechende Icon wird an Stelle des Original-Icons bzw. Text verwendet. Sofern SVG-basierte Icons verwendet werden, kann man die Farbe optional definieren durch das Anfügen via @ mit Name oder einem HTML Farbcode.
- <br><br>
- Mögliche Werte und ihre Standard-Icons sind:<br><br>
- <ul>
- <li><b>incoming.ring</b> => phone_ring@blue</li>
- <li><b>outgoing.ring</b> => phone_ring@green</li>
- <li><b>incoming.connected</b> => phone_ring_in@blue</li>
- <li><b>outgoing.connected</b> => phone_ring_in@green</li>
- <li><b>incoming.missed</b> => phone_missed_in@red</li>
- <li><b>outgoing.missed</b> => phone_missed_out@green</li>
- <li><b>incoming.done</b> => phone_call_end_in@blue</li>
- <li><b>outgoing.done</b> => phone_call_end_out@green</li>
- <li><b>incoming.tam</b> => phone_answering@blue</li>
- </ul>
- <br><br>
- Standardwert ist <i>nicht gesetzt</i> (Keine Zuordnung, es werden die Standard-Icons verwendet, sofern Icons akitivert sind)
- <br><br>
- <li><a name="FB_CALLLIST_internal-number-filter">internal-number-filter</a> <hash></li>
- Dieses Attribut ermöglicht das Filtern der angezeigten Anrufe auf bestimmte interne Rufnummern sowie das Zuordnen von Namen zu den internen Rufnummern.<br><br>
- Es ist möglich eine kommaseparierte Liste an internen Rufnummern anzugeben oder eine Hash-Tabelle in der man den internen Rufnummern eine eigene Bezeichnung zuweist.
- <br>
- <br>
- z.B.<br>
- <ul>
- <code>attr <name> internal-number-filter 304050,304060<br><br>
- attr <name> internal-number-filter {'304050' => 'geschftl.', '304060' => 'privat'}</code>
- </ul>
- <br>
- <b>Wichtig:</b> Je nach Telefonanbieter kann der Wert die Ortsvorwahl enthalten. Die Rufnummer muss genauso angegeben werden, wie sie ohne eine Zuordnung in der Anrufliste auftaucht.<br><br>
- Wenn dieses Attribut gesetzt ist, werden nur die eingestellten Rufnummern in der Liste angezeigt.
- <br><br>
- Standardwert ist <i>nicht gesetzt</i> (alle internen Rufnummern werden angezeigt)
- <br><br>
- <li><a name="FB_CALLLIST_list-order">list-order</a> descending,ascending</li>
- Gibt an ob der neueste Anruf in der ersten Zeile (aufsteigend => descending) oder in der letzten Zeile (absteigend => ascending) in der Liste angezeigt werden soll. Dementsprechend rollt die Liste dann nach oben oder unten durch.<br><br>
- Standardwert ist "descending" (absteigend, neuester Anruf in der ersten Zeile)<br><br>
- <li><a name="FB_CALLLIST_list-type">list-type</a> all,incoming,outgoing,missed-calls,completed,active</li>
- Ist dieses Attribut gesetzt, werden nur bestimmte Typen von Anrufen in der Liste angezeigt:<br><br>
- <ul>
- <li><code>all</code> - Alle Anrufe werden angezeigt</li>
- <li><code>incoming</code> - Alle eingehenden Anrufe werden angezeigt (aktive und abgeschlossene)</li>
- <li><code>outgoing</code> - Alle ausgehenden Anrufe werden angezeigt (aktive und abgeschlossene)</li>
- <li><code>missed-calls</code> - Alle eingehenden, verpassten Anrufe werden angezeigt.</li>
- <li><code>completed</code> - Alle abgeschlossenen Anrufe werden angezeigt (eingehend und ausgehend)</li>
- <li><code>active</code> - Alle aktuell laufenden Anrufe werden angezeigt (eingehend und ausgehend)</li>
- </ul><br>
- Standardwert ist "all" (alle Anrufe anzeigen)<br><br>
- <li><a name="FB_CALLLIST_no-heading">no-heading</a> 0,1</li>
- Sofern aktiviert, wird die Überschriftenzeile ausserhalb der Liste inkl. Link auf die Detail-Seite der aktuellen Definition ausgeblendet.<br><br>
- Mögliche Werte: 0 => Überschriftenzeile wird angezeigt , 1 => Überschriftenzeile wird ausgeblendet<br>
- Standardwert ist 1 (Überschriftenzeile wird angezeigt)<br><br>
- <li><a name="FB_CALLLIST_no-table-header">no-table-header</a> 0,1</li>
- Sofern aktiviert, wird die Kopfzeile der Tabelle für die aktuelle Definition ausgeblendet.<br><br>
- Mögliche Werte: 0 => Kopfzeile wird angezeigt , 1 => Kopfzeile wird ausgeblendet<br>
- Standardwert ist 1 (Kopfzeile wird angezeigt)<br><br>
- <li><a name="FB_CALLLIST_number-cmd">number-cmd</a> <Befehl></li>
- Kann gesetzt werden, um ein FHEM-Befehl oder Perl-Code (in geschweiften Klammern: { ... } ) auszuführen, wenn man auf eine Rufnummer in der Anrufliste klickt.
- Der Platzhalter <code>$NUMBER</code> wird dabei mit der entsprechenden Rufnummer der jeweiligen Zeile ersetzt.
- <br><br>
- Damit kann man beispielsweise einen Rückruf starten.
- e.g.:<br><br>
- <ul>
- <li><code>set FRITZBOX call $NUMBER</code></li>
- <li><code>{dialNumber("$NUMBER")}</code></li>
- </ul>
- <br>
- Sofern nicht gesetzt, wird kein Link angezeigt.<br><br>
- <li><a name="FB_CALLLIST_number-of-calls">number-of-calls</a> 1..40</li>
- Setzt die maximale Anzahl an Einträgen in der Anrufliste. Sollte die Anrufliste voll sein, wird das älteste Gespräch gelöscht.<br><br>
- Standardwert sind 5 Einträge<br><br>
- <li><a name="FB_CALLLIST_show-icons">show-icons</a> 0,1</li>
- Im Normalfall wird der Status eines jeden Anrufs mit einem Icon angezeigt. Dazu muss das openautomation Icon-Set im iconpath-Attribut der entsprechenden FHEMWEB Instanz konfiguriert sein. Sollte man keine Icons wünschen, so kann man diese hiermit abschalten. Der Status wird dann mittels Textzeichen dargestellt.<br><br>
- Mögliche Werte: 0 => keine Icons , 1 => benutze Icons<br>
- Standardwert ist 1 (benutze Icons)<br><br>
- <li><a name="FB_CALLLIST_time-format-string">time-format-string</a> <string></li>
- Definiert einen Formatierungs-String welcher benutzt wird um die Zeitangaben in der Anrufliste nach eigenen Wünschen anzupassen. Es stehen hier eine ganze Reihe an Platzhaltern zur Verfügung um die einzelnen Elemente einer Datums-/Zeitangabe einzeln zu setzen. Die möglichen Werte sind alle Standard POSIX strftime() Platzhalter. Gängige Platzhalter sind:<br><br>
- <ul>
- <li><code>%a</code> - Der abgekürzte Wochentagname</li>
- <li><code>%b</code> - Der abgekürzte Monatsname</li>
- <li><code>%S</code> - Die Sekunden als Dezimalzahl</li>
- <li><code>%M</code> - Die Minuten als Dezimalzahl</li>
- <li><code>%H</code> - Die Stunden als Dezimalzahl</li>
- <li><code>%d</code> - Der Tag im Monat als Dezimalzahl</li>
- <li><code>%m</code> - Der Monat als Dezimalzahl</li>
- <li><code>%Y</code> - Das Jahr als Dezimalzahl (4-stellig).</li>
- </ul><br>
- Es gibt hierfür noch weitere Platzhalter. Weitere Informationen dazu findet man in der Manpage von <code>strftime()</code> oder der Dokumentation des entsprechenden Perl Interpreters.
- <br><br>
- Standardwert ist "%a, %d %b %Y %H:%M:%S" (entspricht "So, 07 Jun 2015 12:50:09")<br><br>
- <li><a name="FB_CALLLIST_language">language</a> en,de</li>
- Definiert die Sprache in der die Anrufliste angezeigt werden soll (Tabellenkopf, Datum). Die entsprechende Sprache muss auch im Betriebssystem installiert und unterstützt werden.<br><br>
- Mögliche Werte: en => Englisch , de => Deutsch<br>
- Standardwert ist en (Englisch)<br><br>
- <li><a name="FB_CALLLIST_visible-columns">visible-columns</a> row,state,timestamp,name,number,internal,external,connection,duration</li>
- Legt fest, welche Spalten in welcher Reihenfolge (von links nach rechts) in der Anrufliste angezeigt werden sollen.
- Es müssen nicht alle verfügbaren Spalten angezeigt werden.
- Es kann auch eine Auswahl von einzelnen Spalten angezeigt werden.
- <br><br>
- Die möglichen Werte repräsentieren die jeweilige Spalte.
- Der Wert "row" steht für die Zeilennummer innerhalb der Liste.
- <br><br>
- Mögliche Werte: Eine Kombination der folgenden Werte in der gewünschten Reihenfolge: <code>row,state,timestamp,name,number,internal,external,connection,duration</code><br>
- Standardwert ist "row,state,timestamp,name,number,internal,external,connection,duration" (Anzeige aller Spalten)<br><br>
- </ul>
- <br>
- <a name="FB_CALLLIST_events"></a>
- <b>Generierte Events:</b><br><br>
- <ul>
- Dieses Modul generiert Readings/Events sofern das Attribut <a href="#FB_CALLLIST_create-readings">create-readings</a> aktiviert ist. Die Anzahl, sowie der Name der Readings ist von den gewählten Spalten (Attribut: <a href="#FB_CALLLIST_visible-columns">visible-columns</a>), sowie der Anzahl der anzuzeigenden Anrufe abhängig (Attribut: <a href="#FB_CALLLIST_number-of-calls">number-of-calls</a>).
- </ul>
- </ul>
- <p><a name="FB_CALLMONITOR"></a>
- <h3>FB_CALLMONITOR</h3>
- <div class='langLinks'>[<a href='commandref.html#FB_CALLMONITOR'>EN</a> DE]</div>
- <ul>
- Das Modul FB_CALLMONITOR verbindet sich zu einer AVM FritzBox Fon und verarbeitet
- Telefonie-<a href="#FB_CALLMONITOR_events">Ereignisse</a>.(eingehende & ausgehende Telefonate)
- <br><br>
- Um dieses Modul nutzen zu können, muss der Callmonitor via Kurzwahl mit einem Telefon aktiviert werden.
- .<br><br>
- <ul>
- <code>#96*5* - Callmonitor aktivieren<br>#96*4* - Callmonitor deaktivieren</code>
- </ul>
- <br>
- Einfach die entsprechende Kurzwahl auf irgend einem Telefon eingeben, welches an die Fritz!Box angeschlossen ist.
- Nach ca. 3 Sekunden kann man einfach wieder auflegen. Nun ist der Callmonitor aktiviert.
- <br><br>
- Sobald der Callmonitor auf der Fritz!Box aktiviert wurde erzeugt das Modul entsprechende Events (s.u.) für alle externen Anrufe. Interne Anrufe werden nicht durch den Callmonitor erfasst.
- <br><br>
- Dieses Modul funktioniert mit allen Fritz!Box Modellen, welche Telefonie unterstützen (Namenszusatz: Fon).
- <br><br>
-
- <a name="FB_CALLMONITOR_define"></a>
- <b>Definition</b>
- <ul>
- <code>define <name> FB_CALLMONITOR <IP-Addresse>[:Port]</code><br>
- <br>
- Port 1012 ist der Standardport und muss daher nicht explizit angegeben werden.
- <br>
- </ul>
- <br>
- <a name="FB_CALLMONITOR_set"></a>
- <b>Set-Kommandos</b>
- <ul>
- <li><b>reopen</b> - schliesst die Verbindung zur FritzBox und öffnet sie erneut</li>
- <li><b>rereadCache</b> - Liest den Cache aus der Datei neu ein (sofern konfiguriert, siehe dazu Attribut <a href="#FB_CALLMONITOR_reverse-search-cache-file">reverse-search-cache-file</a>)</li>
- <li><b>rereadPhonebook</b> - Liest das Telefonbuch der FritzBox neu ein (per Datei, Telnet oder direkt lokal)</li>
- <li><b>rereadTextfile</b> - Liest die nutzereigene Textdatei neu ein (sofern konfiguriert, siehe dazu Attribut <a href="#FB_CALLMONITOR_reverse-search-text-file">reverse-search-text-file</a>)</li>
- <li><b>password</b> - speichert das FritzBox Passwort, welches für das Einlesen aller Telefonbücher direkt von der FritzBox benötigt wird. Dieses Kommando ist nur verfügbar, wenn ein Passwort benötigt wird um das Telefonbuch via Netzwerk einzulesen, siehe dazu Attribut <a href="#FB_CALLMONITOR_fritzbox-remote-phonebook">fritzbox-remote-phonebook</a>.</li>
- </ul>
- <br>
- <a name="FB_CALLMONITOR_get"></a>
- <b>Get-Kommandos</b>
- <ul>
- <li><b>search <Rufnummer></b> - gibt den Namen der Telefonnummer zurück (aus Cache, Telefonbuch oder Rückwärtssuche)</li>
- <li><b>showPhonebookIds</b> - gibt eine Liste aller verfügbaren Telefonbücher auf der FritzBox zurück (nicht verfügbar wenn das Telefonbuch via Telnet-Verbindung eingelesen wird)</li>
- <li><b>showPhonebookEntries</b> - gibt eine Liste aller bekannten Telefonbucheinträge zurück (nur verfügbar, wenn eine Rückwärtssuche via Telefonbuch aktiviert ist)</li>
- <li><b>showCacheEntries</b> - gibt eine Liste aller bekannten Cacheeinträge zurück (nur verfügbar, wenn die Cache-Funktionalität der Rückwärtssuche aktiviert ist))</li>
- <li><b>showTextEntries</b> - gibt eine Liste aller Einträge aus der nutzereigenen Textdatei zurück (nur verfügbar, wenn eine Textdatei als Attribut definiert ist))</li>
- </ul>
- <br>
- <a name="FB_CALLMONITOR_attr"></a>
- <b>Attribute</b><br><br>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="FB_CALLMONITOR_disable">disable</a> 0,1</li>
- Optionales Attribut zur Deaktivierung des Callmonitors. Es können dann keine Anruf-Events mehr erkannt und erzeugt werden.
- <br><br>
- Mögliche Werte: 0 => Callmonitor ist aktiv, 1 => Callmonitor ist deaktiviert.<br>
- Standardwert ist 0 (aktiv)<br><br>
- <li><a name="FB_CALLMONITOR_disabledForIntervals">disabledForIntervals</a> HH:MM-HH:MM HH:MM-HH-MM...</li>
- Optionales Attribut zur Deaktivierung des Callmonitors innerhalb von bestimmten Zeitintervallen.
- Das Argument ist eine Leerzeichen-getrennte Liste von Minuszeichen-getrennten HH:MM Pärchen (Stunde : Minute).
- Falls die aktuelle Uhrzeit zwischen diese Werte fällt, dann wird die Verarbeitung, wie bei <a href="#FB_CALLMONITOR_disable">disable</a>, ausgesetzt.
- Statt HH:MM kann man auch HH oder HH:MM:SS angeben.<br><br>
- Um einen Intervall um Mitternacht zu spezifizieren, muss man zwei einzelne Intervalle angeben, z.Bsp.:
- <pre>23:00-24:00 00:00-01:00</pre>
- Standardwert ist <i>nicht gesetzt</i> (dauerhaft aktiv)<br><br>
- <li><a name="FB_CALLMONITOR_answMachine-is-missed-call">answMachine-is-missed-call</a> 0,1</li>
- Sofern aktiviert, werden Anrufe, welche durch einen internen Anrufbeantworter beantwortet werden, als "unbeantworteter Anruf" gewertet (siehe Reading "missed_call" unter <a href="#FB_CALLMONITOR_events">Generated Events</a>).
- <br><br>
- Mögliche Werte: 0 => deaktiviert, 1 => aktiviert (Anrufbeantworter gilt als "unbeantworteter Anruf").<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLMONITOR_reverse-search">reverse-search</a> (phonebook,dasoertliche.de,11880.com,search.ch,dasschnelle.at,herold.at)</li>
- Aktiviert die Rückwärtssuche der externen Rufnummer (bei eingehenden/ausgehenden Anrufen).
- Dieses Attribut enthält eine komma-separierte Liste mit allen Anbietern die für eine Rückwärtssuche benutzt werden sollen.
- Die Rückwärtssuche prüft in der gegebenen Reihenfolge (von links nach rechts) ob der entsprechende Anbieter (Telefonbuch, Textdatei oder Internetanbieter) die Rufnummer auflösen können.
- Das erste Resultat was dabei gefunden wird, wird als Ergebnis für die Rückwärtssuche verwendet.
- Es ist möglich einen bestimmten Suchanbieter zu verwenden, welcher für die Rückwärtssuche verwendet werden soll.
- Der Anbieter "textfile" verwendet die nutzereigene Textdatei, sofern definiert (siehe Attribut reverse-search-text-file).
- Der Anbieter "phonebook" verwendet das Telefonbuch der FritzBox (siehe Attribut reverse-search-phonebook-file oder fritzbox-remote-phonebook).<br><br>
- Standardmäßig ist diese Funktion deaktiviert (nicht gesetzt)<br><br>
- <li><a name="FB_CALLMONITOR_reverse-search-cache">reverse-search-cache</a> 0,1</li>
- Wenn dieses Attribut gesetzt ist, werden alle Ergebisse von Internetanbietern in einem modul-internen Cache gespeichert
- und alle existierenden Ergebnisse aus dem Cache genutzt anstatt eine erneute Anfrage bei einem Internet-Anbieter durchzuführen.
- Der Cache ist immer an die Internetanbieter gekoppelt und speichert nur Ergebnisse von Internetanbietern.<br><br>
- Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLMONITOR_reverse-search-cache-file">reverse-search-cache-file</a> <Dateipfad></li>
- Da der Cache nur im Arbeitsspeicher existiert, ist er nicht persistent und geht beim stoppen von FHEM verloren.
- Mit diesem Parameter werden alle Cache-Ergebnisse in eine Textdatei geschrieben (z.B. /usr/share/fhem/telefonbuch.txt)
- und beim nächsten Start von FHEM wieder in den Cache geladen und genutzt.
- <br><br>
- <li><a name="FB_CALLMONITOR_reverse-search-cache-file">reverse-search-text-file</a> <Dateipfad></li>
- Lädt eine nutzereigene Textdatei welche eine eigene Namenszuordnungen für Rufnummern enthält. Diese Datei enthält zeilenweise komma-separierte Werte nach folgendem Schema:
- <pre>
- <Nummer1>,<Name1>
- <Nummer2>,<Name2>
- ...
- <NummerN>,<NameN>
- </pre>
- Die Datei kann dabei auch Kommentar-Zeilen enthalten mit # vorangestellt. Sollte die Datei nicht existieren, wird sie durch FHEM erstellt.
- <br><br>
- <li><a name="FB_CALLMONITOR_reverse-search-phonebook-file">reverse-search-phonebook-file</a> <Dateipfad></li>
- Mit diesem Attribut kann man optional den Pfad zu einer Datei angeben, welche ein Telefonbuch im FritzBox-Format (XML-Struktur) enthält.
- Dadurch ist es möglich ein FritzBox-Telefonbuch zu verwenden, ohne das FHEM auf einer FritzBox laufen muss.
- Sofern FHEM auf einer FritzBox läuft (und nichts abweichendes angegeben wurde), wird das interne File /var/flash/phonebook verwendet. Alternativ kann man das Telefonbuch in der FritzBox-Weboberfläche exportieren und dieses verwenden<br><br>
- Standardwert ist /var/flash/phonebook (entspricht dem Pfad auf einer FritzBox)<br><br>
- <li><a name="FB_CALLMONITOR_remove-leading-zero">remove-leading-zero</a> 0,1</li>
- Wenn dieses Attribut aktiviert ist, wird die führende Null aus der externen Rufnummer (bei eingehenden & abgehenden Anrufen) entfernt. Dies ist z.B. notwendig bei Telefonanlagen.<br><br>
- Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLMONITOR_unique-call-ids">unique-call-ids</a> 0,1</li>
- Wenn dieses Attribut aktiviert ist, wird für jedes Gespräch eine eineindeutige Identifizierungsnummer verwendet. Dadurch lassen sich auch bereits beendete Gespräche voneinander unterscheiden. Dies ist z.B. notwendig bei der Verarbeitung der Events durch eine Datenbank.<br><br>
- Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLMONITOR_local-area-code">local-area-code</a> <Ortsvorwahl></li>
- Verwendet die gesetze Vorwahlnummer bei Rückwärtssuchen von Ortsgesprächen (z.B. 0228 für Bonn)<br><br>
- <li><a name="FB_CALLMONITOR_country-code">country-code</a> <Landesvorwahl></li>
- Die Landesvorwahl wird benötigt um Telefonbucheinträge mit lokaler Landesvorwahl als Inlands-Rufnummern, als auch um Call-By-Call-Vorwahlen richtig zu erkennen (z.B. 0049 für Deutschland, 0043 für Österreich oder 001 für USA).<br><br>
- Standardwert ist 0049 (Deutschland)<br><br>
- <li><a name="FB_CALLMONITOR_check-deflection">check-deflections</a> 0,1</li>
- Wenn dieses Attribut aktiviert ist, werden eingehende Anrufe gegen die konfigurierten Rufsperren-Regeln aus der FritzBox geprüft. Wenn ein Anruf auf eine dieser Regeln passt, wird der Anruf ignoriert und es werden keinerlei Readings/Events für diesen Anruf generiert. Dies funktioniert nur, wenn man das Telefonbuch aus der FritzBox via TR-064 einliest (siehe Attribute <a href="#FB_CALLMONITOR_fritzbox-remote-phonebook">fritzbox-remote-phonebook</a> und <a href="#FB_CALLMONITOR_fritzbox-remote-phonebook-via">fritzbox-remote-phonebook-via</a>).<br><br>
- Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLMONITOR_fritzbox-remote-phonebook">fritzbox-remote-phonebook</a> 0,1</li>
- Wenn dieses Attribut aktiviert ist, wird das FritzBox Telefonbuch direkt von der FritzBox gelesen. Dazu ist das FritzBox Passwort und je nach FritzBox Konfiguration auch ein Username notwendig, der in den entsprechenden Attributen konfiguriert sein muss.<br><br>
- Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
- Standardwert ist 0 (deaktiviert)<br><br>
- <li><a name="FB_CALLMONITOR_fritzbox-remote-phonebook-via">fritzbox-remote-phonebook-via</a> tr064,web,telnet</li>
- Setzt die Methode mit der das Telefonbuch von der FritzBox abgefragt werden soll. Bei der Methode "web", werden alle verfügbaren Telefonbücher (lokales sowie alle konfigurierten Online-Telefonbücher) über die Web-Oberfläche eingelesen. Bei der Methode "telnet" wird eine Telnet-Verbindung zur FritzBox aufgebaut um das lokale Telefonbuch abzufragen (keine Online-Telefonbücher). Dazu muss die Telnet-Funktion aktiviert sein (Telefon Kurzwahl: #96*7*). Bei der Methode "tr064" werden alle verfügbaren Telefonbücher über die TR-064 SOAP Schnittstelle ausgelesen. <br><br>
- Mögliche Werte: tr064,web,telnet<br>
- Standardwert ist "tr064" (Abfrage aller verfügbaren Telefonbücher über die TR-064-Schnittstelle)<br><br>
- <li><a name="FB_CALLMONITOR_fritzbox-remote-phonebook-exclude">fritzbox-remote-phonebook-exclude</a> <Liste></li>
- Eine komma-separierte Liste von Telefonbuch-ID's oder Namen welche beim einlesen übersprungen werden sollen. Dieses Attribut greift nur beim einlesen der Telefonbücher via "web"- oder "tr064"-Methode (siehe Attribut <i>fritzbox-remote-phonebook-via</i>). Eine Liste aller möglichen Werte kann über das <a href="#FB_CALLMONITOR_get">Get-Kommando</a> <i>showPhonebookIds</i> angezeigt werden.<br><br>
- Standardmäßig ist diese Funktion deaktiviert (alle Telefonbücher werden eingelesen)<br><br>
- <li><a name="FB_CALLMONITOR_fritzbox-user">fritzbox-user</a> <Username></li>
- Der Username für das Telnet-Interface, sofern das Telefonbuch direkt von der FritzBox geladen werden soll (siehe Attribut: <a href="#FB_CALLMONITOR_fritzbox-remote-phonebook">fritzbox-remote-phonebook</a>). Dieses Attribut ist nur notwendig, wenn mehrere Benutzer auf der FritzBox konfiguriert sind.<br><br>
- <li><a name="FB_CALLMONITOR_apiKeySearchCh">apiKeySearchCh</a> <API-Key></li>
- Der private API-Key von <a href="https://tel.search.ch/api/getkey" target="_new">tel.search.ch</a> um eine Rückwärtssuche via search.ch durchzuführen (siehe Attribut <a href=#FB_CALLMONITOR_reverse-search">reverse-search</a>). Ohne einen solchen API-Key ist eine Rückwärtssuche via search.ch nicht möglich<br><br>
- </ul>
- <br>
-
- <a name="FB_CALLMONITOR_events"></a>
- <b>Generierte Events:</b><br><br>
- <ul>
- <li><b>event</b> (call|ring|connect|disconnect) - Welches Event wurde genau ausgelöst. ("call" => ausgehender Rufversuch, "ring" => eingehender Rufversuch, "connect" => Gespräch ist zustande gekommen, "disconnect" => es wurde aufgelegt)</li>
- <li><b>direction</b> (incoming|outgoing) - Die Anruf-Richtung ("incoming" => eingehender Anruf, "outgoing" => ausgehender Anruf)</li>
- <li><b>external_number</b> - Die Rufnummer des Gegenübers, welcher anruft (event: ring) oder angerufen wird (event: call)</li>
- <li><b>external_name</b> - Das Ergebniss der Rückwärtssuche (sofern aktiviert). Im Fehlerfall kann diese Reading auch den Inhalt "unknown" (keinen Eintrag gefunden) enthalten. Im Falle einer Zeitüberschreitung bei der Rückwärtssuche und aktiviertem Caching, wird die Rufnummer beim nächsten Mal erneut gesucht.</li>
- <li><b>internal_number</b> - Die interne Rufnummer (Festnetz, VoIP-Nummer, ...) auf welcher man angerufen wird (event: ring) oder die man gerade nutzt um jemanden anzurufen (event: call)</li>
- <li><b>internal_connection</b> - Der interne Anschluss an der Fritz!Box welcher genutzt wird um das Gespräch durchzuführen (FON1, FON2, ISDN, DECT, ...)</li>
- <li><b>external_connection</b> - Der externe Anschluss welcher genutzt wird um das Gespräch durchzuführen ("POTS" => analoges Festnetz, "SIPx" => VoIP Nummer, "ISDN", "GSM" => Mobilfunk via GSM/UMTS-Stick)</li>
- <li><b>call_duration</b> - Die Gesprächsdauer in Sekunden. Dieser Wert wird nur bei einem disconnect-Event erzeugt. Ist der Wert 0, so wurde das Gespräch von niemandem angenommen.</li>
- <li><b>call_id</b> - Die Identifizierungsnummer eines einzelnen Gesprächs. Dient der Zuordnung bei zwei oder mehr parallelen Gesprächen, damit alle Events eindeutig einem Gespräch zugeordnet werden können</li>
- <li><b>missed_call</b> - Dieses Event wird nur generiert, wenn ein eingehender Anruf nicht beantwortet wird. Sofern der Name dazu bekannt ist, wird dieser ebenfalls mit angezeigt.</li>
- </ul>
- </ul>
- <p><a name="FHEM2FHEM"></a>
- <h3>FHEM2FHEM</h3>
- <div class='langLinks'>[<a href='commandref.html#FHEM2FHEM'>EN</a> DE]</div>
- <ul>
- FHEM2FHEM ist ein Hilfsmodul, um mehrere FHEM-Installationen zu verbinden.
- <br><br>
- <a name="FHEM2FHEMdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FHEM2FHEM <host>[:<portnr>][:SSL] [LOG:regexp|RAW:devicename] {portpassword}
- </code>
- <br>
- <br>
- Zum <i>remote (entfernten)</i> FHEM auf Rechner <host> verbinden.
- <portnr> ist der telnetPort des remote FHEM, Standardport ist 7072.
- Der Zusatz :SSL wird benötigt, wenn das remote FHEM
- SSL-Verschlüsselung voraussetzt. Auch auf dem lokalen Host muss dann
- das Perl-Modul IO::Socket::SSL installiert sein.<br>
- Anmerkung: Wenn das remote FHEM auf einem eigenen Host läuft, muss
- "telnetPort" des remote FHEM als global festgelegt sein. <br>
- Der nächste Parameter spezifiziert den Verbindungs-Typ:
- <ul>
- <li>LOG<br>
- Bei Verwendung dieses Verbindungstyps werden alle Ereignisse (Events) der
- remote FHEM-Installation empfangen. Die Ereignisse sehen aus wie die, die
- nach <a href="#inform">inform on</a> Befehl erzeugt werden. Sie können
- wie lokale Ereignisse durch <a href="#FileLog">FileLog </a> oder <a
- href="#notify">notify</a> genutzt werden und mit einem regulären
- Ausdruck gefiltert werden. Die Syntax dafür ist unter der
- notify-Definition beschrieben.<br>
- Einschränkungen: die Geräte der remote Installation werden nicht
- lokal angelegt und können weder mit list angezeigt noch lokal
- angesprochen werden. Auf beiden FHEM-Installationen können
- Geräte gleichen Namens angelegt werden, aber wenn beide dasselbe
- Ereignis empfangen (z.B. wenn an beiden Installationen CULs angeschlossen
- sind), werden alle FileLogs und notifys doppelt ausgelöst.<br>
- Falls man lokal Geräte mit dem gleichen Namen (z.Bsp. als dummy)
- angelegt hat, dann werden die Readings von dem lokalen Gerät
- aktualisiert.
- </li>
- <li>RAW<br>
- Bei diesem Verbindungstyp werden unaufbereitete Ereignisse (raw messages)
- des remote FHEM-Geräts <i>devicename</i> genau so empfangen, als
- wäre das Gerät lokal verbunden.<br>
- Einschränkungen: nur Geräte, welche die "Dispatch-Funktion"
- unterstützen (CUL, FHZ, CM11, SISPM, RFXCOM, TCM, TRX, TUL) erzeugen
- raw messages, und für jedes entfernte Gerät muss ein eigenes
- FHEM2FHEM Objekt erzeugt werden.<br>
- <i>devicename</i> muss mit demselben Namen und Typ wie das Remote Devive
- angelegt sein, aber als Dummy, d.h. als device-node "none".
- Zusätzlich müssen alle notwendigen Attribute lokal gesetzt sein
- (z.B. <a href="#rfmode">rfmode</a>, wenn die remote CUL im HomeMatic-Modus
- läuft). Die Verwendung bereits bestehender lokaler Geräte ist zu
- vermeiden, weil sonst die Duplikatsfilterung nicht richtig funktioniert
- (siehe dupTimeout). </li>
- </ul>
- Der letzte Parameter enthält das Passwort des Remote-Servers, wenn dort
- eines aktiviert ist <a href="#portpassword">portpassword</a>.
- <br>
- Beispiele:
- <ul>
- <code>define ds1 FHEM2FHEM 192.168.178.22:7072 LOG:.*</code><br>
- <br>
- <code>define RpiCUL CUL none 0000</code><br>
- <code>define ds2 FHEM2FHEM 192.168.178.22:7072 RAW:RpiCUL</code><br> und auf dem RPi (192.168.178.22):<br>
- <code>rename CUL_0 RpiCUL</code><br>
- </ul>
- </ul>
- <br>
- <a name="FHEM2FHEMset"></a>
- <b>Set </b>
- <ul>
- <li>reopen<br>
- Öffnet die Verbindung erneut.</li>
- </ul>
- <a name="FHEM2FHEMget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="FHEM2FHEMattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#dummy">dummy</a></li>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <li><a name="#eventOnly">eventOnly</a><br>
- falls gesetzt, werden nur die Events generiert, und es wird kein
- Reading aktualisiert. Ist nur im LOG-Mode aktiv.
- </li>
- <li><a name="#addStateEvent">addStateEvent</a><br>
- falls gesetzt, werden state Events als solche uebertragen. Zu beachten:
- das Attribut ist nur für LOG-Mode relevant, beim Setzen wird eine
- zusätzliche reopened Logzeile generiert, und die andere Seite muss
- aktuell sein.
- </li>
- <li><a name="#excludeEvents">excludeEvents <regexp></a>
- die auf das <regexp> zutreffende Events werden nicht
- bereitgestellt.
- </li>
- </ul>
- </ul>
- <p><a name="FHEMWEB"></a>
- <h3>FHEMWEB</h3>
- <div class='langLinks'>[<a href='commandref.html#FHEMWEB'>EN</a> DE]</div>
- <ul>
- FHEMWEB ist das default WEB-Frontend, es implementiert auch einen einfachen
- Webserver (optional mit Basic-Auth und HTTPS).
- <br> <br>
- <a name="FHEMWEBdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FHEMWEB <tcp-portnr> [global|IP]</code>
- <br><br>
- Aktiviert das Webfrontend auf dem Port <tcp-portnr>. Mit dem
- Parameter global werden Anfragen von allen Netzwerkschnittstellen
- akzeptiert (nicht nur vom localhost / 127.0.0.1). Falls IP angegeben wurde,
- dann werden nur Anfragen an diese IP Adresse akzeptiert. <br>
- Informationen für den Betrieb mit IPv6 finden Sie <a
- href="#telnet">hier</a>.<br>
- </ul>
- <br>
- <a name="FHEMWEBset"></a>
- <b>Set</b>
- <ul>
- <li>rereadicons<br>
- Damit wird die Liste der Icons neu eingelesen, für den Fall, dass
- Sie Icons löschen oder hinzufügen.
- </li>
- <li>clearSvgCache<br>
- Im Verzeichnis www/SVGcache werden SVG Daten zwischengespeichert, wenn
- das Attribut SVGcache gesetzt ist. Mit diesem Befehl leeren Sie diesen
- Zwischenspeicher.
- </li>
- </ul>
- <br>
- <a name="FHEMWEBget"></a>
- <b>Get</b>
- <ul>
- <li>icon <logical icon><br>
- Liefert den absoluten Pfad des (logischen) Icons zurück. Beispiel:
- <ul>
- <code>get myFHEMWEB icon FS20.on<br>
- /data/Homeautomation/fhem/FHEM/FS20.on.png
- </code>
- </ul></li>
- <li>pathlist<br>
- Zeigt diejenigen Verzeichnisse an, in welchen die verschiedenen Dateien
- für FHEMWEB liegen.
- </li>
- <br><br>
- </ul>
- <a name="FHEMWEBattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="addHtmlTitle"></a>
- <li>addHtmlTitle<br>
- Falls der Wert 0 ist, wird bei den set/get/attr Parametern in der
- DetailAnsicht der Geräte kein title Attribut gesetzt. Das is bei
- manchen Screenreadern erforderlich. Die Voreinstellung ist 1.
- </li><br>
- <li><a href="#addStateEvent">addStateEvent</a></li><br>
- <li>alias_<RoomName><br>
- Falls man das Attribut alias_<RoomName> definiert, und dieses
- Attribut für ein Gerät setzt, dann wird dieser Wert bei
- Anzeige von <RoomName> verwendet.<br>
- Achtung: man kann im userattr auch alias_.* verwenden um alle
- möglichen Räume abzudecken, in diesem Fall wird aber die
- Attributauswahl in der Detailansicht für alias_.* nicht
- funktionieren.
- </li><br>
- <li><a href="#allowfrom">allowfrom</a>
- </li><br>
- <li>allowedCommands, basicAuth, basicAuthMsg<br>
- Diese Attribute müssen ab sofort bei dem passenden <a
- href="#allowed">allowed</a> Gerät angelegt werden, und sind
- für eine FHEMWEB Instanz unerwünscht.
- </li><br>
- <li>allowedHttpMethods</br>
- FHEMWEB implementiert die HTTP Methoden GET, POST und OPTIONS. Manche
- externe Geräte benötigen HEAD, das ist aber in FHEMWEB nicht
- korrekt implementiert, da FHEMWEB immer ein body zurückliefert, was
- laut Spec falsch ist. Da ein body in manchen Fällen kein Problem
- ist, kann man HEAD durch setzen dieses Attributes auf GET|POST|HEAD
- aktivieren, die Voreinstellung ist GET|POST. OPTIONS ist immer
- aktiviert.
- </li><br>
- <a name="closeConn"></a>
- <li>closeConn<br>
- Falls gesetzt, wird pro TCP Verbindung nur ein HTTP Request
- durchgeführt. Für iOS9 WebApp startups scheint es zu helfen.
- </li><br>
- <a name="cmdIcon"></a>
- <li>cmdIcon<br>
- Leerzeichen getrennte Auflistung von cmd:iconName Paaren.
- Falls gesetzt, wird das webCmd text durch den icon gesetzt.
- Am einfachsten setzt man cmdIcon indem man "Extend devStateIcon" im
- Detail-Ansicht verwendet, und den Wert nach cmdIcon kopiert.<br>
- Beispiel:<ul>
- attr lamp cmdIcon on:control_centr_arrow_up off:control_centr_arrow_down
- </ul>
- </li><br>
- <a name="column"></a>
- <li>column<br>
- Damit werden mehrere Spalten für einen Raum angezeigt, indem
- sie verschiedene Gruppen Spalten zuordnen. Beispiel:<br>
- <ul><code>
- attr WEB column LivingRoom:FS20,notify|FHZ,notify DiningRoom:FS20|FHZ
- </code></ul>
-
- In diesem Beispiel werden im Raum LivingRoom die FS20 sowie die notify
- Gruppe in der ersten Spalte, die FHZ und das notify in der zweiten
- Spalte angezeigt.<br>
-
- Anmerkungen: einige Elemente, wie SVG Plots und readingsGroup
- können nur dann Teil einer Spalte sein wenn sie in <a
- href="#group">group</a> stehen. Dieses Attribut kann man zum sortieren
- der Gruppen auch dann verwenden, wenn man nur eine Spalte hat.
- Leerzeichen im Raum- und Gruppennamen sind für dieses Attribut als
- %20 zu schreiben. Raum- und Gruppenspezifikation ist jeweils ein
- %regulärer Ausdruck.
- </li><br>
- <a name="confirmDelete"></a>
- <li>confirmDelete<br>
- Löschaktionen weden mit einem Dialog bestätigt.
- Falls dieses Attribut auf 0 gesetzt ist, entfällt das.
- </li>
- <br>
- <a name="confirmJSError"></a>
- <li>confirmJSError<br>
- JavaScript Fehler werden per Voreinstellung in einem Dialog gemeldet.
- Durch setzen dieses Attributes auf 0 werden solche Fehler nicht
- gemeldet.
- </li>
- <br>
- <a name="CORS"></a>
- <li>CORS<br>
- Wenn auf 1 gestellt, wird FHEMWEB einen "Cross origin resource sharing"
- Header bereitstellen, näheres siehe Wikipedia.
- </li><br>
- <a name="csrfToken"></a>
- <li>csrfToken<br>
- Falls gesetzt, wird der Wert des Attributes als fwcsrf Parameter bei
- jedem über FHEMWEB abgesetzten Kommando verlangt, es dient zum
- Schutz von Cross Site Resource Forgery Angriffen.
- Falls der Wert random ist, dann wird ein Zufallswert beim jeden FHEMWEB
- Start neu generiert, falls er none ist, dann wird kein Parameter
- verlangt. Default ist random für featurelevel 5.8 und
- größer, und none für featurelevel kleiner 5.8
- </li><br>
- <a name="csrfTokenHTTPHeader"></a>
- <li>csrfTokenHTTPHeader<br>
- Falls gesetzt (Voreinstellung), FHEMWEB sendet im HTTP Header den
- csrfToken als X-FHEM-csrfToken, das wird von manchen FHEM-Clients
- benutzt. Mit 0 kann man das abstellen, um Sites wie shodan.io die
- Erkennung von FHEM zu erschweren.</li><br>
- <a name="CssFiles"></a>
- <li>CssFiles<br>
- Leerzeichen getrennte Liste von .css Dateien, die geladen werden.
- Die Dateinamen sind relativ zum www Verzeichnis anzugeben. Beispiel:
- <ul><code>
- attr WEB CssFiles pgm2/mystyle.css
- </code></ul>
- </li><br>
- <a name="Css"></a>
- <li>Css<br>
- CSS, was nach dem CssFiles Abschnitt im Header eingefuegt wird.
- </li><br>
- <a name="defaultRoom"></a>
- <li>defaultRoom<br>
- Zeigt den angegebenen Raum an falls kein Raum explizit ausgewählt
- wurde. Achtung: falls gesetzt, wird motd nicht mehr angezeigt.
- Beispiel:<br>
- attr WEB defaultRoom Zentrale
- </li><br>
- <a name="devStateIcon"></a>
- <li>devStateIcon<br>
- Erste Variante:<br>
- <ul>
- Leerzeichen getrennte Auflistung von regexp:icon-name:cmd
- Dreierpärchen, icon-name und cmd dürfen leer sein.<br>
- Wenn der Zustand des Gerätes mit der regexp übereinstimmt,
- wird als icon-name das entsprechende Status Icon angezeigt, und (falls
- definiert), löst ein Klick auf das Icon das entsprechende cmd aus.
- Wenn fhem icon-name nicht finden kann, wird der Status als Text
- angezeigt.
- Beispiel:<br>
- <ul>
- attr lamp devStateIcon on:closed off:open<br>
- attr lamp devStateIcon on::A0 off::AI<br>
- attr lamp devStateIcon .*:noIcon<br>
- </ul>
- Anmerkung: Wenn das Icon ein SVG Bild ist, kann das @colorname Suffix
- verwendet werden um das Icon einzufärben. Z.B.:<br>
- <ul>
- attr Fax devStateIcon on:control_building_empty@red
- off:control_building_filled:278727
- </ul>
- Falls cmd noFhemwebLink ist, dann wird kein HTML-Link generiert, d.h.
- es passiert nichts, wenn man auf das Icon/Text klickt.
- </ul>
- Zweite Variante:<br>
- <ul>
- Perl regexp eingeschlossen in {}. Wenn der Code undef
- zurückliefert, wird das Standard Icon verwendet; wird ein String
- in <> zurück geliefert, wird dieser als HTML String interpretiert.
- Andernfalls wird der String als devStateIcon gemäß der
- ersten Variante interpretiert, siehe oben. Beispiel:<br>
- {'<div style="width:32px;height:32px;background-color:green"></div>'}
- </ul>
- </li><br>
- <a name="devStateStyle"></a>
- <li>devStateStyle<br>
- Für ein best. Gerät einen best. HTML-Style benutzen.
- Beispiel:<br>
- <ul>
- attr sensor devStateStyle style="text-align:left;;font-weight:bold;;"<br>
- </ul>
- </li><br>
- <li>deviceOverview<br>
- Gibt an ob die Darstellung aus der Raum-Ansicht (Zeile mit
- Gerüteicon, Stateicon und webCmds/cmdIcons) auch in der
- Detail-Ansicht angezeigt werden soll. Kann auf always, onClick,
- iconOnly oder never gesetzt werden. Der Default ist always.
- </li><br>
- <a name="editConfig"></a>
- <li>editConfig<br>
- Falls dieses FHEMWEB Attribut (auf 1) gesetzt ist, dann kann man die
- FHEM Konfigurationsdatei in dem "Edit files" Abschnitt bearbeiten. Beim
- Speichern dieser Datei wird automatisch rereadcfg ausgefuehrt, was
- diverse Nebeneffekte hat.<br>
- </li><br>
- <a name="editFileList"></a>
- <li>editFileList<br>
- Definiert die Liste der angezeigten Dateien in der "Edit Files" Abschnitt.
- Es ist eine Newline getrennte Liste von Tripeln bestehend aus Titel,
- Verzeichnis für die Suche, und Regexp. Die Voreinstellung ist:
- <ul>
- <code>
- Own modules and helper files:$MW_dir:^(.*sh|[0-9][0-9].*Util.*pm|.*cfg|.*holiday|myUtilsTemplate.pm|.*layout)$<br>
- Gplot files:$FW_gplotdir:^.*gplot$<br>
- Styles:$FW_cssdir:^.*(css|svg)$<br>
- </code>
- </ul>
- Achtung: die Verzeichnis Angabe ist nicht flexibel: alle
- .js/.css/_defs.svg Dateien sind in www/pgm2 ($FW_cssdir), .gplot
- Dateien in $FW_gplotdir (www/gplot), alles andere in $MW_dir (FHEM).
- </li><br>
- <a name="endPlotNow"></a>
- <li>endPlotNow<br>
- Wenn Sie dieses FHEMWEB Attribut auf 1 setzen, werden Tages und
- Stunden-Plots zur aktuellen Zeit beendet. (Ähnlich wie
- endPlotToday, nur eben minütlich).
- Ansonsten wird der gesamte Tag oder eine 6 Stunden Periode (0, 6, 12,
- 18 Stunde) gezeigt. Dieses Attribut wird nicht verwendet, wenn das SVG
- Attribut startDate benutzt wird.<br>
- </li><br>
- <a name="endPlotToday"></a>
- <li>endPlotToday<br>
- Wird dieses FHEMWEB Attribut gesetzt, so enden Wochen- bzw. Monatsplots
- am aktuellen Tag, sonst wird die aktuelle Woche/Monat angezeigt.
- </li><br>
- <a name="fwcompress"></a>
- <li>fwcompress<br>
- Aktiviert die HTML Datenkompression (Standard ist 1, also ja, 0 stellt
- die Kompression aus).
- </li><br>
- <a name="hiddengroup"></a>
- <li>hiddengroup<br>
- Wie hiddenroom (siehe unten), jedoch auf Gerätegruppen bezogen.
- <br>
- Beispiel: attr WEBtablet hiddengroup FileLog,dummy,at,notify
- </li><br>
- <a name="hiddengroupRegexp"></a>
- <li>hiddengroupRegexp<br>
- Ein regulärer Ausdruck, um Gruppen zu verstecken.
- </li>
- <br>
- <a name="hiddenroom"></a>
- <li>hiddenroom<br>
- Eine Komma getrennte Liste, um Räume zu verstecken, d.h. nicht
- anzuzeigen. Besondere Werte sind input, detail und save. In diesem
- Fall werden diverse Eingabefelder ausgeblendent. Durch direktes Aufrufen
- der URL sind diese Räume weiterhin erreichbar!<br>
- Ebenso können Einträge in den Logfile/Commandref/etc Block
- versteckt werden. </li><br>
- <a name="hiddenroomRegexp"></a>
- <li>hiddenroomRegexp<br>
- Ein regulärer Ausdruck, um Räume zu verstecken. Beispiel:
- <ul>
- attr WEB hiddenroomRegexp .*config
- </ul>
- Achtung: die besonderen Werte input, detail und save müssen mit
- hiddenroom spezifiziert werden.
- </li>
- <br>
- <a name="HTTPS"></a>
- <li>HTTPS<br>
- Ermöglicht HTTPS Verbindungen. Es werden die Perl Module
- IO::Socket::SSL benötigt, installierbar mit cpan -i
- IO::Socket::SSL oder apt-get install libio-socket-ssl-perl; (OSX und
- die FritzBox-7390 haben dieses Modul schon installiert.)<br>
- Ein lokales Zertifikat muss im Verzeichis certs erzeugt werden.
- Dieses Verzeichnis <b>muss</b> im <a href="#modpath">modpath</a>
- angegeben werden, also auf der gleichen Ebene wie das FHEM Verzeichnis.
- Beispiel:
- <ul>
- mkdir certs<br>
- cd certs<br>
- openssl req -new -x509 -nodes -out server-cert.pem -days 3650 -keyout
- server-key.pem
- </ul>
- <br>
- </li>
- <a name="icon"></a>
- <li>icon<br>
- Damit definiert man ein Icon für die einzelnen Geräte in der
- Raumübersicht. Es gibt einen passenden Link in der Detailansicht
- um das zu vereinfachen. Um ein Bild für die Räume selbst zu
- definieren muss ein Icon mit dem Namen ico<Raumname>.png im
- iconPath existieren (oder man verwendet roomIcons, s.u.)
- </li><br>
- <a name="iconPath"></a>
- <li>iconPath<br>
- Durch Doppelpunkt getrennte Aufzählung der Verzeichnisse, in
- welchen nach Icons gesucht wird. Die Verzeichnisse müssen unter
- fhem/www/images angelegt sein. Standardeinstellung ist:
- $styleSheetPrefix:default:fhemSVG:openautomation<br>
- Setzen Sie den Wert auf fhemSVG:openautomation um nur SVG Bilder zu
- benutzen.
- </li><br>
- <a name="JavaScripts"></a>
- <li>JavaScripts<br>
- Leerzeichen getrennte Liste von JavaScript Dateien, die geladen werden.
- Die Dateinamen sind relativ zum www Verzeichnis anzugeben. Für
- jede Datei wird ein zusätzliches Attribut angelegt, damit der
- Benutzer dem Skript Parameter weiterreichen kann. Bei diesem
- Attributnamen werden Verzeichnisname und fhem_ Präfix entfernt
- und Param als Suffix hinzugefügt. Beispiel:
- <ul><code>
- attr WEB JavaScripts codemirror/fhem_codemirror.js<br>
- attr WEB codemirrorParam { "theme":"blackboard", "lineNumbers":true }
- </code></ul>
- </li><br>
- <a name="longpoll"></a>
- <li>longpoll [0|1|websocket]<br>
- Falls gesetzt, FHEMWEB benachrichtigt den Browser, wenn
- Gerätestatuus, Readings or Attribute sich ändern, ein
- Neuladen der Seite ist nicht notwendig. Zum deaktivieren 0 verwenden.
- <br>
- Falls websocket spezifiziert ist, läuft die Benachrichtigung des
- Browsers über dieses Verfahren sonst über HTTP longpoll.
- Achtung: ältere Browser haben keine websocket Implementierung.
- </li><br>
- <a name="longpollSVG"></a>
- <li>longpollSVG<br>
- Lädt SVG Instanzen erneut, falls ein Ereignis dessen Inhalt
- ändert. Funktioniert nur, falls die dazugehörige Definition
- der Quelle in der .gplot Datei folgenden Form hat: deviceName.Event
- bzw. deviceName.*. Wenn man den <a href="#plotEditor">Plot Editor</a>
- benutzt, ist das übrigens immer der Fall. Die SVG Datei wird bei
- <b>jedem</b> auslösenden Event dieses Gerätes neu geladen.
- Die Voreinstellung ist aus.
- </li><br>
- <a name="mainInputLength"></a>
- <li>mainInputLength<br>
- Länge des maininput Eingabefeldes (Anzahl der Buchstaben,
- Ganzzahl).
- </li> <br>
- <a name="menuEntries"></a>
- <li>menuEntries<br>
- Komma getrennte Liste; diese Links werden im linken Menü angezeigt.
- Beispiel:<br>
- attr WEB menuEntries fhem.de,http://fhem.de,culfw.de,http://culfw.de<br>
- attr WEB menuEntries
- AlarmOn,http://fhemhost:8083/fhem?cmd=set%20alarm%20on<br>
- </li><br>
- <a name="nameDisplay"></a>
- <li>nameDisplay<br>
- Das Argument ist Perl-Code, was für jedes Gerät in der
- Raum-Übersicht ausgeführt wird, um den angezeigten Namen zu
- berechnen. Dabei kann man die Variable $DEVICE für den aktuellen
- Gerätenamen, und $ALIAS für den aktuellen alias bzw. Name,
- falls alias nicht gesetzt ist, verwenden. Z.Bsp. für eine FHEMWEB
- Instanz mit ungarischer Anzeige fügt man ein global userattr
- alias_hu hinzu, und man setzt nameDisplay für diese FHEMWEB
- Instanz auf dem Wert:
- <ul>
- AttrVal($DEVICE, "alias_hu", $ALIAS)
- </ul>
- </li>
- <br>
- <a name="nrAxis"></a>
- <li>nrAxis<br>
- (bei mehrfach-Y-Achsen im SVG-Plot) Die Darstellung der Y Achsen
- benötigt Platz. Hierdurch geben Sie an wie viele Achsen Sie
- links,rechts [useLeft,useRight] benötigen. Default ist 1,1 (also 1
- Achse links, 1 Achse rechts).
- </li><br>
- <a name="ploteditor"></a>
- <li>ploteditor<br>
- Gibt an ob der <a href="#plotEditor">Plot Editor</a> in der SVG detail
- ansicht angezeigt werden soll. Kann auf always, onClick oder never
- gesetzt werden. Der Default ist always.
- </li><br>
- <a name="plotEmbed"></a>
- <li>plotEmbed 0<br>
- SVG Grafiken werden als Teil der <embed> Tags dargestellt, da
- früher das der einzige Weg war SVG darzustellen, weiterhin
- erlaubt es das parallele Berechnen via plotfork (s.o.)
- Falls plotEmbed auf 0 gesetzt wird, dann werden die SVG Grafiken als
- Teil der HTML-Seite generiert, was leider das plotfork Attribut
- wirkungslos macht.
- </li><br>
- <a name="plotfork"></a>
- <li>plotfork<br>
- Normalerweise wird die Ploterstellung im Hauptprozess ausgeführt,
- FHEM wird wärend dieser Zeit nicht auf andere Ereignisse
- reagieren.
- Falls dieses Attribut auf einen nicht 0 Wert gesetzt ist, dann wird die
- Berechnung in weitere Prozesse ausgelagert. Das kann die Berechnung auf
- Rechnern mit mehreren Prozessoren beschleunigen, allerdings kann es auf
- Rechnern mit wenig Speicher (z.Bsp. FRITZ!Box 7390) zum automatischen
- Abschuss des FHEM Prozesses durch das OS führen.
- </li><br>
- <a name="plotmode"></a>
- <li>plotmode<br>
- Spezifiziert, wie Plots erzeugt werden sollen:
- <ul>
- <li>SVG<br>
- Die Plots werden mit Hilfe des <a href="#SVG">SVG</a> Moduls als SVG
- Grafik gerendert. Das ist die Standardeinstellung.</li>
- <li>gnuplot-scroll<br>
- Die plots werden mit dem Programm gnuplot erstellt. Das output
- terminal ist PNG. Der einfache Zugriff auf historische Daten
- ist möglich (analog SVG).
- </li>
- <li>gnuplot-scroll-svg<br>
- Wie gnuplot-scroll, aber als output terminal wird SVG angenommen.
- </li>
- </ul>
- </li><br>
- <a name="plotsize"></a>
- <li>plotsize<br>
- gibt die Standardbildgröße aller erzeugten Plots an als
- Breite,Höhe an. Um einem individuellen Plot die Größe zu
- ändern muss dieses Attribut bei der entsprechenden SVG Instanz
- gesetzt werden. Default sind 800,160 für Desktop und 480,160
- für Smallscreen
- </li><br>
- <a name="plotWeekStartDay"></a>
- <li>plotWeekStartDay<br>
- Starte das Plot in der Wochen-Ansicht mit diesem Tag.
- 0 ist Sonntag, 1 ist Montag, usw.
- </li><br>
- <a name="redirectCmds"></a>
- <li>redirectCmds<br>
- Damit wird das URL Eingabefeld des Browser nach einem Befehl geleert.
- Standard ist eingeschaltet (1), ausschalten kann man es durch
- setzen des Attributs auf 0, z.Bsp. um den Syntax der Kommunikation mit
- FHEMWEB zu untersuchen.
- </li><br>
- <a name="refresh"></a>
- <li>refresh<br>
- Damit erzeugen Sie auf den ausgegebenen Webseiten einen automatischen
- Refresh, z.B. nach 5 Sekunden.
- </li><br>
- <a name="reverseLogs"></a>
- <li>reverseLogs<br>
- Damit wird das Logfile umsortiert, die neuesten Einträge stehen
- oben. Der Vorteil ist, dass man nicht runterscrollen muss um den
- neuesten Eintrag zu sehen, der Nachteil dass FHEM damit deutlich mehr
- Hauptspeicher benötigt, etwa 6 mal so viel, wie das Logfile auf
- dem Datenträger groß ist. Das kann auf Systemen mit wenig
- Speicher (FRITZ!Box) zum Terminieren des FHEM Prozesses durch das
- Betriebssystem führen.
- </li><br>
- <a name="roomIcons"></a>
- <li>roomIcons<br>
- Leerzeichen getrennte Liste von room:icon Zuordnungen
- Der erste Teil wird als regexp interpretiert, daher muss ein
- Leerzeichen als Punkt geschrieben werden. Beispiel:<br>
- attr WEB roomIcons Anlagen.EDV:icoEverything
- </li><br>
- <a name="sortby"></a>
- <li>sortby<br>
- Der Wert dieses Attributs wird zum sortieren von Geräten in
- Räumen verwendet, sonst wäre es der Alias oder, wenn keiner
- da ist, der Gerätename selbst. Falls der Wert des sortby
- Attributes in {} eingeschlossen ist, dann wird er als ein perl Ausdruck
- evaluiert. $NAME wird auf dem Gerätenamen gesetzt.
- </li><br>
- <a name="showUsedFiles"></a>
- <li>showUsedFiles<br>
- Zeige nur die verwendeten Dateien in der "Edit files" Abschnitt.
- Achtung: aktuell ist das nur für den "Gplot files" Abschnitt
- implementiert.
- </li>
- <br>
- <a name="sortRooms"></a>
- <li>sortRooms<br>
- Durch Leerzeichen getrennte Liste von Räumen, um deren Reihenfolge
- zu definieren.
- Da die Räume in diesem Attribut als Regexp interpretiert werden,
- sind Leerzeichen im Raumnamen als Punkt (.) zu hinterlegen.
- Beispiel:<br>
- attr WEB sortRooms DG OG EG Keller
- </li><br>
- <a name="smallscreenCommands"></a>
- <li>smallscreenCommands<br>
- Falls auf 1 gesetzt werden Kommandos, Slider und Dropdown Menüs im
- Smallscreen Landscape Modus angezeigt.
- </li><br>
- <li>sslVersion<br>
- Siehe das global Attribut sslVersion.
- </li><br>
- <a name="styleData"></a>
- <li>styleData<br>
- wird von dynamischen styles wie f18 werwendet
- </li><br>
- <a name="stylesheetPrefix"></a>
- <li>stylesheetPrefix<br>
- Präfix für die Dateien style.css, svg_style.css und
- svg_defs.svg. Wenn die Datei mit dem Präfix fehlt, wird die Default
- Datei (ohne Präfix) verwendet. Diese Dateien müssen im FHEM
- Ordner liegen und können direkt mit "Select style" im FHEMWEB
- Menüeintrag ausgewählt werden. Beispiel:
- <ul>
- attr WEB stylesheetPrefix dark<br>
- <br>
- Referenzdateien:<br>
- <ul>
- darksvg_defs.svg<br>
- darksvg_style.css<br>
- darkstyle.css<br>
- </ul>
- <br>
- </ul>
- <b>Anmerkung:</b>Wenn der Parametername smallscreen oder touchpad
- enthält, wird FHEMWEB das Layout/den Zugriff für entsprechende
- Geräte (Smartphones oder Touchpads) optimieren<br>
- Standardmäßig werden 3 FHEMWEB Instanzen aktiviert: Port 8083
- für Desktop Browser, Port 8084 für Smallscreen, und 8085
- für Touchpad.<br>
- Wenn touchpad oder smallscreen benutzt werden, wird WebApp support
- aktiviert: Nachdem Sie eine Seite am iPhone oder iPad mit Safari
- angesehen haben, können Sie einen Link auf den Homescreen anlegen um
- die Seite im Fullscreen Modus zu sehen. Links werden in diesem Modus
- anders gerendert, um ein "Zurückfallen" in den "normalen" Browser zu
- verhindern.
- </li><br>
- <a name="SVGcache"></a>
- <li>SVGcache<br>
- Plots die sich nicht mehr ändern, werden im SVGCache Verzeichnis
- (www/SVGcache) gespeichert, um die erneute, rechenintensive
- Berechnung der Grafiken zu vermeiden. Default ist 0, d.h. aus.<br>
- Siehe den clearSvgCache Befehl um diese Daten zu löschen.
- </li><br>
- <a name="title"></a>
- <li>title<br>
- Setzt den Titel der Seite. Falls in {} eingeschlossen, dann wird es
- als Perl Ausdruck evaluiert.
- </li><br>
- <a name="viewport"></a>
- <li>viewport<br>
- Setzt das "viewport" Attribut im HTML Header. Das kann benutzt
- werden um z.B. die Breite fest vorzugeben oder Zoomen zu verhindern.<br>
- Beispiel: attr WEB viewport
- width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no
- </li><br>
- <a name="webCmd"></a>
- <li>webCmd<br>
- Durch Doppelpunkte getrennte Auflistung von Befehlen, die für ein
- bestimmtes Gerät gelten sollen. Funktioniert nicht mit
- smallscreen, ein Ersatz dafür ist der devStateIcon Befehl.<br>
- Beispiel:
- <ul>
- attr lamp webCmd on:off:on-for-timer 10<br>
- </ul>
- <br>
- Der erste angegebene Befehl wird in der "set device ?" list
- nachgeschlagen (Siehe das <a href="#setList">setList</a> Attrib
- für Dummy Geräte). Wenn <b>dort</b> bekannte Modifier sind,
- wird ein anderes Widget angezeigt. Siehe auch widgetOverride.<br>
- Wenn der Befehl state ist, wird der Wert als Kommando interpretiert.<br>
- Beispiele:
- <ul>
- define d1 dummy<br>
- attr d1 webCmd state<br>
- attr d1 setList state:on,off<br>
- define d2 dummy<br>
- attr d2 webCmd state<br>
- attr d2 setList state:slider,0,1,10<br>
- define d3 dummy<br>
- attr d3 webCmd state<br>
- attr d3 setList state:time<br>
- </ul>
- Anmerkung: dies ist ein Attribut für das anzuzeigende Gerät,
- nicht für die FHEMWEBInstanz.
- </li><br>
- <a name="webCmdLabel"></a>
- <li>webCmdLabel<br>
- Durch Doppelpunkte getrennte Auflistung von Texten, die vor dem
- jeweiligen webCmd angezeigt werden. Der Anzahl der Texte muss exakt den
- Anzahl der webCmds entsprechen. Um mehrzeilige Anzeige zu realisieren,
- kann ein Return nach dem Text und vor dem Doppelpunkt eingefuehrt
- werden.</li><br>
- <a name="webname"></a>
- <li>webname<br>
- Der Pfad nach http://hostname:port/ . Standard ist fhem,
- so ist die Standard HTTP Adresse http://localhost:8083/fhem
- </li><br>
- <a name="widgetOverride"></a>
- <li>widgetOverride<br>
- Leerzeichen separierte Liste von Name/Modifier Paaren, mit dem man den
- vom Modulautor für einen bestimmten Parameter (Set/Get/Attribut)
- vorgesehene Widgets ändern kann. Folgendes ist die Liste der
- bekannten Modifier:
- <ul>
- <!-- INSERT_DOC_FROM: www/pgm2/fhemweb.*.js -->
- <li>knob,min:1,max:100,... - zeigt das jQuery knob Widget.Die Parameter
- werden als eine Komma separierte Liste von Key:Value Paaren spezifiziert,
- wobei das data- Präfix entfällt.Für Details siehe die
- jQuery knob Dokumentation.<br> Beispiel:
- attr dimmer widgetOverride dim:knob,min:1,max:100,step:1,linecap:round
- </li>
- <p><p> <li>uzsuToggle,zust1,zust2 - damit ist es möglich mit einem
- Toggle-Button zwischen zwei Zuständen zu wählen. Der Erste ist
- der aktive Zustand.</li>
- <li>uzsuSelect,val1,val2,... - damit ist es mögliche in einer
- Buttonleiste meherere Werte auszuwählen. Das Ergebnis ist
- Komma-separiert.</li>
- <li>uzsuSelectRadio,val1,val2,... - damit ist es mögliche in einer
- Buttonleiste einen aus meherere Werten auszuwählen.</li>
- <li>uzsuDropDown,val1,val2,... - damit ist es mögliche mit einem
- DropDown Menü einen der Werte auszuwählen.</li>
- <li>uzsuTimerEntry[,modifier2] - damit werden je ein uzsuSelect,
- uzsuDropDown und uzsuToggle Widget kombiniert um einen Schaltzeitpunkt
- auszuwählen. Über den optionalen modifier2 kann ein Widget zur
- Auswahl des Schaltwertes angegeben werden. Siehe Beispiele unten. Das
- Ergebniss is eine komma-separiert Liste von Wochentagen gefolgt vom
- Zeitpunkt, eine Aktiv-Indikator und dem Schaltwert, jeweils durch |
- abetrennt. Zum Beispiel: Mo,Di,Sa,So|00:00|enabled|19.5</li>
- <li>uzsu[,modifier2] - damit werden mehrere uzsuTimerEntry Widets kombiniert
- um eine beliebige Anzahl an Schaltzeiten einzugeben. Über den
- optionalen modifier2 kann ein Widget zur Auswahl des Schaltwertes
- angegeben werden. Siehe Beispiele unten. Das Ergebiss ist eine durch
- leerzeichen getrennte Liste von uzsuTimerEntry Ergebnissen.<br>
- Beispiele:
- <ul>
- attr myToggle widgetOverride state:uzsuToggle,123,xyz<br>
- attr mySelect widgetOverride state:uzsuSelect,abc,123,456,xyz<br>
- attr myTemp widgetOverride
- state:uzsuDropDown,18,18.5,19,19.5,20,20.5,21,21.5,22,22.5,23<br>
- attr myTimerEntry widgetOverride state:uzsuTimerEntry<br>
- attr myTimer widgetOverride state:uzsu<br>
- <br>
- Im Folgenden wird die Verwendung des modifier2 parameters von
- uzsuTimerEntry und uzsu gezeigt um die Auswahl des Schaltzeitpunktes
- mit der Auswahl des Schaltwertes zu kombinieren:
- <pre>
- ... widgetOverride state:uzsu,slider,0,5,100 -> ein slider
- ... widgetOverride state:uzsu,uzsuToggle,off,on -> ein on/off button
- ... widgetOverride state:uzsu,uzsuDropDown,18,19,20,21,22,23 -> ein dropDownMenue
- ... widgetOverride state:uzsu,knob,min:18,max:24,step:0.5,linecap:round,fgColor:red -> ein knob widget
- ... widgetOverride state:uzsu,colorpicker -> ein colorpicker
- ... widgetOverride state:uzsu,colorpicker,CT,2700,50,5000 -> ein colortemperature slider
- </pre>
- </ul></li>
- <p><br>
- <u>Für die folgenden icon.* Widgets gilt:</u><br>
- <color> kann ein Farbname oder eine Farbnummer ohne führende <b>#</b> sein, z.B. orange oder FFA500. Abhängig vom Kontext ist <b>@</b> zu escapen <b>\@</b>.<br>
- <icon> ist der Iconname.<br>
- [class<classname>@] als Prefix vor dem zweiten Parameter, weist den SVG-Icons eine CSS-Klasse zu.<br>
- Beispiele zum Import über Raw definition findet man im FHEM-Wiki unter <a href="https://wiki.fhem.de/wiki/FHEMWEB/Widgets">FHEMWEB-Widgets</a>
- <li>iconRadio,[class<classname>@][use4icon@]<select color>,<value>,<icon>[@<color>][,<value>,<icon>[@<color>]]...
- - zeigt Icons als Radiobutton an und gibt Value bei Betätigung zurück.<br>
- <value> ist der Rückgabe- u.Vergleichswert. Wenn eine numerische Folge von <value> angegeben wird, dann passt der laufende Wert zum nächsten höheren Vergleichswert. Vor und hinter der numerischen Folge dürfen nicht numerische Werte angegeben werden, dazwischen nicht. Die numerische Folge muss auf- oder absteigend sein.<br>
- <u>Beispiel:</u> <code>iconRadio,808080,<b>zu</b>,control_arrow_down,<b>10</b>,fts_shutter_10,<b>20</b>,fts_shutter_20,<b>30</b>,fts_shutter_30,<b>auf</b>,control_arrow_up</code><br>
- <select color> die Hintergrundfarbe des gewählten Icons oder die Farbe des Icons wenn der Prefix use4icon@ vorangestellt wird.<br>
- Das Widget enthält eine CSS-Klasse "iconRadio_widget".<br>
- </li>
- <li>iconButtons,[class<classname>@][use4icon@]<select color>,<value>,<icon>[@<color>][,<value>,<icon>[@<color>]]...
- - zeigt Icons als Tastenleiste an und gibt durch Komma getrennte Werte der betätigten Tasten zurück.<br>
- <value> ist der Rückgabewert.<br>
- <select color> die Hintergrundfarbe des gewählten Icons oder die Farbe des Icons wenn der Prefix use4icon@ vorangestellt wird.<br>
- Das Widget enthält eine CSS-Klasse "iconButton_widget".<br>
- </li>
- <li>iconLabel[,[class<classname>@]<reference value>,[<icon>][@<color>]][,<reference value>,[<icon>][@<color>]]...
- - zeigt Zustände durch colorierte Werte, Beschriftungen und Icons an, wenn
- der aktuelle Wert zum Vergleichswert passt. Ein Zustand wird durch
- ein Parameterpaar beschrieben. Es können beliebig viele Paare angegeben
- werden. Ein Paar besteht aus einem Vergleichswert <reference
- value> und einem optionalen Anzeigewert mit optionaler mit
- Farbangabe [,<reference value>,[<icon>][@<color>]].<br>
- <reference value> kann eine Zahl oder ein regulärer Ausdruck sein.<br>
- Wenn <icon> keinem Iconnamen entspricht, wird der Text angezeigt,
- sonst das Icon. Wird <icon> nicht angegeben, wird der aktuelle
- Wert angezeigt.<br>
- </li>
- <li>iconSwitch,[class<classname>@]<reference value>,[<icon>][@<color>][,<reference value>,[<icon>][@<color>]]...
- - schaltet zyklisch nach jeder Betätigung in den angezeigten
- Zustand, dabei wird der aktuelle Wert auf den Vergleichswert
- gesetzt. Ein Zustand wird durch ein Parameterpaar beschrieben.
- Es können beliebig viele Paare angegeben werden. Ein Paar
- besteht aus einem Vergleichswert <reference value> und einem
- optionalen Anzeigewert mit optionaler mit Farbangabe [,<reference
- value>,[<icon>][@<color>]].<br>
- <reference value> kann eine Zahl oder eine Zeichenkette sein.<br>
- Wenn <icon> keinem Iconnamen entspricht, wird der Text
- angezeigt, sonst das Icon. Wird <icon> nicht angegeben,
- wird der Vergleichwert angezeigt.<br>
- </li>
- <br>
- <p><p><p> <li>:sortable,val1,val2,... - damit ist es möglich aus den gegebenen
- Werten eine Liste der gewünschten Werte durch Drag & Drop
- zusammenzustellen. Die Reihenfolge der Werte kann dabei entsprechend
- geändert werden. Es müssen keine Werte explizit vorgegeben
- werden, das Widget kann auch ohne vorgegebenen Werte benutzt werden. Es
- können eigene Werte zur Liste hinzugefügt und einsortiert
- werden. Das Ergebnis ist Komma-separiert entsprechend aufsteigend
- sortiert.</li>
- <li>:sortable-strict,val1,val2,... - damit ist es möglich aus den
- gegebenen Werten eine Liste der gewünschten Werte durch Drag &
- Drop zusammenzustellen. Die Reihenfolge der Werte kann dabei entsprechend
- geändert werden. Es können jedoch keine eigenen Werte zur
- Liste hinzugefügt werden. Das Ergebnis ist Komma-separiert
- entsprechend aufsteigend sortiert.</li>
- <li>:sortable-given,val1,val2,... - damit ist es möglich aus den
- gegebenen Werten eine sortierte Liste der gewünschten Werte durch
- Drag & Drop zusammenzustellen. Es können keine Elemente
- gelöscht und hinzugefügt werden. Es müssen alle gegeben
- Werte benutzt und entsprechend sortiert sein. Das Ergebnis ist
- Komma-separiert entsprechend aufsteigend sortiert.</li>
- <p> <li>noArg - es wird kein weiteres Eingabefeld angezeigt.</li>
- <li>time - zeigt ein Zeitauswahlmenü.
- Beispiel: attr FS20dev widgetOverride on-till:time</li>
- <li>textField - zeigt ein Eingabefeld.<br>
- Beispiel: attr WEB widgetOverride room:textField</li>
- <li>textField-long - ist wie textField, aber beim Click im Eingabefeld wird
- ein Dialog mit einer HTML textarea (60x25) wird geöffnet.</li>
- <li>slider,<min>,<step>,<max>[,1] - zeigt einen
- Schieberegler. Das optionale 1 (isFloat) vermeidet eine Rundung der
- Fliesskommazahlen.</li>
- <li>multiple,<val1>,<val2>,... - zeigt eine Mehrfachauswahl mit
- einem zusätzlichen Eingabefeld. Das Ergebnis ist Komma
- separiert.</li>
- <li>multiple-strict,<val1>,<val2>,... - ist wie :multiple,
- bloß ohne Eingabefeld.</li>
- <li>selectnumbers,<min>,<step>,<max>,<number of
- digits after decimal point>,lin|log10" zeigt ein HTML-select mit einer
- Zahlenreihe vom Wert min bis Wert max mit Schritten von step
- angezeigt.<br>
- Die Angabe lin erzeugt eine konstant ansteigende Reihe. Die Angabe
- log10 erzeugt eine exponentiell ansteigende Reihe zur Basis 10,
- step bezieht sich auf den Exponenten, z.B. 0.0625.</li>
- <li>select,<val1>,<val2>,... - zeigt ein HTML select mit allen
- Werten. <b>Achtung</b>: so ein Widget wird auch dann angezeigt, falls
- kein passender Modifier gefunden wurde.</li>
- <p><p> </ul></li>
- </ul>
- </ul>
- <p><a name="FHT"></a>
- <h3>FHT</h3>
- <div class='langLinks'>[<a href='commandref.html#FHT'>EN</a> DE]</div>
- <ul>
- Fhem kann FHT Funktelegramme (868.35 MHz) entweder mit einem <a
- href="#FHZ">FHZ</a> oder einem <a href="#CUL">CUL</a> empfangen, daher muss
- dieses zuerst definiert sein.
- <br><br>
- <a name="FHTdefine"></a>
- <b>Define</b>
- <ul>
- define <name> FHT <fhtaddress>
- <br><br>
- <fhtaddress> ist eine vierstellige HEX Zahl entsprechend der
- Adresse des FHT80b Gerätes.
- <br>
- Beispiel:
- <ul>
- define wz FHT 3232<br>
- </ul>
- <br>
- Mehr dazu im FHT Abschnitt <a href="#set">set</a>.
- </ul>
- <br>
- <a name="FHTset"></a>
- <b>Set </b>
- <ul>
- set <name> <valuetype> <value>
- <br><br>
- Wobei value eines von folgenden ist:<br>
- <ul>
- desired-temp<br>
- day-temp night-temp<br>
- report1 report2<br>
- refreshvalues<br>
- mode<br>
- holiday1 holiday2 # siehe mode holiday_short oder holiday<br>
- manu-temp # Keine Ahnung was das bewirkt<br>
- year month day hour minute<br>
- time date<br>
- lowtemp-offset # Alarm-Temp.-Differenz<br>
- windowopen-temp<br>
- mon-from1 mon-to1 mon-from2 mon-to2<br>
- tue-from1 tue-to1 tue-from2 tue-to2<br>
- wed-from1 wed-to1 wed-from2 wed-to2<br>
- thu-from1 thu-to1 thu-from2 thu-to2<br>
- fri-from1 fri-to1 fri-from2 fri-to2<br>
- sat-from1 sat-to1 sat-from2 sat-to2<br>
- sun-from1 sun-to1 sun-from2 sun-to2<br>
- </ul>
- Beispiele:
- <ul>
- set wz desired-temp 22.5<br>
- set fl desired-temp 20.5 day-temp 19.0 night-temp 16.0<br>
- </ul>
- <br>
- Hinweise:
- <ul>
- <li>Folgende Events werden (mehr oder weniger regelmäßig) von
- jedem FHT Device gemeldet:
- <ul>
- measured-temp actuator actuator1...actuator8 warnings<br>
- </ul>
- Diese Strings können für <a href="#notify">notify</a> oder
- <a href="#FileLog">FileLog</a> Definitionen verwendet werden.
- <ul>
- <li>Warnings können folgende Strings enthalten:
- none, Battery low,Temperature too low, Window open,
- Fault on window sensor
- </li>
- <li>actuator (ohne Suffix) steht für alle Aktoren.</li>
- <li>actuator or actuator1..8 kann folgende Werte verarbeiten:
- <ul>
- <li><value>%<br>
- Das ist der Normalfall. Der Aktor wird angewiesen auf diesen
- Wert zu öffnen.
- </li>
- <li>offset <value>%<br>
- Der Aktor läuft mit diesem Offset.
- </li>
- <li>lime-protection<br>
- Der Aktor wird angewiesen die lime-protection (Kalkschutz)
- Prozedur auszuführen.
- </li>
- <li>synctime<br>
- Wenn Sond/Sync beim FHT80B gewählt wird, wird ein
- Countdown gesetzt.
- </li>
- <li>test<br>
- Der Aktor wird vom FHT80b angewiesen zu piepsen (beep).
- </li>
- <li>pair<br>
- Das FHT80b sendet ein "you-belong-to-me"
- (Du-gehörst-zu-mir) an diesen Aktor.
- </li>
- </ul></li>
- </ul></li>
- <br>
- <li>Das FHT ist sehr sparsam (oder faul). Es akzeptiert eine Nachricht
- vom FHZ1x00 alle 115+x Sekunden, wobei x von der fhtaddress
- abhängt. Nicht überrascht sein wenn ein Befehl erst 10
- Minuten später vom Gerät angenommen wird. Die FHT Befehle
- werden im FHZ1x00/CUL gepuffert bis sie zum FHT geschickt werden.
- Siehe den zugehörigen fhtbuf Eintrag im der <a
- href="#get">get</a> Abschnitt. Es können bis zu 8 Befehle in
- einer Nachricht an ein FHT geschickt werden wenn diese alle als
- Argumente im gleichen set Befehl zusammengefasst werden. Siehe
- nachfolgendes Beispiel. </li><br>
- <li>time setzt Stunde und Minute auf lokale Zeit</li><br>
- <li>date setzt Jahr, Monat und Tag auf lokale Zeit</li><br>
- <li>refreshvalues ist ein Alias für report1 255 report2 255</li><br>
- <li>Alle *-temp Werte brauchen eine Temperatur als Argument welche auf
- 0.5°C gerundet wird.<br> Temperatur Werte müssen zwischen
- 5.5°C und 30.5°C sein. Der Wert 5.5 setzt den Aktor auf OFF,
- der Wert 30.5 setzt den Aktor auf ON</li><br>
- <li>mode kann auto, manual, holiday or
- holiday_short sein.<br>
- Wenn der mode holiday ist, schaltet dieser zurück auf entweder
- auto oder manual um 00:00 des Tages der wie folgt spezifiziert wird:
- <ul>
- <li>holiday1 setzt Endtag des Urlaubs</li>
- <li>holiday2 setzt den Endmonat des Urlaubs</li>
- </ul>
- Für holiday_short (Party Modus)
- <ul>
- <li> holiday1 setzt die absolute Stunde zu der von diesem Modus
- zurück geschalten wird (in 10-Minuten Schritten, max.
- 144)</li>
- <li> holiday2 setzt den Tag des Monats an dem von diesem Modus
- zurück geschalten wird (kann nur heute oder morgen sein, da
- holiday1 nur 24h akzeptiert.)</li>
- Beispiel:
- <ul>
- <li>Aktuelles Datum ist der 29. Januar, Uhrzeit ist 18:05</li>
- <li>Es soll bis morgen 1:00Uhr in den Party Modus geschalten
- sein</li>
- <li>set holiday1 to 6 (6 x 10min = Std) and holiday2 to
- 30</li>
- </ul>
- </ul>
- Die Temperatur für den Urlaubszeitraum wird durch den
- desired-temperature Parameter setzt. <br> Bitte beachten, dass der
- Holiday Mode nicht früher als auf Übermorgen eingestellt
- werden kann. Alternativ muss hier holiday_short genutzt werden.<br>
- Weiterhin bitte beachten das diese Kommandos nur in einem
- "Sammelkommando" erfolgen können. Beispiel:
- <br>
- set FHT1 mode holiday holiday1 24 holiday2 12 desired-temp 14
- </li><br>
- <li>Die *-from1/*-from2/*-to1/*-to2 Wertetypen brauchen eine
- Zeitspezifikation als Argument im Format HH:MM. Diese definieren den
- Zeitraum in dem die day-temp gültig ist. Minuten (MM) werden
- auf 10er gerundet, 24:00 bedeutet OFF. </li><br>
- <li>Um die FHZ Zeit zu synchronisieren und um "stumme" Geräte
- zu wecken, wird folgendes Kommando empfohlen:<br> define fht_sync at
- +*3:30 set TYPE=FHT time </li><br>
- <li>report1 mit dem Parameter 255 fordert das Senden aller Einstellungen
- von Montag bis Sonntag an. Das Argument ist ein Bitfeld um einzelne
- Werte wie folgt anzufordern:
- <ul>
- <li> 1: monday</li>
- <li> 2: tuesday</li>
- <li> 4: thursday</li>
- <li> 8: wednesday</li>
- <li>16: friday</li>
- <li>32: saturday</li>
- <li>64: sunday</li>
- </ul>
- measured-temp und actuator werden mitgesendet wenn vom FHT als
- notwendig erachtet.
- <br><br>
- <b>Hinweis:</b> Dieser Befehl erzeugt sehr viel Funkverkehr was zu
- weiteren Problemen führen kann, besonders wenn Empfang nicht gut
- ist. </li><br>
- <li>report2 mit dem Parameter 255 fordert die Ausgabe der nachfolgenden
- Einstellungen an:<br> day-temp night-temp windowopen-temp
- lowtemp-offset desired-temp measured-temp mode warnings.<br> Das
- Argument ist ein Bitfeld, um einzelne Werte abzufragen folgendes
- anhängen:
- <ul>
- <li> 1: warnings</li>
- <li> 2: mode</li>
- <li> 4: day-temp, night-temp, windowopen-temp</li>
- <li> 8: desired-temp</li>
- <li>64: lowtemp-offset</li>
- </ul>
- measured-temp und actuator werden mitgesendet wenn vom FHT als
- notwendig erachtet. <br></li>
- <li>lowtemp-offset braucht eine Temperatur als Argument. Gültige
- Werte müssen zwischen 1.0 und 5.0°C liegen.<br> Wird eine
- Warnung erzeugen wenn die desired-temp - measured-temp >
- lowtemp-offset, jedoch frühestens 1,5Stunden nach der letzten
- Änderung der desired-temp. </li><br>
- <li>FHEM hat optional einen internen Softwarepuffer für FHT
- Devices. Dieser Puffer soll vor Übertragungsfehlern
- schützen. Wenn nach einem bestimmten Zeitraum keine
- Bestätigung erhalten wurde wird FHEM den Befehl erneut senden.
- Die Befehle in der Warteschlagen können mit <a
- href="#list">list</a> <fht-device> angezeigt werden. Siehe die
- Attribute <a href="#fhtsoftbuffer">fhtsoftbuffer</a>, <a
- href="#retrycount">retrycount</a> und <a
- href="#minfhtbuffer">minfhtbuffer</a> für weitere Details.
- </li><br>
- <li>Befehle im Softwarepuffer werden in folgender Reihenfolge
- gesendet:<br>
- desired-temp,mode,report1,report2,holiday1,holiday2,day-temp,night-temp,
- [all other commands] </li><br>
- </ul>
- </ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="FHTattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#attrdummy">dummy</a><br>
- <b>Hinweis:</b> Es macht Sinn ein FHT Device auch für ein FHT8b zu
- definieren da sonst der Fehler "unknown FHT device, please define one"
- für jedes FHT8b generiert wird, denn das CUL meldet die 8b
- Nachrichten. Das dummy Attribut sollte bei diesen Devices gesetzt werden
- da sonst der interne FHT Buffer des CUL mit 8b-Daten gefüllt wird
- die niemals gebraucht werden. Wenn der Puffer dann voll ist werden "EOB"
- Nachrichten vom CUL erzeugt, und Senden zu den 8b ist nicht mehr
- möglich.</li><br>
- <a name="retrycount"></a>
- <li>retrycount<br>
- Wenn das <a href="#fhtsoftbuffer">fhtsoftbuffer</a> Attribut gesetzt ist,
- dann werden die Befehle entsprechend dem retrycount n-mal erneut
- versendet wenn nach 240 Sekunden keine Bestätigungsmeldung vom
- entsprechenden FHZ Device empfangen wurde.<br> Der Default-Wert ist
- 1.</li><br>
- <a name="minfhtbuffer"></a>
- <li>minfhtbuffer<br>
- FHEM sendet keine Befehle mehr zum FHZ wenn der fhtbuffer-Wert diesen
- Wert unterschritten hat. Default-Wert ist 0. Wenn dieser Wert zu niedrig
- ist hat die Reihenfolge von fht-Befehlen weniger Einfluss da nur Befehle
- im Softbuffer priorisiert werden können. (Siehe Hinweise in der FHT
- Sektion <a href="#set">set</a>) Der Maximalwert sollte 7 unter dem
- Hardware Maximum sein, siehe fhtbuf. </li><br>
- <a name="lazy"></a>
- <li>lazy<br>
- Wenn das Attribut lazy (faul) gesetzt wurde sendet FHEM keine Befehle
- wenn die aktuell gelesenen Werte und der zu setzende Wert identisch sind.
- Das spart Funkzeit und hilft Konflikte mit der Regelung die besagt, dass
- maximal 1% der Zeit als Funkzeit verwendet werden darf, zu vermeiden.
- Nicht standardmäßig aktiviert. </li><br>
- <a name="tmpcorr"></a>
- <li>tmpcorr<br>
- Korrigiert die Werte die vom FHZ gemeldet werden um den angegebenen Wert.
- Hinweis: nur die measured-temp Werte die von FHEM gemeldet (für
- Logging genutzt) werden angepasst. </li><br>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#model">model</a> (fht80b)</li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <a name="FHTevents"></a>
- <b>Erzeugte Events:</b>
- <ul>
- <li>actuator</li>
- <li>actuator1 actuator2 actuator3 actuator4<br>
- actuator5 actuator6 actuator7 actuator8<br>
- (wird gesendet wenn ein Offset zum entsprechenden Ventil konfiguriert wurde)</li>
- <li>mon-from1 mon-to1 mon-from2 mon-to2</li>
- <li>tue-from1 tue-to1 tue-from2 tue-to2</li>
- <li>wed-from1 wed-to1 wed-from2 wed-to2</li>
- <li>thu-from1 thu-to1 thu-from2 thu-to2</li>
- <li>fri-from1 fri-to1 fri-from2 fri-to2</li>
- <li>sat-from1 sat-to1 sat-from2 sat-to2</li>
- <li>sun-from1 sun-to1 sun-from2 sun-to2</li>
- <li>mode</li>
- <li>holiday1 holiday2</li>
- <li>desired-temp</li>
- <li>measured-temp measured-low measured-high</li>
- <li>warnings</li>
- <li>manu-temp</li>
- <li>year month day hour minute</li>
- <li>day-temp night-temp lowtemp-offset windowopen-temp</li>
- <li>ack can-xmit can-rcv ack2 start-xmit end-xmit (Nur wenn das CUL
- für die Übertragung von FHT Protokoll Daten konfiguriert
- ist)</li>
- </ul>
- <br>
- </ul>
- <p><a name="FHT8V"></a>
- <h3>FHT8V</h3>
- <div class='langLinks'>[<a href='commandref.html#FHT8V'>EN</a> DE]</div>
- <ul>
-
- Fhem kann die Ventile vom Typ FHT8V durch einen <a href="#CUL">CUL</a>
- direkt, ohne zwischengeschalteten FHT, ansteuern. Dieser Abschnitt
- beschreibt einen der Bausteine, der andere ist das <a href="#PID">PID</a> Device.
- <br>
- <br>
- <a name="FHT8Vdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FHT8V <Hauscode> [IODev|FHTID]</code>
- <br><br>
- <code><Hauscode></code> ist eine vierstellige hexadezimale Zahl, die
- folgende Beziehung zum zuständigen CUL-Device aufweisen muss:
- <ul>Bei gegebenem Hauscode des CUL als AABB muss dieser Hauscode die Form CCBB
- haben, wobei CC größer oder gleich AA, aber kleiner AA+8 sein muss.
- </ul>
-
- Diese Form wurde gewählt, damit der CUL alle FHT8V-Ventilstellungen
- innerhalb von zwei Minuten aktualisieren kann. <br><br>
- <code><IODev></code> muß angegeben werden, wenn der als letzter
- definierte CUL nicht der zuständige ist. Normalerweise wird dies mit
- dem <a href="#IODev">IODev</a>-Attribut gesetzt, da die
- Überprüfung der Adresse aber während der Definition erfolgt,
- brauchen wir hier eine Ausnahme. <br>
- Als Alternative kann man die FHTID des zuständigen IODev-Gerätes
- (anstelle des IODev selbst) setzen. Diese Methode ist nötig, wenn man
- FHT8V über FHEM2FHEM betreibt. <br>
- Beispiel:
- <ul>
- <code>define wz FHT8V 3232</code><br>
- </ul>
- </ul>
- <br>
- <a name="FHT8Vset"></a>
- <b>Set </b>
- <ul>
- <li>set <name> valve <Wert><br>
- Öffnet das Ventil auf den angegebenen Wert (in Prozent, von 0 bis 100).
- </li>
- <li>set <name> pair<br>
- Verbindet das Ventil mit dem CUL.
- </li>
- <li>set <name> decalc<br>
- Startet einen Entkalkungslauf des angegebenen Ventils.
- </li>
- </ul>
- <br>
- <a name="FHT8Vget"></a>
- <b>Get </b>
- <ul>
- <li>get <name> valve<br>
- Liest die Ventilöffnung aus dem FHT-Puffer des CUL und wandelt sie
- in Prozent (von 0 bis 100) um.
- </li>
- </ul>
- <br>
- <a name="FHT8Vattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#dummy">dummy</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#eventMap">eventMap</a></li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="FHZ"></a>
- <h3>FHZ</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FHZ'>FHZ</a><br/>
- </ul>
- <a name="FLOORPLAN"></a>
- <h3>FLOORPLAN</h3>
- <div class='langLinks'>[<a href='commandref.html#FLOORPLAN'>EN</a> DE]</div>
- <ul>
- Fügt dem fhem-Menü einen zusätzlichen Menüpunkt "Floorplans" hinzu, der zu einer Anzeige ohne fhem-Menü, Räume oder device-Listen führt.
- Geräte können an einer festlegbaren Koordinate auf dem Bildschirm angezeigt werden, üblicherweise mit einem anklickbaren icon, das das Ein- oder Aus-Schalten
- des Geräts durch klicken erlaubt. Ein Hintergrundbild kann verwendet werden - z.B. ein Grundriss oder jegliches andere Bild.
- Mit floorplanstyle.css kann die Formatierung angepasst werden.<br>
- Eine Schritt-für-Schritt-Anleitung zur Einrichtung ist verfügbar in
- <a href="http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide.pdf?format=raw">Englisch</a> und
- <a href="http://www.fhemwiki.de/wiki/Floorplan_Installations-Leitfaden" target="_blank">Deutsch</a>. <br>
- <br>
- <a name="FLOORPLANdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FLOORPLAN </code>
- <br><br>
- <b>Hinweis:</b> Speichern Sie Ihr Hintergrundbild mit dem Dateinamen fp_<name>.png in Ihrem icon_ordner (www/images/default , www/pgm2 or FHEM) .<br><br>
- Beispiel:
- <ul>
- <code>
- define Grundriss FLOORPLAN<br>
- fp_Grundriss.png
- </code><br>
- </ul>
- </ul>
- <br>
- <a name="FLOORPLANset"></a>
- <b>Set</b>
- <ul>
- <li>N/A</li>
- </ul>
- <br>
- <a name="FLOORPLANget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> config</code>
- <br>
- Zeigt die Konfiguration des FLOORPLAN <name> incl. allen Attributen an. Kann fuer ein include-file verwendet werden.<br>
- </ul>
- <br>
- <a name="FLOORPLANattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a name="fp_fpname">userattr fp_<name> <top>,<left>[,<style>[,<description>]]</a><br><br>
- A <a href="#userattr">userattr</a> fp_<name> wird automatisch angelegt, sofern es noch nicht existiert.<br>
- <ul>
- <li>top = Bildschirmposition, pixel vom oberen Bildschirmrand</li>
- <li>left = Bildschirmposition, pixel vom linken Bildschirmrand</li>
- <li>style =
- <ul>
- <li>0 nur icon/Status</li>
- <li>1 Gerätename und icon/Status</li>
- <li>2 Gerätename, icon/Status und Kommandos</li>
- <li>3 Geräte-reading und optionale Beschreibung</li>
- <li>4 S300TH-spezifisch, zeigt Temperatur und Luftfeuchtigkeit an</li>
- <li>5 icon/Status und Kommandos (ohne Gerätename)</li>
- <li>6 Geräte-reading, Zeitstempel und optionale Beschreibung</li>
- <li>7 nur Kommandos</li>
- <li>8 popup für kommandos</li>
- </ul>
- </li>
- <li>Eine ggf. angegebene Bschreibung wird anstelle des original-Gerätenamens angezeigt.</li>
- </ul></li><br>
- Beispiele:<br>
- <ul>
- <table>
- <tr><td><code>attr lamp1 fp_Erdgeschoss 100,100</code></td><td><code>#display lamp1 with icon only at screenposition 100,100</code></td></tr>
- <tr><td><code>attr lamp2 fp_Erdgeschoss 100,140,1,Art-Deco</code></td><td><code>#display lamp2 with description 'Art-Deco-Light' at 100,140</code></td></tr>
- <tr><td><code>attr lamp2 fp_ErsteEtage 130,100,1</code></td><td><code>#display the same device at different positions on other floorplans</code></td></tr>
- <tr><td><code>attr myFHT fp_Erdgeschoss 300,20,10,Temperature</code></td><td><code>#display given Text + FHT-temperature</code></td></tr>
- </table>
- </ul>
- <b>Hinweis:</b> Die Parameter müssen ohne Leerstellen aneinandergereiht werden.<br><br>
- <li><a name="fp_arrange">fp_arrange</a><br>
- Aktiviert den "arrange-Modus" der ein zusätzliches Menü anzeigt,
- mit dem Geräte auf dem Bildschirm angeordnet werden können. Bei aktiviertem arrange-mode können alle devices per drag&drop platziert werden.<br>
- Beispiel:
- <ul>
- <code>attr Erdgeschoss fp_arrange 1</code><br>
- <code>attr Erdgeschoss fp_arrange WEB #Aktiviert den arrange-Modus nur für die Webinstanz WEB</code><br><br>
- </ul>
- </li>
- <li><a name="stylesheet">stylesheet</a><br>
- Ermöglicht die Verwendung eines eigenen css-stylesheet für Ihren floorplan. Dieses Attribut hat Vorrang vor dem Standard-stylesheet.
- Das Standard-stylesheet für floorplans ist <code>floorplanstyle.css</code>. Falls <a href="#stylesheetPrefix">stylesheetPrefix</a> in der korrespondierenden FHEMWEB-Instanz gesetzt ist, wird dieser
- <code>stylesheetPrefix</code> auch dem stylesheet für floorplans vorangestellt (prepend).<br>
- Alle stylesheets werden im stylesheet-Ordner des fhem-Dateisystems abgelegt. Legen Sie dort
- Ihr eigenes stylesheet neben <code>floorplanstyle.css</code> in demselben Ordner ab.<br>
- Beispiel:
- <ul>
- <code>attr Erdgeschoss stylesheet myfloorplanstyle.css</code><br><br>
- </ul>
- </li>
- <li><a name="fp_default">fp_default</a><br>
- Der floorplan-Startbildschirm wird übersprungen wenn dieses Attribut einem der von Ihnen definierten floorplans zugeordnet ist.
- </li>
- Beispiel:
- <ul>
- <code>attr Erdgeschoss fp_default 1</code><br><br>
- </ul>
- <li><a name="fp_noMenu">fp_noMenu</a><br>
- Blendet das floorplans-Menü aus, das normalerweise am linken Bildschirmrand angezeigt wird.
- </li>
- Beispiel:
- <ul>
- <code>attr Erdgeschoss fp_noMenu 1</code><br><br>
- </ul>
- <li><a name="commandfield">commandfield</a><br>
- Fügt Ihrem floorplan ein fhem-Kommandofeld hinzu.
- </li>
- Beispiel:
- <ul>
- <code>attr Erdgeschoss commandfield 1</code><br><br>
- </ul>
-
- <li><a name="fp_backgroundimg">fp_backgroundimg</a><br>
- Gestattet die Bennung eine Hintergundbilds unabhängig vom floorplan-Namen.<br>
- <b>Hinweis:</b> Das Attribut kann mittels notify geändert werden, um z.B. unterschiedliche Hintergundbidlder am Tag oder in der Nacht anzuzeigen.<br>
- Beispiel:
- <ul>
- <code>attr Erdgeschoss fp_backgroundimg foobar.png</code><br><br>
- </ul>
- </li>
-
- <li><a name="fp_viewport">fp_viewport</a><br>
- Gestattet die Verwendung eines abweichenden viewport-Wertes für die touchpad-Ausgabe.<br>
- Die Default-viewport-Angbe ist "width=768".
- </li>
-
- <a name="fp_roomIcons"></a>
- <li>fp_roomIcons<br>
- Mit Leerstellen getrennte Liste von floorplan:icon -Paaren, um
- einem Eintrag des floorplan-Menues icons zuzuordnen, genau wie
- die entsprechende Funktionalitaet in FHEMWEB. Beispiel:<br>
- attr Grundriss fp_roomIcons Grundriss:control_building_empty Media:audio_eq
- </li>
-
- <li><a name="fp_inherited">Vererbt von FHEMWEB</a><br>
- Die folgenden Attribute werden von der zugrundliegenden <a href="#FHEMWEB">FHEMWEB</a>-Instanz vererbt:<br>
- <ul>
- <a href="#smallscreen">smallscreen</a><br>
- <a href="#touchpad">touchpad</a><br>
- <a href="#refresh">refresh</a><br>
- <a href="#plotmode">plotmode</a><br>
- <a href="#plotsize">plotsize</a><br>
- <a href="#webname">webname</a><br>
- <a href="#redirectCmds">redirectCmds</a><br>
- <a href="#longpoll">longpoll</a><br>
- <a href="#allowedCommands">allowedCommands</a><br>
- </ul>
- </li><br>
- </ul>
- <br>
- </ul>
- <p><a name="FRAMEBUFFER"></a>
- <h3>FRAMEBUFFER</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRAMEBUFFER'>FRAMEBUFFER</a><br/>
- </ul>
- <a name="FRITZBOX"></a>
- <h3>FRITZBOX</h3>
- <div class='langLinks'>[<a href='commandref.html#FRITZBOX'>EN</a> DE]</div>
- <div>
- <ul>
- Steuert gewisse Funktionen eines Fritz!Box Routers. Verbundene Fritz!Fon's (MT-F, MT-D, C3, C4) können als Signalgeräte genutzt werden. MP3-Dateien und Text (Text2Speech) können als Klingelton oder einem angerufenen Telefon abgespielt werden.
- <br>
- Für detailierte Anleitungen bitte die <a href="http://www.fhemwiki.de/wiki/FRITZBOX"><b>FHEM-Wiki</b></a> konsultieren und ergänzen.
- <br/><br/>
- Das Modul schaltet in den lokalen Modus, wenn FHEM auf einer Fritz!Box läuft (als root-Benutzer!). Ansonsten versucht es eine Web oder Telnet Verbindung zu "fritz.box" zu öffnen. D.h. Telnet (#96*7*) muss auf der Fritz!Box erlaubt sein. Für diesen Fernzugriff muss <u>einmalig</u> das Passwort gesetzt werden.
- <br/><br/>
- Die Steuerung erfolgt teilweise über die offizielle TR-064-Schnittstelle und teilweise über undokumentierte Schnittstellen zwischen Webinterface und Firmware Kern. Das Modul funktioniert am besten mit dem Fritz!OS 6.24. Bei den nachfolgenden Fritz!OS Versionen hat AVM einige interne Schnittstellen (telnet, webcm) ersatzlos gestrichen. <b>Einige Modul-Funktionen sind dadurch nicht oder nur eingeschränkt verfügbar (siehe Anmerkungen zu benötigten API).</b>
- <br>
- Bitte auch die anderen Fritz!Box-Module beachten: <a href="#SYSMON">SYSMON</a> und <a href="#FB_CALLMONITOR">FB_CALLMONITOR</a>.
- <br>
- <i>Das Modul nutzt das Perlmodule 'Net::Telnet', 'JSON::XS', 'LWP', 'SOAP::Lite' für den Fernzugriff.</i>
- <br/><br/>
- <a name="FRITZBOXdefine"></a>
- <b>Define</b>
- <ul>
- <br>
- <code>define <name> FRITZBOX [host]</code>
- <br/>
- Das Attribut <i>host</i> ist die Web-Adresse (Name oder IP) der Fritz!Box. Fehlt es, so schaltet das Modul in den lokalen Modus oder nutzt die Standardadresse "fritz.box".
- <br/><br/>
- Beispiel: <code>define Fritzbox FRITZBOX</code>
- <br/><br/>
- Das FritzOS hat eine versteckte Funktion (Osterei).
- <br>
- <code>define MyEasterEgg weblink htmlCode { FRITZBOX_fritztris("Fritzbox") }</code>
- <br/><br/>
- </ul>
-
- <a name="FRITZBOXset"></a>
- <b>Set</b>
- <ul>
- <br>
- <li><code>set <name> alarm <Nummer> [on|off] [time] [once|daily|Mo|Tu|We|Th|Fr|Sa|So]</code>
- <br>
- Schaltet den Weckruf Nummer 1, 2 oder 3 an oder aus (Standard ist on). Setzt die Zeit und den Wochentag.
- <br>
- Benötigt die API: Telnet oder webcm.
- </li><br>
- <li><code>set <name> call <number> [Dauer] [say:Text|play:MP3URL]</code>
- <br>
- Ruf für 'Dauer' Sekunden (Standard 60 s) die angegebene Telefonnummer von einem internen Telefonanschluss an (Standard ist 1 oder das Attribut 'ringWithIntern'). Wenn der Angerufene abnimmt, hört er die Wartemusik oder den angegebenen Text oder Klang.
- Der interne Telefonanschluss klingelt ebenfalls.
- <br>
- "say:" und "play:" benötigen die API: Telnet oder webcm.
- </li><br>
- <li><code>set <name> checkAPIs</code>
- <br>
- Startet eine erneute Abfrage der exitierenden Programmierschnittstellen der FRITZ!BOX.
- </li><br>
- <li><code>set <name> customerRingTone <internalNumber> <MP3DateiInklusivePfad></code>
- <br>
- Lädt die MP3-Datei als Klingelton auf das angegebene Telefon. Die Datei muss im Dateisystem der Fritzbox liegen.
- <br>
- Das Hochladen dauert etwa eine Minute bis der Klingelton verfügbar ist. (API: Telnet)
- </li><br>
- <li><code>set <name> dect <on|off></code>
- <br>
- Schaltet die DECT-Basis der Box an oder aus.
- <br>
- Benötigt die API: Telnet oder webcm.
- </li><br>
- <li><code>set <name> diversity <number> <on|off></code>
- <br>
- Schaltet die Rufumleitung (Nummer 1, 2 ...) für einzelne Rufnummern an oder aus.
- <br>
- Die Rufumleitung muss zuvor auf der Fritz!Box eingerichtet werden. Benötigt die API: Telnet oder webcm.
- <br>
- Achtung! Es lassen sich nur Rufumleitungen für einzelne angerufene Telefonnummern (also nicht "alle") und <u>ohne</u> Abhängigkeit von der anrufenden Nummer schalten.
- Es muss also ein <i>diversity</i>-Geräwert geben.
- <br>
- Benötigt die API: Telnet, webcm oder TR064 (>=6.50).
- </li><br>
- <li><code>set <name> guestWLAN <on|off></code>
- <br>
- Schaltet das Gäste-WLAN an oder aus. Das Gäste-Passwort muss gesetzt sein. Wenn notwendig wird auch das normale WLAN angeschaltet.
- </li><br>
- <li><code>set <name> moh <default|sound|customer> [<MP3DateiInklusivePfad|say:Text>]</code>
- <br>
- Beispiel: <code>set fritzbox moh customer say:Die Wanne ist voll</code>
- <br>
- <code>set fritzbox moh customer /var/InternerSpeicher/warnung.mp3</code>
- <br>
- Ändert die Wartemusik ('music on hold') der Box. Mit dem Parameter 'customer' kann eine eigene MP3-Datei aufgespielt werden.
- Alternativ kann mit "say:" auch ein Text gesprochen werden. Die Wartemusik hat <u>immer</u> eine Länge von 8,13 s. Sie wird kontinuierlich während des Makelns von Gesprächen aber auch bei Nutzung der internen Wählhilfe bis zum Abheben des rufenden Telefons abgespielt. Dadurch können über FHEM dem Angerufenen 8s-Nachrichten vorgespielt werden.
- <br>
- </li><br>
-
- <li><code>set <name> password <Passwort></code>
- <br>
- Speichert das Passwort für den Fernzugriff über Telnet.
- </li><br>
- <li><code>set <name> ring <intNummern> [Dauer [Klingelton]] [show:Text] [say:Text | play:Link]</code>
- <dt>Beispiel:</dt>
- <dd>
- <code>set fritzbox ring 611,612 5 Budapest show:Es regnet</code>
- <br>
- <code>set fritzbox ring 610 8 say:Es regnet</code>
- <br>
- <code>set fritzbox ring 610 10 play:http://raspberrypi/sound.mp3</code>
- </dd>
- Lässt die internen Nummern für "Dauer" Sekunden und (auf Fritz!Fons) mit dem angegebenen "Klingelton" klingeln.
- <br>
- Mehrere interne Nummern müssen durch ein Komma (ohne Leerzeichen) getrennt werden.
- <br>
- Standard-Dauer ist 5 Sekunden. Es kann aber zu Verzögerungen in der Fritz!Box kommen. Standard-Klingelton ist der interne Klingelton des Gerätes.
- Der Klingelton wird für Rundrufe (9 oder 50) ignoriert.
- <br>
- Wenn der Anruf angenommen wird, hört der Angerufene die Wartemusik (music on hold), welche ebenfalls zur Nachrichtenübermittlung genutzt werden kann.
- <br>
- Die Parameter <i>Klingelton, show:, say:</i> und <i>play:</i> benötigen die API Telnet oder webcm.
- <br/><br/>
- Wenn das <a href=#FRITZBOXattr>Attribut</a> 'ringWithIntern' existiert, wird der Text hinter 'show:' als Name des Anrufers angezeigt.
- Er darf maximal 30 Zeichen lang sein.
- <br/><br/>
- Auf Fritz!Fons wird der Text (max. 100 Zeichen) hinter dem Parameter 'say:' direkt angesagt und ersetzt den Klingelton.
- <br>
- Alternativ kann mit 'play:' auch ein MP3-Link (vom einem Webserver) abgespielt werden. Dabei wird die Internetradiostation 39 'FHEM' erzeugt und translate.google.com für Text2Speech genutzt. Es wird <u>immer</u> der komplette Text/Klang abgespielt. Bis zum Ende der 'Klingeldauer' klingelt das Telefon dann mit seinem Standard-Klingelton.
- Das Abspielen ist eventuell nicht auf mehreren Fritz!Fons gleichzeitig möglich.
- <br>
- Je nach Fritz!OS kann das beschriebene Verhalten abweichen.
- <br>
- </li><br>
- <li><code>set <name> sendMail [to:<Address>] [subject:<Subject>] [body:<Text>]</code>
- <br>
- Sendet eine Email über den Emailbenachrichtigungsservice der als Push Service auf der Fritz!Box konfiguriert wurde.
- Mit "\n" kann einen Zeilenumbruch im Textkörper erzeut werden.
- Alle Parameter können ausgelassen werden. Bitte kontrolliert, dass die Email nicht im Junk-Verzeichnis landet.
- <br>
- Benötigt einen Telnet Zugang zur Box.
- <br>
- </li><br>
-
- <li><code>set <name> startRadio <internalNumber> [Name oder Nummer]</code>
- <br>
- Startet das Internetradio auf dem angegebenen Fritz!Fon. Eine verfügbare Radiostation kann über den Namen oder die (Gerätewert)Nummer ausgewählt werden. Ansonsten wird die in der Box als Internetradio-Klingelton eingestellte Station abgespielt. (Also <b>nicht</b> die am Telefon ausgewählte.)
- <br>
- </li><br>
-
- <li><code>set <name> tam <number> <on|off></code>
- <br>
- Schaltet den Anrufbeantworter (Nummer 1, 2 ...) an oder aus.
- Der Anrufbeantworter muss zuvor auf der Fritz!Box eingerichtet werden.
- </li><br>
-
- <li><code>set <name> update</code>
- <br>
- Startet eine Aktualisierung der Gerätewerte.
- </li><br>
-
- <li><code>set <name> wlan <on|off></code>
- <br>
- Schaltet WLAN an oder aus.
- </li><br>
- </ul>
- <a name="FRITZBOXget"></a>
- <b>Get</b>
- <ul>
- <br>
- <li><code>get <name> ringTones</code>
- <br>
- Zeigt die Liste der Klingeltöne, die benutzt werden können.
- </li><br>
- <li><code>get <name> shellCommand <Befehl></code>
- <br>
- Führt den angegebenen Befehl auf der Fritz!Box-Shell aus und gibt das Ergebnis zurück.
- Kann benutzt werden, um Shell-Befehle auszuführen, die nicht im Modul implementiert sind.
- <br>
- Muss zuvor über das Attribute "allowShellCommand" freigeschaltet werden.
- </li><br>
- <li><code>get <name> tr064Command <service> <control> <action> [[argName1 argValue1] ...] </code>
- <br>
- Führt über TR-064 Aktionen aus (siehe <a href="http://avm.de/service/schnittstellen/">Schnittstellenbeschreibung</a> von AVM).
- <br>
- argValues mit Leerzeichen müssen in Anführungszeichen eingeschlossen werden.
- <br>
- Beispiel: <code>get Fritzbox tr064Command X_AVM-DE_OnTel:1 x_contact GetDECTHandsetInfo NewDectID 1</code>
- <br>
- Muss zuvor über das Attribute "allowTR064Command" freigeschaltet werden.
- </li><br>
- <li><code>get <name> tr064ServiceListe</code>
- <br>
- Zeigt die Liste der TR-064-Dienste und Aktionen, die auf dem Gerät erlaubt sind.
- </li><br>
- </ul>
-
- <a name="FRITZBOXattr"></a>
- <b>Attributes</b>
- <ul>
- <br>
- <li><code>allowShellCommand <0 | 1></code>
- <br>
- Freischalten des get-Befehls "shellCommand"
- </li><br>
-
- <li><code>allowTR064Command <0 | 1></code>
- <br>
- Freischalten des get-Befehls "tr064Command"
- </li><br>
-
- <li><code>boxUser <user name></code>
- <br>
- Benutzername für den TR064- oder einen anderen webbasierten Zugang. Normalerweise wird keine Benutzername für das Login benötigt.
- Wenn die Fritz!Box anders konfiguriert ist, kann der Nutzer über dieses Attribut definiert werden.
- </li><br>
-
- <li><code>defaultCallerName <Text></code>
- <br>
- Standard-Text, der auf dem angerufenen internen Telefon als "Anrufer" gezeigt wird.
- <br>
- Dies erfolgt, indem während des Klingelns temporär der Name der internen anrufenden Nummer geändert wird.
- <br>
- Es sind maximal 30 Zeichen erlaubt. Das Attribute "ringWithIntern" muss ebenfalls spezifiziert sein.
- <br>
- Benötigt die API: Telnet oder webcmd
- </li><br>
-
- <li><code>defaultUploadDir <fritzBoxPath></code>
- <br>
- Dies ist der Standard-Pfad der für Dateinamen benutzt wird, die nicht mit einem / (Schrägstrich) beginnen.
- <br>
- Es muss ein Pfad auf der Fritz!Box sein. D.h., er sollte mit /var/InternerSpeicher starten, wenn es in Windows unter \\ip-address\fritz.nas erreichbar ist.
- </li><br>
- <li><code>forceTelnetConnection <0 | 1></code>
- <br>
- Erzwingt den Fernzugriff über Telnet (anstatt über die WebGUI oder TR-064).
- <br>
- Dieses Attribut muss bei älteren Geräten/Firmware aktiviert werden.
- </li><br>
- <li><code>fritzBoxIP <IP-Adresse></code>
- <br>
- Veraltet.
- </li><br>
-
- <li><code>INTERVAL <Sekunden></code>
- <br>
- Abfrage-Interval. Standard ist 300 (Sekunden). Der kleinste mögliche Wert ist 60.
- </li><br>
- <li><code>ringWithIntern <1 | 2 | 3></code>
- <br>
- Um ein Telefon klingeln zu lassen, muss in der Fritzbox eine Anrufer (Wählhilfe, Wert 'box_stdDialPort') spezifiziert werden.
- <br>
- Um während des Klingelns eine Nachricht (Standard: "FHEM") anzuzeigen, kann hier die interne Nummer 1-3 angegeben werden.
- Der entsprechende analoge Telefonanschluss muss vorhanden sein.
- </li><br>
- <li><code>telnetTimeOut <Sekunden></code>
- <br>
- Maximale Zeit, bis zu der während einer Telnet-Sitzung auf Antwort gewartet wird. Standard ist 10 s.
- </li><br>
- <li><code>telnetUser <user name></code>
- <br>
- Benutzername für den Telnetzugang. Normalerweise wird keine Benutzername für das Login benötigt.
- Wenn die Fritz!Box anders konfiguriert ist, kann der Nutzer über dieses Attribut definiert werden.
- </li><br>
-
- <li><code>useGuiHack <0 | 1></code>
- <br>
- Falls die APIs der Box nicht mehr die Änderung des Klingeltones unterstützen (Fritz!OS >6.24), kann dieses Attribute entsprechend der <a href="http://www.fhemwiki.de/wiki/FRITZBOX#Klingelton-Einstellung_und_Abspielen_von_Sprachnachrichten_bei_Fritz.21OS-Versionen_.3E6.24">WIKI-Anleitung</a> genutzt werden.
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <a name="FRITZBOXreading"></a>
- <b>Readings</b>
- <ul><br>
- <li><b>alarm</b><i>1</i> - Name des Weckrufs <i>1</i></li>
- <li><b>alarm</b><i>1</i><b>_state</b> - Aktueller Status des Weckrufs <i>1</i></li>
- <li><b>alarm</b><i>1</i><b>_target</b> - Interne Nummer des Weckrufs <i>1</i></li>
- <li><b>alarm</b><i>1</i><b>_time</b> - Weckzeit des Weckrufs <i>1</i></li>
- <li><b>alarm</b><i>1</i><b>_wdays</b> - Wochentage des Weckrufs <i>1</i></li>
- <br>
- <li><b>box_dect</b> - Aktueller Status des DECT-Basis</li>
- <li><b>box_fwVersion</b> - Firmware-Version der Box, wenn veraltet dann wird '(old)' angehangen</li>
- <li><b>box_guestWlan</b> - Aktueller Status des Gäste-WLAN</li>
- <li><b>box_guestWlanCount</b> - Anzahl der Geräte die über das Gäste-WLAN verbunden sind</li>
- <li><b>box_guestWlanRemain</b> - Verbleibende Zeit bis zum Ausschalten des Gäste-WLAN</li>
- <li><b>box_ipExtern</b> - Internet IP der Fritz!Box</li>
- <li><b>box_model</b> - Fritz!Box-Modell</li>
- <li><b>box_moh</b> - Wartemusik-Einstellung</li>
- <li><b>box_powerRate</b> - aktueller Stromverbrauch in Prozent der maximalen Leistung</li>
- <li><b>box_rateDown</b> - Download-Geschwindigkeit des letzten Intervals in kByte/s</li>
- <li><b>box_rateUp</b> - Upload-Geschwindigkeit des letzten Intervals in kByte/s</li>
- <li><b>box_stdDialPort</b> - Anschluss der geräteseitig von der Wählhilfe genutzt wird</li>
- <li><b>box_tr064</b> - Anwendungsschnittstelle TR-064 (wird auch von diesem Modul benötigt)</li>
- <li><b>box_tr069</b> - Provider-Fernwartung TR-069 (sicherheitsrelevant!)</li>
- <li><b>box_wlanCount</b> - Anzahl der Geräte die über WLAN verbunden sind</li>
- <li><b>box_wlan_2.4GHz</b> - Aktueller Status des 2.4-GHz-WLAN</li>
- <li><b>box_wlan_5GHz</b> - Aktueller Status des 5-GHz-WLAN</li>
-
- <br>
- <li><b>dect</b><i>1</i> - Name des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_alarmRingTone</b> - Klingelton beim Wecken über das DECT Telefon <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_custRingTone</b> - Benutzerspezifischer Klingelton des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_fwVersion</b> - Firmware-Version des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_intern</b> - Interne Nummer des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_intRingTone</b> - Interner Klingelton des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_manufacturer</b> - Hersteller des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_model</b> - Modell des DECT Telefons <i>1</i></li>
- <li><b>dect</b><i>1</i><b>_radio</b> - aktueller Internet-Radio-Klingelton des DECT Telefons <i>1</i></li>
- <br>
- <li><b>diversity</b><i>1</i> - Eigene Rufnummer der Rufumleitung <i>1</i></li>
- <li><b>diversity</b><i>1</i><b>_dest</b> - Zielnummer der Rufumleitung <i>1</i></li>
- <li><b>diversity</b><i>1</i><b>_state</b> - Aktueller Status der Rufumleitung <i>1</i></li>
- <br>
- <li><b>fon</b><i>1</i> - Name des analogen Telefonanschlusses <i>1</i> an der Fritz!Box</li>
- <li><b>fon</b><i>1</i><b>_intern</b> - Interne Nummer des analogen Telefonanschlusses <i>1</i></li>
- <li><b>fon</b><i>1</i><b>_out</b> - ausgehende Nummer des Anschlusses <i>1</i></li>
- <br>
- <li><b>gsm_internet</b> - Internetverbindung errichtet über Mobilfunk-Stick </li>
- <li><b>gsm_rssi</b> - Indikator der empfangenen GSM-Signalstärke (0-100)</li>
- <li><b>gsm_state</b> - Status der Mobilfunk-Verbindung</li>
- <li><b>gsm_technology</b> - GSM-Technologie, die für die Datenübertragung genutzt wird (GPRS, EDGE, UMTS, HSPA)</li>
- <br>
- <li><b>mac_</b><i>01_26_FD_12_01_DA</i> - MAC Adresse und Name eines aktiven Netzwerk-Gerätes.
- <br>
- Bei einer WLAN-Verbindung wird "WLAN" und (von der Box gesehen) die Sende- und Empfangsgeschwindigkeit und die Empfangsstärke angehangen. Bei einer LAN-Verbindung wird der LAN-Port und die LAN-Geschwindigkeit angehangen. Gast-Verbindungen werden mit "gWLAN" oder "gLAN" gekennzeichnet.
- <br>
- Inaktive oder entfernte Geräte erhalten zuerst den Werte "inactive" und werden beim nächsten Update gelöscht.</li>
- <br>
- <li><b>radio</b><i>01</i> - Name der Internetradiostation <i>01</i></li>
- <br>
- <li><b>tam</b><i>1</i> - Name des Anrufbeantworters <i>1</i></li>
- <li><b>tam</b><i>1</i><b>_newMsg</b> - Anzahl neuer Nachrichten auf dem Anrufbeantworter <i>1</i></li>
- <li><b>tam</b><i>1</i><b>_oldMsg</b> - Anzahl alter Nachrichten auf dem Anrufbeantworter <i>1</i></li>
- <li><b>tam</b><i>1</i><b>_state</b> - Aktueller Status des Anrufbeantworters <i>1</i></li>
- <br>
- <li><b>user</b><i>01</i> - Name von Nutzer/IP <i>1</i> für den eine Zugangsbeschränkung (Kindersicherung) eingerichtet ist</li>
- <li><b>user</b><i>01</i>_thisMonthTime - Internetnutzung des Nutzers/IP <i>1</i> im aktuellen Monat (Kindersicherung)</li>
- <li><b>user</b><i>01</i>_todaySeconds - heutige Internetnutzung des Nutzers/IP <i>1</i> in Sekunden (Kindersicherung)</li>
- <li><b>user</b><i>01</i>_todayTime - heutige Internetnutzung des Nutzers/IP <i>1</i> (Kindersicherung)</li>
- </ul>
- <br>
- </ul>
- </div>
- <p><a name="FRM"></a>
- <h3>FRM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM'>FRM</a><br/>
- </ul>
- <a name="FRM_AD"></a>
- <h3>FRM_AD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_AD'>FRM_AD</a><br/>
- </ul>
- <a name="FRM_I2C"></a>
- <h3>FRM_I2C</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_I2C'>FRM_I2C</a><br/>
- </ul>
- <a name="FRM_IN"></a>
- <h3>FRM_IN</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_IN'>FRM_IN</a><br/>
- </ul>
- <a name="FRM_LCD"></a>
- <h3>FRM_LCD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_LCD'>FRM_LCD</a><br/>
- </ul>
- <a name="FRM_OUT"></a>
- <h3>FRM_OUT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_OUT'>FRM_OUT</a><br/>
- </ul>
- <a name="FRM_PWM"></a>
- <h3>FRM_PWM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_PWM'>FRM_PWM</a><br/>
- </ul>
- <a name="FRM_RGB"></a>
- <h3>FRM_RGB</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_RGB'>FRM_RGB</a><br/>
- </ul>
- <a name="FRM_ROTENC"></a>
- <h3>FRM_ROTENC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_ROTENC'>FRM_ROTENC</a><br/>
- </ul>
- <a name="FRM_SERVO"></a>
- <h3>FRM_SERVO</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_SERVO'>FRM_SERVO</a><br/>
- </ul>
- <a name="FRM_STEPPER"></a>
- <h3>FRM_STEPPER</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FRM_STEPPER'>FRM_STEPPER</a><br/>
- </ul>
- <a name="FReplacer"></a>
- <h3>FReplacer</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FReplacer'>FReplacer</a><br/>
- </ul>
- <a name="FS20"></a>
- <h3>FS20</h3>
- <div class='langLinks'>[<a href='commandref.html#FS20'>EN</a> DE]</div>
- <ul>
- Das FS20 Protokoll wird von einem großen Spektrum an Geräten
- verwendet. Diese stammen entweder aus der Kategorie Sensor/Sender oder
- Aktor/Empfänger. Die Funknachrichten (868.35 MHz) können mit einem
- <a href="#FHZ">FHZ</a> oder einem <a href="#CUL">CUL</a> empfangen werden.
- Dieses muss daher zuerst definiert werden.
- <br><br>
- <a name="FS20define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FS20 <housecode> <button>
- [fg <fgaddr>] [lm <lmaddr>] [gm FF] </code>
- <br><br>
- Die Werte housecode, button, fg, lm, und gm können entweder hexadezimal
- oder in der ELV-typischen quaternären Notation (Zahlen von 1-4)
- eingegeben werden.
- Hier und auch in späteren Beispielen wird als Referenz die ELV4
- Notation verwendet. Die Notationen können auch gemischt werden da FHEM
- die verwendete Notation durch zählen der Zeichen erkennt.<br>
- <ul>
- <li><code><housecode></code> ist eine 4 stellige Hex oder 8 stellige
- ELV4 Zahl, entsprechend der Hauscode Adresse.</li>
- <li><code><button></code> ist eine 2 stellige Hex oder 4 stellige ELV4
- Zahl, entsprechend dem Button des Transmitters.</li>
- <li>Optional definiert <code><fgaddr></code> die Funktionsgruppe mit
- einer 2 stelligen Hex oder 4 stelligen ELV4 Adresse. Bei Hex muss die
- erste Stelle F, bei ELV4 die ersten zwei Stellen 44 sein.</li>
- <li>Optional definiert <code><lmaddr></code> definiert einen local
- master mit einer 2 stelligen Hex oder 4 stelligen ELV4 Adresse. Bei Hex
- muss die letzte Stelle F, bei ELV4 die letzten zwei Stellen 44 sein.</li>
- <li>Optional definiert gm den global master. Die Adresse muss FF bei HEX
- und 4444 bei ELV4 Notation sein.</li>
- </ul>
- <br>
- Beispiele:
- <ul>
- <code>define lamp FS20 7777 00 fg F1 gm F</code><br>
- <code>define roll1 FS20 7777 01</code><br>
- <code>define otherlamp FS20 24242424 1111 fg 4412 gm 4444</code><br>
- <code>define otherroll1 FS20 24242424 1114</code>
- </ul>
- </ul>
- <br>
- <a name="FS20set"></a>
- <b>Set </b>
- <ul>
- <code>set <name> <value> [<time>]</code>
- <br><br>
- Wobei <code>value</code> einer der folgenden Werte sein kann:<br>
- <ul><code>
- dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50%<br>
- dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%<br>
- dimdown<br>
- dimup<br>
- dimupdown<br>
- off<br>
- off-for-timer<br>
- on # dimmer: Setze auf diesen Wert vor dem Ausschalten<br>
- on-for-timer # Siehe Hinweise<br>
- on-old-for-timer # Setze zum vorherigen (vor dem Einschalten)<br>
- ramp-on-time # Zeit bis zum erreichen des gewünschten Dim-Wertes<br>
- ramp-off-time # Zeit bis zum Ausschalten bei Dimmern<br>
- reset<br>
- sendstate<br>
- timer<br>
- toggle # zwischen aus und dem letztern Dim-Wert<br>
- </code></ul><br>
- Die<a href="#setExtensions"> set extensions</a> sind ebenfalls
- unterstützt.<br>
- <br>
- Beispiele:
- <ul>
- <code>set lamp on</code><br>
- <code>set lamp1,lamp2,lamp3 on</code><br>
- <code>set lamp1-lamp3 on</code><br>
- <code>set lamp on-for-timer 12</code><br>
- </ul>
- <br>
- Hinweise:
- <ul>
- <li>reset nur mit Vorsicht verwenden: Auch der Hauscode wird
- gelöscht. </li>
- <li>Da das FS20 Protokoll 0.22Sek für eine Funksequenz benötigt
- wird nach jeder Ausführung eine Pause von 0.22Sek eingefügt.
- </li>
- <li>Das FS20ST schaltet für dim*% und dimup ein. Es reagiert nicht
- auf sendstate.</li>
- <li>Wenn ein Timer gesetzt ist (und dieser nicht 0 ist) werden on, dim*,
- und *-for-timer berücksichtigt (zumindest beim FS20ST). </li>
- <li>Das <code>time</code> Argument geht von 0.25Sek bis 4Std und 16Min.
- Da <code>time</code> nur mit einem Byte dargestellt wird ergeben sich
- hieraus nur 112 eindeutige Zeit-Werte die mit ansteigender
- größe immer gröber aufgelöst werden. Das Programm
- zeigt die exakte Restzeit an wenn die gewählte Auflösung
- nicht eindeutig war. Die Auflösung ist is 0.25Sek von 0 bis 4
- Sekunden, 0.5Sek von 4 bis 8Sek, 1Sek von 8 bis 16 Sek und so weiter.
- Wenn eine höhere Genauigkeit bei großen Werten gebraucht
- wird, dann hilft <a href="#at">at</a> mit einer Auflösung von
- 1Sek.</li>
- </ul>
- </ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="FS20attr"></a>
- <b>Attribute</b>
- <ul>
- <a name="IODev"></a>
- <li>IODev<br>
- Setzt das IO oder das physische Device welches zum Senden der Signale an
- dieses logische Device verwendet werden soll (Beispielsweise FHZ oder
- CUL). Hinweis: Beim Start weist FHEM jedem logischen Device das letzte
- physische Device zu, das Daten von diesem Typ empfangen kann. Das
- Attribut IODev muss nur gesetzt werden wenn mehr als ein physisches
- Device fähig ist Signale von diesem logischen Device zu empfangen.
- </li><br>
- <a name="eventMap"></a>
- <li>eventMap<br>
- Ersetze Event Namen und setze Argumente. Der Wert dieses Attributes
- besteht aus einer Liste von durch Leerzeichen getrennte Werten. Jeder
- Wert ist ein durch Doppelpunkt getrenntes Paar. Der erste Teil stellt den
- "alten" Wert, der zweite Teil den "neuen" Wert dar. Wenn der erste Wert
- ein Slash (/) oder ein Komma (,) ist, dann wird nicht durch Leerzeichen
- sondern durch das vorgestellte Zeichen getrennt.
- Beispiele:
- <ul><code>
- attr store eventMap on:open off:closed<br>
- attr store eventMap /on-for-timer 10:open/off:closed/<br>
- set store open
- </code></ul>
- </li><br>
- <a name="attrdummy"></a>
- <li>dummy<br>
- Setzt das Attribut dummy um Devices zu definieren, die keine Funksignale
- absetzen. Zugehörige notifys werden ausgeführt wenn das Signal
- empfangen wird. Wird beispielsweise genutzt um auf Code eines Sender zu
- reagieren, dennoch wird es auch dann kein Signal senden wenn es im Web
- Frontend getriggert wird.
- </li><br>
- <a name="follow-on-for-timer"></a>
- <li>follow-on-for-timer<br>
- Plant ein "setstate off;trigger off" für die angegebene Zeit als
- Argument zum on-for-timer Command. Oder das gleiche mit "on" wenn der
- Befehl "follow-off-for-timer" war.
- </li><br>
- <a name="follow-on-timer"></a>
- <li>follow-on-timer<br>
- Wie follow-on-for-timer plant es ein "setstate off;trigger off", aber
- diesmal als Argument in Sekunden zum Attribut. Wird verwendet um dem
- vorprogrammierten Timer zu folgen welcher vorher durch den timer-Befehl,
- oder manuell durch Drücken des Buttons gesetzt wurde. Im Handbuch
- finden sich noch mehr Informationen. Beachtet bei on und dim Befehlen.
- </li><br>
- <a name="model"></a>
- <li>model<br>
- Das "model" Attribut bezeichnet den Modelltyp des Gerätes. Dieses
- Attribut wird (derzeit) nicht direkt durch fhem.pl genutzt. Es kann
- beispielsweise von externen Programmen oder Webinterfaces genutzt werden
- um Geräteklassen zu unterscheiden und dazu passende Befehle zu senden
- (z.B. "on" oder "off" an ein fs20st, "dim..%" an ein fs20du etc.). Die
- Schreibweise des Modellnamens ist wie die in Anführungszeichen in
- der Anleitung gedruckte Bezeichnung die jedem Gerät beiliegt.
- Dieser Name wird ohne Leerzeichen ausschließlich in Kleinbuchstaben
- verwendet. Gültige Zeichen sind <code>a-z 0-9</code> und
- <code>-</code>, andere Zeichen sind zu vermeiden. Hier ist eine Liste der
- "offiziellen" Devices:<br><br>
- <b>Sender/Sensor</b>: fs20fms fs20hgs fs20irl fs20kse fs20ls
- fs20pira fs20piri fs20piru fs20s16 fs20s20 fs20s4 fs20s4a fs20s4m
- fs20s4u fs20s4ub fs20s8 fs20s8m fs20sd fs20sn fs20sr fs20ss
- fs20str fs20tc1 fs20tc6 fs20tfk fs20tk fs20uts fs20ze fs20bf fs20si3<br><br>
- <b>Dimmer</b>: fs20di fs20di10 fs20du<br><br>
- <b>Empfänger/Aktor</b>: fs20as1 fs20as4 fs20ms2 fs20rgbsa fs20rst
- fs20rsu fs20sa fs20sig fs20sm4 fs20sm8 fs20st fs20su fs20sv fs20ue1
- fs20usr fs20ws1
- </li><br>
- <a name="ignore"></a>
- <li>ignore<br>
- Ignoriere dieses Gerät, beispielsweise wenn es dem Nachbar
- gehört. Das Gerät wird keine FileLogs/notifys triggern,
- empfangene Befehle werden stillschweigend ignoriert (es wird kein
- Funksignal gesendet, wie auch beim <a href="#attrdummy">dummy</a>
- Attribut). Das Gerät wird weder in der Device-List angezeigt (es sei
- denn, es wird explizit abgefragt), noch wird es in Befehlen mit
- "Wildcard"-Namenspezifikation (siehe <a href="#devspec">devspec</a>)
- erscheinen. Es kann mit dem "ignored=1" devspec dennoch erreicht werden.
- </li><br>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <li>useSetExtensions<br>
- Falls es auf 0 gesetzt wird, werden die SetExtensions Befehle nicht
- angeboten. Die Voreinstellung ist 1.
- </li><br>
- </ul>
- <br>
- <a name="FS20events"></a>
- <b>Erzeugte Events:</b>
- <ul>
- Von einem FS20 Gerät können folgende Events empfangen werden:
- <li>on</li>
- <li>off</li>
- <li>toggle</li>
- <li>dimdown</li>
- <li>dimup</li>
- <li>dimupdown</li>
- <li>on-for-timer</li>
- Welches Event gesendet wird ist Geräteabhängig und kann manchmal
- auf dem Device konfiguriert werden.
- </ul>
- </ul>
- <p><a name="FTUISRV"></a>
- <h3>FTUISRV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FTUISRV'>FTUISRV</a><br/>
- </ul>
- <a name="FULLY"></a>
- <h3>FULLY</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#FULLY'>FULLY</a><br/>
- </ul>
- <a name="FileLog"></a>
- <h3>FileLog</h3>
- <div class='langLinks'>[<a href='commandref.html#FileLog'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="FileLogdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> FileLog <filename> <regexp> [readonly]</code>
- <br><br>
- Speichert Ereignisse in einer Log-Datei mit Namen <code><filename></code>. Das Log-Format ist
- <ul><code><br>
- YYYY-MM-DD_HH:MM:SS <device> <event><br>
- <br></code></ul>
- Der Ausdruck unter regexp wird anhand des Gerätenames überprüft und zwar
- devicename:event oder der timestamp:devicename:event-Kombination.
- Der regexp muss mit dem kompletten String übereinstimmen und nicht nur teilweise.
- <br>
- <code><filename></code> können %-wildcards der POSIX
- strftime-Funktion des darunterliegenden OS enthalten (siehe auch strftime
- Beschreibung).
- Allgemein gebräuchliche Wildcards sind:
- <ul>
- <li><code>%d</code> Tag des Monats (01..31)</li>
- <li><code>%m</code> Monat (01..12)</li>
- <li><code>%Y</code> Jahr (1970...)</li>
- <li><code>%w</code> Wochentag (0..6); beginnend mit Sonntag (0)</li>
- <li><code>%j</code> Tag des Jahres (001..366)</li>
- <li><code>%U</code> Wochennummer des Jahres, wobei Wochenbeginn = Sonntag (00..53)</li>
- <li><code>%W</code> Wochennummer des Jahres, wobei Wochenbeginn = Montag (00..53)</li>
- </ul>
- FHEM ersetzt <code>%L</code> mit dem Wert des global logdir Attributes.<br>
- Bevor <code>%V</code> für ISO 8601 Wochennummern verwendet werden,
- muss überprüft werden, ob diese Funktion durch das Brriebssystem
- unterstützt wird (Es kann sein, dass %V nicht umgesetzt wird, durch
- einen Leerstring ersetzt wird oder durch eine falsche ISO-Wochennummer
- dargestellt wird - besonders am Jahresanfang)
- Bei der Verwendung von <code>%V</code> muss gleichzeitig für das Jahr
- ein <code>%G</code> anstelle von <code>%Y</code> benutzt werden.<br>
- Falls man readonly spezifiziert, dann wird die Datei nur zum visualisieren
- verwendet, und nicht zum Schreiben geöffnet.
- <br>
- Beispiele:
- <ul>
- <code>define lamplog FileLog %L/lamp.log lamp</code><br>
- <code>define wzlog FileLog ./log/wz-%Y-%U.log
- wz:(measured-temp|actuator).*</code><br>
- Mit ISO 8601 Wochennummern falls unterstützt:<br>
- <code>define wzlog FileLog ./log/wz-%G-%V.log
- wz:(measured-temp|actuator).*</code><br>
- </ul>
- <br>
- </ul>
- <a name="FileLogset"></a>
- <b>Set </b>
- <ul>
- <li>reopen
- <ul>
- Erneutes Öffnen eines FileLogs nach händischen
- Änderungen in dieser Datei.
- </ul></li>
- <li>clear
- <ul>
- Löschen und erneutes Öffnen eines FileLogs.
- </ul></li>
- <li>addRegexpPart <device> <regexp>
- <ul>
- Fügt ein regexp Teil hinzu, der als device:regexp aufgebaut ist.
- Die Teile werden nach Regexp-Regeln mit | getrennt. Achtung: durch
- hinzufügen können manuell erzeugte Regexps ungültig
- werden.
- </ul></li>
- <li>removeRegexpPart <re>
- <ul>
- Entfernt ein regexp Teil. Die Inkonsistenz von addRegexpPart /
- removeRegexPart-Argumenten hat seinen Ursprung in der Wiederverwendung
- von Javascript-Funktionen.
- </ul></li>
- <li>absorb secondFileLog
- <ul>
- Führt den gegenwärtigen Log und den secondFileLog zu einer
- gemeinsamen Datei zusammen, fügt danach die regexp des
- secondFileLog dem gegenwärtigen Filelog hinzu und löscht dann
- anschließend das secondFileLog.<br>
- Dieses Komanndo wird zur Erzeugung von kombinierten Plots (weblinks)
- benötigt.<br>
- <b>Hinweise:</b>
- <ul>
- <li>secondFileLog wird gelöscht (d.h. die FHEM-Definition und
- die Datei selbst).</li>
- <li>nur das aktuelle File wird zusammengeführt, keine
- archivierten Versionen.</li>
- <li>Weblinks, die das secondFilelog benutzen werden unbrauchbar, sie
- müssen deshalb auf das neue Logfile angepasst oder
- gelöscht werden.</li>
- </ul>
- </ul></li>
- <br>
- </ul>
- <br>
- <a name="FileLogget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> <infile> <outfile> <from>
- <to> <column_spec> </code>
- <br><br>
- Liest Daten aus einem Logfile und wird von einem Frontend benötigt, um
- Daten ohne direkten Zugriff aus der Datei zu lesen.<br>
- <ul>
- <li><infile><br>
- Name des Logfiles, auf das zugegriffen werden soll. Sonderfälle:
- "-" steht für das aktuelle Logfile, und "CURRENT" öffnet die
- zum "from" passende Datei.</li>
- <li><outfile><br>
- Bei einem "-", bekommt man die Daten auf der aktuellen Verbindung
- zurück, anderenfall ist es das Name (eigentlich Prefix, s.u.) des
- Output-Files. Wenn mehr als ein File angesprochen wird, werden die
- einzelnen Dateinamen durch ein "-" getrennt, anderenfalls werden die
- Daten in einzelne Dateien geschrieben, die - beginnend mit 0 -
- durchnummeriert werden.
- </li>
- <li><from> <to><br>
- Bezeichnet den gewünschten Datenbereich. Die beiden Elemente
- müssen ganz oder mit dem Anfang des Zeitformates
- übereinstimmen.</li>
- <li><column_spec><br>
- Jede column_spec sendet die gewünschten Daten entweder in eine
- gesonderte Datei oder über die gegenwärtige Verbindung durch
- "-" getrennt.<br>
- Syntax: <col>:<regexp>:<default>:<fn><br>
- <ul>
- <li><col>
- gibt die Spaltennummer zurück, beginnend mit 1 beim Datum.
- Wenn die Spaltenmummer in doppelten Anführungszeichen steht,
- handelt es sich um einen festen Text und nicht um eine
- Spaltennummer.</li>
- <li><regexp>
- gibt, falls vorhanden, Zeilen mit Inhalten von regexp zurück.
- Groß- und Kleinschreibung beachten. </li>
- <li><default><br>
- Wenn keine Werte gefunden werden, und der Default-Wert
- (Voreinstellung) wurde gesetzt, wird eine Zeile zurückgegeben,
- die den von-Wert (from) und diesen Default-Wert enthält.
- Dieses Leistungsmerkmal ist notwendig, da gnuplot abbricht, wenn
- ein Datensatz keine Daten enthält.
- </li>
- <li><fn>
- Kann folgende Inhalte haben:
- <ul>
- <li>int<br>
- Löst den Integer-Wert zu Beginn eines Strings heraus. Wird
- z.B. bei 10% gebraucht.</li>
- <li>delta-h oder delta-d<br>
- Gibt nur den Unterschied der Werte-Spalte pro
- Stunde oder pro Tag aus. Wird benötigt, wenn die Spalte
- einen Zähler enthält, wie im Falles des KS300 in der
- Spalte für die Regenmenge.</li>
- <li>alles andere<br>
- Dieser String wird als Perl-Ausdruck ausgewertet. @fld enthaelt
- die aktuelle Zeile getrennt durch Leerzeichen. Achtung:
- Dieser String/Perl-Ausdruck darf keine Leerzeichen enthalten.
- </li>
- </ul></li>
- </ul></li>
- </ul>
- <br><br>
- Beispiel:
- <ul><code><br>
- get outlog out-2008.log - 2008-01-01 2008-01-08 4:IR:int: 9:IR::
- </code></ul>
- <br>
- </ul>
- <a name="FileLogattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#addStateEvent">addStateEvent</a></li><br><br>
- <a name="archivedir"></a>
- <a name="archivecmd"></a>
- <a name="nrarchive"></a>
- <li>archivecmd / archivedir / nrarchive<br>
- Wenn eine neue FileLog-Datei geöffnet wird, wird der FileLog
- archiver aufgerufen. Das geschieht aber nur , wenn der Name der Datei
- sich geändert hat(abhängig von den zeitspezifischen
- Wildcards, die weiter oben unter <a href="#FileLogdefine">FileLog
- (define)</a> beschrieben werden) und gleichzeitig ein neuer Datensatz
- in diese Datei geschrieben werden muss. <br>
- Wenn das Attribut archivecmd benutzt wird, startet es als
- shell-Kommando ( eine Einbettung in " ist nicht notwendig), und jedes %
- in diesem Befehl wird durch den Namen des alten Logfiles ersetzt.<br>
- Wenn dieses Attribut nicht gesetzt wird, aber dafür nrarchive,
- werden nrarchive viele Logfiles im aktuellen Verzeichnis gelassen, und
- ältere Dateien in das Archivverzeichnis (archivedir) verschoben
- (oder gelöscht, falls kein archivedir gesetzt wurde).<br>
- Achtung: "ältere Dateien" sind die, die in der alphabetisch
- sortierten Liste oben sind.<br>
-
- Hinweis: Werden diese Attribute als global instance gesetzt, hat das
- auschließlich auf das <a href="#logfile">FHEM logfile</a>
- Auswirkungen. </li><br>
- <a name="archiveCompress"></a>
- <li>archiveCompress<br>
- Falls nrarchive, archivedir und archiveCompress gesetzt ist, dann
- werden die Dateien im archivedir komprimiert abgelegt.
- </li><br>
- <a name="createGluedFile"></a>
- <li>createGluedFile<br>
- Falls gesetzt (1), und im SVG-Plot ein Zeitbereich abgefragt wird, was
- in zwei Logdateien gespeichert ist, dann wird für die Anfrage eine
- temporäre Datei mit dem Inhalt der beiden Dateien erzeugt.
- </li><br>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <br>
- <a name="eventOnThreshold"></a>
- <li>eventOnThreshold<br>
- Falls es auf eine (nicht Null-) Zahl gesetzt ist, dann wird das
- linesInTheFile Event generiert, falls die Anzahl der Zeilen in der
- Datei ein Mehrfaches der gesetzen Zahl ist. Achtung: der Zähler ist
- nur für solche Dateien korrekt, die nach dem Impementieren dieses
- Features angelegt wurden. Ein Absturz/Abschuß von FHEM
- verfälscht die Zählung.
- </li><br>
- <li><a href="#ignoreRegexp">ignoreRegexp</a></li>
- <a name="logtype"></a>
- <li>logtype<br>
- Wird vom SVG Modul benötigt, um daten grafisch aufzubereiten.
- Der String wird aus komma-separierten Tokens
- (,) erzeugt, wobei jeder Token ein eigenes gnuplot-Programm bezeichnet.
- Die Token können Doppelpunkte (:) enthalten. Der Teil vor dem
- Doppelpunkt bezeichnet den Namen des Programms; der Teil nach dem
- Doppelpunkt ist der String, der im Web.Frontend dargestellt werden
- soll. Gegenwärtig sind folgende Typen von gnuplot-Programmen
- implementiert:<br>
- <ul>
- <li>fs20<br>
- Zeichnet on als 1 and off als 0. Die geeignete
- filelog-Definition für das Gerät fs20dev lautet:<br>
- define fslog FileLog log/fs20dev-%Y-%U.log fs20dev
- </li>
- <li>fht<br>
- Zeichnet die Ist-Temperatur/Soll-temperatur/Aktor Kurven. Die
- passende FileLog-Definition (für das FHT-Gerät mit
- Namen fht1)sieht wie folgt aus: <br>
- <code>define fhtlog1 FileLog log/fht1-%Y-%U.log
- fht1:.*(temp|actuator).*</code>
- </li>
- <li>temp4rain10<br>
- Zeichnet eine Kurve aus der Temperatur und dem Niederschlag (pro
- Stunde und pro Tag) eines KS300. Die dazu passende
- FileLog-Definition (für das KS300
- Gerät mit Namen ks300) sieht wie folgt aus:<br>
- define ks300log FileLog log/fht1-%Y-%U.log ks300:.*H:.*
- </li>
- <li>hum6wind8<br>
- Zeichnet eine Kurve aus der Feuchtigkeit und der
- Windgeschwindigkeit eines ks300. Die geeignete
- FileLog-Definition ist identisch mit der vorhergehenden
- Definition. Beide programme erzeugen das gleiche Log.
- </li>
- <li>text<br>
- Zeigt das LogFile in seiner ursprünglichen Form (Nur
- Text).Eine gnuplot-Definition ist nicht notwendig.
- </li>
- </ul>
- Beispiel:<br> attr ks300log1 logtype
- temp4rain10:Temp/Rain,hum6wind8:Hum/Wind,text:Raw-data
- </li><br>
- <li><a href="#mseclog">mseclog</a></li><br>
- <a name="reformatFn"></a>
- <li>reformatFn<br>
- wird verwendet, um "fremde" Dateien für die SVG-Anzeige ins
- FileLog-Format zu konvertieren. Es enthält nur den Namen einer
- Funktion, der mit der ursprünglichen Zeile aufgerufen wird. Z.Bsp.
- um die NTP loopstats Datei zu visualisieren kann man den Wert von
- reformatFn auf ntpLoopstats setzen, und folgende Funktion in
- 99_myUtils.pm definieren:
- <pre><code>
- sub
- ntpLoopstats($)
- {
- my ($d) = @_;
- return $d if($d !~ m/^(\d{5}) (\d+)\.(\d{3}) (.*)$/);
- my ($r, $t) = ($4, FmtDateTime(($1-40587)*86400+$2));
- $t =~ s/ /_/;
- return "$t ntpLoopStats $r";
- }</code></pre>
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="GAEBUS"></a>
- <h3>GAEBUS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#GAEBUS'>GAEBUS</a><br/>
- </ul>
- <p>
- <a name="GEOFANCY" id="GEOFANCY"></a>
- </p>
- <h3>
- GEOFANCY
- </h3>
- <div class='langLinks'>[<a href='commandref.html#GEOFANCY'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#GEOFANCY'>GEOFANCY</a>
- </ul>
- <p><a name="GHoma"></a>
- <h3>GHoma</h3>
- <div class='langLinks'>[<a href='commandref.html#GHoma'>EN</a> DE]</div>
- (<a href="commandref.html#GHoma">en</a> | de)
- <ul>
- <ul>
- Verbindet fhem mit einem G-Homa Zwischenstecker<br><br>
- <b>Vorbereitung:</b><br>
- <li>WLAN konfigurieren (bis Firmware 1.06):<br>
- Gerät in den AP modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)<br>
- Nun einen Computer mit der SSID G-Home verbinden.<br>
- Im Browser zu 10.10.100.254 (username:passwort = admin:admin)<br>
- In STA Setting WLAN Einstellungen eintragen<br>
- </li>
- <li>WLAN konfigurieren:<br>
- Gerät in den AP modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)<br>
- Mit der G-Homa App das WLAN des Zwischensteckers einstellen<br>
- </li>
- <li>Network Parameters settings (bis Firmware 1.06):<br>
- Other Setting -> Protocol auf TCP-Server<br>
- Other Setting -> Port ID (wird später für FHEM benötigt)<br>
- Other Setting -> Server Address (IP Adresse des FHEM Servers)<br>
- </li>
- <li>Network Parameters settings:<br>
- Über <code>set ... ConfigAll</code> des Server Gerätes die Parameter automatisch setzen.<br>
- </li>
- <li>Optional:<br>
- Im Router alle ausgehenden Verbindungen für G-Homa blockieren.<br>
- </li>
- </ul>
- <br><br>
-
- <a name="GHomadefine"></a>
- <b>Define</b><br>
- <ul>
- <code>define <name> GHoma <port></code> <br>
- Legt ein GHoma Server device an.<br>
- Neue Zwischenstecker werden beim ersten verbinden automatisch angelegt.<br>
- Diese können aber auch manuell angelegt werden:<br>
- <code>define <name> GHoma <Id></code> <br>
- Die <code>Id</code> besteht aus den letzten 6 Stellen der MAC Adresse des Zwischensteckers.<br>
- Beispiel: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B<br>
- <br>
- </ul>
- <a name="GHomaset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <value></code>
- <br><br>
- Gültige Werte für <code>value</code>:<br>
- <ul><code>
- off<br>
- on<br>
- </code>
- </ul>
- Die <a href="#setExtensions"> set extensions</a> werden auch unterstützt.<br>
- <br>
- Für Server Device:
- <code>set <name> ConfigAll [IP|hostname|FQDN]</code><br>
- Einstellen aller GHoma Zwischenstecker über UDP broadcast auf TCP client mit FHEM Server Adresse und Port des GHoma Server Devices.<br>
- </ul>
-
-
- <a name="GHomaattr"></a>
- <b>Attributes</b><br>
- <ul>
- Für Zwischenstecker devices:
- <ul><li>restoreOnStartup<br>
- Wiederherstellen der Portzustände nach Neustart<br>
- Standard: last, gültige Werte: last, on, off<br><br>
- </li>
- <li>restoreOnReinit<br>
- Wiederherstellen der Portzustände nach Neustart<br>
- Standard: last, gültige Werte: last, on, off<br><br>
- </li>
- <li>blocklocal<br>
- Wert im Reading State sofort nach Änderung über lokale Taste wiederherstellen<br>
- Standard: no, gültige Werte: no, yes<br><br>
- </li></ul>
- Für Server devices:
- <ul><li>allowfrom<br>
- Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut
- gesetzt wurde, werden ausschließlich Verbindungen von diesen
- Adressen akzeptiert.<br><br>
- </li></ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="GOOGLECAST"></a>
- <h3>GOOGLECAST</h3>
- <div class='langLinks'>[<a href='commandref.html#GOOGLECAST'>EN</a> DE]</div>
- <ul>
- GOOGLECAST wird zur Steueung deines Google Cast Devices verwendet<br><br>
- <b>Note</b><br>Es ist sicherzustellen, dass python3 installiert ist. Zusätzlich werden folgende Pakete benötigt:
- <ul>
- <li>sudo apt-get install libwww-perl python-enum34 python-dev libextutils-makemaker-cpanfile-perl python3-pip cpanminus</li>
- <li>sudo pip3 install pychromecast --upgrade</li>
- <li>sudo pip3 install youtube-dl --upgrade</li>
- <li>sudo INLINE_PYTHON_EXECUTABLE=/usr/bin/python3 cpanm Inline::Python</li>
- </ul>
- <br>
- <br>
- <a name="GOOGLECASTdefine" id="GOOGLECASTdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> GOOGLECAST <name></code><br>
- <br>
- Beispiel:
- <ul>
- <code>define livingroom.chromecast GOOGLECAST livingroom</code><br><br>
- Warte ein paar Sekunden bis das Gerät als ONLINE angezeigt wird...<br><br>
- <code>set livingroom.chromecast play https://www.youtube.com/watch?v=YE7VzlLtp-4</code><br>
- </ul>
- <br>
- Die folgenden Medienformate werden unterstützt:<br>
- <a href="https://developers.google.com/cast/docs/media">Unterstützte Medienformate</a><br>
- Das Abspielen mittels youtube-dl funktioniert für die folgenden URLs:<br>
- <a href="https://rg3.github.io/youtube-dl/supportedsites.html">Unterstützte youtube-dl - Seiten</a><br>
- <br>
- </ul>
- <br>
- <a name="GOOGLECASTset" id="GOOGLECASTset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <command> [<parameter>]</code><br>
- Die folgenden Befehle sind definiert:<br><br>
- <ul>
- <li><code><b>play</b> URL</code> - Abspielen einer URL</li>
- <li><code><b>play</b></code> - Abspielen im Sinne von Wiederaufnahme eines zuvor pausierten Abspielvorgangs</li>
- <li><code><b>playFavorite</b></code> - spielt die URL aus den Favoriten favoriteURL_[1-5] ab</li>
- <li><code><b>stop</b></code> - unterbricht den augenblicklichen Abspielvorgang</li>
- <li><code><b>pause</b></code> - pause</li>
- <li><code><b>quitApp</b></code> - schließt die gegenwärtige Applikation wie beispielsweise YouTube</li>
- <li><code><b>skip</b></code> - unterbricht das gegenwärtige Kapitel bzw. Lied und springt zum Nächsten</li>
- <li><code><b>rewind</b></code> - springt zum Anfang des gegenwärtigen Kapitels bzw. Liedes</li>
- <li><code><b>displayWebsite</b></code> - anzeigen einer Webseite auf Chromecast Video</li>
- </ul>
- <br>
- </ul>
-
- <a name="GOOGLECASTattr" id="GOOGLECASTattr"></a>
- <b>Attribute</b>
- <ul>
- <li><code><b>favoriteURL_[1-5]</b></code> - Abspeichern von URL - Favoriten um mittels playFavorite [1-5] - Befehl abgespielt zu werden.</li>
- </ul>
- <br>
- <a name="GOOGLECASTget" id="GOOGLECASTget"></a>
- <b>Get</b>
- <ul>
- <code>n/a</code>
- </ul>
- <br>
- </ul>
- <p> <a name="GUEST" id="GUEST"></a>
- <h3>GUEST</h3>
- <div class='langLinks'>[<a href='commandref.html#GUEST'>EN</a> DE]</div>
- <ul>
- <a name="GUESTdefine" id="GUESTdefine"></a> <b>Define</b>
- <ul>
- <code>define <rg_FirstName> GUEST [<Device Name(n) der Bewohnergruppe(n)>]</code><br>
- <br>
- Stellt ein spezielles virtuelles Device bereit, welches einen Gast zu Hause repräsentiert.<br>
- Basierend auf dem aktuellen Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br>
- <br>
- Wird vom übergeordneten Modul <a href="#RESIDENTS">RESIDENTS</a> verwendet, kann aber auch einzeln benutzt werden.<br>
- <br />
- Bei Mitgliedschaft mehrerer Bewohnergruppen werden diese durch Komma getrennt angegeben (siehe Beispiel unten).<br />
- <br>
- Beispiele:<br>
- <ul>
- <code># Einzeln<br>
- define rg_Guest GUEST<br>
- <br>
- # Typisches Gruppenmitglied<br>
- define rg_Guest GUEST rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein<br>
- <br>
- # Mitglied in mehreren Gruppen<br>
- define rg_Guest GUEST rgr_Residents,rgr_Guests # um Mitglied der Gruppen rgr_Residents und rgr_Guests zu sein</code>
- </ul>
- </ul><br>
- <br>
- <a name="GUESTset" id="GUESTset"></a> <b>Set</b>
- <ul>
- <code>set <rg_FirstName> <command> [<parameter>]</code><br>
- <br>
- Momentan sind die folgenden Kommandos definiert.<br>
- <ul>
- <li>
- <b>location</b> - setzt das Reading 'location'; siehe auch Attribut rg_locations, um die in FHEMWEB angezeigte Liste anzupassen
- </li>
- <li>
- <b>mood</b> - setzt das Reading 'mood'; siehe auch Attribut rg_moods, um die in FHEMWEB angezeigte Liste anzupassen
- </li>
- <li>
- <b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status; siehe auch Attribut rg_states, um die in FHEMWEB angezeigte Liste anzupassen
- </li>
- <li>
- <b>create</b>
- <li><i>locationMap</i> fügt ein vorkonfiguriertes weblink Device hinzu, welches eine Google Map anzeigt, sofern die Readings locationLat+locationLong vorhanden sind.</li>
- <li><i>wakeuptimer</i> fügt diverse Vorkonfigurationen auf Basis von RESIDENTS Toolkit hinzu. Siehe separate Sektion in der <a href="#RESIDENTS">RESIDENTS Modul Kommandoreferenz</a>.</li>
- </li>
- </ul>
- <ul>
- <u>Hinweis:</u> Sofern der Zugriff auf administrative set-Kommandos (-> create) eingeschränkt werden soll, kann in einer FHEMWEB Instanz das Attribut allowedCommands ähnlich wie 'set,set-user' erweitert werden.
- Die Zeichenfolge 'set-user' stellt dabei sicher, dass beim Zugriff auf FHEM über diese FHEMWEB Instanz nur nicht-administrative set-Kommandos ausgeführt werden können.
- </ul>
- </ul><br>
- <br>
- <ul>
- <u>Mögliche Status und ihre Bedeutung</u><br>
- <br>
- <ul>
- Dieses Modul unterscheidet 6 verschiedene Status:<br>
- <br>
- <ul>
- <li>
- <b>home</b> - Mitbewohner ist zu Hause und wach
- </li>
- <li>
- <b>gotosleep</b> - Mitbewohner ist auf dem Weg ins Bett
- </li>
- <li>
- <b>asleep</b> - Mitbewohner schläft
- </li>
- <li>
- <b>awoken</b> - Mitbewohner ist gerade aufgewacht
- </li>
- <li>
- <b>absent</b> - Mitbewohner ist momentan nicht zu Hause, wird aber bald zurück sein
- </li>
- <li>
- <b>none</b> - Gast Device ist deaktiviert
- </li>
- </ul>
- </ul>
- </ul><br>
- <br>
- <ul>
- <u>Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location</u><br>
- <br>
- <ul>
- Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.<br>
- <br>
- Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'absent' auf 'present' wechselt, wird 'location' auf 'home' gesetzt. Sofern das Attribut rg_locationHome gesetzt ist, wird die erste Lokation daraus anstelle von 'home' verwendet.<br>
- <br>
- Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'present' auf 'absent' wechselt, wird 'location' auf 'underway' gesetzt. Sofern das Attribut rg_locationUnderway gesetzt ist, wird die erste Lokation daraus anstelle von 'underway' verwendet.
- </ul>
- </ul><br>
- <br>
- <ul>
- <u>Auto-Status 'gone'</u><br>
- <br>
- <ul>
- Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.<br>
- Der Standard ist nach 16 Stunden.<br>
- <br>
- Dieses Verhalten kann über das Attribut rg_autoGoneAfter angepasst werden.
- </ul>
- </ul><br>
- <br>
- <ul>
- <u>Anwesenheit mit anderen GUEST oder ROOMMATE Devices synchronisieren</u><br>
- <br>
- <ul>
- Wenn Sie immer zusammen mit anderen Mitbewohnern oder Gästen das Haus verlassen oder erreichen, können Sie ihren Status ganz einfach auf andere Mitbewohner übertragen.<br>
- Durch das Setzen des Attributs rg_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.<br>
- <br>
- Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'none' oder 'gone' (im Falle von ROOMMATE Devices) nicht beachtet werden.
- </ul>
- </ul><br>
- <br>
- <ul>
- <u>Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence</u><br>
- <br>
- <ul>
- Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.<br>
- <br>
- Immer wenn eine Lokation mit dem Namen 'home' gesetzt wird, wird auch der Status auf 'home' gesetzt, sofern die Anwesenheit bis dahin noch auf 'absent' stand. Sofern das Attribut rg_locationHome gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'home' aus.<br>
- <br>
- Immer wenn eine Lokation mit dem Namen 'underway' gesetzt wird, wird auch der Status auf 'absent' gesetzt, sofern die Anwesenheit bis dahin noch auf 'present' stand. Sofern das Attribut rg_locationUnderway gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'underway' aus. Diese Lokationen werden auch nicht in das Reading 'lastLocation' übertragen.<br>
- <br>
- Immer wenn eine Lokation mit dem Namen 'wayhome' gesetzt wird, wird das Reading 'wayhome' auf '1' gesetzt, sofern die Anwesenheit zu diesem Zeitpunkt 'absent' ist. Sofern das Attribut rg_locationWayhome gesetzt wurde, so führt das VERLASSEN einer dort aufgeführten Lokation ebenfalls dazu, dass das Reading 'wayhome' auf '1' gesetzt wird. Es gibt also 2 Möglichkeiten den Nach-Hause-Weg-Indikator zu beeinflussen (implizit und explizit).<br>
- Die Ankunft zu Hause setzt den Wert von 'wayhome' zurück auf '0'.<br>
- <br>
- Wenn Sie auch das <a href="#GEOFANCY">GEOFANCY</a> Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:<br>
- <br>
- <code>define n_rg_Manfred.location notify geofancy:currLoc_Manfred.* set rg_Manfred:FILTER=location!=$EVTPART1 location $EVTPART1</code><br>
- <br>
- Durch das Anlegen von Geofencing-Zonen mit den Namen 'home' und 'wayhome' in der iOS App werden zukünftig automatisch alle Statusänderungen wie oben beschrieben durchgeführt.
- </ul>
- </ul><br>
- <br>
- <a name="GUESTattr" id="GUESTattr"></a> <b>Attribute</b><br>
- <ul>
- <ul>
- <li>
- <b>rg_autoGoneAfter</b> - Anzahl der Stunden, nach denen sich der Status automatisch auf 'gone' ändert, wenn der aktuellen Status 'absent' ist; Standard ist 36 Stunden
- </li>
- <li>
- <b>rg_geofenceUUIDs</b> - Mit Komma getrennte Liste von Geräte UUIDs, die ihren Standort über <a href="#GEOFANCY">GEOFANCY</a> aktualisieren. Vermeidet zusätzliche notify/DOIF/watchdog Geräte und kann als Ersatz für das GEOFANCY attribute <i>devAlias</i> dienen. (hier ehr als eine UUID/Device zu hinterlegen ist eher keine gute Idee da die Lokation dann womöglich anfängt zu springen)
- </li>
- <li>
- <b>rg_lang</b> - überschreibt globale Spracheinstellung; hilft beim setzen von Device Attributen, um FHEMWEB Anzeigetext zu übersetzen
- </li>
- <li>
- <b>rg_locationHome</b> - hiermit übereinstimmende Lokationen werden als zu Hause gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'home'
- </li>
- <li>
- <b>rg_locationUnderway</b> - hiermit übereinstimmende Lokationen werden als unterwegs gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'underway'
- </li>
- <li>
- <b>rg_locationWayhome</b> - das Verlassen einer Lokation, die hier aufgeführt ist, lässt das Reading 'wayhome' auf '1' setzen; mehrere Einträge durch Leerzeichen trennen; Standard ist "wayhome"
- </li>
- <li>
- <b>rg_locations</b> - Liste der in FHEMWEB anzuzeigenden Lokationsauswahlliste in FHEMWEB; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
- </li>
- <li>
- <b>rg_moodDefault</b> - die Stimmung, die nach Ankunft zu Hause oder nach dem Statuswechsel von 'awoken' auf 'home' gesetzt werden soll
- </li>
- <li>
- <b>rg_moodSleepy</b> - die Stimmung, die nach Statuswechsel zu 'gotosleep' oder 'awoken' gesetzt werden soll
- </li>
- <li>
- <b>rg_moods</b> - Liste von Stimmungen, wie sie in FHEMWEB angezeigt werden sollen; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
- </li>
- <li>
- <b>rg_noDuration</b> - deaktiviert die kontinuierliche, nicht Event-basierte Berechnung der Zeitspannen (siehe Readings durTimer*)
- </li>
- <li>
- <b>rg_passPresenceTo</b> - synchronisiere die Anwesenheit mit anderen GUEST oder ROOMMATE Devices; mehrere Devices durch Leerzeichen trennen
- </li>
- <li>
- <b>rg_presenceDevices</b> - übernehmen des presence Status von einem anderen FHEM Device. Bei mehreren Devices diese mit Komma trennen, um ein Update des GUEST Devices auszulösen, sobald ALLE Devices entweder absent oder present sind. Optional kann auch durch : abgetrennt ein Reading Name angegeben werden, ansonsten werden die Readings presence und state berücksichtigt.
- </li>
- <li>
- <b>rg_realname</b> - wo immer GUEST den richtigen Namen verwenden möchte nutzt es den Wert des Attributs alias oder group; Standard ist group
- </li>
- <li>
- <b>rg_showAllStates</b> - die Status 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0
- </li>
- <li>
- <b>rg_states</b> - Liste aller in FHEMWEB angezeigter Status; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Status führen zu Fehlern
- </li>
- <li>
- <b>rg_wakeupDevice</b> - Referenz zu versklavten DUMMY Geräten, welche als Wecker benutzt werden (Teil von RESIDENTS Toolkit's wakeuptimer)
- </li>
- </ul>
- </ul><br>
- <br>
- <br>
- <b>Generierte Readings/Events:</b><br>
- <ul>
- <ul>
- <li>
- <b>durTimerAbsence</b> - Timer, der die Dauer der Abwesenheit in normal lesbarem Format anzeigt (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>durTimerAbsence_cr</b> - Timer, der die Dauer der Abwesenheit in Computer lesbarem Format anzeigt (Minuten)
- </li>
- <li>
- <b>durTimerPresence</b> - Timer, der die Dauer der Anwesenheit in normal lesbarem Format anzeigt (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>durTimerPresence_cr</b> - Timer, der die Dauer der Anwesenheit in Computer lesbarem Format anzeigt (Minuten)
- </li>
- <li>
- <b>durTimerSleep</b> - Timer, der die Schlafdauer in normal lesbarem Format anzeigt (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>durTimerSleep_cr</b> - Timer, der die Schlafdauer in Computer lesbarem Format anzeigt (Minuten)
- </li>
- <li>
- <b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause
- </li>
- <li>
- <b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus
- </li>
- <li>
- <b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses
- </li>
- <li>
- <b>lastDurAbsence</b> - Dauer der letzten Abwesenheit in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurAbsence_cr</b> - Dauer der letzten Abwesenheit in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastDurPresence</b> - Dauer der letzten Anwesenheit in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurPresence_cr</b> - Dauer der letzten Anwesenheit in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastDurSleep</b> - Dauer des letzten Schlafzyklus in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurSleep_cr</b> - Dauer des letzten Schlafzyklus in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastLocation</b> - der vorherige Aufenthaltsort
- </li>
- <li>
- <b>lastMood</b> - die vorherige Stimmung
- </li>
- <li>
- <b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus
- </li>
- <li>
- <b>lastState</b> - der vorherige Status
- </li>
- <li>
- <b>lastWakeup</b> - Zeit der letzten Wake-up Timer Ausführing
- </li>
- <li>
- <b>lastWakeupDev</b> - Device Name des zuletzt verwendeten Wake-up Timers
- </li>
- <li>
- <b>location</b> - der aktuelle Aufenthaltsort
- </li>
- <li>
- <b>mood</b> - die aktuelle Stimmung
- </li>
- <li>
- <b>nextWakeup</b> - Zeit der nächsten Wake-up Timer Ausführung
- </li>
- <li>
- <b>nextWakeupDev</b> - Device Name des als nächstes ausgefährten Wake-up Timer
- </li>
- <li>
- <b>presence</b> - gibt den zu Hause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)
- </li>
- <li>
- <b>state</b> - gibt den aktuellen Status wieder
- </li>
- <li>
- <b>wakeup</b> - hat den Wert '1' während ein Weckprogramm dieses Bewohners ausgeführt wird
- </li>
- <li>
- <b>wayhome</b> - abhängig vom aktullen Aufenthaltsort, kann der Wert '1' werden, wenn die Person auf dem weg zurück nach Hause ist
- </li>
- <li>
- <br>
- Die folgenden Readings werden auf '-' gesetzt, sobald der Status auf 'none' steht:<br>
- lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood
- </li>
- </ul>
- </ul>
- </ul>
- <p><a name="GardenaSmartBridge"></a>
- <h3>GardenaSmartBridge</h3>
- <div class='langLinks'>[<a href='commandref.html#GardenaSmartBridge'>EN</a> DE]</div>
- <ul>
- <u><b>Voraussetzungen</b></u>
- <br><br>
- <li>Zusammen mit dem Device GardenaSmartDevice stellt dieses FHEM Modul die Kommunikation zwischen der GardenaCloud und Fhem her. Es können damit Rasenmäher, Bewässerungscomputer und Bodensensoren überwacht und gesteuert werden</li>
- <li>Das Perl-Modul "SSL Packet" wird benötigt.</li>
- <li>Unter Debian (basierten) System, kann dies mittels "apt-get install libio-socket-ssl-perl" installiert werden.</li>
- <li>Das Gardena-Gateway und alle damit verbundenen Geräte und Sensoren müssen vorab in der GardenaApp eingerichtet sein.</li>
- </ul>
- <br>
- <a name="GardenaSmartBridgedefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> GardenaSmartBridge <Account-EMail> <Account-Passwort></code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define Gardena_Bridge GardenaSmartBridge me@email.me secret</code><br>
- </ul>
- <br>
- <Account-EMail> Email Adresse, die auch in der GardenaApp verwendet wurde<br>
- <Account-Passwort> Passwort, welches in der GardenaApp verwendet wurde<br>
- Das Bridge Device wird im Raum GardenaSmart angelegt und danach erfolgt das Einlesen und automatische Anlegen der Geräte. Von nun an können die eingebundenen Geräte gesteuert werden. Änderungen in der APP werden mit den Readings und dem Status syncronisiert.
- <br><br>
- <a name="GardenaSmartBridgereadings"></a>
- <br><br>
- <b>Readings</b>
- <ul>
- <li>address - Adresse, welche in der App eingetragen wurde (Langversion)</li>
- <li>authorized_user_ids - </li>
- <li>city - PLZ, Stadt</li>
- <li>devices - Anzahl der Geräte, welche in der GardenaCloud angemeldet sind (Gateway zählt mit)</li>
- <li>lastRequestState - Letzter abgefragter Status der Bridge</li>
- <li>latitude - Breitengrad des Grundstücks</li>
- <li>longitude - Längengrad des Grundstücks</li>
- <li>name - Name für das Grundstück – Default „My Garden“</li>
- <li>state - Status der Bridge</li>
- <li>token - SessionID</li>
- <li>zones - </li>
- </ul>
- <br><br>
- <a name="GardenaSmartBridgeset"></a>
- <b>set</b>
- <ul>
- <li>getDeviceState - Startet eine Abfrage der Daten.</li>
- <li>getToken - Holt eine neue Session-ID</li>
- </ul>
- <br><br>
- <a name="GardenaSmartBridgeattributes"></a>
- <b>Attribute</b>
- <ul>
- <li>debugJSON - JSON Fehlermeldungen</li>
- <li>disable - Schaltet die Datenübertragung der Bridge ab</li>
- <li>interval - Abfrageinterval in Sekunden (default: 300)</li>
- </ul>
- </ul>
- <p><a name="GardenaSmartDevice"></a>
- <h3>GardenaSmartDevice</h3>
- <div class='langLinks'>[<a href='commandref.html#GardenaSmartDevice'>EN</a> DE]</div>
- <ul>
- Zusammen mit dem Device GardenaSmartDevice stellt dieses FHEM Modul die Kommunikation zwischen der GardenaCloud und Fhem her.
- <br><br>
- Wenn das GardenaSmartBridge Device erzeugt wurde, werden verbundene Geräte automatisch erkannt und in Fhem angelegt.<br>
- Von nun an können die eingebundenen Geräte gesteuert werden. Änderungen in der APP werden mit den Readings und dem Status syncronisiert.
- <a name="GardenaSmartDevicereadings"></a>
- </ul>
- <br>
- <ul>
- <b>Readings</b>
- <ul>
- <li>battery-charging - Ladeindikator (0/1) oder mit neuerer Firmware (false/true)</li>
- <li>battery-level - Ladezustand der Batterie in Prozent</li>
- <li>battery-rechargeable_battery_status - Zustand der Batterie (Ausser Betrieb/Kritischer Batteriestand, wechseln Sie jetzt/Niedrig/oK)</li>
- <li>device_info-category - Eigenschaft des Gerätes (Mäher/Bewässerungscomputer/Bodensensor)</li>
- <li>device_info-last_time_online - Zeitpunkt der letzten Funkübertragung</li>
- <li>device_info-manufacturer - Hersteller</li>
- <li>device_info-product - Produkttyp</li>
- <li>device_info-serial_number - Seriennummer</li>
- <li>device_info-sgtin - </li>
- <li>device_info-version - Firmware Version</li>
- <li>firmware-firmware_command - Firmware Kommando (Nichts zu tun/Firmwareupload unterbrochen/Firmwareupload/nicht unterstützt)</li>
- <li>firmware-firmware_status - Firmware Status </li>
- <li>firmware-firmware_update_start - Firmwareupdate (0/1) oder mit neuerer Firmware (false/true)</li>
- <li>firmware-firmware_upload_progress - Firmwareupdatestatus in Prozent</li>
- <li>firmware-inclusion_status - Einbindungsstatus</li>
- <li>internal_temperature-temperature - Interne Geräte Temperatur</li>
- <li>mower-error - Aktuelle Fehler Meldung
- <ul>
- <li>Kein Fehler</li>
- <li>Außerhalb des Arbeitsbereichs</li>
- <li>Kein Schleifensignal</li>
- <li>Falsches Schleifensignal</li>
- <li>Problem Schleifensensor, vorne</li>
- <li>Problem Schleifensensor, hinten</li>
- <li>Eingeschlossen</li>
- <li>Steht auf dem Kopf</li>
- <li>Niedriger Batteriestand</li>
- <li>Batterie ist leer</li>
- <li>Kein Antrieb</li>
- <li>Angehoben</li>
- <li>Eingeklemmt in Ladestation</li>
- <li>Ladestation blockiert</li>
- <li>Problem Stoßsensor hinten</li>
- <li>Problem Stoßsensor vorne</li>
- <li>Radmotor rechts blockiert</li>
- <li>Radmotor links blockiert</li>
- <li>Problem Antrieb, rechts</li>
- <li>Problem Antrieb, links</li>
- <li>Schneidsystem blockiert</li>
- <li>Fehlerhafte Verbindung</li>
- <li>Standardeinstellungen</li>
- <li>Elektronisches Problem</li>
- <li>Problem Ladesystem</li>
- <li>Kippsensorproblem</li>
- <li>Rechter Radmotor überlastet</li>
- <li>Linker Radmotor überlastet</li>
- <li>Ladestrom zu hoch</li>
- <li>Vorübergehendes Problem</li>
- <li>SK 1 nicht gefunden</li>
- <li>SK 2 nicht gefunden</li>
- <li>SK 3 nicht gefunden</li>
- <li>Problem die Ladestation zu finden</li>
- <li>Kalibration des Suchkabels beendet</li>
- <li>Kalibration des Suchkabels fehlgeschlagen</li>
- <li>Kurzzeitiges Batterieproblem</li>
- <li>Batterieproblem</li>
- <li>Alarm! Mäher ausgeschalten</li>
- <li>Alarm! Mäher gestoppt</li>
- <li>Alarm! Mäher angehoben</li>
- <li>Alarm! Mäher gekippt</li>
- <li>Verbindung geändert</li>
- <li>Verbindung nicht geändert</li>
- <li>COM board nicht verfügbar</li>
- <li>Rutscht</li>
- </ul>
- </li>
- <li>mower-manual_operation - Manueller Betrieb (0/1) oder mit neuerer Firmware (false/true)</li>
- <li>mower-override_end_time - Zeitpunkt wann der manuelle Betrieb beendet ist</li>
- <li>mower-source_for_next_start - Grund für den nächsten Start
- <ul>
- <li>Kein Grund</li>
- <li>Mäher wurde geladen</li>
- <li>SensorControl erreicht</li>
- <li>Wochentimer erreicht</li>
- <li>Stoppuhr Timer</li>
- <li>Undefiniert</li>
- </ul>
- </li>
- <li>mower-status - Mäher Status (siehe state)</li>
- <li>mower-timestamp_next_start - Zeitpunkt des nächsten geplanten Starts</li>
- <li>radio-connection_status - Status der Funkverbindung</li>
- <li>radio-quality - Indikator für die Funkverbindung in Prozent</li>
- <li>radio-state - radio state (schlecht/schwach/gut/Undefiniert)</li>
- <li>state - Staus des Mähers
- <ul>
- <li>Pausiert</li>
- <li>Mähen</li>
- <li>Suche Ladestation</li>
- <li>Lädt</li>
- <li>Mähen</li>
- <li>Wird aktualisiert ...</li>
- <li>Wird eingeschaltet ...</li>
- <li>Geparkt nach Zeitplan</li>
- <li>Geparkt</li>
- <li>Der Mäher ist ausgeschaltet</li>
- <li>Deaktiviert. Abdeckung ist offen oder PIN-Code erforderlich</li>
- <li>Unbekannter Status</li>
- <li>Fehler</li>
- <li>Neustart ...</li>
- <li>Deaktiviert. Manueller Start erforderlich</li>
- <li>Manuelles Mähen</li>
- <li>Geparkt durch SensorControl</li>
- <li>Abgeschlossen</li>
- </ul>
- </li>
- </ul>
- <br><br>
- <a name="GardenaSmartDeviceattributes"></a>
- <b>Attribute</b>
- <ul>
- <li>readingValueLanguage - Änderung der Sprache der Readings (de,en/wenn nichts gesetzt ist, dann Englisch es sei denn deutsch ist als globale Sprache gesetzt) </li>
- <li>model - </li>
- </ul>
- <a name="GardenaSmartDeviceset"></a>
- <b>set</b>
- <ul>
- <li>parkUntilFurtherNotice - Parken des Mähers unter Umgehung des Zeitplans</li>
- <li>parkUntilNextTimer - Parken bis zum nächsten Zeitplan</li>
- <li>startOverrideTimer - Manuelles mähen (0 bis 59 Minuten)</li>
- <li>startResumeSchedule - Weiterführung des Zeitplans</li>
- </ul>
- </ul>
- <p><a name="GasCalculator"></a>
- <h3>GasCalculator</h3>
- <div class='langLinks'>[<a href='commandref.html#GasCalculator'>EN</a> DE]</div>
- <ul>
- <table>
- <tr>
- <td>
- Das GasCalculator Modul berechnet den Gas - Verbrauch und den verbundenen Kosten von einem oder mehreren Gas-Zählern.<BR>
- Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit den Zähl-Impulse von einem oder mehreren Gaszählern zu finden.<BR>
- <BR>
- Sobald das Modul in der fhem.cfg definiert wurde, reagiert das Modul auf jedes durch das regex definierte event wie beispielsweise ein myOWDEVICE:counter.* etc.<BR>
- <BR>
- Das GasCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Gas-Zählern und erstellt die entsprechenden Readings.<BR>
- <BR>
- Um zu verhindern, dass man bis zu 12 Monate warten muss, bis alle Werte der Realität entsprechen, müssen die Readings <code><DestinationDevice>_<SourceCounterReading>_Vol1stDay</code>, <code><DestinationDevice>_<SourceCounterReading>_Vol1stMonth</code>, <code><DestinationDevice>_<SourceCounterReading>_Vol1stYear</code> und <code><DestinationDevice>_<SourceCounterReading>_Vol1stMeter</code> entsprechend mit dem <code>setreading</code> - Befehl korrigiert werden.
- Diese Werte findet man unter Umständen auf der letzten Gas-Rechnung. Andernfalls dauert es bis zu 24h für die täglichen, 30 Tage für die monatlichen und bis zu 12 Monate für die jährlichen Werte bis diese der Realität entsprechen.<BR>
- <BR>
- </td>
- </tr>
- </table>
-
- <table>
- <tr><td><a name="GasCalculatorDefine"></a><b>Define</b></td></tr>
- </table>
- <table><tr><td><ul><code>define <name> GasCalculator <regex></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der Name dieses Berechnungs-Device. Empfehlung: "myGasCalculator".</td></tr>
- <tr><td><code><regex></code> : </td><td>Eine gültige Regular Expression (regex or regexp) von dem Event wo der Zählerstand gefunden werden kann</td></tr>
- </table>
- </ul></ul>
- <table><tr><td><ul>Beispiel: <code>define myGasCalculator GasCalculator myGasCounter:countersA.*</code></ul></td></tr></table>
- <BR>
- <table>
- <tr><td><a name="GasCalculatorSet"></a><b>Set</b></td></tr>
- <tr><td>
- <ul>
- Die set - Funktion erlaubt individuelle Readings zu verändern um beispielsweise nach einem Stromausfall Werte zu korrigieren.<BR>
- Die set - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.<BR>
- Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit <code>set</code> - Befehl gesetzt werden.<BR>
- </ul>
- </td></tr>
- </table>
- <BR>
- <table>
- <tr><td><a name="GasCalculatorGet"></a><b>Get</b></td></tr>
- <tr><td>
- <ul>
- Die get - Funktion liefert nur den Wert des jeweiligen Readings zurück.<BR>
- Die get - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.<BR>
- Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit <code>get</code> - Befehl ausgelesen werden.<BR>
- </ul>
- </td></tr>
- </table>
- <BR>
- <table>
- <tr><td><a name="GasCalculatorAttr"></a><b>Attributes</b></td></tr>
- <tr><td>
- <ul>
- Sollten die unten ausfeg&auuml;hrten Attribute bei der Definition eines entsprechenden Gerätes nicht gesetzt sein, so werden sie vom Modul mit Standard Werten automatisch gesetzt<BR>
- Zusätzlich können die globalen Attribute wie <a href="#room">room</a> verwendet werden.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>BasicPricePerAnnum</code> : </li></td><td> Eine gültige float Zahl für die jährliche Grundgebühr in der gewählten Währung für die Gas-Versorgung zum End-Verbraucher.<BR>
- Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.<BR>
- Der Standard Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>Currency</code> : </li></td><td> Eines der vordefinerten Währungssymbole: [€,£,$].<BR>
- Der Standard Wert ist €<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>disable</code> : </li></td><td> Deaktiviert das devive. Das Modul wird nicht mehr auf die Events reagieren die durch die Regular Expression definiert wurde.<BR>
- Der Standard Wert ist 0 = ativiert.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>GasCounterOffset</code> : </li></td><td> Eine gültige float-Zahl für den Volumen Unterschied = Offset (Nicht der Unterschied zwischen Zählimpulsen) zwischen dem am mechanischen Gaszähler und dem angezeigten Wert im Reading dieses Device.<BR>
- Der Offset-Wert wird wie folgt ermittelt: V<sub>Offset</sub> = V<sub>Mechanisch</sub> - V<sub>Module</sub><BR>
- Der Standard-Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>GasCubicPerCounts</code> : </li></td><td> Eine gültige float-Zahl für die Menge an Zählimpulsen pro gewählter Volumen-Grundeinheit.<BR>
- Der Wert ist durch das mechanische Zählwerk des Gaszählers vorgegeben. GasCubicPerCounts = 0.01 bedeutet, dass jeder Zählimpuls ein hunderstel der gewählten Volumengrundeinheit.<BR>
- Der Standard-Wert ist 0.01<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>GasNominalHeatingValue</code> : </li></td><td> Eine gültige float-Zahl für den Heizwert des gelieferten Gases in [kWh/ gewählter Volumeneinheit].<BR>
- Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.<BR>
- Der Standard-Wert ist 10.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>GaszValue</code> : </li></td><td> Eine gültige float-Zahl für die Zustandszahl des Gases basierend auf der Relation based on the local installation of the mechganical gas meter in relation of the gas providers main supply station.<BR>
- Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.<BR>
- Der Standard-Wert ist 1.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>GasPricePerKWh</code> : </li></td><td> Eine gültige float-Zahl für den Gas Preis in der gewählten Währung pro kWh.<BR>
- Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.<BR>
- Der Standard-Wert ist 0.0654<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>MonthlyPayment</code> : </li></td><td> Eine gültige float-Zahl für die monatlichen Abschlagszahlungen in der gewählten Währung an den Gas-Lieferanten.<BR>
- Der Standard-Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>MonthOfAnnualReading</code> : </li></td><td> Eine gültige Ganz-Zahl für den Monat wenn der mechanische Gas-Zähler jedes Jahr durch den Gas-Lieferanten abgelesen wird.<BR>
- Der Standard-Wert ist 5 (Mai)<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ReadingDestination</code> : </li></td><td> Eines der vordefinerten Device als Ziel der errechneten Readings: [CalculatorDevice,CounterDevice].<BR>
- Das CalculatorDevice ist das mit diesem Modul erstellte Device.<BR>
- Das CounterDevice ist das Device von welchem der mechanische Zähler ausgelesen wird.<BR>
- Der Standard-Wert ist CalculatorDevice.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>Volume</code> : </li></td><td> Eine der vordefinierten Volumensymbole für die Volumeneinheit [m³,ft³].<BR>
- Der Standard-Wert ist m³<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="GasCalculatorReadings"></a><b>Readings</b></td></tr>
- <tr><td>
- <ul>
- Sobald das Device in der Lage war mindestens 2 Werte des Zählers einzulesen, werden automatisch die entsprechenden Readings erzeugt:<BR>
- Der Platzhalter <code><DestinationDevice></code> steht für das Device, welches man in dem Attribut <code>ReadingDestination</code> oben festgelegt hat. Dieser Platzhalter bleibt leer, sobald man dort CalculatorDevice ausgewählt hat.<BR>
- Der Platzhalter <code><SourceCounterReading></code> steht für das Reading welches mit der Regular Expression definiert wurde.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostLastDay</code> : </li></td><td>Energiekosten in der gewählten Währung des letzten Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMeter</code> : </li></td><td>Energiekosten in der gewählten Währung seit Anfang des Monats wo der Gas-Versorger den Zähler abliest.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast</code> : </li></td><td>Energiekosten in der gewählten Währung der letzten Zählperiode des Gas-Versorgers.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMonth</code> : </li></td><td>Energiekosten in der gewählten Währung seit Anfang des Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast</code> : </li></td><td>Energiekosten in der gewählten Währung des letzten Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostYear</code> : </li></td><td>Energiekosten in der gewählten Währung seit Anfang des Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast</code> : </li></td><td>Energiekosten in der gewählten Währung des letzten Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyDay</code> : </li></td><td>Energieverbrauch in kWh seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyDayLast</code> : </li></td><td>Gesamter Energieverbrauch des letzten Tages (Gestern).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMeter</code> : </li></td><td>Energieverbrauch in kWh seit Anfang seit Anfang des Monats wo der Gas-Versorger den Zähler abliest.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMeterLast</code> : </li></td><td>Gesamter Energieverbrauch der letzten Zählerperiode des Gas-Versorgers.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMonth</code> : </li></td><td>Energieverbrauch in kWh seit Anfang seit Anfang des Monats (Mitternacht des 01.).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyMonthLast</code> : </li></td><td>Gesamter Energieverbrauch im letzten Monat.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyYear</code> : </li></td><td>Energieverbrauch in kWh seit Anfang seit Anfang des Jahres (Mitternacht des 01. Januar).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_EnergyYearLast</code> : </li></td><td>Gesamter Energieverbrauch in kWh des letzten Kalender-Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_FinanceReserve</code> : </li></td><td>Finanzielle Reserve basierend auf den Abschlagszahlungen die jeden Monat an den Gas-Versorger gezahlt werden. Bei negativen Werten ist von einer Nachzahlung auszugehen.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_MonthMeterReading</code> : </li></td><td>Anzahl der Monate seit der letzten Zählerablesung. Der Monat der Zählerablesung ist der erste Monat = 1.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_Meter</code> : </li></td><td>Zählerstand am Gaszähler. Bei Differenzen muss das Offset-Attribut korrigiert werden.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerCurrent</code> : </li></td><td>Aktuelle Heizleistung. (Mittelwert zwischen aktueller und letzter Messung)<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerDayAver</code> : </li></td><td>Mittlere Heitzleistung seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerDayMax</code> : </li></td><td>Maximale Leistungsaufnahme seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_PowerDayMin</code> : </li></td><td>Minimale Leistungsaufnahme seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_Vol1stDay</code> : </li></td><td>Erster Volumenmesswert des Tages (Mitternacht).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_VolLastDay</code> : </li></td><td>Verbrauchtes Volumen des vorherigen Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_Vol1stMonth</code> : </li></td><td>Erster Volumenmesswert des Monats (Mitternacht des 01.).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_VolLastMonth</code> : </li></td><td>Verbrauchtes Volumen des vorherigen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_Vol1stYear</code> : </li></td><td>Erster Volumenmesswert des Jahres (Mitternacht des 01. Januar).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_VolLastYear</code> : </li></td><td>Verbrauchtes Volumen des vorherigen Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_Vol1stMeter</code> : </li></td><td>Erster Volumenmesswert des Zeitraums seit Anfang des Monats wo der Gas-Versorger den Zähler abliest.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_VolLastMeter</code> : </li></td><td>Verbrauchtes Volumen des vorherigen Abrechnungszeitraums.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- </ul>
- <p><a name="GoogleAuth"></a>
- <h3>GoogleAuth</h3>
- <div class='langLinks'>[<a href='commandref.html#GoogleAuth'>EN</a> DE]</div>
- <ul>
- Sorry, keine deutsche Dokumentation vorhanden.<br/><br/>
- Die englische Doku gibt es hier: <a href='commandref.html#GoogleAuth'>GoogleAuth</a><br/>
- </ul>
- <p><a name="HCS"></a>
- <h3>HCS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HCS'>HCS</a><br/>
- </ul>
- <a name="HEATRONIC"></a>
- <h3>HEATRONIC</h3>
- <div class='langLinks'>[<a href='commandref.html#HEATRONIC'>EN</a> DE]</div>
- <ul>
- Das HEATRONIC Modul wertet die Nachrichten aus, die über den HT-Bus von einer Junkers-Heizung übertragen werden.<br/>
- Mögliche Adapter werden unter http://www.mikrocontroller.net/topic/317004 vorgestellt.<br/><br/>
-
- <a name="HEATRONIC_Define"></a>
- <B>Define:</B><br/>
- <ul><code>define <name> HEATRONIC <serial-device> | <proxy-server IP-Adresse:port></code><br/><br/>
-
- <B>Beispiel für serielles Gerät:</B></br>
- <ul>
- <code> define Heizung HEATRONIC /dev/ttyUSB0@9600</code>
- </ul><br/>
- <B>Beispiel für Proxy-Server:</B></br>
- <ul>
- <code> define Heizung HEATRONIC 192.168.2.11:8088</code>
- </ul></ul><br/>
- <a name="HEATRONIC_set"><b>Set:</b></a>
- <ul>
- <code>set <name> <param> <value></code>
- <br><ul>(nur mit ht_pitiny- oder ht_piduino-Adapter möglich)</ul>
- <br>
- wobei die Parameter folgende Werte haben:
- <ul>
- <li>hc1_Trequired <temp><br>
- Setzt das 'Heizen' Temperatur-Niveau für Heizkreis 1 (permanent)<br>
- Auflösung 0.5 Celsius, Bereich: 10 bis 30 Celsius
- </li>
- <li>hc1_mode [ auto | comfort | eco | frost ]<br>
- Setzt die Betriebsart des Heizkreises 1<br>
- <ul>
- <li>auto : Das Timerprogramm und die Sommerzeit-Umschaltung sind aktiv </li>
- <li>comfort: Manueller 'comfort' Mode, Timerprogramm deaktiv</li>
- <li>eco : Manueller 'eco' Mode, Timerprogramm deaktiv</li>
- <li>frost : Manueller 'frost' Mode, Timerprogramm deaktiv</li>
- </ul></li>
- </ul>
- <br>
- Beispiele:
- <ul>
- <code>set Boiler hc1_Trequired 22.5</code><br>
- <code>set Boiler hc1_mode eco</code>
- </ul>
- <br>
- </ul>
- <br>
- <a name="HEATRONIC_attributes"><b>Attributes:</b></a>
- <ul>
- <li><B>interval_ch_time, interval_ch_Tflow_measured, interval_dhw_Tmeasured, interval_dhw_Tcylinder</B><br/>
- Intervall (in Sekunden) zum Update der entsprechenden Werte
- </li><br/>
- <li><B>minDiff_ch_Tflow_measured</B><br/>
- Minimaldifferenz (in Grad, z.B. 0.2) zum Update der entsprechenden Werte
- </li><br/>
- </ul>
-
- <a name="HEATRONIC_readings"><b>Readings:</b></a>
- <ul>
- <li><B>ch_Tflow_desired</B><br/>
- benötigte Vorlauf-Temperatur (im Warmwasser-Modus max. Kesseltemperatur)
- </li><br/>
- <li><B>ch_Tflow_measured</B><br/>
- aktuell gemessene Vorlauf-Temperatur
- </li><br/>
- <li><B>ch_Treturn</B><br/>
- aktuell gemessene Rücklauf-Temperatur
- </li><br/>
- <li><B>ch_Tmixer</B><br/>
- aktuell gemessene Mischer-Temperatur
- </li><br/>
- <li><B>ch_mode</B><br/>
- aktueller Betriebsmodus (0=aus, 1=Heizen, 2=Warmwasser)
- </li><br/>
- <li><B>ch_code</B><br/>
- aktueller Betriebs-Code oder erweiterter Störungs-Code (siehe Heizungs-Anleitung)
- </li><br/>
- <li><B>ch_code</B><br/>
- Störungs-Code (siehe Heizungs-Anleitung)
- </li><br/>
- <li><B>ch_burner_fan</B><br/>
- Status Brenner-Gebläse (0=aus, 1=läuft)
- </li><br/>
- <li><B>ch_burner_operation</B><br/>
- Brenner-Status (0=off, 1=an)
- </li><br/>
- <li><B>ch_pump_heating</B><br/>
- Status der Heizungspumpe(0=aus, 1=läuft)
- </li><br/>
- <li><B>ch_pump_cylinder</B><br/>
- Status der Speicherladepumpe (0=aus, 1=läuft)
- </li><br/>
- <li><B>ch_pump_circulation</B><br/>
- Status der Zirkulationspumpe (0=aus, 1=läuft)
- </li><br/>
- <li><B>ch_burner_power</B><br/>
- Brennerleistung in Prozent
- </li><br/>
- <li><B>ch_pump_heating_power</B><br/>
- Leistung der Heizungspumpe in Prozent
- </li><br/>
-
- <li><B>ch_Toutside</B><br/>
- Außentemperatur
- </li><br/>
- <li><B>ch_runtime_total</B><br/>
- Brennerlaufzeit in Minuten (Heizen und Warmwasser)
- </li><br/>
- <li><B>ch_runtime_ch</B><br/>
- Brennerlaufzeit in Minuten (nur Heizen)
- </li><br/>
- <li><B>ch_runtime_dhw</B><br/>
- Brennerlaufzeit in Minuten (nur Warmwasser)
- </li><br/>
- <li><B>ch_starts_tot</B><br/>
- Anzahl der Brennerstarts (Heizen und Warmwasser)
- </li><br/>
- <li><B>ch_starts_ch</B><br/>
- Anzahl der Brennerstarts (nur Heizen)
- </li><br/>
- <li><B>ch_starts_dhw</B><br/>
- Anzahl der Brennerstarts (nur Warmwasser)
- </li><br/>
- <li><B>ch_time</B><br/>
- Systemzeit der Heizung
- </li><br/>
-
- <li><B>hc1_Tdesired .. hc4_Tdesired</B><br/>
- benötigte Raumtemperatur Heizkreis 1-4
- </li><br/>
- <li><B>hc1_Tmeasured .. hc4_Tmeasured</B><br/>
- aktuell gemessene Raumtemperatur Heizkreis 1-4
- </li><br/>
- <li><B>hc1_Tmode .. hc4_Tmode</B><br/>
- Betriebsmodus Heizkreis 1-4
- </li><br/>
- <li><B>dhw_Tdesired</B><br/>
- benötigte Warmwasser-Temperatur
- </li><br/>
- <li><B>dhw_Tmeasured</B><br/>
- aktuell gemessene Warmwasser-Temperatur
- </li><br/>
- <li><B>dhw_Tcylinder</B><br/>
- aktuell gemessene Warmwasser-Temperatur Speicher oben
- </li><br/>
- <li><B>sol_Tcollector</B><br/>
- Temperatur Kollektorgruppe 1
- </li><br/>
- <li><B>sol_Tcylinder_bottom</B><br/>
- Temperatur Solarspeicher unten
- </li><br/>
- <li><B>sol_yield_last_hour</B><br/>
- Kollektorertrag der letzten Stunde
- </li><br/>
- <li><B>sol_yield_2</B><br/>
- Der Wert ist noch nicht bekannt. Der Name kann sich noch ändern.
- </li><br/>
- <li><B>sol_pump</B><br/>
- Status der Solarpumpe (0=off, 1=läuft)
- </li><br/>
- <li><B>sol_runtime</B><br/>
- Laufzeit der Solarpumpe in Minuten
- </li><br/>
- </ul>
- </ul>
- <p><a name="HEOSGroup"></a>
- <h3>HEOSGroup</h3>
- <div class='langLinks'>[<a href='commandref.html#HEOSGroup'>EN</a> DE]</div>
- <ul>
- <u><b>HEOSGroup</b></u>
- <br><br>
- In Kombination mit HEOSMaster and HEOSPlayer steuert dieses FHEM Modul das Denon Multiroom-Soundsystem mit Hilfe einer telnet Socket-Verbindung und dem HEOS Command Line Interface (CLI).
- <br><br>
- Nachdem der Master einmal angelegt ist werden die Player und Gruppierungen des Systems automatisch erkannt und in FHEM angelegt. Von da an können die Player und Gruppierungen gesteuert werden und Veränderungen in der HEOS App oder am Reveiver werden mit dem Status und den Media Readings der Player und Gruppierungen synchronisiert.
- <br>
- <br>
- Gruppierungen können aus einem Player heraus mit "groupWithMember" erzeugt werden.
- <br><br>
- Beispiel:
- <ul><br>
- <code>set Wohnzimmer groupWithMember Küche</code><br>
- </ul>
- <br>
- ... erzeugt eine Gruppierung namens "Wohnzimmer+Küche" mit dem Player "Wohnzimmer" als Leader und dem Player "Küche" als Mitglied.
- <a name="HEOSGroupreadings"></a>
- <br><br>
- <b>Readings</b>
- <ul>
- <li>channel - Nr des gerade abgespielten Favoriten</li>
- <li>currentAlbum - Name des gerade abgespielten Albums</li>
- <li>currentArtist - Name des gerade abgespielten Künstlers</li>
- <li>currentImageUrl - URL des Albumcovers, Senderlogos, etc.</li>
- <li>currentMedia - Medientyp des gerade abgespielten Streams (song|station|genre|artist|album|container)</li>
- <li>currentMid - media ID</li>
- <li>currentQid - queue ID</li>
- <li>currentSid - source ID</li>
- <li>currentStation - Name des gerade abgespielten Senders</li>
- <li>currentTitle - Name des gerade abgespielten Titels</li>
- <li>error - letzte Fehlermeldung</li>
- <li>gid - Gruppen-ID</li>
- <li>leader - Leader der Gruppierung</li>
- <li>member - Mitglied(er) der Gruppierung</li>
- <li>mute - Player mute Status (on|off)</li>
- <li>name - Name der Gruppierung</li>
- <li>playStatus - Status des Players (play|pause|stop)</li>
- <li>repeat - Player Repeat Status (on_all|on_one|off) </li>
- <li>shuffle - Player Shuffle Status (on|off)</li>
- <li>state - Status der Player-Verbindung (on|off)</li>
- <li>volume - aktuelle Lautstärke (0-100)</li>
- <li>volumeDown - Schrittweite Lautstärke (1-10, default 5)</li>
- <li>volumeUp - Schrittweite Lautstärke (1-10, default 5)</li>
- </ul>
- <br><br>
- <a name="HEOSGroupset"></a>
- <b>set</b>
- <ul>
- <li>channel <nr> - spielt den vorher mit der App erstellten Favoriten <nr> ab</li>
- <li>channelUp - schaltet auf den nächsten Favoriten in der Favoritenliste um</li>
- <li>channelDown- schaltet auf vorherigen Favoriten in der Favoritenliste um</li>
- <li>clearGroup - Auflösen der Gruppierung (setzt state auf off)</li>
- <li>getGroupInfo - holt die Media-Informationen der Gruppierung</li>
- <li>mute on|off - setze den mute Status on|off</li>
- <li>next - spielt nächsten Titel in Warteschlange</li>
- <li>pause - setzt den Status des Players auf "pause"</li>
- <li>play - setzt den Status des Players auf "play"</li>
- <li>playPlaylist <myList> - spielt die Playlist <myList> ab</li>
- <li>prev - spielt vorherigen Titel in Warteschlange</li>
- <li>repeat - setzt den Player Repeat Status (on_all|on_one|off) </li>
- <li>shuffle - setzt den Player Shuffle Status auf on|off</li>
- <li>stop - setzt den Status des Players auf "stop"</li>
- <li>volume - setzt die Lautstärke auf 0..100</li>
- <li>volumeDown - verringert die Lautstärke um <volumeDown></li>
- <li>volumeUp - erhöht die Lautstärke um <volumeUp></li>
- </ul>
- <br><br>
- <a name="HEOSGroupstate"></a>
- <b>state</b>
- <ul>
- <li>Status der Gruppierung (on|off)</li>
- </ul>
- </ul>
- <p><a name="HEOSMaster"></a>
- <h3>HEOSMaster</h3>
- <div class='langLinks'>[<a href='commandref.html#HEOSMaster'>EN</a> DE]</div>
- <ul>
- <u><b>HEOSMaster</b></u>
- <br><br>
- In Kombination mit HEOSPlayer und HEOSGroup steuert dieses FHEM Modul das Denon Multiroom-Soundsystem mit Hilfe einer telnet Socket-Verbindung und dem HEOS Command Line Interface (CLI).
- <br><br>
- <b>Voraussetzung</b>
- <ul>
- <li>Installation der folgenden Pakete: apt-get install libjson-perl libnet-telnet-perl libencode-perl
- </li>
- </ul>
- <br>
- <a name="HEOSMasterdefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> HEOSMaster <IP address></code>
- <br><br>
- Example:
- <ul><br>
- <code>define MyMasterBox HEOSMaster 192.168.178.67</code><br>
- </ul>
- <br>
- <IP address> ist die IP-Adresse des HEOS Receivers oder der HEOS Box. Das Master Device wird im Raum HEOS angelegt und danach erfolgt das Einlesen und automatische Anlegen der Player.
- Von nun an können die Player gesteuert werden. Außerdem wird der Status und die Media Readings der Player entsprechend geändert, wenn man in der HEOS-App oder direkt am Receiver etwas ändert.
- <a name="HEOSMasterreadings"></a>
- <br><br>
- <b>Readings</b>
- <ul>
- <li>enableChangeEvents - Status der Event Wiedergabe auf dem CLI Master</li>
- <li>heosAccount - signed_out | signed_in as <HEOSAccount></li>
- <li>lastCommand - zuletzt ausgeführtes Kommando</li>
- <li>lastPlayerId - Player-Id des Geräts, welches das Kommando ausgeführt hat</li>
- <li>lastPlayerName - Player-Name des Geräts, welches das Kommando ausgeführt hat</li>
- <li>lastResult - Ergebnis des zuletzt ausgeführten Kommandos</li>
- <li>state - Status des HEOSMaster</li>
- </ul>
- <br><br>
- <a name="HEOSMasterset"></a>
- <b>set</b>
- <ul>
- <li>checkAccount - prüft das HEOS Konto</li>
- <li>enableChangeEvents - aktiviert die Event Wiedergabe auf dem CLI Master</li>
- <li>getGroups - holt eine Liste aller Gruppen und legt die Devices an, sofern noch nicht geschehen</li>
- <li>getPlayers - holt eine Liste aller Player und legt die Devices an, sofern noch nicht vorhanden</li>
- <li>password - setzt das Passwort des HEOS Kontos</li>
- <li>reboot - rebootet das CLI Interface am Master</li>
- <li>reopen - versucht eine neue Socket-Verbindung zum CLI Master aufzubauen</li>
- <li>signAccount In|Out - anmelden|abmelden am HEOS Konto (attr MyMasterBox heosUsername <username>)</li>
- </ul>
- <br><br>
- <a name="HEOSMasterget"></a>
- <b>get</b>
- <ul>
- <li>ShowAccount - zeigt das HEOS Konto an</li>
- </ul>
- <br><br>
- <a name="HEOSMasterstate"></a>
- <b>state</b>
- <ul>
- <li>connected - der HEOSmaster ist mit dem CLI Master verbunden</li>
- <li>not connected - der HEOSmaster ist nicht mit dem CLI Master verbunden</li>
- </ul>
- <br><br>
- <a name="HEOSMasterattributes"></a>
- <b>Attributes</b>
- <ul>
- <li>heosUsername - Benutzername des HEOS Kontos</li>
- </ul>
- <br><br>
- </ul>
- </ul>
- <p><a name="HEOSPlayer"></a>
- <h3>HEOSPlayer</h3>
- <div class='langLinks'>[<a href='commandref.html#HEOSPlayer'>EN</a> DE]</div>
- <ul>
- <u><b>HEOSPlayer</b></u>
- <br><br>
- In Kombination mit HEOSMaster and HEOSGroup steuert dieses FHEM Modul das Denon Multiroom-Soundsystem mit Hilfe einer telnet Socket-Verbindung und dem HEOS Command Line Interface (CLI).
- <br><br>
- Nachdem der Master einmal angelegt ist werden die Player und Gruppierungen des Systems automatisch erkannt und in FHEM angelegt. Von da an können die Player und Gruppierungen gesteuert werden und Veränderungen in der HEOS App oder am Reveiver werden mit dem Status und den Media Readings der Player und Gruppierungen synchronisiert.
- <a name="HEOSPlayerreadings"></a>
- <br><br>
- <b>Readings</b>
- <ul>
- <li>channel - Nr des gerade abgespielten Favoriten</li>
- <li>currentAlbum - Name des gerade abgespielten Albums</li>
- <li>currentArtist - Name des gerade abgespielten Künstlers</li>
- <li>currentImageUrl - URL des Albumcovers, Senderlogos, etc.</li>
- <li>currentMedia - Medientyp des gerade abgespielten Streams (song|station|genre|artist|album|container)</li>
- <li>currentMid - media ID</li>
- <li>currentQid - queue ID</li>
- <li>currentSid - source ID</li>
- <li>currentStation - Name des gerade abgespielten Senders</li>
- <li>currentTitle - Name des gerade abgespielten Titels</li>
- <li>error - letzte Fehlermeldung</li>
- <li>gid - ID der Gruppe, in der der Player Mitglied ist</li>
- <li>ip-address - IP-Adresse des Players</li>
- <li>lineout - lineout level type (variable|Fixed)</li>
- <li>model - Modell des HEOS Lautsprechers (z.B. HEOS 1)</li>
- <li>mute - Player mute Status (on|off)</li>
- <li>name - Name des Players (aus der App übernommen)</li>
- <li>network - Netzwerkverbindung (wired|wifi)</li>
- <li>playStatus - Status des Players (play|pause|stop)</li>
- <li>repeat - Player Repeat Status (on_all|on_one|off) </li>
- <li>shuffle - Player Shuffle Status (on|off)</li>
- <li>state - Status der Player-Verbindung (on|off)</li>
- <li>version - Softwareversion des HEOS Lautsprechers</li>
- <li>volume - aktuelle Lautstärke (0-100)</li>
- <li>volumeDown - Schrittweite Lautstärke (1-10, default 5)</li>
- <li>volumeUp - Schrittweite Lautstärke (1-10, default 5)</li>
- </ul>
- <br><br>
- <a name="HEOSPlayerset"></a>
- <b>set</b>
- <ul>
- <li>aux - aktiviert die Quelle am AUX-Eingang des Players</li>
- <li>channel <nr> - spielt den vorher mit der App erstellten Favoriten <nr> ab</li>
- <li>channelUp - schaltet auf den nächsten Favoriten in der Favoritenliste um</li>
- <li>channelDown- schaltet auf vorherigen Favoriten in der Favoritenliste um</li>
- <li>clear queue - löscht die Warteschlange</li>
- <li>deletePlaylist <myList> - löscht die Playlist <myList> </li>
- <li>set <hp1> groupWithMember <hp2> - erzeugt eine Gruppierung mit hp1 als Leader und hp2 als Mitglied</li>
- <li>input sid[,cid][,mid] - setze input source-id[,container-id][,media-id] </li>
- <ul>
- <code>Beispiel: set Küche input 1027,1772574848,inputs/tvaudio<br>
- startet "TV-Audio" auf dem Player "Küche"</code>
- </ul>
- <li>mute on|off - setzt den mute Status on|off</li>
- <li>next - spielt nächsten Titel in Warteschlange</li>
- <li>pause - setzt den Status des Players auf "pause"</li>
- <li>play - setzt den Status des Players auf "play"</li>
- <li>playPlaylist <myList> - spielt die Playlist <myList> ab</li>
- <li>playQueueItem <nr> - spielt Titel <nr> in Warteschlange</li>
- <li>prev - spielt vorherigen Titel in Warteschlange</li>
- <li>repeat - setzt den Player Repeat Status (on_all|on_one|off) </li>
- <li>saveQueue <myList> - speichert die Warteschlange als Playlist <myList></li>
- <li>shuffle - setzt den Player Shuffle Status auf on|off</li>
- <li>stop - setzt den Status des Players auf "stop"</li>
- <li>volume - setzt die Lautstärke auf 0..100</li>
- <li>volumeDown - verringert die Lautstärke um <volumeDown></li>
- <li>volumeUp - erhöht die Lautstärke um <volumeUp></li>
- </ul>
- <br><br>
- <a name="HEOSPlayerget"></a>
- <b>get</b>
- <ul>
- <li>ls - listet Musikquellen (Eingänge, Playlists, Favoriten, Musik-Dienste, ...)</li>
- <li>channelscount - Anzahl der Favoriten</li>
- </ul>
- <br><br>
- <a name="HEOSPlayerstate"></a>
- <b>state</b>
- <ul>
- <li>Status der Player-Verbindung (on|off)</li>
- </ul>
- <br><br>
- <a name="HEOSPlayerattributes"></a>
- <b>attributes</b>
- <ul>
- <li>channelring - Beim Erreichen des letzten Favoriten schaltet ChannelUp/Down im Kreis, also wieder auf den ersten/letzten Favoriten</li>
- <li>mute2play - Beim Betätigen der Mute-Taste am Lautsprecher wird auch der Stream angehalten</li>
- </ul>
- </ul>
-
- <p><a name="HMCCU"></a>
- <h3>HMCCU</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HMCCU'>HMCCU</a><br/>
- </ul>
- <a name="HMCCUCHN"></a>
- <h3>HMCCUCHN</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HMCCUCHN'>HMCCUCHN</a><br/>
- </ul>
- <a name="HMCCUDEV"></a>
- <h3>HMCCUDEV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HMCCUDEV'>HMCCUDEV</a><br/>
- </ul>
- <a name="HMCCURPC"></a>
- <h3>HMCCURPC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HMCCURPC'>HMCCURPC</a><br/>
- </ul>
- <a name="HMCCURPCPROC"></a>
- <h3>HMCCURPCPROC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HMCCURPCPROC'>HMCCURPCPROC</a><br/>
- </ul>
- <a name="HMLAN"></a>
- <h3>HMLAN</h3>
- <div class='langLinks'>[<a href='commandref.html#HMLAN'>EN</a> DE]</div>
- <ul>
- Das HMLAN ist das fhem-Modul für den eQ-3 HomeMatic LAN Configurator welcher als IO
- in FHEM fungiert. Siehe <a href="http://www.fhemwiki.de/wiki/HM-CFG-LAN_LAN_Konfigurations-Adapter">HM-CFG-LAN_LAN_Konfigurations-Adapter</a> zur Konfiguration.<br>
- Eine weitere Beschreibung, wie der HomeMatic USB Konfigurations-Adapter
- <a href="https://git.zerfleddert.de/cgi-bin/gitweb.cgi/hmcfgusb">(HM-CFG-USB)</a>
- verwendet werden kann, ist unter dem angegebenen Link zu finden.<br/>
- <br>
- Dieses Gerät kann gleichzeitig mit einer CCU und (nur lesend) mit FHEM verwendet werden.
- Hierfür ist wie folgt vorzugehen:
- <ul>
- <li>Starten des fhem/contrib/tcptee.pl Programms</li>
- <li>Umleiten der CCU zum local host</li>
- <li>Ausschalten der LAN-Encryption auf der CCU für den LAN-Configurator</li>
- <li>Setzen des dummy Attributes für das HMLAN Gerät in FHEM</li>
- </ul>
- <br><br>
- <a name="HMLANdefine"><b>Define</b></a>
- <ul>
- <code>define <name> HMLAN <ip-address>[:port]</code><br>
- <br>
- Der Standard-Port lautet: 1000.<br/>
- Wenn keine IP-Adresse angegeben wird, wird auch kein Gerät geöffnet; man kann
- also auch ohne angeschlossene Hardware experimentieren.
- </ul>
- <br><br>
- <a name="HMLANset"><b>Set</b></a>
- <ul>
- <li><a href="#hmPairForSec">hmPairForSec</a></li>
- <li><a href="#hmPairSerial">hmPairSerial</a></li>
- <li><a href="#hmreopen">reopen</a>
- Connection zum IO device neu starten</li>
- <li><a href="#hmrestart">restart</a>
- Neustart des IOdevice
- </li>
- <li><a href="#HMLANset_reassignIDs">reassignIDs</a>
- Synchronisiert die im HMLAN eingetragenen IDs mit der von FHEM verwalteten Liste.
- I.a. findet dies automatisch statt, koennte aber in reset Fällen abweichen.
- </li>
- </ul>
- <br><br>
- <a name="HMLANget"><b>Get</b></a>
- <ul>
- <li><a href="#HMLANgetassignIDs">assignIDs</a>
- Gibt eine Liste aller diesem IO zugewiesenen IOs aus.
- </li>
- </ul>
- <br><br>
- <a name="HMLANattr"><b>Attributes</b></a>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li><br>
- <li><a href="#attrdummy">dummy</a></li><br>
- <li><a href="#addvaltrigger">addvaltrigger</a></li><br>
- <li><a href="#HMLANlogIDs">logIDs</a><br>
- Schaltet selektives Aufzeichnen der HMLAN Meldungen ein. Eine Liste der
- HMIds oder Namen, die aufgezeichnet werden sollen, können - getrennt durch
- Kommata - eingegeben werden.<br>
- Die Attribute erlauben ausschließlich die Angabe von Device-IDs und keine Kanal-IDs.
- Die Kanal-IDs werden automatisch in Device-IDs umgewandelt.<br>
- <b>all</b> zeichnet die Original-Meldungen für alle HMIds auf.<br>
- <b>sys</b> zeichnet alle systemrelevanten Meldungen wie keep-alive auf.<br>
- <b>all,sys</b> damit wird die Aufzeichnung aller Meldungen eingeschaltet<br>
- </li>
- <li><a name="HMLANloadLevel">loadLevel</a><br>
- loadlevel mapped den Auslastungslevel auf die Namen in ein Reading. <br>
- 0:low,30:mid,40:batchLevel,90:high,99:suspended<br>
- Der batchLevel Wert wird auf 40 gesetzt., sollte er fehlen.
- Das ist der Levelbei dem die Hintergrundnachrichten z.B. durch autoReadReg gestoppt werden<br>
- </li><br>
- <li><a href="#hmId">hmId</a></li><br>
- <li><a name="HMLANhmKey">hmKey</a></li><br>
- <li><a name="HMLANhmKey2">hmKey2</a></li><br>
- <li><a name="HMLANhmKey3">hmKey3</a></li><br>
- <li><a name="HMLANhmKey4">hmKey4</a></li><br>
- <li><a name="HMLANhmKey5">hmKey5</a><br>
- AES Schlüssel für den HMLAN Adapter. <br>
- Der Schlüssel wird in eine hash-Zeichenfolge umgewandelt. Wenn eine Hash-Folge unmittelbar
- eingegeben wird, erfolgt keine Umwandlung, sondern eine eine direkte Benutzung der Hash-Folge.
- Deshalb kann der Originalschlüssel auch nicht entschlüsselt werden.<br>
- </li>
- <li><a href="#hmProtocolEvents">hmProtocolEvents</a></li><br>
- <li><a name="HMLANrespTime">respTime</a><br>
- Definiert die maximale Antwortzeit des HMLAN-Adapters in Sekunden. Standardwert ist 1 Sekunde.<br/>
- Längere Zeiten können übergangsweise in langsamen und instabilen Systemen oder in
- LAN-Konfigurationen verwendet werden.</li>
- <li><a name="HMLAN#wdTimer">wdTimer</a><br>
- Zeit in Sekunden, um den HMLAN zu triggern. Werte zwischen 5 und 25 sind zulässig.
- Standardwert ist 25 Sekunden.<br>
- Es wird <B>davon abgeraten</B> diesen Timer zu verändern. Wenn Probleme mit
- HMLAN-Abbrüchen bestehen wird empfohlen die Ursache des Problems zu finden
- und zu beheben und nicht die Symptom.</li>
- <li><a name="HMLANhmLanQlen">hmLanQlen</a><br>
- Definiert die Länge der Warteschlange des HMLAN Interfaces. Es ist deshalb die Anzahl
- der gleichzeitig zu sendenden Meldungen. Erhöhung des Wertes kann eine Steigerung der
- Übertragungsgeschwindigkeit verursachen, ebenso können wiederholte Aussendungen
- Datenverlust bewirken.<br>
- Die Auswirkungen werden durch die Ereignisse im Protokoll sichtbar.<br>
- 1 - ist ein Wert auf der sicheren Seite und deshalb der Standardwert<br>
- 5 - ist eine kritische Länge und verursacht wahrscheinlich Meldungsverluste</li>
- </ul>
- <a name="HMLANparameter"><b>parameter</b></a>
- <ul>
- <li><B>assignedIDsCnt</B><br>
- Anzahl der IDs, die von FHEM einem HMLAN zugeordnet sind.
- Sollte die Anzahl von der im HMLAN abweichen wird dies als 'reported' gemeldet.<br>
- Wird eine Abweichung festgestellt kann man mit dem Kommando assignIDs das HMLAN synchronisieren.
- </li>
- <li><B>msgKeepAlive</B><br>
- Güte der keep-alive Meldungen. <br>
- <B>dlyMax</B>: maximale Verzögerungsdauer zwischen dem geplanten Meldungszeitpunkt
- und der tatsächlich gesendeten Meldung.<br>
- <B>bufferMin</B>: minimal verfügbarer Speicher bevor HMLAN voraussichtlich
- unterbrochen wird bedingt durch die fehlende keepAlive Meldung. bufferMin
- wird auf 30 Sekunden zurückgesetzt wenn das Attribut wdTimer verändert wird.<br>
- Wenn dlyMax hoch ist (mehrere Sekunden) oder bufferMin geht gegen "0" (normal ist 4)
- leidet das System unter den internen Verzögerungen. Den Gründen hierfür muss
- nachgegangen werdensystem. Als schnelle Lösung kann der Wert für wdTimer
- verkleinert werden, um HMLAN schneller zu triggern.</li>
- <li><B>msgLoadCurrent</B><br>
- Aktuelle Funklast des HMLAN. Da HMLAN nur eine begrenzte Kapzität je Stunde hat
- Telegramme abzusetzen stellt es bei 100% das Senden ein. Siehe auch
- <a href="#loadLevel">loadLevel</a><br></li>
- <li><B>msgLoadHistoryAbs</B><br>
- IO Funkbelastung vergangener Zeitabschnitte.</li>
- <li><B>msgParseDly</B><br>
- Kalkuliert die Verzögerungen einer Meldung vom Zeitpunkt des Abschickens im HMLAN
- bis zu Verarbeitung in FHEM. Deshalb ist dies ein Indikator für die Leistungsfähigkeit
- des Systems von FHEM.
- </li>
- </ul>
- <a name="HMLANreadings"><b>Parameter und Readings</b></a>
- <ul>
- <li><B>prot_disconnect</B> <br>letzter HMLAN disconnect</li>
- <li><B>prot_init</B> <br>letzter HMLAN init</li>
- <li><B>prot_keepAlive</B> <br>HMLAN unterbrochen, wahrscheinlich um langsame
- keep-alive Meldungen zu senden.</li>
- <li><B>prot_ok</B> <br>letzte HMLAN ok Bedingung</li>
- <li><B>prot_timeout</B> <br>letzter HMLAN Timeout</li>
- <li><B>prot_Warning-HighLoad</B> <br>hohe Auslastung erreicht -
- HMLAN hat nur noch 10% seiner Leistungsfähigkeit übrig</li>
- <li><B>prot_ERROR-Overload</B> <br>Überlastung -
- HMLAN wird zwar Meldungen empfangen aber keine Meldungen mehr absenden</li>
- <li><B>prot_Overload-released</B><br>Überlastung beendet - normale Arbeitsweise ist möglich</li>
- </ul>
- </ul>
- <p><a name="HMS"></a>
- <h3>HMS</h3>
- <div class='langLinks'>[<a href='commandref.html#HMS'>EN</a> DE]</div>
- <ul>
- <a name="HMSdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> HMS <housecode></code>
- <br><br>
- Der <code><housecode></code> ist eine vierstellige HEX-Zahl,
- entsprechend dem HMS Gerät.<br>
- Beispiel:
- <ul>
- <code>define temp HMS 1234</code><br>
- </ul>
- Hinweise:<br>
- <ul>
- <li>Derzeit werden folgende Komponenten Unterstützt: HMS100-T
- HMS100-TF HMS100-WD HMS100-MG HMS100-TFK HMS100-CO HMS100-FIT RM100-2
- RM100-3</li>
- <li>Der Hauscode kann sich ändern wenn die Batterie gewechselt wird.
- Um sich das Leben einfacher zu machen kann man ein "Wildcard"
- (Platzhalter) Device für jeden Typ von HMS Gerät anlegen.
- Zuerst wird die echte Device-ID geprüft, danach die Wildcard-ID.
- Wildcards sind:
- <ul>
- <li>1000 für das HMS100-TF</li>
- <li>1001 für das HMS100-T</li>
- <li>1002 für das HMS100-WD</li>
- <li>1003 für das RM100-2</li>
- <li>1004 für das HMS100-TFK</li>
- <li>1006 für das HMS100-MG</li>
- <li>1008 für das HMS100-CO</li>
- <li>100e für das HMS100-FIT</li>
- </ul>
- </li>
- <li>Einige "Batteriestand niedrig" Benachrichtigungen sind noch nicht
- implemeniert (RM100, HMS100WD).</li>
- <li>Die Installation ist zu testen bevor man sich auf die
- Funktionalität verlässt.</li>
- </ul>
- <br>
- </ul>
- <br>
- <a name="HMSset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="HMSget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="HMSattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#model">model</a> (hms100-t hms100-tf hms100-wd hms100-mg
- hms100-co hms100-tfk hms100-fit rm100-2)</li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="HMUARTLGW"></a>
- <h3>HMUARTLGW</h3>
- <div class='langLinks'>[<a href='commandref.html#HMUARTLGW'>EN</a> DE]</div>
- <ul>
- Das Modul HMUARTLGW ermöglicht die Anbindung des eQ-3 HomeMatic Wireless
- LAN Gateways (HM-LGW-O-TW-W-EU) und des eQ-3 HomeMatic UART Moduls
- (HM-MOD-UART), welches Teil des HomeMatic-Moduls für den Raspberry Pi
- (HM-MOD-RPI-PCB) ist.<br>
- <br><br>
- <a name="HMUARTLGHW_define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> HMUARTLGW <device></code><br><br>
- Der Parameter <device> hängt vom eingesetzten Gerätetyp ab:
- <ul>
- <li>HM-MOD-UART: <device> ist die zu benutzende serielle
- Schnittstelle. Die Baudrate ist fest auf 115200 eingestellt und muss
- nicht angegeben werden.<br>
- Falls der HM-MOD-UART über einen Seriell-zu-Ethernet-Konverter
- mit dem Netzwerk verbunden ist, muss die Definition in einem
- an URLs angelehnten Format geschehen
- (<code>uart://ip:port</code>).</li>
- <li>HM-LGW-O-TW-W-EU: <device> gibt die IP-Adresse oder den
- Hostnamen des Gateways an, optional gefolgt von einem Doppelpunkt
- und der Portnummer des BidCos-Ports (Default falls nicht angegeben:
- 2000).</li>
- </ul>
- <br><br>
- Beispiele:<br>
- <ul>
- <li>Lokaler HM-MOD-UART an der Schnittstelle <code>/dev/ttyAMA0</code>:<br>
- <code>define myHmUART HMUARTLGW /dev/ttyAMA0</code><br> </li>
- <li>LAN Gateway mit der IP-Adresse <code>192.168.42.23</code>:<br>
- <code>define myHmLGW HMUARTLGW 192.168.42.23</code><br> </li>
- <li>Entfernter HM-MOD-UART unter Verwendung von <code>socat</code> auf einem Raspberry Pi:<br>
- <code>define myRemoteHmUART HMUARTLGW uart://192.168.42.23:12345</code><br><br>
- Entfernter Raspberry Pi:<br><code>$ socat TCP4-LISTEN:12345,fork,reuseaddr /dev/ttyAMA0,raw,echo=0,b115200</code></li>
- </ul>
- </ul>
- <br>
- <a name="HMUARTLGW_set"></a>
- <p><b>Set</b></p>
- <ul>
- <li>close<br>
- Schließt die Verbindung zum Gerät.
- </li>
- <li><a href="#hmPairForSec">hmPairForSec</a></li>
- <li><a href="#hmPairSerial">hmPairSerial</a></li>
- <li>open<br>
- Öffnet die Verbindung zum Gerät und initialisiert es.
- </li>
- <li>reopen<br>
- Schlißt und öffnet die Verbindung zum Gerät und re-initialisiert es.
- </li>
- <li>restart<br>
- Rebootet das Gerät.
- </li>
- <li>updateCoPro </path/to/firmware.eq3><br>
- Aktualisierung der Koprozessor-Firmware (Reading D-firmware) mit der
- angegebenen Datei. Quelle für Firmware-Images (Version 1.4.1,
- offizielles eQ-3 Repository):<br>
- <ul>
- <li>HM-MOD-UART: <a href="https://raw.githubusercontent.com/eq-3/occu/28045df83480122f90ab92f7c6e625f9bf3b61aa/firmware/HM-MOD-UART/coprocessor_update.eq3">coprocessor_update.eq3</a> (Version 1.4.1)</li>
- <li>HM-LGW-O-TW-W-EU: <a href="https://raw.githubusercontent.com/eq-3/occu/28045df83480122f90ab92f7c6e625f9bf3b61aa/firmware/coprocessor_update_hm_only.eq3">coprocessor_update_hm_only.eq3</a> (Version 1.4.1)<br>
- Bitte zusätzlich sicherstellen, dass die Version der
- D-LANfirmware mindestens 1.1.5 beträgt. Um auf diese Version
- zu aktualisieren können die eQ-3 CLI Tools (siehe Wiki) oder
- der eQ-3 Netfinder genutzt werden. Das passende Image ist:
- <a href="https://github.com/eq-3/occu/raw/28045df83480122f90ab92f7c6e625f9bf3b61aa/firmware/hm-lgw-o-tw-w-eu_update.eq3">hm-lgw-o-tw-w-eu_update.eq3</a><br>
- <b>Die Datei hm-lgw-o-tw-w-eu_update.eq3 nicht mit updateCoPro flashen!</b></li>
- </ul>
- </li>
- </ul>
- <br>
- <a name="HMUARTLGW_get"></a>
- <p><b>Get</b></p>
- <ul>
- <li>assignIDs<br>
- Gibt die aktuell diesem IO-Gerät zugeordneten HomeMatic-Geräte
- zurück.
- </li>
- </ul>
- <br>
- <a name="HMUARTLGW_attr"></a>
- <b>Attribute</b>
- <ul>
- <li>csmaCa<br>
- Aktiviert oder deaktiviert CSMA/CA (Carrier sense multiple access with
- collision avoidance), auch bekannt als Listen-Before-Talk.<br>
- Default: 0 (deaktiviert)
- </li>
- <li>dummy<br>
- Ermöglicht die Definition des Geräts ohne jegliche Interaktion
- mit einem physikalischen Gerät.<br>
- Default: nicht gesetzt
- </li>
- <li>dutyCycle<br>
- Aktiviert oder deaktiviert die Überprüfung des Arbeitszyklus
- (1%-Regel) durch das Sendemodul.<br>
- Die Abschaltung dieser Funktion kann in verschiedenen Ländern gegen
- das Gesetz verstossen, weshalb zuerst die Situation anhand lokaler
- Richtlinien zu prüfen ist!<br>
- Default: 1 (aktiviert)
- </li>
- <li><a href="#hmId">hmId</a></li>
- <li><a name="HMLANhmKey">hmKey</a></li>
- <li><a name="HMLANhmKey2">hmKey2</a></li>
- <li><a name="HMLANhmKey3">hmKey3</a></li>
- <li>lgwPw<br>
- AES-Passwort für das eQ-3 HomeMatic Wireless LAN Gateway. Das initiale
- Passwort befindet sich auf der Rückseite des Geräts, kann aber
- durch den Benutzer geändert werden. Falls die AES gesicherte
- Kommunikation aktiviert ist (Auslieferungszustand), muss dieses Attribut
- auf den richtigen Wert gesetzt werden, da ansonsten keine Kommunikation
- möglich ist. Zusätzlich muss das Perl-Modul Crypt::Rijndael
- (stellt den AES-Algorithmus bereit) installiert sein.
- </li>
- <li>loadEvents<br>
- Aktiviert die Erzeugung von Log-Nachrichten über die Funklast
- des Interfaces (in Prozent der erlaubten Sendezeit).
- Default: 0 (deaktiviert)
- </li>
- <li>logIDs<br>
- Aktiviert die gezielte Erzeugung von Log-Nachrichten. Der Parameter ist
- eine durch Komma getrennte Liste an HMIds oder HM Geräte-/Kanalnamen,
- deren Nachrichten aufgezeichnet werden sollen.<br>
- <ul>
- <li><i>all</i>: Zeichnet die Rohnachrichten aller HMIds auf</li>
- <li><i>sys</i>: Zeichnet Systemnachrichten (z.B. Keep-Alive) auf</li>
- </ul>
- Um alle möglichen Nachrichten aufzuzeichnen, kann <i>all,sys</i>
- genutzt werden.
- </li>
- <li>qLen<br>
- Maximale Anzahl an Kommandos in der internen Warteschlange des
- HMUARTLGW-Moduls. Neue Kommandos werden verworfen, wenn die Warteschlange
- gefüllt ist. Jedes Kommando hat eine Lebensdauer von 3s, sobald es
- aktiv verarbeitet wird. Die Verzögerung eines Kommandos beträgt
- im schlechtesten Fall also qLen * 3s (3 Minuten mit den Defaulteinstellungen).<br>
- Default: 60
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="HMinfo"></a>
- <h3>HMinfo</h3>
- <div class='langLinks'>[<a href='commandref.html#HMinfo'>EN</a> DE]</div>
- <ul>
- Das Modul HMinfo ermöglicht einen Überblick über eQ-3 HomeMatic Geräte, die mittels <a href="#CUL_HM">CUL_HM</a> definiert sind.<br><br>
- <B>Status Informationen und Zähler</B><br>
- HMinfo gibt einen Überlick über CUL_HM Installationen einschliesslich aktueller Zustände.
- Readings und Zähler werden aus Performance Gründen nicht automatisch aktualisiert. <br>
- Mit dem Kommando <a href="#HMinfoupdate">update</a> können die Werte aktualisiert werden.
- <ul><code><br>
- set hm update<br>
- </code></ul><br>
- Die Webansicht von HMinfo stellt Details über CUL_HM Instanzen mit ungewöhnlichen Zuständen zur Verfügung. Dazu gehören:
- <ul>
- <li>Action Detector Status</li>
- <li>CUL_HM Geräte und Zustände</li>
- <li>Ereignisse im Zusammenhang mit Kommunikationsproblemen</li>
- <li>Zähler für bestimmte Readings und Zustände (z.B. battery) - <a href="#HMinfoattr">attribut controlled</a></li>
- <li>Zähler für Readings, die auf Fehler hindeuten (z.B. overheat, motorErr) - <a href="#HMinfoattr">attribut controlled</a></li>
- </ul>
- <br>
- Weiterhin stehen HM Kommandos zur Verfügung, z.B. für das Speichern aller gesammelten Registerwerte.<br><br>
- Ein Kommando wird für alle HM Instanzen der kompletten Installation ausgeführt.
- Die Ausführung ist jedoch auf die dazugehörigen Instanzen beschränkt.
- So wird rssi nur auf Geräte angewendet, da Kanäle RSSI Werte nicht unterstützen.<br><br>
- <a name="HMinfoFilter"><b>Filter</b></a>
- <ul> werden wie folgt angewendet:<br><br>
- <code>set <name> <cmd> <filter> [<param>]</code><br>
- wobei sich filter aus Typ und Name zusammensetzt<br>
- [-dcasev] [-f <filter>]<br><br>
- <b>Typ</b> <br>
- <ul>
- <li>d - device :verwende Gerät</li>
- <li>c - channels :verwende Kanal</li>
- <li>v - virtual :unterdrücke virtuelle Instanz</li>
- <li>p - physical :unterdrücke physikalische Instanz</li>
- <li>a - aktor :unterdrücke Aktor</li>
- <li>s - sensor :unterdrücke Sensor</li>
- <li>e - empty :verwendet das Resultat auch wenn die Felder leer sind</li>
- <li>2 - alias :2ter name alias anzeigen</li>
- </ul>
- und/oder <b>Name</b>:<br>
- <ul>
- <li>-f <filter> :Regulärer Ausdruck (regexp), um die Instanznamen zu filtern</li>
- </ul>
- Beispiel:<br>
- <ul><code>
- set hm param -d -f dim state # Zeige den Parameter 'state' von allen Geräten, die "dim" im Namen enthalten<br>
- set hm param -c -f ^dimUG$ peerList # Zeige den Parameter 'peerList' für alle Kanäle mit dem Namen "dimUG"<br>
- set hm param -dcv expert # Ermittle das Attribut expert für alle Geräte, Kanäle und virtuelle Instanzen<br>
- </code></ul>
- </ul>
- <br>
- <a name="HMinfodefine"><b>Define</b></a>
- <ul>
- <code>define <name> HMinfo</code><br>
- Es muss nur eine Instanz ohne jegliche Parameter definiert werden.<br>
- </ul>
- <br>
- <a name="HMinfoget"><b>Get</b></a>
- <ul>
- <li><a name="#HMinfomodels">models</a><br>
- zeige alle HM Modelle an, die von FHEM unterstützt werden
- </li>
- <li><a name="#HMinfoparam">param</a> <a href="#HMinfoFilter">[filter]</a> <name> <name>...<br>
- zeigt Parameterwerte (Attribute, Readings, ...) für alle Instanzen in Tabellenform an
- </li>
- <li><a name="#HMinforegister">register</a> <a href="#HMinfoFilter">[filter]</a><br>
- zeigt eine Tabelle mit Registern einer Instanz an
- </li>
- <li><a name="#HMinforegCheck">regCheck</a> <a href="#HMinfoFilter">[filter]</a><br>
- validiert Registerwerte
- </li>
- <li><a name="#HMinfopeerCheck">peerCheck</a> <a href="#HMinfoFilter">[filter]</a><br>
- validiert die Einstellungen der Paarungen (Peers). Hat ein Kanal einen Peer gesetzt, muss dieser auch auf
- der Gegenseite gesetzt sein.
- </li>
- <li><a name="#HMinfopeerXref">peerXref</a> <a href="#HMinfoFilter">[filter]</a><br>
- erzeugt eine komplette Querverweisliste aller Paarungen (Peerings)
- </li>
- <li><a name="#HMinfoconfigCheck">configCheck</a> <a href="#HMinfoFilter">[filter]</a><br>
- Plausibilitätstest aller HM Einstellungen inklusive regCheck und peerCheck
- </li>
- <li><a name="#HMinfoconfigChkResult">configChkResult</a><br>
- gibt das Ergebnis eines vorher ausgeführten configCheck zurück
- </li>
- <li><a name="#HMinfotemplateList">templateList [<name>]</a><br>
- zeigt eine Liste von Vorlagen. Ist kein Name angegeben, werden alle Vorlagen angezeigt<br>
- </li>
- <li><a name="#HMinfotemplateUsg">templateUsg</a> <template> [sortPeer|sortTemplate]<br>
- Liste der genutzten templates.<br>
- template filtert die Einträge nach diesem template
- </li>
- <li><a name="#HMinfomsgStat">msgStat</a> <a href="#HMinfoFilter">[filter]</a><br>
- zeigt eine Statistik aller Meldungen der letzen Woche<br>
- </li>
- <li><a name="#HMinfoprotoEvents">protoEvents</a> <a href="#HMinfoFilter">[filter]</a> <br>
- vermutlich die <B>wichtigste Auflistung</B> für Meldungsprobleme.
- Informationen über ausstehende Kommandos und fehlgeschlagene Sendevorgänge
- für alle Geräte in Tabellenform.<br>
- Mit <a name="#HMinfoclear">clear msgEvents</a> kann die Statistik gelöscht werden.<br>
- </li>
- <li><a name="#HMinforssi">rssi </a><a href="#HMinfoFilter">[filter]</a><br>
- Statistik über die RSSI Werte aller HM Instanzen.<br>
- </li>
- <li><a name="#HMinfotemplateChk">templateChk</a> <a href="#HMinfoFilter">[filter]</a> <template> <peer:[long|short]> [<param1> ...]<br>
- Verifiziert, ob die Registerwerte mit der Vorlage in Einklang stehen.<br>
- Die Parameter sind identisch mit denen aus <a href="#HMinfotemplateSet">templateSet</a>.<br>
- Wenn kein Peer benötigt wird, stattdessen none verwenden.
- Beispiele für die Überprüfung von Einstellungen<br>
- <ul><code>
- set hm templateChk -f RolloNord BlStopUpLg none 1 2 # RolloNord, no peer, parameter 1 and 2 given<br>
- set hm templateChk -f RolloNord BlStopUpLg peerName:long # RolloNord peerName, long only<br>
- set hm templateChk -f RolloNord BlStopUpLg peerName # RolloNord peerName, long and short<br>
- set hm templateChk -f RolloNord BlStopUpLg peerName:all # RolloNord peerName, long and short<br>
- set hm templateChk -f RolloNord BlStopUpLg all:long # RolloNord any peer, long only<br>
- set hm templateChk -f RolloNord BlStopUpLg all # RolloNord any peer,long and short<br>
- set hm templateChk -f Rollo.* BlStopUpLg all # each Rollo* any peer,long and short<br>
- set hm templateChk BlStopUpLg # each entities<br>
- set hm templateChk # all assigned templates<br>
- set hm templateChk sortTemplate # all assigned templates, sort by template<br>
- set hm templateChk sortPeer # all assigned templates, sort by peer<br>
- </code></ul>
- </li>
- </ul>
- <a name="HMinfoset"><b>Set</b></a>
- <ul>
- Obwohl die Kommandos Einstellungen abrufen (get function), werden sie mittels set ausgeführt, um die
- Benutzung mittels Web Interface zu erleichtern.<br>
- <ul>
- <li><a name="#HMinfoupdate">update</a><br>
- Aktualisiert HM Status Zähler.
- </li>
- <li><a name="#HMinfoautoReadReg">autoReadReg</a> <a href="#HMinfoFilter">[filter]</a><br>
- Aktiviert das automatische Lesen der Konfiguration für ein CUL_HM Gerät, wenn das Attribut autoReadReg auf 1 oder höher steht.
- </li>
- <li><a name="#HMinfoclear">clear</a> <a href="#HMinfoFilter">[filter]</a> [msgEvents|msgErrors|readings|msgStat|register|rssi]<br>
- Führt ein set clear ... für alle HM Instanzen aus<br>
- <ul>
- <li>Protocol bezieht sich auf set clear msgEvents</li>
- <li>Protocol set clear msgEvents fuer alle devices mit protokoll Fehlern</li>
- <li>readings bezieht sich auf set clear readings</li>
- <li>rssi löscht alle rssi Zähler</li>
- <li>msgStat löscht die HM Meldungsstatistik</li>
- <li>register löscht alle Einträge in den Readings</li>
- </ul>
- </li>
- <li><a name="#HMinfosaveConfig">saveConfig</a> <a href="#HMinfoFilter">[filter] [<file>]</a><br>
- Sichert alle HM Registerwerte und Peers. Siehe <a href="#CUL_HMsaveConfig">CUL_HM saveConfig</a>.<br>
- <a ref="#HMinfopurgeConfig">purgeConfig</a> wird automatisch ausgeführt, wenn die Datenmenge 1 MByte übersteigt.<br>
- </li>
- <li><a name="#HMinfoarchConfig">archConfig</a> <a href="#HMinfoFilter">[filter] [<file>]</a><br>
- Führt <a href="#HMinfosaveConfig">saveConfig</a> für alle Instanzen aus, sobald sich deren Konfiguration ändert.
- Es schont gegenüber saveConfig die Resourcen, da es nur vollständige Konfigurationen sichert.<br>
- Die Option -a erzwingt das sofortige Archivieren für alle Geräte, die eine vollständige Konfiguration aufweisen.<br>
- </li>
- <li><a name="#HMinfoloadConfig">loadConfig</a> <a href="#HMinfoFilter">[filter] [<file>]</a><br>
- Lädt Register und Peers aus einer zuvor mit <a href="#HMinfosaveConfig">saveConfig</a> gesicherten Datei.<br>
- Es sollte mit Vorsicht verwendet werden, da es Daten zu FHEM hinzufügt, die nicht verifiziert sind.
- Readings werden nicht ersetzt, nur fehlende Readings werden hinzugefügt. Der Befehl ist dazu geignet, um Readings
- zu erstellen, die schwer zu erhalten sind. Readings von Geräten, die nicht dauerhaft empfangen sondern nur auf Tastendruck
- aufwachen (z.B. Türsensoren), können nicht ohne Weiteres gelesen werden.<br>
- Daher liegt es in der Verantwortung des Benutzers gültige Werte zu verwenden. Es sollte autoReadReg für Geräte verwendet werden,
- die einfach ausgelesen werden können.<br>
- Der Befehl aktualisiert lediglich FHEM Readings und Attribute. Die Programmierung des Gerätes wird <B>nicht</B> verändert.
- </li>
- <li><a name="#HMinfopurgeConfig">purgeConfig</a> <a href="#HMinfoFilter">[filter] [<file>]</a><br>
- Bereinigt die gespeicherte Konfigurationsdatei. Durch die kumulative Speicherung der Registerwerte bleiben die
- zuletzt gespeicherten Werte erhalten und alle älteren werden gelöscht.
- Siehe <a href="#CUL_HMsaveConfig">CUL_HM saveConfig</a>.
- </li>
- <li><a name="#HMinfoverifyConfig">verifyConfig</a> <a href="#HMinfoFilter">[filter] [<file>]</a><br>
- vergleicht die aktuellen Daten mit dem configFile und zeigt unterschiede auf.
- Es ist hilfreich wenn man eine bekannt gute Konfiguration gespeichert hat und gegen diese vergleiche will.
- Ein purge vorher macht sinn.
- Siehe <a href="#CUL_HMpurgeConfig">CUL_HM purgeConfig</a>.
- </li>
- <br>
-
- <li><a name="#HMinfotempList">tempList</a> <a href="#HMinfoFilter">[filter]</a>[save|restore|verify] [<file>]</a><br>
- Diese Funktion ermöglicht die Verarbeitung von temporären Temperaturlisten für Thermostate.
- Die Listen können in Dateien abgelegt, mit den aktuellen Werten verglichen und an das Gerät gesendet werden.<br>
- <li><B>save</B> speichert die aktuellen tempList Werte des Systems in eine Datei. <br>
- Zu beachten ist, dass die aktuell in FHEM vorhandenen Werte benutzt werden. Der Benutzer muss selbst sicher stellen,
- dass diese mit den Werten im Gerät überein stimmen.<br>
- Der Befehl arbeitet nicht kummulativ. Alle evtl. vorher in der Datei vorhandenen Werte werden überschrieben.</li>
- <li><B>restore</B> in der Datei gespeicherte Termperaturliste wird direkt an das Gerät gesendet.</li>
- <li><B>verify</B> vergleicht die Temperaturliste in der Datei mit den aktuellen Werten in FHEM. Der Benutzer muss
- selbst sicher stellen, dass diese mit den Werten im Gerät überein stimmen.</li>
- <li><B>status</B> gibt einen Ueberblick aller genutzten template files. Ferner werden vorhandene templates in den files gelistst.
- <br></li>
- <li><B>genPlot</B> erzeugt einen Satz Daten um temp-templates graphisch darzustellen<br>
- Aus den gegebenen template-file wird ein .log erweitertes file erzeugt welches log-formatierte daten beinhaltet.
- Zeitmarken sind auf Beginn 2000 terminiert.<br>
- Ein .gplot file wird in der gplt directory erzeugt.<br>
- Eine Logfile-entity <file>_Log, falls nicht vorhanden, wird erzeugt.<br>
- Eine SVG-entity <file>_SVG, falls nicht vorhanden, wird erzeugt.<br>
- </li>
- <br>
- <li><B>filename</B> Name der Datei. Vorgabe ist <B>tempList.cfg</B></li>
- Beispiel für einen Dateiinhalt:<br>
- <ul><code>
- entities:HK1_Climate,HK2_Clima<br>
- tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0<br>
- tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0<br>
- tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0<br>
- tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0<br>
- tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0<br>
- tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0<br>
- tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0<br>
- entities:hk3_Climate<br>
- tempListFri>06:00 17.0 12:00 21.0 23:00 20.0 24:00 19.5<br>
- tempListMon>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0<br>
- tempListSat>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0<br>
- tempListSun>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0<br>
- tempListThu>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0<br>
- tempListTue>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0<br>
- tempListWed>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0<br>
- </code></ul>
- Datei Schlüsselwörter<br>
- <li><B>entities</B> mittels Komma getrennte Liste der Instanzen für die die nachfolgende Liste bestimmt ist.
- Es muss die tatsächlich für die Temperaturliste zuständige Instanz angegeben werden. Bei RTs ist das der Kanal 04,
- bei TCs der Kanal 02.</li>
- <li><B>tempList...</B> Zeiten und Temperaturen sind genau wie im Befehl "set tempList" anzugeben</li>
- <br>
- </li>
- <br>
- <li><a name="#HMinfocpRegs">cpRegs <src:peer> <dst:peer> </a><br>
- ermöglicht das Kopieren von Registern, Einstellungen und Verhalten zwischen gleichen Kanälen, bei einem Peer auch
- zwischen unterschiedlichen Kanälen. Das Kopieren kann daher sowohl von Gerät zu Gerät, als auch innerhalb eines
- Gerätes stattfinden.<br>
- <b>src:peer</b> ist die Quell-Instanz. Der Peer muss angegeben werden, wenn dessen Verhalten kopiert werden soll.<br>
- <b>dst:peer</b> ist die Ziel-Instanz.<br>
- Beispiel:<br>
- <ul><code>
- set hm cpRegs blindR blindL # kopiert alle Register (list 1) des Kanals von blindR nach blindL einschliesslich z.B. der
- Rolladen Fahrzeiten. Register, die den Peer betreffen (list 3/4), werden nicht kopiert.<br>
- set hm cpRegs blindR:Btn1 blindL:Btn2 # kopiert das Verhalten der Beziehung Btn1/blindR nach Btn2/blindL<br>
- set hm cpRegs blindR:Btn1 blindR:Btn2 # kopiert das Verhalten der Beziehung Btn1/blindR nach Btn2/blindR, hier
- innerhalb des Aktors<br>
- </code></ul>
- <br>
- Einschränkungen:<br>
- <ul>
- cpRegs <u>verändert keine Peerings</u> oder liest direkt aus den Geräten. Die Readings müssen daher aktuell sein.<br>
- cpRegs kann nur auf <u>identische Gerätemodelle</u> angewendet werden<br>
- cpRegs erwartet <u>aktuelle Readings</u>. Dies muss der Benutzer sicher stellen.<br>
- </ul>
- </li>
- <li><a name="#HMinfotemplateDef">templateDef <name> <param> <desc> <reg1:val1> [<reg2:val2>] ...</a><br>
- definiert eine Vorlage.<br>
- <b>param</b> definiert die Namen der Parameters, die erforderlich sind, um die Vorlage auszuführen.
- Diese sind abhängig von der Vorlage und können onTime oder brightnesslevel sein.
- Bei einer Liste mehrerer Parameter müssen diese mittels Kommata separiert werden.<br>
- param1:param2:param3<br>
- Der Parameter del führt zur Löschung der Vorlage.<br>
- <b>desc</b> eine Beschreibung für die Vorlage<br>
- <b>reg:val</b> der Name des Registers und der dazugehörige Zielwert.<br>
- Wenn das Register zwischen long und short unterscheidet, muss das führende sh oder lg weggelassen werden.<br>
- Parameter müssen mit p angegeben werden, p0 für den ersten, p1 für den zweiten usw.
- <br>
- Beispiel<br>
- <ul><code>
- set hm templateDef SwOnCond level:cond "my description" CtValLo:p0 CtDlyOn:p1 CtOn:geLo<br>
- set hm templateDef SwOnCond del # lösche template SwOnCond<br>
- set hm templateDef SwOnCond fromMaster <masterChannel> <peer:[long|short]># masterKanal mit peer wird als Vorlage genommen<br>
- set hm templateDef SwOnCond fromMaster myChannel peerChannel:long <br>
- </code></ul>
- </li>
- <li><a name="#HMinfotemplateSet">templateSet</a> <entity> <template> <peer:[long|short]> [<param1> ...]<br>
- setzt mehrere Register entsprechend der angegebenen Vorlage. Die Parameter müssen entsprechend der Vorlage angegeben werden.<br>
- templateSet akkumuliert alle Änderungen und schreibt das Ergebnis gesammelt.<br>
- <b>entity:</b> ist die Quell-Instanz. Der Peer muss angegeben werden, wenn dessen Verhalten kopiert werden soll.<br>
- <b>template:</b> eine der vorhandenen Vorlagen<br>
- <b>peer:</b> [long|short]:falls erforderlich muss der Peer angegeben werden. Wird kein Peer benötigt, '0' verwenden.
- Bei einem Peer muss für den Tastendruck long oder short angegeben werden.<br>
- <b>param:</b> Nummer und Bedeutung des Parameters hängt von der Vorlage ab.<br>
- Ein Beispiel könnte sein (theoretisch, ohne die Vorlage anzugeben)<br>
- <ul><code>
- set hm templateSet Licht1 staircase FB1:short 20 <br>
- set hm templateSet Licht1 staircase FB1:long 100 <br>
- </code></ul>
- Einschränkungen:<br>
- <ul>
- Der Benutzer muss aktuelle Register/Konfigurationen sicher stellen.<br>
- templateSet konfiguriert ggf. nur einzelne Register und keinen vollständigen Satz. Dies hängt vom Design der Vorlage ab.<br>
- <br>
- </ul>
- </li>
- <li><a name="#HMinfotemplateDel">templateDel</a> <entity> <template> <peer:[long|short]><br>
- entfernt ein Template das mit templateSet eingetragen wurde
- </li>
- <li><a name="#HMinfotemplateExe">templateExe</a> <template> <br>
- führt das templateSet erneut aus. Die Register werden nochmals geschrieben, falls sie nicht zum template passen. <br>
- </li>
- <li><a name="#HMinfodeviceReplace">x-deviceReplace</a> <oldDevice> <newDevice> <br>
- Ersetzen eines alten oder defekten Device. Das neue Ersatzdevice muss kompatibel zum Alten sein - FHEM prüft das nur rudimentär. Der Anwender sollt es sorgsam prüfen.<br>
- Das Kommando muss aus Sicherheitsgründen 2-fach ausgeführt werden. Der erste Aufruf wird mit einem CAUTION quittiert. Nach Auslösen den Kommandos ein 2. mal werden die Devices umbenannt und umkonfiguriert. Er werden alle peerings, Register und Templates im neuen Device UND allen peers umgestellt.<br>
- ACHTUNG: Nach dem Auslösen kann die Änderung nicht mehr automatisch rückgängig gemacht werden. Manuell ist das natürlich möglich.<br>
- Auch ein ückspring auf eine ältere Konfiguration erlaubt KEIN Rückgängigmachen!!!<br>
- Sollte das Device und seine Kanäle über Templates definiert sein - also die Registerlisten - kann im Falle von Problemen in der Übertragung - problemlos wieder hergestellt werden. <br>
- </li>
- </ul>
- </ul>
- <br>
- <a name="HMinfoattr"><b>Attribute</b></a>
- <ul>
- <li><a name="#HMinfosumStatus">sumStatus</a><br>
- erzeugt eine Liste von Warnungen. Die zu untersuchenden Readings werden mittels Komma separiert angegeben.
- Die Readings werden, so vorhanden, von allen Instanzen ausgewertet, gezählt und getrennt nach Readings mit
- gleichem Inhalt ausgegeben.<br>
- Beispiel:<br>
- <ul><code>
- attr hm sumStatus battery,sabotageError<br>
- </code></ul>
- könnte nachfolgende Ausgaben erzeugen<br>
- W_sum_batterie ok:5 low:3<br>
- W_sum_sabotageError on:1<br>
- <br>
- Anmerkung: Zähler mit Werten von '0' werden nicht angezeigt. HMinfo findet alle vorhanden Werte selbstständig.<br>
- Das Setzen des Attributes ermöglicht einen schnellen Überblick über systemkritische Werte.<br>
- </li>
- <li><a name="#HMinfosumERROR">sumERROR</a>
- Ähnlich sumStatus, jedoch mit dem Fokus auf signifikante Fehler.
- Hier können Reading <b>Werte</b> angegeben werden, die dazu führen, dass diese <b>nicht angezeigt</b> werden.
- Damit kann beispielsweise verhindert werden, dass der zu erwartende Normalwert oder ein anderer nicht
- kritischer Wert angezeigt wird.<br>
- Beispiel:<br>
- <ul><code>
- attr hm sumERROR battery:ok,sabotageError:off,overheat:off,Activity:alive:unknown<br>
- </code></ul>
- erzeugt folgende Ausgabe:<br>
- <ul><code>
- ERR_batterie low:3<br>
- ERR_sabotageError on:1<br>
- ERR_overheat on:3<br>
- ERR_Activity dead:5<br>
- </code></ul>
- </li>
- <li><a name="#HMinfoautoUpdate">autoUpdate</a>
- führt den Befehl periodisch aus.<br>
- Beispiel:<br>
- <ul><code>
- attr hm autoUpdate 00:10<br>
- </code></ul>
- führt den Befehl alle 10 Minuten aus<br>
- </li>
- <li><a name="#HMinfoautoArchive">autoArchive</a>
- Sobald neue Daten verfügbar sind, wird das configFile aktualisiert.
- Für die Aktualisierung ist <a ref="#HMinfoautoUpdate">autoUpdate</a> zwingend erforderlich.<br>
- siehe auch <a ref="#HMinfoarchConfig">archConfig</a>
- <br>
- </li>
- <li><a name="#HMinfohmAutoReadScan">hmAutoReadScan</a>
- definiert die Zeit in Sekunden bis zum nächsten autoRead durch CUL_HM. Trotz dieses Zeitwertes stellt
- FHEM sicher, dass zu einem Zeitpunkt immer nur ein Gerät gelesen wird, auch wenn der Minimalwert von 1
- Sekunde eingestellt ist. Mit dem Timer kann der Zeitabstand
- ausgeweitet werden - bis zu 300 Sekunden zwischen zwei Ausführungen.<br>
- Das Herabsetzen erhöht die Funkbelastung, Heraufsetzen erhöht die Wartzezeit.<br>
- </li>
- <li><a name="#HMinfohmIoMaxDly">hmIoMaxDly</a>
- maximale Zeit in Sekunden für die CUL_HM Meldungen puffert, wenn das Gerät nicht sendebereit ist.
- Ist das Gerät nicht wieder rechtzeitig sendebereit, werden die gepufferten Meldungen verworfen und
- IOErr ausgelöst.<br>
- Hinweis: Durch die Pufferung kann es vorkommen, dass Aktivität lange nach dem Absetzen des Befehls stattfindet.<br>
- Standard ist 60 Sekunden, maximaler Wert ist 3600 Sekunden.<br>
- </li>
- <li><a name="#HMinfoconfigDir">configDir</a>
- Verzeichnis für das Speichern und Lesen der Konfigurationsdateien, sofern in einem Befehl nur ein Dateiname ohne
- Pfad angegen wurde.<br>
- Verwendung beispielsweise bei <a ref="#HMinfotempList">tempList</a> oder <a ref="#HMinfosaveConfig">saveConfig</a><br>
- </li>
- <li><a name="#HMinfoconfigFilename">configFilename</a>
- Standard Dateiname zur Verwendung von
- <a ref="#HMinfosaveConfig">saveConfig</a>,
- <a ref="#HMinfopurgeConfig">purgeConfig</a>,
- <a ref="#HMinfoloadConfig">loadConfig</a><br>
- </li>
- <li><a name="#HMinfoconfigTempFile">configTempFile<,configTempFile2><,configTempFile2> </a>
- Liste der Templfiles (weekplan) welche in HM berücksichtigt werden<br>
- Die Files werden kommasepariert eingegeben. Das erste File ist der Default. Dessen Name muss beim Template nicht eingegeben werden.<br>
- </li>
- <li><a name="#HMinfohmManualOper">hmManualOper</a>
- auf 1 gesetzt, verhindert dieses Attribut jede automatische Aktion oder Aktualisierung seitens CUL_HM.<br>
- </li>
- <li><a name="#HMinfohmDefaults">hmDefaults</a>
- setzt default Atribute fuer HM devices. Mehrere Attribute sind moeglich, Komma separiert.<br>
- Beispiel:<br>
- attr hm hmDefaults hmProtocolEvents:0_off,rssiLog:0<br>
- </li>
- <li><a name="#HMinfoautoLoadArchive">autoLoadArchive</a>
- das Register Archive sowie Templates werden nach reboot automatischgeladen.
- Siehe <a ref="#HMinfoloadConfig">loadConfig</a> fuer details<br>
- </li>
- </ul>
- <br>
- <a name="HMinfovariables"><b>Variablen</b></a>
- <ul>
- <li><b>I_autoReadPend:</b> Info: Liste der Instanzen, für die das Lesen von Konfiguration und Status ansteht,
- üblicherweise ausgelöst durch autoReadReg.</li>
- <li><b>ERR___rssiCrit:</b> Fehler: Liste der Geräte mit kritischem RSSI Wert </li>
- <li><b>W_unConfRegs:</b> Warnung: Liste von Instanzen mit unbestätigten Änderungen von Registern.
- Die Ausführung von getConfig ist für diese Instanzen erforderlich.</li>
- <li><b>I_rssiMinLevel:</b> Info: Anzahl der niedrigen RSSI Werte je Gerät, in Blöcken angeordnet.</li>
- <li><b>ERR__protocol:</b> Fehler: Anzahl nicht behebbarer Protokollfehler je Gerät.
- Protokollfehler sind NACK, IOerr, ResendFail, CmdDel, CmdPend.<br>
- Gezählt wird die Anzahl der Geräte mit Fehlern, nicht die Anzahl der Fehler!</li>
- <li><b>ERR__protoNames:</b> Fehler: Liste der Namen der Geräte mit nicht behebbaren Protokollfehlern</li>
- <li><b>I_HM_IOdevices:</b> Info: Liste der IO Geräte, die von CUL_HM Instanzen verwendet werden</li>
- <li><b>I_actTotal:</b> Info: Status des Actiondetectors, Zähler für Geräte mit bestimmten Status</li>
- <li><b>ERRactNames:</b> Fehler: Namen von Geräten, die der Actiondetector als ausgefallen meldet</li>
- <li><b>C_sumDefined:</b> Count: In CUL_HM definierte Instanzen. Instanzen können als Gerät UND
- als Kanal gezählt werden, falls die Funktion des Kanals durch das Gerät
- selbst abgedeckt ist. Ähnlich virtual</li>
- <li><b>ERR_<reading>:</b> Fehler: Anzahl mittels Attribut <a href="#HMinfosumERROR">sumERROR</a>
- definierter Readings, die nicht den Normalwert beinhalten. </li>
- <li><b>ERR_names:</b> Fehler: Namen von Instanzen, die in einem ERR_<reading> enthalten sind.</li>
- <li><b>W_sum_<reading></b> Warnung: Anzahl der mit Attribut <a href="#HMinfosumStatus">sumStatus</a> definierten Readings.</li>
- Beispiele:<br>
- <ul>
- <code>
- ERR___rssiCrit LightKittchen,WindowDoor,Remote12<br>
- ERR__protocol NACK:2 ResendFail:5 CmdDel:2 CmdPend:1<br>
- ERR__protoNames LightKittchen,WindowDoor,Remote12,Ligth1,Light5<br>
- ERR_battery: low:2;<br>
- ERR_names: remote1,buttonClara,<br>
- I_rssiMinLevel 99>:3 80<:0 60<:7 59<:4<br>
- W_sum_battery: ok:5;low:2;<br>
- W_sum_overheat: off:7;<br>
- C_sumDefined: entities:23 device:11 channel:16 virtual:5;<br>
- </code>
- </ul>
- </ul>
- </ul>
- <p><a name="HMtemplate"></a>
- <h3>HMtemplate</h3>
- <div class='langLinks'>[<a href='commandref.html#HMtemplate'>EN</a> DE]</div>
- <ul>
- </ul>
- <p><a name="HOMBOT"></a>
- <h3>HOMBOT</h3>
- <div class='langLinks'>[<a href='commandref.html#HOMBOT'>EN</a> DE]</div>
- <ul>
- <u><b>HOMBOT - LG Homebot Staubsaugerroboter</b></u>
- <br>
- Dieses Modul gibt Euch die Möglichkeit Euren Hombot nach erfolgreichen Hack in FHEM ein zu binden.
- Voraussetzung ist das Ihr den Hombot Hack gemacht und einen WLAN Stick eingebaut habt. Als Schnittstelle zwischen FHEM und Bot wird der Luigi HTTP Server verwendet. Was genau könnt Ihr nun mit dem Modul machen:
- <ul>
- <li>Readings über den Status des Hombots werden angelegt</li>
- <li>Auswahl des Reinigungsmodus ist möglich</li>
- <li>Starten der Reinigung</li>
- <li>Beenden der Reinigung</li>
- <li>zurück zur Homebase schicken</li>
- <li>Namen vergeben</li>
- <li>Wochenprogramm einstellen</li>
- <li>Repeat und Turbo aktivieren</li>
- </ul>
- <br>
- !!! Voraussetzungen schaffen !!!
- <br>Ihr benötigt zum verwenden des Modules die Programme ssh und sshpass. Desweiteren muß im Homeverzeichnis des fhem Users das Verzeichniss .ssh existieren und darin die Datei known_hosts. Diese sollte eine Passphrass des Bots beinhalten. Am besten Ihr macht als normaler User eine ssh Session zum Bot und kopiert danach die known_hosts Eures normalen Users in das .ssh Verzeichnis des fhem Users. Rechte anpassen nicht vergessen.
- <br>
- Das Device für den Hombot legt Ihr wie folgt in FHEM an.
- <br><br>
- <a name="HOMBOTdefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> HOMBOT <IP-ADRESSE></code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define Roberta HOMBOT 192.168.0.23</code><br>
- </ul>
- <br>
- Diese Anweisung erstellt ein neues HOMBOT-Device im Raum HOMBOT.Der Parameter <IP-ADRESSE> legt die IP Adresse des LG Hombot fest.<br>
- Das Standard Abfrageinterval ist 180 Sekunden und kann über das Attribut intervall geändert werden. Das Interval ist in Abhängigkeit des Arbeitsstatus dynamisch. Im Status WORKING beträgt es z.B. 30 Sekunden.
- <br>
- </ul>
- <br><br>
- <b><u>Nach anlegen der Geräteinstanz sollten bereits die ersten Readings erscheinen.</u></b>
- <br><br><br>
- <a name="HOMBOTreadings"></a>
- <b>Readings</b>
- <ul>
- <li>at_* - Reading für das Wochenprogramm. Startzeit für den jeweiligen Tag</li>
- <li>batteryPercent - Status der Batterie in %</li>
- <li>cleanMode - aktuell eingestellter Reinigungsmodus</li>
- <li>cpu_* - Informationen über die Prozessorauslastung</li>
- <li>currentBumping - Anzahl der Zusammenstöße mit Hindernissen</li>
- <li>firmware - aktuell installierte Firmwareversion</li>
- <li>hombotState - Status des Hombots</li>
- <li>lastClean - Datum und Uhrzeit der letzten Reinigung</li>
- <li>lastSetCommandError - letzte Fehlermeldung vom set Befehl</li>
- <li>lastSetCommandState - letzter Status vom set Befehl, Befehl erfolgreich/nicht erfolgreich gesendet</li>
- <li>lastStatusRequestError - letzte Fehlermeldung vom statusRequest Befehl</li>
- <li>lastStatusRequestState - letzter Status vom statusRequest Befehl, Befehl erfolgreich/nicht erfolgreich gesendet</li>
- <li>luigiSrvVersion - Version des Luigi HTTP Servers auf dem Hombot</li>
- <li>nickname - Name des Hombot</li>
- <li>num* - Bisher begonnene und beendete Reinigungen im entsprechenden Modus</li>
- <li>repeat - Reinigung wird wiederholt Ja/Nein</li>
- <li>state - Modulstatus</li>
- <li>turbo - Turbo aktiv Ja/Nein</li>
- </ul>
- <br><br>
- <a name="HOMBOTset"></a>
- <b>Set</b>
- <ul>
- <li>cleanMode - setzen des Reinigungsmodus (ZZ-ZickZack / SB-Cell by Cell / SPOT-Spiralreinigung</li>
- <li>cleanStart - Reinigung starten</li>
- <li>homing - Beendet die Reinigung und lässt die Bot zurück zur Bases kommen</li>
- <li>nickname - setzt des Bot-Namens. Wird im Reading erst nach einem neustart des Luigiservers oder des Bots sichtbar</li>
- <li>pause - lässt den Reinigungsproßess pausieren</li>
- <li>repeat - Reinigung wiederholen? (true/false)</li>
- <li>schedule - setzen des Wochenprogrammes Bsp. set Roberta schedule Mo=13:30 Di= Mi=14:00,ZZ Do=15:20 Fr= Sa=11:20 So= Man kann also auch den Modus mitgeben!</li>
- <li>statusRequest - Fordert einen neuen Statusreport beim Device an</li>
- <li>turbo - aktivieren des Turbomodus (true/false)</li>
- </ul>
- <br><br>
- </ul>
- <p><a name="HOMEMODE"></a>
- <h3>HOMEMODE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HOMEMODE'>HOMEMODE</a><br/>
- </ul>
- <p>
- <a name="HP1000" id="HP1000"></a>
- </p>
- <h3>
- HP1000
- </h3>
- <div class='langLinks'>[<a href='commandref.html#HP1000'>EN</a> DE]</div>
- <ul>
- <div>
- <a name="HP1000define" id="HP10000define"></a> <b>Define</b>
- <div>
- <ul>
- <code>define <WeatherStation> HP1000 [<ID> <PASSWORD>]</code><br>
- <br>
- Stellt einen Webhook für WLAN-basierte Wetterstationen bereit, die das <a href="http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol">PWS</a> Protokoll von Weather Underground verwenden (z.B. HP1000, WH2600, WH2601, WH2621, WH2900, WH2950 Wetterstation von <a href="http://www.foshk.com/Wifi_Weather_Station/">Fine Offset Electronics</a> - manchmal auch bekannt als <a href="http://www.ambientweather.com/peorhowest.html">Ambient Weather</a> WS-1001-WIFI oder ähnliches). In Deutschland werden die Geräte zumeist von <a href="http://www.froggit.de/">froggit</a> oder von <a href="http://www.conrad.de/">Conrad</a> unter dem Markennamen Renkforce vertrieben.<br>
- Es muss noch eine dedizierte FHEMWEB Instanz angelegt werden, wo das Attribut webname auf "weatherstation" gesetzt wurde.<br>
- Kein anderer Name funktioniert, da dieser fest in der Wetterstation hinterlegt ist!<br>
- Sofern notwendig, erstellt dieses Modul eine passende FHEMWEB Instanz namens WEBweatherstation während der initialen Definition.<br>
- <br>
- Da die URI ebenfalls fest kodiert ist, kann mit einer einzelnen FHEM Installation maximal eine Instanz dieses Moduls gleichzeitig verwendet werden.<br>
- <br>
- Beispiel:<br>
- <div>
- <code># ungeschützte Instanz bei der ID und PASSWORD ignoriert werden<br>
- define WeatherStation HP1000<br>
- <br>
- # geschützte Instanz: Die Wetterstation muss so konfiguriert sein, dass sie<br>
- # diese ID und PASSWORD sendet, damit Daten akzeptiert werden<br>
- define WeatherStation HP1000 MyHouse SecretPassword</code>
- </div><br>
- WICHTIG: Im Gerät selbst muss sichergestellt sein, dass ein DNS Name statt einer IP Adresse verwendet wird, da einige Revisionen damit nicht umgehen können.<br>
- Ggf. sollte man <a href="http://www.foshk.com/support/">hier</a> einmal nach einer neueren Firmware schauen.
- </ul>
- </div><br>
- </div>
- <a name="HP1000Attr" id="HP10000Attr"></a> <b>Attributes</b>
- <div>
- <ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <br>
- <a name="wu_id"></a><li><b>wu_id</b></li>
- Weather Underground (Wunderground) Stations ID
- <a name="wu_password"></a><li><b>wu_password</b></li>
- Weather Underground (Wunderground) Passwort
- <a name="wu_dataValues"></a><li><b>wu_dataValues</b></li>
- Ersetzt Werte oder fügt neue Werte hinzu, bevor diese zu Weather Underground übertragen werden.<br>
- Das Format entspricht key=value wobei value im <a href="#set">Format set magic sein</a> kann.
- <a name="wu_indoorValues"></a><li><b>wu_indoorValues</b></li>
- Gibt an, ob die Innenraumwerte mit zu Weather Underground übertragen werden sollen (Standard ist 1=an)
- <a name="wu_push"></a><li><b>wu_push</b></li>
- Pushen der Daten zu Weather Underground aktivieren oder deaktivieren (Standard ist 0=aus)
- <a name="wu_pushValues"></a><li><b>wu_pushValues</b></li>
- Schränkt die Werte ein, die an Weather Underground übertragen werden.
- Andernfalls werden alle Werte übertragen.
- <a name="wu_realtime"></a><li><b>wu_realtime</b></li>
- Sendet die Daten an den WU Echtzeitserver statt an den Standard Server (Standard ist 1=an)
- </ul>
- </div>
- </ul>
- <p><a name="HTTPMOD"></a>
- <h3>HTTPMOD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HTTPMOD'>HTTPMOD</a><br/>
- </ul>
- <a name="HTTPSRV"></a>
- <h3>HTTPSRV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HTTPSRV'>HTTPSRV</a><br/>
- </ul>
- <a name="HUEBridge"></a>
- <h3>HUEBridge</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HUEBridge'>HUEBridge</a><br/>
- </ul>
- <a name="HUEDevice"></a>
- <h3>HUEDevice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HUEDevice'>HUEDevice</a><br/>
- </ul>
- <a name="HXB"></a>
- <h3>HXB</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HXB'>HXB</a><br/>
- </ul>
- <a name="HXBDevice"></a>
- <h3>HXBDevice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HXBDevice'>HXBDevice</a><br/>
- </ul>
- <a name="Heating_Control"></a>
- <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">
- <h3>Heating Control</h3>
- <div class='langLinks'>[<a href='commandref.html#Heating_Control'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="Heating_Controldefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Heating_Control <device> [<language>] <wochentage;] <profile> <command>|<condition></code>
- <br><br>
- Bildet ein Wochenprofil für ein <device>, zb. Heizkörper, ab.<br>
- Es können für jeden Tag unterschiedliche Schaltzeiten angegeben werden.<br>
- Ist das <device> ein Heizkörperthermostat (zb. FHT8b, MAX) so wird bei FHT8b/MAX die
- zu setzende Temperatur im <profile> automatisch mittels <br><br>
- <code>set <device> (desired-temp|desiredTemperature) <temp></code> <br><br> gesendet.
- Struktuen von Heizkörperthermostaten bekommen aufgrund des fhem-Typs auch desired-temp gesendet:
- Nutze bitte explizite Kommandos wenn Strukturen von MAX Heizthermostaten gesteuert werden sollen.<br><br>
- Ist eine <condition> angegeben und ist zum Schaltpunkt der Ausdruck unwahr,
- so wird dieser Schaltpunkt nicht ausgeführt.<br>
- Alternativ zur Automatik kann stattdessen eigener Perl-Code im <command> ausgeführt werden.
- <p>
- Folgende Parameter sind im Define definiert:
- <ul><b>device</b><br>
- Name des zu schaltenden Device.
- </ul>
- <p>
- <ul><b>language</b><br>
- Spezifiziert die Sprache für die Definition und die Anzeige der Profile in der Weboberfläche.
- Zurzeit sind de,en,fr definiert. Der Parameter ist optional.
- </ul>
- <p>
- <ul><b><u>wochentage</u></b><br>
- Spezifiziert die Tage für alle Timer eines <b>Heating_Control</b>.
- Der Parameter ist optional. Bitte für Details zur Definition siehe wochentage im part profile.
- </ul>
- <p>
- <ul><b>profile</b><br>
- Angabe des Wochenprofils. Die einzelnen Schaltzeiten sind durch Leerzeichen getrennt
- Die Angabe der Schaltzeiten ist nach folgendem Muster definiert:<br>
- <ul><b>[<Wochentage>|]<Uhrzeit>|<Parameter></b></ul><br>
- <u>Wochentage:</u> optionale Angabe, falls nicht gesetzt wird der Schaltpunkt jeden Tag ausgeführt.
- Für die Tage an denen dieser Schaltpunkt aktiv sein soll, ist jeder Tag mit seiner
- Tagesnummer (Mo=1, ..., So=0) oder Name des Tages (Mo, Di, ..., So) einzusetzen.<br><br>
- <ul>
- <li>0,so Sonntag</li>
- <li>1,mo Montag</li>
- <li>2,di Dienstag</li>
- <li>3,mi Mittwoch</li>
- <li>4 ...</li>
- <li>7,$we Wochenende ($we)</li>
- <li>8,!$we Wochentag (!$we)</li>
- </ul><br>
- Es ist möglich $we or !$we in der Tagesliste zu definieren.
- So ist es auf einfache Art möglich die Schaltzeitpunkte für das Wochenende oder Wochetage zu definieren.
- $we und!$we werden als 7 bzw. 8 spezifiziert, wenn die numerische Variante der Tagesliste gewählt wird.<br><br>
- <u>Uhrzeit:</u>Angabe der Uhrzeit zu der geschaltet werden soll, Format: HH:MM:[SS](HH im 24 Stunden Format) oder eine Perlfunction wie {sunrise_abs()}.
- In {} kannst du die Variable $date(epoch) nutzen, um die Schaltzeiten der Woche zu berechnen. Beispiel: {sunrise_abs_dat($date)}<br><br>
- <u>Parameter:</u>Angabe der zu setzenden Temperatur als Zahl mit Format 99.9 oder als symbolische Konstante <b>eco</b>
- or <b>comfort</b> - was immer das Heizkörperthermostat versteht.
- Symbolischen Werten kann ein zusätzlicher Parameter angehängt werden: dayTemp:16 night-temp:15. Unten folgen Beispiele<br><br>
- </ul>
- <p>
- <ul><b>command</b><br>
- Falls keine Condition in () angegeben wurde, so wird alles weitere als Command
- interpretiert. Perl-Code ist in {} zu setzen. <br>
- Wichtig: Falls ein Command definiert ist, so wird zu den definierten Schaltzeiten
- nur(!) das Command ausgeführt. Falls ein desired-temp Befehl abgesetzt werde soll,
- so muss dies explizit angegeben werden.<br>
- Folgende Parameter werden ersetzt:<br>
- <ol>
- <li>$NAME => das zu schaltende Device</li>
- <li>$EVENT => die zu setzende Temperatur</li>
- </ol>
- </ul>
- <p>
- <ul><b>condition</b><br>
- Bei Angabe einer Condition ist diese in () zu setzen und mit validem Perl-Code zu versehen.<br>
- Der Rückgabedatentyp der condition muss boolean sein.<br>
- Die Parameter $NAME und $EVENT werden interpretiert.
- </ul>
- <p>
- <b>Beispiele:</b>
- <ul>
- <code>define HCW Heating_Control Bad_Heizung 12345|05:20|21 12345|05:25|comfort 17:20|21 17:25|eco</code><br>
- Mo-Fr wird die Temperatur um 05:20Uhr auf 21°C, und um 05:25Uhr auf <b>comfort</b> gesetzt.
- Jeden Tag wird die Temperatur um 17:20Uhr auf 21°C und 17:25Uhr auf <b>eco</b> gesetzt.<p>
- <code>define HCW Heating_Control WZ_Heizung 07:00|16 Mo,Di,Mi|16:00|18.5 20:00|12
- {fhem("set dummy on"); fhem("set $NAME desired-temp $EVENT");}</code><br>
- Zu den definierten Schaltzeiten wird nur(!) der in {} angegebene Perl-Code ausgeführt.<p>
- <code>define HCW Heating_Control WZ_Heizung Sa-So,Mi|08:00|21 (ReadingsVal("WeAreThere", "state", "no") eq "yes")</code><br>
- Die zu setzende Temperatur wird nur gesetzt, falls die Dummy Variable WeAreThere = "yes" ist.<p>
- <code>define HCW Heating_Control WZ_Heizung en Su-Fr|{sunrise_abs()}|21 Mo-Fr|{sunset_abs()}|16</code><br>
- Das Gerät wird bei Sonnenaufgang und Sonnenuntergang geschaltet. Sprache: Englisch.<p>
- <code>define HCW Heating_Control WZ_Heizung en Mo-Fr|{myFunction}|night-temp:18 Mo-Fr|{myFunction()}|dayTemp:16</code><br>
- Das Gerät wird bei myFunction() geschaltet. Es wird das Kommando "night-temp 18" bzw. "dayTemp 16" gesendet.<p>
- Wenn du beispielsweise nach einer Temperaturabsenkungsphase erreichen willst, dass alle Heating_Controls ihren aktuellen Wert
- einstellen sollen, kannst du die Funktion <b>Heating_Control_SetTemp("HC-device")</b> or <b>Heating_Control_SetAllTemps()</b> aufrufen.<p>
- Dieser Aufruf kann per notify automatisch an ein dummy gekoppelt werden:<br>
- <code>define HeizStatus2 notify Heizung:.* {Heating_Control_SetAllTemps()}</code>
- <br><p>
- Einige Definitionen ohne weitere Erklärung:
- <code><pre>
- define hc Heating_Control HeizungKueche de 7|23:35|25 34|23:30|22 23:30|16 23:15|22 8|23:45|16
- define hc Heating_Control HeizungKueche de fr,$we|23:35|25 34|23:30|22 23:30|16 23:15|22 12|23:45|16
- define hc Heating_Control HeizungKueche de 20:35|25 34|14:30|22 21:30|16 21:15|22 12|23:00|16
- define hw Heating_Control HeizungKueche de mo-so, $we|{sunrise_abs_dat($date)}|18 mo-so, $we|{sunset_abs_dat($date)}|22
- define ht Heating_Control HeizungKueche de mo-so,!$we|{sunrise_abs_dat($date)}|18 mo-so,!$we|{sunset_abs_dat($date)}|22
- define hh Heating_Control HeizungKueche de {sunrise_abs_dat($date)}|19 {sunset_abs_dat($date)}|21
- define hx Heating_Control HeizungKueche de 22:35|25 23:00|16
- </code></pre>
- Die Tagesliste kann global für das ganze Heating_Control angegeben werden:<p>
- <code><pre>
- define HeizungWohnen_an_wt Heating_Control HeizungWohnen de !$we 09:00|19 (heizungAnAus("Ein"))
- define HeizungWohnen_an_we Heating_Control HeizungWohnen de $we 09:00|19 (heizungAnAus("Ein"))
- define HeizungWohnen_an_we Heating_Control HeizungWohnen de 78 09:00|19 (heizungAnAus("Ein"))
- define HeizungWohnen_an_we Heating_Control HeizungWohnen de 57 09:00|19 (heizungAnAus("Ein"))
- define HeizungWohnen_an_we Heating_Control HeizungWohnen de fr,$we 09:00|19 (heizungAnAus("Ein"))
- </code></pre>
- es ist möglich den Parameter als Perlcode zu spezifizieren:<p>
- <code><pre>
- ... 7|23:35|{getParameter(13,"this")} 7|23:36|{getParameter(14,"that")}
- </code></pre>
- ein detailiertes Beispiel ist in Heating_Control(EN) beschrieben<p>
- </ul>
- </ul>
- <a name="Heating_Controlset"></a>
- <b>Set</b>
- <code><b><font size="+1">set <name> <value></font></b></code>
- <br><br>
- where <code>value</code> is one of:<br>
- <pre>
- <b>enable</b> # enables the Heating_Control
- <b>disable</b> # disables the Heating_Control
- </pre>
- <b><font size="+1">Examples</font></b>:
- <ul>
- <code>set hc disable</code><br>
- <code>set hc enable</code><br>
- </ul>
- </ul>
- <a name="Heating_Controlget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="Heating_ControlLogattr"></a>
- <b>Attributes</b>
- <ul>
- <li>delayedExecutionCond <br>
- definiert eine Veroegerungsfunktion. Wenn die Funktion wahr liefert, wird die Schaltung des Geraets solage verzoegert, bis die Funktion wieder falsch liefert. Das Verhalten entspricht einem Fensterkontakt.
- <br><br>
- <b>Beispiel:</b>
- <pre>
- attr wd delayedExecutionCond isDelayed("$HEATING_CONTROL","$WEEKDAYTIMER","$TIME","$NAME","$EVENT")
- </pre>
- Die Parameter $HEATING_CONTROL(timer Name) $TIME $NAME(device Name) $EVENT werden zur Laufzeit durch die echten Werte ersetzt.
- <br><br>
- <b>Beispielfunktion:</b>
- <pre>
- sub isDelayed($$$$$) {
- my($hc, $wdt, $tim, $nam, $event ) = @_;
- my $theSunIsStillshining = ...
- return ($tim eq "16:30" && $theSunIsStillshining) ;
- }
- </pre>
- </li>
- <li>switchInThePast<br>
- Definiert, dass ein abhängiges Gerät in der Start- oder Definitionsphase mit einem Wert aus der Vergangheit geschaltet wird auch wenn das Gerät nicht als Heizung erkannt wurde.
- Heizungen werden immer mit einem Wert aus der Vergangenheit geschaltet.
- </li>
- <li><a href="#disable">disable</a></li>
- <li><a href="#event-on-update-reading">event-on-update-reading</a></li>
- <li><a href="#event-on-change-reading">event-on-change-reading</a></li>
- <li><a href="#stateFormat">stateFormat</a></li>
- <li>windowSensor<br>Definiert eine Liste mit Fensterkontakten. Wenn das Reading window state eines Fensterkontakts <b>open</b> ist, wird der aktuelle Schaltvorgang verzögert.</li>
- </ul><br>
- <p><a name="Hideki"></a>
- <h3>Hideki</h3>
- <div class='langLinks'>[<a href='commandref.html#Hideki'>EN</a> DE]</div>
- <ul>
- Das Hideki module dekodiert empfangene Nachrichten von Wettersensoren, welche das Hideki Protokoll verwenden.
- <br><br>
-
- <a name="Hideki_define"></a>
- <b>Unterstuetzte Hersteller</b>
- <ul>
- <li>Hama</li>
- <li>Bresser</li>
- <li>TFA Dostman</li>
- <li>Arduinos with remote Sensor lib from Randy Simons</li>
- <li>Cresta</li>
- <li>Hideki (Anemometer | UV sensor | Rain level meter | Thermo/hygro-sensor)</li>
- <li>Alle anderen, welche das Hideki Protokoll verwenden</li>
- </ul>
- Hinweis, Aktuell sind nur temp/feuchte Sensoren implementiert. Bitte sendet uns Daten zu anderen Sensoren.
-
- <a name="Hideki_define"></a>
- <b>Define</b>
- <ul>
- <li><code>define <name> Hideki <code> </code></li>
- <li>
- <br>
- <code> besteht aus dem Sensortyp und der Kanalnummer (1..5) oder wenn das Attribut longid im IO Device gesetzt ist aus einer Zufallsadresse, die durch den Sensor beim einlegen der
- Batterie generiert wird (Die Adresse aendert sich bei jedem Batteriewechsel).<br>
- </li>
- <li>Wenn autocreate aktiv ist, dann wird der Sensor automatisch in FHEM angelegt. Das ist der empfohlene Weg, neue Sensoren hinzuzufügen.</li>
-
- </ul>
- <br>
- <a name="Hideki_readings"></a>
- <b>Generated Readings</b>
- <ul>
- <li>state (T:x H:y B:z)</li>
- <li>temperature (°C)</li>
- <li>humidity (0-100)</li>
- <li>battery (ok oder low)</li>
- <li>channel (Der Sensor Kanal)</li>
- <br><i>- Hideki spezifisch -</i>
- <li>comfort_level (Status: Humidity OK... , Wet größer 69% RH, Dry weiniger als 40% RH, Temperature and humidity comfortable)</li>
- <li>package_number (Paketnummer in der letzten Signalfolge, startet bei 1)</li><br>
- </ul>
- <a name="Hideki_unset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="Hideki_unget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="Hideki_attr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="HourCounter"></a>
- <h3>HourCounter</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#HourCounter'>HourCounter</a><br/>
- </ul>
- <a name="Hyperion"></a>
- <h3>Hyperion</h3>
- <div class='langLinks'>[<a href='commandref.html#Hyperion'>EN</a> DE]</div>
- <ul>
- Mit <i>Hyperion</i> ist es möglich auf einem Hyperion Server die Farbe oder den Effekt einzustellen.<br>
- Es ist auch möglich eine komplette Farbkalibrierung vorzunehmen (Änderungen sind temporär und werden nicht in die Konfigurationsdatei geschrieben).<br>
- Der Hyperion Server muss dem JSON Server aktiviert haben.<br>
- Es ist auch möglich Hyperion mit verschiedenen Konfigurationsdateien zu starten (z.B. mit anderem Eingang/Grabber)<br>
- <br>
- <a name="Hyperion_define"></a>
- <p><b>Define</b></p>
- <ul>
- <code>define <name> Hyperion <IP oder HOSTNAME> <PORT> [<INTERVAL>]</code><br>
- </ul>
- <br>
- <INTERVAL> ist optional für automatisches Abfragen.<br>
- <br>
- <i>Nach dem Definieren des Gerätes wird einmalig und automatisch "get <name> statusRequest" aufgerufen um den aktuellen Status und die verfügbaren Effekte vom Hyperion Server zu holen.</i><br>
- <br>
- Beispiel für Hyperion auf dem lokalen System:
- <br><br>
- <ul>
- <code>define Ambilight Hyperion localhost 19444 10</code><br>
- </ul>
- <br>
- Beispiel für Hyperion auf einem entfernten System:
- <br><br>
- <ul>
- <code>define Ambilight Hyperion 192.168.1.4 19444 10</code><br>
- </ul>
- <br>
- <a name="Hyperion_set"></a>
- <p><b>set <benötigt> [optional]</b></p>
- <ul>
- <li>
- <i>addEffect <eigener_name></i><br>
- fügt den aktuellen Effekt mit dem übergebenen Namen den eigenen Effekten hinzu<br>
- kann nachträglich im Attribut hyperionCustomEffects geändert werden<br>
- Gerät muss dazu im Effekt Modus in einen nicht-eigenen Effekt sein und der übergebene Name muss ein einmaliger Effektname sein
- </li>
- <li>
- <i>adjustBlue <0,0,255></i><br>
- Justiert jede Farbe von Blau separat (Komma separiert) (R,G,B)<br>
- Werte von 0 bis 255 in Schritten von 1
- </li>
- <li>
- <i>adjustGreen <0,255,0></i><br>
- Justiere jede Farbe von Grün separat (Komma separiert) (R,G,B)<br>
- Werte von 0 bis 255 in Schritten von 1
- </li>
- <li>
- <i>adjustRed <255,0,0></i><br>
- Justiert jede Farbe von Rot separat (Komma separiert) (R,G,B)<br>
- Werte von 0 bis 255 in Schritten von 1
- </li>
- <li>
- <i>blacklevel <0.00,0.00,0.00></i><br>
- Justiert den Schwarzwert von jeder Farbe separat (Komma separiert) (R,G,B)<br>
- Werte von 0.00 bis 1.00 in Schritten von 0.01
- </li>
- <li>
- <i>clear <1000></i><br>
- einen bestimmten Prioritätskanal löschen
- </li>
- <li>
- <i>clearall</i><br>
- alle Prioritätskanäle löschen / Umschaltung auf Ambilight
- </li>
- <li>
- <i>colorTemperature <255,255,255></i><br>
- Justiert die Temperatur von jeder Farbe separat (Komma separiert) (R,G,B)<br>
- Werte von 0 bis 255 in Schritten von 1
- </li>
- <li>
- <i>configFile <Dateiname></i><br>
- Neustart des Hyperion Servers mit der angegebenen Konfigurationsdatei (Dateien werden automatisch aufgelistet aus Verzeichnis welches im Attribut hyperionConfigDir angegeben ist)<br>
- Bitte die doppelte Endung weglassen (.config.json)<br>
- Nur verfügbar nach erfolgreichem "get <name> configFiles"
- </li>
- <li>
- <i>correction <255,255,255></i><br>
- Justiert die Korrektur von jeder Farbe separat (Komma separiert) (R,G,B)<br>
- Werte von 0 bis 255 in Schritten von 1
- </li>
- <li>
- <i>dim <Prozent> [Dauer] [Priorität]</i><br>
- Dimmt das RGB Licht auf angegebenen Prozentwert, mit optionaler Dauer in Sekunden und optionaler Priorität
- </li>
- <li>
- <i>dimDown [delta]</i><br>
- Abdunkeln des RGB Lichts um angegebenen Prozentwert oder um Prozentwert der im Attribut hyperionDimStep eingestellt ist (Voreinstellung: 10)
- </li>
- <li>
- <i>dimUp [delta]</i><br>
- Aufhellen des RGB Lichts um angegebenen Prozentwert oder um Prozentwert der im Attribut hyperionDimStep eingestellt ist (Voreinstellung: 10)
- </li>
- <li>
- <i>effect <effect> [Dauer] [Priorität] [effectargs]</i><br>
- Stellt gewählten Effekt ein (ersetzte Leerzeichen mit Unterstrichen) mit optionaler Dauer in Sekunden und optionaler Priorität<br>
- effectargs können ebenfalls übermittelt werden - muss ein JSON String ohne Leerzeichen sein
- </li>
- <li>
- <i>gamma <1.90,1.90,1.90></i><br>
- Justiert Gamma von jeder Farbe separat (Komma separiert) (R,G,B)<br>
- Werte von 0.00 bis 5.00 in Schritten von 0.01
- </li>
- <li>
- <i>luminanceGain <1.00></i><br>
- Justiert Helligkeit<br>
- Werte von 0.00 bis 5.00 in Schritten von 0.01
- </li>
- <li>
- <i>luminanceMinimum <0.00></i><br>
- Justiert Hintergrundbeleuchtung<br>
- Werte von 0.00 bis 5.00 in Schritten von 0.01
- </li>
- <li>
- <i>mode <clearall|effect|off|rgb></i><br>
- Setzt das Licht im gewählten Modus mit dem zuletzt für diesen Modus eingestellten Wert
- </li>
- <li>
- <i>off</i><br>
- Schaltet aus mit Farbe schwarz
- </li>
- <li>
- <i>on</i><br>
- Schaltet mit letztem Modus und letztem Wert ein
- </li>
- <li>
- <i>rgb <RRGGBB> [Dauer] [Priorität]</i><br>
- Setzt Farbe im RGB Hex Format mit optionaler Dauer in Sekunden und optionaler Priorität
- </li>
- <li>
- <i>saturationGain <1.10></i><br>
- Justiert Sättigung<br>
- Werte von 0.00 bis 5.00 in Schritten von 0.01
- </li>
- <li>
- <i>saturationLGain <1.00></i><br>
- Justiert minimale Sättigung<br>
- Werte von 0.00 bis 5.00 in Schritten von 0.01
- </li>
- <li>
- <i>threshold <0.16,0.16,0.16></i><br>
- Justiert den Schwellenwert von jeder Farbe separat (Komma separiert) (R,G,B)<br>
- Werte von 0.00 bis 1.00 in Schritten von 0.01
- </li>
- <li>
- <i>toggle</i><br>
- Schaltet zwischen an und aus hin und her
- </li>
- <li>
- <i>toggleMode</i><br>
- Schaltet alle Modi durch
- </li>
- <li>
- <i>valueGain <1.70></i><br>
- Justiert Helligkeit vom Ambilight<br>
- Werte von 0.00 bis 5.00 in Schritten von 0.01
- </li>
- <li>
- <i>whitelevel <0.70,0.80,0.90></i><br>
- Justiert den Weißwert von jeder Farbe separat (Komma separiert) (R,G,B)<br>
- Werte von 0.00 bis 1.00 in Schritten von 0.01
- </li>
- </ul>
- <br>
- <a name="Hyperion_get"></a>
- <p><b>Get</b></p>
- <ul>
- <li>
- <i>configFiles</i><br>
- Holt die verfügbaren Konfigurationsdateien aus dem Verzeichnis vom Attribut hyperionConfigDir<br>
- Es müssen mindestens zwei Konfigurationsdateien im Verzeichnis vorhanden sein. Die Dateien dürfen keine Leerzeichen enthalten und müssen mit .config.json enden!
- </li>
- <li>
- <i>devStateIcon</i><br>
- Zeigt den Wert des aktuellen devStateIcon
- </li>
- <li>
- <i>statusRequest</i><br>
- Holt den aktuellen Status vom Hyperion Server,<br>
- holt auch die Internals vom Hyperion Server inklusive verfügbarer Effekte
- </li>
- </ul>
- <br>
- <a name="Hyperion_attr"></a>
- <p><b>Attribute</b></p>
- <ul>
- <li>
- <i>disable</i><br>
- Abfragen beenden und Verbindung trennen<br>
- Voreinstellung: 0
- </li>
- <li>
- <i>hyperionBin</i><br>
- Pfad zum Hyperion Daemon<br>
- OpenELEC Benutzer müssen eventuell hyperiond.sh als Daemon einstellen<br>
- Voreinstellung: /usr/bin/hyperiond
- </li>
- <li>
- <i>hyperionConfigDir</i><br>
- Pfad zu den Hyperion Konfigurationsdateien<br>
- Voreinstellung: /etc/hyperion/
- </li>
- <li>
- <i>hyperionCustomEffects</i><br>
- Leerzeichen separierte Liste von JSON Strings (ohne Leerzeichen - bitte Leerzeichen in Effektnamen durch Unterstriche ersetzen)<br>
- muss name (als Anzeigename), oname (Name des basierenden Effekts) und args (die eigentlichen unterschiedlichen Effekt Argumente) beinhalten (auch genau in dieser Reihenfolge, sonst kommt beim Übernehmen des Attributs ein Fehler und das Attribut wird nicht gespeichert)<br>
- Beispiel: {"name":"Knight_Rider_speed_2","oname":"Knight_rider","args":{"color":[255,0,255],"speed":2}} {"name":"Knight_Rider_speed_4","oname":"Knight_rider","args":{"color":[0,0,255],"speed":4}}
- </li>
- <li>
- <i>hyperionDefaultDuration</i><br>
- Voreinstellung für Dauer<br>
- Voreinstellung: 0 = unendlich
- </li>
- <li>
- <i>hyperionDefaultPriority</i><br>
- Voreinstellung für Priorität<br>
- Voreinstellung: 0 = höchste Priorität
- </li>
- <li>
- <i>hyperionDimStep</i><br>
- Dimmstufen für dimDown/dimUp<br>
- Voreinstellung: 10 (Prozent)
- </li>
- <li>
- <i>hyperionGainStep</i><br>
- valueGain Dimmstufen für valueGainDown/valueGainUp<br>
- Voreinstellung: 0.1
- </li>
- <li>
- <i>hyperionNoSudo</i><br>
- Deaktiviert sudo für nicht root SSH Benutzer<br>
- Voreinstellung: 0
- </li>
- <li>
- <i>hyperionSshUser</i><br>
- Benutzername mit dem SSH Befehle ausgeführt werden sollen<br>
- Voreinstellung: pi
- </li>
- <li>
- <i>hyperionToggleModes</i><br>
- Modi und Reihenfolge von toggleMode als kommaseparierte Liste (min. 2 Werte, max. 4 Werte, jeder Mode nur 1x)<br>
- Voreinstellung: clearall,rgb,effect,off
- </li>
- <li>
- <i>hyperionVersionCheck</i><br>
- Deaktiviert Hyperion Versionüberprüfung um (eventuell) ältere Hyperion Versionen zu unterstützen<br>
- DAS GESCHIEHT AUF EIGENE VERANTWORTUNG! FHEM KÖNNTE UNERWARTET ABSTÜRTZEN!<br>
- Voreinstellung: 1
- </li>
- <li>
- <i>queryAfterSet</i><br>
- Wenn gesetzt auf 0 wird der Status des Hyperion Server nach einem set Befehl nicht abgerufen, stattdessen wird der Status zum nächsten eingestellten Interval abgerufen.<br>
- Das wird nur verwendet wenn das priodische Abfragen aktiviert ist, ohne dieses Abfragen wird der Status automatisch nach dem set Befehl abgerufen.<br>
- Voreinstellung: 1
- </li>
- </ul>
- <br>
- <a name="Hyperion_read"></a>
- <p><b>Readings</b></p>
- <ul>
- <li>
- <i>adjustBlue</i><br>
- jede Farbe von Blau separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>adjustGreen</i><br>
- jede Farbe von Grün separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>adjustRed</i><br>
- jede Farbe von Rot separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>blacklevel</i><br>
- Schwarzwert von jeder Farbe separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>colorTemperature</i><br>
- Temperatur von jeder Farbe separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>configFile</i><br>
- aktive/zuletzt geladene Konfigurationsdatei, doppelte Endung (.config.json) wird weggelassen
- </li>
- <li>
- <i>correction</i><br>
- Korrektur von jeder Farbe separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>dim</i><br>
- aktive/letzte Dimmstufe (RGB Licht)
- </li>
- <li>
- <i>duration</i><br>
- aktive/letzte/verbleibende primäre Dauer in Sekunden oder infinite für unendlich
- </li>
- <li>
- <i>effect</i><br>
- aktiver/letzter Effekt
- </li>
- <li>
- <i>effectArgs</i><br>
- aktive/letzte Effekt Argumente als JSON
- </li>
- <li>
- <i>gamma</i><br>
- Gamma von jeder Farbe separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>id</i><br>
- ID vom Hyperion Server
- </li>
- <li>
- <i>lastError</i><br>
- letzter aufgetretener Fehler während der Kommunikation mit dem Hyperion Server
- </li>
- <li>
- <i>luminanceGain</i><br>
- aktive Helligkeit
- </li>
- <li>
- <i>luminanceMinimum</i><br>
- aktive Hintergrundbeleuchtung
- </li>
- <li>
- <i>mode</i><br>
- aktiver Modus
- </li>
- <li>
- <i>mode_before_off</i><br>
- letzter Modus vor aus
- </li>
- <li>
- <i>priority</i><br>
- aktive/letzte Priorität
- </li>
- <li>
- <i>rgb</i><br>
- aktive/letzte RGB Farbe
- </li>
- <li>
- <i>saturationGain</i><br>
- aktive Sättigung
- </li>
- <li>
- <i>saturationLGain</i><br>
- aktive minimale Sättigung
- </li>
- <li>
- <i>serverResponse</i><br>
- letzte Hyperion Server Antwort (success/ERROR)
- </li>
- <li>
- <i>state</i><br>
- aktiver Status
- </li>
- <li>
- <i>threshold</i><br>
- Schwellenwert von jeder Farbe separat (Komma separiert) (R,G,B)
- </li>
- <li>
- <i>valueGain</i><br>
- aktive Helligkeit vom Ambilight
- </li>
- <li>
- <i>whitelevel</i><br>
- Weißwert von jeder Farbe separat (Komma separiert) (R,G,B)
- </li>
- </ul>
- </ul>
- <p><a name="I2C_BH1750"></a>
- <h3>I2C_BH1750</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#I2C_BH1750'>I2C_BH1750</a><br/>
- </ul>
- <a name="I2C_BME280"></a>
- <h3>I2C_BME280</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_BME280'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_BME280">en</a> | de)
- <ul>
- <a name="I2C_BME280"></a>
- Ermöglicht die Verwendung eines digitalen (Luft)druck/feuchtesensors BME280 über den I2C Bus des Raspberry Pi.<br><br>
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
-
- <b>Define</b>
- <ul>
- <code>define BME280 <BME280_name> [<I2C Addresse>]</code><br><br>
- Fehlt <code><I2C Address></code> wird 0x76 verwendet<br>
- <br>
- Beispiel:
- <pre>
- define BME280 I2C_BME280 0x77
- attr BME280 poll_interval 5
- </pre>
- </ul>
- <a name="I2C_BME280set"></a>
- <b>Set</b>
- <ul>
- <code>set BME280 readValues</code>
- <br><br>
- <code>set <name> readValues</code><br>
- Aktuelle Temperatur, Feuchte und Luftdruck Werte vom Sensor lesen.<br><br>
- </ul>
- <a name="I2C_BME280attr"></a>
- <b>Attribute</b>
- <ul>
- <li>oversampling_t,oversampling_h,oversampling_p<br>
- Steuert das jeweils das Oversampling der Temperatur-, Feuchte-, oder Druckmessung im Sensor.<br>
- Standard: 1, gültige Werte: 0, 1, 2, 3, 4, 5<br>
- 0 deaktiviert die jeweilige Messung<br>
- 1 to 5 entspricht einem Oversampling von 2^zahl/2<br><br>
- </li>
- <li>poll_interval<br>
- Definiert das Poll Intervall in Minuten für das Auslesen einer neuen Messung.<br>
- Default: 5, gültige Werte: 1, 2, 5, 10, 20, 30<br><br>
- </li>
- <li>roundTemperatureDecimal, roundHumidityDecimal, roundPressureDecimal<br>
- Rundet jeweils den Temperatur-, Feuchte-, oder Druckwert mit den angegebenen Nachkommastellen.<br>
- Standard: 1, gültige Werte: 0, 1, 2<br><br>
- </li>
- <li>altitude<br>
- Wenn dieser Wert definiert ist, wird diese Angabe zusä für die Berechnung des
- Luftdrucks bezogen auf Meereshöhe (Normalnull) NN herangezogen.<br>
- Bemerkung: Dies ist ein globales Attribut.<br><br>
- <code>attr global altitude 220</code>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_BMP180"></a>
- <h3>I2C_BMP180</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_BMP180'>EN</a> DE]</div>
- <ul>
- <a name="I2C_BMP180"></a>
- <p>
- Dieses Modul ermöglicht das Auslesen der digitalen (Luft)drucksensoren
- BMP085 und BMP180 über den I2C Bus des Raspberry Pi.<br><br>
- <b>Es gibt zwei Möglichkeiten das Modul mit dem I2C Bus zu verbinden:</b><br>
- <ul>
- <li><b>Über das RPII2C Modul</b><br>
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br><br>
- </li>
- <li><b>Über die HiPi Bibliothek</b><br>
- Diese beiden Zeilen müssen in die Datei <b>/etc/modules</b> angefügt werden,
- um die Kernel Module automatisch beim Booten des Raspberry Pis zu laden.<br>
- <code><pre>i2c-bcm2708
- i2c-dev</pre></code>
- Installation des HiPi Perl Moduls:<br>
- <code><pre>wget http://raspberry.znix.com/hipifiles/hipi-install
- perl hipi-install</pre></code>
- Um die Rechte für die I2C Devices anzupassen, folgende Datei:<br>
- <code><pre> /etc/udev/rules.d/98_i2c.rules</pre></code>
- mit diesem Inhalt anlegen:<br>
- <code><pre>SUBSYSTEM=="i2c-dev", MODE="0666"</pre></code>
- <b>Reboot</b><br><br>
- Falls der Sensor am zweiten I2C Bus am Stecker P5 (nur in Version 2 des
- Raspberry Pi) verwendet werden soll, muss die fett gedruckte Zeile
- des folgenden Codes in das FHEM Start Skript aufgenommen werden:
- <code><pre> case "$1" in
- 'start')
- <b>sudo hipi-i2c e 0 1</b>
- ...</pre></code>
- </li></ul>
- <p>
-
- <b>Define</b>
- <ul>
- <code>define BMP180 <BMP180_name> <I2C_device></code><br><br>
- <I2C device> darf nicht verwendet werden, wenn der I2C Bus über das RPII2C Modul angesprochen wird. Für HiPi ist es allerdings notwendig. <br>
- <br>
- Beispiel:
- <pre>
- define BMP180 I2C_BMP180 /dev/i2c-0
- attr BMP180 oversampling_settings 3
- attr BMP180 poll_interval 5
- </pre>
- <pre>
- define BMP180 I2C_BMP180
- attr BMP180 IODev RPiI2CMod
- attr BMP180 oversampling_settings 3
- attr BMP180 poll_interval 5
- </pre>
- </ul>
- <a name="I2C_BMP180set"></a>
- <b>Set</b>
- <ul>
- <code>set BMP180 readValues</code>
- <br><br>
- Liest die aktuelle Temperatur und den Luftdruck des Sensors aus.<br>
- Dies wird automatisch nach Ablauf des definierten Intervalls ausgeführt.
- Wenn der aktuelle Wert gelesen werden soll, kann dieser Befehl auch manuell
- ausgeführt werden.
- <br><br>
- </ul>
- <a name="I2C_BMP180get"></a>
- <b>Get</b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="I2C_BMP180attr"></a>
- <b>Attribute</b>
- <ul>
- <li>oversampling_settings<br>
- Steuert das Oversampling der Druckmessung im Sensor.<br>
- Default: 3, gültige Werte: 0, 1, 2, 3<br><br>
- </li>
- <li>poll_interval<br>
- Definiert das Poll Intervall in Minuten für das Auslesen einer neuen Messung.<br>
- Default: 5, gültige Werte: 1, 2, 5, 10, 20, 30<br><br>
- </li>
- <li>roundTemperatureDecimal<br>
- Rundet den Temperaturwert mit den angegebenen Nachkommastellen.<br>
- Default: 1, gültige Werte: 0, 1, 2<br><br>
- </li>
- <li>roundPressureDecimal<br>
- Rundet die Drucksensorwerte mit den angegebenen Nachkommastellen.<br>
- Default: 1, valid values: 0, 1, 2<br><br>
- </li>
- <li>altitude<br>
- Wenn dieser Wert definiert ist, wird diese Angabe zusätzlich für die Berechnung des
- Luftdrucks bezogen auf Meereshöhe (Normalnull) NN herangezogen.<br>
- Bemerkung: Dies ist ein globales Attribut.<br><br>
- <code>attr global altitude 220</code>
- </li>
- </ul>
- <br>
-
- <b>Hinweise</b>
- <ul>
- <li>I2C-Bustiming<br>
- Zur Abfrage des Sensors wird von einer I2C-Schnittstelle mit blockierendem IO-Zugriff (z.B. RPII2C) ausgegangen.
- Bei I2C-Schnittstellen, die nicht-blockierend arbeiten (z.B. FRM mit Ethernet), kann es zu Verarbeitungsfehlern kommen,
- insbesondere wenn das Attribut oversampling_settings auf einen Wert größer 1 eingestellt wird.
- Dies lässt sich je nach I2C-Schnittstelle kompensieren. Bei Firmata empfiehlt es sich,
- das Attribut i2c-config im Modul FRM auf einen Wert von ca. 30000 Mikrosekunden einzustellen.<br><br>
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_DS1307"></a>
- <h3>I2C_DS1307</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#I2C_DS1307'>I2C_DS1307</a><br/>
- </ul>
- <a name="I2C_EEPROM"></a>
- <h3>I2C_EEPROM</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_EEPROM'>EN</a> DE]</div>
- <ul>
- <a name="I2C_EEPROM"></a>
- Ermöglicht die Verwendung I2C EEPROM.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_EEPROMDefine"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_EEPROM <I2C Address></code><br>
- Der Wert <code><I2C Address></code> ist ohne das Richtungsbit
- </ul>
- <a name="I2C_EEPROMSet"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <byte address> <value></code><br><br>
- <code><byte address></code> ist die Registeradresse (0..IC abhängig) und <code><value></code> der Registerinhalt (0..255)<br>
- Beide Zahlen können sowohl eine Dezimal- als auch eine Hexadezimalzahl sein.<br>
- <br>
- Beispiel:
- <ul>
- <code>set eeprom1 0x02 0xAA</code><br>
- <code>set eeprom1 2 170</code><br>
- </ul><br>
- </ul>
- <a name="I2C_EEPROMGet"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Aktualisierung aller Werte
- </ul><br>
- <ul>
- <code>get <name> <byte address> [Bit<bitnumber(0..7)>]</code>
- <br><br>
- Gibt den Inhalt des in <byte address> angegebenen Registers zurück, bzw. ein einzelnes Bit davon.<br>
- Achtung mit diesem Befehl werden nur die Werte aus den Readings angezeigt und nicht der Registerinhalt selbst!
- </ul><br>
- <a name="I2C_EEPROMAttr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: -, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>EEPROM_size<br>
- Speichergröße des EEPROM<br>
- Standard: 128, gültige Werte: 128 (128bit), 2k (2048bit)<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_EMC1001"></a>
- <h3>I2C_EMC1001</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_EMC1001'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_EMC1001">en</a> | de)
- <ul>
- <a name="I2C_EMC1001"></a>
- Ermöglicht die Verwendung eines digitalen Temperatur EMC1001 über den I2C Bus des Raspberry Pi.<br><br>
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <b>Define</b>
- <ul>
- <code>define EMC1001 <EMC1001_name> [<I2C Addresse>]</code><br><br>
- Fehlt <code><I2C Address></code> wird 0x48 verwendet<br>
- <br>
- Beispiel:
- <pre>
- define EMC1001 I2C_EMC1001 0x48
- attr EMC1001 poll_interval 5
- attr roundTemperatureDecimal 2
- </pre>
- </ul>
- <a name="I2C_EMC1001set"></a>
- <b>Set</b>
- <ul>
- <code>set EMC1001 readValues</code>
- <br><br>
- <code>set <name> readValues</code><br>
- Aktuelle Temperatur Werte vom Sensor lesen.<br><br>
- </ul>
- <a name="I2C_EMC1001attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Definiert das Poll Intervall in Minuten für das Auslesen einer neuen Messung.<br>
- Default: 5, gültige Werte: 1, 2, 5, 10, 20, 30<br><br>
- </li>
- <li>roundTemperatureDecimal<br>
- Rundet jeweils den Temperaturwert mit den angegebenen Nachkommastellen.<br>
- Standard: 1, gültige Werte: 0, 1, 2<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_HDC1008"></a>
- <h3>I2C_HDC1008</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_HDC1008'>EN</a> DE]</div>
- <ul>
- <a name="I2C_HDC1008"></a>
- Ermöglicht die Verwendung eines I2C_HDC1008 I2C Feuchtesensors von <a href=" http://www.ti.com">Texas Instruments</a>.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_HDC1008Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_HDC1008 [<I2C Address>]</code><br>
- Der Wert <code><I2C Address></code> ist ein zweistelliger Hex-Wert<br>
- </ul>
- <a name="I2C_HDC1008Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> Update</code><br>
- Aktuelle Temperatur und Feuchte Werte vom Sensor lesen.<br><br>
- <code>set <name> Reset</code><br>
- Setzt den Sensor zurück
- <code>set <name> Heater {on|off}</code><br>
- Schaltet das Heizelement des Sensors an oder aus
- </ul>
- <a name="I2C_HDC1008Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: 1,2,5,10,20,30<br><br>
- </li>
- <li>Resolution_Temperature<br>
- Genauigkeit mit der die Temperatur gemessen werden soll.<br>
- Standard: 14Bit, gültige Werte: 11Bit, 14Bit<br><br>
- </li>
- <li>Resolution_Humidity<br>
- Genauigkeit mit der die Feuchtigkeit gemessen werden soll.<br>
- Standard: 14Bit, gültige Werte: 8Bit, 11Bit, 14Bit<br><br>
- </li>
- <li>roundHumidityDecimal<br>
- Anzahl Dezimalstellen für den Feuchtewert<br>
- Standard: 1, gültige Werte: 0 1 2<br><br>
- </li>
- <li>roundTemperatureDecimal<br>
- Anzahl Dezimalstellen für den Temperaturwert<br>
- Standard: 1, gültige Werte: 0,1,2<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- </ul><br>
- </ul>
- =end html
- =cut<a name="I2C_K30"></a>
- <h3>I2C_K30</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_K30'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_K30">en</a> | de)
- <ul>
- <a name="I2C_K30"></a>
- Ermöglicht die Verwendung eines K30 CO2 Sensors von <a href="www.senseair.com">SenseAir</a>. Der Sensor
- muss über I2C angeschlossen sein (siehe z.B.
- <a href="http://co2meters.com/Documentation/AppNotes/AN142-RaspberryPi-K_series.pdf">Application Note 142 "K-30/K-33 I2C on Raspberry Pi"</a>
- von co2meters.com).
- Auf meinem Raspberry Pi 2 musste ich die I2C-Frequenz auf 90 kHz reduzieren, sonst sind die meisten I2C-Zugriffe fehlgeschlagen
- ("options i2c_bcm2708 baudrate=90000", z.B. in /etc/modprobe.d/i2c-options.conf eintragen). Nach wie vor gehen ca. 5 % der Zugriffe schief,
- aber das scheint normal zu sein - zumindest warnt das Datenblatt, dass I2C-Zugriffe fehlschlagen können, wenn der Microcontroller auf dem
- Sensor gerade mit einer CO2-Messung beschäftigt ist.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_K30Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_K30 [<I2C Address>]</code><br>
- Der Wert <code><I2C Address></code> ist die konfigurierte I2C-Adresse des Sensors (Standard: 104 bzw. 0x68)<br>
- </ul>
- <a name="I2C_K30Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> readValues</code><br>
- Aktuellen CO2 Wert vom Sensor lesen.<br><br>
- </ul>
- <a name="I2C_K30Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: 1,2,5,10,20,30<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_LCD"></a>
- <h3>I2C_LCD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#I2C_LCD'>I2C_LCD</a><br/>
- </ul>
- <a name="I2C_LM75A"></a>
- <h3>I2C_LM75A</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_LM75A'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_LM75A">en</a> | de)
- <ul>
- <a name="I2C_LM75A"></a>
- Ermöglicht die Verwendung eines LM75A I2C Temperatursensors.</a>.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_LM75ADefine"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_LM75A [<I2C Address>]</code><br>
- Der Wert <code><I2C Address></code> ist ein zweistelliger Hex-Wert<br>
- </ul>
- <a name="I2C_LM75ASet"></a>
- <b>Set</b>
- <ul>
- <code>set <name> readValues</code><br>
- Aktuelle Temperatur Werte vom Sensor lesen.<br><br>
- </ul>
- <a name="I2C_LM75AAttr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: 1,2,5,10,20,30<br><br>
- </li>
- <li>roundTemperatureDecimal<br>
- Anzahl Dezimalstellen für den Temperaturwert<br>
- Standard: 1, gültige Werte: 0 1 2<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_MCP23008"></a>
- <h3>I2C_MCP23008</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_MCP23008'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_MCP23008">en</a> | de)
- <ul>
- <a name="I2C_MCP23008"></a>
- Ermöglicht die Verwendung eines MCP23008 I2C 8 Bit Portexenders.
- Auf einem Raspberry Pi kann der Interrupt Pin des MCP23008 mit einem GPIO verbunden werden und über die Interrupt Funktionen von <a href="#RPI_GPIO">RPI_GPIO</a> lässt sich dann ein get für den MCP23008 bei Pegeländerung auslösen.<br>
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_MCP23008Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_MCP23008 <I2C Address></code><br>
- Der Wert <code><I2C Address></code> ist ohne das Richtungsbit<br>
- </ul>
- <a name="I2C_MCP23008Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <port[,port[...]]> <value></code><br><br>
- <code><port></code> kann PortA0 bis PortA7 annehmen und <code><value></code> folgende Werte:<br>
- <ul>
- <code>
- off<br>
- on<br>
- </code>
- </ul>
- <br>
- Beispiel:
- <ul>
- <code>set mod1 PortA4 on</code><br>
- <code>set mod1 PortA4,PortA6 off</code><br>
- <code>set mod1 PortA4,A6 on</code><br>
- </ul><br>
- </ul>
- <a name="I2C_MCP23008Get"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Aktualisierung aller Werte
- </ul><br>
- <a name="I2C_MCP23008Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: -, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>OutputPorts<br>
- Durch Komma getrennte Ports die als Ausgänge genutzt werden sollen.<br>
- Nur Ports in dieser Liste können gesetzt werden.<br>
- Standard: -, gültige Werte: A0-A7<br><br>
- </li>
- <li>OnStartup<br>
- Durch Komma getrennte Output Ports und ihr gewünschter Status nach dem Start.<br>
- Ohne dieses Attribut werden alle Ausgänge nach dem Start auf den letzten Status gesetzt.<br>
- Standard: -, gültige Werte: <port>=on|off|last wobei <port> = A0-A7<br><br>
- </li>
- <li>Pullup<br>
- Durch Komma getrennte Input Ports, bei denen der interne 100k pullup aktiviert werden soll.<br>
- Standard: -, gültige Werte: A0-A7<br><br>
- </li>
- <li>Interrupt<br>
- Durch Komma getrennte Input Ports, die einen Interrupt auf IntA/B auslösen.<br>
- Standard: -, gültige Werte: A0-A7<br><br>
- </li>
- <li>invert_input<br>
- Durch Komma getrennte Input Ports, die reverse Logik nutzen.<br>
- Standard: -, gültige Werte: A0-A7<br><br>
- </li>
- <li>InterruptOut<br>
- Einstellungen für den INT Pin<br>
- gültige Werte:<br>
- <ul>
- <li>
- active-low (INT ist active low)
- </li>
- <li>
- active-high (INT ist active high)
- </li>
- <li>
- open-drain (INT ist open drain)
- </li><br>
- </ul>
- </li>
-
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_MCP23017"></a>
- <h3>I2C_MCP23017</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_MCP23017'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_MCP23017">en</a> | de)
- <ul>
- <a name="I2C_MCP23017"></a>
- Ermöglicht die Verwendung eines MCP23017 I2C 16 Bit Portexenders.
- Auf einem Raspberry Pi kann der Interrupt Pin des MCP23017 mit einem GPIO verbunden werden und über die Interrupt Funktionen von <a href="#RPI_GPIO">RPI_GPIO</a> lässt sich dann ein get für den MCP23017 bei Pegeländerung auslösen.<br>
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_MCP23017Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_MCP23017 <I2C Address></code><br>
- Der Wert <code><I2C Address></code> ist ohne das Richtungsbit<br>
- </ul>
- <a name="I2C_MCP23017Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <port[,port[...]]> <value></code><br><br>
- <code><port></code> kann PortA0 bis PortA7 / PortB0 bis PortB7 annehmen und <code><value></code> folgende Werte:<br>
- <ul>
- <code>
- off<br>
- on<br>
- </code>
- </ul>
- <br>
- Beispiel:
- <ul>
- <code>set mod1 PortA4 on</code><br>
- <code>set mod1 PortA4,PortB6 off</code><br>
- <code>set mod1 PortA4,B6 on</code><br>
- </ul><br>
- </ul>
- <a name="I2C_MCP23017Get"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Aktualisierung aller Werte
- </ul><br>
- <a name="I2C_MCP23017Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: -, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>OutputPorts<br>
- Durch Komma getrennte Ports die als Ausgänge genutzt werden sollen.<br>
- Nur Ports in dieser Liste können gesetzt werden.<br>
- Standard: -, gültige Werte: A0-A7, B0-B7<br><br>
- </li>
- <li>OnStartup<br>
- Durch Komma getrennte Output Ports und ihr gewünschter Status nach dem Start.<br>
- Ohne dieses Attribut werden alle Ausgänge nach dem Start auf den letzten Status gesetzt.<br>
- Standard: -, gültige Werte: <port>=on|off|last wobei <port> = A0-A7, B0-B7<br><br>
- </li>
- <li>Pullup<br>
- Durch Komma getrennte Input Ports, bei denen der interne 100k pullup aktiviert werden soll.<br>
- Standard: -, gültige Werte: A0-A7, B0-B7<br><br>
- </li>
- <li>Interrupt<br>
- Durch Komma getrennte Input Ports, die einen Interrupt auf IntA/B auslösen.<br>
- Standard: -, gültige Werte: A0-A7, B0-B7<br><br>
- </li>
- <li>invert_input<br>
- Durch Komma getrennte Input Ports, die reverse Logik nutzen.<br>
- Standard: -, gültige Werte: A0-A7, B0-B7<br><br>
- </li>
- <li>InterruptOut<br>
- Einstellungen für die INTA/INTB Pins<br>
- gültige Werte:<br>
- <ul>
- <li>
- separate_active-low (INTA/INTB sind für PortA/PortB getrennt und mit active low Logik)
- </li>
- <li>
- separate_active-high (INTA/INTB sind für PortA/PortB getrennt und mit active high Logik)
- </li>
- <li>
- separate_open-drain (INTA/INTB sind für PortA/PortB getrennt und arbeiten als open drain)
- </li>
- <li>
- connected_active-low (INTA/INTB sind intern verbunden und mit active low Logik)
- </li>
- <li>
- connected_active-high (INTA/INTB sind intern verbunden und mit active high Logik)
- </li>
- <li>
- connected_open-drain (INTA/INTB sind intern verbunden und arbeiten als open drain)
- </li><br>
- </ul>
- </li>
-
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_MCP342x"></a>
- <h3>I2C_MCP342x</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_MCP342x'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_MCP342x">en</a> | de)
- <ul>
- <a name="I2C_MCP342x"></a>
- Ermöglicht die Verwendung eines MCP3422/3/4 I2C A/D Wandler.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_MCP342xDefine"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_MCP342x [[<I2C Address>] <n channels>]</code><br>
- Der Wert <code><I2C Address></code> ist die I2C Adresse ohne Richtungsbit und <n channels> die Anzahl der A/D Kanäle.<br>
- </ul>
- <a name="I2C_MCP342xGet"></a>
- <b>Get</b>
- <ul>
- <code>get <name> [[[<channel>] <resolution> ] <gain>]</code><br>
- Aktuelle Werte vom entstrechenden <channel> lesen. <resolution> und <gain> überschreiben die entsprechenden Attribute für diesen Lesevorgang<br><br>
- </ul>
- <a name="I2C_MCP342xAttr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: 1,2,5,10,20,30<br><br>
- </li>
- Folgende Attribute existieren separat für alle Kanäle.<br><br>
- <li>ch1resolution<br>
- Auflösung des Kanals<br>
- Je größer die Auflösung desto länger die Lesezeit.<br>
- Standard: 12, gültige Werte: 12,14,16,18<br><br>
- </li>
- <li>ch1gain<br>
- Verstärkungsfaktor<br>
- Wichtig: Der Verstärkungsfaktor verringert den Messbereich entsprechend und kann zu einem Überlauf führen. In diesem Fall wird "overflow" an das reading angehängt.<br>
- Standard: 1, gültige Werte: 1,2,4,8<br><br>
- </li>
- <li>ch1factor<br>
- Korrekturfaktor (Wird zum Kanalwert multipliziert.)<br>
- Standard: 1, gültige Werte: Zahl<br><br>
- </li>
- <li>ch1roundDecimal<br>
- Anzahl Dezimalstellen für den Messwert<br>
- Standard: 3, gültige Werte: 0,1,2,3<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_MMA845X"></a>
- <h3>I2C_MMA845X</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#I2C_MMA845X'>I2C_MMA845X</a><br/>
- </ul>
- <a name="I2C_PCA9532"></a>
- <h3>I2C_PCA9532</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_PCA9532'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_PCA9532">en</a> | de)
- <ul>
- <a name="I2C_PCA9532"></a>
- Ermöglicht die Verwendung eines PCA9532 I2C 16 Kanal PWM IC.
- Das PCA9532 hat 2 unabhängige PWM Stufen. Jeder Kanal kanne einer der Stufen zugeordnet werden oder direkt auf off/on gesetzt werden.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_PCA9532Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_PCA9532 <I2C Address></code><br>
- Der Wert <code><I2C Address></code> ist ein zweistelliger Hex-Wert<br>
- </ul>
- <a name="I2C_PCA9532Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <port> <value></code><br><br>
- <ul>
- <li>wenn als <code><port></code> Port0 bis Port15 verwendet wird, dann ist <code><value></code> einer dieser Werte:<br>
- <ul>
- <code>
- off<br>
- on<br>
- PWM0 (Port wird auf PWM0 Frequenz- und Pulsweiteneinstellung gesetzt)<br>
- PWM1 (Port wird auf PWM1 Frequenz- und Pulsweiteneinstellung gesetzt)<br>
- </code>
- </ul>
- </li>
- <li>
- wenn als <code><port></code> PWM0 oder PWM1 verwendet wird, ist <code><value></code> ein Wert zwischen 0 und 255 ensprechend der Pulsweite der PWM Stufe.
- </li>
- </ul>
- <br>
- Beispiele:
- <ul>
- <code>set mod1 Port4 PWM1</code><br>
- <code>set mod1 PWM1 128</code><br>
- </ul><br>
- </ul>
- <a name="I2C_PCA9532Get"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Aktualisierung aller Werte
- </ul><br>
- <a name="I2C_PCA9532Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: -, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>OutputPorts<br>
- Durch Komma getrennte Portnummern die als Outputs genutzt werden.<br>
- Nur Ports in dieser Liste können geschrieben werden.<br>
- Standard: no, gültige Werte: 0 1 2 .. 15<br><br>
- </li>
- <li>OnStartup<br>
- Durch Komma getrennte Output Ports/PWM Register und ihr gewünschter Status nach dem Start.<br>
- Ohne dieses Attribut werden alle Ausgänge nach dem Start auf den letzten Status gesetzt.<br>
- Standard: -, gültige Werte: <port>=on|off|PWM0|PWM1|last oder PWM0|PWM1=0..255|last wobei <port> = 0 - 15<br><br>
- </li>
- <li>T0/T1<br>
- Änderung der Frequenzwerte von PWM0/PWM1 nach der Formel: Fx = 152/(Tx + 1). Der entsprechende Frequenzwert wird unter Internals angezeigt.<br>
- Standard: 0 (152Hz), gültige Werte: 0-255<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_PCA9685"></a>
- <h3>I2C_PCA9685</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_PCA9685'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_PCA9685">en</a> | de)
- <ul>
- <a name="I2C_PCA9685"></a>
- Ermöglicht die Verwendung eines PCA9685 I2C 16 Kanal PWM IC.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_PCA9685Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_PCA9685 <I2C Address> [<I2C Buffer Size>]</code><br>
- Der Wert <code><I2C Address></code> ist ein zweistelliger Hex-Wert im Format 0xnn oder eine Dezimalzahl<br>
- <code><I2C Buffer Size></code> gibt die maximale Anzahl von Datenbytes pro I2C Datenpaket an. Nicht angegeben, wird der Wert 30 verwendet
- ( entspricht 32 Bytes incl. Adresse und Registernummer). RPII2C kann mit beliebig großen Paketlängen umgehen, daher ist diese Option dort inaktiv.<br>
- </ul>
- <a name="I2C_PCA9685Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <port> <dimvalue> [<delay>]</code><br><br>
- <li>Als <code><port></code> kann Port00 bis Port15 verwendet werden<br>
- <code><dimvalue></code> kann folgende Werte annehmen:<br>
- <ul>
- <code>
- off<br>
- on<br>
- 0..4095<br>
- </code>
- </ul>
- <code><delay></code> gibt den Wert innerhalb der Zählschleife an, an dem der Ausgang eingeschaltet wird.
- Damit lassen sich die 16 Ausgänge zu unterschiedlichen Zeiten einschalten um Stromspitzen zu minimieren.
- Dieser Wert hat keinerlei Einfluss auf die Pulsbreite. Stardartwert ist 0, mögliche Werte sind 0..4095<br>
- </li>
- <li>
- Um mehrer Ports mit einem Befehl zu ändern können mehrere Befehle per Komma getrennt eingegeben werden.
- Dabei kann jeder Port auf einen separaten, oder alle Ports auf den selben Wert gesettz werden.
- Fär letzteres darf nur der letzte Befehl dimvalue (und delay) enthalten.
- Aufeinanerfolgene Ports werden mit einem Befehl geschrieben. So können beispielsweise multicolor LED's ohne flackern geschaltet werden.<br>
- Anstelle von Port kann auch einfach ein P verwendet werden.
- </li>
- <br>
- Examples:
- <ul>
- <code>set mod1 Port04 543</code><br>
- <code>set mod1 Port4 434 765</code><br>
- <code>set mod1 Port1, Port2, Port14 434 765</code><br>
- <code>set mod1 Port1 on, P14 434 765</code><br>
- </ul><br>
- </ul>
- <a name="I2C_PCA9685Get"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Aktualisierung aller Werte
- </ul><br>
- <a name="I2C_PCA9685Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>SUBADR1,SUBADR2,SUBADR3,ALLCALLADR<br>
- Alternative slave Adressen, zum kontrollieren mehrerer PCA9685 mit einem define
- Zusätzlich zu diesen Registern müssen die Passenden Bits in modereg1 gesetzt werden.<br>
- Standard: SUBADR1=113,SUBADR2=114,SUBADR3=116,ALLCALLADR=112, gültige Werte: I2C Adresse <br><br>
- </li>
- <li>OnStartup<br>
- Kommagetrennte Liste der Ports mit den gewünschten Startwerten.<br>
- Nicht gelistete Ports werden auf en letzte state wiederhergestellt.<br>
- Standard: last, gültige Werte: <port>=on|off|0..4095|last wobei <port> = 0 - 15<br><br>
- </li>
- <li>prescale<br>
- PWM Frequenz setzen. Formel: Fx = 25MHz/(4096 * (prescale + 1)).
- Die eingestellte Frequenz wird in den Internals angezeigt.
- Wenn das Attribut extclock angegeben ist, wird dieses zur Frequenzberechnung verwendet. Andernfalls 25MHz.<br>
- Standard: 30 (200Hz für 25MHz clock), gültige Werte: 0-255<br><br>
- </li>
- <li>modereg1<br>
- Durch Komma getrennte Liste von:
- <ul>
- <li>EXTCLK<br>
- Anstelle des internen 25MHz Oszillators wird ein extern Angeschlossener verwendet.
- Die Frequenz des externen Oszillators kann über das Attribut extclock angegeben werden.
- </li>
- <li>SUBADR1<br>
- Wenn gesetzt, antwortet der PCA9685 auf I2C-bus Subadresse 1.
- </li>
- <li>SUBADR2<br>
- Wenn gesetzt, antwortet der PCA9685 auf I2C-bus Subadresse 2.
- </li>
- <li>SUBADR3<br>
- Wenn gesetzt, antwortet der PCA9685 auf I2C-bus Subadresse 3.
- </li>
- <li>ALLCALLADR<br>
- Wenn gesetzt, antwortet der PCA9685 auf I2C-bus ALLCALLADR Adresse.
- </li>
- </ul>
- </li>
- <li>modereg2<br>
- Durch Komma getrennte Liste von:
- <ul>
- <li>INVRT<br>
- Wenn gesetzt, werden die Ausgänge invertiert.<br>
- </li>
- <li>OCH<br>
- Wenn gesetzt, werden die Ports nach jedem ACK gesetzt (also nach jedem gesendeten Byte).<br>
- Andernfalls werden sie nach einem STOP Kommando gesetzt (Bus Schreibaktion fertig, also nach einem Datenpaket)<br>
- </li>
- <li>OUTDRV<br>
- Wenn gesetzt, werden die Ausgänge als totem pole konfiguriert.<br>
- Andernfalls sind sie open-drain.<br>
- </li>
- Verhalten bei OE = 1 (wenn OE = 0 verhalten sich die Ausgänge wie in OUTDRV eingestellt):
- <li>OUTNE0<br>
- Wenn gesetzt:<br>
- LEDn = 1 wenn OUTDRV = 1<br>
- LEDn = hochohmig wenn OUTDRV = 0<br>
- Wenn nicht gesetzt:
- LEDn = 0.<br>
- </li>
- <li>OUTNE1<br>
- LEDn = hochohmig.<br>
- Wenn OUTNE1 gesetzt wird OUTNE0 ignoriert.<br><br>
- </li>
- </ul>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_PCF8574"></a>
- <h3>I2C_PCF8574</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_PCF8574'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_PCF8574">en</a> | de)
- <ul>
- <a name="I2C_PCF8574"></a>
- Ermöglicht die Verwendung eines PCF8574 I2C 8 Bit Portexenders.
- Auf einem Raspberry Pi kann der Interrupt Pin des PCF8574 mit einem GPIO verbunden werden und ¨ber die Interrupt Funktionen von <a href="#RPI_GPIO">RPI_GPIO</a> l&aml;sst sich dann ein get für den PCF8574 bei Pegel&aml;nderung ausl&oml;sen.<br>
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_PCF8574Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_PCF8574 <I2C Address></code><br>
- Der Wert <code><I2C Address></code> ist ohne das Richtungsbit<br>
- </ul>
- <a name="I2C_PCF8574Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <port[,port[...]]> <value></code><br><br>
- <ul>
- <li><code><port></code> kann Port0 bis Port7 annehmen und <code><value></code> folgende Werte:<br>
- <ul>
- <code>
- off<br>
- on<br>
- </code>
- </ul>
- </li>
- </ul>
- <br>
- Beispiel:
- <ul>
- <code>set mod1 Port4 on</code><br>
- <code>set mod1 Port4,Port6 off</code><br>
- <code>set mod1 Port4,6 on</code><br>
- </ul><br>
- </ul>
- <a name="I2C_PCF8574Get"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Aktualisierung aller Werte
- </ul><br>
- <a name="I2C_PCF8574Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: -, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>InputPorts<br>
- Durch Komma getrennte Portnummern die als Inputs genutzt werden.<br>
- Ports in dieser Liste können nicht geschrieben werden.<br>
- Standard: -, gültige Werte: 0 - 7<br><br>
- </li>
- <li>InvrtPorts<br>
- Durch Komma getrennte Portnummern die invertiert werden.<br>
- Standard: -, gültige Werte: 0 - 7<br><br>
- </li>
- <li>OnStartup<br>
- Durch Komma getrennte Output Ports und ihr gewünschter Status nach dem Start.<br>
- Ohne dieses Attribut werden alle Ausgänge nach dem Start auf den letzten Status gesetzt.<br>
- Standard: -, gültige Werte: <port>=on|off|last wobei <port> = 0 - 7<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="I2C_SHT21"></a>
- <h3>I2C_SHT21</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_SHT21'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_SHT21">en</a> | de)
- <ul>
- <a name="I2C_SHT21"></a>
- Ermöglicht die Verwendung eines SHT21 I2C Feuchtesensors von <a href="www.sensirion.com">Sensirion</a>.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_SHT21Define"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_SHT21 [<I2C Address>]</code><br>
- Der Wert <code><I2C Address></code> ist ein zweistelliger Hex-Wert<br>
- </ul>
- <a name="I2C_SHT21Set"></a>
- <b>Set</b>
- <ul>
- <code>set <name> readValues</code><br>
- Aktuelle Temperatur und Feuchte Werte vom Sensor lesen.<br><br>
- </ul>
- <a name="I2C_SHT21Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: 1,2,5,10,20,30<br><br>
- </li>
- <li>roundHumidityDecimal, roundTemperatureDecimal<br>
- Anzahl Dezimalstellen für den Feuchte-, oder Temperaturwert<br>
- Standard: 1, gültige Werte: 0 1 2<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_SHT3x"></a>
- <h3>I2C_SHT3x</h3>
- <div class='langLinks'>[<a href='commandref.html#I2C_SHT3x'>EN</a> DE]</div>
- (<a href="commandref.html#I2C_SHT3x">en</a> | de)
- <ul>
- <a name="I2C_SHT3x"></a>
- Ermöglicht die Verwendung eines SHT30/SHT31 I2C Feuchtesensors von <a href="http:\\www.sensirion.com">Sensirion</a>.
- I2C-Botschaften werden über ein I2C Interface Modul wie beispielsweise das <a href="#RPII2C">RPII2C</a>, <a href="#FRM">FRM</a>
- oder <a href="#NetzerI2C">NetzerI2C</a> gesendet. Daher muss dieses vorher definiert werden.<br>
- <b>Das Attribut IODev muss definiert sein.</b><br>
- <a name="I2C_SHT3xDefine"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> I2C_SHT3x [<I2C Address>]</code><br>
- <br>
- Der Wert <code><I2C Address></code> ist ein zweistelliger Hex-Wert:<br>
- ADDR (Pin 2) verbunden mit VSS (Versorgungsspannung): 0x44 (Standardwert, wenn <code><I2C Address></code> nicht angegeben)<br>
- ADDR (pin 2) verbunden mit VDD (Masse): 0x45<br>
- Für kompatible Sensoren können auch andere Werte als 0x44 oder 0x45 angegeben werden.<br>
- <br>
- </ul>
- <a name="I2C_SHT3xSet"></a>
- <b>Set</b>
- <ul>
- <code>set <name> readValues</code><br>
- Aktuelle Temperatur und Feuchte Werte vom Sensor lesen.<br><br>
- </ul>
- <a name="I2C_SHT3xAttr"></a>
- <b>Attribute</b>
- <ul>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: 1,2,5,10,20,30<br><br>
- </li>
- <li>roundHumidityDecimal, roundTemperatureDecimal<br>
- Anzahl Dezimalstellen für den Feuchte- oder Temperaturwert<br>
- Standard: 1, gültige Werte: 0 1 2<br><br>
- </li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul><br>
- </ul>
- <p><a name="I2C_TSL2561"></a>
- <h3>I2C_TSL2561</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#I2C_TSL2561'>I2C_TSL2561</a><br/>
- </ul>
- <a name="IF"></a>
- <h3>IF</h3>
- <div class='langLinks'>[<a href='commandref.html#IF'>EN</a> DE]</div>
- <ul>
- <code>IF (<Bedingung>) (<FHEM-Kommandos1>) ELSE (<FHEM-Kommandos2>)</code><br>
- <br>
- Es werden <code><FHEM-Kommandos1></code> ausgeführt, wenn <code><Bedingung></code> erfüllt ist, sonst werden <code><FHEM-Kommanodos2></code> ausgeführt.<br>
- <br>
- Beim IF-Befehl (IF in Großbuchstaben) handelt es sich um einen FHEM-Befehl. Der Befehl kann überall dort genutzt werden, wo FHEM-Befehle vorkommen dürfen.
- Im Gegensatz zu Perl-if (if in Kleinbuchstaben) bleibt man auf der FHEM-Ebene und muss nicht auf die Perl-Ebene, um FHEM-Befehle mit Hilfe der fhem-Funktion auszuführen.<br>
- <br>
- IF ist kein eigenständig arbeitendes Modul, sondern ein FHEM-Befehl, der nur in Kombination mit anderen Modulen, wie z. B. notify oder at, sinnvoll eingesetzt werden kann.
- Es gibt inzwischen ein neueres <a href="http://fhem.de/commandref_DE.html#DOIF">DOIF</a>-Modul, welches auf der Syntax vom IF-Befehl aufbaut.
- Es arbeitet im Gegensatz zu IF als Modul selbstständig ereignis- und zeitgesteuert ohne notify bzw. at. Damit lassen sich viele Problemlösungen eleganter, jeweils mit einem einzigen Modul, realisieren.<br>
- <br>
- In der Bedingung des IF-Befehls wird die vollständige Syntax des Perl-if unterstützt. Stati und Readings von Devices werden in eckigen Klammern angegeben.<br>
- <br>
- <br>
- <b>Beispiele:</b><br>
- <br>
- IF in Kombination mit at-Modul, Readingangabe [<Device>:<Reading>] in der Bedingung:<br>
- <br>
- <code>define check at +00:10 IF ([outdoor:humidity] > 70) (set switch1 off) ELSE (set switch1 on)<br></code>
- <br>
- IF Statusabfrage des Devices "outdoor" in der Bedingung:<br>
- <br>
- <code>define check at +00:10 IF ([outdoor] eq "open") (set switch1 on)<br></code>
- <br>
- entspricht mit Angabe des Internals mit &:<br>
- <br>
- <code>define check at +00:10 IF ([outdoor:&STATE] eq "open") (set switch1 on)<br></code>
- <br>
- Wenn der Reading "state" abgefragt werden soll, dann wird der Readingname ohne & angegeben:<br>
- <br>
- <code>define check at +00:10 IF ([outdoor:state] eq "open") (set switch1 on)<br></code>
- <br>
- Geschachtelte Angabe von mehreren IF-Befehlen kann in mehreren Zeilen mit Einrückungen zwecks übersichtlicher
- Darstellung über FHEM-Weboberfläche in der DEF-Eingabe eingegeben werden.<br>
- Die erste Zeile "define test notify lamp " muss mit einem Leerzeichen enden, bevor die Zeile mit Enter umgebrochen wird - das ist eine Eigenschaft von notify und nicht von IF:<br>
- <br>
- <code>define test notify lamp <br>
- IF ([lamp] eq "on") (<br>
- <ol>
- IF ([outdoor:humidity] < 70)<br>
- <ol>
- (set lamp off)<br>
- </ol>
- ELSE<br>
- <ol>
- (set lamp on)<br>
- </ol>
- </ol>
- ) ELSE<br>
- <ol>
- (set switch on)<br>
- </ol>
- <br></code>
- Mehrzeilige Eingaben in der cfg-Datei müssen dagegen jeweils am Zeilenende mit \ verknüpft werden (das ist eine Eigenschaft von FHEM und nicht von IF):<br>
- <br>
- <code>define test notify lamp \<br>
- IF ([lamp] eq "on") (\<br>
- <ol>
- IF ([outdoor:humidity] < 70)\<br>
- <ol>
- (set lamp off)\<br>
- </ol>
- ELSE\<br>
- <ol>
- (set lamp on)\<br>
- </ol>
- </ol>
- ) ELSE\<br>
- <ol>
- (set switch on)<br>
- </ol>
- <br></code>
- Filtern nach Zahlen im Reading "temperature":<br>
- <br>
- <code>define settemp at 22:00 IF ([tempsens:temperature:d] >= 10) (set heating on)<br></code>
- <br>
- Filtern nach "on" und "off" im Status des Devices "move":<br>
- <br>
- <code>define activity notify move IF ([move:&STATE:[(on|off)]] eq "on" and $we) (set lamp off)<br></code>
- <br>
- Beispiel für die Nutzung des Status eines Devices im Ausführungsteil. Hier: "lamp1" wird mit dem Status von "lamp2" geschaltet:<br>
- <br>
- <code>define temp at 18:00 IF ([outdoor:temperature] > 10) (set lamp1 [lamp2])<br></code>
- <br>
- Falls bei einem FHEM-Befehl ein Perl-Ausdruck mit Readings zuvor ausgewertet werden soll, so muss er in geschweifte und runde Klammern gesetzt werden.<br>
- Beispiel: Wenn um 18:00 Uhr die Außentemperatur höher ist als 10 Grad, dann wird die Solltemperatur um 1 Grad erhöht.<br>
- <br>
- <code>define temp at 18:00 IF ([outdoor:temperature] > 10) (set thermostat desired-temp {([thermostat:desired-temp:d]+1)})<br></code>
- <br>
- Mehrerer Befehle werden durch ein Komma statt durch ein Semikolon getrennt, dadurch entfällt das Doppeln, Vervierfachen usw. des Semikolons:<br>
- <br>
- <code>define check at +00:10 IF ([outdoor:humidity] > 10) (set switch1 off,set switch2 on) ELSE (set switch1 on,set switch2 off)<br></code>
- <br>
- Falls ein Komma im FHEM-Ausdruck vorkommt, muss dieser zusätzlich geklammert werden, damit das Komma nicht als Trennzeichen erkannt wird:<br>
- <br>
- <code>define check at +00:10 IF ([outdoor:humidity] > 10) ((set switch1,switch2 off))<br></code>
- <br>
- IF in Kombination mit einem define at mit mehreren set-Befehlen (Eingabe muss wegen der Semikolons im DEF-Editor erfolgen,
- einfaches Semikolon ist nicht erlaubt - es würde vom FHEM-Parser "geschluckt" werden und beim IF nicht mehr ankommen):<br>
- <br>
- <code>define check at *10:00 IF ([indoor] eq "on") (define a_test at +00:10 set lampe1 on;;set lampe2 off;;set temp desired 20)<br></code>
- <br>
- Man kann die Problematik des Doppelns von Semikolons wie folgt umgehen:<br>
- <br>
- <code>define check at *10:00 IF ([indoor] eq "on") (define a_test at +00:10 IF (1) (set lampe1 on,set lampe2 off,set temp desired 20))<br></code>
- <br>
- Das Komma als Trennzeichen zwischen den FHEM-Befehlen lässt sich mit ;; kombinieren, z. B.:<br>
- <br>
- <code>define check at *10:00 IF ([indoor] eq "on") (set lamp1 on,define a_test at +00:10 set lampe2 on;;set lampe3 off;;set temp desired 20)<br></code>
- <br>
- sleep kann mit Komma verwendet werden, dabei wirkt das sleep nicht blockierend:<br>
- <br>
- <code>define check at *10:00 IF ([indoor] eq "on") (sleep 2,set lampe1 on,sleep 3,set lampe2 on)</code><br>
- <br>
- Zeitabhängig schalten: In der Zeit zwischen 20:00 und 22:00 Uhr soll das Licht ausgehen, wenn es an war und ich den Raum verlasse:<br>
- <br>
- <code>define n_lamp_off notify sensor IF ($hms gt "20:00" and $hms lt "22:00" and [sensor] eq "absent") (set lamp:FILTER=STATE!=off off)<br></code>
- <br>
- Kombination von Perl und FHEM-Befehlen ($NAME sowie $EVENT können ebenso benutzt werden):<br>
- <br>
- <code>define mail notify door:open IF ([alarm] eq "on")({system("wmail $NAME:$EVENT")},set alarm_signal on)<br></code>
- <br>
- Der IF-Befehl dient in erster Linie zur Vereinfachung der Schreibweise in Kombination mit anderen FHEM-Modulen wie at, notify oder DOIF.
- Intern wird der IF-Befehl zur Ausführung in einen Perl if-Befehl umgesetzt. Das soll anhand von Beispielen verdeutlicht werden:<br>
- <br>
- <code>IF ([switch] eq "off") (set lamp on)</code><br>
- <br>
- entspricht:<br>
- <br>
- <code>{if (Value('switch') eq "off"){fhem('set lamp on')}}</code><br>
- <br>
- <br>
- <code>IF ([living_room:temperature] > 12) (set lamp on, set lamp2 off)</code><br>
- <br>
- entspricht:<br>
- <br>
- <code>{if (ReadingVal('living_room','temperature','') > 12) {fhem('set lamp on');;fhem('set lamp2 off')}}</code><br>
- <br>
- <br>
- <code>IF ([bathroom:humidity] > 70) (set led red) ELSE (set led green)</code><br>
- <br>
- entspricht:<br>
- <br>
- <code>{if (ReadingsVal('bathroom','humidity','') > 70) {fhem('set led red')} else {fhem('set led green')}}</code><br>
- <br>
- <br>
- </ul>
- <p><a name="IOhomecontrol"></a>
- <h3>IOhomecontrol</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#IOhomecontrol'>IOhomecontrol</a><br/>
- </ul>
- <a name="IPCAM"></a>
- <h3>IPCAM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#IPCAM'>IPCAM</a><br/>
- </ul>
- <a name="IPWE"></a>
- <h3>IPWE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#IPWE'>IPWE</a><br/>
- </ul>
- <a name="IT"></a>
- <h3>IT - InterTechno</h3>
- <div class='langLinks'>[<a href='commandref.html#IT'>EN</a> DE]</div>
- <ul>
- Das InterTechno 433MHZ Protokoll wird von einer Vielzahl von Geräten
- benutzt. Diese gehören entweder zur Kategorie Sender/Sensoren oder zur
- Kategorie Empfänger/Aktoren. Es ist das Senden sowie das Empfangen von InterTechno
- Befehlen möglich. Geräten kötnnen z.B.
- Schalter, Dimmer usw. sein.
- Von diesem Modul wird sowohl das Protolkoll 1 sowie das Protokoll 3 unterstützt.
- Neu empfangene Pakete werden per autocreate in Fhem unter der Kategorie IT angelegt.
- Hinweis: Für ein AutoCreate muss die Taste innerhalb von 30 Sek 2 mal gedrückt werden.
- <br>
- <br>
- <a name="ITdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> IT <housecode> <on-code> <off-code>
- [<dimup-code>] [<dimdown-code>] </code>
- <br>oder<br>
- <code>define <name> IT <ITRotarySwitches|FLS100RotarySwitches> </code>
- <br>oder<br>
- <code>define <name> IT <Adresse 26 Bit> <Group bit> <Unit Code></code>
- <br>oder<br>
- <code>define <name> IT HE800 <Transmitter ID> <Receiver ID></code>
- <br><br>
- Der Wert von Hauscode ist abhängig vom verwendeten Gerät und besteht aus zehn Ziffern InterTechno-Code Protokoll 1.
- Da dieser ein tri-State-Protokoll ist, können die Ziffern jeweils die Werte 0/1/F annehmen.
- <br>
- Bit 11/12 werden für Schalten oder Dimmen verwendet. Da die Hersteller verschiedene Codes verwenden, können hier die
- (2-stelligen) Codes für an, aus, heller und dunkler (on/off/dimup/dimdown) als tri-State-Ziffern (0/1/F) festgelegt werden.
- <br>
- Der Wert des ITRotary-Schalters setzt sich aus dem Wert des Buchstaben-Schalters A-P und dem numerischen Schalter 1-16
- des InterTechno-Gerätes zusammen, z.B. A1 oder G12.
- <br>
- Der Wert des FLS100Rotary-Schalters setzt sich aus dem Wert des Schalters I,II,II,IV und dem numerischen Schalter 1-4
- des InterTechno-Gerätes zusammen, z.B. I2 oder IV4.
- <br>
- Die Werte der ITRotary-Schalter und FLS100Rotary-Schalter werden intern in Hauscode-Werte umgewandelt.
- <br>
- Für Intertechno Protokoll 3 besteht der Hauscode aus 26 Ziffern. Zusätzlich werden noch 4 Ziffern als Unit Code sowie eine Ziffer als Group code benötigt.
- <br>
- Neues IT Element in FHEM anlegen: define IT myITSwitch IT <Adresse 26 Bit> <Group bit> <Unit Code>
- <br><br>
- <b>Intertechno Protokoll 1 (ITv1)</b>
- <ul>
- <li><code><housecode></code> 10 Ziffern lange tri-State-Zahl (0/1/F) abhängig vom benutzten Gerät.</li>
- <li><code><on-code> <off-code></code> jeweils 2 Ziffern lange quad-State-Zahl (0/1/F/D), die den Einschaltbefehl enthält;
- die Zahl wird an den <housecode> angefügt, um den 12-stelligen IT-Sendebefehl zu bilden.</li>
- <li>optional <code><dimup-code> <dimdown-code></code> jeweils 2 Ziffern lange quad-State-Zahl (0/1/F/D),
- die den Befehl zum Herauf- und Herunterregeln enthält;
- die Zahl wird an den <housecode> angefügt, um den 12-stelligen IT-Sendebefehl zu bilden.</li>
- <li>Hinweis: orginal ITv1 devices werden nur beim on Befehl angelegt.</li>
- <li>Die nicht orginal ITv1 devices können wie folgt angelegt werden:</li><br>
- Zum anlegen mit autocreate 2 mal auf "on" drücken:<br>
- <code>2016.11.27 11:47:37.753 4: sduinoD IT: 001F001000 not defined (Switch code: <b>11</b>)</code><br>
- <code>2016.11.27 11:47:37.755 2: autocreate: define IT_001F001000 IT 001F001000 0F F0</code><br><br>
- Nun auf "off" oder eine andere Taste drücken:<br>
- <code>2016.11.27 11:48:32.004 3: sduinoD IT: Code <b>1D</b> not supported by IT_001F001000.</code><br><br>
- Da dies keine orginal Intertechno Steckdose ist, passt der on/off code im define nicht und muss angepasst werden<br>
- <code>DEF 001F001000 <b>11 1D</b></code><br><br>
- <li> <b>EV1527</b></li>
- Wenn im housecode ein nicht gültiger (10) ITv1 Tristatecode enthalten ist, dann wird es per autocreate als EV1527 angelegt.<br>
- <code><housecode></code> 1527xabcde , abcde ist der empfangene housecode im Hex Format<br>
- <code><on-code> <off-code></code> jeweils 4 Ziffern lange Bin Zahl (0/1), die den Einschaltbefehl enthält;
- die Zahl wird an den housecode angefügt, um den 12-stelligen IT-Sendebefehl zu bilden.<br>
- optional <code><dimup-code> <dimdown-code></code> jeweils 4 Ziffern lange Bin Zahl (0/1),
- die den Befehl zum Herauf- und Herunterregeln enthält;
- die Zahl wird an den housecode angefügt, um den 12-stelligen IT-Sendebefehl zu bilden.<br><br>
- Nach dem anlegen per autocreate muss noch der on/off- und optional der dimcode beim define (DEF) angepasst werden.<br>
- </ul>
- <br>
- <b>SBC_FreeTec</b><br>
- <ul>
- <li><code><housecode></code> 8 Ziffern lange tri-State-Zahl (0/1/F) abhängig vom benutzten Gerät.</li>
- <li><code><on-code></code> 4 Ziffern lange tri-State-Zahl, die den Einschaltbefehl enthält;
- die Zahl wird an den housecode angefügt, um den 12-stelligen IT-Sendebefehl zu bilden.</li>
- <li><code><off-code></code> 4 Ziffern lange tri-State-Zahl, die den Ausschaltbefehl enthält;
- die Zahl wird an den housecode angefügt, um den 12-stelligen IT-Sendebefehl zu bilden.</li>
- </ul>
- <br>
- <b>HE800</b><br>
- <ul>
- <li><code><Transmitter ID></code> Eindeutige Transmitter-ID (1..65535)</li>
- <li><code><Receiver ID></code> Receiver-ID [0]1..15, 0=Broadcast 1-15 (HE844A button# 1-4 & MASTER=0, HE850 UNIT# 1-15, HE853 = 1)</li>
- </ul>
- <br>
-
- Beispiele:
- <ul>
- <code>define lamp IT 01FF010101 11 00 01 10</code><br>
- <code>define roll1 IT 111111111F 11 00 01 10</code><br>
- <code>define otherlamp IT 000000000F 11 10 00 00</code><br>
- <code>define otherroll1 IT FFFFFFF00F 11 10</code><br>
- <code>define IT_1527xe0fec IT 1527xe0fec 1001 0000</code><br>
- <code>define SBC_FreeTec_Steck1 IT FFF00FFF 000F 0000</code><br>
- <code>define itswitch1 IT A1</code><br>
- <code>define lamp IT J10</code><br>
- <code>define flsswitch1 IT IV1</code><br>
- <code>define lamp IT II2</code><br>
- <code>define HE800_TID1_SW1 IT HE800 1 1</code><br>
- </ul>
- <br>
- Für <b>Intertechno Protokoll 3 (ITv3)</b> ist der <housecode> eine 26-stellige Zahl. Zusätzlich wird noch ein 1 stelliger Gruppen-Code, sowie
- ein 4-stelliger <unit code> verwendet.
- <ul>
- <li><code><address></code> ist eine 26-stellige Nummer (0/1)</li>
- <li><code><group></code> ist eine 1-stellige Nummer (0/1)</li>
- <li><code><unit></code> ist eine 4-stellige Nummer (0/1)</li>
- </ul>
- <br>
- Beispiele:
- <ul>
- <code>define myITSwitch IT 00111100110101010110011111 0 0000</code>
- </ul>
- </ul>
- <br>
- <a name="ITset"></a>
- <b>Set </b>
- <ul>
- <code>set <name> <value> [<time>]</code>
- <br><br>
- wobei <code>value</code> eines der folgenden Schlüsselwörter ist:<br>
- <pre>
- dimdown
- dimup
- off
- on
- on-till # siehe Anmerkungen
- <li>Die <a href="#setExtensions">set extensions</a> werden unterstützt.</li>
- </pre>
- Beispiele:
- <ul>
- <code>set lamp on</code><br>
- <code>set lamp1,lamp2,lamp3 on</code><br>
- <code>set lamp1-lamp3 on</code><br>
- <code>set lamp off</code><br>
- </ul>
- <br>
- Anmerkungen:
- <ul>
- <li>on-till erfordert eine Zeitangabe im "at"-Format (HH:MM:SS, HH:MM
- oder { <perl code> }, wobei dieser Perl-Code eine Zeitangabe zurückgibt).
- Ist die aktuelle Zeit größer als die Zeitangabe, wird der Befehl verworfen,
- andernfalls wird ein Einschaltbefehl gesendet und für die Zeitangabe ein
- Ausschaltbefehl mittels "at"-Befehl angelegt.
- </li>
- </ul>
- </ul>
- <br>
- <b>Get</b> <ul>N/A (nicht vorhanden)</ul><br>
- <a name="ITattr"></a>
- <b>Attributes</b>
- <ul>
- <a name="IODev"></a>
- <li>IODev<br>
- Spezifiziert das physische Gerät, das die Ausstrahlung der Befehle für das
- "logische" Gerät ausführt. Ein Beispiel für ein physisches Gerät ist ein CUL oder ein SIGNALduino.<br>
- Anmerkung: Beim Start weist fhem einem InterTechno-Gerät kein IO-Gerät zu.
- Das Attribut IODev ist daher IMMER zu setzen.</li><br>
- <a name="eventMap"></a>
- <li>eventMap<br>
- Ersetzt Namen von Ereignissen (wie on und off) und set-Parametern. Die Liste besteht dabei
- aus mit Doppelpunkt verbundenen Wertepaaren, die durch Leerzeichen getrennt
- sind. Der erste Teil des Wertepaares ist der zu ersetzende Wert, der zweite der neue/gewünschte Wert.
- Man kann Leerzeichen innerhalb der neuen/gewünschten Werte verwenden, muss dann aber Fhem signalisieren, dass das die Werte nicht mehr durch Leerzeichen getrennt werden. Die geschieht, indem das erste Zeichen der Werteliste ein Komma (,) oder ein Schrägsstrich (/) wird. Dieses Komma bzw der Schrägstrich werden dann als Listenzeichen verwendet. Beispiele:
- <ul><code>
- attr store eventMap on:open off:closed<br>
- attr store eventMap /on-for-timer 10:open/off:closed/<br>
- set store open
- </code></ul>
- </li><br>
- <li><a href="#do_not_notify">do_not_notify</a></li><br>
- <a name="attrdummy"></a>
- <li>dummy<br>
- Mit der Eigenschaft dummy lassen sich Geräte definieren, die keine physikalischen Befehle
- senden sollen. Verknüpfte notifys werden trotzdem ausgeführt. Damit kann z.B. auf Sendebefehle
- reagiert werden, die über die Weboberfläche ausgelöst wurden, ohne dass der Befehl physikalisch
- gesendet wurde.
- </li><br>
- <li><a href="#loglevel">loglevel</a></li><br>
- <li><a href="#showtime">showtime</a></li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <a name="model"></a>
- <li>model<br>
- Hiermit kann das Modell des IT-Geräts näher beschrieben werden. Diese
- Eigenschaft wird (im Moment) nicht von Fhem ausgewertet.
- Mit Hilfe dieser Information können externe Programme oder Web-Interfaces
- Geräteklassen unterscheiden, um geeignete Kommandos zu senden (z.B. "on"
- oder "off" an Schalter, aber "dim..%" an Dimmer usw.). Die Schreibweise
- der Modellbezeichnung sollten der dem Gerät mitgelieferten Dokumentation
- in Kleinbuchstaben ohne Leerzeichen entsprechen.
- Andere Zeichen als <code>a-z 0-9</code> und <code>-</code> (Bindestrich)
- sollten vermieden werden. Dies ist die Liste der "offiziellen" Modelltypen:<br>
- <b>Sender/Sensor</b>: itremote<br>
- <b>Dimmer</b>: itdimmer<br>
- <b>Empfänger/Actor</b>: itswitch<br>
- <b>EV1527</b>: ev1527
- </li><br>
- <a name="ignore"></a>
- <li>ignore<br>
- Durch das Setzen dieser Eigenschaft wird das Gerät nicht durch Fhem beachtet,
- z.B. weil es einem Nachbarn gehört. Aktivitäten dieses Gerätes erzeugen weder
- Log-Einträge noch reagieren notifys darauf, erzeugte Kommandos werden ignoriert
- (wie bei Verwendung des Attributes <a href="#attrdummy">dummy</a> werden keine
- Signale gesendet). Das Gerät ist weder in der Ausgabe des list-Befehls enthalten
- (außer es wird explizit aufgerufen), noch wird es bei Befehlen berücksichtigt,
- die mit Platzhaltern in Namensangaben arbeiten (siehe <a href="#devspec">devspec</a>).
- Sie werden weiterhin mit der speziellen devspec (Gerätebeschreibung) "ignored=1" gefunden.
- </li><br>
- <a name="ITclock"></a>
- <li>ITclock<br>
- ITclock ist die kleinste Basispulslänge beim Senden des Intertechno V1 Protokolls.<br>
- Ein Signal beim IT-Protokoll besteht immer aus einer Sequenz von HIGH und LOW, die mit einer bestimmten Pulslänge gesendet werden. Typischerweise stehen die Pulslängen dabei im Verhältnis 1:3 (also z.B. LOW=Basispulslänge und HIGH=3*Basispulslänge).<br>
- Voreingestellt ist 250 für Original-IT-Geräte. Andere Hersteller verwenden manchmal andere Werte, dennoch sollte ITclock nur dann verändert werden, wenn es Probleme beim Schalten mit Fhem gibt. Achten Sie in dem Fall auch darauf, ob nicht vielleicht das Signal zu schwach ist oder gestört wird, um regelmässig empfangen zu werden.<br>
- - Hier ist eine Beschreibung für die Ermittlung des ITclock beim Signalduino: Nach Drücken einer Taste an der Fernbedienung steht die empfangene raw Nachricht im log und in der device-Ansicht des IT-device, also etwa<br>
- MS;P0=357;P2=-1128;P3=1155;P4=-428;P5=-11420;D=05023402020202020202020202020202020202023402340234;CP=0;SP=5;<br>
- Die Ziffer hinter "CP=" gibt die Pattern-Nr des clock an, also z.B. folgt aus CP=0 --> P0, das am Anfang der Nachricht definiert ist, hier ist also die clock 357.<br>
- - Beim CUL kann die ITclock aus den raw Daten (X31) ermittelt werden.
- </li><br>
-
- <a name="ITfrequency"></a> </li>
- <li>ITfrequency<br>
- Setzt die Sendefrequenz.
- </li><br>
-
- <a name="ITrepetition"></a>
- <li>ITrepetition<br>
- Setzt die Sendewiederholungen (Default=6).
- </li><br>
-
- <a name="userV1setCodes"></a>
- <li>userV1setCodes<br>
- Damit können beim ITv1 Protokoll eigene setcodes zugefügt werden. Beispiele:
- <ul><code>
- attr lamp userV1setCodes rot:FD blau:1F<br>
- attr lamp userV1setCodes hoch:1001 runter:1000 stop:1011
- </code></ul>
- </li><br>
-
- <a name="SIGNALduinoProtocolId"></a>
- <li>SIGNALduinoProtocolId<br>
- Damit kann beim Senden mit dem SIGNALduino eine Protocol-Id gewählt werden.
- </li><br>
-
- </ul>
- <br>
- <a name="ITevents"></a>
- <b>Erzeugte Ereignisse (Events):</b>
- <ul>
- Ein IT-Gerät kann folgende Ereignisse generieren:
- <li>on</li>
- <li>off</li>
- <li>dimdown</li>
- <li>dimup<br></li>
- Welche Ereignisse erzeugt werden ist geräteabhängig und kann evtl. eingestellt werden.
- </ul>
- </ul>
- <p><a name="InfoPanel"></a>
- <h3>InfoPanel</h3>
- <div class='langLinks'>[<a href='commandref.html#InfoPanel'>EN</a> DE]</div>
- <ul>
- Sorry, keine deutsche Dokumentation vorhanden.<br/><br/>
- Die englische Doku gibt es hier: <a href='commandref.html#InfoPanel'>InfoPanel</a><br/>
- </ul>
- <p><a name="Itach_IR"></a>
- <h3>Itach_IR</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Itach_IR'>Itach_IR</a><br/>
- </ul>
- <a name="Itach_IRDevice"></a>
- <h3>Itach_IRDevice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Itach_IRDevice'>Itach_IRDevice</a><br/>
- </ul>
- <a name="Itach_Relay"></a>
- <h3>Itach_Relay</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Itach_Relay'>Itach_Relay</a><br/>
- </ul>
- <a name="JSONMETER"></a>
- <h3>JSONMETER</h3>
- <div class='langLinks'>[<a href='commandref.html#JSONMETER'>EN</a> DE]</div>
- <div>
- <ul>
- Dieses Modul liest Daten von Messgeräten (z.B. Stromzähler, Gaszähler oder Wärmezähler, so genannte Smartmeter),
- welche <a href="http://de.wikipedia.org/wiki/OBIS-Kennzahlen">OBIS</a> kompatible Daten im JSON-Format auf einem Webserver oder auf dem FHEM-Dateisystem zur Verfügung stellen.
- <br>
- Für detailierte Anleitungen bitte die <a href="http://www.fhemwiki.de/wiki/JSONMETER"><b>FHEM-Wiki</b></a> konsultieren und ergänzen.
- <br>
-
- <br>
-
- <b>Define</b>
- <ul>
- <code>define <name> JSONMETER <Gerätetyp> [<IP-Adresse>] [Abfrageinterval]</code>
- <br>
- Beispiel: <code>define Stromzaehler JSONMETER ITF 192.168.178.20 300</code>
- <br>
- <li><code>[Abfrageinterval]</code>
- <br>
- Optional. Standardmässig 300 Sekunden. Der kleinste mögliche Wert ist 30.
- <br>
- Bei 0 kann die Geräteabfrage nur manuell gestartet werden.
- </li><br>
- <li><code><Gerätetyp></code>
- <br>
- Definiert den Pfad und den Port, um die JSON-Datei einzulesen.
- <br>
- Mit dem Attribute 'pathString' können Login Information an den URL-Pfad von vordefinierten Geräte angehangen werden.
- <ul>
- <li><b>ITF</b> - FROETEC Simplex ME Eintarifzähler (N-ENERGY) (<a href="http://www.itf-froeschl.de">ITF Fröschl</a>)</li>
- <li><b>EFR</b> - <a href="http://www.efr.de">EFR</a> Smart Grid Hub für Stromzähler (EON, N-ENERGY, EnBW)
- <br>
- Die Login-Information wird über das Attribute 'pathstring' angegeben.
- <br>
- <code>?LogName=<i>Benutzer</i>&LogPSWD=<i>Passwort</i></code></li>
- <li><b>LS110</b> - <a href="http://www.youless.nl/downloads-ls110.html">YouLess LS110</a> Netzwerkfähiger Sensor für elektromechanische Stromzähler</li>
- <li><b>LS120</b> - <a href="http://www.youless.nl/winkel/product/ls120.html">YouLess LS120</a> Neues Modell</li>
- <li><b>url</b> - benutzt die URL, welche durch das Attribut 'pathString' und 'port' definiert wird.</li>
- <li><b>file</b> - benutzt die Datei, welche durch das Attribut 'pathString' definiert wird (im FHEM Dateisystem)</li>
- </ul>
- </li>
- </ul>
-
- <br>
- <b>Set</b>
- <ul>
- <li><code>activeTariff < 0 - 9 ></code>
- <br>
- Erlaubt die gezielte, separate Erfassung der statistischen Verbrauchswerte (doStatistics = 1) für verschiedene Tarife (Doppelstromzähler), wenn der Stromzähler dies selbst nicht unterscheiden kann (z.B. LS110) oder wenn geprüft werden soll, ob ein zeitabhängiger Tarif preiswerter wäre. Dieser Wert muss entsprechend des vorhandenen oder geplanten Tarifes zum jeweiligen Zeitpunkt z.B. durch den FHEM-Befehl "at" gesetzt werden.<br>
- 0 = tariflos
- </li><br>
- <li><code>INTERVAL <Abfrageinterval></code>
- <br>
- Abfrageinterval in Sekunden
- </li><br>
- <li><code>resetStatistics <statWerte></code>
- <br>
- Löscht die ausgewählten statisischen Werte: <i>all, statElectricityConsumed..., statElectricityConsumedTariff..., statElectricityPower...</i>
-
- </li><br>
- <li><code>restartJsonAnalysis</code>
- <br>
- Neustart der Analyse der json-Datei zum Auffinden bekannter Gerätewerte (kompatibel zum OBIS Standard).
- Diese Analysie wird normaler Weise nur einmalig durchgeführt, nachdem Gerätewerte gefunden wurden.
- </li><br>
- <li><code>statusRequest</code>
- <br>
- Aktualisieren der Gerätewerte</li>
- </ul>
- <br>
- <b>Get</b>
- <ul>
- <li><code>jsonFile</code>
- <br>
- Liest die JSON-Datei ein und zeigt sie an.
- </li><br>
- <li><code>jsonAnalysis</code>
- <br>
- Extrahiert die JSON-Daten und zeigt das Resultat der JSON-Analyse.</li>
- </ul>
- <br>
- <a name="JSONMETERattr"></a>
- <b>Attributes</b>
- <ul>
- <li><code>alwaysAnalyse < 0 | 1 ></code>
- <br>
- Führt bei jeder Abfrage der Gerätewerte eine Analyse der JSON-Datenstruktur durch.
- <br>
- Dies ist sinnvoll, wenn sich die JSON-Struktur ändert. Normalerweise wird die analysierte Struktur
- zwischengespeichert, um die CPU-Last gering zu halten.
- </li><br>
- <li><code>doStatistics < 0 | 1 ></code>
- <br>
- Bildet tägliche, monatliche und jährliche Statistiken bestimmter Gerätewerte (Mittel/Min/Max oder kumulierte Werte).
- Für grafische Auswertungen können die Werte der Form 'stat<i>ReadingName</i><b>Last</b>' genutzt werden.
- </li><br>
- <li><code>pathString <Zeichenkette></code>
- <ul>
- <li>Gerätetyp 'file': definiert den lokalen Dateinamen und -pfad
- </li>
- <li>Gerätetyp 'url': Definiert den URL-Pfad
- </li>
- <li>Andere: Kann benutzt werden um Login-Information zum URL Pfad von vordefinerten Geräten hinzuzufügen
- </li>
- </ul>
- </li><br>
- <li><code>port <Nummer></code>
- <br>
- Beim Gerätetyp 'url' kann hier der URL-Port festgelegt werden. (standardmässig 80)
- </li><br>
- <li><code>timeOut <Sekunden></code>
- <br>
- Gibt an, nach wieviel Sekunden das Einlesen der Rohdaten abgebrochen werden soll. (standardmässig 10)
- <br>
- Die Laufzeit des Einlesevorganges wird bei "get <device> jsonFile" angezeigt.
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- </ul>
- </div>
- <p><a name="Jabber"></a>
- <h3>Jabber</h3>
- <div class='langLinks'>[<a href='commandref.html#Jabber'>EN</a> DE]</div>
- <ul>
- Dieses Modul verbindet sich mit dem Jabber Netzwerk, sendet und empfängt Nachrichten von und zu einem Jabber Server.<br>
- <br>
- Jabber ist eine andere Beschreibung für "XMPP", ein Kommunikationsprotokoll für Nachrichtenorientierte "middleware", basierend
- auf XML.<br>
- Fester bestandteil des Protokolls ist die Verschlüsselung zwischen Client und Server.<br>
- Für den Benutzer ist es ähnlich anderer Chat-Plattformen wie zum Beispiel dem facebook Chat, ICQ oder Google Hangouts -
- jedoch frei Verfügbar, open Source und normalerweise Verschlüsselt (was Serverabhängig ist).<br>
- <br>
- Für dieses Modul brauchst du einen Account auf einem Jabber Server. Kostenlose accounts und Server findet man unter <a href="http://www.jabber.org/">jabber.org</a><br>
- Diskussionen zu diesem Modul findet man im <a href="http://forum.fhem.de/index.php/topic,18967.0.html">FHEM Forum hier</a>.<br>
- <br>
- Dieses Modul benötigt die folgenden Perl Module (inkl. SSL Möglichkeit)<br>
- <ul>
- <li>Net::Jabber</li>
- <li>Net::XMPP</li>
- <li>Authen::SASL</li>
- <li>XML::Stream</li>
- <li>Net::SSLeay</li>
- </ul>
- <br>
- Seit Version 1.5 kann dieses Modul in Multi-User-Channel (sogenannte MUC) beitreten und Off-the-Record (OTR) Ende-zu-Ende Verschlüsselung benutzen.<br>
- Wenn du OTR benutzen möchtest musst du dir Crypt::OTR von CPAN selbst installieren.<br>
- OTR ist nochmal ein zusätzlicher Sicherheitsrelevater Punkt, da die Kommunikation wirklich von Endgerät zu FHEM verschlüsselt wird und man sich nicht auf die Jabber Server Transportverschlüsselung verlassen muss.<br>
- <br>
- <br>
- <a name="JabberDefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Jabber <server> <port> <username> <password> <TLS> <SSL></code><br>
- <br>
- Du benötigst natürlich echte Accountdaten.<br>
- <br>
- Beispiel:
- <ul>
- <code>define JabberClient1 Jabber jabber.org 5222 myusername mypassword 1 0</code>
- </ul>
- <br>
- </ul>
- <br>
- <a name="JabberSet"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>set <name> msg <username> <msg></code>
- <br>
- Sendet eine Nachricht "msg" an den Jabberuser "username"
- <br>
- Beispiel:
- <ul>
- <code>set JabberClient1 msg myname@jabber.org It is working!</code><br>
- </ul>
- </li>
- <br>
- <li>
- <code>set <name> msgmuc <channel> <msg></code>
- <br>
- Sendet eine Nachricht "msg" an dieJabber-MUC-Gruppe "channel".<br>
- Dabei wird ein eventuell mitgegebener Nickname von "channel" entfernt, so kann man direkt das Reading LastMessageJID benutzen.<br>
- <br>
- Beispiel:
- <ul>
- <code>set JabberClient1 msgmuc roomname@jabber.org Woot!</code><br>
- </ul>
- </li>
- <br>
- <li>
- <code>set <name> msgotr <username> <msg></code>
- <br>
- Sendet eine OTR verschlüsselte Nachricht an den "username", wenn keine aktive OTR Sitzung aufgebaut ist, wird versucht eine aufzubauen.<br>
- Wenn der Empfänger OTR nicht versteht, wird die Nachricht verworfen, d.h. sie wird auf keinen Fall im Klartext übertragen.
- <br>
- Beispiel:
- <ul>
- <code>set JabberClient1 msgotr myname@jabber.org Wir sehen uns heute um 18:00 Uhr :*</code><br>
- </ul>
- </li>
- <br>
- <li>
- <code>set <name> subscribe <username></code>
- <br>
- Frägt eine Authorisierung beim "username" an (normalerweise wird das nicht benötigt)
- <br>
- Beispiel:
- <ul>
- <code>set JabberClient1 subscribe myname@jabber.org</code><br>
- </ul>
- </li>
- </ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="JabberAttr"></a>
- <b>Attribute</b>
- <ul>
- <a name="OnlineStatus"></a>
- <li><code>OnlineStatus available|unavailable</code><br>
- Setzt den Online-status, ob der Client anderen gegenüber Online ist (available) oder Offline erscheint (unavailable)<br>
- Es ist möglich dass einige Server eingehende Nachrichten trotzdem FHEM zustellen obwohl er "unavailable" ist<br>
- <br>
- Standard: <code>available</code>
- </li><br>
- <a name="ResourceName"></a>
- <li><code>ResourceName <name></code><br>
- In der Jabber-Welt kann ein Client mit einem Usernamen öfter mit einem Server verbunden sein (z.b. Handy, Computer, FHEM). <br>
- Der "resource name" ergibt die finale Jabber-ID und macht die verschiedenen Verbindungen einzigartig (z.B. bios@jabber.org/FHEM).<br>
- Hier kannst du den "resource name" setzen.<br>
- <br>
- Standard: <code>FHEM</code>
- </li><br>
- <a name="PollTimer"></a>
- <li><code>PollTimer <seconds></code><br>
- Dies ist der Intervall in der überprüft wird ob neue Nachrichten zur Verarbeitung beim Jabber Server anstehen.<br>
- Ebenfalls wird hiermit die Verbindung zum Server überprüft (Timeouts, DSL Disconnects etc.).<br>
- Setze es nicht über 10 Sekunden, die Verbindung kann sonst die ganze Zeit getrennt werden, Sie wird zwar wieder aufgebaut, aber nach 10 Sekunden brechen die meisten Server die Verbindung automatisch ab.<br>
- <br>
- Standard: <code>2</code>
- </li><br>
- <a name="RecvWhitelist"></a>
- <li><code>RecvWhitelist <Regex></code><br>
- Nur wenn die Jabber-ID einer privaten empfangenen Nachricht auf diese Regex zutrifft, akzeptiert FHEM die Nachricht und gibt sie an Notifys weiter. Alles andere wird verworfen.<br>
- <br>
- Standard: <code>.*</code><br>
- Beispiele:<br>
- <ul>
- <code>myname@jabber.org</code><br>
- <code>(myname1@jabber.org|myname2@xmpp.de)</code><br>
- </ul>
- </li><br>
- <a name="MucJoin"></a>
- <li><code>MucJoin channel1@server.com/mynick[:passwort]</code><br>
- Tritt dem MUC mit dem spezifizierten Nickname und dem optionalem Passwort bei.<br>
- <br>
- Standard: nicht definiert<br>
- Beispiele:<br>
- <ul>
- Einen Raum betreten: <code>channel1@server.com/mynick</code><br>
- Mehrere Räume betreten: <code>channel1@server.com/mynick,channel2@server.com/myothernick</code><br>
- Einen Raum mit Passwort betreten: <code>channel1@server.com/mynick:password</code><br>
- </ul>
- </li><br>
- <a name="MucRecvWhitelist"></a>
- <li><code>MucRecvWhitelist <Regex></code><br>
- Selbe funktion wie RecvWhitelist, aber für Gruppenräume: Nur wenn die Regex zutrifft, wird die Nachricht verarbeitet. Alles andere wird ignoriert.<br>
- <br>
- Standard: nicht definiert (keine Nachricht wird akzeptiert)<br>
- Beispiele:<br>
- <ul>
- Alle Nachrichten aller betretenen Räume erlauben: <code>.*</code><br>
- Alle Nachrichten bestimmter betretenen Räume erlauben: <code>mychannel@jabber.org</code><br>
- Nur bestimmte User in bestimmten betretenen Räumen erlauben: <code>mychannel@jabber.org/NickOfFriend</code><br>
- </ul>
- </li><br>
- <a name="OTREnable"></a>
- <li><code>OTREnable 1|0</code><br>
- Schaltet die Verschlüsselungsfunktionen von Crypt::OTR für sichere Ende-zu-Ende Kummunikation in FHEM an oder aus.<br>
- Es muss zwangsläufig dafür Crypt::OTR installiert sein.<br>
- <i>Ein Privater Schlüssel wird bei Erstbenutzung generiert, das kann mehr als 2 Stunden dauern!</i><br>
- Dafür ist das eine einmalige Sache und FHEM wird dadurch nicht blockiert. Im Device sieht man im OTR_STATE wenn der Private Schlüssel fertig ist.<br>
- Erst danach ist OTR aktiv.<br>
- <br>
- Default: nicht definiert (OTR deaktiviert)
- </li><br>
- <a name="OTRSharedSecret"></a>
- <li><code>OTRSharedSecret aSecretKeyiOnlyKnow@@*</code><br>
- Optionales geheimes Passwort, dass man vom Endgerät an FHEM schicken kann um zu beweisen, dass es sich tatsächlich um FHEM handelt und nicht um einen
- Hacker der sich (z.b. bei dem Internetprovider) zwischengeschaltet hat.
- Normalerweise bekommt das Endgerät eine Warnung wenn sich an einer bereits verifizierten Verbindung etwas geändert hat.<br>
- Diese Warnung sollte man dann sehr ernst nehmen.
- <br>
- Default: nicht definiert, setze hier dein geheimes Passwort.
- </li><br>
-
-
- </ul>
- <br>
- <a name="JabberReadings"></a>
- <b>Generierte Readings/Events:</b>
- <ul>
- <li>Privat Nachrichten
- <ul>
- <li><b>Message</b> - Komplette Nachricht inkl. JID und Text</li>
- <li><b>LastMessage</b> - Nur der Textteil der Nachricht</li>
- <li><b>LastSenderJID</b> - Nur die Sender-JID der Nachricht</li>
- </ul>
- </li><br>
- <li>Verschlüsselte Private Nachrichten (wenn OTREnable=1)
- <ul>
- <li><b>OTRMessage</b> - Komplette entschlüsselte Nachricht inkl. JID und Text</li>
- <li><b>OTRLastMessage</b> - Nur der Textteil der Nachricht</li>
- <li><b>OTRLastSenderJID</b> - Nur die Sender-JID der Nachricht</li>
- </ul>
- </li><br>
- <li>MUC Raum Nachrichten (wenn MUCJoin gesetzt ist)
- <ul>
- <li><b>MucMessage</b> - Komplette Nachricht (Raumname/Nickname und Text)</li>
- <li><b>MucLastMessage</b> - Nur der Textteil der Nachricht</li>
- <li><b>MucLastSenderJID</b> - Nur die Sender-JID der Nachricht</li>
- </ul>
- </li>
- </ul>
- <br>
- <a name="JabberNotes"></a>
- <b>Notizen des Entwicklers:</b>
- <ul>
- <li>Mit folgendem Notify-Beispiel kannst du auf eingehende Nachrichten reagieren, dieses Beispiel schickt das Reading "Temperatur" des Sensors "BU_Temperatur" bei jeder ankommenden Nachricht an den Sender zurück:<br>
- <pre><code>define Jabber_Notify notify JabberClient1:Message.* {
- my $lastsender=ReadingsVal("JabberClient1","LastSenderJID","0");
- my $lastmsg=ReadingsVal("JabberClient1","LastMessage","0");
- my $temperature=ReadingsVal("BU_Temperatur","temperature","0");
- fhem("set JabberClient1 msg ". $lastsender . " Temp: ".$temperature);
- }
- </code></pre>
- </li>
- <li>Auf MUC Nachrichten lässt sich folgend reagieren, Augenmerk darauf legen dass der Nickname aus $lastsender in der msgmuc Funktion entfernt wird, damit die Nachricht an den Raum geht<br>
- <pre><code>define Jabber_Notify notify JabberClient1:MucMessage.* {
- my $lastsender=ReadingsVal("JabberClient1","LastSenderJID","0");
- my $lastmsg=ReadingsVal("JabberClient1","LastMessage","0");
- my $temperature=ReadingsVal("BU_Temperatur","temperature","0");
- fhem("set JabberClient1 msgmuc ". $lastsender . " Temp: ".$temperature);
- }
- </code></pre>
- </li>
- <li>Auf OTR Nachrichten wird reagiert, wie auf normale private Nachrichten auch, jedoch wird mit der msgotr Funktion geantwortet:<br>
- <pre><code>define Jabber_Notify notify JabberClient1:OTRMessage.* {
- my $lastsender=ReadingsVal("JabberClient1","LastSenderJID","0");
- my $lastmsg=ReadingsVal("JabberClient1","LastMessage","0");
- my $temperature=ReadingsVal("BU_Temperatur","temperature","0");
- fhem("set JabberClient1 msgotr ". $lastsender . " Temp: ".$temperature);
- }
- </code></pre>
- </li>
- </ul>
- </ul>
- <p><a name="JawboneUp"></a>
- <h3>JawboneUp</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#JawboneUp'>JawboneUp</a><br/>
- </ul>
- <a name="JeeLink"></a>
- <h3>JeeLink</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#JeeLink'>JeeLink</a><br/>
- </ul>
- <a name="JsonList"></a>
- <h3>JsonList</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#JsonList'>JsonList</a><br/>
- </ul>
- <a name="JsonList2"></a>
- <h3>JsonList2</h3>
- <div class='langLinks'>[<a href='commandref.html#JsonList2'>EN</a> DE]</div>
- <ul>
- <code>jsonlist2 [<devspec>] [<value1> <value2> ...]</code>
- <br><br>
- Dieses Befehl sollte in der FHEMWEB oder telnet Eingabezeile ausgeführt
- werden, kann aber auch direkt über HTTP abgerufen werden über
- <ul>
- http://fhemhost:8083/fhem?cmd=jsonlist2&XHR=1
- </ul>
- Es liefert die JSON Darstellung der internen Variablen, Readings und
- Attribute zurück.<br>
- Wenn valueX angegeben ist, dann wird nur der entsprechende Internal (DEF,
- TYPE, usw), Reading (actuator, measured-temp) oder Attribut
- zurückgeliefert für alle Geräte die in devspec angegeben sind.
- <br><br>
- <b>Achtung</b>: die alte Version dieses Befehls (jsonlist, ohne 2 am Ende) is
- überholt, und wird in der Zukunft entfernt.<br>
- </ul>
- <p><a name="KM271"></a>
- <h3>KM271</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#KM271'>KM271</a><br/>
- </ul>
- <a name="KM273"></a>
- <h3>KM273</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#KM273'>KM273</a><br/>
- </ul>
- <a name="KNX"></a>
- <h3>KNX</h3>
- <div class='langLinks'>[<a href='commandref.html#KNX'>EN</a> DE]</div>
- <ul>
- <p>KNX ist ein Standard zur Haus- und Gebäudeautomatisierung.
- Der Standard begründet sich hauptsächlich auf twisted pair, findet aber auch zunehmende Verbreitung auf andere Medien (Funk, Ethernet, ...)</p>
- Für Anfänger sei folgende Lektüre empfohlen: <a href="http://www.knx.org/media/docs/Flyers/KNX-Basics/KNX-Basics_de.pdf">KNX-Basics</a>
- <p>Das Modul <a href="#TUL">TUL</a> stellt die Verbindung zum Bus her, Das KNX-Modul stellt die Verbindung zu den einzelnen KNX-/EIB-Geräten her. Das Modul stellt Befehle (on, off, on-until, on-for-timer)
- zum ein- und Ausschalten von Geräten zur Verfügung. Für numerische DPT nutzt bitte value (set <devname> value <177.45>). Für string-DPT nutzt bitte string
- (set <devname> string <Hello World>). Für andere, undefinierte DPT könnt Ihr raw hex Werte ans Netzwerk senden (set <devname> raw <hexval>).<br>
- Komplexe Konfigurationen können aufgebaut werden, indem mehrere Modulinstanzen in einem Gerät definiert werden. Dafür werden mehrere Kombinationen aus GAD und DPT in einem Gerät definiert werden.</p>
- <p>Der KNX-Standard stellt eine Reihe vordefinierter Datentypen zur Verfügung. Dies sichert die Herstellerübergreifende Kompatibilität.
- Basierend auf diesen DPT wird der Status eines Gerätes interpretiert und in FHEM angezeigt. Für jedes empfangene Telegramm wird ein reading mit state, getG<group> und der Absenderadresse angelegt.
- Für jedes ser-command wird ein Reading mit state und setG<group> angelegt.</p>
- <p><a name="KNXdefine"></a> <b>Define</b></p>
- <ul>
- <code>define <name> KNX <group>:<DPT>:<[;readingName]> [<group>:<DPT> ..] [IODev]</code>
-
- <p>Ein KNX-device benötigt einen konkreten DPT. Bitte schaut die verfügbaren DPT unter <a href="#KNXdpt">Available DPT</a> nach. Wird kein korrekter DPT angegeben, kann das system die Nachrichten nicht korrekt de- / codieren.
- Weiterhin kann bei der Gerätedefinition eine IO-Schnittstelle angegeben werden. Dies kann später ebenfalls per Attribut erfolgen.</p>
-
- <p>Jedes Device muss an eine <a href="#TUL">TUL</a> gebunden sein. Die <group> Parameter werden entweder als Gruppenadresse (0-15/0-15/0-255) oder als Hex-notation angegeben (0-f0-f0-ff).
- Alle definierten Gruppen können für die Buskommunikation verwendet werden. Ohne weitere Attribute, werden alle eingehenden Nachrichten in state übersetzt.
- Per default wird über die erste Gruppe gesendet.<br>
- Wenn Ihr einen readingNamen angebt, wird dieser als Basis für die Readings benutzt (z.B. hugo-set, hugo-get for name hugo).<br>
- Wollt Ihr über eine andere Gruppe senden. müsst Ihr diese indizieren (set <devname> value <17.0> <g2>).</p>
-
- <p>Das Modul <a href="#autocreate">autocreate</a> generiert eine Instanz für jede unbekannte Gruppenadresse. Das Gerät selbst wird jedoch NICHT korrekt funktionieren, so lange noch kein korrekter
- DPT angelegt ist. Der Name ist immer KNX_nnmmooo wobei nn die Linie ist, mm der Bereich und ooo die Geräteadresse.</p>
- <p>Example:</p>
- <pre>
- define lamp1 KNX 0/10/12:dpt1
- define lamp1 KNX 0/10/12:dpt1:meinName 0/0/5:dpt1.001
- define lamp1 KNX 0A0C:dpt1.003 myTul
- </pre>
-
- Ein Hinweis bezüglich dem binären Datentyp dpt1: alle Untertypen müssen über das Schlüsselwort value gesetzt werden. Empfangene Telegramme werden entsprechend ihrer Definition automatisch
- umbenannt. Zu sendende Telegramme sind immer min on/off zu belegen!<br>
- Die zur Verfügung stehenden on/off Schaltflächen ohne den Schlüssel value sind ein absoluter Sonderfall und gelten für den dpt1 und alle Untertypen.
-
- <p>Example:</p>
- <pre>
- define rollo KNX 0/10/12:dpt1.008
- set rollo value off
- set rollo value on
- </pre>
-
- </ul>
-
- <p><a name="KNXset"></a> <b>Set</b></p>
- <ul>
- <code>set <name> <on, off></code> [g<groupnr>]
- <code>set <name> <on-for-timer, on-until> <time> [g<groupnr>]</code>
- <code>set <name> <value> [g<groupnr>]</code>
- <code>set <name> <string> [g<groupnr>]</code>
- <code>set <name> <raw> [g<groupnr>]</code>
-
- <p>Example:</p>
- <pre>
- set lamp1 on
- set lamp1 off
- set lamp1 on-for-timer 10
- set lamp1 on-until 13:15:00
- set foobar raw 234578
- set thermo value 23.44
- set message value Hallo Welt
- </pre>
- <p>Wenn eine Gruppe angegeben wurde (g<groupnr>) wird das Telegramm an de indizierte Gruppe gesendet (start bei 1, wie in der Definition angegeben).</p>
- <pre>
- define lamp1 KNX 0/10/01:dpt1 0/10/02:dpt1
- set lamp1 on g2 (will send "on" to 0/10/02)
- </pre>
- <p>Ein Dimmer mit Slider:</p>
- <pre>
- define dim1 KNX 0/0/5:dpt5.001
- attr dim1 slider 0,1,100
- attr dim1 webCmd value
- </pre>
-
- <p>Aktuelle Uhrzeit / Datum können wie folgt auf den Bus gelegt werden:</p>
- <pre>
- define timedev KNX 0/0/7:dpt10
- attr timedev webCmd value now
-
- define datedev KNX 0/0/8:dpt11
- attr datedev webCmd value now
-
- # send every midnight the new date
- define dateset at *00:00:00 set datedev value now
-
- # send every hour the current time
- define timeset at +*01:00:00 set timedev value now
- </pre>
- </ul>
-
- <p><a name="KNXget"></a> <b>Get</b></p>
- <ul>
- <p>Bei jeder Ausführung wird eine Leseanfrage an die entsprechende Gruppe geschickt. Die Gruppe muss in der Lage sein, auf diese Anfrage zu antworten (dies ist nicht immer der Fall).<br>
- Die Antwort der Gruppe wird nicht im FHEMWEB angezeigt. Das empfangene Telegramm wird (wie jedes andere) ausgewertet.</p>
- </ul>
-
- <p><a name="KNXattr"></a> <b>Attributes</b></p>
- <ul><br>
- Common attributes:<br>
- <a href="#DbLogInclude">DbLogInclude</a><br>
- <a href="#DbLogExclude">DbLogExclude</a><br>
- <a href="#IODev">IODev</a><br>
- <a href="#alias">alias</a><br>
- <a href="#comment">comment</a><br>
- <a href="#devStateIcon">devStateIcon</a><br>
- <a href="#devStateStyle">devStateStyle</a><br>
- <a href="#do_not_notify">do_not_notify</a><br>
- <a href="#readingFnAttributes">readingFnAttributes</a><br>
- <a href="#event-aggregator">event-aggregator</a><br>
- <a href="#event-min-interval">event-min-interval</a><br>
- <a href="#event-on-change-reading">event-on-change-reading</a><br>
- <a href="#event-on-update-reading">event-on-update-reading</a><br>
- <a href="#eventMap">eventMap</a><br>
- <a href="#group">group</a><br>
- <a href="#icon">icon</a><br>
- <a href="#room">room</a><br>
- <a href="#showtime">showtime</a><br>
- <a href="#sortby">sortby</a><br>
- <a href="#stateFormat">stateFormat</a><br>
- <a href="#userReadings">userReadings</a><br>
- <a href="#userattr">userattr</a><br>
- <a href="#verbose">verbose</a><br>
- <a href="#webCmd">webCmd</a><br>
- <a href="#widgetOverride">widgetOverride</a><br>
- <br>
- </ul>
- <p><a name="KNXformat"></a> <b>format</b></p>
- <ul>
- Der Inhalt dieses Attributes wird bei jedem empfangenen Wert angehangen, bevor der Wert in state kopeiert wird.
- <p>Example:</p>
- <pre>
- define myTemperature KNX 0/1/1:dpt5
- attr myTemperature format °C;
- </pre>
- </ul>
- <p><a name="KNXstateRegex"></a> <b>stateRegex</b></p>
- <ul>
- Es kann eine Reihe an Search/Replace Patterns übergeben werden (getrennt durch einen Slash). Intern wird der neue Wert von state immer im Format getG<group>:<state-value>. abgebildet.
- Die Ersetzungen werden bei bei jedem neuen Telegramm vorgenommen. Ihr könnt die Funktion für Konvertierungen nutzen, Einheiten hinzufügen, Spaß mit Icons haben, ...
- Diese Funktion wirkt nur auf den Inhalt von State - sonst wird nichts beeinflusst.
- Die Funktion wird direkt nach dem Ersetzen der Readings-Namen und dem ergänzen der Formate ausgeführt.
- <p>Example:</p>
- <pre>
- define myLamp KNX 0/1/1:dpt1 0/1/2:dpt1 0/1/2:dpt1
- attr myLamp stateRegex /getG1:/steuern:/ /getG2:/status:/ /getG3:/sperre:/ /setG[13]:/steuern:/ /setG[3]://
- attr myLamp devStateIcon status.on:general_an status.off:general_aus sperre.on:lock steuern.*:hourglass
- </pre>
- </ul>
-
- <p><a name="KNXstateCmd"></a> <b>stateCmd</b></p>
- <ul>
- Hier könnt Ihr ein perl-Kommando angeben, welches state beeinflusst. Die Funktion wird unmittelbar vor dem Update des Readings aufgerufen - also nach dem Umbennenen der Readings, format und regex.
- Es ist ein gültiges Perl-Kommando anzugeben (vgl. stateFormat). Im Gegensatz zu StateFormat wirkt sich dieses Attribut inhaltlich auf das Reading aus, und nicht "nur" auf die Anzeige im FHEMWEB.
- <p>Beispiel:</p>
- <pre>
- define myLamp KNX 0/1/1:dpt1 0/1/2:dpt1 0/1/2:dpt1
- attr myLamp stateCmd {$state = sprintf("%s", ReadingsVal($name,"getG2","undef"))}
- </pre>
- </ul>
- <p><a name="KNXanswerReading"></a> <b>answerReading</b></p>
- <ul>
- Wenn aktiviert, antwortet FHEM auf Leseanfragen. Der Inhalt von state wird auf den Bus gelegt.
- <p>Leseanfragen werden beantwortet, wenn der Wert auf 1 gesetzt ist.</p>
- </ul>
- <p><a name="KNXlistenonly"></a> <b>listenonly</b></p>
- <ul>
- Wenn auf 1 gesetzt, kann das Gerät keine Nachrichten senden. Sowohl Leseanfragen als auch get sind verboten.
- </ul>
- <p><a name="KNXreadonly"></a> <b>readonly</b></p>
- <ul>
- Wenn auf 1 gesetzt, kann das Gerät keine Nachrichten senden. Leseanfragen sind verboten. Get ist erlaubt.
- </ul>
- <p><a name="KNXslider"></a> <b>slider</b></p>
- <ul>
- slider <min>,<step>,<max><br>
- Mit diesem Attribut könnt Ihr jedem Gerät einen Slider verpassen.
- <p>Example:</p>
- <pre>
- define myDimmer KNX 0/1/1:dpt5
- attr myDimmer slider 0,1,100
- attr myDimmer webCmd value
- </pre>
- </ul>
- <p><a name="KNXdpt"></a> <b>DPT - datapoint-types</b></p>
- <ul>
- <p>Die folgenden DPT sind implementiert und müssen in der Gruppendefinition angegeben werden.</p>
- dpt1 on, off<br>
- dpt1.001 on, off<br>
- dpt1.002 true, false<br>
- dpt1.003 enable, disable<br>
- dpt1.004 no ramp, ramp<br>
- dpt1.005 no alarm, alarm<br>
- dpt1.006 low, high<br>
- dpt1.007 decrease, increase<br>
- dpt1.008 up, down<br>
- dpt1.009 open, closed<br>
- dpt1.010 start, stop<br>
- dpt1.011 inactive, active<br>
- dpt1.012 not inverted, inverted<br>
- dpt1.013 start/stop, ciclically<br>
- dpt1.014 fixed, calculated<br>
- dpt1.015 no action, reset<br>
- dpt1.016 no action, acknowledge<br>
- dpt1.017 trigger, trigger<br>
- dpt1.018 not occupied, occupied<br>
- dpt1.019 closed, open<br>
- dpt1.021 logical or, logical and<br>
- dpt1.022 scene A, scene B<br>
- dpt1.023 move up/down, move and step mode<br>
- dpt2 value on, value off, value forceOn, value forceOff<br>
- dpt3 -100..+100<br>
- dpt5 0..255<br>
- dpt5.001 0..100 %<br>
- dpt5.003 0..360 °<br>
- dpt5.004 0..255 %<br>
- dpt6 -127..+127<br>
- dpt6.001 0..100 %<br>
- dpt7 0..65535<br>
- dpt7.001 0..65535 s<br>
- dpt7.005 0..65535 s<br>
- dpt7.005 0..65535 m<br>
- dpt7.012 0..65535 mA<br>
- dpt7.013 0..65535 lux<br>
- dpt8 -32768..32768<br>
- dpt8.005 -32768..32768 s<br>
- dpt8.010 -32768..32768 %<br>
- dpt8.011 -32768..32768 °<br>
- dpt9 -670760.0..+670760.0<br>
- dpt9.001 -670760.0..+670760.0 °<br>
- dpt9.004 -670760.0..+670760.0 lux<br>
- dpt9.005 -670760.0..+670760.0 m/s<br>
- dpt9.006 -670760.0..+670760.0 Pa<br>
- dpt9.007 -670760.0..+670760.0 %<br>
- dpt9.008 -670760.0..+670760.0 ppm<br>
- dpt9.009 -670760.0..+670760.0 m³/h<br>
- dpt9.010 -670760.0..+670760.0 s<br>
- dpt9.021 -670760.0..+670760.0 mA<br>
- dpt9.024 -670760.0..+670760.0 kW<br>
- dpt9.025 -670760.0..+670760.0 l/h<br>
- dpt9.026 -670760.0..+670760.0 l/h<br>
- dpt9.028 -670760.0..+670760.0 km/h<br>
- dpt10 01:00:00<br>
- dpt11 01.01.2000<br>
- dpt12 0..+Inf<br>
- dpt13 -Inf..+Inf<br>
- dpt13.010 -Inf..+Inf Wh<br>
- dpt13.013 -Inf..+Inf kWh<br>
- dpt14 -Inf.0..+Inf.0<br>
- dpt14.019 -Inf.0..+Inf.0 A<br>
- dpt14.027 -Inf.0..+Inf.0 V<br>
- dpt14.056 -Inf.0..+Inf.0 W<br>
- dpt14.057 -Inf.0..+Inf.0 cosΦ<br>
- dpt14.068 -Inf.0..+Inf.0 °C;<br>
- dpt14.076 -Inf.0..+Inf.0 m³<br>
- dpt16 String;<br>
- dpt16.000 ASCII-String;<br>
- dpt16.001 ISO-8859-1-String (Latin1);<br>
- dpt19 01.12.2010_01:00:00<br>
- dpt232 RGB-Value RRGGBB<br>
- </ul>
- </ul>
- <p><a name="KODI"></a>
- <h3>KODI</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#KODI'>KODI</a><br/>
- </ul>
- <a name="KOPP_FC"></a>
- <h3>KOPP_FC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#KOPP_FC'>KOPP_FC</a><br/>
- </ul>
- <a name="KOSTALPIKO"></a>
- <h3>KOSTALPIKO</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#KOSTALPIKO'>KOSTALPIKO</a><br/>
- </ul>
- <a name="KS300"></a>
- <h3>KS300</h3>
- <div class='langLinks'>[<a href='commandref.html#KS300'>EN</a> DE]</div>
- <ul>
- Fhem kann KS300 bzw. KS555 Funktelegramme mit einem <a href="#FHZ">FHZ</a>,
- einem <a href="WS300">WS300</a> oder einem <a href="#CUL">CUL</a> empfangen.
- Daher muss eines von diesen zuerst definiert sein.<br> Dieses Modul behandelt
- Nachrichten die mittels CUL oder FHZ empfangen werden.<br>
- <br>
- <a name="KS300define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> KS300 <housecode> [ml/raincounter [wind-factor]]</code>
- <br><br>
- <code><housecode></code> ist ein vierstelliger HEX-Wert, der aus
- historischen Gründen angegeben werden muss, es wird ignoriert. Der
- ml/raincounter hat einen Default-Wert von 255ml, und muss angegeben sein
- wenn man den Wind-Faktor setzen will. Dieser hat einen Default-Wert von
- 1.0.<br>
- Beispiele:
- <ul>
- <code>define ks1 KS300 1234</code><br>
- </ul>
- </ul>
- <br>
- <a name="KS300set"></a>
- <b>Set </b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="KS300get"></a>
- <b>Get</b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="KS300attr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#eventMap">eventMap</a></li><br>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#model">model</a> (ks300)</li>
- <li>rainadjustment<br>
- Wenn dieses Attribut gesetzt ist, Regenmesser resets werden automatisch
- berücksichtigt. Resets treten beim Wechsel der Batterie und nach
- Beobachtung einiger Benutzer auch nach zufälligen Schaltzyklen
- auf. Die Voreinstellung ist 0 (aus).</li>
- </ul>
- <br>
- </ul>
- <p><a name="KeyValueProtocol"></a>
- <h3>KeyValueProtocol</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#KeyValueProtocol'>KeyValueProtocol</a><br/>
- </ul>
- <a name="LGTV"></a>
- <h3>LGTV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LGTV'>LGTV</a><br/>
- </ul>
- <a name="LGTV_IP12"></a>
- <h3>LGTV_IP12</h3>
- <div class='langLinks'>[<a href='commandref.html#LGTV_IP12'>EN</a> DE]</div>
- <ul>
- Dieses Modul steuert SmartTV's des Herstellers LG welche zwischen 2012 und 2014 produziert wurden über die Netzwerkschnittstelle.
- Es bietet die Möglichkeit den aktuellen TV Kanal zu steuern, sowie Apps zu starten, Fernbedienungsbefehle zu senden, sowie den aktuellen Status abzufragen.
- <br><br>
- Es werden alle TV Modelle unterstützt, welche mit der <a href="https://itunes.apple.com/de/app/lg-tv-remote/id509979485?mt=8" target="_new">LG TV Remote</a> Smartphone App steuerbar sind.
- <br><br>
- <a name="LGTV_IP12_define"></a>
- <b>Definition</b>
- <ul>
- <code>define <name> LGTV_IP12 <IP-Addresse> [<Status_Interval>]
- <br><br>
- define <name> LGTV_IP12 <IP-Addresse> [<Off_Interval>] [<On_Interval>]
- </code>
- <br><br>
- Bei der Definition eines LGTV_IP12-Moduls wird eine interne Routine in Gang gesetzt, welche regelmäßig
- (einstellbar durch den optionalen Parameter <code><Status_Interval></code>; falls nicht gesetzt ist der Standardwert 30 Sekunden)
- den Status des TV abfragt und entsprechende Notify-/FileLog-Definitionen triggert.
- <br><br>
- Sofern 2 Interval-Argumente übergeben werden, wird der erste Parameter <code><Off_Interval></code> genutzt
- sofern der TV ausgeschaltet ist. Der zweiter Parameter <code><On_Interval></code>
- wird verwendet, sofern der TV eingeschaltet ist.
- <br><br>
- Beispiel:<br><br>
- <ul><code>
- define TV LGTV_IP12 192.168.0.10
- <br><br>
- # Mit modifiziertem Status Interval (60 Sekunden)<br>
- define TV LGTV_IP12 192.168.0.10 60
- <br><br>
- # Mit gesetztem "Off"-Interval (60 Sekunden) und "On"-Interval (10 Sekunden)<br>
- define TV LGTV_IP12 192.168.0.10 60 10
- </code></ul>
- </ul>
- <br><br>
- <a name="LGTV_IP12_set"></a>
- <b>Set-Kommandos </b>
- <ul>
- <code>set <Name> <Kommando> [<Parameter>]</code>
- <br><br>
- Aktuell werden folgende Kommandos unterstützt.
- <br><br>
- <ul>
- <li><b>channel</b> <Nummer> - wählt den aktuellen TV-Kanal aus</li>
- <li><b>channelUp</b> - schaltet auf den nächsten Kanal um </li>
- <li><b>channelDown</b> - schaltet auf den vorherigen Kanal um </li>
- <li><b>removePairing</b> - löscht das Pairing zwischen FHEM und dem TV</li>
- <li><b>showPairCode</b> - zeigt den Pair-Code auf dem TV-Bildschirm an. Dieser Code muss im Attribut <a href="#LGTV_IP12_pairingcode">pairingcode</a> gesetzt werden, damit FHEM mit dem TV kommunizieren kann.</li>
- <li><b>startApp</b> <Name> - startet eine installierte App</li>
- <li><b>stopApp</b> <Name> - stoppt eine laufende App</li>
- <li><b>statusRequest</b> - fragt den aktuellen Status ab</li>
- <li><b>remoteControl</b> up,down,... - sendet Fernbedienungsbefehle</li>
- </ul>
- </ul>
- <br><br>
- <a name="LGTV_IP12_get"></a>
- <b>Get-Kommandos</b>
- <ul>
- <code>get <Name> <Readingname></code>
- <br><br>
- Aktuell stehen via GET lediglich die Werte der Readings zur Verfügung. Eine genaue Auflistung aller möglichen Readings folgen unter "Generierte Readings/Events".
- </ul>
- <br><br>
- <a name="LGTV_IP12_attr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="LGTV_IP12_disable">disable</a></li>
- Optionales Attribut zur Deaktivierung des zyklischen Status-Updates. Ein manuelles Update via statusRequest-Befehl ist dennoch möglich.
- <br><br>
- Mögliche Werte: 0 => zyklische Status-Updates, 1 => keine zyklischen Status-Updates.<br><br>
- <li><a name="LGTV_IP12_disabledForIntervals">disabledForIntervals</a> HH:MM-HH:MM HH:MM-HH-MM...</li>
- Optionales Attribut zur Deaktivierung der zyklischen Status-Updates innerhalb von bestimmten Zeitintervallen.
- Das Argument ist eine Leerzeichen-getrennte Liste von Minuszeichen-getrennten HH:MM Paaren (Stunde : Minute).
- Falls die aktuelle Uhrzeit zwischen diese Werte fällt, dann werden zyklische Status-Updates, wie bei <a href="#LGTV_IP12_disable">disable</a>, ausgesetzt.
- Statt HH:MM kann man auch HH oder HH:MM:SS angeben.<br><br>
- Um einen Intervall um Mitternacht zu spezifizieren, muss man zwei einzelne Intervalle angeben, z.Bsp.:
- <pre>23:00-24:00 00:00-01:00</pre>
- Standardwert ist <i>nicht gesetzt</i> (dauerhaft aktiv)<br><br>
- <li><a name="LGTV_IP12_request-timeout">request-timeout</a></li>
- Optionales Attribut. Maximale Dauer einer Anfrage in Sekunden zum TV.
- <br><br>
- Mögliche Werte: 1-5 Sekunden. Standartwert ist 4 Sekunden<br><br>
- <li><a name="LGTV_IP12_pairingcode">pairingcode</a></li>
- Dieses Attribut speichert den Pairing Code um sich gegenüber dem TV als vertrauenswürdigen Controller zu authentifizieren. Der Pairing-Code kann via Set-Kommando <a href="#LGTV_IP12_set">showPairCode</a> angezeigt werden.
- </ul>
- <br><br>
- <b>Generierte Readings/Events:</b><br>
- <ul>
- <li><b>3D</b> - Status des 3D-Wiedergabemodus ("true" => 3D Wiedergabemodus aktiv, "false" => 3D Wiedergabemodus nicht aktiv)</li>
- <li><b>channel</b> - Die Nummer des aktuellen TV-Kanals</li>
- <li><b>channelName</b> - Der Name des aktuellen TV-Kanals</li>
- <li><b>currentProgram</b> - Der Name der laufenden Sendung</li>
- <li><b>input</b> - Die aktuelle Eingangsquelle (z.B. Antenna, Sattelite, HDMI1, ...)</li>
- <li><b>inputLabel</b> - Die benutzerdefinierte Bezeichnung der aktuellen Eingangsquelle</li>
- <li><b>mute</b> on,off - Der aktuelle Stumm-Status ("on" => Stumm, "off" => Laut)</li>
- <li><b>power</b> on,off - Der aktuelle Power-Status ("on" => eingeschaltet, "off" => ausgeschaltet)</li>
- <li><b>volume</b> - Der aktuelle Lautstärkepegel.</li>
- </ul>
- </ul>
- <p><a name="LGTV_WebOS"></a>
- <h3>LGTV_WebOS</h3>
- <div class='langLinks'>[<a href='commandref.html#LGTV_WebOS'>EN</a> DE]</div>
- <ul>
- <ul>
- Dieses Modul steuert SmartTV's des Herstellers LG mit dem Betriebssystem WebOS über die Netzwerkschnittstelle. Es bietet die Möglichkeit den aktuellen TV Kanal zu steuern, sowie Apps zu starten, Fernbedienungsbefehle zu senden, sowie den aktuellen Status abzufragen.
- </ul>
- <p><br /><br /><strong>Definition </strong><code>define <name> LGTV_WebOS <IP-Addresse></code> <br /><br /></p>
- <ul>
- <ul>
- <ul>Bei der Definition eines LGTV_WebOS-Moduls wird eine interne Routine in Gang gesetzt, welche regelmäßig alle 15s den Status des TV abfragt und entsprechende Notify-/FileLog-Definitionen triggert.</ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>Beispiel: <code>define TV LGTV_WebOS 192.168.0.10 <br /></code><br /><br /></ul>
- </ul>
- </ul>
- <strong>Set-Kommandos </strong><code>set <Name> <Kommando> [<Parameter>]</code>
- <ul>
- <ul>
- <ul>Aktuell werden folgende Kommandos unterstützt.</ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>
- <ul>
- <li><strong>connect </strong> - Verbindet sich zum Fernseher unter der IP wie definiert, führt beim ersten mal automatisch ein pairing durch</li>
- <li><strong>pairing </strong> - Berechtigungsanfrage an den Fernseher, hier muss die Anfrage mit der Fernbedienung bestätigt werden</li>
- <li><strong>screenMsg</strong> <Text> - zeigt für ca 3-5s eine Nachricht auf dem Fernseher oben rechts an</li>
- <li><strong>mute</strong> on, off - Schaltet den Fernseher Stumm, je nach Anschluss des Audiosignals, muss dieses am Verstärker (AV Receiver) geschehen (siehe Volume)</li>
- <li><strong>volume </strong>0-100, Schieberegler - Setzt die Lautstärke des Fernsehers, je nach Anschluss des Audiosignals, muss dieses am Verstärker (AV Receiver) geschehen (siehe mute)</li>
- <li><strong>volumeUp</strong> - Erhöht die Lautstärke um den Wert 1</li>
- <li><strong>volumeDown</strong> - Verringert die Lautstärke um den Wert 1</li>
- <li><strong>channelUp</strong> - Schaltet auf den nächsten Kanal um</li>
- <li><strong>channelDown</strong> - Schaltet auf den vorherigen Kanal um</li>
- <li><strong>getServiceList </strong> - Fragrt die Laufenden Dienste des Fernsehers an (derzeit noch in Beta-Phase)</li>
- <li><strong>on</strong> - Schaltet den Fernseher ein, wenn WLAN oder LAN ebenfalls im Aus-Zustand aktiv ist (siehe Bedienungsanleitung da Typabhängig)</li>
- <li><strong>off</strong> - Schaltet den Fernseher aus, wenn eine Connection aktiv ist</li>
- <li><strong>launchApp</strong> <Anwendung> - Aktiviert eine Anwendung aus der Liste (Maxdome, AmazonVideo, YouTube, Netflix, TV, GooglePlay, Browser, Chili, TVCast, Smartshare, Scheduler, Miracast, TV) <br />Achtung: TV ist hier eine Anwendung, und kein Geräteeingang</li>
- <li><strong>3D</strong> on,off - 3D Modus kann hier ein- und ausgeschaltet werden, je nach Fernseher können mehrere 3D Modi unterstützt werden (z.B. Side-by-Side, Top-Bottom)</li>
- <li><strong>stop</strong> - Stop-Befehl (anwendungsabhängig)</li>
- <li><strong>play </strong>- Play-Befehl (anwendungsabhängig)</li>
- <li><strong>pause </strong>- Pause-Befehl (anwendungsabhängig)</li>
- <li><strong>rewind </strong>- Zurückspulen-Befehl (anwendungsabhängig)</li>
- <li><strong>fastForward </strong>- Schneller-Vorlauf-Befehl (anwendungsabhängig)</li>
- <li><strong>clearInputList </strong> - Löscht die Liste der Geräteeingänge</li>
- <li><strong>input </strong> - Wählt den Geräteeingang aus (Abhängig von Typ und angeschossenen Geräten) <br />Beispiele: extInput_AV-1, extInput_HDMI-1, extInput_HDMI-2, extInput_HDMI-3)</li>
- </ul>
- </ul>
- </ul>
- </ul>
- <p><strong>Get-Kommandos</strong> <code>get <Name> <Readingname></code><br /><br /></p>
- <ul>
- <ul>
- <ul>Aktuell stehen via GET lediglich die Werte der Readings zur Verfügung. Eine genaue Auflistung aller möglichen Readings folgen unter "Generierte Readings/Events".</ul>
- </ul>
- </ul>
- <p><br /><br /><strong>Attribute</strong></p>
- <ul>
- <ul>
- <ul>
- <li>disable</li>
- Optionales Attribut zur Deaktivierung des zyklischen Status-Updates. Ein manuelles Update via statusRequest-Befehl ist dennoch möglich.
- </ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>Mögliche Werte: 0 => zyklische Status-Updates, 1 => keine zyklischen Status-Updates.</ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>
- <li>channelGuide</li>
- Optionales Attribut zur Deaktivierung der zyklischen Updates des TV-Guides, dieses beansprucht je nach Hardware einigen Netzwerkverkehr und Prozessorlast
- </ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>Mögliche Werte: 0 => keine zyklischen TV-Guide-Updates, 1 => zyklische TV-Guide-Updates</ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>
- <li>wakeOnLanMAC</li>
- MAC Addresse der Netzwerkkarte vom LG TV
- </ul>
- </ul>
- </ul>
- <ul>
- <ul>
- <ul>
- <li>wakeOnLanBroadcast</li>
- Broadcast Netzwerkadresse - wakeOnLanBroadcast <netzwerk>.255
- </ul>
- </ul>
- </ul>
- <p><br /><br /><strong>Generierte Readings/Events:</strong></p>
- <ul>
- <ul>
- <li><strong>3D</strong> - Status des 3D-Wiedergabemodus ("on" => 3D Wiedergabemodus aktiv, "off" => 3D Wiedergabemodus nicht aktiv)</li>
- <li><strong>3DMode</strong> - Anzeigemodus (2d, 2dto3d, side_side_half, line_interleave_half, column_interleave, check_board)</li>
- <li><strong>channel</strong> - Die Nummer des aktuellen TV-Kanals</li>
- <li><strong>channelName</strong> - Der Name des aktuellen TV-Kanals</li>
- <li><strong>channelMedia</strong> - Senderinformation</li>
- <li><strong>channelCurrentEndTime </strong>- Ende der laufenden Sendung (Beta)</li>
- <li><strong>channelCurrentStartTime </strong>- Start der laufenden Sendung (Beta)</li>
- <li><strong>channelCurrentTitle</strong> - Der Name der laufenden Sendung (Beta)</li>
- <li><strong>channelNextEndTime </strong>- Ende der nächsten Sendung (Beta)</li>
- <li><strong>channelNextStartTime </strong>- Start der nächsten Sendung (Beta)</li>
- <li><strong>channelNextTitle</strong> - Der Name der nächsten Sendung (Beta)</li>
- <li><strong>extInput_<Geräteeingang</strong>> - Status der Eingangsquelle (connect_true, connect_false)</li>
- <li><strong>input</strong> - Derzeit aktiver Geräteeingang</li>
- <li><strong>lastResponse </strong>- Status der letzten Anfrage (ok, error <Fehlertext>)</li>
- <li><strong>launchApp</strong> <Anwendung> - Gegenwärtige aktive Anwendung</li>
- <li><strong>lgKey</strong> - Der Client-Key, der für die Verbindung verwendet wird</li>
- <li><strong>mute</strong> on,off - Der aktuelle Stumm-Status ("on" => Stumm, "off" => Laut)</li>
- <li><strong>pairing</strong> paired, unpaired - Der Status des Pairing</li>
- <li><strong>presence </strong>absent, present - Der aktuelle Power-Status ("present" => eingeschaltet, "absent" => ausgeschaltet)</li>
- <li><strong>state</strong> on, off - Status des Fernsehers (ähnlich presence)</li>
- <li><strong>volume</strong> - Der aktuelle Lautstärkepegel -1, 0-100 (-1 invalider Wert)</li>
- </ul>
- </ul>
- </ul>
- <p><a name="LIGHTIFY"></a>
- <h3>LIGHTIFY</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LIGHTIFY'>LIGHTIFY</a><br/>
- </ul>
- <a name="LINDY_HDMI_SWITCH"></a>
- <h3>LINDY_HDMI_SWITCH</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LINDY_HDMI_SWITCH'>LINDY_HDMI_SWITCH</a><br/>
- </ul>
- <a name="LIRC"></a>
- <h3>LIRC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LIRC'>LIRC</a><br/>
- </ul>
- <a name="LUXTRONIK2"></a>
- <h3>LUXTRONIK2</h3>
- <div class='langLinks'>[<a href='commandref.html#LUXTRONIK2'>EN</a> DE]</div>
- <div>
- <ul>
- Die Luxtronik 2.0 ist eine Heizungssteuerung der Firma <a href="http://www.alpha-innotec.de">Alpha Innotec</a>, welche in Wärmepumpen von Alpha Innotec,
- Siemens Novelan (WPR NET), Roth (ThermoAura®, ThermoTerra), Elco und Wolf Heiztechnik (BWL/BWS) verbaut ist.
- Sie besitzt einen Ethernet Anschluss, so dass sie direkt in lokale Netzwerke (LAN) integriert werden kann.
- <br>
- <i>Das Modul wurde bisher mit folgender Steuerungs-Firmware getestet: V1.51, V1.54C, V1.60, V1.64, V1.69, V1.70, V1.73, V1.77, V1.80, V1.81.</i>
- <br>
- Mehr Infos im entsprechenden <u><a href="http://www.fhemwiki.de/wiki/Luxtronik_2.0">Artikel der FHEM-Wiki</a></u>.
- <br>
- <br>
- <a name="LUXTRONIK2define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> LUXTRONIK2 <IP-Adresse[:Port]> [Abfrageinterval]</code>
- <br>
- Wenn das Abfrage-Interval nicht angegeben ist, wird es auf 300 (Sekunden) gesetzt. Der kleinste mögliche Wert ist 10.
- <br>
- Die Angabe des Portes kann gewöhnlich entfallen.
- <br>
- Beispiel: <code>define Heizung LUXTRONIK2 192.168.0.12 600</code>
-
- </ul>
- <br>
-
- <a name="LUXTRONIK2set"></a>
- <b>Set</b><br>
- <ul>
- Durch einen Firmware-Test wird vor jeder Set-Operation sichergestellt, dass Wärmepumpen mit ungetester Firmware nicht unabsichtlich beschädigt werden.
- <br>
- <li><code>activeTariff < 0 - 9 ></code>
- <br>
- Erlaubt die gezielte, separate Erfassung der statistischen Verbrauchswerte (doStatistics = 1) für verschiedene Tarife (Doppelstromzähler)<br>
- Dieser Wert muss entsprechend des vorhandenen oder geplanten Tarifes zum jeweiligen Zeitpunkt z.B. durch den FHEM-Befehl "at" gesetzt werden.<br>
- 0 = tariflos
- </li><br>
- <li><code>heatingCurveEndPoint <Temperaratur></code><br>
- Einstellung des Heizkurvenparameters. In 0.1er Schritten einstellbar.
- </li><br>
- <li><code>heatingCurveOffset <Temperaratur></code><br>
- Einstellung des Heizkurvenparameters. In 0.1er Schritten einstellbar.
- </li><br>
- <li><code>hotWaterCircPumpDeaerate <on | off></code><br>
- Schaltet die externe Warmwasser-Zirkulationspumpe an oder aus. Durch die Zirkulation wird das Abkühlen des Warmwassers in den Hausleitungen verhindert. Der Wärmeverbrauch steigt jedoch drastisch.
- <br>
- Achtung! Es wird die Entlüftungsfunktion der Steuerung genutzt. Dadurch taktet die Pumpe jeweils 5 Minuten ein und 5 Minuten aus.
- </li><br>
- <li><code>hotWaterTemperatureTarget <Temperatur></code>
- <br>
- Soll-Temperatur des Heißwasserboilers in °C
- </li><br>
- <li><code>opModeHotWater <Betriebsmodus></code>
- <br>
- Betriebsmodus des Heißwasserboilers ( Auto | Party | Off )
- </li><br>
- <li><code>resetStatistics <statWerte></code>
- <br>
- Löscht die ausgewählten statisischen Werte: <i>all, statBoilerGradientCoolDownMin, statAmbientTemp..., statElectricity..., statHours..., statHeatQ...</i>
- </li><br>
- <li><code>returnTemperatureHyst <Temperatur></code>
- <br>
- Sollwert-Hysterese der Heizungsregelung. 0.5 K bis 3 K. In 0.1er Schritten einstellbar.
- </li><br>
- <li><code>returnTemperatureSetBack <Temperatur></code>
- <br>
- Absenkung oder Anhebung der Rücklauftemperatur von -5 K bis + 5K. In 0.1er Schritten einstellbar.
- </li><br>
- <li><code>INTERVAL <Sekunden></code>
- <br>
- Abfrageinterval in Sekunden
- </li><br>
- <li><code>statusRequest</code>
- <br>
- Aktualisieren der Gerätewerte
- </li><br>
- <li><code>synchClockHeatPump</code>
- <br>
- Abgleich der Uhr der Steuerung mit der FHEM Zeit. <b>Diese Änderung geht verloren, sobald die Steuerung ausgeschaltet wird!!</b></li>
- </ul>
- <br>
-
- <a name="LUXTRONIK2get"></a>
- <b>Get</b>
- <ul>
- <li><code>heatingCurveParameter <Aussentemp1 Solltemp1 Aussentemp2 Solltemp2></code>
- <br>
- Ermittelt rekursiv anhand zweier Punkte auf der Heizkurve die entsprechenden Heizkurvenparameter <i>heatingCurveEndPoint</i> und <i>heatingCurveOffset</i>.<br>
- Diese können dann über die entsprechenden set-Befehl einstellt werden.
- </li>
- <br>
- <li><code>rawData</code>
- <br>
- Zeigt alle von der Steuerung auslesbaren Parameter und Betriebswerte an.<br>
- Diese können dann mit den Attributen <i>userHeatpumpParameters</i> und <i>userHeatpumpValues</i> einem Gerätewert zugeordnet werden.
- </li><br>
- </ul>
- <br>
-
- <a name="LUXTRONIK2attr"></a>
- <b>Attribute</b>
- <ul>
- <li><code>allowSetParameter < 0 | 1 ></code>
- <br>
- Die internen <a href="#LUXTRONIK2set">Parameter</a> der Wärmepumpensteuerung können
- nur geändert werden, wenn dieses Attribut auf 1 gesetzt ist.
- </li><br>
- <li><code>autoSynchClock <Zeitunterschied></code>
- <br>
- Die Uhr der Wärmepumpe wird automatisch korrigiert, wenn ein gewisser <i>Zeitunterschied</i> (10 s - 600 s)
- gegenüber der FHEM Zeit erreicht ist. Zuvor wird die Kompatibilität der Firmware überprüft.<br>
- <i>(Ein Gerätewert 'delayDeviceTimeCalc' <= 2 s ist auf die internen Berechnungsintervale der
- Wärmepumpensteuerung zurückzuführen.)</i>
- </li><br>
- <li><code>compressor2ElectricalPowerWatt</code><br>
- Betriebsleistung des zweiten Kompressors zur Berechung der Arbeitszahl (erzeugte Wärme pro elektrische Energieeinheit)
- und Abschätzung des elektrischen Verbrauches (Auswertungen noch nicht implementiert)
- </li><br>
- <li><code>doStatistics < 0 | 1 ></code>
- <br>
- Berechnet statistische Werte: <i>statBoilerGradientHeatUp, statBoilerGradientCoolDown,
- statBoilerGradientCoolDownMin (Wärmeverlust des Boilers)</i>
- <br>
- Bildet tägliche, monatliche und jährliche Statistiken bestimmter Gerätewerte.<br>
- Für grafische Auswertungen können die Werte der Form 'stat<i>ReadingName</i><b>Last</b>' genutzt werden.
- </li><br>
- <li><code>heatPumpElectricalPowerWatt <E-Leistung in Watt></code><br>
- Elektrische Leistungsaufnahme der Wärmepumpe in Watt bei einer Vorlauftemperatur von 35 °C zur Berechung der Arbeitszahl (erzeugte Wärme pro elektrische Energieeinheit)
- und Abschätzung des elektrischen Verbrauches
- </li><br>
- <li><code>heatPumpElectricalPowerFactor</code><br>
- Änderung der elektrischen Leistungsaufnahme pro 1 K Vorlauftemperaturdifferenz zu 35 °C
- <br>
- (z.B. 2% pro 1 K = 0,02)
- </li><br>
- <li><code>heatRodElectricalPowerWatt <E-Leistung in Watt></code><br>
- Elektrische Leistungsaufnahme der Heizstäbe in Watt zur Abschätzung des elektrischen Verbrauches
- </li><br>
- <li><code>ignoreFirmwareCheck < 0 | 1 ></code>
- <br>
- Durch einen Firmware-Test wird vor jeder Set-Operation sichergestellt, dass Wärmepumpen
- mit ungetester Firmware nicht unabsichtlich beschädigt werden. Wenn dieses Attribute auf 1
- gesetzt ist, dann wird der Firmware-Test ignoriert und neue Firmware kann getestet werden.
- Dieses Attribut wird jedoch ignoriert, wenn die Steuerungs-Firmware bereits als nicht kompatibel berichtet wurde.
- </li><br>
- <li><code>statusHTML</code>
- <br>
- Wenn gesetzt, dann wird ein HTML-formatierter Wert "floorplanHTML" erzeugt,
- welcher vom Modul <a href="#FLOORPLAN">FLOORPLAN</a> genutzt werden kann.<br>
- Momentan wird nur geprüft, ob der Wert dieses Attributes ungleich NULL ist,
- der entsprechende Gerätewerte besteht aus dem aktuellen Wärmepumpenstatus und der Heizwassertemperatur.
- </li><br>
- <li><code>userHeatpumpParameters <Index [Name][,Index2 [Name2],Index3 [Name3] ...]></code>
- <br>
- Erlaubt das Auslesen der Werte benutzerspezifischer Parameter. Die Indizes der verf¨gbaren Parameterwerte können mit dem get-Befehl <i>rawData</i> ermittelt werden.<br>
- In der Attributdefinition kann der Name hinter den Index getrennt durch ein Leerzeichen geschrieben werden. Der jeweilige Parameter-Wert wird entweder mit dem Präfix "userParameter..." oder unter dem angegebenen Namen angezeigt. <br>
- Mehrere Indizes werden durch Kommas getrennt.<br>
- Nicht mehr benötigte Gerätewerte können mit dem FHEM-Befehl <a href="#deletereading">deleteReading</a> gelöscht werden.
- </li><br>
- <li><code>userHeatpumpValues <Index Name[,Index2 Name2,Index3 Name3 ...]></code>
- <br>
- Erlaubt das Auslesen benutzerspezifische Betriebswerte. Vorgehen wie bei <i>userHeatpumpParameters</i>.
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a>
- </li><br>
- </ul>
- </ul>
- </div>
- <p><a name="LaCrosse"></a>
- <h3>LaCrosse</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LaCrosse'>LaCrosse</a><br/>
- </ul>
- <a name="LaCrosseGateway"></a>
- <h3>LaCrosseGateway</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LaCrosseGateway'>LaCrosseGateway</a><br/>
- </ul>
- <a name="Level"></a>
- <h3>Level</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Level'>Level</a><br/>
- </ul>
- <a name="LightScene"></a>
- <h3>LightScene</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#LightScene'>LightScene</a><br/>
- </ul>
- <a name="Log2Syslog"></a>
- <h3>Log2Syslog</h3>
- <div class='langLinks'>[<a href='commandref.html#Log2Syslog'>EN</a> DE]</div>
- <ul>
- Sendet FHEM Systemlog Einträge und/oder Events an einen externen Syslog-Server weiter. <br>
- Die Implementierung des Syslog-Protokolls erfolgte entsprechend den Vorgaben von <a href="https://tools.ietf.org/html/rfc5424"> RFC5424 (IETF)</a>,
- <a href="https://tools.ietf.org/html/rfc3164"> RFC3164 (BSD)</a> sowie dem TLS Transport Protokoll nach
- <a href="https://tools.ietf.org/pdf/rfc5425.pdf"> RFC5425</a>. <br>
- <br>
-
- <b>Voraussetzungen</b>
- <ul>
- <br/>
- Es wird das Perl Modul "IO::Socket::INET" benötigt und muss installiert sein. <br>
- Das Modul kann über CPAN oder mit <br><br>
-
- <code>apt-get install libio-socket-multicast-perl (auf Debian Linux Systemen) </code><br><br>
-
- installiert werden.
- </ul>
- <br/>
-
- <a name="Log2Syslogdefine"></a>
- <b>Definition</b>
- <ul>
- <br>
- <code>define <name> Log2Syslog <Zielhost> [ident:<ident>] [event:<regexp>] [fhem:<regexp>] </code><br>
- <br>
- <Zielhost> = Host (Name oder IP-Adresse) auf dem der Syslog-Server läuft <br>
- [ident:<ident>] = optionaler Programm Identifier. Wenn nicht gesetzt wird per default der Devicename benutzt. <br>
- [event:<regexp>] = optionaler regulärer Ausdruck zur Filterung von Events zur Weiterleitung <br>
- [fhem:<regexp>] = optionaler regulärer Ausdruck zur Filterung von FHEM Logs zur Weiterleitung <br><br>
-
- Direkt nach der Definition sendet das neue Device alle neu auftretenden FHEM Systemlog Einträge und Events ohne weitere
- Einstellungen an den Zielhost, Port=514/UDP Format=IETF, wenn reguläre Ausdrücke für Events/FHEM angegeben wurden. <br>
- Wurde kein Regex gesetzt, erfolgt keine Weiterleitung von Events oder FHEM Systemlogs. <br><br>
-
- Die Verbose-Level der FHEM Systemlogs werden in entsprechende Schweregrade der Syslog-Messages umgewandelt. <br>
- Weiterhin wird der Meldungstext der FHEM Systemlogs und Events nach den Signalwörtern "warning" und "error" durchsucht
- (Groß- /Kleinschreibung wird nicht beachtet). Davon abhängig wird der Schweregrad ebenfalls äquivalent gesetzt und übersteuert
- einen eventuell bereits durch Verbose-Level gesetzten Schweregrad. <br><br>
-
- <b>Umsetzungstabelle Verbose-Level in Syslog-Schweregrad Stufe: </b><br><br>
- <ul>
- <table>
- <colgroup> <col width=40%> <col width=60%> </colgroup>
- <tr><td> <b>Verbose-Level</b> </td><td> <b>Schweregrad in Syslog</b> </td></tr>
- <tr><td> 0 </td><td> Critical </td></tr>
- <tr><td> 1 </td><td> Error </td></tr>
- <tr><td> 2 </td><td> Warning </td></tr>
- <tr><td> 3 </td><td> Notice </td></tr>
- <tr><td> 4 </td><td> Informational </td></tr>
- <tr><td> 5 </td><td> Debug </td></tr>
- </table>
- </ul>
- <br>
-
- <br>
- Beispiel:<br/>
- <br/>
- <code>define splunklog Log2Syslog fhemtest 192.168.2.49 ident:Test event:.* fhem:.* </code><br/>
- <br/>
- Es werden alle Events weitergeleitet wie deses Beispiel der raw-Ausgabe eines Splunk Syslog Servers zeigt::<br/>
- <pre>Aug 18 21:06:46 fhemtest.myds.me 1 2017-08-18T21:06:46 fhemtest.myds.me Test_event 13339 FHEM - : LogDB sql_processing_time: 0.2306
- Aug 18 21:06:46 fhemtest.myds.me 1 2017-08-18T21:06:46 fhemtest.myds.me Test_event 13339 FHEM - : LogDB background_processing_time: 0.2397
- Aug 18 21:06:45 fhemtest.myds.me 1 2017-08-18T21:06:45 fhemtest.myds.me Test_event 13339 FHEM - : LogDB CacheUsage: 21
- Aug 18 21:08:27 fhemtest.myds.me 1 2017-08-18T21:08:27.760 fhemtest.myds.me Test_fhem 13339 FHEM - : 4: CamTER - Informations of camera Terrasse retrieved
- Aug 18 21:08:27 fhemtest.myds.me 1 2017-08-18T21:08:27.095 fhemtest.myds.me Test_fhem 13339 FHEM - : 4: CamTER - CAMID already set - ignore get camid
- </pre>
- Der Aufbau der Payload unterscheidet sich je nach verwendeten logFormat. <br><br>
-
- <b>logFormat IETF:</b> <br><br>
- "<PRIVAL>1 TIME MYHOST IDENT PID MID - : MESSAGE" <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=10%> <col width=90%> </colgroup>
- <tr><td> PRIVAL </td><td> Priority Wert (kodiert aus "facility" und "severity") </td></tr>
- <tr><td> TIME </td><td> Timestamp nach RFC5424 </td></tr>
- <tr><td> MYHOST </td><td> Internal MYHOST </td></tr>
- <tr><td> IDENT </td><td> Ident-Tag aus DEF wenn angegeben, sonst der eigene Devicename. Die Angabe wird mit "_fhem" (FHEM-Log) bzw. "_event" (Event-Log) ergänzt. </td></tr>
- <tr><td> PID </td><td> fortlaufende Payload-ID </td></tr>
- <tr><td> MID </td><td> fester Wert "FHEM" </td></tr>
- <tr><td> MESSAGE </td><td> der zu übertragende Datensatz </td></tr>
- </table>
- </ul>
- <br>
-
- <b>logFormat BSD:</b> <br><br>
- "<PRIVAL>MONAT TAG TIME MYHOST IDENT: : MESSAGE" <br><br>
-
- <ul>
- <table>
- <colgroup> <col width=10%> <col width=90%> </colgroup>
- <tr><td> PRIVAL </td><td> Priority Wert (kodiert aus "facility" und "severity") </td></tr>
- <tr><td> MONAT </td><td> Monatsangabe nach RFC3164 </td></tr>
- <tr><td> TAG </td><td> Tag des Monats nach RFC3164 </td></tr>
- <tr><td> TIME </td><td> Zeitangabe nach RFC3164 </td></tr>
- <tr><td> MYHOST </td><td> Internal MYHOST </td></tr>
- <tr><td> IDENT </td><td> Ident-Tag aus DEF wenn angegeben, sonst der eigene Devicename. Die Angabe wird mit "_fhem" (FHEM-Log) bzw. "_event" (Event-Log) ergänzt. </td></tr>
- <tr><td> MESSAGE </td><td> der zu übertragende Datensatz </td></tr>
- </table>
- </ul>
- <br>
-
- </ul>
- <br><br>
-
- <a name="Log2SyslogGet"></a>
- <b>Get</b>
- <ul>
- <br>
-
- <li><code>certinfo</code><br>
- <br>
- Zeigt Informationen zum Serverzertifikat wenn eine TLS-Session aufgebaut wurde (Reading "SSL_Version" ist nicht "n.a.").
- </li><br>
- </ul>
- <br>
-
-
- <a name="Log2Syslogattr"></a>
- <b>Attribute</b>
- <ul>
- <br>
-
- <a name="addTimestamp"></a>
- <li><code>addTimestamp [0|1]</code><br>
- <br/>
- Wenn gesetzt, werden FHEM Timestamps im Datensatz mit übertragen.<br/>
- Per default werden die Timestamps nicht mit übertragen, da der Syslog-Server eigene Timestamps verwendet.<br/>
- Die Einstellung kann hilfeich sein wenn mseclog in FHEM aktiviert ist.<br/>
- <br/>
-
- Beispielausgabe (raw) eines Splunk Syslog Servers:<br/>
- <pre>Aug 18 21:26:55 fhemtest.myds.me 1 2017-08-18T21:26:55 fhemtest.myds.me Test_event 13339 FHEM - : 2017-08-18 21:26:55 USV state: OL
- Aug 18 21:26:54 fhemtest.myds.me 1 2017-08-18T21:26:54 fhemtest.myds.me Test_event 13339 FHEM - : 2017-08-18 21:26:54 Bezug state: done
- Aug 18 21:26:54 fhemtest.myds.me 1 2017-08-18T21:26:54 fhemtest.myds.me Test_event 13339 FHEM - : 2017-08-18 21:26:54 recalc_Bezug state: Next: 21:31:59
- </pre>
- </li><br>
- <li><code>addStateEvent [0|1]</code><br>
- <br>
- Wenn gesetzt, werden state-events mit dem Reading "state" ergänzt.<br/>
- Die Standardeinstellung ist ohne state-Ergänzung.
- </li><br>
-
- <li><code>disable [0|1]</code><br>
- <br>
- Das Device wird aktiviert | aktiviert.
- </li><br>
-
- <li><code>logFormat [BSD|IETF]</code><br>
- <br>
- Stellt das Protokollformat ein. <br>
- Der Standardwert ist "IETF". <br>
- </li><br>
-
- <li><code>protocol [TCP|UDP]</code><br>
- <br>
- Setzt den Protokolltyp der verwendet werden soll. Es kann UDP oder TCP gewählt werden. <br>
- Standard ist "UDP" wenn nichts spezifiziert ist.
- </li><br>
-
- <li><code>port</code><br>
- <br>
- Der verwendete Port des Syslog-Servers. (default 514)
- </li><br>
-
- <li><code>rateCalcRerun</code><br>
- <br>
- Wiederholungszyklus für die Bestimmung der Log-Transferrate (Reading "Transfered_logs_per_minute") in Sekunden.
- Default sind 60 Sekunden.
- </li><br>
-
- <li><code>timeout</code><br>
- <br>
- Timeout für die Verbindung zum Syslog-Server (TCP).
- </li><br>
-
- <li><code>verbose</code><br>
- <br>
- Die Ausgaben der Verbose-Level von Log2Syslog-Devices werden ausschließlich im lokalen FHEM Logfile ausgegeben und
- nicht weitergeleitet um Schleifen zu vermeiden.
- </li><br>
-
- </ul>
- <br>
-
- <a name="Log2Syslogreadings"></a>
- <b>Readings</b>
- <ul>
- <br>
- <table>
- <colgroup> <col width=35%> <col width=65%> </colgroup>
- <tr><td><b>SSL_Algorithm</b> </td><td> der verwendete SSL Algorithmus wenn SSL eingeschaltet und aktiv ist </td></tr>
- <tr><td><b>SSL_Version</b> </td><td> die verwendete TLS-Version wenn die Verschlüsselung aktiv ist</td></tr>
- <tr><td><b>Transfered_logs_per_minute</b> </td><td> die durchschnittliche Anzahl der übertragenen Logs/Events pro Minute </td></tr>
- </table>
- <br>
- </ul>
-
- </ul>
- <p><a name="LuftdatenInfo"></a>
- <h3>LuftdatenInfo</h3>
- <div class='langLinks'>[<a href='commandref.html#LuftdatenInfo'>EN</a> DE]</div>
- (<a href="commandref.html#LuftdatenInfo"><u>en</u></a> | de)
- <div>
- <ul>
- LuftdatenInfo ist das FHEM Modul um Feinstaub-, Temperatur- und
- Luftfeuchtichkeitswerte von den selbstbau Feinstaub Sensoren von
- <a href="http://Luftdaten.info"><u>Luftdaten.info</u></a> auszulesen.<br>
- Dabei können die Werte direkt vom Server oder auch lokal abgefragt
- werden.<br>
- Bei einer lokalen Abfrage werden durch eine
- <a href="https://forum.fhem.de/index.php/topic,73879">
- <u>alternative Firmware</u>
- </a>
- noch weitere Sensoren unterstützt.<br>
- <br>
- <b>Vorraussetzungen</b>
- <ul>
- Das Perl-Modul "JSON" wird benötigt.<br>
- Unter Debian (basierten) System, kann dies mittels
- <code>"apt-get install libjson-perl"</code> installiert werden.
- </ul>
- <br>
- <a name="LuftdatenInfodefine"></a>
- <b>Define</b>
- <ul>
- <code>
- define <name> LuftdatenInfo remote
- <SENSORID1> [<SENSORID2> ..]<br>
- define <name> LuftdatenInfo local <IP><br>
- define <name> LuftdatenInfo
- slave <master-name> <sensor1 sensor2 ...>
- </code><br>
- Für eine Abfrage der Daten vom Server müssem alle betroffenenen
- SensorIDs angegeben werden. Die IDs vom SDS01 stehen rechts auf der Seite
- <a href="http://maps.luftdaten.info/">
- <u>http://maps.luftdaten.info/</u>
- </a>
- . Die DHT22 SensorID entspricht normalerweise der SDS011 SensorID + 1.
- Bei einer Abfrage werden die die Positionsangaben verglichen und bei
- einer Abweichung eine Meldung ins Log geschrieben.<br>
- Für eine lokale Abfrage der Daten muss die IP Addresse oder der
- Hostname angegeben werden.<br>
- Werden mehrere ähnliche Sensoren betrieben lassen sich die doppelten
- Werte in einem anderen Gerät geschrieben werden.
- </ul><br>
- <a name="LuftdatenInfoset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>statusRequest</code><br>
- Startet eine Abfrage der Daten.
- </li>
- </ul><br>
- <a name="LuftdatenInfoget"></a>
- <b>Get</b>
- <ul>
- <li>
- <code>sensors</code><br>
- Listet alle Sensoren auf.
- </li>
- </ul><br>
- <a name="LuftdatenInforeadings"></a>
- <b>Readings</b><br>
- <ul>
- <li>
- <code>altitude</code><br>
- Höhe über NN
- </li>
- <li>
- <code>humidity</code><br>
- Relative Luftfeuchtgkeit in %
- </li>
- <li>
- <code>illuminanceFull</code><br>
- Helligkeit des vollen Bereich in lux
- </li>
- <li>
- <code>illuminanceIR</code><br>
- Helligkeit des IR Bereich in lux
- </li>
- <li>
- <code>illuminanceUV</code><br>
- Helligkeit des UV Bereich in lux
- </li>
- <li>
- <code>illuminanceVisible</code><br>
- Helligkeit des sichtbaren Bereich in lux
- </li>
- <li>
- <code>latitude</code><br>
- Längengrad
- </li>
- <li>
- <code>location</code><br>
- Standort als "Postleitzahl Ort"<br>
- Nur bei remote Abfrage verfügbar.
- </li>
- <li>
- <code>longitude</code><br>
- Breitengrad
- </li>
- <li>
- <code>PM1</code><br>
- Menge der Partikel mit einem Durchmesser von weniger als 1 µm in µg/m³
- </li>
- <li>
- <code>PM2.5</code><br>
- Menge der Partikel mit einem Durchmesser von weniger als 2.5 µm in µg/m³
- </li>
- <li>
- <code>PM10</code><br>
- Menge der Partikel mit einem Durchmesser von weniger als 10 µm in µg/m³
- </li>
- <li>
- <code>pressure</code><br>
- Luftdruck in hPa
- </li>
- <li>
- <code>pressureNN</code><br>
- Luftdruck für Normal Null in hPa<br>
- Wird bei aktivem Luftdruck- und Temperatursensor berechnet, sofern sich
- der Sensor nicht auf Normal Null befindet.<br>
- Hierzu ist die Höhe, kann über Kartendienste oder SmartPhone ermittelt
- werden, auf der Konfigurationsseite anzugeben.
- </li>
- <li>
- <code>signal</code><br>
- WLAN Signalstärke in dBm<br>
- Nur bei local Abfrage verfügbar.
- </li>
- <li>
- <code>temperature</code><br>
- Temperatur in °C
- </li>
- <li>
- <code>UVIntensity</code><br>
- UV Intensität in W
- </li>
- <li>
- <code>UVRisk</code><br>
- UV Risiko von 1 bis 5
- </li>
- </ul><br>
- <a name="LuftdatenInfoattr"></a>
- <b>Attribute</b>
- <ul>
- <li>
- <code>disable 1</code><br>
- Es werden keine Abfragen mehr gestartet.
- </li>
- <li>
- <a href="#disabledForIntervals">
- <u><code>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ...</code></u>
- </a>
- </li>
- <li>
- <code>interval <seconds></code><br>
- Intervall in Sekunden in dem Abfragen durchgeführt werden.<br>
- Der Vorgabe- und Mindestwert beträgt 300 Sekunden.
- </li>
- <li>
- <code>timeout <seconds></code><br>
- Timeout in Sekunden für die Abfragen.<br>
- Der Vorgabe- und Mindestwert beträgt 5 Sekunden.
- </li>
- </ul>
- </ul>
- </div>
- <p><a name="M232"></a>
- <h3>M232</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#M232'>M232</a><br/>
- </ul>
- <a name="M232Counter"></a>
- <h3>M232Counter</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#M232Counter'>M232Counter</a><br/>
- </ul>
- <a name="M232Voltage"></a>
- <h3>M232Voltage</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#M232Voltage'>M232Voltage</a><br/>
- </ul>
- <a name="MAX"></a>
- <h3>MAX</h3>
- <div class='langLinks'>[<a href='commandref.html#MAX'>EN</a> DE]</div>
- <ul>
- Verarbeitet MAX! Geräte, die von der eQ-3 MAX! Gruppe hergestellt werden.<br>
- Falls Heizkörperthermostate eine Temperatur von Null Grad zeigen, wurde von ihnen
- noch nie Daten an den MAX Cube gesendet. In diesem Fall kann das Senden von Daten an
- den Cube durch Einstellen einer Temeratur direkt am Gerät (nicht über fhem)
- erzwungen werden.
- <br><br>
- <a name="MAXdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> MAX <type> <addr></code>
- <br><br>
- Erstellt ein MAX Gerät des Typs <type> und der RF Adresse <addr>.
- Als <type> kann entweder <code>HeatingThermostat</code> (Heizkörperthermostat),
- <code>HeatingThermostatPlus</code> (Heizkörperthermostat Plus),
- <code>WallMountedThermostat</code> (Wandthermostat), <code>ShutterContact</code> (Fensterkontakt)
- oder <code>PushButton</code> (Eco-Taster) gewählt werden.
- Die Adresse <addr> ist eine 6-stellige hexadezimale Zahl.
- Da <a href="#autocreate">autocreate</a> diese vergibt, sollte diese nie händisch gewählt
- werden müssen.<br>
- Es ist empfehlenswert, das Atribut <code>event-on-change-reading</code> zu setzen, z.B.
- <code>attr MAX_123456 event-on-change-reading .*</code> da ansonsten der "Polling" Mechanismus
- alle 10 s ein Ereignis erzeugt.<br>
- Beispiel:
- <ul>
- <code>define switch1 MAX PushButton ffc545</code><br>
- </ul>
- </ul>
- <br>
- <a name="MAXset"></a>
- <b>Set</b>
- <ul>
- <li>desiredTemperature <value> [until <date>]<br>
- Nur für Heizkörperthermostate. <value> kann einer aus folgenden Werten sein
- <ul>
- <li>Grad Celsius zwischen 3,5 und 30,5 Grad in 0,5 Kelvin Schritten</li>
- <li>"on" oder "off" versetzt den Thermostat in volle bzw. keine Heizleistung</li>
- <li>"eco" oder "comfort" mit der eco/comfort Temperatur, die direkt am Gerät
- eingestellt wurde (änhlich wie die rechte Taste am Gerät selbst)</li>
- <li>"auto <temperature>". Damit wird das am Thermostat eingestellte Wochenprogramm
- abgearbeitet. Wenn optional die Temperatur <temperature> angegeben wird, wird diese
- bis zum nästen Schaltzeitpunkt des Wochenprogramms als
- <code>desiredTemperature</code> gesetzt.</li>
- <li>"boost" aktiviert den Boost Modus, wobei für <code>boostDuration</code> Minuten
- das Ventil <code>boostValveposition</code> Prozent geöffnet wird.</li>
- </ul>
- Alle Werte außer "auto" können zusäzlich den Wert "until" erhalten,
- wobei <date> in folgendem Format sein muß: "dd.mm.yyyy HH:MM"
- (Minuten nur "30" bzw. "00"!), um kurzzeitige eine andere Temperatur bis zu diesem Datum/dieser
- Zeit einzustellen. Bitte sicherstellen, dass der Cube bzw. das Gerät die korrekte Systemzeit hat.</li>
- <li>groupid <id><br>
- Nur für Heizkörperthermostate.
- Schreibt die angegebene Gruppen ID in den Speicher des Gerätes.
- Um alle Geräte in einem Raum zu synchronisieren, können diese derselben Gruppen ID
- zugeordnet werden, diese muß größer Null sein.</li>
- <li>ecoTemperature <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene <code>eco</code> Temperatur in den Speicher
- des Gerätes. Diese kann durch Drücken der rechten Taste am Gerät aktiviert werden.</li>
- <li>comfortTemperature <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene <code>comfort</code> Temperatur in den Speicher
- des Gerätes. Diese kann durch Drücken der rechten Taste am Gerät aktiviert werden.</li>
- <li>measurementOffset <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene <code>offset</code> Temperatur in den Speicher
- des Gerätes. Wenn der interne Temperatursensor nicht korrekt kalibriert ist, kann dieses einen
- systematischen Fehler erzeugen. Mit dem Wert <code>measurementOffset</code>, kann dieser Fehler
- kompensiert werden. Die ausgelese Temperatur ist gleich der gemessenen
- Temperatur + <code>measurementOffset</code>. Normalerweise ist die intern gemessene Temperatur höher
- als die Raumtemperatur, da der Sensor näher am Heizkörper ist und man verwendet einen
- kleinen negativen Offset, der zwischen -3,5 und 3,5 Kelvin sein muß.</li>
- <li>minimumTemperature <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegemene <code>minimum</code> Temperatur in der Speicher
- des Gerätes. Diese begrenzt die Temperatur, die am Gerät manuell eingestellt werden kann.</li>
- <li>maximumTemperature <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegemene <code>maximum</code> Temperatur in der Speicher
- des Gerätes. Diese begrenzt die Temperatur, die am Gerät manuell eingestellt werden kann.</li>
- <li>windowOpenTemperature <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegemene <code>window open</code> Temperatur in den Speicher
- des Gerätes. Das ist die Tempereratur, die an der Heizung kurzfristig eingestellt wird, wenn ein
- geöffnetes Fenster erkannt wird. Der Wert 4,5 Grad bzw. "off" schaltet die Reaktion auf
- ein offenes Fenster aus.</li>
- <li>windowOpenDuration <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene <code>window</code> open Dauer in den Speicher
- des Gerätes. Dies ist die Dauer, während der die Heizung kurzfristig die window open Temperatur
- einstellt, wenn ein offenes Fenster durch einen schnellen Temperatursturz erkannt wird.
- (Wird nicht verwendet, wenn das offene Fenster von <code>ShutterControl</code> erkannt wird.)
- Parameter muss zwischen Null und 60 Minuten sein als Vielfaches von 5.</li>
- <li>decalcification <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene Zeit für <code>decalcification</code>
- in den Speicher des Gerätes. Parameter muss im Format "Sat 12:00" sein, wobei die Minuten
- "00" sein müssen. Zu dieser angegebenen Zeit wird das Heizkörperthermostat das Ventil
- kurz ganz öffnen, um vor Schwergängigkeit durch Kalk zu schützen.</li>
- <li>boostDuration <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene Boost Dauer in den Speicher
- des Gerätes. Der gewählte Parameter muss einer aus 5, 10, 15, 20, 25, 30 oder 60 sein
- und gibt die Dauer der Boost-Funktion in Minuten an.</li>
- <li>boostValveposition <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene Boost Ventilstellung in den Speicher
- des Gerätes. Dies ist die Ventilstellung (in Prozent) die bei der Boost-Fumktion eingestellt wird.</li>
- <li>maxValveSetting <value><br>
- Nur für Heizkörperthermostate. Schreibt die angegebene maximale Ventilposition in den Speicher
- des Gerätes. Der Heizkörperthermostat wird das Ventil nicht weiter öffnen als diesen Wert
- (Angabe in Prozent).</li>
- <li>valveOffset <value><br>
- Nur für Heizkörperthermostate. Schreibt den angegebenen <code>offset</code> Wert der Ventilstellung
- in den Speicher des Gerätes Der Heizkörperthermostat wird diesen Wert während der Regelung
- zu den berechneten Ventilstellungen hinzuaddieren.</li>
- <li>factoryReset<br>
- Setzt das Gerät auf die Werkseinstellungen zurück. Das Gerät muss anschließend neu
- angelernt werden.<br>
- ACHTUNG: Wenn dies in Kombination mit einem Fensterkontakt und dem MAXLAN Modul
- verwendet wird, muss der Fensterkontakt einmal manuell ausgelöst werden, damit das
- Zurücksetzen auf Werkseinstellungen beendet werden kann.</li>
- <li>associate <value><br>
- Verbindet ein Gerät mit einem anderen. <value> kann entweder der Name eines MAX Gerätes oder
- seine 6-stellige hexadezimale Adresse sein.<br>
- Wenn ein Fensterkontakt mit einem {Heizkörper-/Wand-}Thermostat verbunden wird, sendet der
- Fensterkontakt automatisch die <code>windowOpenTemperature</code> Temperatur wenn der Kontakt
- geöffnet ist. Das Thermostat muss ebenfalls mit dem Fensterkontakt verbunden werden, um diese
- Botschaften zu verarbeiten.
- <b>Achtung: Nach dem Senden der Botschaft zum Verbinden an den Fensterkontakt muss der Knopf am
- Fensterkontakt gedrückt werden um den Fensterkonakt einzuschalten und den Befehl zu verarbeiten.
- Details über das erfolgreiche Verbinden finden sich in der fhem Logdatei!</b>
- Das Verbinden eines Heizkörperthermostates und eines Wandthermostates synchronisiert deren
- <code>desiredTemperature</code> und verwendet die am Wandthermostat gemessene Temperatur für
- die Regelung.</li>
- <li>deassociate <value><br>
- Löst die Verbindung, die mit <code>associate</code> gemacht wurde, wieder auf.</li>
- <li>weekProfile [<day> <temp1>,<until1>,<temp2>,<until2>]
- [<day> <temp1>,<until1>,<temp2>,<until2>] ...<br>
- Erlaubt das Setzen eines Wochenprofils. Nur für Heizk&oum;rperthermostate bzw. Wandthermostate.<br>
- Beispiel:<br>
- <code>set MAX_12345 weekProfile Fri 24.5,6:00,12,15:00,5 Sat 7,4:30,19,12:55,6</code><br>
- stellt das folgende Profil ein<br>
- <code>Freitag: 24.5 °C von 0:00 - 6:00, 12 °C von 6:00 - 15:00, 5 °C von 15:00 - 0:00<br>
- Samstag: 7 °C von 0:00 - 4:30, 19 °C von 4:30 - 12:55, 6 °C von 12:55 - 0:00</code><br>
- und behält die Profile für die anderen Wochentage bei.
- </li>
- </ul>
- <br>
- <a name="MAXget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="MAXattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#IODev">IODev</a></li>
- <li><a href="#loglevel">loglevel</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <li>keepAuto<br>Standardwert: 0. Wenn der Wert auf 1 gesetzt wird, bleibt das Gerät im
- Wochenprogramm auch wenn eine <code>desiredTemperature</code> gesendet wird.</li>
- </ul>
- <br>
- <a name="MAXevents"></a>
- <b>Erzeugte Ereignisse:</b>
- <ul>
- <li>desiredTemperature<br>Nur für Heizkörperthermostate und Wandthermostate</li>
- <li>valveposition<br>Nur für Heizkörperthermostate</li>
- <li>battery</li>
- <li>temperature<br>Die gemessene Temperatur (= gemessene Temperatur + <code>measurementOffset</code>),
- nur für Heizkörperthermostate und Wandthermostate</li>
- </ul>
- </ul>
- <p><a name="MAXLAN"></a>
- <h3>MAXLAN</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MAXLAN'>MAXLAN</a><br/>
- </ul>
- <a name="MEDIAPORTAL"></a>
- <h3>MEDIAPORTAL</h3>
- <div class='langLinks'>[<a href='commandref.html#MEDIAPORTAL'>EN</a> DE]</div>
- <p>Verbindet sich über das Wifiremote-Plugin mit einer laufenden Mediaportal-Instanz.</p>
- <h4>Beispiel</h4>
- <p>
- <code>define wohnzimmer_Mediaportal MEDIAPORTAL 192.168.0.47:8017</code>
- </p>
- <a name="MEDIAPORTALdefine"></a>
- <h4>Define</h4>
- <b><code>define <name> MEDIAPORTAL host[:port]</code></b>
- <br /><br />Definiert ein Mediaportal Interface für die Kommunikation mit einem Wifiremote-Plugin einer Mediaportal Installation.<br />
- <p>
- <b><code>host[:port]</code></b><br />Der Hostname und der Port eines laufenden Mediaportal-Wifiremote-Plugins. Wenn der Port nicht angegeben wurde, wird <code>8017</code> als Standard verwendet.</p>
- <a name="MEDIAPORTALset"></a>
- <h4>Set</h4>
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="MEDIAPORTAL_setter_connect">
- <b><code>connect</code></b></a>
- <br />Erzwingt eine sofortige Verbindung zu Mediaportal. Normalerweise würde die normale Verbindungswiederholung von Fhem (30s) abgewartet werden. </li>
- <li><a name="MEDIAPORTAL_setter_powermode">
- <b><code>powermode <mode></code></b></a>
- <br />Eins aus (logoff, suspend, hibernate, reboot, shutdown, exit). Setzt den powermode, z.B. shutdown, zum Herunterfahren des Computers des Mediaportal-Systems.</li>
- <li><a name="MEDIAPORTAL_setter_reconnect">
- <b><code>reconnect</code></b></a>
- <br />Erzwingt eine sofortige Trennung und Neuverbindung zu Mediaportal.</li>
- </ul></li>
- <li><b>Control-Befehle</b><ul>
- <li><a name="MEDIAPORTAL_setter_command">
- <b><code>command <command></code></b></a>
- <br />Eins aus (stop, record, pause, play, rewind, forward, replay, skip, back, info, menu, up, down, left, right, ok, volup, voldown, volmute, chup, chdown, dvdmenu, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, clear, enter, teletext, red, blue, yellow, green, home, basichome, nowplaying, tvguide, tvrecs, dvd, playlists, first, last, fullscreen, subtitles, audiotrack, screenshot). Sendet das entsprechende Kommando an den Player.</li>
- <li><a name="MEDIAPORTAL_setter_key">
- <b><code>key <keyvalue></code></b></a>
- <br />Sendet die entsprechende Taste an den Player.</li>
- <li><a name="MEDIAPORTAL_setter_sleep">
- <b><code>sleep</code></b></a>
- <br />Startet den Hibernate-Modus. Dieser Befehl ist ein Shortcut für "powermode hibernate"</li>
- <li><a name="MEDIAPORTAL_setter_wakeup">
- <b><code>wakeup</code></b></a>
- <br />Weckt den Mediaportal-Rechner auf (WakeUp-On-LAN).</li>
- </ul></li>
- <li><b>Abspielbefehle</b><ul>
- <li><a name="MEDIAPORTAL_setter_playchannel">
- <b><code>playchannel <channelID></code></b></a>
- <br />Spielt den Kanal mit der entsprechenden ID ab.</li>
- <li><a name="MEDIAPORTAL_setter_playfile">
- <b><code>playfile <fileType> <filePath></code></b></a>
- <br />Spielt die entsprechende Datei mit dem angegebenen Typ ab. FileType kann (audio, video) sein.</li>
- <li><a name="MEDIAPORTAL_setter_playlist">
- <b><code>playlist <command> <param></code></b></a>
- <br />Sendet das entsprechende Playlist-Kommando mit dem gegebenen Parameter. Das Kommando kann (play, loadlist, loadlist_shuffle, loadfrompath, loadfrompath_shuffle) sein.</li>
- <li><a name="MEDIAPORTAL_setter_Volume">
- <b><code>Volume <volumelevel></code></b></a>
- <br />Setzt die angegebene Lautstärke.</li>
- </ul></li>
- </ul>
- <a name="MEDIAPORTALget"></a>
- <h4>Get</h4>
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="MEDIAPORTAL_getter_status">
- <b><code>status</code></b></a>
- <br />Sendet eine Aufforderung für das Senden einer <code>status</code>-Nachricht. Liefert dann asynchron die Informationen "Title" und "PlayStatus".</li>
- <li><a name="MEDIAPORTAL_getter_nowplaying">
- <b><code>nowplaying</code></b></a>
- <br />Sendet eine Aufforderung für das Senden einer <code>nowplaying</code>-Nachricht. Liefert dann asynchron die Informationen "Duration", "Position" und "File"".</li>
- </ul></li>
- </ul>
- <a name="MEDIAPORTALattr"></a>
- <h4>Attribute</h4>
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="MEDIAPORTAL_attribut_disable"><b><code>disable <value></code></b>
- </a><br />Eins aus (0, 1). Mit diesem Attribut kann das Modul deaktiviert werden.</li>
- <li><a name="MEDIAPORTAL_attribut_generateNowPlayingUpdateEvents"><b><code>generateNowPlayingUpdateEvents <value></code></b>
- </a><br />Eins aus (0, 1). Mit diesem Attribut kann die Erzeugung eines <code>NowPlayingUpdate</code>-Events an- oder abgeschaltet werden. Wenn auf "1" gesetzt, generiert Fhem ein Event pro Sekunde mit den angepassten Zeitangaben. Standard ist "0".</li>
- <li><a name="MEDIAPORTAL_attribut_HeartbeatInterval"><b><code>HeartbeatInterval <intervall></code></b>
- </a><br />In Sekunden. Legt das Intervall für die Prüfung der Verbindung zu Mediaportal fest. Mit "0" kann die Prüfung deaktiviert werden. Wenn kein Wert angeggeben wird, wird "15" verwendet.</li>
- <li><a name="MEDIAPORTAL_attribut_macaddress"><b><code>macaddress <address></code></b>
- </a><br />Gibt die Mac-Adresse des Mediaportal-Rechners an. Das wird für die WakeUp-Funktionalität benötigt. z.B. "90:E6:BA:C2:96:15"</li>
- </ul></li>
- <li><b>Authentifizierung</b><ul>
- <li><a name="MEDIAPORTAL_attribut_authmethod"><b><code>authmethod <value></code></b>
- </a><br />Eins aus (none, userpassword, passcode, both). Hiermit wird der Authentifizierungsmodus festgelegt.</li>
- <li><a name="MEDIAPORTAL_attribut_password"><b><code>password <value></code></b>
- </a><br />Hiermit wird das Passwort für die Authentifzierung festgelegt.</li>
- <li><a name="MEDIAPORTAL_attribut_username"><b><code>username <value></code></b>
- </a><br />Hiermit wird der Benutzername für die Authentifizerung festgelegt.</li>
- </ul></li>
- </ul>
- <p><a name="MOBILEALERTS"></a>
- <h3>MOBILEALERTS</h3>
- <div class='langLinks'>[<a href='commandref.html#MOBILEALERTS'>EN</a> DE]</div>
- <ul>
- MOBILEALERTS ist ein FHEM-Modul fü die deutschen MobileAlerts Gerä und TFA WEATHERHUB.
- <br><br>
- Dieses FHEM Modul stellt jeweils ein MobileAlerts Gerät dar. Die Verbindung wird durch das
- <a href="#MOBILEALERTSGW">MOBILELAERTSGW</a> Modul bereitgestellt.<br>
- Aktuell werden unterstüzt: MA10100, MA10101, MA10200, MA10230, MA10300, MA10650, MA10320PRO, MA10350, MA10410, MA10450, MA10660, MA10700, TFA 30.3312.02, MA10800, WL2000<br>
- Unterstüzt aber ungetestet: ./.<br>
- <br>
- <a name="MOBILEALERTSdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> MOBILEALERTS <deviceID></code><br>
- <br>
- deviceID ist der Sensorcode auf dem Sensor.
- </ul>
- <br>
- <a name="MOBILEALERTSreadings"></a>
- <b>Readings</b>
- <ul>
- <li>lastMsg<br>Die letzte empfangene Nachricht (immer für unbekannte Geräte, für bekannte nur wenn das Attribut lastMsg gesetzt ist).</li>
- <li>deviceType<br>Der Gerätetyü.</li>
- <li>lastRcv<br>Timestamp der letzten Nachricht.</li>
- <li>actStatus<br>Zeigt 'unknown', 'alive', 'dead', 'switchedOff' abhängig vom Attribut actCycle</li>
- <li>txCounter<br>Counter des letzten Nachricht (wird 0 nach Batteriewechsel).</li>
- <li>triggered<br>1=letzte Nachricht wurde von einem Ereignis ausgelöst.</li>
- <li>tempertature, prevTemperature, temperatureIn, temperatureOut, prevTemperatureIn, prevTemperatureOut<br>Temperatur (abhänging vom Gerät und dem Attribut expert).</li>
- <li>tempertatureString, prevTemperatureString, temperatureInString, temperatureOutString, prevTemperatureInString, prevTemperatureOutString<br>Temperatur als Zeichkette.</li>
- <li>state<br>State of device (short actual reading)</li>
- <li>humidity, prevHumidity, humidityIn, humidityOut, prevHumidityIn, prevHumidityOut<br>Luftfeuchte (abhänging vom Gerät und dem Attribut expert).</li>
- <li>humidityString, prevHumidityString, humidityInString, humidityOutString, prevHumidityInString, prevHumidityOutString<br>Luftfeuchte als Zeichenkette</li>
- <li>wetness<br>Zeigt ob der Sensors Wasser entdeckt.</li>
- <li>lastEvent, lastEvent<X> ,lastEventString, lastEvent<X>String<br>Zeitpunkt wann das letzte Event (Regen) stattgefunden hat (nur MA10650).</li>
- <li>mmRain, mmRainActHour, mmRainLastHour, mmRainActDay, mmRainYesterday<br>Regen seit dem letzten Reset des Counters, in der aktuellen Stunde, seit der letzten Stunden, am aktuellen Tagn, gestern.</li>
- <li>direction, directionInt<br>Richtung des Winds.</li>
- <li>windSpeed, gustSpeed<br>Windgeschwindigkeit.</li>
- </ul>
- <br>
- <a name="MOBILEALERTSset"></a>
- <b>Set</b>
- <ul>
- <li><code>set <name> clear <readings|counters></code><br>
- Löscht die Readings (alle) oder Counter (wie mmRain). </li>
- </ul>
- <br>
- <a name="MOBILEALERTSget"></a>
- <b>Get</b>
- <ul>
- N/A
- </ul>
- <br>
- <br>
- <a name="MOBILEALERTSattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <li>lastMsg<br>
- Wenn dieser Wert auf 1 gesetzt ist, wird die letzte erhaltene Nachricht als Reading gelogt auch wenn das Gerä bekannt ist.
- </li>
- <li>actCycle <[hhh:mm]|off><br>
- Dieses Attribut ermölicht eine 'nicht erreichbarkeit' Erkennung.
- [hhh:mm] ist die maximale Zeit, innerhalb der keine Nachrichten empfrangen wird.
- Das Reading actStatus zeigt den Status 'unknown', 'alive', 'dead' an.
- </li>
- <li>expert<br>
- Gibt an wie detailiert die Readings angezeigt werden (0=nur aktuelle, 1=mit vorhergehenden, 4=alle).
- </li>
- </ul>
- </ul>
- <p><a name="MOBILEALERTSGW"></a>
- <h3>MOBILEALERTSGW</h3>
- <div class='langLinks'>[<a href='commandref.html#MOBILEALERTSGW'>EN</a> DE]</div>
- <ul>
- MOBILEALERTSGW ist ein FHEM-Modul für das deutsche MobileAlerts Gateway und TFA WEATHERHUB.
- <br><br>
- Dieses FHEM-Modul simuliert einen http-proxy, um Nachrichten vom Gateway abzufangen.
- Um dies zu erreichen, muss das Gateway so konfiguriert werden, dass es den FHEM-Server mit dem definierten Port als
- Proxy nutzt. Sie können dies entweder mit der App oder dem Kommando initgateway erreichen.
- Es erkennt automatisch Geräte. Die Gerä werden durch das <a href="#MOBILEALERTS">MOBILELAERTS</a> Modul
- bereitgestellt. MOBILEALERTS nutzt dieses Modul als Backend.<br>
- <br>
- <a name="MOBILEALERTSGWdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> MOBILEALERTSGW <port></code><br>
- <br>
- port ist der Port auf dem der Proxy-Server hört. Der Port muss frei sein.
- </ul>
- <br>
- <a name="MOBILEALERTSGWreadings"></a>
- <b>Readings</b>
- <ul>
- <li>Gateways<br>Liste der bekannten Gateways</li>
- <li>GW_<Gateway-MAC>_lastSeen<br>Zeitpunkt when zuletzt eine Nachricht empfangen wurde</li>
- <li>GW_<Gateway-MAC>_ip<br>IP-Adresse des Gateways</li>
- <li>GW_<Gateway-MAC>_serial<br>Seriennummer des Gateways</li>
- <li>GW_<Gateway-MAC>_proxy<br>on, off: Einstellung des Proxies (nur verfünach einem get config)</li>
- <li>GW_<Gateway-MAC>_proxyname<br>Name/IP der Proxy (nur verfünach einem get config)</li>
- <li>GW_<Gateway-MAC>_proxyport<br>Port der Proxy (nur verfünach einem get config)</li>
- <li>GW_<Gateway-MAC>_config<br>Komplette Konfiguration als HEX-Wert (nur verfünach einem get config)</li>
- </ul>
- <br>
- <a name="MOBILEALERTSGWset"></a>
- <b>Set</b>
- <ul>
- <li><code>set <name> clear <readings></code><br>
- Löscht die Readings. </li>
- <li><code>set <name> initgateway <gatewayid></code><br>
- Setzt den Proxy im Gateway auf dem FHEM-Server. Es kann ein Neustart (reboot) des Gateways nötig sein, damit die
- Einstellung wirksam wird.</li>
- <li><code>set <name> rebootgateway <gatewayid></code><br>
- Startet das Gateway neu.</li>
- </ul>
- <br>
- <a name="MOBILEALERTSGWget"></a>
- <b>Get</b>
- <ul>
- <li><code>get <name> config <IP or gatewayid> </code><br>
- Holt die Konfiguration eines oder aller Gateways im lokalen Netz. IP bzw. die GatewayId sind optional.
- Wenn keines von beiden angegeben ist, werden alle Gateways im lokalen Netz gesucht (Broadcast).</li>
- </ul>
- <br>
- <br>
- <a name="MOBILEALERTSGWattr"></a>
- <b>Attributes</b>
- <ul>
- <li>forward<br>
- Wenn dieser Wert auf 1 gesetzt ist, werden die Daten zusätzlich zum MobileAlerts Server http://www.data199.com/gateway/put gesendet.
- </li>
- </ul>
- </ul>
- <p><a name="MPD"></a>
- <h3>MPD</h3>
- <div class='langLinks'>[<a href='commandref.html#MPD'>EN</a> DE]</div>
- <ul>
- FHEM Modul zur Steuerung des MPD (oder Mopidy) ähnlich dem MPC (MPC = Music Player Command, das Kommando Zeilen Interface für den
- <a href='http://en.wikipedia.org/wiki/Music_Player_Daemon'>Music Player Daemon</a> ) (englisch)<br>
- Um den MPD auf einem Raspberry Pi zu installieren finden sich im Internet zahlreiche gute Dokumentaionen
- z.B. <a href="http://www.forum-raspberrypi.de/Thread-tutorial-music-player-daemon-mpd-und-mpc-auf-dem-raspberry-pi"><b>hier</b></a><br>
- Thread im FHEM Forum : <a href='http://forum.fhem.de/index.php/topic,18517.0.html'>Modul für MPD</a><br>
- Das Modul benötigt zwingend JSON, installation z.B. mit <i>sudo apt-get install libjson-perl</i><br>
- <a name="MPDdefine"></a>
- <b>Define</b>
- <ul>
- define <name> MPD <IP MPD Server | default localhost> <Port MPD Server | default 6600><br>
- Beispiel :<br>
- <ul><pre>
- define myMPD MPD 192.168.0.99 7000
- </pre>
- wenn FHEM und der MPD auf dem gleichen PC laufen :
- <pre>
- define myMPD MPD
- </pre>
- </ul>
- </ul>
- <br>
- <a name="MPDset"></a>
- <b>Set</b><ul>
- <code>set <name> <was></code>
- <br> <br>
- z.Z. unterstützte Kommandos<br>
- <br>
- play => spielt den aktuellen Titel der MPD internen Playliste<br>
- clear => löscht die MPD interne Playliste<br>
- stop => stoppt die Wiedergabe<br>
- pause => Pause an/aus<br>
- previous => spielt den vorherigen Titel in der Playliste<br>
- next => spielt den nächsten Titel in der Playliste<br>
- random => zufällige Wiedergabe an/aus<br>
- repeat => Wiederholung an/aus<br>
- toggle => wechselt von play nach stop bzw. stop/pause nach play<br>
- volume (%) => ändert die Lautstärke von 0 - 100%<br>
- volumeUp => Lautstärke schrittweise erhöhen , Schrittweite = ( attr volumeStep size )<br>
- volumeDown => Lautstärke schrittweise erniedrigen , Schrittweite = ( attr volumeStep size )<br>
- playlist (name|SongNr|Position) => lade Playliste <name> aus der MPD Datenbank und starte die Wiedergabe<br>
- Werden SongNr und/oder Position nicht mit übergeben, startet die Wiedergabe mit dem ersten Titel (Song=0) am Anfang (Position=0)<br>
- playfile (file) => erzeugt eine MPD interne Playliste mit file als Inhalt und spielt dieses ab<br>
- updateDb => wie MPC update, Update der MPD Datenbank<br>
- reset => reset des FHEM MPD Moduls<br>
- mpdCMD (cmd) => sende cmd direkt zum MPD Server ( siehe auch <a href="http://www.musicpd.org/doc/protocol/">MPD Comm Ref</a> )<br>
- IdleNow => sendet das Kommando idle zum MPD und wartet auf Ereignisse<br>
- clear_readings => löscht sehr viele Readings<br>
- mute => on,off,toggle<br>
- seekcur (zeit) => Format: [[hh:]mm:]ss. nicht vor MPD Version 0.20<br>
- forward => Springt im laufenden Track um einen optional per seekStep oder seekStepSmall definierten Wert nach vorne bzw. defaultmäßig um 7%. <br>
- rewind => Springt so wie bei forward beschrieben entsprechend zurück. <br>
- channel => Wechsele zur Playliste mit der angegebenen Nummer<br>
- channelUp => wechselt zur nächsten Playliste<br>
- channelDown => wechselt zur vorherigen Playliste<br>
- save_bookmark => speichert den aktuellen Zustand (Tracknummer und Position innerhalb des Tracks für die gerade geladene Playliste<br>.
- dies sunktioniert nur, wenn die Playliste mit dem Modul geladen wurde und wenn das Attribut bookmarkDir gesetzt ist.<br>
- load_bookmark <name> => stellt den zuletzt gespeicherten Zustand (set bookmark) der geladenen Playliste wieder her und springt zum gespeicherten Track und Position<br>
- wird <name> zusätzlich mit übergeben wird zuvor die entsprechend Playliste geladen<br>
- </ul>
- <br>
- <a name="MPDget"></a>
- <b>Get</b><ul>
- <code>get <name> <was></code>
- <br> <br>
- z.Z. unterstützte Kommandos<br>
- music => zeigt alle Dateien der MPD Datenbank<br>
- playlists => zeigt alle Playlisten der MPD Datenbank<br>
- playlistsinfo => zeigt Informationen der aktuellen Playliste<br>
- webrc => HTML Ausgabe einer einfachen Web Fernbedienung Bsp :.<br>
- <pre>
- define <name> weblink htmlCode {fhem("get <name> webrc", 1)}
- attr <name> room MPD
- </pre>
- statusRequest => hole aktuellen MPD Status<br>
- currentsong => zeigt Informationen zum aktuellen Titel der MPD internen Playliste<br>
- outputs => zeigt Informationen der definierten MPD Ausgabe Kanäle ( aus /etc/mpd.conf )<br>
- bookmarks => zeigt eine Liste aller bisher gespeicherten Bookmarks<br>
- </ul>
- <br>
- <a name="MPDattr"></a>
- <b>Attribute</b>
- <ul>
- <li>password <pwd> => Password falls in der mpd.conf definiert</li>
- <li>loadMusic 1|0 => lade die MPD Titel beim FHEM Start : mpd.conf - music_directory</li>
- <li>loadPlaylists 1|0 => lade die MPD Playlisten beim FHEM Start : mpd.conf - playlist_directory</li>
- <li>volumeStep x => Schrittweite für Volume +/-</li>
- <li>titleSplit 1|0 => zerlegt die aktuelle Titelangabe am ersten Vorkommen von - (BlankMinusBlank) in die zwei Felder Artist und Titel,<br>
- wenn im abgespielten Titel die Interpreten Information nicht verfügbar ist (sehr oft bei Radio-Streams default 1)<br>
- Liegen keine Titelangaben vor wird die Ausgabe durch den Namen der Radiostation ersetzt</li>
- <li>timeout (default 1) => Timeoutwert in Sekunden für die Verbindung fhem-mpd</li>
- <li>waits (default 60) => Überwachungszeit in Sekunden für den Idle Prozess. In Verbindung mit refresh_song der Aktualisierungs Intervall für die aktuellen Songparamter,<br>
- (z.B. um den Fortschrittsbalken bei TabletUI aktuell zu halten) </li>
- <li>stateMusic 1|0 => zeige Musikliste als DropDown im Webfrontend</li>
- <li>statePlaylists 1|0 => zeige Playlisten als DropDown im Webfrontend</li>
- <li>player mpd|mopidy|forked-daapd (default mpd) => welcher Player wird gesteuert<br>
- <b>ACHTUNG</b> : Mopidy unterstützt nicht alle Kommandos des echten MPD ! (siehe <a href="https://docs.mopidy.com/en/latest/ext/mpd/">Mopidy Dokumentation</a>)</li>
- <li>Cover Art Funktionen von <a href="http://www.last.fm/"><b>last.fm</b></a> :</li>
- <li>image_size -1|0|1|2|3 (default -1 = keine Interpretenbilder und Infos von last.fm verwenden)<br>
- last.fm stellt verschiedene Bildgroessen zur Verfügung :<br>
- 0 = 32x32 , 1 = 64x64 , 2 = 174x174 , 3 = 300x300</li>
- <li>artist_content 0|1 => stellt Interpreteninformation im Reading artist_content zur Verfügung</li>
- <li>artist_summary 0|1 => stellt weitere Interpreteninformation im Reading artist_summary zur Verfügung<br>
- Beispiel Anzeige mittels readingsGroup :<br>
- <pre>
- define rg_artist readingsGroup <MPD name>:artist,artist_image_html,artist_summary
- attr rg_artist room MPD
- </pre></li>
- <li>cache (default lfm => /fhem/www/lfm) Zwischenspeicher für die JSON und PNG Dateien<br>
- <b>Wichtig</b> : Der User unter dem der fhem Prozess ausgeführt wird (default fhem) muss Lese und Schreibrechte in diesem Verzeichniss haben !<br>
- Das Verzeichnis sollte auch unterhalb von www liegen, damit der fhem Webserver direkten Zugriff auf die Bilder hat.</li>
- <li>unknown_artist_image => Ersatzimage wenn kein anderes Image zur Verfügung steht (default : /fhem/icons/1px-spacer)</li>
- <li>bookmarkDir => ein vom FHEM User les- und beschreibbares Verzeichnis. Wennn dieses definiert wird, ist das Speichern und Wiederherstellen von Playlistzuständen mit Hilfe von set/get bookmark möglich</li>
- <li>autoBookmark => wenn dies auf 1 gesetzt wird, dann werden automatisch Playlistenzustände geladen und gespeichert, immer wenn die Playliste mit diesem Modul gewechselt wird</li>
- <li>seekStep => wenn definiert, wird dadurch die Sprungweite von forward und rewind gesetzt. Der Wert gilt als Prozentwert. default: 7</li>
- <li>seekStepSmall => Wenn diesem Attribut kann für den Anfang eines Tracks innerhalb der ersten per seekStepSmall definierten Prozent eine kleinere Sprungweite definiert werden,<br>
- um so z.B. die Intromusik von Hörspielen oder Hörbüchern überspringen zu können. default: 1</li>
- <li>seekStepSmallThreshold => unterhalb dieses Wertes wird seekStepSmall benutzt, oberhalb seekStep default: 0 (ohne Funktion)</li>
- <li>no_playlistcollection (default 0) => wenn auf 1 gesetzt wird das Reading playlistcollection nicht erzeugt</li>
- </ul>
- <br>
- <b>Readings</b>
- <ul>
- - alle MPD internen Werte<br>
- - vom Modul direkt erzeugte Readings :<br>
- playlistinfo : (TabletUI Medialist)<br>
- playlistcollection : (TabletUI)<br>
- playlistname : (TabletUI)<br>
- artist_image : (bei Nutzung von Last.fm)<br>
- artist_image_html : (bei Nutzung von Last.fm)<br>
- album_image : (bei Nutzung von Last.fm)<br>
- album_image_html : (bei Nutzung von Last.fm)<br>
- artist_content : (bei Nutzung von Last.fm)<br>
- artist_summary : (bei Nutzung von Last.fm)<br>
- playlistinfo : (z.B. für die TabletUI Medialist)<br>
- playlistcollection : (TabletUI) Liste der Playlisten<br>
- playlistname : (TabletUI) Name der aktuellen Playliste aus playlistcollection<br>
- playlist_num : Playlisten Nr. (0 .. n) der aktuellen Playliste aus playlistcollection
- playlist_json : (notwendig fü das Medialist Modul)<br>
- Cover : Cover Bild zum aktuellen Song aus playlist_json<br>
- currentTrackProvider : Radio / Bibliothek - Unterscheidung Radio Stream oder lokale Datei<br>
- rawTitle : Title Information ohne Veränderungen durch das Modul
- </ul>
- </ul>
- <p><a name="MQTT"></a>
- <h3>MQTT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MQTT'>MQTT</a><br/>
- </ul>
- <a name="MQTT_BRIDGE"></a>
- <h3>MQTT_BRIDGE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MQTT_BRIDGE'>MQTT_BRIDGE</a><br/>
- </ul>
- <a name="MQTT_DEVICE"></a>
- <h3>MQTT_DEVICE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MQTT_DEVICE'>MQTT_DEVICE</a><br/>
- </ul>
- <a name="MSG"></a>
- <h3>msg</h3>
- <div class='langLinks'>[<a href='commandref.html#MSG'>EN</a> DE]</div>
- <ul>
- <code>msg [<type>] [<@device>|<e-mail address>] [<priority>] [|<title>|] <message></code>
- <br>
- <br>
- Bisher keine Dokumentation hier, sorry.<br>
- <a href="http://forum.fhem.de/index.php/topic,39983.0.html">FHEM Forum</a>
- </ul>
- <p><a name="MSGFile"></a>
- <h3>MSGFile</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MSGFile'>MSGFile</a><br/>
- </ul>
- <a name="MSGMail"></a>
- <h3>MSGMail</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MSGMail'>MSGMail</a><br/>
- </ul>
- <a name="MYSENSORS"></a>
- <h3>MYSENSORS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MYSENSORS'>MYSENSORS</a><br/>
- </ul>
- <a name="MYSENSORS_DEVICE"></a>
- <h3>MYSENSORS_DEVICE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MYSENSORS_DEVICE'>MYSENSORS_DEVICE</a><br/>
- </ul>
- <a name="MaxScanner"></a>
- <h3>MaxScanner</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MaxScanner'>MaxScanner</a><br/>
- </ul>
- <a name="MediaList"></a>
- <h3>MediaList</h3>
- <div class='langLinks'>[<a href='commandref.html#MediaList'>EN</a> DE]</div>
- <br>
- Eine deutsche Beschreibung ist aktuell nur im WIKI verfügbar.<br>
- <a href="https://wiki.fhem.de/wiki/MediaList">Wiki MediaList</a>
- <p><a name="MilightBridge"></a>
- <h3>MilightBridge</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MilightBridge'>MilightBridge</a><br/>
- </ul>
- <a name="MilightDevice"></a>
- <h3>MilightDevice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#MilightDevice'>MilightDevice</a><br/>
- </ul>
- <a name="Modbus"></a>
- <h3>Modbus</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Modbus'>Modbus</a><br/>
- </ul>
- <a name="ModbusAttr"></a>
- <h3>ModbusAttr</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ModbusAttr'>ModbusAttr</a><br/>
- </ul>
- <a name="ModbusSET"></a>
- <h3>ModbusSET</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ModbusSET'>ModbusSET</a><br/>
- </ul>
- <a name="ModbusTrovis5576"></a>
- <h3>ModbusTrovis5576</h3>
- <div class='langLinks'>[<a href='commandref.html#ModbusTrovis5576'>EN</a> DE]</div>
- <ul>
- ModbusTrovis5576 verwendet das Modul Modbus für die Kommunikation mit der Samson Trovis 5576 Heizungssteuerung.
- Hier wurden die wichtigsten (der über 2000 verfügbaren) Werte aus den Holding-Registern und Coils-Statuswerten definiert und werden im angegebenen Intervall abgefragt und aktualisiert.
- <br /><br />
- <b>Vorraussetzungen</b>
- <ul>
- Dieses Modul benötigt das Basismodul <a href="#Modbus">Modbus</a> für die Kommunikation, welches wiederum das Perl-Modul Device::SerialPort oder Win32::SerialPort benötigt.
- </ul><br />
-
- <b>Physikalische Verbindung zur Heizungssteuerung</b>
- <ul>
- Im <a href="https://www.samson.de/pdf_de/e55760de.pdf">Handbuch</a> auf Seite 124 steht die Pinbelegung der RS232-Schnittstelle. Diese befindet sich <b>nicht</b> vorne am Reglermodul, sondern, von vorne gesehen, an der linken Seite des Reglers. Diese Schnittstelle ist mit einem Schutzdeckel verschlossen, den man einfach abziehen kann.<br />
- Man benötigt nur die üblichen Pins für TD und RD, sowie Ground.
- </ul><br />
-
- <b>Besonderheiten der Readings und des Reglers</b>
- <ul>
- Man kann mit diesem Modul z.B. die Betriebsart der jeweiligen Regelkreise umschalten. Da der Drehschalter am Regler selbst natürlich immer noch auf der alten Stellung steht, wird diese "Umgehung" durch die Anzeige "GLT" (steht für "Gebäudeleittechnik", also für die zentrale Steuerungsübernahme) im Display deutlich gemacht. Gleichzeitig dazu wird das entsprechende Ebenen-Bit ("_EBN") auf "GLT" gesetzt.<br />
- Um jetzt wieder auf die hardwaremäßig gesetzte Einstellung zurückzuschalten, muss das entsprechende Ebenen-Bit auf "Autark" gesetzt werden. Das dazugehörende Reading wird im Anschluß auf den nun im Regler gültigen Wert gesetzt.<br /><br />
-
- Wenn man eine Betriebsart auf "Standby" umschaltet, kann es sein, dass die Heizungsanlage diese auf "Mond" (zurück-)umstellt. Das wird dann mit dem Bit für Frostschutzbetrieb angezeigt, und erfolgt, wenn die gemessene Aussentemperatur unter 3°C liegt.<br /><br />
- <b>Hinweis:</b><br />
- Es ist sehr empfehlenswert das Attribut <code>event-on-change-reading</code> auf <code>.*</code> zu setzen. Sonst werden sehr viele unnötige Events erzeugt.
- </ul><br />
- <a name="ModbusTrovis5576Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> ModbusTrovis5576 <ID> <Interval></code><br /><br />
- Das Modul verbindet sich zur Samson Trovis 5576 Heizungssteuerung mit der angegebenen Modbus Id <ID> über ein bereits fertig definiertes Modbus-Device und fragt die gewünschten Werte im Abstand von <Interval> Sekunden ab.<br /><br />
- Beispiel:<br>
- <code>define heizung ModbusTrovis5576 255 60</code>
- </ul><br />
- <a name="ModbusTrovis5576Set"></a>
- <b>Set-Kommandos</b>
- <ul>
- Die folgenden Werte können gesetzt werden:
- <ul>
- <li>Regelkreis 1 (Normalerweise Wandheizkörper):<ul>
- <li><b>RK1_Betriebsart</b>: Die Betriebsart des Regelkreis 1. Kann Standby, Mond oder Sonne sein, und entspricht der Einstellung am Regler selbst (siehe auch Reading RK1_Schalter).</li>
- <li><b>RK1_Betriebsart_EBN</b>: Das Ebenen-Bit zur Betriebsart. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- <li><b>RK1_Stellsignal</b>: Der Öffnungsgrad in Prozent des Stellglieds zur Wärmeübertragung.</li>
- <li><b>RK1_Stellsignal_EBN</b>: Das Ebenen-Bit zum Stellsignal. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- <li><b>RK1_Umwaelzpumpe</b>: Der Zustand der Umwälzpumpe, Kann An oder Aus sein.</li>
- <li><b>RK1_Umwaelzpumpe_EBN</b>: Das Ebenen-Bit zur Umwälzpumpe. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- </ul></li>
-
- <li>Regelkreis 2 (Normalerweise Fußbodenheizung):<ul>
- <li><b>RK2_Betriebsart</b>: Die Betriebsart des Regelkreis 2. Kann Standby, Mond oder Sonne sein, und entspricht der Einstellung am Regler selbst (siehe auch Reading RK2_Schalter).</li>
- <li><b>RK2_Betriebsart_EBN</b>: Das Ebenen-Bit zur Betriebsart. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- <li><b>RK2_Stellsignal</b>: Der Öffnungsgrad in Prozent des Stellglieds zur Wärmeübertragung.</li>
- <li><b>RK2_Stellsignal_EBN</b>: Das Ebenen-Bit zum Stellsignal. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- <li><b>RK2_Umwaelzpumpe</b>: Der Zustand der Umwälzpumpe, Kann An oder Aus sein.</li>
- <li><b>RK2_Umwaelzpumpe_EBN</b>: Das Ebenen-Bit zur Umwälzpumpe. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- </ul></li>
-
- <li>Trinkwasserspeicher:<ul>
- <li><b>Wasser_Betriebsart</b>: Die Betriebsart des Trinkwasserkreises. Kann Standby, Mond oder Sonne sein, und entspricht der Einstellung am Regler selbst (siehe auch Reading Wasser_Schalter).</li>
- <li><b>Wasser_Betriebsart_EBN</b>: Das Ebenen-Bit zur Betriebsart. Kann GLT oder Autark sein, und gibt an, ob die Heizungssteuerung Autark läuft, oder übersteuert wurde.</li>
- <li><b>Wasser_Speicherladepumpe</b>: Der Zustand der Speicherladepumpe. Kann An oder Aus sein.</li>
- <li><b>Wasser_Speicherladepumpe_EBN</b>: Das Ebenen-Bit zur Speicherladepumpe. Kann GLT oder Autark sein, und gibt an, ob die Pumpe Autark läuft, oder übersteuert wurde.</li>
- <li><b>Wasser_Zirkulationspumpe</b>: Der Zustand der Zirkulationspumpe. Kann An oder Aus sein.</li>
- <li><b>Wasser_Zirkulationspumpe_EBN</b>: Das Ebenen-Bit zur Zirkulationspumpe. Kann GLT oder Autark sein, und gibt an, ob die Pumpe Autark läuft, oder übersteuert wurde.</li>
- <li><b>Wasser_ThermischeDesinfektion</b>: Gibt an, ob gerade eine thermische Desinfektion läuft (=An) oder nicht (=Aus). </li>
- <li><b>Wasser_Temp_Soll</b>: Die Solltemperatur des Trinkwasserspeichers.</li>
- <li><b>Wasser_Temp_Minimum</b>: Die Minimaltemperatur des Trinkwasserspeichers.</li>
- <li><b>Wasser_Temp_Desinfektion</b>: Die Solltemperatur der thermischen Desinfektion.</li>
- </ul></li>
- </ul><br />
- Hier der Vollständigkeit halber die Bedeutung der restlichen Readings (die nur gelesen werden können):<br />
- <ul>
- <li>Grundsätzliches:<ul>
- <li><b>Modellnummer</b>: Gibt die gemeldete Modellnummer an. Sollte "5576" sein.</li>
- <li><b>Aussen_Temp</b>: Gibt die gemessene Aussentemperatur in °C an.</li>
- <li><b>Fehlerstatusregister_CL1</b>: Gibt den Zustand des aktuellen Status Register zurück.</li>
- </ul></li>
-
- <li>Regelkreis 1 (Normalerweise Wandheizkörper):<ul>
- <li><b>RK1_Schalter</b>: Gibt die Schalterstellung am Regler an. Kann PA, Auto, Standby, Hand, Sonne oder Mond sein.</li>
- <li><b>RK1_Frostschutzbetrieb</b>: Gibt an, ob der Heizungsregelkreis 1 im Frostschutzbetrieb läuft.</li>
- <li><b>RK1_Vorlauf_Temp</b>: Gibt die Heizungsvorlauftemperatur in °C an.</li>
- <li><b>RK1_Ruecklauf_Temp</b>: Gibt die Heizungsrücklauftemperatur in °C an.</li>
- </ul></li>
-
- <li>Regelkreis 2 (Normalerweise Fußbodenheizung):<ul>
- <li><b>RK2_Schalter</b>: Gibt die Schalterstellung am Regler an. Kann PA, Auto, Standby, Hand, Sonne oder Mond sein.</li>
- <li><b>RK2_Frostschutzbetrieb</b>: Gibt an, ob der Heizungsregelkreis 2 im Frostschutzbetrieb läuft.</li>
- <li><b>RK2_Vorlauf_Temp</b>: Gibt die Heizungsvorlauftemperatur in °C an.</li>
- <li><b>RK2_Ruecklauf_Temp</b>: Gibt die Heizungsrücklauftemperatur in °C an.</li>
- </ul></li>
-
- <li>Trinkwasserspeicher:<ul>
- <li><b>Wasser_Schalter</b>: Gibt die Schalterstellung am Regler an. Kann PA, Auto, Standby, Hand, Sonne oder Mond sein.</li>
- <li><b>Wasser_Frostschutzbetrieb</b>: Gibt an, ob der Trinkwasserregelkreis im Frostschutzbetrieb läuft.</li>
- <li><b>Wasser_Temp</b>: Gibt die Trinkwasserspeichertemperatur in °C an.</li>
- </ul></li>
- </ul>
- </ul><br />
-
- <a name="ModbusTrovis5576Get"></a>
- <b>Get-Kommandos</b>
- <ul>
- Alle Readings sind auch als get-Kommando verfügbar. Intern führt ein get einen Request an die Heizungssteuerung aus, und aktualisiert den entsprechenden Readings-Wert (und gibt ihn als Ergebnis des Aufrufs zurück). Damit kann man eine zusätzliche Aktualisierung des Wertes erzwingen.
- </ul><br />
-
- <a name="ModbusTrovis5576attr"></a>
- <b>Attribute</b>
- <ul>
- Nur zentral definierte Attribute werden untstützt. Im speziellen:
- <ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- </ul><br />
- </ul>
- <p><a name="N4HBUS"></a>
- <h3>N4HBUS</h3>
- <div class='langLinks'>[<a href='commandref.html#N4HBUS'>EN</a> DE]</div>
- Dieses Modul verbindet fhem über IP mit dem net4home Bus. Zusätzlich müssen Objekte über den Typ
- <a href="#N4MODULE">N4MODULE</a> definiert werden, um Daten an den net4home-Bus zu senden oder zu lesen.
- <br /><br />
- Weitere technische Informationen gibt es auf der Homepage unter <a href="http://www.net4home.de">net4home.de</a>
- <br /><br />
- <a name="N4HBUS_Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> N4HBUS <device></code>
- <br /> <br />
- <device> ist eine Kombination aus IP Adresse des net4home Busconnectors und dem Port (default:3478).
- <br /> <br />
- Beispiel:
- <ul>
- <code>define net4home N4HBUS 192.168.1.69:3478</code>
- </ul>
- <br />
- Das Device kann sich auch mit dem Busconnector auf dem selben System verbinden.
- Der Default-Port für die Kommunikation ist 3478. Sollte es nötig sein den Port zu verändern, so muss dies ebenfalls
- in der Konfiguration des Services durchgeführt werden.<br />
- </ul>
- <br />
- <a name="N4HBUS_Readings"></a>
- <b>Readings</b>
- <ul>
- <li>state - aktueller Status der Verbindung zum net4home Busconnector</li>
- </ul><br />
- <a name="N4HBUS_Attr"></a>
- <b>Attributes</b>
- <ul>
- <li>MI - die eindeutige MI in der net4home Umgebung (default:65281)</li>
- <li>OBJADR - die eindeutige OBJADR in der net4home Umgebung (default:32700)</li>
- </ul>
- <p><a name="N4HMODULE"></a>
- <h3>N4HMODULE</h3>
- <div class='langLinks'>[<a href='commandref.html#N4HMODULE'>EN</a> DE]</div>
- fhem-Modul zur Kommunikation mit dem net4home Bus über IP
- <br /><br />
- <ul>
- <br />
- <a name="N4HMODULE_Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> N4HMODULE <device> <type> <objectaddress></code><br />
- <br />
- Erstellt ein net4home Modul-Device welches mit dem <a href="#N4HBUS">N4HBUS</a> Device kommuniziert.
- Beispiel:
- <ul>
- <code>define MyN4HMODULEice N4HMODULE 24 26004</code><br />
- </ul>
-
- Derzeit werden folgende Typen unterstützt:<br />
- <b>Messwerte</b><br />
- <ul>
- <li> 24 - Messwert,Temperatur</li>
- <li> 25 - Messwert,Helligkeit</li>
- <li> 26 - Messwert,Feuchte</li>
- <li> 34 - TLH-Regler H,Sollwert,Temperatur</li>
- <li> 95 - Ausgang, Jal, Motor AJ3</li>
- <li>210 - RF Reader</li>
- <li>240 - Messwert,Wind</li>
- <li>242 - Messwert,Luftdruck</li>
- <li>245 - Messwert,Regenmenge</li>
- </ul>
- </ul><br />
- <a name="N4HMODULE_Readings"></a>
- <b>Readings</b>
- <ul>
- <li>Die Readings werden Abhängig vom Modultyp angegeben.<br /></li>
- </ul><br />
- <a name="N4HMODULE_Attr"></a>
- <b>Attributes</b>
- <ul>
- <li>Interval<br>
- Das Interval bestimmt bei Messwerten die Zeit zwischen dem Senden der Daten auf den Bus. Ist kein Attribut definiert, so wird der Standardwert genutzt.</li>
- </ul>
- </ul>
- <p> <p>
- <a name="NEUTRINO" id="NEUTRINO"></a>
- </p>
- <h3>
- NEUTRINO
- </h3>
- <div class='langLinks'>[<a href='commandref.html#NEUTRINO'>EN</a> DE]</div>
- <ul>
- <a name="NEUTRINOdefine" id="NEUTRINOdefine"></a> <b>Define</b>
- <ul>
- <code>define <name> NEUTRINO <ip-address-or-hostname> [[[[<port>] [<poll-interval>]] [<http-user>]] [<http-password>]]</code><br>
- <br>
- Dieses Modul steuert NEUTRINO basierte Geräte wie die Coolstream über eine Netzwerkverbindung.<br>
- <br>
- Für definierte NEUTRINO Geräte wird ein interner Task angelegt, welcher periodisch die Readings aktualisiert. Der Standartpollintervall ist 45 Sekunden.<br>
- <br>
- Beispiele:<br>
- <ul>
- <code>define SATReceiver NEUTRINO 192.168.0.10<br>
- <br>
- # Alternativer Port<br>
- define SATReceiver NEUTRINO 192.168.0.10 8080<br>
- <br>
- # Alternativer poll intervall von 20 seconds<br>
- define SATReceiver NEUTRINO 192.168.0.10 80 20<br>
- <br>
- # Mit HTTP Benutzer Zugangsdaten<br>
- define SATReceiver NEUTRINO 192.168.0.10 80 20 root secret</code>
- </ul>
- </ul><br>
- <br>
- <a name="NEUTRINOset" id="NEUTRINOset"></a> <b>Set</b>
- <ul>
- <code>set <name> <command> [<parameter>]</code><br>
- <br>
- Aktuell gibt es folgende Befehle.<br>
- <ul>
- <li>
- <b>on</b> - Schaltet das Gerät aus dem Standby wieder an
- </li>
- <li>
- <b>off</b> - Schaltet das Gerät in den Standby
- </li>
- <li>
- <b>toggle</b> - Ein- und Ausschalten zwischen Standby
- </li>
- <li>
- <b>shutdown</b> - Schaltet das Gerät aus
- </li>
- <li>
- <b>reboot</b> - Neustart des Gerätes
- </li>
- <li>
- <b>channel</b> - Schaltet auf den angegebenen Kanal
- </li>
- <li>
- <b>volume</b> 0...100 - Ändert die Lautstärke in Prozent
- </li>
- <li>
- <b>mute</b> on,off,toggle - Steuert Lautstärke "stumm"
- </li>
- <li>
- <b>statusRequest</b> - Fordert den aktuellen Status des Gerätes an
- </li>
- <li>
- <b>remoteControl</b> UP,DOWN,... - Sendet Fernsteuerungsbefehle<br />
- </li>
- <li>
- <b>showText</b> text - Sendet eine Textnachricht
- </li>
- <li>
- <b>showtextwithbutton</b> - Sendet eine Textnachricht mit OK Button
- </li>
- <br>
- </ul>
- </ul>
- <br>
- <br>
- <a name="NEUTRINOget" id="NEUTRINOget"></a> <b>Get</b>
- <ul>
- <code>get <name> <what></code><br>
- <br>
- Aktuell gibt es folgende Befehle.<br>
- <br>
- <ul>
- <code>channel<br>
- channelurl<br>
- currentTitle<br>
- input<br>
- mute<br>
- power<br>
- volume<br></code>
- </ul>
- </ul><br>
- <br>
- <a name="NEUTRINOattr" id="NEUTRINOattr"></a> <b>Attributes</b><br>
- <ul>
- <ul>
- <li>
- <b>disable</b> - Schaltet das Polling aus (true/false)
- </li>
- <li>
- <b>http-noshutdown</b> - Setzt FHEM-internal HttpUtils Verbindung offen halten (defaults=0)
- </li>
- <li>
- <b>https</b> - Zugriff über HTTPS aktivieren (true/false)
- </li>
- <li>
- <b>timeout</b> - Setzen des Timeout der HTTP Verbindung (default=2)
- </li>
- </ul>
- </ul><br>
- <br>
- <br>
- <b>Generelle Readings:</b><br>
- <ul>
- <ul>
- <li>
- <b>ber</b> - Zeigt die Bit Error Rate vom aktuellen Kanal
- </li>
- <li>
- <b>bouquetnr</b> - Zeigt die aktuelle Bouquet Nummer vom aktuellen Kanal
- </li>
- <li>
- <b>channel</b> - Zeigt den aktuellen Servicenamen vom aktuellen Kanal
- </li>
- <li>
- <b>channel_id</b> - Zeigt die aktuelle Kanal ID vom aktuellen Kanal
- </li>
- <li>
- <b>channel_name</b> - Zeigt den aktuellen Kanal Namen
- </li>
- <li>
- <b>channel_url</b> - Zeigt die aktuelle Kanal URL, welche im Vlc Player zum Streamen verwendet werden kann
- </li>
- <li>
- <b>currentTitle</b> - Zeigt den aktuellen Titel der aktuellen Sendung an
- </li>
- <li>
- <b>epg_current_channel_id</b> - Zeigt die Kanal ID von aktuellen EPG an
- </li>
- <li>
- <b>epg_current_date</b> - Zeigt das Datum des aktuellen EPGs an
- </li>
- <li>
- <b>egp_current_description</b> - Zeigt die aktuelle Beschreibung der aktuellen Sendung an
- </li>
- <li>
- <b>egp_current_duration_min</b> - Zeigt die Dauer der aktuellen Sendung an
- </li>
- <li>
- <b>egp_current_info1</b> - Zeigt die Information Teil 1 der aktuellen Sendung an
- </li>
- <li>
- <b>egp_current_info2</b> - Zeigt die Information Teil 2 der aktuellen Sendung an
- </li>
- <li>
- <b>egp_current_number</b> - Zeigt die EPG Nummer der aktuellen Sendung an
- </li>
- <li>
- <b>egp_current_start_sec</b> - Zeigt die Startzeit der aktuellen Sendung an (ticks)
- </li>
- <li>
- <b>egp_current_start_t</b> - Zeigt die Startzeit der aktuellen Sendung an
- </li>
- <li>
- <b>egp_current_stop_sec</b> - Zeigt die Stopzeit der aktuellen Sendung an (ticks)
- </li>
- <li>
- <b>egp_current_stop_t</b> - Zeigt die Stopzeit der aktuellen Sendung an
- </li>
- <li>
- <b>eventid</b> - Zeigt die aktuelle Event ID von der aktuellen Sendung an
- </li>
- <li>
- <b>image_*</b> - Zeigt Image Informationen von NEUTRINO
- </li>
- <li>
- <b>input</b> - Zeigt den aktuellen Input an (TV/Radio)
- </li>
- <li>
- <b>mute</b> - Zeigt aktuellen Mute Status ("on" oder "off")
- </li>
- <li>
- <b>power</b> - Zeigt aktuellen Power Status ("on" oder "off")
- </li>
- <li>
- <b>presence</b> - Zeigt den aktuellen presence Status an ("absent" oder "present").
- </li>
- <li>
- <b>recordmode</b> - Zeigt an ob die Box gerade eine Aufnahme macht ("on" oder "off")
- </li>
- <li>
- <b>recordmodetitle</b> - Zeigt den letzten Aufnahme Titel an
- </li>
- <li>
- <b>sig</b> - Zeigt Signalstärke vom aktuellen Sender an
- </li>
- <li>
- <b>snr</b> - Zeigt Singal Noise vom aktuellen Sender an
- </li>
- <li>
- <b>state</b> - Zeigt den aktuellen Status an ("on", "off" oder "standby")
- </li>
- <li>
- <b>time_now</b> - Aktuelle Uhrzeit
- </li>
- <li>
- <b>time_raw_now</b> - Aktuelle Uhrzeit (ticks)
- </li>
- <li>
- <b>timerX</b> - Zeigt den kompletten Timer an (Report from NEUTRINO)
- </li>
- <li>
- <b>timerXannounceTime</b> - Zeigt die Ankündigungszeit des Timers an
- </li>
- <li>
- <b>timerXname</b> - Zeigt den Aufnahmekanal des Timers an
- </li>
- <li>
- <b>timerXnumber</b> - Zeigt die Timernummer an
- </li>
- <li>
- <b>timerXrepcount</b> - Zeigt den Rep. Counter des Timers an
- </li>
- <li>
- <b>timerXrepeat</b> - Zeigt die Wiederholungszeit an
- </li>
- <li>
- <b>timerXstartTime</b> - Zeigt die Startzeit des Timers an
- </li>
- <li>
- <b>timerXstopTime</b> - Zeigt die Stopzeit des Timers an
- </li>
- <li>
- <b>timerXtyp</b> - Zeigt den Typ des Timers an
- </li>
- <li>
- <b>timer_count</b> - Zeigt die Anzahl der aktuellen Timer an
- </li>
- <li>
- <b>timer_count</b> - Zeitg die max. Anzahl der Timer an (wird intern verwendet)
- </li>
- <li>
- <b>volume</b> - Zeit die aktuelle Lautstärke an (zwischen 0 und 100 %)
- </li>
- </ul>
- </ul>
- </ul>
- <p><a name="NUKIBridge"></a>
- <h3>NUKIBridge</h3>
- <div class='langLinks'>[<a href='commandref.html#NUKIBridge'>EN</a> DE]</div>
- <ul>
- <u><b>NUKIBridge - Steuert das Nuki Smartlock über die Nuki Bridge</b></u>
- <br>
- Das Nuki Bridge Modul verbindet FHEM mit der Nuki Bridge und liest dann alle auf der Bridge verfügbaren Smartlocks ein. Desweiteren werden automatisch die erkannten Smartlocks als eigenständige Devices an gelegt.
- <br><br>
- <a name="NUKIBridgedefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> NUKIBridge <HOST> <API-TOKEN></code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define NBridge1 NUKIBridge 192.168.0.23 F34HK6</code><br>
- </ul>
- <br>
- Diese Anweisung erstellt ein NUKIBridge Device mit Namen NBridge1 und der IP 192.168.0.23 sowie dem Token F34HK6.<br>
- Nach dem anlegen des Bridge Devices werden alle zur verfügung stehende Smartlock automatisch in FHEM an gelegt.
- </ul>
- <br><br>
- <a name="NUKIBridgereadings"></a>
- <b>Readings</b>
- <ul>
- <li>0_nukiId - ID des ersten gefundenen Nuki Smartlocks</li>
- <li>0_name - Name des ersten gefunden Nuki Smartlocks</li>
- <li>smartlockCount - Anzahl aller gefundenen Smartlock</li>
- <li>bridgeAPI - API Version der Bridge</li>
- <li>bridgeType - Hardware oder Software/App Bridge</li>
- <li>currentTime - aktuelle Zeit auf der Bridge zum zeitpunkt des Info holens</li>
- <li>firmwareVersion - aktuell auf der Bridge verwendete Firmwareversion</li>
- <li>hardwareId - ID der Hardware Bridge</li>
- <li>lastError - gibt die letzte HTTP Errormeldung wieder</li>
- <li>serverConnected - true/false gibt an ob die Hardwarebridge Verbindung zur Nuki-Cloude hat.</li>
- <li>serverId - gibt die ID des Cloudeservers wieder</li>
- <li>uptime - Uptime der Bridge in Sekunden</li>
- <li>wifiFirmwareVersion- Firmwareversion des Wifi Modules der Bridge</li>
- <br>
- Die vorangestellte Zahl ist forlaufend und gibt beginnend bei 0 die Eigenschaften <b>Eines</b> Smartlocks wieder.
- </ul>
- <br><br>
- <a name="NUKIBridgeset"></a>
- <b>Set</b>
- <ul>
- <li>autocreate - Veranlasst ein erneutes Einlesen aller Smartlocks von der Bridge und falls noch nicht in FHEM vorhanden das autimatische anlegen.</li>
- <li>callbackRemove - Löschen einer Callback Instanz auf der Bridge. Die Instanz ID kann mittels get callbackList ermittelt werden</li>
- <li>clearLog - löscht das Logfile auf der Bridge</li>
- <li>fwUpdate - schaut nach einer neueren Firmware und installiert diese sofern vorhanden</li>
- <li>info - holt aktuellen Informationen über die Bridge</li>
- <li>reboot - veranlässt ein reboot der Bridge</li>
- <br>
- </ul>
- <br><br>
- <a name="NUKIBridgeget"></a>
- <b>Get</b>
- <ul>
- <li>callbackList - Gibt die Liste der eingetragenen Callback URL's wieder. Die Bridge nimmt maximal 3 auf.</li>
- <li>logFile - Zeigt das Logfile der Bridge an</li>
- <br>
- </ul>
- <br><br>
- <a name="NUKIBridgeattribut"></a>
- <b>Attribute</b>
- <ul>
- <li>disable - deaktiviert die Nuki Bridge</li>
- <br>
- </ul>
- </ul>
- <p><a name="NUKIDevice"></a>
- <h3>NUKIDevice</h3>
- <div class='langLinks'>[<a href='commandref.html#NUKIDevice'>EN</a> DE]</div>
- <ul>
- <u><b>NUKIDevice - Steuert das Nuki Smartlock</b></u>
- <br>
- Das Nuki Modul verbindet FHEM über die Nuki Bridge mit einem Nuki Smartlock. Es ist dann möglich das Schloss zu ver- und entriegeln.<br>
- In der Regel werden die Nuki Devices automatisch durch das Bridgemodul angelegt.
- <br><br>
- <a name="NUKIDevicedefine"></a>
- <b>Define</b>
- <ul><br>
- <code>define <name> NUKIDevice <Nuki-Id> <IODev-Device></code>
- <br><br>
- Beispiel:
- <ul><br>
- <code>define Haustür NUKIDevice 1 NBridge1</code><br>
- </ul>
- <br>
- Diese Anweisung erstellt ein NUKIDevice mit Namen Haustür, der NukiId 1 sowie dem IODev Device NBridge1.<br>
- Nach dem anlegen des Devices wird automatisch der aktuelle Zustand des Smartlocks aus der Bridge gelesen.
- </ul>
- <br><br>
- <a name="NUKIDevicereadings"></a>
- <b>Readings</b>
- <ul>
- <li>state - Status des Smartlock bzw. Fehlermeldung von Fehler vorhanden.</li>
- <li>lockState - aktueller Schließstatus uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.</li>
- <li>name - Name des Smart Locks</li>
- <li>paired - pairing Status des Smart Locks</li>
- <li>rssi - rssi Wert des Smart Locks</li>
- <li>succes - true, false Gibt des Status des letzten Schließbefehles wieder. Geklappt oder nicht geklappt.</li>
- <li>batteryCritical - Ist die Batterie in einem kritischen Zustand? true, false</li>
- <li>battery - Status der Batterie, ok/low</li>
- </ul>
- <br><br>
- <a name="NUKIDeviceset"></a>
- <b>Set</b>
- <ul>
- <li>statusRequest - ruft den aktuellen Status des Smartlocks von der Bridge ab.</li>
- <li>lock - verschließen</li>
- <li>unlock - aufschließen</li>
- <li>unlatch - entriegeln/Falle öffnen.</li>
- <li>unpair - entfernt das pairing mit dem Smart Lock</li>
- <li>locknGo - verschließen wenn gegangen</li>
- <li>locknGoWithUnlatch - verschließen nach dem die Falle geöffnet wurde.</li>
- <br>
- </ul>
- <br><br>
- <a name="NUKIDeviceattribut"></a>
- <b>Attribute</b>
- <ul>
- <li>disable - deaktiviert das Nuki Device</li>
- <li>webhookFWinstance - zu verwendene Webinstanz für den Callbackaufruf</li>
- <li>webhookHttpHostname - IP oder FQDN vom FHEM Server für den Callbackaufruf</li>
- <br>
- </ul>
- </ul>
- <p><a name="NUT"></a>
- <h3>NUT</h3>
- <div class='langLinks'>[<a href='commandref.html#NUT'>EN</a> DE]</div>
- <ul>
- Die Network UPS Tools (<a href="http://www.networkupstools.org">www.networkupstools.org</a>) bieten Unterstützung für Unterbrechungsfreie Stromversorgungen (USV)
- und ähnliches. Dieses Modul ermöglicht den Zugriff auf einen NUT-Server, womit man Daten auslesen kann (z.B. den Status, Restlaufzeit, Eingangsspannung, manchmal
- auch Temperatur u.ä.) und zukünftig die USV auch steuern kann (Test aktivieren, USV herunterfahren u.ä.).<br>
- Welche Readings zur Verfügung stehen, bestimmt das Attribut <a href="#NUT_asReadings">asReadings</a>. Welche Werte eine USV zur Verfügung stellt, kann man mit
- <code>list dieUSV</code> unter <i>Helper:</i> ablesen. Nur ups.status wird immer ausgelesen und ergibt den Status des Geräts.<br>
- <br><br>
- <a name=NUTdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> NUT <ups> [<host>[:<port>]]</code> <br>
- <br>
- <ups> ist der im NUT-Server definierte Name der USV.
- <br>
- [<host>[:<port>]] ist Host und Port des NUT-Servers. Default ist <code>localhost:3493</code>.
- <br><br>
- Beispiel: <br>
- <code>define dieUSV NUT myups einserver</code>
- <br>
- </ul>
- <br>
- <a name="NUTset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="NUTget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="NUTattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#disable">disable</a></li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="">pollState</a><br>
- Polling-Intervall in Sekunden für den Status der USV. Default: 10</li><br>
- <li><a name="">pollVal</a><br>
- Polling-Intervall für die anderen Werte. Dieser Wert wird auf ein Vielfaches von pollState gerundet. Default: 60</li><br>
- <li><a name="NUT_asReadings">asReadings</a><br>
- Mit Kommata getrennte Liste der USV-Werte, die als Readings verwendet werden sollen (ups.status wird auf jeden Fall gelesen).<br>
- Beispiel:<br>
- <code>attr dieUSV asReadings battery.charge,battery.runtime,input.voltage,ups.load,ups.power,ups.realpower</code> </li><br>
- </ul>
- </ul>
- <p><a name="Nello"></a>
- <h3>Nello</h3>
- <div class='langLinks'>[<a href='commandref.html#Nello'>EN</a> DE]</div>
- <ul>
- Das <i>Nello</i> Modul ermöglicht die Steuerung des <a target="_blank" rel="nofollow" href="https://www.nello.io/de/">nello one</a> Chips.<br>
- Um es aufzusetzen, muss zunächst ein <b>neuer Nutzer mit Admin-Rechten</b> in der Nello-App angelegt werden, der nur für FHEM verwendet wird - eine Nutzung per App ist mit diesem Account dann nicht mehr möglich.<br>
- Anschließend kann das Gerät angelegt werden. Sobald das Gerät erstellt wurde, kann der Login durchgeführt werden.<br>
- <b>ACHTUNG:</b> Sollte der Login fehlschlagen, versuche das Passwort über die recoverPassword Funktion zurückzusetzen.<br>
- <b>Dringend empfohlen:</b> Für verzögerungsfreie Events die detectDeviceID Funktion nach dem Login aufrufen.<br>
- <br>
- <p><b>Benötigte Pakete</b></p>
- <code>
- sudo apt-get install libcpan-meta-yaml-perl<br>
- sudo cpan -i Net::MQTT::Simple
- </code>
- <br>
- <br>
- <br>
- <a name="Nello_define"></a>
- <p><b>Define</b></p>
- <ul>
- <code>define <name> Nello</code><br>
- </ul>
- <br>
- <ul>
- Beispiel: <code>define nello Nello</code><br>
- </ul>
- <br>
- <a name="Nello_set"></a>
- <p><b>set <required> [ <optional> ]</b></p>
- <ul>
- <li>
- <i>login <username> <password></i><br>
- Login
- </li>
- <li>
- <i>recoverPassword <username></i><br>
- setzt das Passwort zurück
- </li>
- <li>
- <i>detectDeviceID</i><br>
- erkennt die Geräte-ID des Nellos durch einmaliges Öffnen der Tür und erstellt MQTT-Helper-Geräte für verzögerungsfreie Ereignisse
- </li>
- <li>
- <i>open [ <location_id> ]</i><br>
- öffnet die Tür
- </li>
- <li>
- <i>update</i><br>
- aktualisiert Aktionen und Ereignisse
- </li>
- </ul>
- <br>
- <a name="Nello_get"></a>
- <p><b>Get</b></p>
- <ul>
- N/A
- </ul>
- <br>
- <a name="Nello_attr"></a>
- <p><b>Attribute</b></p>
- <ul>
- <li>
- <i>updateInterval</i><br>
- das Intervall in Sekunden, in dem Ereignisse gepollt werden (nur relevant, wenn deviceID nicht erkannt wurde)<br>
- default: 900 (wenn Geräte-ID erkannt wurde), ansonten 15
- </li>
- </ul>
- </ul>
- <p><a name="NetIO230B"></a>
- <h3>NetIO230B</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#NetIO230B'>NetIO230B</a><br/>
- </ul>
- <a name="Netzer"></a>
- <h3>Netzer</h3>
- <div class='langLinks'>[<a href='commandref.html#Netzer'>EN</a> DE]</div>
- <ul>
- The <a href="http://www.mobacon.de/wiki/doku.php/de/netzer/index">Netzer</a> realisiert ein Ethernetinterface auf PIC-Basis. Es agiert als Gateway zwischen TCP/IP und verschiedenen seriellen Busses wie I2C, SPI oder UART. Es können bis zu 13 GPIO Pins angesprochen (gelesen oder geschrieben) werden.
- This Modul ermöglicht den Zugriff auf diese GPIO Pin's auf einem Netzer mit IO_base in Version 1.5.
- Es gibt zwei als ADC nutzbare Pin's channel, 2 als PMW Ausgänge, drei als Zähler sowie drei die einen Interrupt auslösen können.
- Die GPIO Pin's sind standardmäßig als Eingänge konfiguriert. Bevor ein Pin anderweitig genutzt werden kann, muss er über die eingebaute Website entsprechend <a href="http://www.mobacon.de/wiki/doku.php/de/netzer/io">eingestellt</a> werden.
- Ist einer der Eingänge als Inerrupteingang eingestellt, werden bei jedem Interrupereignis die Weter sämtlicher Ports aktualisiert.
- <br><br>
- <a name="NetzerDefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Netzer <host:port></code>
- <br><br>
- </ul>
- <a name="NetzerSet"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <port[_counter]> <value></code>
- <br>
- Dabei ist <value> ein dem Port entsprechender Buchstabe zwischen <code>a</code> und <code>m</code>. Besitzt der Port das Attribut <code>cnt</code> so kann ein weiterer Wert <port_counter> gesetzt werden.<br>
- Ausschließlich Port's die über Attribut Port_[a-m] auf <code>PWM</code> oder <code>out</code> gesetzt sind können benutzt werden.<br>
- Bei Port Attribut:<ul>
- <li>PWM <value> kann ein Wert zwischen 0 und 1023 sein</li>
- <li>out <value> kann ein Wert zwischen 0 und 1 sein</li>
- <li>cnt <port_counter> <value> kann ein Wert zwischen 0 und 32767 sein</li>
- <br></ul>
- </ul>
- <b>Get</b>
- <ul>
- <code>get <name> [<port[_counter]>]</code>
- <br>
- Ohne <port> werde alle Werte aktualisiert.<br>
- Wenn <port> ein Buchstabe zwischen <code>a</code> und <code>m</code><br> ist, wird der Portwert aktualisiert und bei Port Attribut <code>cnt</code> kann ein weiterer Zählerwert <port_counter> gelesen werden.<br>
- <br>
- </ul>
- <a name="NetzerAttr"></a>
- <b>Attributes</b>
- <ul>
- <a name="poll_interval"></a>
- <li>poll_interval<br>
- Aktualisierungsintervall aller Werte in Minuten.<br>
- Standard: 5, gültige Werte: Dezimalzahl
- </li><br>
- <a name="Port_<port>"></a>
- <li>Port_<port><br>
- <ul>
- Konfiguration des jeweiligen GPIO.<br>
- <port> ist ein Buchstabe zwischen <code>a</code> und <code>m</code>.<br>
- <li><code>in</code>: Port ist Eingang. Kann auch weggelassen werden, da Standard. Set ist für diesen Port nicht verfügbar.<br>
- Nutzbar für alle Port's</li>
- <li><code>out</code>: Port ist Ausgang. Set kann <value> zwischen 0 und 1 haben.<br>
- Nutzbar für alle Port's</li>
- <li><code>cnt</code>: Port ist Eingang. Set ist für diesen Port nicht verfügbar.<br>
- Ein weiteres Reading: Port_<port>_counter ist verfügbar.
- Dieses kann auch mit <code>get</code> gelesen und mit <code>set</code> verändert werden.<br>
- Port_<port>_counter <value> = 0-32767 oder overflow wenn es ausserhalb dieses Bereichs liegt.<br>
- Nutzbar für Port's a,b,c</li>
- <li><code>ADC</code>: Port ist Analogeingang. <code>get</code> <value> ist 0-1023 entsprechend der Spannung am Port. Set ist für diesen Port nicht verfügbar.<br>
- Nutzbar für Port's e,f</li>
- <li><code>PWM</code>: Port ist PWM-Ausgang. <code>set</code> und <code>get</code> <value> ist 0-1023 entsprechend des Dutycycle am Port.<br>
- Nutzbar für Port's d,j</li>
- </ul>
- </li><br>
- </ul>
- <br>
- </ul>
- <p><a name="NetzerI2C"></a>
- <h3>NetzerI2C</h3>
- <div class='langLinks'>[<a href='commandref.html#NetzerI2C'>EN</a> DE]</div>
- <ul>
- <a name="NetzerI2C"></a>
- Ermöglicht den Zugriff auf die I2C Schnittstelle des <a href="http://www.mobacon.de/wiki/doku.php/de/netzer/index">Netzer</a>.<br> über logische Module. Register von I2C IC's können auch direkt gelesen und geschrieben werden.<br><br>
- <b>Vorbereitung:</b><br>
- Bevor dieses Modul verwendet werden kann muss der Serielle Server des Netzers <a href="http://www.mobacon.de/wiki/doku.php/de/netzer/serialserveraktiviert"> und auf I2C gestellt</a> werden.
- <a name="NetzerI2CDefine"></a><br><br>
- <b>Define</b>
- <ul>
- <code>define <name> NetzerI2C <Device-Address:Port></code><br>
- <code><Device-Address:Port></code> ist die Adresse/IP-Adresse und Serial Server TCP-Port des Netzer<br><br>
- </ul>
- <a name="NetzerI2CSet"></a>
- <b>Set</b>
- <ul>
- <li>
- Schreibe ein Byte (oder auch mehrere nacheinander) direkt auf ein I2C device (manche I2C Module sind so einfach, das es nicht einmal mehrere Register gibt):<br>
- <code>set <name> writeByte <I2C Address> <value></code><br><br>
- </li>
- <li>
- Schreibe ein Byte (oder auch mehrere nacheinander) direkt auf ein Register des adressierten I2C device:<br>
- <code>set <name> writeByteReg <I2C Address> <Register Address> <value></code><br><br>
- </li>
- <li>
- Schreibe n-bytes auf einen Registerbereich, beginnend mit dem angegebenen Register:<br>
- <code>set <name> writeBlock <I2C Address> <Register Address> <value></code><br><br>
- </li>
- Beispiele:
- <ul>
- Schreibe 0xAA zu Modul mit I2C Addresse 0x60<br>
- <code>set test1 writeByte 60 AA</code><br>
- Schreibe 0xAA zu Register 0x01 des Moduls mit der I2C Adresse 0x6E<br>
- <code>set test1 writeByteReg 6E 01 AA</code><br>
- Schreibe 0xAA zu Register 0x01 des Moduls mit der I2C Adresse 0x6E, schreibe danach 0x55 zu Register 0x01<br>
- <code>set test1 writeByteReg 6E 01 AA 55</code><br>
- Schreibe 0xA4 zu Register 0x03, 0x00 zu Register 0x04 und 0xDA zu Register 0x05 des Moduls mit der I2C Adresse 0x60 als Block<br>
- <code>set test1 writeBlock 60 03 A4 00 DA</code><br>
- </ul><br>
- </ul>
- <a name="NetzerI2CGet"></a>
- <b>Get</b>
- <ul>
- <code>get <name> read <I2C Address> [<Register Address> [<number of registers>]] </code>
- <br>
- Auslesen der Registerinhalte des I2C Moduls<br><br>
- Examples:
- <ul>
- Lese Byte vom Modul mit der I2C Adresse 0x60<br>
- <code>get test1 writeByte 60</code><br>
- Lese den Inhalt des Registers 0x01 vom Modul mit der I2C Adresse 0x6E.<br>
- <code>get test1 read 6E 01 AA 55</code><br>
- Lese den Inhalt des Registerbereichs 0x03 bis 0x06 vom Modul mit der I2C Adresse 0x60.<br>
- <code>get test1 read 60 03 4</code><br>
- </ul><br>
- </ul><br>
- <a name="NetzerI2CAttr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="Nextion"></a>
- <h3>Nextion</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Nextion'>Nextion</a><br/>
- </ul>
- <a name="Nmap"></a>
- <h3>Nmap</h3>
- <div class='langLinks'>[<a href='commandref.html#Nmap'>EN</a> DE]</div>
- ( <a href="commandref.html#Nmap"><u>en</u></a> | de )
- <div>
- <ul>
- Nmap ist das FHEM Modul um einen Netzwerkscan mit Nmap durchzuführen
- und Informationen über die erreichbaren Netzwerkgeräte
- darzustellen.<br>
- Wird ein neues Gerät erkannt wird ein Event
- <code>"<name> new host: <hostname> (<IPv4>)"</code>
- erzeugt.<br>
- Wird erkannt, dass ein Gerät mit bekannter MAC-Adresse eine neue IP
- erhalten hat wird ein Event
- <code>"<name> new IP: <hostname> (<IPv4>)"</code>
- erzeugt.<br>
- <br>
- Vorraussetzungen:
- <ul>
- Das Programm "Nmap" sowie das Perl-Modul "Nmap::Parser" werden
- benötigt.<br>
- Unter Debian (basierten) System, können diese mittels
- <code>"apt-get install nmap libnmap-parser-perl"</code>
- installiert werden.
- </ul>
- <br>
- <a name="Nmapdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Nmap <target specification></code><br>
- In der <target specification> stehen alle Zielhosts, die gescannet
- werden sollen. <br>
- Der einfachste Fall ist die Beschreibung einer IP-Zieladresse oder eines
- Zielhostnamens zum Scannen. <br>
- Um ein ganzes Netzwerk benachbarter Hosts zu scannen unterstützt
- Nmap Adressen im CIDR-Stil. Es können /numbits an eine IPv4-Adresse
- oder an einen Hostnamen angefügt werden, und Nmap wird alle
- IP-Adressen scannen, bei denen die ersten numbits mit denen der gegebenen
- IP oder des gegebenen Hostnamens übereinstimmen. Zum Beispiel
- würde 192.168.10.0/24 die 256 Hosts zwischen 192.168.10.0 und
- 192.168.10.255 scannen. 192.168.10.40/24 würde genau dieselben Ziele
- scannen. Es ist auch möglich mehrere Netzwerke zur gleichen Zeit zu
- scannen. Zum Beispiel würde 192.168.1.0/24 192.168.2.0/24 die 512
- Hosts zwischen 192.168.1.0 und 192.168.2.255 scannen.<br>
- Siehe
- <a href="https://nmap.org/man/de/man-target-specification.html">
- <u>Nmap Man Page (Angabe von Zielen)</u>
- </a>.
- </ul><br>
- <a name="Nmapset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>clear readings</code><br>
- Löscht alle Readings außer "state".
- </li>
- <li>
- <code>deleteOldReadings <s></code><br>
- Löscht alle Readings die älter sind als <s> Sekunden.
- </li>
- <li>
- <code>interrupt</code><br>
- Bricht einen laufenden Scan ab.
- </li>
- <li>
- <code>statusRequest</code><br>
- Startet einen Netzwerkscan.
- </li>
- </ul><br>
- <a name="Nmapreadings"></a>
- <b>Readings</b><br>
- <ul>
- Allgemeine Readings:
- <ul>
- <li>
- <code>NmapVersion</code><br>
- Die Versionsnummer des installierten Nmap Programms.
- </li>
- <li>
- <code>hostsScanned</code><br>
- Die Anzahl der gescannten Adressen.
- </li>
- <li>
- <code>hostsUp</code><br>
- Die Anzahl der erreichbaren Netzwerkgeräte.
- </li>
- <li>
- <code>knownHosts</code><br>
- Die Anzahl der bekannten Netzwerkgeräte.
- </li>
- <li>
- <code>scanDuration</code><br>
- Die Scan-Dauer in Sekunden.
- </li>
- <li>
- <code>state</code><br>
- <ul>
- <li>
- <code>Initialized</code><br>
- Nmap wurde definiert oder enabled.
- </li>
- <li>
- <code>running</code><br>
- Ein Netzwerkscan wird ausgeführt.
- </li>
- <li>
- <code>done</code><br>
- Der Netzwerkscan wurde erfolgreich abgeschlossen.
- </li>
- <li>
- <code>aborted</code><br>
- Der Netzwerkscan wurde aufgrund einer Zeitüberschreitung oder
- durch den Benutzer abgebrochen.
- </li>
- <li>
- <code>disabled</code><br>
- Nmap wurde deaktiviert.
- </li>
- </ul>
- </li>
- </ul>
- <br>
- Hostspezifische Readings:
- <ul>
- <li>
- <code><metaReading>_alias</code><br>
- Alias welcher unter dem Attribut "devAlias" für das Netzwerkgerät
- angegeben ist. Ist kein Alias angegeben wird der Hostname angezeigt.
- </li>
- <li>
- <code><metaReading>_hostname</code><br>
- Hostname des Netzwerkgeräts. Kann dieser nicht ermittel werden
- wird die IPv4-Adresse angezeigt.
- </li>
- <li>
- <code><metaReading>_ip</code><br>
- IPv4-Adresse des Netzwerkgeräts.
- </li>
- <li>
- <code><metaReading>_lastSeen</code><br>
- Der Zeitpunkt zu dem das Netzwerkgerät das letzte mal als gesehen
- wurde.
- </li>
- <li>
- <code><metaReading>_macAddress</code><br>
- MAC-Adresse des Netzwerkgeräts. Diese kann nur ermittelt werden,
- wenn der Scan mit Root-Rechten ausgeführt wird.
- </li>
- <li>
- <code><metaReading>_macVendor</code><br>
- Vermutlicher Hersteller des Netzwerkgeräts. Dieser kann nur
- ermittelt werden, wenn der Scan mit Root-Rechten ausgeführt wird.
- </li>
- <li>
- <code><metaReading>_state</code><br>
- Status des Netzwerkgeräts. Kann entweder "absent" oder "present"
- sein.
- </li>
- <li>
- <code><metaReading>_uptime</code><br>
- Zeit in Sekunden seit der das Netzwerkgerät erreichbar ist.
- </li>
- <li>
- <code><metaReading>_uptimeText</code><br>
- Zeit in "d days, hh hours, mm minutes, ss seconds" seit der das
- Netzwerkgerät erreichbar ist.
- </li>
- </ul>
- </ul><br>
- <a name="Nmapattr"></a>
- <b>Attribute</b>
- <ul>
- <li>
- <code>absenceThreshold <n></code><br>
- Die Anzahl an Netzwerkscans, welche in "absent" resultieren
- müssen, bevor der Status eines Netzwerkgeräts auf "absent"
- wechselt. Mit dieser Funktion kann man die Abwesenheit eines
- Gerätes verifizieren bevor der Status final auf "absent"
- geändert wird. Wenn dieses Attribut auf einen Wert >1 gesetzt
- ist, verbleibt das Reading "<metaReading>_state" auf "present",
- bis der Status final auf "absent" wechselt.
- </li>
- <li>
- <code>args <args></code><br>
- Argumente für den Nmap-Scan.<br>
- Die Vorgabe ist "-sn".
- </li>
- <li>
- <code>deleteOldReadings <s></code><br>
- Nach einem Netzwerkscan werden alle hostspezifischen Readings, die
- älter sind als <s> Sekunden, gelöscht
- </li>
- <li>
- <code>
- devAlias <ID>:<ALIAS> <ID2>:<ALIAS2> ...
- </code><br>
- Eine Leerzeichen-getrennte getrennte Liste von <ID>:<ALIAS>
- Paaren, die dazu genutzt werden kann um Netzwerkgeräten einen
- Alias zu geben.<br>
- Die ID kann dabei MAC-Adresse, hostname oder IPv4-Adresse sein.<br>
- Beispiele:
- <ul>
- MAC-Adresse:
- <code>
- attr <name> devAlias 5C:51:88:A5:94:1F:Michaels_Handy_byMAC
- </code><br>
- hostname:
- <code>
- attr <name> devAlias
- android-87c7a6221093d830:Michaels_Handy_byHOST
- </code><br>
- IPv4-Adresse:
- <code>
- attr <name> devAlias 192.168.1.130:Michaels_Handy_byIP
- </code><br>
- </ul>
- </li>
- <li>
- <code>disable 1</code><br>
- Ein laufender Scan wird abgebrochen und es werden keine neuen Scans
- gestartet.
- </li>
- <li>
- <code>excludeHosts <target specification></code><br>
- In der <target specification> stehen alle Zielhosts, die beim
- Scan übersprungen werden sollen.
- </li>
- <li>
- <code>interval <seconds></code><br>
- Intervall in Sekunden in dem der Scan durchgeführt wird.<br>
- Der Vorgabewert ist 900 Sekunden und der Mindestwert 30 Sekunden.
- </li>
- <li>
- <code>keepReadings 1</code><br>
- Wird für ein Gertät mit bekannter MAC-Adresse eine neue IP-Adresse
- erkannt, werden die ungültig gewordenen Readings gelöscht es sei denn
- dieses Attribut ist gesetzt.
- </li>
- <li>
- <code>leadingZeros 1</code><br>
- Bei den Readings-Namen werden die IPv4-Adressen mit führenden
- Nullen dargestellt.
- </li>
- <li>
- <code>metaReading <metaReading></code><br>
- Als <metaReading> kann "alias", "hostname", "ip" oder
- "macAddress" angegeben werden und ist der Bezeichner für die
- Readings.<br>
- Die Vorgabe is "ip".
- </li>
- <li>
- <code>path</code><br>
- Pfad unter dem das Nmap Programm zu erreichen ist.<br>
- Die Vorgabe ist "/urs/bin/nmap".
- </li>
- <li>
- <a href="#readingFnAttributes">
- <u><code>readingFnAttributes</code></u>
- </a>
- </li>
- <li>
- <code>sudo 1</code><br>
- Der Scan wird mit Root-Rechten ausgeführt.<br>
- Voraussetzung ist, dass der Benutzer unter dem FHEM ausgeführt
- diese Rechte besitzt. Für den Benutzer "fhem", auf einem Debian
- (basierten) System, lassen sich diese in der Datei "/etc/sudoers"
- festlegen. Dafür muss im Abschnitt "# User privilege
- specification" die Zeile "fhem ALL=(ALL) NOPASSWD: /usr/bin/nmap"
- eingefügt werden.
- </li>
- </ul>
- </ul>
- </div>
- <p><a name="NotifyAndroidTV"></a>
- <h3>NotifyAndroidTV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#NotifyAndroidTV'>NotifyAndroidTV</a><br/>
- </ul>
- <a name="OBIS"></a>
- <h3>OBIS</h3>
- <div class='langLinks'>[<a href='commandref.html#OBIS'>EN</a> DE]</div>
- <ul>
- Modul für Smartmeter, die ihre Daten im OBIS-Standard senden. Hierbei ist es egal, ob die Daten als reiner Text oder aber SML-kodiert kommen.
- <br><br>
- <b>Define</b>
- <ul>
- <code>define <name> OBIS device|none [MeterType] </code><br>
- <br>
- <device> gibt den seriellen Port an.
- <br><br>
- Optional: MeterType kann sein:
- <ul><li>VSM102 -> Voltcraft VSM102</li>
- <li>E110 -> Landis&&;Gyr E110</li>
- <li>E350USB -> Landis&&;Gyr E350 USB-Version</li>
- <li>Standard -> Daten kommen als plainText</li>
- <li>SML -> Smart Message Language</li></ul>
- <br>
- Beispiel: <br>
- <code>define myPowerMeter OBIS /dev/ttyPlugwise@@9600,7,E,1 VSM102</code>
- <br>
- <br>
- </ul>
- <b>Attribute</b>
- <ul><li>
- <code>offset_feed <br>offset_energy</code><br>
- Wenn das Smartmeter hinter einem Zähler des EVU's sitzt, kann hiermit der Zähler des
- Smartmeters an den des EVU's angepasst werden.
- </li><li>
- <code>channels</code><br>
- Hiermit können die einzelnen Kanal-Readings mittels RegExes umbenannt werden.<BR>
- Beispiel: <code>attr myOBIS channels {"1.0.96.5.5.255"=>"Status","1.0.0.0.0.255"=>"Info","16.7"=>"Verbrauch"}></code>
- </li><li>
- <code>directions</code><br>
- Manche SmartMeter senden im Statusbyte die Stromrichtung.
- In diesem Fall gibt es ein extra Reading "dir_total_consumption" welches standardmäßig "in" and "out" beinhaltet<BR>
- Hiermit kann dieser Text geändert werden, z.B.:
- <code>attr myOBIS directions {">" => "pwr consuming", "<"=>"pwr feeding"}</code>
- </li><li>
- <code>interval</code><br>
- Abrufinterval der Daten. (Bringt nur im Polling-Mode was)
- </li><li>
- <code>algignTime</code><br>
- Richtet den Zeitpunkt von <interval> nach einer bestimmten Uhrzeit aus.
- </li><li>
- <code>pollingMode</code><br>
- Hiermit wird von Direktbenachrichtigung auf Polling umgestellt.
- Bei Smartmetern, welche von selbst im Sekundentakt senden,
- kann das zu einer spürbaren Senkung der Prozessorleistung führen.
- </li><li>
- <code>unitReadings</code><br>
- Hängt bei den Readings auch die Einheiten an, zB w, wH, A usw.
- </li><li>
- <code>valueBracket</code><br>
- Legt fest, ob der Wert aus dem ersten oder zweiten Klammernpaar genommen wird.
- Standard ist "second"
- </li>
- <br>
- </ul></ul>
- <p> <p>
- <a name="ONKYO_AVR" id="ONKYO_AVR"></a>
- </p>
- <h3>
- ONKYO_AVR
- </h3>
- <div class='langLinks'>[<a href='commandref.html#ONKYO_AVR'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#ONKYO_AVR'>ONKYO_AVR</a>
- </ul>
- <p> <p>
- <a name="ONKYO_AVR_ZONE" id="ONKYO_AVR_ZONE"></a>
- </p>
- <h3>
- ONKYO_AVR_ZONE
- </h3>
- <div class='langLinks'>[<a href='commandref.html#ONKYO_AVR_ZONE'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#ONKYO_AVR_ZONE'>ONKYO_AVR_ZONE</a>
- </ul>
- <p><a name="OPENWEATHER"></a>
- <h3>OPENWEATHER</h3>
- <div class='langLinks'>[<a href='commandref.html#OPENWEATHER'>EN</a> DE]</div>
- <div>
- <ul>
- <a name="OPENWEATHERdefine"></a>
- Das Modul extrahiert Wetterdaten über die <a href="http://www.wetter.com/apps_und_mehr/website/api/dokumentation">"openweather"-Schnittstelle (API)</a> von <a href="http://www.wetter.com">www.wetter.com</a>.
- <br/>
- Zuvor ist eine Registrierung auf der Webseite notwendig.
- <br/>
- Das Modul nutzt die Perlmodule HTTP::Request, LWP::UserAgent, HTML::Parse und Digest::MD5.
- <br>
- Für detailierte Anleitungen bitte die <a href="http://www.fhemwiki.de/wiki/OPENWEATHER"><b>FHEM-Wiki</b></a> konsultieren und ergänzen.
- <br/><br/>
- <b>Define</b>
- <ul>
- <br>
- <code>define <name> OPENWEATHER <Projekt> <Ortscode> <apiSchlüssel> [Sprache]</code>
- <br>
- Beispiel:
- <br>
- <code>define wetter OPENWEATHER projectx DE0001020 3c551bc20819c19ee88d</code>
- <br/><br/>
- Um die unteren Parameter zu erhalten, ist die Registrierung eines neuen Projektes auf <a href="http://www.wetter.com/apps_und_mehr/website/api/projekte/">www.wetter.com</a> notwendig.
- <br/><br/>
- <li><code><Projekt></code>
- <br>
- Name des benutzerspezifischen 'openweather'-Projektes (erzeugt über ein Konto auf wetter.com).
- </li><br>
- <li><code><Ortscode></code>
- <br>
- Code des Ortes, für den die Wettervorhersage benötigt wird. Er kann direkt aus der Adresszeile der jeweiligen Vorhersageseite genommen werden. Zum Beispiel <i>DE0009042</i> aus:
- <br>
- <i>http://www.wetter.com/wetter_aktuell/aktuelles_wetter/deutschland/rostock/<u>DE0009042</u>.html</i>
- </li><br>
- <li><code><apiSchlüssel></code>
- <br>
- Geheimer Schlüssel, den man erhält, nachdem man ein neues 'Openweather'-Projekt auf der Website registriert hat.
- </li><br>
- <li><code>[Sprache]</code>
- <br>
- Optional. Standardsprache für die Wettersituation ist Deutsch. Mit <i>en</i> kann man zu Englisch und mit <i>es</i> zu Spanisch wechseln.
- </li><br>
- Über die Funktion <code>OPENWEATHER_Html</code> wird ein HTML-Code für ein vertikal arrangierte Wettervorhersage erzeugt.
- <br>
- Beispiel:
- <br>
- <code>define MyForecast weblink htmlCode { OPENWEATHER_Html("MyWeather") }</code>
- <br/><br/>
- </ul>
- <a name="OPENWEATHERset"></a>
- <b>Set</b>
- <ul>
- <br>
- <li><code>set <name> update</code>
- <br>
- Startet sofort ein neues Auslesen der Wetterdaten.
- </li><br>
- </ul>
-
- <a name="OPENWEATHERget"></a>
- <b>Get</b>
- <ul>
- <br>
- <li><code>get <name> apiResponse</code>
- <br>
- Zeigt die Rückgabewerte der Website an.
- </li><br>
- </ul>
- <a name="OPENWEATHERattr"></a>
- <b>Attribute</b>
- <ul>
- <br>
- <li><code>disable <0 | 1></code>
- <br>
- Automatische Aktuallisierung ist angehalten, wenn der Wert auf 1 gesetzt wird.
- </li><br>
- <li><code>INTERVAL <Abfrageinterval></code>
- <br>
- Abfrageinterval in Sekunden (Standard und kleinster Wert ist 3600 = 1 Stunde). 0 stoppt die automatische Aktualisierung
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br/>
- <a name="OPENWEATHERreading"></a>
- <b>Vorhersagewerte</b>
- <ul>
- Wichtig! Die Vorhersagewerte (in Klammern) müssen zuerst in den Vorhersageeinstellungen des Projektes auf wetter.com ausgewählt werden.
- <br/> <br/>
- <li><b>fc</b><i>0|1|2</i><b>_...</b> - Vorhersagewerte für <i>heute|morgen|übermorgen</i></li>
- <li><b>fc</b><i>0</i><b>_...<i>06|11|17|23</i></b> - Vorhersagewerte für <i>heute</i> um <i>06|11|17|23</i> Uhr</li>
- <li><b>fc</b><i>0</i><b>_chOfRain</b> - <i>heutige</i> Niederschlagswahrscheinlichkeit in % (pc)</li>
- <li><b>fc</b><i>0</i><b>_temp</b><i>Min|Max</i> - <i>Mindest|Maximal</i>temperatur <i>heute</i> in °C (tn, tx)</li>
- <li><b>fc</b><i>0</i><b>_temp</b><i>Min06</i> - <i>Mindest</i>temperatur <i>heute</i> um <i>06:00</i> Uhr in °C</li>
- <li><b>fc</b><i>0</i><b>_valHours</b><i>06</i> - Gültigkeitszeitraum der Prognose von <i>heute</i> ab <i>6:00 Uhr</i> in Stunden (p)</li>
- <li><b>fc</b><i>0</i><b>_weather</b> - Wetterzustand <i>heute</i> (w_txt)</li>
- <li><b>fc</b><i>0</i><b>_weatherCode</b> - Code des Wetterzustand <i>heute</i> (w)</li>
- <li><b>fc</b><i>0</i><b>_wday</b> - Abkürzung des Wochentags von <i>heute</i> (d)</li>
- <li><b>fc</b><i>0</i><b>_wind</b> - Windgeschwindigkeit <i>heute</i> in km/h (ws)</li>
- <li><b>fc</b><i>0</i><b>_windDir</b> - Windrichtung <i>heute</i> in ° (Grad) (wd)</li>
- <li><b>fc</b><i>0</i><b>_windDirTxt</b> - Windrichtung <i>heute</i> in Textform (wd_txt)</li>
- <li>etc.</li>
- </ul>
- <br/>
- </ul>
- </div>
- <p><a name="OREGON"></a>
- <h3>OREGON</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OREGON'>OREGON</a><br/>
- </ul>
- <a name="OWAD"></a>
- <h3>OWAD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWAD'>OWAD</a><br/>
- </ul>
- <a name="OWCOUNT"></a>
- <h3>OWCOUNT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWCOUNT'>OWCOUNT</a><br/>
- </ul>
- <a name="OWDevice"></a>
- <h3>OWDevice</h3>
- <div class='langLinks'>[<a href='commandref.html#OWDevice'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="OWDevicedefine"></a>
- <b>Definition</b>
- <ul>
- <code>define <name> OWDevice <address> [<interval>]</code>
- <br><br>
- Definiert ein 1-Wire- Gerät. 1-Wire- Geräte werden anhand ihrer Adresse <address> definiert. Diese wird
- durch den zuvor eingerichteten <a href="#OWServer">OWServer</a> bereitgestellt.
- <br><br>
- Geräte hinter 1-wire-Hubs (DS2409, Adressfamilie 1F) müssen über den vollen Pfad adressiert werden, z.B.
- <code>1F.0AC004000000/main/26.A157B6000000</code> (kein führender Schrägstrich). Sie werden nicht
- automatisch erkannt.
- <br><br>
- Wird zusätzlich <interval> angegeben, ruft OWServer alle <interval> Sekunden
- einen Datensatz des Gerätes ab.
- <br><br>
- Jedes OWDevice ist ein eigenständiges Gerät. Seine Eigenschaften werden erstmals zum Zeitpunkt der Definition
- abgefragt. Die durch "get" oder "set" erzeugten, sowie durch den zyklischen Abruf gelieferten readings,
- können mit dem Kommando <code><a href="#list">list</a> <name></code> angezeigt werden.
- <br><br>
- Folgende 1-Wire- und iButton- Komponenten werden aktuell unterstützt:
- <ul>
- <li>DS2401 - Im Chip integrierte Seriennummer</li>
- <li>DS1990A - iButton mit fester Seriennummer</li>
- <li>DS2405 - Adressierbarer Schalter</li>
- <li>DS18S20 - Hochpräzisions-Digital-Thermosensor</li>
- <li>DS1920 - iButton-Thermosensor</li>
- <li>DS2406, DS2407 - Dualer adressierbarer Schalter mit 1 kbit Speicher</li>
- <li>DS2436 - Batterie-ID/Monitor- Schaltkreis</li>
- <li>DS2423 - Dual-Zählerbaustein mit Speicherfunktion</li>
- <li>DS2450 - Vierfach-A/D Umsetzer</li>
- <li>DS1822 - Econo-Thermosensor</li>
- <li>DS2433 - 4kbit 1-Wire RAM</li>
- <li>DS2415 - Zeitgeber- Schaltkreis </li>
- <li>DS1904 - iButton-Echtzeituhr</li>
- <li>DS2438 - Smart-Batterie-Monitor</li>
- <li>DS2417 - Zeitgeber-Schaltkreis mit Interrupt</li>
- <li>DS18B20 - Thermosensor mit programmierbarer Auflösung</li>
- <li>DS2408 - 8-kanaliger adressierbarer Schalter</li>
- <li>DS2413 - 2-kanaliger adressierbarer Schalter</li>
- <li>DS1825 - Thermosensor mit programmierbarer Auflösung und ID</li>
- <li>EDS0066 - Vielfachsensor für Temperatur und Luftdruck</li>
- <li>LCD - LCD-Ansteuerung von Louis Swart</li>
- </ul>
- <br>
- Das Hinzufügen weiterer Geräte ist im Modulcode (subroutine <code>OWDevice_GetDetails</code>) sehr einfach möglich.
- <br><br>
- <b>Achtung: Dieses Modul ist weder verwandt noch verwendbar mit den 1-Wire Modulen, deren Namen nur aus Großbuchstaben bestehen!</b>
- <br><br>
- <b>Bitte beachten:</b> Um einer Verwechselung entgegenzuwirken, stößt das reading "state" der Geräte keine Events an.<br><br>
- Beispiele zur Einrichtung:
- <ul>
- <code>
- define myOWServer OWServer localhost:4304<br><br>
- get myOWServer devices<br>
- 10.487653020800 DS18S20<br><br>
- define myT1 10.487653020800<br><br>
- list myT1 10.487653020800<br>
- Internals:<br>
- ...<br>
- Readings:<br>
- 2012-12-22 20:30:07 temperature 23.1875<br>
- Fhem:<br>
- ...<br>
- getters:<br>
- address<br>
- family<br>
- id<br>
- power<br>
- type<br>
- temperature<br>
- templow<br>
- temphigh<br>
- polls:<br>
- temperature<br>
- setters:<br>
- alias<br>
- templow<br>
- temphigh<br>
- ...<br>
- </code>
- </ul>
- <br>
- </ul>
- <a name="OWDeviceset"></a>
- <b>Set-Befehle</b>
- <ul>
- <li><code>set <name> interval <value></code>
- <br>
- <code>value</code> überschreibt das Abrufintervall der Datensätze. Der Wert ist in Sekunden anzugeben.
- </li><br>
- <li><code>set <name> <reading> <value></code>
- <br>
- Setzt das <reading> auf <value> für das 1-Wire-Gerät <name>. Die verwendbaren Werte werden durch die
- jeweiligen 1-wire-Geräte bestimmt.
- <br><br>
- Beispiel:
- <ul>
- <code>set myT1 templow 5</code><br>
- </ul>
- <br>
- </li>
- </ul>
- <a name="OWDeviceget"></a>
- <b>Get-Befehle</b>
- <ul>
- <code>get <name> <reading> <value></code>
- <br>
- Holt das <reading> des 1- Wire Geräte- <name>. Die verwendbaren Werte werden durch die
- jeweiligen 1-wire-Geräte bestimmt.
- <br><br>
- Beispiel:
- <ul>
- <code>get myT1 temperature</code><br>
- </ul>
- <br>
- </ul>
- <a name="OWDeviceattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="IODev"></a>
- <li>IODev:
- Bestimmt die OWServer-Instanz, welche für das Senden und Abrufen der Daten
- eines OWDevice-Gerätes genutzt werden soll. Hinweis: Während des Starts
- ordnet FHEM die neuen OWDevice-Geräte der jeweils zuletzt definierten OWServer-Instanz zu.
- Deshalb verfährt man idealerweise so, dass man zuerst eine OWServer-Instanz und
- anschließend die zugehörigen OWDevice-Geräte definiert. Danach definiert man die
- nächste OWServer-Instanz, gefolgt von den zugehörigen OWDevice-Geräten, usw.
- </li>
- <li>trimvalues: Entfernt voran- und nachgestellte Leerzeichen aus den readings. Standartwert ist 1 (ein).</li>
- <li>cstrings: Interpretiert die readings als C-String, d.h. hört mit dem ersten 0-Byte zu lesen auf. Standardwert ist 0 (off).</li>
- <li>polls: Eine per Komma getrennte Liste der abzurufenden readings. Mit diesem Attribut unterdrückt man alle standartmäßig abgerufenen readings und ersetzt sie durch die eigene Zusammenstellung.</li>
- <li>interfaces: Ersetzt die durch dieses Gerät erzeugten Interfaces.</li>
- <li>model: Angabe des Gerätetyps, z.B.: DS18S20.</li>
- <li>resolution: Angabe der Auflösung für die Temperaturmessung in bits, zur Verfügung stehen: 9, 10, 11 oder 12.
- Hinweis: Geringere Auflösungen bewirken schnellere Reaktionen des Busses. Dies kann z.B. bei umfangreichen 1-Wire- Installationen hilfreich sein,
- um eventuelle Stillstände von FHEM zu vermindern.</li>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br><br>
- </ul>
- <p><a name="OWFS"></a>
- <h3>OWFS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWFS'>OWFS</a><br/>
- </ul>
- <a name="OWID"></a>
- <h3>OWID</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWID'>OWID</a><br/>
- </ul>
- <a name="OWLCD"></a>
- <h3>OWLCD</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWLCD'>OWLCD</a><br/>
- </ul>
- <a name="OWMULTI"></a>
- <h3>OWMULTI</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWMULTI'>OWMULTI</a><br/>
- </ul>
- <a name="OWSWITCH"></a>
- <h3>OWSWITCH</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWSWITCH'>OWSWITCH</a><br/>
- </ul>
- <a name="OWServer"></a>
- <h3>OWServer</h3>
- <div class='langLinks'>[<a href='commandref.html#OWServer'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="OWServerdefine"></a>
- <b>Definition</b>
- <ul>
- <code>define <name> OWServer <protocol></code>
- <br><br>
- Definiert eine logische OWServer- Instanz. OWServer ist die Serverkomponente des
- <a href="http://owfs.org">1-Wire Dateisystems</a>. Sie ermöglicht den Zugriff auf
- alle 1-Wire- Busteilnehmer eines Systems.<br><br>
- <protocol> hat das Format <hostname>:<port> Nähere Informationen dazu gibt es in der <a href="http://owfs.org/index.php?page=owserver_protocol">owserver Dokumentation</a>.
- <br><br>
- Voraussetzung innerhalb von FHEM ist das Modul <a href="http://owfs.cvs.sourceforge.net/viewvc/owfs/owfs/module/ownet/perl5/OWNet/lib/OWNet.pm">OWNet.pm von owfs.org</a>, welches bereits mit FHEM ausgeliefert wird.
- Das auf CPAN erhältliche OWNet- Modul beinhaltet seit dem 23.12.2012 einen Fehler, der es für Fernzugriffe unbrauchbar macht.<p>
- Auf dem Computer, an dem der 1-Wire- Bus angeschlossen ist, muss die Software "owserver" installiert sein. Zusätzlich sollte auf diesem Rechner die Konfigurationsdatei "owfs.conf" eingesehen bzw. angepasst werden. <a href="http://www.fhemwiki.de/wiki/OWServer_%26_OWDevice#Tipps_und_Tricks"> Einen WIKI- Artikel dazu gibt es hier.</a>
- <br><br>
- Die ow*-Pakete in der Version 2.9 von Debian Jessie haben Probleme. Bitte entpacke für Debian Jessie entweder
- <a href="http://forum.fhem.de/index.php?action=dlattach;topic=12219.0;attach=2463">owfs_2.8p17-1_all.zip</a> und installiere
- owserver, Abhängigkeiten und was Du sonst noch brauchst mit <code>dpkg -i <package>.deb</code>, oder benutze die neueste Version von OWNet.pm von Sourceforge.
- <p>
- Die ow*-Pakete in der Version 3.1 von Debian Stretch sind in Ordnung.
- <p>
- Eine typische funktionierende Konfigurationsdatei <code>/etc/owfs.conf</code> sieht so aus:<p>
- <code>
- # server uses device /dev/onewire<br>
- server: device = /dev/onewire<br>
- # clients other than server use server<br>
- ! server: server = localhost:4304<br>
- # port<br>
- server: port = 4304<br>
- # owhttpd<br>
- http: port = 2121<br>
- # owftpd<br>
- ftp: port = 2120<br>
- </code>
- <p>
- Die vorhandenen 1-Wire- Busteilnehmer werden als <a href="#OWDevice">OWDevice</a> -Geräte definiert.
- Wenn <a href="#autocreate">autocreate</a> aktiviert ist, werden beim Start von FHEM alle Geräte automatisch erkannt und eingerichtet.
- <br><br>
- <b>Achtung: Dieses Modul ist weder verwandt noch verwendbar mit den 1-Wire Modulen, deren Namen nur aus Großbuchstaben bestehen!</b>
- <br><br>
- Beispiele für die Einrichtung:
- <ul>
- <code>define myLocalOWServer OWServer localhost:4304</code><br>
- <code>define myRemoteOWServer OWServer 192.168.1.100:4304</code><br>
- <code>define myRemoteOWServer OWServer raspi:4304</code><br>
- </ul>
- <br>
- Hinweis: Sollten keine Geräte erkannt werden, kann man versuchen in der owserver- Konfigurationsdatei (owfs.conf) zwei Servereinträge anzulegen:
- Einen mit <code>localhost</code> und einen mit dem "FQDN", bzw. dem Hostnamen, oder der IP-Adresse des Computers, auf dem die Software "owserver" läuft.
- <br><br>
- </ul>
- <a name="OWServerset"></a>
- <b>Set- Befehle</b>
- <ul>
- <code>set <name> <value></code>
- <br><br>
- wobei <code>value</code> für einen der folgenden Befehle steht:<br><br>
- <li><code>reopen</code><br>
- Erneuert die Verbindung zum owserver.
- </li>
- <li>owserver (OWFS) -spezifische Einstellungen:
- <ul>
- <li><code>timeout/directory</code></li>
- <li><code>timeout/ftp</code></li>
- <li><code>timeout/ha7</code></li>
- <li><code>timeout/network</code></li>
- <li><code>timeout/presence</code></li>
- <li><code>timeout/serial</code></li>
- <li><code>timeout/server</code></li>
- <li><code>timeout/stable</code></li>
- <li><code>timeout/uncached</code></li>
- <li><code>timeout/usb</code></li>
- <li><code>timeout/volatile</code></li>
- <li><code>timeout/w1</code></li>
- <li><code>units/pressure_scale</code></li>
- <li><code>units/temperature_scale</code></li>
- </ul>
- </li>
- Nähere Informationen zu diesen Einstellungen gibt es im <a href="http://owfs.org/uploads/owserver.1.html#sect41">owserver- Manual</a>.
- <br>
- </ul>
- <br><br>
- <a name="OWServerget"></a>
- <b>Get- Befehle</b>
- <ul>
- <code>get <name> <value></code>
- <br><br>
- wobei <code>value</code> für einen der folgenden Befehle steht:<br><br>
- <li><code>devices</code><br>
- Gibt eine Liste der Adressen und Typen aller von owserver erkannten Geräte aus. Außerdem
- werden die entsprechenden <a href="#OWDevice">OWDevice-</a> Namen angezeigt, soweit sie bereits definiert sind.
- </li>
- <li><code>errors</code><br>
- Liefert eine Fehlerstatistik zurück.</li>
- <li>owserver (OWFS) -spezifische Einstellungen:
- <ul>
- <li><code>/settings/timeout/directory</code></li>
- <li><code>/settings/timeout/ftp</code></li>
- <li><code>/settings/timeout/ha7</code></li>
- <li><code>/settings/timeout/network</code></li>
- <li><code>/settings/timeout/presence</code></li>
- <li><code>/settings/timeout/serial</code></li>
- <li><code>/settings/timeout/server</code></li>
- <li><code>/settings/timeout/stable</code></li>
- <li><code>/settings/timeout/uncached</code></li>
- <li><code>/settings/timeout/usb</code></li>
- <li><code>/settings/timeout/volatile</code></li>
- <li><code>/settings/timeout/w1</code></li>
- <li><code>/settings/units/pressure_scale</code></li>
- <li><code>/settings/units/temperature_scale</code></li>
- <li><code>/uncached/alarm</code></li>
- </ul>
- </li>
- Nähere Informationen zu diesen Einstellungen gibt es im <a href="http://owfs.org/uploads/owserver.1.html#sect41">owserver- Manual</a>.
- <br>
- </ul>
- <p>
- <a name="OWServerattr"></a>
- <b>Attribute</b>
- <ul>
- <li>nonblocking<br>
- Holt alle readings (OWServer / <a href="#OWDevice">OWDevice</a>) über einen Tochterprozess. Dieses Verfahren stellt sicher,
- dass FHEM während der Kommunikation mit owserver nicht angehalten wird.<br>
- Beispiel:<br>
- <code> attr <name> nonblocking 1</code>
- </li>
- <li><a href="#eventMap">eventMap</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- Hinweis: Falls in FHEM trotzdem ungewöhnliche Stillstände auftreten, sollte das Attribut <code>nonblocking</code> wieder deaktiviert werden.<br>
- </ul>
- <p><a name="OWTEMP"></a>
- <h3>OWTEMP</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWTEMP'>OWTEMP</a><br/>
- </ul>
- <a name="OWTHERM"></a>
- <h3>OWTHERM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWTHERM'>OWTHERM</a><br/>
- </ul>
- <a name="OWVAR"></a>
- <h3>OWVAR</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWVAR'>OWVAR</a><br/>
- </ul>
- <a name="OWX"></a>
- <h3>OWX</h3>
- <div class='langLinks'>[<a href='commandref.html#OWX'>EN</a> DE]</div>
- <ul>
- <a href="http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#OWX">OWX</a>
- </ul>
- <p><a name="OWX_ASYNC"></a>
- <h3>OWX_ASYNC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#OWX_ASYNC'>OWX_ASYNC</a><br/>
- </ul>
- <a name="OWX_CCC"></a>
- <h3>OWX_CCC</h3>
- <div class='langLinks'>[<a href='commandref.html#OWX_CCC'>EN</a> DE]</div>
- <ul>
- <a href="http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#OWX">OWX</a>
- </ul>
- <p><a name="OWX_FRM"></a>
- <h3>OWX_FRM</h3>
- <div class='langLinks'>[<a href='commandref.html#OWX_FRM'>EN</a> DE]</div>
- <ul>
- <a href="http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#OWX">OWX</a>
- </ul>
- <p><a name="OWX_SER"></a>
- <h3>OWX_SER</h3>
- <div class='langLinks'>[<a href='commandref.html#OWX_SER'>EN</a> DE]</div>
- <ul>
- <a href="http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#OWX">OWX</a>
- </ul>
- <p><a name="OWX_TCP"></a>
- <h3>OWX_TCP</h3>
- <div class='langLinks'>[<a href='commandref.html#OWX_TCP'>EN</a> DE]</div>
- <ul>
- <a href="http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#OWX">OWX</a>
- </ul>
- <p><a name="PCA301"></a>
- <h3>PCA301</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PCA301'>PCA301</a><br/>
- </ul>
- <a name="PHILIPS_AUDIO"></a>
- <h3>PHILIPS_AUDIO</h3>
- <div class='langLinks'>[<a href='commandref.html#PHILIPS_AUDIO'>EN</a> DE]</div>
- <ul>
- <a name="PHILIPS_AUDIOdefine"></a>
- <b>Define</b><br><br>
- <ul>
- <code>
- define <name> PHILIPS_AUDIO <device model> <ip-address> [<status_interval>]<br><br>
- define <name> PHILIPS_AUDIO <device model> [<off_status_interval>] [<on_status_interval>]
- </code>
- <br><br>
- Mit Hilfe dieses Moduls lassen sich Philips Audio Netzwerk Player wie z.B. MCi, Streamium oder Fidelio im lokalen Netzwerk steuern.<br>
- Geräte, die über die myRemote App oder einen internen HTTP Server am Port 8889 sollten theoretisch ebenfalls bedient werden können.<br>
- (http://[ip Nummer des Gerätes]:8889/index)<br>
- <br>
- (Getestet mit: AW9000, NP3500, NP3700 und NP3900)
- <br><br>
- Beispiel:<br>
- <ul><br>
- <code>
- define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15
- <br>
- <br>
- # 60 Sekunden Intervall<br>
- define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15 <b>60</b>
- <br>
- <br>
- # 60 Sekunden Intervall für "off" und 10 Sekunden für "on"<br>
- define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15 <b>60 10</b>
- </code>
- <br><br>
- <i>Bemerkung: Aufgrund der relativ langsamen Verarbeitung von Befehlen durch den Player selbst wurde das minimale Intervall <b>auf 5 Sekunden limitiert</b>. Dadurch sollten potentielle Gerätefreezes reduziert werden.</i>
- </ul>
- </ul><br>
- <a name="PHILIPS_AUDIOset"></a>
- <b>Set</b>
- <ul>
- <code>
- set <name> <command> [<parameter>]
- </code>
- <br><br>
- <i>Bemerkung: Befehle und Parameter sind case-sensitive</i><br>
- <ul><br>
- <li><b>favoriteAdd</b> – Fügt den aktuellen Audiostream zu Favoriten hinzu</li>
- <li><b>favoriteRemove</b> – Löscht den aktuellen Audiostream aus den Favoriten</li>
- <li><b>getFavorites</b> – Liest aus die gespeicherten Favoriten aus dem Gerät (kann einige Zeit dauern...)</li>
- <li><b>getMediaRendererDesc</b> – Liest aus Gerätspezifische Informationen aus (siehe auch deviceInfo reading)</li>
- <li><b>getPresets</b> – Liest aus die gespeicherten Presets aus dem Gerät (kann einige Zeit dauern...)</li>
- <li><b>input</b> – Schaltet auf den folgenden Eingang</li>
- <ul>
- <li><b>analogAux</b> – AUX input (nur AW9000)</li>
- <li><b>digital1Coaxial</b> – digital coaxial input (nur AW9000)</li>
- <li><b>digital2Optical</b> – digital optical input (nur AW9000)</li>
- <li><b>internetRadio</b> – Internet Radio</li>
- <li><b>mediaLibrary</b> – Media Library (UPnP/DLNA server) (nicht verfügbar beim AW9000)</li>
- <li><b>mp3Link</b> – Analoger MP3 Link (nicht verfügbar beim AW9000)</li>
- <li><b>onlineServices</b> – Online Services</li>
- </ul>
- <li><b>mute [ on | off ]</b> – Stummschaltung (an/aus)</li>
- <li><b>player</b> – Player-Befehle</li>
- <ul>
- <li><b>next</b> – Nächstee Audiostream</li>
- <li><b>prev</b> – Letzter Audiostream</li>
- <li><b>play-pause</b> – Play/pause des aktuellen Audiostreams</li>
- <li><b>stop</b> – Stoppt das Abspielen des aktuellen Audiostreams</li>
- </ul>
- <li><b>repeat [ single | all | off]</b> – Stellt den repeat mode ein</li>
- <li><b>selectFavorite [ name ]</b> – Wählt einen Favoriten. Leer falls keine Favoriten vorhanden (s. getFavorites)</li>
- <li><b>selectFavoriteByNumber [ number ]</b> – Wählt einen Favoriten anhand seiner Speichernummer. Leer falls keine Favoriten vorhanden (s. getFavorites)</li>
- <li><b>selectPreset [ name ]</b> – Wählt einen Preset. Leer falls keine Presets vorhanden (s. getPresets)</li>
- <li><b>selectPresetByNumber [ number ]</b> – Wählt einen Preset anhand seiner Speichernummer. Leer falls keine Presets vorhanden (see also getPresets)</li>
- <li><b>selectStream [ name ]</b> – Context-sensitive. Wählt einen Audiostream. Hängt vom aktuellen Inhalt der Playerlist ab. Ein 'c'-Präfix repräsentiert einen 'Container' (Directory). ein 'i'-Präfix repräsentiert ein 'Item' (audio stream).</li></li>
- <li><b>shuffle [ on | off ]</b> – Wählt den gewünschten Shuffle Modus</li>
- <li><b>standbyButton</b> – Emuliert den standby-Knopf. Toggelt zwischen standby und power on</li>
- <li><b>volume</b> – Setzt die relative Lautstärke 0...100%</li>
- <li><b>volumeDown</b> – Setzt die Lautstärke um ein Dekrement herunter</li>
- <li><b>volumeStraight</b> – Setzt die devicespezifische Lautstärke 0...64</li>
- <li><b>volumeUp</b> – Setzt die Lautstärke um ein Inkrement herauf</li>
- </ul>
- </ul>
- <br>
- <a name="PHILIPS_AUDIOget"></a>
- <b>Get</b>
- <ul>
- <code>
- get <name> <reading> <reading name>
- </code>
- <ul>
- <br>
- <li><b>deviceInfo</b> – Liefert devicespezifische Information</li>
- <li><b>reading</b></li>
- <ul>
- <li><b>input</b> – Liefert den aktuellen Eingang oder '-' falls kein Audiostream aktiv</li>
- <li><b>listItem_xxx</b> – Liefert Einträge der Playerliste (limitiert auf 999 Einträge)</li>
- <li><b>networkError</b> – Liefert einen potentiellen Netzwerkfehler</li>
- <li><b>networkRequest</b> – Liefert die aktuelle Netzwerkaktivität (idle/busy)</li>
- <li><b>power</b> – Liefert den Power-Status (on/off)</li>
- <li><b>playerAlbum</b> – Liefert den Albumnamen des aktiven Audiostreams</li>
- <li><b>playerAlbumArt</b> – Liefert die Albumart des aktiven Audiostreams</li>
- <li><b>playerListStatus</b> – Liefert den aktuellen Zusatand der Playlist (busy/ready)</li>
- <li><b>playerListTotalCount</b> – Liefert die Anzahl der Playlisteinträge</li>
- <li><b>playerPlayTime</b> – Liefert die aktuell Audiostreamspieldauer</li>
- <li><b>playerPlaying</b> – Zeigt an, ob Audiostream abgespielt wird (yes/no)</li>
- <li><b>playerRadioStation</b> – Liefert den Stationsnamen des Radiosenders</li>
- <li><b>playerRadioStationInfo</b> – Liefert zusätzliche Informationen des Radiosenders</li>
- <li><b>playerRepeat</b> – Zeigt den Reapeat Mode an (off/single/all)</li>
- <li><b>playerShuffle</b> – Zeigt den aktuellen Shuffle mode an (on/off)</li>
- <li><b>playerState</b> – Zeigt den Playerzustand an (home/browsing/playing)</li>
- <li><b>playerStreamFavorite</b> – Zeigt an, ob aktueller Audiostream ein Favorit ist (yes/no)</li>
- <li><b>playerStreamRating</b> – Zeigt das rating des Audiostreams</li>
- <li><b>playerTitle</b> – Zeigt den Titel des Audiostreams an</li>
- <li><b>playerTotalTime</b> – Zeigt die Audiostreamdauer an</li>
- <li><b>presence</b> – Liefert den presence status (present/absent)</li>
- <li><b>state</b> – Lifert den aktuellen Gerätestatus (on/off)</li>
- <li><b>totalFavorites</b> – Liefert die Anzahl gepseicherter Favoriten (s. getFavorites)</li>
- <li><b>totalPresets</b> – Liefert die Anzahl gepseicherter Presets (see getPresets)</li>
- <li><b>volume</b> – Liefert die relative Lutstärke (0...100%)</li>
- <li><b>volumeStraight</b> – Liefert die devicespezifische Lautstärke (0...64)</li>
- </ul>
- </ul>
- <br>
- </ul>
- <a name="PHILIPS_AUDIOattr"></a>
- <b>Attribute</b><br><br>
- <ul>
- <ul>
- <li><b>autoGetFavorites</b> – Automatisches Auslesen der Favoriten beim Modulstart falls keine vorhanden (default off)</li>
- <li><b>autoGetPresets</b> – Automatisches Auslesen der Presets beim Modulstart falls keine vorhanden (default off)</li>
- <li><b>do_not_notify</b></li>
- <li><b>httpBufferTimeout</b> – Optionalles Attribut für den internen http buffer timeount (default 10 Sekunden)</li>
- <li><b>maxListItems</b> – Definiert die max. Anzahl der anzuzeigenden Playerlisteinträge (default 100)</li>
- <li><b>playerBrowsingTimeout</b> – Definiert den Inaktivitäts-Timeout beim Browsen der Playerlist. Nach diesem Timeout fällt das Modul in den "home"-State zurück. Die Playerreadings werden wieder aktualisiert (default 180 Sekunden)</li>
- <li><b>readingFnAttributes</b></li>
- <li><b>requestTimeout</b> – Optionalles Attribut für http responses (default 4 Sekunden)</li>
- </ul>
- </ul>
- </ul>
- <p><a name="PHTV"></a>
- <h3>PHTV</h3>
- <div class='langLinks'>[<a href='commandref.html#PHTV'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden.
- Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#PHTV'>PHTV</a>
- </ul>
- <p><a name="PID20"></a>
- <h3>PID20</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PID20'>PID20</a><br/>
- </ul>
- <a name="PIFACE"></a>
- <h3>PIFACE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PIFACE'>PIFACE</a><br/>
- </ul>
- <a name="PIONEERAVR"></a>
- <h3>PIONEERAVR</h3>
- <div class='langLinks'>[<a href='commandref.html#PIONEERAVR'>EN</a> DE]</div>
- <ul>
- Dieses Modul erlaubt es einen Pioneer AV Receiver via Fhem zu steuern (nur die MAIN-Zone, etwaige andere Zonen können mit dem Modul PIONEERAVRZONE gesteuert werden) wenn eine Datenverbindung via Ethernet oder RS232 hergestellt werden kann.
- Es erlaubt Fhem
- <ul>
- <li>Den Receiver ein/auszuschalten</li>
- <li>die Lautstärke zu ändern</li>
- <li>die Eingangsquelle auszuwählen</li>
- <li>und weitere Parameter zu kontrollieren</li>
- </ul>
- <br><br>
- Dieses Modul basiert auf der <a href="http://www.pioneerelectronics.com/StaticFiles/PUSA/Files/Home%20Custom%20Install/Elite%20&%20Pioneer%20FY14AVR%20IP%20&%20RS-232%207-31-13.zip">Pioneer documentation</a>
- und ist mit einem Pioneer AV Receiver VSX-923 von <a href="http://www.pioneer.de">Pioneer</a> getestet.
- <br><br>
- Achtung: Dieses Modul benötigt die Perl-Module Device::SerialPort oder Win32::SerialPort
- wenn die Datenverbindung via USB bzw. rs232 Port erfolgt.
- <br><br>
- Dieses Modul versucht
- <ul>
- <li>die Datenverbindung zwischen Fhem und Pioneer AV Receiver offen zu halten. Wenn die Verbindung abbricht, versucht das Modul
- einmal die Verbindung wieder herzustellen</li>
- <li>Daten vom/zum Pioneer AV Receiver dem Modul PIONEERAVRZONE (für die Kontrolle weiterer Zonen des Pioneer AV Receiver)
- zur Verfügung zu stellen.</li>
- </ul>
- Solange die Datenverbindung zwischen Fhem und dem Pioneer AV Receiver offen ist, kann kein anderes Gerät (z.B. ein Smartphone)
- auf dem gleichen Port eine Verbindung zum Pioneer AV Receiver herstellen.
- Einige Pioneer AV Receiver bieten mehr als einen Port für die Datenverbindung an. Pioneer empfiehlt Port 23 sowie 49152-65535, "Invalid number:00000,08102".
- <br><br>
- <a name="PIONEERAVRdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> PIONEERAVR telnet <IPAddress:Port></code><br><br>
- or<br><br>
- <code>define <name> PIONEERAVR serial <SerialDevice>[<@BaudRate>]</code>
- <br><br>
- Definiert ein Fhem device für einen Pioneer AV Receiver (Kommunikationsschnittstelle und Steuerung der Main - Zone). Die Schlüsselwörter <code>telnet</code> bzw.
- <code>serial</code> sind fix. Der Standard Port für die Ethernet Verbindung bei Pioneer AV Receiver ist 23
- (laut der oben angeführten Pioneer Dokumentation) - oder 8102 (laut Fhem-Forumsberichten).<br>
- Note: PIONEERAVRZONE-Devices zur Steuerung der Zone2, Zone3 und/oder HD-Zone werden per autocreate beim Eintreffen der ersten Nachricht für eine der Zonen erzeugt.
- <br><br>
- Beispiele:
- <ul>
- <code>define VSX923 PIONEERAVR telnet 192.168.0.91:23</code><br>
- <code>define VSX923 PIONEERAVR serial /dev/ttyS0</code><br>
- <code>define VSX923 PIONEERAVR serial /dev/ttyUSB0@9600</code><br>
- </ul>
- <br>
- </ul>
- <a name="PIONEERAVRset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <was> [<value>]</code>
- <br><br>
- "was" ist eines von
- <li><b>bass <-6 ... 6></b> - Bass von -6dB bis + 6dB (funktioniert nur wenn tone = on und der ListeningMode es erlaubt)</li>
- <li><b>channel <1 ... 9></b> - Setzt den Tuner Preset ("gespeicherten Sender"). Nur verfügbar, wenn Input = 2 (Tuner), wie in http://www.fhemwiki.de/wiki/DevelopmentGuidelinesAV beschrieben</li>
- <li><b>channelDown</b> - Setzt den nächst niedrigeren Tuner Preset ("gespeicherten Sender"). Wenn vorher channel = 2, so wird nachher channel = 1. Nur verfügbar, wenn Input = 2 (Tuner).</li>
- <li><b>channelStraight <A1...G9></b> - </li> Setzt den Tuner Preset ("gespeicherten Sender") mit Werten, wie sie im Display des Pioneer AV Receiver angezeigt werden (z.B. A1). Nur verfügbar, wenn Input = 2 (Tuner).
- <li><b>channelUp</b> - Setzt den nächst höheren Tuner Preset ("gespeicherten Sender"). Nur verfügbar, wenn Input = 2 (Tuner).</li>
- <li><b>down</b> - "Pfeiltaste nach unten". Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>enter</b> - "Eingabe" - Entspricht der "Enter-Taste" der Fernbedienung. Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>eq <on|off></b> - Schalten den Equalizer ein oder aus.</li>
- <li><b>fwd</b> - Schnellvorlauf. Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>hdmiOut <1+2|1|2|off></b> - Schaltet die HDMI-Ausgänge 1 und/oder 2 des Pioneer AV Receivers ein bzw. aus.</li>
- <li><b>input <nicht am Pioneer AV Receiver deaktivierte Eingangsquelle></b> - Schaltet die Eingangsquelle (z.B. CD, HDMI 1,...) auf die Ausgänge der Main-Zone. Die Liste der verfügbaren (also der nicht deaktivierten)
- Eingangsquellen wird beim Start von Fhem und auch mit <code>get <name> statusRequest</code> eingelesen. Wurden die Eingänge am Pioneer AV Receiver umbenannt, wird der neue Name des Eingangs angezeigt.</li>
- <li><b>inputDown</b> - vorherige Eingangsquelle der Main Zone auswählen</li>
- <li><b>inputUp</b> - nächste Eingangsquelle der Main Zone auswählen</li>
- <li><b>left</b> - "Pfeiltaste nach links". Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>listeningMode</b> - Setzt einen ListeningMode, z.B. autoSourround, direct, action,...</li>
- <li><b>mcaccMemory <1...6></b> - Setzt einen der bis zu 6 gespeicherten MCACC Einstellungen der Main Zone</li>
- <li><b>menu</b> - "Menu-Taste" der Fernbedienung. Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>mute <on|off|toggle></b> - Stummschalten der Main Zone des Pioneer AV Receivers. "mute = on" bedeutet: stumm</li>
- <li><b>networkStandby <on|off></b> - Schaltet Network standby ein oder aus. Um einen Pioneer AV Receiver mit diesem Modul aus dem Standby einzuschalten, muss Network Standby = on sein. Mit <code>set <name> networkStandby on</code> sollte sich das machen lassen.</li>
- <li><b>next</b> - für die gleichen Eingangsquellen wie "play"</li>
- <li><b>off</b> - Ausschalten der Main Zone in den Standby Modus.</li>
- <li><b>on</b> - Einschalten der Main Zone aus dem Standby Modus. Das funktioniert nur, wenn am Pioneer AV Receiver "Network Standby" "on" eingestellt ist. Siehe dazu auch "networkStandby" weiter unten.</li>
- <li><b>pause</b> - Unterbricht die Wiedergabe für die gleichen Eingangsquellen wie "play"</li>
- <li><b>play</b> - Startet die Wiedergabe für folgende Eingangsquellen:
- <ul>
- <li>usbDac</li>
- <li>ipodUsb</li>
- <li>xmRadio</li>
- <li>homeMediaGallery</li>
- <li>sirius</li>
- <li>adapterPort</li>
- <li>internetRadio</li>
- <li>pandora</li>
- <li>mediaServer</li>
- <li>favorites</li>
- <li>mhl</li>
- </ul>
- </li>
- <li><b>prev</b> - Wechselt zum vorherigen Titel. Für die gleichen Eingangsquellen wie "play".</li>
- <li><b>raw <PioneerKommando></b> - Sendet den Befehl <code><PioneerKommando></code> unverändert an den Pioneer AV Receiver. Eine Liste der verfügbaren Pioneer Kommandos ist in dem Link zur Pioneer Dokumentation oben enthalten</li>
- <li><b>remoteControl <attr></b> - wobei <attr> eines von folgenden sein kann:
- <ul>
- <li>cursorDown</li>
- <li>cursorRight</li>
- <li>cursorLeft</li>
- <li>cursorEnter</li>
- <li>cursorReturn</li>
- <li>homeMenu</li>
- <li>statusDisplay</li>
- <li>audioParameter</li>
- <li>hdmiOutputParameter</li>
- <li>videoParameter</li>
- <li>homeMenu</li>
- Simuliert die Tasten der Fernbedienung. Achtung: mit cursorXX können die Eingänge nicht beeinflusst werden -> set <name> up ... kann zur Steuerung der Inputs verwendet werden.
- </ul>
- </li>
- <li><b>reopen</b> - Versucht die Datenverbindung zwischen Fhem und dem Pioneer AV Receiver wieder herzustellen</li>
- <li><b>repeat</b> - Wiederholung für folgende Eingangsquellen: AdapterPort, Ipod, Favorites, InternetRadio, MediaServer. Wechselt zyklisch zwischen
- <ul>
- <li>keine Wiederholung</li>
- <li>Wiederholung des aktuellen Titels</li>
- <li>Wiederholung aller Titel</li>
- </ul>
- </li>
- <li><b>return</b> - "Zurück"... Entspricht der "Return-Taste" der Fernbedienung. Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>rev</b> - "Rückwärtssuchlauf". Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>right</b> - "Pfeiltaste nach rechts". Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>selectLine01 - selectLine08</b> - für die gleichen Eingangsquellen wie "play".Wird am Bildschirm ein Pioneer-Menu angezeigt, kann hiermit die gewünschte Zeile direkt angewählt werden</li>
- <li><b>shuffle</b> - Zufällige Wiedergabe für die gleichen Eingangsquellen wie "repeat". Wechselt zyklisch zwischen Zufallswiedergabe "ein" und "aus".</li>
- <li><b>signalSelect <auto|analog|digital|hdmi|cycle></b> - Setzt den zu verwendenden Eingang (bei Eingängen mit mehreren Anschlüssen) </li>
- <li><b>speakers <off|A|B|A+B></b> - Schaltet die Lautsprecherausgänge ein/aus.</li>
- <li><b>standingWave <on|off></b> - Schaltet Standing Wave der Main Zone aus/ein</li>
- <li><b>statusRequest</b> - Fragt Informationen vom Pioneer AV Receiver ab und aktualisiert die readings entsprechend</li>
- <li><b>stop</b> - Stoppt die Wiedergabe für die gleichen Eingangsquellen wie "play"</li>
- <li><b>toggle</b> - Ein/Ausschalten der Main Zone in/von Standby</li>
- <li><b>tone <on|bypass></b> - Schaltet die Klangsteuerung ein bzw. auf bypass</li>
- <li><b>treble <-6 ... 6></b> - Höhen (treble) von -6dB bis + 6dB (funktioniert nur wenn tone = on und der ListeningMode es erlaubt)</li>
- <li><b>up</b> - "Pfeiltaste nach oben". Für die gleichen Eingangsquellen wie "play"</li>
- <li><b>volume <0 ... 100></b> - Lautstärke der Main Zone in % der Maximallautstärke</li>
- <li><b>volumeDown</b> - Lautstärke der Main Zone um 0.5dB verringern</li>
- <li><b>volumeUp</b> - Lautstärke der Main Zone um 0.5dB erhöhen</li>
- <li><b>volumeStraight<-80.5 ... 12></b> - Direktes Einstellen der Lautstärke der Main Zone mit einem Wert, wie er am Display des Pioneer AV Receiver angezeigt wird</li>
- <li><a href="#setExtensions">set extensions</a> (ausser <code><blink></code> ) werden unterstützt</li>
- <br><br>
- Beispiel:
- <ul>
- <code>set VSX923 on</code><br>
- </ul>
- <br>
- <code>set <name> reopen</code>
- <br><br>
- Schließt und öffnet erneut die Datenverbindung von Fhem zum Pioneer AV Receiver.
- Kann nützlich sein, wenn die Datenverbindung nicht automatisch wieder hergestellt werden kann.
- <br><br>
- </ul>
- <a name="PIONEERAVRget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> raw <Befehl></code>
- <br><br>
- liefert bei diesem Modul keine Werte zurück, sondern fragt den Pioneer AVR nach dem aktuellen Status (z.B. der Lautstärke). Sobald der Pioneer AVR antwortet (die Zeit, bis der Pioneer AVR antwortet, ist nicht vorhersehbar), aktualisiert das Modul die Readings bzw. Internals des PioneerAVR devices.
- Falls unten keine Beschreibung für das "get-Kommando" angeführt ist, siehe gleichnamiges "Set-Kommando"
- <li><b>loadInputNames</b> - liest die Namen der Eingangsquellen vom Pioneer AV Receiver und überprüft, ob sie aktiviert sind</li>
- <li><b>audioInfo</b> - Holt die aktuellen Audio Parameter vom Pioneer AV receiver (z.B. audioInputSignal, audioInputFormatXX, audioOutputFrequency)</li>
- <li><b>display</b> - Aktualisiert das reading 'display' und 'displayPrevious' mit der aktuellen Anzeige des Displays Pioneer AV Receiver</li>
- <li><b>bass</b> - aktualisiert das reading 'bass'</li>
- <li><b>channel</b> - </li>
- <li><b>currentListIpod</b> - aktualisiert die readings currentAlbum, currentArtist, etc. </li>
- <li><b>currentListNetwork</b> - </li>
- <li><b>input</b> - </li>
- <li><b>listeningMode</b> - </li>
- <li><b>listeningModePlaying</b> - </li>
- <li><b>macAddress</b> - </li>
- <li><b>avrModel</b> - Versucht vom Pioneer AV Receiver die Modellbezeichnung (z.B. VSX923) einzulesen und im gleichnamigen INTERNAL abzuspeichern</li>
- <li><b>mute</b> - </li>
- <li><b>networkPorts</b> - Versucht vom Pioneer AV Receiver die offenen Ethernet Ports einzulesen und als INTERNAL networkPort1 ... networkPort4 abzuspeichern</li>
- <li><b>networkSettings</b> - Versucht vom Pioneer AV Receiver die Netzwerkparameter (IP, Gateway, Netmask, Proxy, DHCP, DNS1, DNS2) einzulesen und in INTERNALS abzuspeichern</li>
- <li><b>networkStandby</b> - Versucht vom Pioneer AV Receiver den Parameter networkStandby (kann on oder off sein) einzulesen und als INTERNAL abzuspeichern</li>
- <li><b>power</b> - Versucht vom Pioneer AV Receiver in Erfahrung zu bringen, ob die Main Zone eingeschaltet oder in Standby ist.</li>
- <li><b>signalSelect</b> - </li>
- <li><b>softwareVersion</b> - Fragt den Pioneer AV Receiver nach der aktuell im Receiver verwendeten Software Version und speichert diese als INTERNAL</li>
- <li><b>speakers</b> - </li>
- <li><b>speakerSystem</b> - Fragt die aktuell verwendete Lautsprecheranwendung vom Pioneer AV Receiver ab. Mögliche Werte sind z.B. "ZONE 2", "Normal(SB/FH)", "5.1ch C+Surr Bi-Amp",...</li>
- <li><b>tone</b> - </li>
- <li><b>tunerFrequency</b> - Fragt die aktuell eingestellte Frequenz des Tuners ab</li>
- <li><b>tunerChannelNames</b> - Sollten für die Tuner Presets Namen im Pioneer AV Receiver gespeichert sein, werden sie hiermit abgefragt</li>
- <li><b>treble</b> - </li>
- <li><b>volume</b> - </li>
- </ul>
- <br><br>
- <a name="PIONEERAVRattr"></a>
- <b>Attribute</b>
- <br><br>
- <ul>
- <li>
- <b>connectionCheck</b> 1..120,off Pingt den Pioneer AV Receiver alle X Sekunden um den Datenverbindungsstatus zu überprüfen. Standard: 60 Sekunden.
- </li>
- <li>
- <b> timeout</b> 1,2,3,4,5,7,10,15 Zeit in Sekunden, innerhalb der der Pioneer AV Receiver auf einen Ping antwortet. Standard: 3 Sekunden.
- </li>
- <li>
- <b>statusUpdateStart <enable|disable></b> - Ein-/Ausschalten des Status Updates (lesen aller Parameter vom Pioneer AV Receiver, dauert bis zu einer Minute) beim Start des Moduls.
- Mit "disable" lässt sich das Status Update abschalten, FHEM startet schneller, das Pioneer Modul zeigt eventuell nicht korrekte readings.
- </li>
- <li><b>statusUpdateReconnect <enable|disable></b> - Ein-/Ausschalten des Status Updates (lesen aller Parameter vom Pioneer AV Receiver, dauert bis zu einer Minute) nach dem Wiederherstellen der Datenverbindung zum Pioneer AV Receiver.
- Mit "disable" lässt sich das Status Update abschalten, FHEM bleibt reaktiver beim reconnect, das Pioneer Modul zeigt eventuell nicht korrekte readings.</li>
- <li><b>logTraffic <loglevel></b> - Ermöglicht das Protokollieren ("Loggen") der Datenkommunikation vom/zum Pioneer AV Receiver.
- Steuerzeichen werden angezeigt z.B. ein doppelter Rückwärts-Schrägstrich wird als einfacher Rückwärts-Schrägstrich angezeigt,
- \n wird für das Steuerzeichen "line feed" angezeigt, etc.</li>
- <li><b><a href="#verbose">verbose</a></b> - Beeinflusst die Menge an Informationen, die dieses Modul protokolliert. 0: möglichst wenig in die Fhem Logdatei schreiben, 5: möglichst viel in die Fhem Logdatei schreiben</li>
- <li><b>volumeLimit <0 ... 100></b> - beschränkt die maximale Lautstärke (in %). Selbst wenn manuell am Pioneer AV Receiver eine höher Lautstärke eingestellt wird, regelt Fhem die Lautstärke auf volumeLimit zurück.</li>
- <li><b>volumeLimitStraight < -80 ... 12></b> - beschränkt die maximale Lautstärke (Werte wie am Display des Pioneer AV Receiver angezeigt). Selbst wenn manuell am Pioneer AV Receiver eine höher Lautstärke eingestellt wird, regelt Fhem die Lautstärke auf volumeLimit zurück.</li>
- </ul>
- <br><br>
- <b>Generated Readings/Events:</b>
- <br/><br/>
- <ul>
- <li><b>audioAutoPhaseControlMS</b> - aktuell konfigurierte Auto Phase Control in ms</li>
- <li><b>audioAutoPhaseControlRevPhase</b> - aktuell konfigurierte Auto Phase Control reverse Phase -> 1 bedeutet: reverse phase</li>
- <li><b>audioInputFormat<XXX></b> - Zeigt ob im Audio Eingangssignal der Kanal XXX vorhanden ist (1 bedeutet: ist vorhanden)</li>
- <li><b>audioInputFrequency</b> - Frequenz des Eingangssignals</li>
- <li><b>audioInputSignal</b> - Art des Inputsignals (z.B. ANALOG, PCM, DTS,...)</li>
- <li><b>audioOutputFormat<XXX></b> - Zeigt ob im Audio Ausgangssignal der Kanal XXX vorhanden ist (1 bedeutet: ist vorhanden)</li>
- <li><b>audioOutputFrequency</b> - Frequenz des Ausgangssignals</li>
- <li><b>bass</b> - aktuell konfigurierte Bass-Einstellung</li>
- <li><b>channel</b> - Tuner Preset (1...9)</li>
- <li><b>channelStraight</b> - Tuner Preset wie am Display des Pioneer AV Receiver angezeigt, z.B. A2</li>
- <li><b>display</b> - Text, der aktuell im Display des Pioneer AV Receivers angezeigt wird</li>
- <li><b>displayPrevious</b> - Zuletzt im Display angezeigter Text</li>
- <li><b>eq</b> - Status des Equalizers des Pioneer AV Receivers (on|off)</li>
- <li><b>hdmiOut</b> - welche HDMI-Ausgänge sind aktiviert?</li>
- <li><b>input</b> - welcher Eingang ist ausgewählt</li>
- <li><b>inputsList</b> - Mit ":" getrennte Liste der aktivierten/verfügbaren Eingänge</li>
- <li><b>listeningMode</b> - Welcher Hörmodus (Listening Mode) ist eingestellt</li>
- <li><b>listeningModePlaying</b> - Welcher Hörmodus (Listening Mode) wird aktuell verwendet</li>
- <li><b>mcaccMemory</b> - MCACC Voreinstellung</li>
- <li><b>mute</b> - Stummschaltung</li>
- <li><b>power</b> - Main Zone eingeschaltet oder in Standby?</li>
- <li><b>pqlsWorking</b> - aktuelle PQLS Einstellung</li>
- <li><b>presence</b> - Kann der Pioneer AV Receiver via Ethernet erreicht werden?</li>
- <li><b>screenHirarchy</b> - Hierarchie des aktuell angezeigten On Screen Displays (OSD)</li>
- <li><b>screenLine01...08</b> - Inhalt der Zeile 01...08 des OSD</li>
- <li><b>screenLineHasFocus</b> - Welche Zeile des OSD hat den Fokus?</li>
- <li><b>screenLineNumberFirst</b> - Lange Listen werden im OSD zu einzelnen Seiten mit je 8 Zeilen angezeigt. Die oberste Zeile im OSD repräsentiert welche Zeile in der gesamten Liste?</li>
- <li><b>screenLineNumberLast</b> - Lange Listen werden im OSD zu einzelnen Seiten mit je 8 Zeilen angezeigt. Die unterste Zeile im OSD repräsentiert welche Zeile in der gesamten Liste?</li>
- <li><b>screenLineNumbersTotal</b> - Wie viele Zeilen hat die im OSD anzuzeigende Liste insgesamt?</li>
- <li><b>screenLineNumbers</b> - Wie viele Zeilen hat das OSD</li>
- <li><b>screenLineType01...08</b> - Welchen Typs ist die Zeile 01...08? Z.B. "directory", "Now playing", "current Artist",...</li>
- <li><b>screenName</b> - Name des OSD</li>
- <li><b>screenReturnKey</b> - Steht die "Return-Taste" in diesem OSD zur Verfügung?</li>
- <li><b>screenTopMenuKey</b> - Steht die "Menu-Taste" in diesem OSD zur Verfügung?</li>
- <li><b>screenToolsKey</b> - Steht die "Tools-Taste" (Menu, Edit, iPod control) in diesem OSD zur Verfügung?</li>
- <li><b>screenType</b> - Typ des OSD, z.B. "message", "List", "playing(play)",...</li>
- <li><b>speakerSystem</b> - Zeigt, wie die hinteren Surround-Lautsprecheranschlüsse und die B-Lautsprecheranschlüsse verwendet werden</li>
- <li><b>speakers</b> - Welche Lautsprecheranschlüsse sind aktiviert?</li>
- <li><b>standingWave</b> - Einstellung der Steuerung stark resonanter tiefer Frequenzen im Hörraum</li>
- <li>
- <b>state</b> - Wird beim Verbindungsaufbau von Fhem mit dem Pioneer AV Receiver gesetzt. Mögliche Werte sind disconnected, innitialized, off, on, opened
- </li>
- <li>
- <b>stateAV</b> - Status aus der Sicht des USers: Kombiniert die readings presence, power, mute und playStatus zu einem Status (on|off|absent|stopped|playing|paused|fast-forward|fast-rewind).
- </li>
- <li><b>tone</b> - Ist die Klangsteuerung eingeschalten?</li>
- <li><b>treble</b> - Einstellung des Höhenreglers</li>
- <li><b>tunerFrequency</b> - Tunerfrequenz</li>
- <li><b>volume</b> - Eingestellte Lautstärke (0%-100%)</li>
- <li><b>volumeStraight</b> - Eingestellte Lautstärke, so wie sie auch am Display des Pioneer AV Receivers angezeigt wird</li>
- </ul>
- <br/><br/>
- </ul>
- <p><a name="PIONEERAVRZONE"></a>
- <h3>PIONEERAVRZONE</h3>
- <div class='langLinks'>[<a href='commandref.html#PIONEERAVRZONE'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="PIONEERAVRZONEdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> PIONEERAVRZONE <zone> </code>
- <br><br>
- Definiert ein PioneerAVR device für eine Zone Zone (zone2, zone3 or hdZone).<p>
-
- Im Allgemeinen verwendet das logische device PIONEERAVRZONE das zuletzt definierte PIONEERAVR device für die Kommunikation mit dem Pioneer AV Receiver.
- Mit dem Atribut <code>IODev</code> kann das PIONEERAVRZONE device jedes PIONEERAVR device zur Kommunikation verwenden,
- z.B. <code>attr myPioneerAvrZone2 IODev myPioneerAvr</code>.
- <br><br>
- Examples:
- <ul>
- <code>define myPioneerAvrZone2 PIONEERAVRZONE zone2</code><br>
- <code>attr myPioneerAvrZone2 IODev myPIONEERAVR</code>
- </ul>
- <br>
- </ul>
- <a name="PIONEERAVRZONEset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <was> [<value>]</code>
- <br><br>
- wobei <was> eines der folgenden Befehle sein kann:
- <li>reopen</li>
- <li>off <br>Zone in den Standby-Modus schalten</li>
- <li>on <br>Zone aus dem Standby-Modus Einschalten</li>
- <li>toggle <br>Zone Ein/Ausschalten</li>
- <li>volume <0 ... 100><br>Zonenlautstärke in % der maximalen Lautstärke</li>
- <li>volumeUp<br>Zonenlautstärke um 0.5dB erhöhen</li>
- <li>volumeDown<br>Zonenlautstärke um 0.5dB verringern</li>
- <li>volumeStraight<-80.5 ... 12><br>Einstellen der Zonenlautstärke mit einem Wert, wie er am Display des Pioneer AV Receiver angezeigt wird</li>
- <li>mute <on|off|toggle></li>
- <li>input <nicht am Pioneer AV Receiver deaktivierte Eingangsquelle><br> Die Liste der verfügbaren (also der nicht deaktivierten)
- Eingangsquellen wird beim Start von Fhem und auch mit <code>get <name> statusRequest</code> eingelesen</li>
- <li>inputUp<br>nächste Eingangsquelle für die Zone auswählen</li>
- <li>inputDown<br>vorherige Eingangsquelle für die Zone auswählen</li>
- <li><a href="#setExtensions">set extensions</a> (ausser <code><name></code>) werden unterstützt</li>
-
- <br><br>
- Beispiel:
- <ul>
- <code>set VSX923Zone2 on</code><br>
- </ul>
- <br><br>
- </ul>
- <a name="PIONEERAVRZONEget"></a>
- <b>Get</b>
- <ul>
- <li><code>get <name> input</code>
- <br><br>
- reading für die Eingangsquelle aktualisieren
- </li>
- </ul>
- <br><br>
- <a name="PIONEERAVRattr"></a>
- <b>Attributes</b>
- <br><br>
- <ul>
- <li>IOdev Name des device welches die Kommunikation mit dem Pioneer AV Receiver zur Verfügung stellt</li>
- <li><a href="#verbose">verbose</a></li>
- </ul>
- <br><br>
- </ul>
- <p><a name="PLAYBULB"></a>
- <h3>MiPow Playbulb</h3>
- <div class='langLinks'>[<a href='commandref.html#PLAYBULB'>EN</a> DE]</div>
- <p><span style="text-decoration: underline;"><strong>PLAYBULB -Smart Light von MIPOW.COM</strong></span></p>
- <p>Dieses Modul integriert diverse Smart Leuchten von MIPOW in FHEM und zeigt ihre Einstellungen an.</p>
- <p> </p>
- <p><a name="PLAYBULBdefine"></a><strong>Define</strong><br /><code>define <name> PLAYBULB <MAC-ADDRESS></code></p>
- <p>Beispiel: <code>define PlaybulbCandle PLAYBULB 0B:0B:0C:D0:E0:F0</code></p>
- <p> </p>
- <p>Mit diesem Kommando wird ein neues PLAYBULB Device im Raum PLAYBULB angelegt. Der Parameter <MAC-ADDRESS> definiert die Bluetooth MAC Address der Mipow Smart Leuchte.</p>
- <p> </p>
- <p style="padding-left: 90px;"><strong>Vorbedingungen</strong>: Es wird ein Bluetooth LE 4.0 Stick, sowie eine funktionierende bluez Installation oder aehnlich vorausgesetzt. (Eine gute Anleitung findedsich hier: <a href="http://www.elinux.org/RPi_Bluetooth_LE)">http://www.elinux.org/RPi_Bluetooth_LE)</a></p>
- <p style="padding-left: 90px;">Derzeit sieht es so aus, als ob die Devices nur eine aktive Verbindung akzeptieren.</p>
- <p><br /><a name="PLAYBULBreadings"></a><strong>Readings</strong></p>
- <ul>
- <ul>
- <ul>
- <li>battery - Batterielevel in Prozent</li>
- <li>color - Zeigt an ob der Farbmodus an oder aus ist</li>
- <li>devicename - Geraetename</li>
- <li>effect - Zeigt an, welcher effect ausgewaehlt ist: (Flash; Pulse; RainbowJump; RainbowFade; Candle; none)</li>
- <li>onoff - Zeigt an, ob das Geraet an (1) oder aus (0) ist</li>
- <li>rgb - Zeigt die gewaehlte Farbe in HEX vom Typ rgb (Beispiel: FF0000 ist satt rot)</li>
- <li>sat - Zeigt die gewaehlte Saettigung von 0 bis 255 (scheint invertiert zu sein; 0 ist volle Saettigung)</li>
- <li>speed - Zeigt die gewaehlte Effektgeschwindigkeit (moeglich sind: 20; 70; 120; 170)</li>
- <li>state - Aktueller Zustand des Devices</li>
- </ul>
- </ul>
- </ul>
- <p><a name="PLAYBULBset"></a><strong>Set</strong></p>
- <ul>
- <ul>
- <ul>
- <li>on - Schaltet das Geraet ein</li>
- <li>off - Schaltet das Geraet aus</li>
- <li>rgb - Farbwaehler,RGB; ermoeglicht jede Farbe, Saettigung und Helligkeit einzustellen</li>
- <li>sat - Schieber zur Einstellung der Saettigungvon 0 bis 255, Schrittweite 5</li>
- <li>effect - Flash,Pulse,RainbowJump,RainbowFade,Candle,none; aktiviert den gewaehlten Effekt</li>
- <li>speed - Schieberegler: Werte sind 170, 120, 70, 20</li>
- <li>color - on,of; Schaltet das Geraet auf RGB oder weiss</li>
- <li>statusRequest - Ist notwendig, um den Zustand des Geraetes abzufragen</li>
- <li>deviceName - Aendert den Namen des Bluetoothdevice z.B. "PlaybulbCandle"</li>
- </ul>
- </ul>
- </ul>
- <p><br /><strong>Get na</strong></p>
- <p> </p>
- <p><strong>Attributes </strong></p>
- <ul>
- <ul>
- <ul>
- <li>model<br />BTL300_v5 # Candle Firmware 5<br />BTL300_v6 # Candle Firmware 6<br />BTL201_v2 # Smart<br />BTL201M_V16 # Smart (1/2017)<br />BTL505_v1 # Stripe<br />BTL400M_v18 # Garden<br />BTL100C_v10 # Color LED</li>
- <li>sshHost - IP oder FQDN für SSH remote Kontrolle</li>
- </ul>
- </ul>
- </ul>
- <p><br /><a name="PLAYBULBstate"></a><strong>state</strong></p>
- <ul>
- <ul>
- <ul>
- <li>set attribut model - wird nach der Erstdefinition angezeigt</li>
- <li>on - Device ist an</li>
- <li>off - Device ist aus</li>
- <li>unreachable - Verbindung zum device verloren</li>
- </ul>
- </ul>
- </ul>
- <p><br /><br /><br /><span style="text-decoration: underline;"><strong>Weitere Beispiel und readings:</strong></span><br /><a href="https://forum.fhem.de/index.php/topic,60829.msg522226.html#msg522226">Forum thread</a></p>
- <p> </p>
- <p><a name="POKEYS"></a>
- <h3>POKEYS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#POKEYS'>POKEYS</a><br/>
- </ul>
- <a name="PRESENCE"></a>
- <h3>PRESENCE</h3>
- <div class='langLinks'>[<a href='commandref.html#PRESENCE'>EN</a> DE]</div>
- <ul>
- Das PRESENCE Module bietet mehrere Möglichkteiten um die Anwesenheit von Handys/Smartphones oder anderen mobilen Geräten (z.B. Tablets) zu erkennen.
- <br><br>
- Dieses Modul bietet dazu mehrere Modis an um Anwesenheit zu erkennen. Diese sind:<br><br>
- <ul>
- <li><b>lan-ping</b> - Eine Erkennung auf Basis von Ping-Tests im lokalen LAN/WLAN</li>
- <li><b>fritzbox</b> - Eine Erkennung aufgrund der internen Abfrage des Status auf der FritzBox (nur möglich, wenn FHEM auf einer FritzBox läuft)</li>
- <li><b>local-bluetooth</b> - Eine Erkennung auf Basis von Bluetooth-Abfragen durch den FHEM Server. Das Gerät muss dabei in Empfangsreichweite sein, aber nicht sichtbar sein</li>
- <li><b>function</b> - Eine Erkennung mithilfe einer selbst geschriebenen Perl-Funktion, welche den Anwesenheitsstatus ermittelt.</li>
- <li><b>shellscript</b> - Eine Erkennung mithilfe eines selbst geschriebenen Skriptes oder Programm (egal in welcher Sprache).</li>
- <li><b>event</b> - Eine Erkennung basierend auf Events einer anderen Definition in FHEM. </li>
- <li><b>lan-bluetooth</b> - Eine Erkennung durch Bluetooth-Abfragen via Netzwerk (LAN/WLAN) in ein oder mehreren Räumen</li>
- </ul>
- <br>
- Jeder Modus kann optional mit spezifischen Prüf-Intervallen ausgeführt werden.<br><br>
- <ul>
- <li>check-interval - Das normale Prüfinterval in Sekunden für eine Anwesenheitsprüfung. Standardwert: 30 Sekunden</li>
- <li>present-check-interval - Das Prüfinterval in Sekunden, wenn ein Gerät anwesend (<i>present</i>) ist. Falls nicht angegeben, wird der Wert aus check-interval verwendet</li>
- </ul>
- <br><br>
- <a name="PRESENCE_define"></a>
- <b>Define</b><br><br>
- <ul><b>Modus: lan-ping</b><br><br>
- <code>define <name> PRESENCE lan-ping <IP-Addresse oder Hostname> [ <Interval> [ <Anwesend-Interval> ] ]</code><br>
- <br>
- Prüft ob ein Gerät über Netzwerk (üblicherweise WLAN) auf Ping-Anfragen reagiert und setzt entsprechend den Anwesenheitsstatus.<br><br>
- <u>Beispiel</u><br><br>
- <code>define iPhone PRESENCE lan-ping 192.168.179.21</code><br><br>
- <b>Modus: fritzbox</b><br><br>
- <code>define <name> PRESENCE fritzbox <Gerätename/MAC-Adresse> [ <Interval> [ <Anwesend-Interval> ] ]</code><br>
- <br>
- Prüft ob ein Gerät welches per WLAN mit der FritzBox verbunden ist, erreichbar durch Abfrage des Status mit dem Befehl ctlmgr_ctl.
- Der Gerätename (Parameter: <Gerätename>) muss dem Namen entsprechen, welcher im Menüpunkt "Heimnetz" auf der FritzBox-Oberfläche angezeigt wird oder kann durch die MAC-Adresse im Format XX:XX:XX:XX:XX:XX ersetzt werden.<br><br>
- <i>Dieser Modus ist nur verwendbar, wenn FHEM auf einer FritzBox läuft! Die Erkennung einer Abwesenheit kann ca. 10-15 Minuten dauern!</i><br><br>
- <u>Beispiel</u><br><br>
- <code>define iPhone PRESENCE fritzbox iPhone-6</code><br>
- <code>define iPhone PRESENCE fritzbox 00:06:08:05:0D:00</code><br><br>
- <b>Modus: local-bluetooth</b><br><br>
- <code>define <name> PRESENCE local-bluetooth <Bluetooth-Adresse> [ <Interval> [ <Anwesend-Interval> ] ]</code><br>
- <br>
- Prüft ob ein Bluetooth-Gerät abgefragt werden kann und meldet dies als Anwesenheit. Für diesen Modus wird der Shell-Befehl "hcitool" benötigt
- (wird durch das Paket <a href="http://www.bluez.org" target="_new">bluez</a> bereitgestellt), sowie ein funktionierender Bluetooth-Empfänger (intern oder als USB-Stick)<br><br>
- <u>Beispiel</u><br><br>
- <code>define iPhone PRESENCE local-bluetooth 0a:4f:36:d8:f9:8</code><br><br>
- <b>Modus: function</b><br><br>
- <code>define <name> PRESENCE function {...} [ <Interval> [ <Anwesend-Interval> ] ]</code><br>
- <br>
- Prüft den Anwesenheitsstatus mithilfe einer selbst geschriebenen Perl-Funktion (z.B. SNMP Abfrage).<br><br>
- Diese Funktion muss 0 (Abwesend) oder 1 (Anwesend) zurückgeben. Ein entsprechendes Beispiel findet man im <a href="http://www.fhemwiki.de/wiki/Anwesenheitserkennung" target="_new">FHEM-Wiki</a>.<br><br>
- <u>Beispiel</u><br><br>
- <code>define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")</code><br><br>
- <b>Mode: shellscript</b><br><br>
- <code>define <name> PRESENCE shellscript "<Skript-Pfad> [<arg1>] [<argN>]..." [ <Interval> [ <Anwesend-Interval> ] ]</code><br>
- <br>
- Prüft den Anwesenheitsstatus mithilfe eines selbst geschrieben Skripts oder Programmes (egal in welcher Programmier-/Skriptsprache)<br><br>
- Der Aufruf dieses Skriptes muss eine 0 (Abwesend) oder 1 (Anwesend) auf der <u>Kommandozeile (STDOUT)</u> ausgeben. Alle anderen Werte/Ausgaben werden als Fehler behandelt.<br><br>
- <u>Beispiel</u><br><br>
- <code>define iPhone PRESENCE shellscript "/opt/check_device.sh iPhone"</code><br><br>
- <b>Mode: event</b><br><br>
- <code>define <name> PRESENCE event <Abwesend-Regexp> <Anwesend-Regexp></code><br>
- <br>
- Lauscht auf Events von anderen Definitionen innerhalb von FHEM um die Anwesenheit darzustellen.
- Die regulären Ausdrücke für An- und Abwesenheit entsprechen dabei der Syntax von <a href="#notify">notify</a>.<br><br>
- Sobald innerhalb von FHEM ein Event gefeuert wird, welches auf die Abwesend-Regexp bzw. Anwesend-Regexp passt, wird der Status entsprechend in PRESENCE gesetzt.<br><br>
- <u>Beispiel</u><br><br>
- <code>define Anwesenheit PRESENCE event Tuerschalter:off Tuerschalter:on</code><br><br>
- <b>Modus: lan-bluetooth</b><br><br>
- Prüft ein Bluetooth-Gerät auf Anwesenheit über Netzwerk mit Hilfe von presenced oder collectord. Diese können auf jeder Maschine installiert werden,
- welche eine Standard-Perl-Umgebung bereitstellt und über Netzwerk erreichbar ist.
- <br>
- <br>
- <code>define <name> PRESENCE lan-bluetooth <Bluetooth-Adresse> <IP-Adresse>[:Port] [ <Interval> ]</code><br>
- <br>
- Der Standardport ist 5111 (presenced). Alternativ kann man den Port 5222 (collectord) nutzen. Generell ist der Port aber frei wählbar.<br><br>
- <u>Beispiel</u><br><br>
- <code>define iPhone PRESENCE lan-bluetooth 0a:4f:36:d8:f9:89 127.0.0.1:5222</code><br><br>
- <u>presenced</u><br><br>
- <ul>Der presenced ist ein Perl Netzwerkdienst, welcher eine Bluetooth-Anwesenheitserkennung von ein oder mehreren Geräten über Netzwerk bereitstellt.
- Dieser lauscht standardmäßig auf TCP Port 5111 nach eingehenden Verbindungen von dem PRESENCE Modul oder einem collectord.<br>
- <PRE>
- Usage:
- presenced -d [-p <port>] [-P <filename>]
- presenced [-h | --help]
- Options:
- -p, --port
- TCP Port which should be used (Default: 5111)
- -P, --pid-file
- PID file for storing the local process id (Default: /var/run/presenced.pid)
- -d, --daemon
- detach from terminal and run as background daemon
- -v, --verbose
- Print detailed log output
- -h, --help
- Print detailed help screen
- </PRE>
- Zur Bluetooth-Abfrage wird der Shell-Befehl "hcitool" verwendet (Paket: <a href="http://www.bluez.org" target="_new">bluez</a>)
- um sogenannte "Paging-Request" an die gewünschte Bluetooth Adresse (z.B. 01:B4:5E:AD:F6:D3) durchzuführen. Das Gerät muss dabei nicht sichtbar sein, allerdings ständig aktiviert sein
- um Bluetooth-Anfragen zu beantworten.
- <br><br>
- Wenn ein Gerät anwesend ist, wird dies an FHEM übermittelt zusammen mit dem Gerätenamen als Reading.<br><br>
- Der presenced ist zum Download verfügbar als:<br><br>
- <ul>
- <li>Perl Skript: <a href="https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/presenced" target="_new">presenced</a></li>
- <li>.deb Paket für Debian/Raspbian (architekturunabhängig): <a href="https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/presenced-1.5.deb" target="_new">presenced-1.5.deb</a></li>
- </ul>
- </ul><br><br>
- <u>lepresenced</u><br><br>
- <ul>lepresenced ist ein Perl Netzwerkdienst, der analog zu presenced eine
- Bluetooth-Anwesenheitserkennung von ein oder mehreren Geräten
- über Netzwerk bereitstellt. Im Gegensatz zu presenced unterstützt
- lepresenced <u>Bluetooth 4.0 (Low Energy) Geräte wie z. B. Gigaset G-Tags,
- FitBit Charges.</u>
- lepresenced lauscht standardmäßig auf TCP Port 5333 und wartet
- auf eingehende Verbindungen des PRESENCE-Moduls bzw. von collectord.<br>
- <PRE>
- Usage:
- lepresenced --bluetoothdevice <bluetooth device> --listenaddress <listen address> --listenport <listen port> --loglevel <log level> --daemon
- lepresenced -b <bluetooth device> -a <listen address> -p <listen port> -l <log level> -d
- valid log levels:
- LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG. Default: LOG_INFO
- Examples:
- lepresenced --bluetoothdevice hci0 --listenaddress 127.0.0.1 --listenport 5333 --daemon
- lepresenced --loglevel LOG_DEBUG --daemon
- </PRE>
- Zur Bluetooth-Abfrage wird der Befehl <i>hcitool lescan</i> (Paket:
- <a href="http://www.bluez.org" target="_new">bluez</a>) verwendet, der
- fortwährend auf die Beacons der Bluetooth-LE-Geräte lauscht.
- <br><br>
- Wenn ein Gerät anwesend ist, wird dies an FHEM übermittelt zusammen mit dem Gerätenamen als Reading.<br><br>
- Der le presenced ist zum Download verfügbar als:<br><br>
- <ul>
- <li>Perl Skript: <a href="https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/lepresenced" target="_new">lepresenced</a></li>
- <li>.deb Paket (architekturunabhängig) unter <a href="https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/" target="_new">contrib/PRESENCE/deb/</a></li>
- </ul>
- </ul><br><br>
- <u>collectord</u><br><br>
- <ul>
- Der collectord ist ein Perl Netzwerk Dienst, welcher Verbindungen zu mehreren presenced-Instanzen verwaltet um eine koordinierte Suche nach ein oder mehreren Bluetooth-Geräten über Netzwerk durchzuführen.<br><br>
- Er lauscht auf TCP port 5222 nach eingehenden Verbindungen von einem PRESENCE Modul.
- <PRE>
- Usage:
- collectord -c <configfile> [-d] [-p <port>] [-P <pidfile>]
- collectord [-h | --help]
- Options:
- -c, --configfile <configfile>
- The config file which contains the room and timeout definitions
- -p, --port
- TCP Port which should be used (Default: 5222)
- -P, --pid-file
- PID file for storing the local process id (Default: /var/run/collectord.pid)
- -d, --daemon
- detach from terminal and run as background daemon
- -v, --verbose
- Print detailed log output
- -l, --logfile <logfile>
- log to the given logfile
- -h, --help
- Print detailed help screen
- </PRE>
- Bevor der collectord verwendet werden kann, benötigt er eine Konfigurationsdatei in welcher alle Räume mit einem presenced-Agenten eingetragen sind. Diese Datei sieht wie folgt aus:
- <br><br>
- <PRE>
- # Raum Definitionen
- # =================
- #
- [Raum-Name] # Name des Raumes
- address=192.168.0.10 # IP-Adresse oder Hostname
- port=5111 # TCP Port welcher benutzt werden soll (standardmäßig 5111)
- presence_timeout=120 # Prüfinterval in Sekunden für jede Abfrage eines Gerätes, welches anwesend ist
- absence_timeout=20 # Prüfinterval in Sekunden für jede Abfrage eines Gerätes, welches abwesend ist
- [Wohnzimmer]
- address=192.168.0.11
- port=5111
- presence_timeout=180
- absence_timeout=20
- </PRE>
- <br>
- Wenn ein Gerät in irgend einem Raum anwesend ist, wird dies an FHEM übermittelt, zusammen mit dem Gerätenamen und dem Raum, in welchem das Gerät erkannt wurde.<br><br>
- Der collectord ist zum Download verfügbar als:<br><br>
- <ul>
- <li>Perl Skript: <a href="https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/collectord" target="_new">collectord</a></li>
- <li>.deb Paket für Debian (architekturunabhängig): <a href="https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/collectord-1.8.1.deb" target="_new">collectord-1.8.1.deb</a></li>
- </ul>
- </ul>
- </ul>
- <br>
- <a name="PRESENCE_set"></a>
- <b>Set</b>
- <ul>
- <li><b>statusRequest</b> - Startet einen sofortigen Check.</li>
- <li><b>power</b> - Startet den powerCmd-Befehl welche durch den Parameter powerCmd angegeben ist (Nur wenn das Attribut "powerCmd" definiert ist)</li>
- <li><b>overrideInterval</b> - Übersteuert das Prüfinterval auf die übergebene Dauer in Sekunden (Nicht im Modus "event" und "lan-bluetooth" anwendbar)</li>
- <li><b>clearOverride</b> - Entfernt eine zuvor gesetzte Übersteuerung des Prüfintervals (Nur anwendbar, wenn zuvor eine Übersteuerung mit dem Set-Befehl overrideInterval stattgefunden hat)</li>
- </ul>
- <br>
- <a name="PRESENCE_get"></a>
- <b>Get</b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="PRESENCE_attr"></a>
- <b>Attributes</b><br><br>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="PRESENCE_disable">disable</a></li>
- Wenn dieses Attribut aktiviert ist, wird die Anwesenheitserkennung nicht mehr durchgeführt.<br><br>
- Mögliche Werte: 0 => Erkennung durchführen , 1 => Keine Erkennungen durchführen<br>
- Standardwert ist 0 (Erkennung durchführen)<br><br>
- <li><a name="PRESENCE_absenceThreshold">absenceThreshold</a></li> <i>(Nicht im Modus "event" anwendbar)</i><br>
- Die Anzahl an Checks, welche in "absent" resultieren müssen, bevor der Status der PRESENCE-Definition auf "absent" wechselt.
- Mit dieser Funktion kann man die Abwesenheit eines Gerätes verifizieren bevor der Status final auf "absent" geändert wird.
- Wenn dieses Attribut auf einen Wert >1 gesetzt ist, werden die Readings "state" und "presence" auf den Wert "maybe absent" gesetzt,
- bis der Status final auf "absent" wechselt.<br><br>
- Standardwert ist 1 (keine Abwesenheitsverifizierung)<br><br>
- <li><a name="PRESENCE_presenceThreshold">presenceThreshold</a></li> <i>(Nicht im Modus "event" anwendbar)</i><br>
- Die Anzahl an Checks, welche in "present" resultieren müssen, bevor der Status der PRESENCE-Definition auf "present" wechselt.
- Mit dieser Funktion kann man die Anwesenheit eines Gerätes verifizieren bevor der Status final auf "present" geändert wird.
- Wenn dieses Attribut auf einen Wert >1 gesetzt ist, werden die Readings "state" und "presence" auf den Wert "maybe present" gesetzt,
- bis der Status final auf "present" wechselt.<br><br>
- Standardwert ist 1 (keine Anwesenheitsverifizierung)<br><br>
- <li><a name="PRESENCE_absenceTimeout">absenceTimeout</a></li> <i>(Nur im Modus "event" anwendbar)</i><br>
- Die Dauer, die nach einem "absent"-Event gewartet werden soll, bis der Status der PRESENCE-Definition tatsächlich auf "absent" geändert werden soll.
- Die Dauer kann dabei im Format HH:MM:SS angegeben werden, wobei Stunden und Minuten optional sind.
- Wenn dieses Attribut auf einen gültigen Wert gesetzt ist, werden die Readings "state" und "presence" bei einem "absent"-Event zunächst auf den Wert "maybe absent" gesetzt.
- Sobald das parametrisierte Zeitfenster um ist, wird der Status final auf "absent" gesetzt.<br><br>
- Standardwert ist 0 Sekunden (keine Statusverzögerung)<br><br>
- <li><a name="PRESENCE_presenceTimeout">presenceTimeout</a></li> <i>(Nur im Modus "event" anwendbar)</i><br>
- Die Dauer, die nach einem "present"-Event gewartet werden soll, bis der Status der PRESENCE-Definition tatsächlich auf "present" geändert werden soll.
- Die Dauer kann dabei im Format HH:MM:SS angegeben werden, wobei Stunden und Minuten optional sind.
- Wenn dieses Attribut auf einen gültigen Wert gesetzt ist, werden die Readings "state" und "presence" bei einem "present"-Event zunächst auf den Wert "maybe present" gesetzt.
- Sobald das parametrisierte Zeitfenster um ist, wird der Status final auf "present" gesetzt.<br><br>
- Standardwert ist 0 Sekunden (keine Statusverzögerung)<br><br>
- <li><a name="PRESENCE_retryInterval">retryInterval</a></li> <i>(Nicht im Modus "event" oder "lan-bluetooth" anwendbar)</i><br>
- Das Prüfinterval, welches im Falle eines vorzeitig abgebrochenen Checks genutzt wird, um eine Wiederholung auszuführen. Dazu wird im Falle eines abgebrochenen
- Checks der nächste Check nach der übergebenen Dauer in Sekunden ausgeführt. Diese sollte geringer sein als das reguläre Prüfinterval.
- <br><br>
- Standardwert ist 10 Sekunden<br><br>
- <li><a name="PRESENCE_retryCount">retryCount</a></li> <i>(Nicht im Modus "event" oder "lan-bluetooth" anwendbar)</i><br>
- Die maximale Anzahl an Wiederholungen, sollte ein Check vorzeitig abgebrochen werden. Sobald ein Check vorzeitigabbricht, werden maximal die übergebene Anzahl an Wiederholung
- innerhalb des in retryInterval konfigurierten Interval ausgeführt um in kürzerer Zeit ein valides Ergebnis zu erhalten.
- <br><br>
- Standardwert ist 3 Wiederholungen<br><br>
- <li><a name="PRESENCE_pingCount">pingCount</a></li> (Nur im Modus "ping" anwendbar)<br>
- Verändert die Anzahl der Ping-Pakete die gesendet werden sollen um die Anwesenheit zu erkennen.
- Je nach Netzwerkstabilität können erste Pakete verloren gehen oder blockiert werden.<br><br>
- Standardwert ist 4 (Versuche)<br><br>
- <li><a name="PRESENCE_bluetoothHciDevice">bluetoothHciDevice</a></li> (Nur im Modus "local-bluetooth" anwendbar)<br>
- Sofern man mehrere Bluetooth-Empfänger verfügbar hat, kann man mit diesem Attribut ein bestimmten Empfänger auswählen, welcher zur Erkennung verwendet werden soll (bspw. hci0, hci1, ...). Es muss dabei ein vorhandener HCI-Gerätename angegeben werden wie z.B. <code>hci0</code>.
- <br><br>
- <li><a name="PRESENCE_fritzboxCheckSpeed">fritzboxCheckSpeed</a></li> (Nur im Modus "fritzbox")<br>
- Zusätzlich zum Status des Geräts wird die aktuelle Verbindungsgeschwindigkeit ausgegeben<br>
- Das macht nur bei WLAN Geräten Sinn, die direkt mit der FritzBox verbunden sind. Bei abwesenden Geräten wird als Geschwindigkeit 0 ausgegeben.
- <br><br>
- Mögliche Werte: 0 => Geschwindigkeit nicht prüfen, 1 => Geschwindigkeit prüfen<br>
- Standardwert ist 0 (Keine Geschwindigkeitsprüfung)
- <br><br>
- <li><a name="PRESENCE_powerCmd">powerCmd</a></li><br>
- Ein FHEM-Befehl, welcher das Gerät schalten kann.<br><br>
- Wenn der power-Befehl ausgeführt wird (set-Befehl: power) werden folgende Platzhalter durch ihre entsprechenden Werte ersetzt:<br><br>
- <ul>
- <li><code>$NAME</code> - Name der PRESENCE-Definition</li>
- <li><code>$ADDRESS</code> - Die überwachte Addresse der PRESENCE Definition, wie sie im define-Befehl angegeben wurde.</li>
- <li><code>$ARGUMENT</code> - Das Argument, was dem Set-Befehl "power" übergeben wurde. (z.B. "on" oder "off")</li>
- </ul>
- <br>
- Beispielhafte FHEM-Befehle:<br><br>
- <ul>
- <li><code>set PowerSwitch_1 on</code></li>
- <li><code>set PowerSwitch_1 $ARGUMENT</code></li>
- <li><code>"/opt/power_on.sh $ADDRESS"</code></li>
- <li><code>{powerOn("$ADDRESS", "username", "password")}</code></li>
- </ul>
- </ul>
- <br>
- <a name="PRESENCE_events"></a>
- <b>Generierte Readings/Events:</b><br><br>
- <ul>
- <u>Generelle ReadingsEvents:</u><br><br>
- <ul>
- <li><b>state</b>: (absent|maybe absent|present|maybe present|disabled|error|timeout) - Der Anwesenheitsstatus eine Gerätes (absent = abwesend; present = anwesend) oder "disabled" wenn das <a href="#PRESENCE_disable">disable</a>-Attribut aktiviert ist</li>
- <li><b>presence</b>: (absent|maybe absent|present|maybe present) - Der Anwesenheitsstatus eine Gerätes (absent = abwesend; present = anwesend). Der Wert "maybe absent" (vielleicht abwesend) tritt nur auf, sofern das Attribut <a href="#PRESENCE_absenceThreshold">absenceThreshold</a> aktiviert ist. Der Wert "maybe present" (vielleicht anwesend) tritt nur auf, sofern das Attribut <a href="#PRESENCE_presenceThreshold">presenceThreshold</a> aktiviert ist.</li>
- <li><b>powerCmd</b>: (executed|failed) - Ausführung des power-Befehls war erfolgreich.</li>
- </ul><br><br>
- <u>Bluetooth-spezifische Readings/Events:</u><br><br>
- <ul>
- <li><b>device_name</b>: $name - Der Name des Bluetooth-Gerätes, wenn es anwesend (Status: present) ist</li>
- </ul><br><br>
- <u>FRITZ!Box-spezifische Readings/Events:</u><br><br>
- <ul>
- <li><b>speed</b>: $speed - Die Netzwerkdeschwindigkeit des Gerätes, sofern das Attribut <a href="#PRESENCE_fritzboxCheckSpeed">fritzboxCheckSpeed</a> aktiviert ist.</li>
- </ul><br><br>
- <u>presenced-/collectord-spezifische Readings/Events:</u><br><br>
- <ul>
- <li><b>command_accepted</b>: $command_accepted (yes|no) - Wurde das letzte Kommando an den presenced/collectord akzeptiert (yes = ja, no = nein)?</li>
- <li><b>room</b>: $room - Wenn das Modul mit einem collectord verbunden ist, zeigt dieses Event den Raum an, in welchem dieses Gerät erkannt wurde (Raumname entsprechend der Konfigurationsdatei des collectord)</li>
- </ul>
- </ul>
- </ul>
- <p><a name="PROPLANTA"></a>
- <h3>PROPLANTA</h3>
- <div class='langLinks'>[<a href='commandref.html#PROPLANTA'>EN</a> DE]</div>
- <div>
- <ul>
- <a name="PROPLANTAdefine"></a>
- Das Modul extrahiert Wetterdaten von der Website <a href="http://www.proplanta.de">www.proplanta.de</a>.
- <br/>
- Es stellt eine Vorhersage für 12 Tage zur Verfügung - während der ersten 7 Tage im 3-Stunden-Intervall.
- <br>
- Dieses Modul erzeugt eine hohe CPU-Last. Es wird deshalb empfohlen, die auszulesenden Vorhersagetage zu reduzieren.
- <br>
- <i>Es nutzt die Perl-Module HTTP::Request, LWP::UserAgent und HTML::Parse</i>.
- <br>
- Für detailierte Anleitungen bitte die <a href="http://www.fhemwiki.de/wiki/PROPLANTA"><b>FHEM-Wiki</b></a> konsultieren und ergänzen.
- <br/><br/>
- <b>Define</b>
- <ul>
- <br>
- <code>define <Name> PROPLANTA [Stadt] [Ländercode]</code>
- <br>
- Beispiel:
- <br>
- <code>define wetter PROPLANTA Bern ch</code>
- <br>
- <code>define wetter PROPLANTA Wittingen+(Niedersachsen)</code>
- <br>
- <li><code>[Stadt]</code>
- <br>
- Optional. Die Stadt muss auf <a href="http://www.proplanta.de">www.proplanta.de</a> auswählbar sein.
- <br>
- Wichtig!! Auf die <b>großen</b> Anfangsbuchstaben achten.
- Leerzeichen im Stadtnamen werden durch ein + (Plus) ersetzt.
- </li><br>
- <li><code>[Ländercode]</code>
- <br>
- Optional. Mögliche Werte: de (Standard), at, ch, fr, it
- </li><br>
- Über die Funktion <code>PROPLANTA_Html</code> wird ein HTML-Code für eine Vorhersage für die angegebenen Anzahl Tage (standardmäßig 3) erzeugt.
- <br>
- Beispiel:
- <br>
- <code>define Vorschau weblink htmlCode {PROPLANTA_Html("Wetter"[, Tage])}</code>
- <br/><br/>
- </ul>
- <br>
-
- <a name="PROPLANTAset"></a>
- <b>Set</b>
- <ul>
- <br>
- <li><code>set <name> update</code>
- <br>
- Startet sofort ein neues Auslesen der Wetterdaten.
- </li><br>
- </ul>
-
- <a name="PROPLANTAattr"></a>
- <b>Attribute</b>
- <ul>
- <br>
- <li><code>forecastDays <4-14></code>
- <br>
- Anzahl Tage, für die die Vorhersage ausgelesen werden soll. Standard ist 14 Tage (inkl. heute).
- </li><br>
- <li><code>INTERVAL <Abfrageinterval></code>
- <br>
- Abfrageinterval in Sekunden (Standard 3600 = 1 Stunde)
- </li><br>
- <li><code>URL <Internetadresse></code>
- <br>
- Internetadresse, von der die Daten ausgelesen werden (überschreibt die Werte im 'define'-Term)
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br><br>
- <a name="PROPLANTAreading"></a>
- <b>Vorhersagewerte</b>
- <ul>
- <br>
- <li><b>fc</b><i>0|1|2|3...|13</i><b>_...</b> - Vorhersagewerte für <i>heute|morgen|übermorgen|in 3|...|13 Tagen</i></li>
- <li><b>fc</b><i>0</i><b>_...<i>00|03|06|09|12|15|18|21</i></b> - Vorhersagewerte für <i>heute</i> um <i>00|03|06|09|12|15|18|21</i> Uhr</li>
- <li><b>fc</b><i>0</i><b>_chOfRain</b><i>Day|Night</i> - <i>heutiges</i> Niederschlagsrisiko <i>tagsüber|nachts</i> in %</li>
- <li><b>fc</b><i>1</i><b>_chOfRain</b><i>15</i> - <i>morgiges</i> Niederschlagsrisiko um <i>15</i>:00 Uhr in %</li>
- <li><b>fc</b><i>2</i><b>_cloud</b><i>15</i> - Wolkenbedeckungsgrad <i>übermorgen</i> um <i>15</i>:00 Uhr in %</li>
- <li><b>fc</b><i>0</i><b>_dew</b> - Taubildung <i>heute</i> (0=keine, 1=leicht, 2=mäßig, 3=stark)</li>
- <li><b>fc</b><i>0</i><b>_evapor</b> - Verdunstung <i>heute</i> (0=keine, 1=gering, 2=mäßig, 3=stark)</li>
- <li><b>fc</b><i>0</i><b>_frost</b> - Bodenfrost <i>heute</i> (0=nein, 1=ja)</li>
- <li><b>fc</b><i>1</i><b>_moon</b><i>Rise|Set</i> - Mond<i>auf|unter</i>gang <i>morgen</i></li>
- <li><b>fc</b><i>0</i><b>_rad</b> - Globalstrahlung <i>heute</i></li>
- <li><b>fc</b><i>0</i><b>_rain</b><i>15</i> - Niederschlagsmenge <i>heute</i> um <i>15</i>:00 Uhr in mm</li>
- <li><b>fc</b><i>0</i><b>_sun</b> - relative Sonnenscheindauer <i>heute</i> in % (zwischen Sonnenauf- und -untergang)</li>
- <li><b>fc</b><i>0</i><b>_temp</b><i>Min|Max</i> - <i>Minimal|Maximal</i>temperatur <i>heute</i> in °C</li>
- <li><b>fc</b><i>0</i><b>_temp</b><i>15</i> - Temperatur <i>heute</i> um <i>15</i>:00 Uhr in °C</li>
- <li><b>fc</b><i>0</i><b>_uv</b> - UV-Index <i>heute</i></li>
- <li><b>fc</b><i>0</i><b>_weather</b><i>Morning|Day|Evening|Night</i> - Wetterzustand <i>heute morgen|tagsüber|abends|nachts</i></li>
- <li><b>fc</b><i>0</i><b>_weather</b><i>Day</i><b>Icon</b> - Icon Wetterzustand <i>heute tagsüber</i></li>
- <li><b>fc</b><i>0</i><b>_wind</b><i>15</i> - Windgeschwindigkeit <i>heute</i> um <i>15</i>:00 Uhr in km/h</li>
- <li><b>fc</b><i>0</i><b>_windDir</b><i>15</i> - Windrichtung <i>heute</i> um <i>15</i>:00 Uhr in °</li>
- <li>etc.</li>
- </ul>
- <br>
- <b>Aktuelle Werte</b>
- <ul>
- <br>
- <li><b>cloudBase</b><i>Min|Max</i> - Höhe der <i>minimalen|maximalen</i> Wolkenuntergrenze in m</li>
- <li><b>dewPoint</b> - Taupunkt in °C</li>
- <li><b>humidity</b> - relative Feuchtigkeit in %</li>
- <li><b>obs_time</b> - Uhrzeit der Wetterbeobachtung</li>
- <li><b>pressure</b> - Luftdruck in hPa</li>
- <li><b>temperature</b> - Temperature in °C</li>
- <li><b>visibility</b> - Sichtweite in km</li>
- <li><b>weather</b> - Wetterzustand</li>
- <li><b>weatherIcon</b> - Icon Wetterzustand</li>
- <li><b>wind</b> - Windgeschwindigkeit in km/h</li>
- <li><b>windDir</b> - Windrichtung in °</li>
- </ul>
- <br><br>
- </ul>
- </div>
- <p><a name="PWM"></a>
- <h3>PWM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PWM'>PWM</a><br/>
- </ul>
- <a name="PWMR"></a>
- <h3>PWMR</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PWMR'>PWMR</a><br/>
- </ul>
- <a name="PW_Circle"></a>
- <h3>PW_Circles</h3>
- <div class='langLinks'>[<a href='commandref.html#PW_Circle'>EN</a> DE]</div>
- <ul>
- Das PW_Circles Modul setzt auf das Plugwise-System auf. Es muss zuerst ein Plugwise-Stick angelegt werden.
- Siehe <a href="#Plugwise">Plugwise</a>.
- <br>
- <a name="PW_Circle define"></a>
- <br>
- <b>Define</b>
- <ul>
- <code>define <name> PW_Circle <ShortAddress></code> <br>
- <br>
- <code><ShortAddress></code>
- <ul>
- gibt die Kurzadresse (die letzten 4 Bytes) des Circles an. <br>
- </ul>
- <br><br>
- </ul>
- <b>Set</b>
- <ul>
- <code>on / off</code> <br>
- <ul>
- Schaltet den Circle ein oder aus<br><br>
- </ul>
- <code>on-for-timer / off-for-timer sec</code> <br>
- <ul>
- Schaltet den Circle für n Sekunden an oder aus<br><br>
- </ul>
- <code>syncTime</code> <br>
- <ul>
- Synchronisiert die interne Uhr des Circles mit der lokalen Systemzeit<br><br>
- </ul>
- <code>removeNode</code> <br>
- <ul>
- Entfernt den Circle aus dem Plugwise-Netzwerk<br><br>
- </ul>
- <code>ping</code> <br>
- <ul>
- Sendet ein Ping an den Circle und setzt das Reading "ping" im Format "q_in - q_out - pingZeit"<br><br>
- </ul>
- <code>status</code> <br>
- <ul>
- Liest den aktuellen Status des Circles aus<br><br>
- </ul>
- </ul>
-
- <br><br>
-
- <b>Attribute</b>
- <ul>
- <code>interval</code> <br>
- <ul>
- Setzt das Abruf-Intervall speziell für diesen einen Circle<br>
- </ul>
- </ul>
- <br><br>
- <b>Beispiel</b> <br>
- <ul><code>define Circle_2907CC9 PW_Circle 2907CC9</code></ul>
- <br>
-
- <br>
- </ul>
- =end html
- =cut
- <a name="PW_Scan"></a>
- <h3>PW_Scan</h3>
- <div class='langLinks'>[<a href='commandref.html#PW_Scan'>EN</a> DE]</div>
- <ul>
- Das PW_Scan Modul setzt auf das Plugwise-System auf. Es muss zuerst ein Plugwise-Stick angelegt werden.
- Siehe <a href="#Plugwise">Plugwise</a>.
- <br>
- <a name="PW_Scan define"></a>
- <br>
- <b>Define</b>
- <ul>
- <code>define <name> PW_Scan <ShortAddress></code> <br>
- <br>
- <code><ShortAddress></code>
- <ul>
- gibt die Kurzadresse (die letzten 4 Bytes) des Gerätes an. <br>
- </ul>
- <br><br>
- </ul>
- </ul>
- =end html
- =cut
- <a name="PW_Sense"></a>
- <h3>PW_Sense</h3>
- <div class='langLinks'>[<a href='commandref.html#PW_Sense'>EN</a> DE]</div>
- <ul>
- Das PW_Sense Modul setzt auf das Plugwise-System auf. Es muss zuerst ein Plugwise-Stick angelegt werden.
- Siehe <a href="#Plugwise">Plugwise</a>.
- <br>
- <a name="PW_Sense define"></a>
- <br>
- <b>Define</b>
- <ul>
- <code>define <name> PW_Sense <ShortAddress></code> <br>
- <br>
- <code><ShortAddress></code>
- <ul>
- gibt die Kurzadresse (die letzten 4 Bytes) des Gerätes an. <br>
- </ul>
- <br><br>
- </ul>
- </ul>
- =end html
- =cut
- <a name="PW_Switch"></a>
- <h3>PW_Switch</h3>
- <div class='langLinks'>[<a href='commandref.html#PW_Switch'>EN</a> DE]</div>
- <ul>
- Das PW_Switch Module basiert auf dem Plugwise-System. Es muss zuerst ein Plugwise-Stick angelegt werden.
- Siehe <a href="#PW_Switch">PW_Switch</a>.
- <br>
- <a name="PW_Switch define"></a>
- <br>
- <b>Define</b>
- <ul>
- <code>define <name> PW_Switch <ShortAddress></code> <br>
- <br>
- <code><ShortAddress></code>
- <ul>
- gibt die Kurzadresse (die letzten 4 Bytes) des Circles an. <br>
- </ul>
- <br>
- Beispiel: <br>
- <code>define PW_Switch_2907CC9 PW_Switch 2907CC9</code>
- <br>
- </ul><br>
- <b>Set</b>
- <ul>
- <code>syncTime</code> <br>
- <ul>
- Synchronisiert die interne Uhr des Circles mit der lokalen Systemzeit<br><br>
- </ul>
- <code>removeNode</code> <br>
- <ul>
- Entfernt den Circle aus dem Plugwise-Netzwerk<br><br>
- </ul>
- <code>ping</code> <br>
- <ul>
- Sendet ein Ping an den Circle und setzt das Reading "ping" im Format "q_in - q_out - pingZeit"<br><br>
- </ul>
- </ul>
- <br>
- </ul>
- =end html
- =cut
- <a name="PachLog"></a>
- <h3>PachLog</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PachLog'>PachLog</a><br/>
- </ul>
- <a name="PiXtendV2"></a>
- <h3>PiXtendV2</h3>
- <div class='langLinks'>[<a href='commandref.html#PiXtendV2'>EN</a> DE]</div>
- <ul>
- PiXtend ist eine speicherprogrammierbare Steuerung auf Basis des Raspberry Pi.
- Dieses FHEM-Modul ermöglicht dabei den Zugriff auf die Funktionen des PiXtendV2-Boards in der FHEM-Oberfläche.
- Der PiXtend bietet dabei eine Vielzahl an digitalen und analogen Ein- und Ausgängen, die nach Industrie-Standards ausgelegt sind
- und ist aufgrund der sicheren Anschlüsse auch ideal für die Hausautomatisierung geeignet.
- Für mehr Informationen über PiXtend(R) und das FHEM-Modul besuchen Sie unsere Website
- <a href="http://www.PiXtend.de" target="_blank">www.PiXtend.de</a> oder
- <a href="http://www.PiXtend.com" target="_blank">www.PiXtend.com</a>.
- <br><br>
- <a name="PiXtendV2Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> PiXtendV2</code>
- <br><br>
- Beispiel:
- <ul>
- <code>define pix PiXtendV2</code><br>
- </ul>
- </ul>
- <br>
- <a name="PiXtendV2Set"></a>
- <b>Set</b>
- <ul>
- Kommandos um die Basiskonfiguration für den PiXtend durchzuführen, beginnen mit einem "_".<br>
- Unterstützt ein Kommando mehrere Kanäle, muss das "#"-Zeichen durch die Kanal-Nummer ersetzt werden.<br>
- Alle Set-Kommandos sind unabhängig von der Groß-/Kleinschreibung um die einfache Benutzung zu ermöglichen.<br>
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.
- <br><br>
- Beispiel:
- <ul>
- <code>set pix relayOut0 on</code><br>
- <code>set pix Relayout0 On</code><br>
- <code>set pix rElAyoUT0 oFf</code><br>
- </ul>
- <br><br>
-
- <li>_GPIO#Ctrl [input,output,DHT11,DHT22]<br>
- Mit dieser Einstellung kann die Funktion des GPIO eingestellt werden. [input], [output] oder [DHT11] und [DHT22] wenn ein DHT-Sensor an den GPIO angeschlossen ist.
- Wenn ein DHT-Sensor angeschlossen ist und verwendet wird, kann die normale Funktion des GPIO als Eingang/Ausgang nicht gleichzeitig verwendet werden.
- <br><br></li>
-
- <li>_GPIOPullupsEnable [yes,no]<br>
- Diese Einstellung aktiviert [yes] oder deaktiviert [no] für alle GPIOs die Möglichkeit die internen PullUp-Widerstände durch GPIOOut zu setzen.
- <br><br></li>
-
- <li>_JumperSettingAI# [5V,10V]<br>
- Diese Einstellung beeinflusst die Berechnung der Spannung durch die analogen Eingänge und bezieht sich dabei auf die tatsächliche Position des Jumpers
- auf dem PiXtend-Board [5V,10V]. Wenn kein Jumper verwendet wird, entspricht das der Standardeinstellung von [10V].
- <br><br></li>
-
- <li>_StateLEDDisable [yes,no]<br>
- Diese Einstellung deaktiviert [yes] oder aktiviert [no] die Status-LED auf dem PiXtend. Wenn die LED deaktiviert ist, leuchtet sie im Fehlerfall nicht auf.
- <br><br></li>
-
- <li>_WatchdogEnable [disable,125ms,1s,8s]<br>
- Diese Einstellung ermöglicht die Konfiguration des Watchdog-Timers. Wenn der Watchdog konfiguriert ist, geht der PiXtend in den Sicheren Zustand
- über, falls innerhalb der eingestellten Zeit keine gültige Übertragung zwischen PiXtend und Raspberry Pi stattgefunden hat.
- Im Sicheren Zustand kann der PiXtend erst wieder angesprochen werden, nachdem ein Reset des PiXtend durchgeführt wurde.
- <br><br></li>
- <li>AnalogOut# []<br>
- Stellt am analogen Ausgang eine Spannung ein. Der übergebene Wert kann eine Spannung zwischen 0 V und 10 V
- oder ein Rohwert zwischen 0 und 1023 sein. Um den Wert als Spannung zu übergeben, muss der Wert ein "." enthalten,
- auch wenn der Wert ganzzahlig ist.
- <br><br>
- Beispiel:
- <ul>
- <code>set pix analogout0 2.5</code>   => Setzt den analogen Ausgang 0 auf 2,5 V<br>
- <code>set pix analogout0 4.0</code>   => Setzt den analogen Ausgang 0 auf 4 V<br>
- <code>set pix analogout0 223</code>   => Setzt den analogen Ausgang 0 auf 10*(233/1024) = 1,09 V
- </ul>
- <br><br></li>
-
- <li>DigitalDebounce# [0-255]<br>
- Ermöglicht das Entprellen der digitalen Eingänge. Die Einstellung beeinflusst dabei immer zwei Kanäle.
- DigitalDebounce01 beeinflusst somit DigitalIn0 und DigitalIn1.
- Die resultierende Verzögerung berechnet sich dabei durch (eingestellten Wert)*(100 ms).
- Der übergebene Wert kann eine beliebige Zahl zwischen 0 und 255 sein.
- Entprellen kann sinnvoll sein, falls an den Eingängen Schalter oder Taster angeschlossen sind.
- <br><br>
- Beispiel:
- <ul>
- <code>set pix digitaldebounce01 20</code>   => entprellt DigitalIn0 und DigitalIn1 über (20*100ms) = 2s
- </ul>
- <br><br></li>
-
- <li>DigitalOut# [on,off,toggle]<br>
- Setzt den digitalen Ausgang auf HIGH [on] oder LOW [off] oder [toggle]t ihn.
- <br><br></li>
- <li>GPIODebounce# [0-255]<br>
- Ermöglicht das Entprellen der GPIO Eingänge. Die Einstellung beeinflusst dabei immer zwei Kanäle.
- GPIODebounce01 beeinflusst somit GPIOIn0 und GPIOIn1.
- Die resultierende Verzögerung berechnet sich dabei durch (eingestellten Wert)*(100 ms).
- Der übergebene Wert kann eine beliebige Zahl zwischen 0 und 255 sein.
- Entprellen kann sinnvoll sein, falls an den Eingängen Schalter oder Taster angeschlossen sind.
- <br><br>
- Beispiel:
- <ul>
- <code>set pix gpiodebounce23 33</code>   => entprellt GPIOIn2 und GPIOIn3 über (33*100ms) = 3,3s
- </ul>
- <br><br></li>
-
- <li>GPIOOut# [on,off,toggle]<br>
- Setzt den GPIO auf HIGH [on] oder LOW [off] oder [toggle]t ihn, falls er als Ausgang konfiguriert ist.
- Wenn der GPIO als Eingang konfiguriert ist, kann mit diesem Kommando der interne PullUp-Widerstand aktiviert [on], deaktiviert [off] oder
- ge[toggle]t werden. Dazu muss die Möglichkeit allerdings global durch _GPIOPullupsEnable aktiviert werden.
- <br><br></li>
- <li>PWM<br>
- PiXtendV2 unterstützt mehrere PWM-Modi, die mit diesen Einstellungen konfiguriert werden können.
- Zum Beispiel wird ein Servo-Mode um Modellbau-Servomotoren anzusteuern, ein Frequency-Mode oder ein Duty-Cycle-Mode unterstüzt.
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.
- <br><br>
- PWM#Ctrl0 benötigt einen Wert zwischen 0 und 255<br>
- PWM#Ctrl1 benötigt einen Wert zwischen 0 und 65535 (oder einen Wert zwischen 0 und 255)<br>
- PWM#A/B benötigt einen Wert zwischen 0 und 65535 (oder einen Wert zwischen 0 und 255)
- <br><br></li>
- <li>RelayOut# [on,off,toggle]<br>
- Setzt das Relay auf HIGH [on] oder LOW [off] oder [toggle]t es.
- <br><br></li>
-
- <li>Reset<br>
- Setzt den Controller auf dem PiXtend zurück, z.B. wenn er sich im Sicheren Zustand befindet, um ihn erneut konfigurieren zu können.
- <br><br></li>
-
- <li>RetainCopy [on,off]<br>
- Wenn RetainCopy aktiviert [on] ist, werden die geschriebenen Daten RetainDataOut vom PiXtend in RetainDataIn zurückgegeben.
- Die Aktivierung kann in Situationen sinnvoll sein, wenn überprüft werden soll, welche Daten an den PiXtend geschickt wurden.
- Ist die Funktion deaktiviert [off] werden die zuletzt gespeicherten Daten in RetainDataIn zurückgegeben.
- <br><br></li>
-
- <li>RetainDataOut [0-(RetainSize-1)] [0-255]<br>
- Der PiXtendV2 unterstüzt die Speicherung remanenter/persistenter Daten - auch Retain genannt. Diese Daten werden im Falle
- einer Betribsspannungsunterbrechung, beim Auslösen des Watchdog-Timers oder beim Entritt in den Sicheren Zustand gespeichert,
- sofern diese Funktion aktiviert wurde. Die Retain-Daten sind dabei in Bytes organisiert, wobei jedes Byte
- individuell mit einem Wert zwischen 0 und 255 beschrieben werden kann.<br>
- Als ersten Parameter erwartet das Kommando den Index des Bytes, der zwischen 0 und (RetainSize-1) liegt. RetainSize ist in den "Internals" zu finden.
- Als zweiter Parameter wird der Wert erwartet, der gespeichert werden soll.
- <br><br>
- Beispiel:
- <ul>
- <code>set pix retaindataout 0 34</code>    => speichert 34 in Retain-Data-Byte 0<br>
- <code>set pix retaindataout 30 222</code>   => speichert 222 in Retain-Data-Byte 30
- </ul>
- <br><br></li>
-
- <li>RetainEnable [on,off]<br>
- Die Funktion um Retain-Daten auf dem PiXtend zu speichern muss erst aktiviert [on] werden. Andernfalls [off] werden keine Daten gespeichert.
- Es ist zu beachten, dass für den Retain-Speicherbereich 10.000 Schreibzyklen unterstützt werden. Dementsprechend
- sollte die Funktion nur aktiviert werden, wenn sie tatsächlich benötigt wird.
- <br><br></li>
-
- <li>SafeState<br>
- Mit dieser Einstellung kann der PiXtend in den Sicheren Zustand versetzt werden. Wenn die Retain-Speicherung aktiviert ist, werden die Daten gesichert.
- Im Sicheren Zustand kommuniziert der PiXtend nicht mehr mit FHEM. Um den PiXtend neuzustarten muss ein Reset durchgeführt werden.
- <br><br></li>
- </ul>
- <br>
- <a name="PiXtendV2Get"></a>
- <b>Get</b>
- <ul>
- Unterstützt ein Kommando mehrere Kanäle, muss das "#"-Zeichen durch die Kanal-Nummer ersetzt werden.<br>
- Alle Get-Kommandos sind unabhängig von der Groß-/Kleinschreibung um die einfache Benutzung zu ermöglichen.<br>
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.<br>
- Die Werte können als Text, wobei die Werte in eckigen Klammern stehen oder als rohe Werte zurückgegeben werden.
- Die Einstellung für das Format ist in den Attributen zu finden.
- <br><br>
-
- <li>AnalogIn#<br>
- Gibt den Wert des ausgewählten analogen Eingangs zurück.
- Der Wert hängt dabei von der Einstellung _JumperSettingAI# und der tatsächlichen Jumper-Position auf dem Board ab.
- <br><br></li>
- <li>DigitalIn#<br>
- Gibt den Status 1 (HIGH) oder 0 (LOW) des digitalen Eingangs zurück.
- <br><br></li>
- <li>GPIOIn#<br>
- Gibt den Status 1 (HIGH) oder 0 (LOW) des GPIOs zurück, unabhängig von der Konfiguration (input, output, ..).
- <br><br></li>
-
- <li>RetainDataIn [0-(RetainSize-1)]<br>
- Gibt den Wert des ausgewählten RetainDataIn-Bytes zurück.
- <br><br></li>
- <li>Sensor# [temperature,humidity]<br>
- Wenn ein DHT-Sensor an den entsprechenden GPIO angeschlossen ist und _GPIO#Ctrl auf DHT11 oder DHT22 gesetzt ist
- wird die Temperatur und Luftfeuchtigkeit gemessen und kann ausgelesen werden.
- <br><br>
- Beispiel:
- <ul>
- <code>set pix _GPIO0Ctrl DHT11</code><br>
- <code>get pix Sensor0 temperature</code>
- </ul>
- <br><br></li>
-
- <li>SysState<br>
- Gibt den Systemstatus [defined, active, error] des FHEM-Moduls zurück.
- <br><br></li>
- <li>UCState<br>
- Gibt den Status des PiXtend zurück. Ist der Status 1, ist alles in Ordnung. Ist der Status allerdings größer als 1 ist ein Fehler aufgetreten
- oder steht noch an. In diesem Fall kann der PiXtend nicht konfiguriert werden.
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.
- <br><br></li>
- <li>UCWarnings<br>
- Der zurückgegebene Wert repräsentiert die Warnungen des PiXtendV2.
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.
- <br><br></li>
- <li>Version<br>
- Gibt die Version des FHEM-Moduls sowie die PiXtend-Version [Model-Hardware-Firmware] zurück.
- <br><br></li>
- </ul>
- <br>
- <a name="PiXtendV2Readings"></a>
- <b>Readings</b>
- <ul>
- Das FHEM-Modul des PiXtend unterstüzt mehrere Readings, von denen die meisten ein Event auslösen, sobald sie sich ändern.
- Die Bedeutung der Readings ist ähnlich zu den Get-Kommandos.
- <br><br>
- <li>AnalogIn#<br>
- Zeigt das Ergebnis der Messungen der analogen Eingänge in Volt an.
- <br><br></li>
- <li>DigitalIn#<br>
- Zeigt den Status 1 (HIGH) oder 0 (LOW) der digitalen Eingänge an.
- <br><br></li>
-
- <li>Firmware<br>
- Zeigt die Firmware-Version an.
- <br><br></li>
-
- <li>GPIOIn#<br>
- Zeigt den Status 1 (HIGH) oder 0 (LOW) der GPIOs, unabhängig von deren Konfiguration (input, output, ..).
- <br><br></li>
-
- <li>Hardware<br>
- Zeigt die Hardware-Version an.
- <br><br></li>
-
- <li>Model<br>
- Zeigt das Model an.
- <br><br></li>
-
- <li>RetainDataIn<br>
- Zeigt die Werte von RetainDataIn an. Die Werte von RetainDataIn sind dabei in einer Zeile
- zusammengefasst. Der am weitsten links stehende Wert entspricht Byte0 / RetainDataIn0.
- Die Werte sind durch ein Leerzeichen " " voneinander getrennt und können somit einfach in Perl ausgewertet werden:
- <br><br>
- Beispiel:
- <ul>
- <code>my ($str) = ReadingsVal(pix, "RetainDataIn", "?")</code><br>
- <code>if($str ne "?"){</code><br>
-  <code>my @val = split(/ /, $str);</code>   => $val[0] enthält nun Byte0, $val[1] Byte1, usw<br>
-  <code>...</code><br>
- <code>}</code>
- </ul>
- <br><br></li>
-
- <li>Sensor#T/H<br>
- Zeigt die Temperatur (T) in °C und die Luftfeuchtigkeit (H) in % des Sensors an, der an den entsprechenden GPIO angeschlossen ist.
- <br><br></li>
- <li>UCState<br>
- Zeigt den Status des PiXtend an. Ist der Status 1, ist alles in Ordnung. Ist der Status allerdings größer als 1 ist ein Fehler aufgetreten
- oder steht noch an. In diesem Fall kann der PiXtend nicht konfiguriert werden.
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.
- <br><br></li>
- <li>UCWarnings<br>
- Der angezeigte Wert repräsentiert die Warnungen des PiXtendV2.
- Für mehr Informationen sehen Sie bitte im Handbuch für den PiXtendV2 im
- <a href="http://www.PiXtend.de/PiXtend/downloads/" target="_blank">Downloadbereich</a>
- unserer Hompage nach.
- <br><br></li>
- </ul>
- <br>
-
- <a name="PiXtendV2Attr"></a>
- <b>Attributes</b>
- <ul>
- Für den Attribut-Namen muss die Groß-/Kleinschreibung beachtet werden.
- <br><br>
- <li>PiXtend_GetFormat [text,value]<br>
- Ändert die Darstellung, wie die Werte durch die Get-Kommandos zurückgegeben werden. Die Werte können entweder in einer Nachricht [text] oder als rohe Werte [value] zurückgegeben werden.
- Standard ist die Ausgabe als Text.
- <br><br></li>
- <li>PiXtend_Parameter<br>
- Dieses Attribut kann verwendet werden, um die Einstellungen zur Basiskonfiguration (Set-Kommandos beginnend mit "_") als Attribut zu speichern. Attribute werden im Gegensatz zu Set-Kommandos in der Config-Datei gespeichert.<br>
- Einzelne Kommandos werden durch ein Leerzeichen voneinander getrennt und erhalten ihre Werte nach einem Doppelpunkt.
- <br><br>
- Beispiel:
- <ul>
- <code>attr pix PiXtend_Parameter _gpio0ctrl:dht11 _gpio3ctrl:dht22</code>
- </ul>
- <br><br></li>
-
- </ul>
- <br>
-
- </ul>
- <p><a name="Plugwise"></a>
- <h3>Plugwise</h3>
- <div class='langLinks'>[<a href='commandref.html#Plugwise'>EN</a> DE]</div>
- <ul>
- Modul für das Plugwise-System.
- <br>
- Achtung: Dieses Modul benötigt folgende Perl-Module:
- <ul><li>Device::SerialPort oder Win32::SerialPort</li>
- <li>digest:CRC</li></ul>
- <br><br>
- <b>Define</b>
- <ul>
- <code>define <name> Plugwise <device> </code><br>
- </ul>
- <br>
- <device> Gibt den COM-Port des Plugwise-Stick an.
- Unter Linux ist dies im Normalfall /dev/ttyUSBx, wobei x eine fortlaufende Nummer ist. (zB /dev/ttyUSB0)
- Wobei es unter Linux sinnvoller ist, den Port mittels UDEV-Regeln oder mittels /dev/by-id/ anzugeben.
- Der Plugwise-Stick läuft fix auf 115200 Baud<br>
- <br>
- Beispiel: <br>
- <code>define myPlugwise Plugwise /dev/ttyPlugwise</code>
- <br>
- </ul>
- <br>
-
- <a name="PLUGWISEset"></a>
- <b>Set</b>
- <ul>
- <code>Scan_Circles</code>
- <ul>
- Startet eine Suche nach neuen Geräten und legt diese per Autocreate an.
- </ul><br><br>
- <code>syncTime</code>
- <ul>
- Syncronisiert die internen RTCs der Geräte mit der aktuellen Systemzeit.
- </ul><br><br>
- <code>reOpen</code>
- <ul>
- Öffnet den COM-Port neu (zB bei zu vielen Fehlern, nach deren Behebung)
- </ul><br><br>
- </ul>
- <br><br>
- <b>Attribute</b>
- <ul>
- <code>circlecount</code><br>
- <ul>
- Maximale Anzahl der Geräte, nach denengesucht wird.
- <br><br>
- </ul>
- <code>interval</code><br>
- <ul>Standard-Abfrageintervall der Circles
- </ul><br><br>
- <code>autosync</code><br>
- <ul>Sendet alle >n< Sekunden ein "syncTime" an alle Geräte
- </ul><br><br>
- <code>WattFormat</code><br>
- <ul>String, mit welchem die Power-Readings formatiert werden
- Standard: %0.f
- </ul><br><br>
- <code>showCom</code><br>
- <ul>Schreibt die gesamte Kommunikation (gefiltern nach >regEx<) in das Reading "communication"
- (Am besten mit FileLog oder dem Eventmonitor anzusehen)
- </ul><br><br>
-
- <br>
- </ul>
- =end html
- =cut
- <a name="PostMe"></a>
- <h3>PostMe</h3>
- <div class='langLinks'>[<a href='commandref.html#PostMe'>EN</a> DE]</div>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Modul_PostMe">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#PostMe">PostMe</a>
- </ul>
- <p><a name="PrecipitationSensor"></a>
- <h3>PrecipitationSensor</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#PrecipitationSensor'>PrecipitationSensor</a><br/>
- </ul>
- <a name="PushNotifier"></a>
- <h3>PushNotifier</h3>
- <div class='langLinks'>[<a href='commandref.html#PushNotifier'>EN</a> DE]</div>
- <ul>
- PushNotifier ist ein Dienst, um Benachrichtigungen von einer vielzahl
- von Quellen auf Deinem Smartphone oder Tablet zu empfangen.<br>
- Du brauchst einen Account um dieses Modul zu verwenden.<br>
- F��r weitere Informationen besuche <a href="http://www.fhemwiki.de/wiki/PushNotifier">FhemWiki PushNotifier</a>.<br>
- <br>
- Diskutiere das Modul <a href="http://forum.fhem.de/index.php/topic,25440.0.html">hier</a>.<br>
- <br>
- <br>
- <a name="PushNotifierDefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> PushNotifier <apiToken> <appName> <user> <password> <deviceID></code><br>
- <br>
- Du musst einen Account erstellen, um das apiToken zu bekommen.<br>
- Und du musst eine Anwendung erstellen, um einen appToken zu bekommen.<br>
- <br>
- Beispiel:
- <ul>
- <code>define PushNotifier1 PushNotifier 01234 appname user password 012</code>
- </ul>
- </ul>
- <br>
- <a name="PushNotifierSet"></a>
- <b>Set</b>
- <ul>
- <code>set <PushNotifier_device> message </code>
- <br>
- <br>
- Beispiele:
- <ul>
- <code>set PushNotifier1 message Dies ist ein Text.</code><br>
- </ul>
- Zeilenumbruch:
- <ul>
- <code>set PushNotifier1 message Dies ist ein Text._Neue Zeile.</code><br>
- </ul>
- </ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <br>
- <a name="PushNotifierEvents"></a>
- <b>Generated events:</b>
- <ul>
- N/A
- </ul>
- </ul>
- <p><a name="Pushalot"></a>
- <h3>Pushalot</h3>
- <div class='langLinks'>[<a href='commandref.html#Pushalot'>EN</a> DE]</div>
- <ul>
- Pusalot ist ein Dienst, um Benachrichtigungen von einer vielzahl
- von Quellen auf ein Windows Phone Device zu empfangen.<br>
- Du brauchst einen Account um dieses Modul zu verwenden.<br>
- Für weitere Informationen über den Dienst besuche <a href="https://pushalot.com" target="_blank">pushalot.com</a>.<br>
- <br>
- Diskutiere das Modul <a href="http://forum.fhem.de/index.php/topic,37775.0.html" target="_blank">hier</a>.<br>
- <br>
- <br>
- <a name="PushalotDefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Pushalot <token> [<source>]</code><br>
- <br>
- <table>
- <colgroup>
- <col style="width: 100px";"></col>
- <col></col>
- </colgroup>
- <tr>
- <td><token></td>
- <td>Der Token der den pushalot-Account identifiziert. Um diesen zu bekommen, muss ein Account erstellt werden.</td>
- </tr>
- <tr>
- <td><source></td>
- <td>Definiert den Absender, der in der Nachricht angezeigt werden soll.</td>
- </tr>
- </table>
- <br>
- Beispiel:
- <ul>
- <code>define Pushalot PushNotification 123234 FHEM</code>
- </ul>
- </ul>
- <br>
- <a name="PushalotSet"></a>
- <b>Set</b>
- <ul>
- <code>set <Pushalot_device> "<message>" ["<title>"] ["<image>"] ["<link>"] ["<link_title>"] ["<important>"] ["<silent>"]</code>
- <br>
- <br>
- <table>
- <colgroup>
- <col style="width: 100px";"></col>
- <col></col>
- </colgroup>
- <tr>
- <td><message></td>
- <td>Der Nachrichten-Text.</td>
- </tr>
- <tr>
- <td><title></td>
- <td>Der Titel der Nachricht.</td>
- </tr>
- <tr>
- <td><image></td>
- <td>Optionale Bild-URL die in der Nachricht angezeigt werden soll.</td>
- </tr>
- <tr>
- <td><link></td>
- <td>Ein optionaler Link der an die Nachricht angehängt werden soll.</td>
- </tr>
- <tr>
- <td><link_title></td>
- <td>Optionaler Link Titel. Wenn kein Titel angegeben wird, ist dieser die URL.</td>
- </tr>
- <tr>
- <td><important></td>
- <td>True|False: True wenn die Nachricht als 'wichtig' markiert werden soll, sonst False (Default)</td>
- </tr>
- <tr>
- <td><silent></td>
- <td>True|False: True wenn die Nachricht 'still' ausgeliefert werden soll (kein Benachrichtigungssound wird abgespielt), ansonsten False (Default)</td>
- </tr>
- <tr>
- <td><time_to_live></td>
- <td>Zeit in Minuten nach der die Nachricht automatisch entfernt wird. Achtung: Der Pushalot Service prüft zu löschende Nachrichten alle 5 Minuten</td>
- </tr>
- </table>
- <br>
- Beispiele:
- <ul>
- <code>set PushNotification message "Das ist meine Nachricht."</code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel"</code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel" "http://www.xyz.com/image.png"</code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel" "http://www.xyz.com/image.png" "http://www.xyz.com"</code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Titel" </code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Titel" True</code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Title" True False</code><br>
- <code>set PushNotification message "Das ist meine Nachricht." "Mit Titel" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Title" True False 5</code><br>
- </ul>
- <br>
- Notes:
- <ul>
- </ul>
- </ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="PushalotAttr"></a>
- <b>Attribute</b> <ul>N/A</ul><br>
- <ul>
- </ul>
- <br>
- <a name="PushalotEvents"></a>
- <b>Generierte events:</b>
- <ul>
- N/A
- </ul>
- </ul>
- <p><a name="Pushbullet"></a>
- <h3>Pushbullet</h3>
- <div class='langLinks'>[<a href='commandref.html#Pushbullet'>EN</a> DE]</div>
- <ul>
- Pushbullet ist ein Dienst, um Benachrichtigungen an unterschiedliche Endgeräte zu senden. Pushbullet
- bietet Apps für iPhone, Android, Windows (Beta) und Mac OS X sowie Plugins für Chrome, Firefox und Safari an.<br>
- Für weitere Informationen über den Dienst besuche <a target="_blank" href="https://pushbullet.com">pushbullet.com</a>.<br>
- <br>
- Diskutiere das Modul <a target="_blank" href="http://forum.fhem.de/index.php/topic,29796.0.html">hier</a>.<br>
- <br><br>
- <a name="Pushbullet_Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Pushbullet <accessToken></code><br>
- <br>
- Notiz:<br>
- JSON muss auf dem FHEM Host installiert sein.<br><br>
- Registriere dich auf pushbullet.com um deine accessToken zu bekommen.<br>
- </ul><br>
- <a name="Pushbullet_Set"></a>
- <b>Set</b>
- <ul>
- <li>clear<br>
- Löscht alle Device Readings</li>
- <li>contactAdd name | email<br>
- Fügt einen neuen Kontakt hinzu. Leerzeichen im Namen sind erlaubt.</li>
- <li>deviceDelete deviceName<br>
- Löscht das Device.</li>
- <li>deviceRename deviceName | neuerDeviceName<br>
- Benennt das Device um.</li>
- <li>link [| Titel | Device]<br>
- Sendet einen Link mit optionalen Titel und Device. Wenn kein Device angegeben ist, geht der Push an alle deine Devices.</li>
- <li>list Item1[, Item2, Item3, ... | Titel | Device]<br>
- Sendet eine Liste mit einem oder mehreren Items, optionalen Titel und Device. Wenn kein Device angegeben ist, geht der Push an alle deine Devices.</li>
- <li>message [| Titel | Device]<br>
- Sendet eine Nachricht mit optionalen Titel und Device. Wenn kein Device angegeben ist, geht der Push an alle deine Devices.</li>
- <br>
- Beispiele:<br>
- <ul>
- <code>set Pushbullet message Das ist eine Nachricht</code><br>
- Sendet eine Push Benachrichtigung mit der Nachricht "Das ist eine Nachricht" ohne vorbestimmten Titel an alle <b>deine</b> Devices.<br><br>
- <code>set Pushbullet message Das ist eine Nachricht | Ein Titel</code><br>
- Sendet eine Push Benachrichtigung mit der Nachricht "Das ist eine Nachricht" mit dem Titel "Ein Titel" an alle <b>deine</b> Devices.<br><br>
- <code>set Pushbullet message This is a message | Ein Titel | iPhone</code><br>
- Sendet eine Push Benachrichtigung mit der Nachricht "Das ist eine Nachricht" mit dem Titel "Ein Titel" an deinen Device iPhone.<br><br>
- <code>set Pushbullet message This is a message | Ein Titel | Max Mustermann</code><br>
- Sendet eine Push Benachrichtigung mit der Nachricht "Das ist eine Nachricht" mit dem Titel "Ein Titel" an deinen Kontakt Max Mustermann.<br><br>
- </ul>
- <br>
- Notiz:<br>
- Leerstellen vor und nach dem Trenner | werden nicht benötigt.
- </ul><br>
-
- <a name="Pushbullet_Get"></a>
- <b>Get</b>
- <ul>
- <li>devices<br>
- Liest alle Geräte und Kontakte ein und setzt die entsprechenden Readings.</li>
- </ul><br>
- <a name="Pushbullet_Attr"></a>
- <b>Attributes</b>
- <ul>
- <li>defaultDevice<br>
- Standart Device für Pushnachrichten.</li>
- <li>defaultTitle<br>
- Standart Titel für Pushnachrichten. Wenn nicht gesetzt ist der Standart Titel FHEM</li>
- </ul>
- </ul>
- <p><a name="Pushover"></a>
- <h3>Pushover</h3>
- <div class='langLinks'>[<a href='commandref.html#Pushover'>EN</a> DE]</div>
- <ul>
- Pushover ist ein Dienst, um Benachrichtigungen von einer vielzahl
- von Quellen auf Deinem Smartphone oder Tablet zu empfangen.<br>
- Du brauchst einen Account um dieses Modul zu verwenden.<br>
- Für weitere Informationen über den Dienst besuche <a href="https://pushover.net">pushover.net</a>.<br>
- <br>
- Die Installation des Perl Moduls IO::Socket::SSL ist Voraussetzung zur Nutzung dieses Moduls (z.B. via 'cpan -i IO::Socket::SSL').<br>
- Es wird empfohlen Perl-JSON zu installieren, um erweiterte Funktion wie Supplementary URLs nutzen zu können.<br>
- <br>
- Diskutiere das Modul <a href="http://forum.fhem.de/index.php/topic,16215.0.html">hier</a>.<br>
- <br>
- <br>
- <a name="PushoverDefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Pushover <token> <user> [<infix>]</code><br>
- <br>
- Du musst einen <a href="https://pushover.net/login">Account erstellen</a>, um den User Key zu bekommen.<br>
- Und du musst <a href="https://pushover.net/apps/build">eine Anwendung erstellen</a>, um einen API APP_TOKEN zu bekommen.<br>
- <br>
- Das Attribut infix ist optional, um einen FHEMWEB uri Namen für die Pushover API Callback Funktion zu definieren.<br>
- Die Callback URL Callback URL kann dann mit dem Attribut callbackUrl gesetzt werden (siehe unten).<br>
- Hinweis: Eine infix uri can innerhalb einer FHEM Instanz nur einmal verwendet werden!<br>
- <br>
- Beispiel:
- <ul>
- <code>define Pushover1 Pushover 01234 56789</code>
- </ul>
- <ul>
- <code>define Pushover1 Pushover 01234 56789 pushCallback1</code>
- </ul>
- </ul>
- <br>
- <a name="PushoverSet"></a>
- <b>Set</b>
- <ul><b>msg</b><ul>
- <code>set <Pushover_device> msg <text> [<option1>=<value> <option2>="<value with space in it>" ...]</code>
- <br>
- <br>
- Die folgenden Optionen können genutzt werden, um den Nachrichteninhalt und die Zustellung zu beeinflussen::<br>
- <br>
- <code><b>message</b> </code> - Typ: Text - Dein Nachrichtentext. Die Nutzung dieser Option hat Vorrang; Text außerhalb wird verworfen.<br>
- <code><b>device</b> </code> - Typ: Text - Dein selbst vergebener Gerätename, um die Nachricht direkt an dieses Gerät zu senden anstatt an alle Geräte gleichzeitig (mehrere Geräte können mit Komma getrennt angegeben werden). Hier kann auch explizit ein User oder Group Key angegeben werden. Um gezielt ein Gerät einer/s speziellen User/Group anzusprechen, zuerst den User/Group Key angeben, gefolgt vom Gerätenamen und einem Doppelpunkt als Trennzeichen.<br>
- <code><b>title</b> </code> - Typ: Text - Dein Nachrichten Titel, andernfalls wird der App Name wie in der Pushover API festgelegt verwendet.<br>
- <code><b>action</b> </code> - Typ: Text - Entweder ein auszuführendes FHEM Kommando, wenn der Empfänger den Link anklickt oder eine <a href="https://pushover.net/api#urls">supplementary URL</a>, die mit der Nachricht zusammen angezeigt werden soll.<br>
- <code><b>url_title</b> </code> - Typ: Text - Ein Titel für das FHEM Kommando oder die supplementary URL, andernfalls wird die URL direkt angezeigt.<br>
- <code><b>priority</b> </code> - Typ: Integer - Sende mit -2, um keine/n Benachrichtigung/Alarm zu generieren. Sende mit -1, um immer eine lautlose Benachrichtigung zu senden. Sende mit 1, um die Nachricht mit <a href="https://pushover.net/api#priority">hoher Priorität</a> anzuzeigen und die Ruhezeiten des Empfängers zu umgehen. Oder sende mit 2, um zusätzlich eine Bestätigung des Empfängers anzufordern.<br>
- <code><b>retry</b> </code> - Typ: Integer - Verpflichtend bei einer Nachrichten Priorität >= 2.<br>
- <code><b>expire</b> </code> - Typ: Integer - Verpflichtend bei einer Nachrichten Priorität >= 2.<br>
- <code><b>cancel_id</b> </code> - Typ: Text - Benutzerdefinierte ID, um Nachrichten mit einer Priorität >= 2 sofort ablaufen zu lassen und die wiederholte Benachrichtigung auszuschalten.<br>
- <code><b>timestamp</b> </code> - Typ: Integer - Ein Unix Zeitstempfel mit Datum und Uhrzeit deiner Nachricht, die dem Empfänger statt der Uhrzeit des Einganges auf den Pushover Servern angezeigt wird. Hat Vorrang bei gesetztem Attribut timestamp=1.<br>
- <code><b>sound</b> </code> - Typ: Text - Der Name eines vom Empfängergerät unterstützten <a href="https://pushover.net/api#sounds">Klangs</a>, um den vom Empfänger ausgewählten Klang zu überschreiben.<br>
- <code><b>attachment</b> </code> - Typ: Text - Pfad zu einer Bilddatei, welche an die Nachricht angehängt werden soll. Der Basispfad ist relativ zum FHEM Verzeichnis und kann über das storage Attribut überschrieben werden.<br>
- <br>
- Beispiele:
- <ul>
- <code>set Pushover1 msg Meine erste Pushover Nachricht.</code><br>
- <code>set Pushover1 msg Meine zweite Pushover Nachricht.\nDiesmal mit zwei Zeilen.</code><br>
- <code>set Pushover1 msg "Eine andere Pushover Nachricht in doppelten Anfährungszeichen."</code><br>
- <code>set Pushover1 msg 'Eine andere Pushover Nachricht in einfachen Anfährungszeichen.'</code><br>
- <code>set Pushover1 msg message="Pushover Nachricht, die die explizite Nachrichten Option für den Textinhalt verwendet." Dieser Teil des Textes wird ignoriert.</code><br>
- <code>set Pushover1 msg Dies ist eine Nachricht mit einem Titel. title="Dies ist ein Betreff"</code><br>
- <code>set Pushover1 msg Diese Nachricht hat einen Anhang! attachment="demolog/pictures/p1.jpg"</code><br>
- <code>set Pushover1 msg title="Dies ist auch ein Betreff!" Dies ist eine weitere Nachricht mit einem Titel, der am Anfang des Kommandos gesetzt ist.</code><br>
- <code>set Pushover1 msg title=Notfall priority=2 retry=30 expire=3600 Sicherheits-Alarm im Wohnzimmer.</code><br>
- <code>set Pushover1 msg title=Link Schau dir mal diese Website an: url_title="Öffnen" action="http://fhem.de/" expire=3600</code><br>
- <code>set Pushover1 msg title=Hinweis expire=3600 Dies ist eine Erinnerung, um etwas zu tun. Der Link verliert in 1h seine Gültigkeit. url_title="Hier klicken, um den Befehl auszuführen" action="set device something"</code><br>
- <code>set Pushover1 msg title=Notfall priority=2 retry=30 expire=3600 Sicherheits-Alarm im Wohnzimmer. sound=siren url_title="Hier klicken, um den Befehl auszuführen" action="set device something"</code><br>
- </ul>
- <br>
- </ul></ul>
- <br>
- <br>
- <ul><b>msgCancel</b><ul>
- <code>set <Pushover_device> msgCancel <ID></code>
- <br>
- <br>
- Stoppt vorzeitig die wiederkehrende Aufforderung zur Bestätigung bei Nachrichten mit Priorität >= 2.<br>
- <br>
- Beispiel:
- <ul>
- <code>set Pushover1 msg title=Notfall priority=2 retry=30 expire=3600 Sicherheits-Alarm im Wohnzimmer. sound=siren cancel_id=SicherheitsAlarm</code><br>
- <code>set Pushover1 msgCancel SicherheitsAlarm</code>
- </ul>
- </ul></ul>
- <br>
- <br>
- <ul><b>msg</b> <u>(veraltetes Format)</u><ul>
- <code>set <Pushover_device> msg [title] <msg> [<device> <priority> <sound> [<retry> <expire> [<url_title> <action>]]]</code>
- <br>
- <br>
- Beispiele:
- <ul>
- <code>set Pushover1 msg 'Dies ist ein Text.'</code><br>
- <code>set Pushover1 msg 'Titel' 'Dies ist ein Text.'</code><br>
- <code>set Pushover1 msg 'Titel' 'Dies ist ein Text.' '' 0 ''</code><br>
- <code>set Pushover1 msg 'Notfall' 'Sicherheitsproblem im Wohnzimmer.' '' 2 'siren' 30 3600</code><br>
- <code>set Pushover1 msg 'Erinnerung' 'Dies ist eine Erinnerung an etwas' '' 0 '' 0 3600 'Hier klicken, um Aktion auszuführen' 'set device irgendwas'</code><br>
- <code>set Pushover1 msg 'Notfall' 'Sicherheitsproblem im Wohnzimmer.' '' 2 'siren' 30 3600 'Hier klicken, um Aktion auszuführen' 'set device something'</code><br>
- </ul>
- <br>
- Anmerkungen:
- <ul>
- <li>Bei der Verwendung der ersten beiden Beispiele müssen die entsprechenden Attribute als Ersatz für die fehlenden Parameter belegt sein (s. Attribute)
- </li>
- <li>Wenn device leer ist, wird die Nachricht an alle Geräte geschickt.
- </li>
- <li>Wenn device ein User oder Group Key ist, wird die Nachricht stattdessen hierhin verschickt. Möchte man trotzdem ein dediziertes Device angeben, trennt man den Namen mit einem Doppelpunkt ab.
- </li>
- <li>Wenn sound leer ist, dann wird die Standardeinstellung in der App verwendet.
- </li>
- <li>Wenn die Priorität höher oder gleich 2 ist müssen retry und expire definiert sein.
- </li>
- </ul>
- </ul></ul>
- <br>
- <br>
- <ul><b>glance</b><ul>
- <code>set <Pushover_device> glance [<text>] [<option1>=<value> <option2>="<value with space in it>" ...]</code>
- <br>
- <br>
- Aktualisiert die <a href="https://pushover.net/api/glances">Pushover glances</a> auf einer Apple Watch.<br>
- Die folgenden Optionen können genutzt werden, um den Nachrichteninhalt und die Zustellung zu beeinflussen::<br>
- <br>
- <code><b>title</b> </code> - type: text(100 characters) - Eine Beschreibung der Daten, die angezeigt werden, beispielsweise "Verkaufte Dinge".<br>
- <code><b>text</b> </code> - type: text(100 characters) - Textzeile, die in den meisten Ansichten verwendet wird. Die Nutzung dieser Option hat Vorrang; Text außerhalb wird verworfen.<br>
- <code><b>subtext</b> </code> - type: text(100 characters) - Eine zweite Zeile mit Text.<br>
- <code><b>count</b> </code> - type: integer(may be negative) - Wird auf kleineren Ansichten dargestellt; nützlich für einfache Zählerstände.<br>
- <code><b>percent</b> </code> - type: integer(0-100) - Wird bei einigen Ansichten als Fortschrittsbalken/-kreis angezeigt.<br>
- <code><b>device</b> </code> - Typ: Text - Dein selbst vergebener Gerätename, um die Nachricht direkt an dieses Gerät zu senden anstatt an alle Geräte gleichzeitig (mehrere Geräte können mit Komma getrennt angegeben werden). Hier kann auch explizit ein User oder Group Key angegeben werden. Um gezielt ein Gerät einer/s speziellen User/Group anzusprechen, zuerst den User/Group Key angeben, gefolgt vom Gerätenamen und einem Doppelpunkt als Trennzeichen.<br>
- <br>
- </ul></ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="PushoverAttr"></a>
- <b>Attributes</b>
- <ul>
- <li>
- <a href="#do_not_notify">do_not_notify</a>
- </li>
- <li>
- <a href="#disabledForIntervals">disabledForIntervals</a>
- </li>
- <li>
- <a href="#readingFnAttributes">readingFnAttributes</a>
- </li>
- <li><a name="PushoverAttrcallbackUrl"></a><code>callbackUrl</code><br>
- Setzt die Callback URL, um Nachrichten mit Emergency Priorität zu bestätigen.
- </li>
- <li><a name="PushoverAttrtimestamp"></a><code>timestamp</code><br>
- Sende den Unix-Zeitstempel mit jeder Nachricht.
- </li>
- <li><a name="title"></a><code>title</code><br>
- Wird beim Senden als Titel verwendet, sofern dieser nicht als Aufrufargument angegeben wurde.
- </li>
- <li><a name="PushoverAttrdevice"></a><code>device</code><br>
- Wird beim Senden als Gerätename verwendet, sofern dieser nicht als Aufrufargument angegeben wurde. Kann auch generell entfallen, bzw. leer sein, dann wird an alle Geräte gesendet.
- </li>
- <li><a name="PushoverAttrpriority"></a><code>priority</code><br>
- Wird beim Senden als Priorität verwendet, sofern diese nicht als Aufrufargument angegeben wurde. Zulässige Werte sind -1 = leise / 0 = normale Priorität / 1 = hohe Priorität
- </li>
- <li><a name="PushoverAttrexpire"></a><code>expire</code><br>
- Wenn die Nachrichten Priorität 2 ist, wird dieser Wert als Standard für expire verwendet, falls dieser nicht in der Nachricht angegeben wurde. Muss 30 oder höher sein.
- </li>
- <li><a name="PushoverAttrretry"></a><code>retry</code><br>
- Wenn die Nachrichten Priorität 2 ist, wird dieser Wert als Standard für retry verwendet, falls dieser nicht in der Nachricht angegeben wurde.
- </li>
- <li><a name="PushoverAttrsound"></a><code>sound</code><br>
- Wird beim Senden als Titel verwendet, sofern dieser nicht als Aufrufargument angegeben wurde. Kann auch generell entfallen, dann wird der eingestellte Ton der App verwendet.
- </li>
- <li><a name="PushoverAttrstorage"></a><code>storage</code><br>
- Wird als Standardpfad beim Versand von Anhängen verwendet, ansonsten wird das globale Attribut modpath benutzt.
- </li>
- </ul>
- <br>
- <a name="PushoverEvents"></a>
- <b>Generated events:</b>
- <ul>
- N/A
- </ul>
- </ul>
- <p><a name="Pushsafer"></a>
- <h3>Pushsafer</h3>
- <div class='langLinks'>[<a href='commandref.html#Pushsafer'>EN</a> DE]</div>
- <ul>
- Pushsafer ist ein Dienst, um Benachrichtigungen von einer Vielzahl
- unterschiedlicher Quellen auf einem iOS-, Android-, Windows 10 Phone oder Desktop-Gerät zu empfangen.<br>
- Es wird ein personalisierter Account benötigt um dieses Modul zu verwenden.<br>
- Weitere Information zum Pushsafer-Dienst gibt es unter <a href="https://www.pushsafer.com" target="_new">pushsafer.com</a>.<br>
- <br>
- Dieses Modul dient lediglich zum Versand von Nachrichten über Pushsafer.<br>
- <br>
- <br>
- <a name="PushsaferDefine"></a>
- <b>Define</b>
- <ul>
- <code>define <Name> Pushsafer <Schlüssel></code><br>
- <br>
- Der Parameter <Schlüssel> muss eine alphanumerische Zeichenkette sein. Hierbei kann es sich um einen regulären privaten Schlüssel (20 Zeichen lang) handeln oder um einen Email-Alias-Schlüssel (15 Zeichen lang), welcher in einem Account entsprechend eingerichtet sein muss.<br>
- <br>
- Beispiel:
- <ul>
- <code>define PushsaferAccount Pushsafer A1b2c3D4E5F6g7h8i9J0</code>
- </ul>
- </ul>
- <br>
- <a name="PushsaferSet"></a>
- <b>Set</b>
- <ul>
- <code>set <Name> message <Nachricht> [<Option1>=<Wert> <Option2>=<Wert> ...]</code><br>
- <br>
- Aktuell wird nur das "message"-Kommando unterstützt um Nachrichten zu versenden.<br>
- <br>
- Der einfachste Anwendungsfall ist das Versenden einer einfachen Textnachricht wie im folgenden Beispiel:<br>
- <br>
- <code>set PushsaferAccount message "Meine erste Pushsafer Nachricht."</code><br>
- <br>
- Um eine mehrzeilige Nachricht zu schicken, kann man den Platzhalter "\n" für einen Zeilenumbruch verwenden:<br>
- <br>
- <code>set PushsaferAccount message "Meine zweite Pushsafer Nachricht.\nDiesmal mit zwei Zeilen."</code><br>
- <br>
- <u>Optionale Zusatzparameter</u><br>
- <br>
- Es ist möglich die zu versendende Nachricht durch zusätzliche Optionen an die eigenen Wünsche anzupassen. Diese Optionen können hinter dem Nachrichtentext beliebig kombiniert werden um die Nachricht zu individualisieren. Die möglichen Optionen sind:<br>
- <br>
- <code><b>title</b> </code> - Kurzform: <code>t </code> - Typ: Text - Eine Überschrift, die über der Nachricht hervorgehoben angezeigt werden soll.<br>
- <code><b>device</b> </code> - Kurzform: <code>d </code> - Typ: Text - Die Geräte-ID als Ganzzahl an welche die Nachricht gezielt geschickt werden soll. Um eine Gruppen-ID direkt zu addressieren muss der ID das Präfix "gs" vorangestellt werden (Bsp. "gs23" für die Gruppen-ID 23). Standardmäßig wird eine Nachricht immer an alle Geräte geschickt, die mit dem Account verknüpft sind.<br>
- <code><b>sound</b> </code> - Kurzform: <code>s </code> - Typ: Ganzzahl - Die Nummer eines Tons, welcher beim Empfang der Nachricht auf dem Zielgerät ertönen soll (siehe <a href="https://www.pushsafer.com/de/pushapi" target="_new">pushsafer.com</a> für eine Liste möglicher Werte).<br>
- <code><b>icon</b> </code> - Kurzform: <code>i </code> - Typ: Ganzzahl - Die Nummer eines Icons, welches zusammen mit der Nachricht auf dem Zielgerät angezeigt werden soll (siehe <a href="https://www.pushsafer.com/de/pushapi" target="_new">Pushsafer.com</a> für eine Liste möglicher Werte).<br>
- <code><b>vibration</b></code> - Kurzform: <code>v </code> - Typ: Ganzzahl - Die Anzahl, wie oft das Zielgerät vibrieren soll beim Empfang der Nachricht (maximal 3 mal; nur für iOS-/Android-Geräte nutzbar). Falls nicht benutzt, wird die geräteinterne Einstellung verwendet.<br>
- <code><b>url</b> </code> - Kurzform: <code>u </code> - Typ: Text - Eine URL, welche der Nachricht angehangen werden soll. Dies kann eine normale http:// bzw. https:// URL sein, es sind jedoch auch weitere spezielle Schemas möglich. Eine Liste aller möglichen URL-Schemas gibt es unter <a href="https://www.pushsafer.com/de/url_schemes" target="_new">pushsafer.com</a> .<br>
- <code><b>urlText</b> </code> - Kurzform: <code>ut</code> - Typ: Text - Der Text, welcher zum Anzeigen der URL benutzt werden soll anstatt der Zieladresse.<br>
- <code><b>key</b> </code> - Kurzform: <code>k </code> - Typ: Text - Übersteuert den zu nutzenden Schlüssel zur Identifikation aus dem define-Kommando. Es kann hierbei auch ein Email-Alias-Schlüssel benutzt werden.<br>
- <code><b>ttl</b> </code> - Kurzform: <code>l </code> - Typ: Ganzzahl - Die Lebensdauer der Nachricht in Minuten. Sobald die Lebensdauer erreicht ist, wird die Nachricht selbstständig auf allen Geräten gelöscht. Der mögliche Wertebereich liegt zwischen 1 - 43200 Minuten (entspricht 30 Tagen).<br>
- <code><b>picture</b> </code> - Kurzform: <code>p </code> - Typ: Text - Anhängen eines Bildes zur Nachricht. Dies kann ein Dateipfad zu einer Bilddatei sein (z.B. <code>picture=/home/user/Bild.jpg</code>) oder der Name einer IPCAM-Instanz (im Format: <code>picture=IPCAM:<i><Name></i></code>) um die letzte Aufnahme zu senden (Bsp. <code>picture=IPCAM:IpKamera_Einganstuer</code>). Es werden die Dateiformate JPG, PNG und GIF unterstüzt.<br>
- <code><b>picture2</b> </code> - Kurzform: <code>p2</code> - Typ: Text - Gleiche Syntax wie die Option <code>"picture"</code>.<br>
- <code><b>picture3</b> </code> - Kurzform: <code>p3</code> - Typ: Text - Gleiche Syntax wie die Option <code>"picture"</code>.<br>
- <br>
- Beispiele:<br>
- <br>
- <ul>
- <code>set PushsaferAccount message "Dies ist eine Nachricht mit Überschrift." title="Sehr Wichtig!!"</code><br>
- <code>set PushsaferAccount message "Komm runter\nwir warten" title="Mittag ist fertig" device=100</code><br>
- <code>set PushsaferAccount message "Server ist nicht erreichbar" sound=25 icon=5 vibration=3</code><br>
- <code>set PushsaferAccount message "Hier sind die Urlaubsfotos" url="http://www.foo.de/fotos" urlText="Sommerurlaub"</code><br>
- <br>
- It is also possible to use the short-term versions of options:<br>
- <br>
- <code>set PushsaferAccount message "Dies ist eine Nachricht mit Überschrift." t="Sehr Wichtig!!"</code><br>
- <code>set PushsaferAccount message "Komm runter\nwir warten" t="Mittag ist fertig" d=100</code><br>
- <code>set PushsaferAccount message "Server ist nicht erreichbar" s=25 i5 v=3</code><br>
- <code>set PushsaferAccount message "Hier sind die Urlaubsfotos" u="http://www.foo.de/fotos" ut="Sommerurlaub"</code><br>
- </ul>
- <br>
- </ul>
- <br>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="PushsaferAttr"></a>
- <a name="PushsaferAttr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#disabled">disabled</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- </ul>
- <br>
- <a name="PushsaferEvents"></a>
- <b>Generierte Readings/Events:</b><br>
- <ul>
- <li><b>lastSuccess</b> - Die letzte erfolgreiche Statusmeldung vom Pushsafer Server</li>
- <li><b>lastError</b> - Die letzte Fehlermeldung vom Pushsafer Server</li>
- <li><b>availableMessages-<i><Geräte-ID></i>-<i><Geräte-Name></i></b> - Die verbleibende Anzahl an Nachrichten die zu diesem Gerät noch gesendet werden können</li>
- </ul>
- </ul>
- <p><a name="QRCode"></a>
- <h3>QRCode</h3>
- <div class='langLinks'>[<a href='commandref.html#QRCode'>EN</a> DE]</div>
- <ul>
- Mit hilfe dieses Moduls, kann auf einfache Weise eine URL generiert werden, mit
- der vom Dienstleister TEC-IT ein QRCode abgerufen werden kann.<br/>
- Ein Device dieses Moduls kann außerdem den QRCode auch selbst direkt in FHEMWEB
- darstellen und auch anderen Devices (bspw. weblink) als HTML zur Verfügung stellen.
- <br/><br/>
- <b>HINWEIS:</b> Es ist ohne schriftliche Genehmigung des Dienstaanbieters nur erlaubt,
- maximal 30 QRCode-Abrufe / Minute durchzuführen.<br/><br/>
- Siehe dazu auch die Nutzungsbedingungen von TEC-IT: http://qrcode.tec-it.com/de#TOS
- <br/><br/>
- <a name="QRCodedefine"></a>
- <b>Define</b><br/>
- <ul>
- <code>define <name> QRCode</code>
- <br/><br/>
- </ul>
- <br/>
- <a name="QRCodeset"></a>
- <b>Set</b><br/>
- <ul>
- <code>set <name> update</code><br/>
- Führt eine aktualisierung der QRCode-Url durch.
- </ul>
- <br/>
- <a name="QRCodeattr"></a>
- <b>Attributes</b><br/><br/>
- <ul>
- <b>QRCode-URL-relevante Attribute</b>
- <br/><br/>
- Die folgenden Attribute sind für die Erzeugung der Abruf-URL relevant und haben somit<br/>
- direkten Einfluß auf die Erzeugung des QRCode-Images.<br/><br/>
- Für diese Attribute wird bei Änderung, standardmäßig ein automatisches Udate der QRCode-URL<br/>
- durchgeführt. Dies kann durch setzen des Attirbutes qrNoAutoUpdate (s.w.u.) deaktiviert werden.
- <br/><br/>
- <li><a name="qrData">qrData</a><br/>
- Dieses Attribut legt die Daten fest, die im QRCode kodiert werden sollen.<br/>
- Ist dieses Attribut nicht gesetzt, wird beim update eine entsprechende
- Fehlermeldung erzeugt.
- <br/><br/>
- </li>
- <li><a name="qrSize">qrSize</a><br/>
- Dieses Attribut legt die Größe fest, in der das QRCode-Image erstellt werden
- soll.<br/> Mögliche Ausprägungen sind small, medium (default), large.
- <br/><br/>
- </li>
- <li><a name="qrResolutionDPI">qrResolutionDPI</a><br/>
- Dieses Attribut legt die Auflösung fest, in der das QRCode-Image erstellt werden
- soll.<br/> Mögliche Werte liegen zwischen 96 und 600 (Default ist 300dpi)
- <br/><br/>
- </li>
- <li><a name="qrColor">qrColor</a><br/>
- Dieses Attribut legt die Vordergrundfarbe fest, in der das QRCode-Image erstellt werden
- soll.<br/> Der Wert ist ein RGB-Farbwert in Hexadezimaler schreibweise (Bspw. FF0000 für rot)
- Default ist 000000 (schwarz)
- <br/><br/>
- </li>
- <li><a name="qrBackColor">qrBackColor</a><br/>
- Dieses Attribut legt die Hintergrundfarbe fest, in der das QRCode-Image erstellt werden
- soll.<br/> Der Wert ist ein RGB-Farbwert in Hexadezimaler schreibweise (Bspw. 0000FF für blau)
- Default ist FFFFFF (weiß).
- <br/><br/>
- </li>
- <li><a name="qrTransparent">qrTransparent</a><br/>
- Dieses Attribut legt fest, ob der Hintergrund transparent sein soll.<br/>
- Mögliche Werte sind True für transparenten Hintergrund und False für nicht-transparenten
- Hintergrund (default)
- <br/><br/>
- </li>
- <li><a name="qrQuietZone">qrQuietZone</a><br/>
- Über diesen Wert kann eine Ruhe-Zone, also ein Rand um den eigentlichen QRCode festgelegt
- werden.<br/> Dies ermöglicht ggf. ein erleichtertes Erfassen des QRCodes beim Scannen.<br/>
- Mögliche Werte sind positive numerische Werte. Default ist 0, wenn das Attribut nicht gesetzt ist.
- <br/><br/>
- </li>
- <li><a name="qrQuietUnit">qrQuietUnit</a><br/>
- Über diesen Wert kann die Maßeinheit für das Festlegen einer Ruhe-Zone eingestellt werden.<br/>
- Mögliche Ausptägungen sind mm (default), in (=inch), mil (=mils), mod (=Module) oder px (=Pixel).
- <br/><br/>
- </li>
- <li><a name="qrCodepage">qrCodepage</a><br/>
- Über diesen Wert kann die Zeichentabelle für die QRCode-Erzeugung festgelegt werden.<br/>
- Mögliche Werte sind UTF8 (default), Cyrillic oder Ansi
- <br/><br/>
- </li>
- <li><a name="qrErrorCorrection">qrErrorCorrection</a><br/>
- Über diesen Wert kann Fehlerkorrektur für die QRCode-Erzeugung festgelegt werden.<br/>
- Mögliche Werte sind L (default), M,Q oder H
- <br/><br/>
- </li>
-
- <b>darstellungsrelevante Attribute</b>
- <br/><br/>
- Die folgenden Attribute haben nur Einfluß auf das Verhalten und die Darstellung in FHEMWEB<br/>
- in der Deatailansicht des QRCode-Devices, bzw. beim Abruf der HTML-Daten mittels
- QRCode_getHtml (s.u.)<br/><br/>
- Im Fehlerfall wird weder der QRCode, noch qrDisplayText dargestellt, sondern eine entsprechend<br/>
- Fehlermeldung stattdessen eingeblendet.
- <br/><br/>
- <li><a name="qrDisplayWidth">qrDisplayWidth</a><br/>
- Breite des Images bei der Darstellung in FHEMWEB in der Detailübersicht<br/>
- Default ist 200
- <br/><br/>
- </li>
- <li><a name="qrDisplayHeigth">qrDisplayHeight</a><br/>
- Höhe des Images bei der Darstellung in FHEMWEB in der Detailübersicht<br/>
- Default ist 200
- <br/><br/>
- </li>
- <li><a name="qrDisplayData">qrDisplayData</a><br/>
- Wenn dieses Attribut gesetzt ist, wird unterhalb des QRCodes der Datenteil als einfacher<br/>
- Text dargestellt.
- <br/><br/>
- </li>
- <li><a name="qrDisplayNoImage">qrDisplaNoImage</a><br/>
- Wenn dieses Attribut gesetzt ist, der QRCode nicht in der Detailansicht dargestellt.
- <br/><br/>
- </li>
- <li><a name="qrDisplayText">qrDisplaText</a><br/>
- Hier kann ein beliebiger Text eingetragen werden, der unterhalb des QRCodes eingeblendet werden soll.
- <br/><br/>
- </li>
- <li><a name="qrDisplayNoText">qrDisplaNoText</a><br/>
- Ist dieses Attribut gesetzt, so wird der, im Attribut qrDisplayText eingetragene Text nicht
- eingeblendet, auch ohne das Attribut qrDisplayText zu löschen.
- <br/><br/>
- </li>
- <li><a name="qrNoAutoUpdate">qrNoAutoUpdate</a><br/>
- Ist dieses Attribut gesetzt, so wird bei Änderung eines für die QRCode-Erzeugung relevanten<br/>
- Attributs kein automatisches Update der QRCode-URL durchgeführt.
- <br/><br/>
- </li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br/><br/>
- <a name="QRCodereadings"></a>
- <b>Erzeugte Readings</b>
- <br/><br/>
- <ul>
- <br/>
- <li>data<br/>
- Dieses Reading enthält die vom QRCode zu kodierenden Daten.<br/>
- Das ist im Normalfall der Inhalt aus dem Attribut qrData.<br/>
- Im Fehlerfall steht hier stattdessen der entsprechende Fehlertext.
- <br/><br/>
- </li>
- <li>qrcode_url<br/>
- Dies ist die durch <code>set update</code> erzeugte URL, die für den Abruf des QRCode-Image<br/>
- verwendet wird.
- <br/><br/>
- </li>
- <li>state<br/>
- Status des QRCode-Device.<br/>
- Das ist entweder <code>defined</code>, oder der Zeitpunkt des letzten <code>set update</code>, bzw. auto-update
- <br/><br/>
- </li>
- </ul>
- <br/><br/>
-
- <a name="QRCodefunctions"></a>
- <b>Enthaltene Funktionen</b>
- <br/><br/>
- Es gibt im Modul eine Funktion, die auch für andere Anwendungsfälle einsetzbar ist, wie bspw. in einem weblink
- <br/><br/>
- <ul>
- <br/>
- <li><code>QRCode_getHtml($;$$)</code><br/><br/>
- Die Funktion gibt den HTML-Code zurück, wie er auch für die Darstellung im QRCode-Device in der<br/>
- Detail-Ansicht verwendet wird.
- <br/><br/>
- Parameter:
- <br/><br/>
- <ul>
- <li>QRCodeDevice<br/>
- Hier ist der Name des QRCode-Devices anzugeben, dessen HTML-Code abgerufen werden soll.
- </li>
- <li>noImage (Optional)<br/>
- Entspricht dem Attribut qrDisplayNoImage<br/>
- Wenn dieser Parameter angezeigt wird, wird also keine Referenz auf QRCode-Image im HTML-Code<br/>
- erzeugt.
- </li>
- <li>noText (Optional)<br/>
- Entspricht dem Attribut qrDisplayNoText<br/>
- Wenn dieser Parameter angezeigt wird, wird also Benutzerdefinierter Text unterhalb des QRCode<br/>
- im HTML-Code erzeugt.
- </li>
- </ul>
- <br/><br/>
- Beispiel:
- <br/><br/>
- <code>QRCode_getHtml('MyQRCode',1,0)</code>
- <br/><br/>
- Damit wird der HTML-Code für das (QRCode-)Device MyQRCode abgerufen, das nur das Image enthält,<br>
- aber nicht den Benutzerdefinierten text.
-
-
- </li>
- </ul>
- </ul>
- <p> <p>
- <a name="RESIDENTS" id="RESIDENTS"></a>
- </p>
- <h3>
- RESIDENTS
- </h3>
- <div class='langLinks'>[<a href='commandref.html#RESIDENTS'>EN</a> DE]</div>
- <ul>
- <a name="RESIDENTSdefine" id="RESIDENTSdefine"></a> <b>Define</b>
- <ul>
- <code>define <rgr_ResidentsName> RESIDENTS</code><br>
- <br>
- Stellt ein spezielles virtuelles Device bereit, um eine Gruppe von Personen zu repräsentieren, die zusammen wohnen.<br>
- Es kombiniert dabei logisch die individuellen Status von <a href="#ROOMMATE">ROOMMATE</a> und <a href="#GUEST">GUEST</a> Devices und erlaubt den Status für alle Mitglieder zeitgleich zu ändern. Basierend auf dem aktuellen Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br>
- <br>
- Beispiele:<br>
- <ul>
- <code># Einzeln<br>
- define rgr_Residents RESIDENTS</code>
- </ul>
- </ul><br>
- <br>
- <a name="RESIDENTSset" id="RESIDENTSset"></a> <b>Set</b>
- <ul>
- <code>set <rgr_ResidentsName> <command> [<parameter>]</code><br>
- <br>
- Momentan sind die folgenden Kommandos definiert.<br>
- <ul>
- <li>
- <b>addGuest</b> - erstellt ein neues GUEST Device und fügt es der aktuellen RESIDENTS Gruppe hinzu. Einfach den Platzhalternamen eingeben und das wars.
- </li>
- <li>
- <b>addRoommate</b> - erstellt ein neues ROOMMATE Device und fügt es der aktuellen RESIDENTS Gruppe hinzu. Einfach den Vornamen eingeben und das wars.
- </li>
- <li>
- <b>removeGuest</b> - zeigt alle Mitglieder vom Typ GUEST an und ermöglicht ein einfaches löschen des dazugehörigen Dummy Devices.
- </li>
- <li>
- <b>removeRoommate</b> - zeigt alle Mitglieder vom Typ ROOMMATE an und ermöglicht ein einfaches löschen des dazugehörigen Dummy Devices.
- </li>
- <li>
- <b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status für alle Gruppenmitglieder gleichzeitig; siehe Attribut rgr_states, um die angezeigte Liste in FHEMWEB abzuändern
- </li>
- <li>
- <b>create</b> wakeuptimer fügt diverse Vorkonfigurationen auf Basis von RESIDENTS Toolkit hinzu. Siehe separate Sektion.
- </li>
- </ul>
- <ul>
- <u>Hinweis:</u> Sofern der Zugriff auf administrative set-Kommandos (-> addGuest, addRoommate, removeGuest, create) eingeschränkt werden soll, kann in einer FHEMWEB Instanz das Attribut allowedCommands ähnlich wie 'set,set-user' erweitert werden.
- Die Zeichenfolge 'set-user' stellt dabei sicher, dass beim Zugriff auf FHEM über diese FHEMWEB Instanz nur nicht-administrative set-Kommandos ausgeführt werden können.
- </ul>
- </ul><br>
- <br>
- <ul>
- <u>Mögliche Status und ihre Bedeutung</u><br>
- <br>
- <ul>
- Dieses Modul unterscheidet 7 verschiedene Status:<br>
- <br>
- <ul>
- <li>
- <b>home</b> - Bewohner sind zu Hause und mindestens einer schläft nicht
- </li>
- <li>
- <b>gotosleep</b> - alle anwesenden Bewohner sind auf dem Weg ins Bett (wenn sie nicht schon schlafen)
- </li>
- <li>
- <b>asleep</b> - alle anwesenden Bewohner schlafen
- </li>
- <li>
- <b>awoken</b> - mindestens einer der anwesenden Bewohner ist gerade aufgewacht
- </li>
- <li>
- <b>absent</b> - keiner der Bewohner ist momentan zu Hause; mindestens einer ist aber in Kürze zurück
- </li>
- <li>
- <b>gone</b> - alle Bewohner sind für längere Zeit verreist
- </li>
- <li>
- <b>none</b> - kein Mitglied aktiv
- </li>
- </ul><br>
- <br>
- Hinweis: Der Status 'none' kann nicht explizit gesetzt werden. Das setzen von 'gone' wird bei Mitgliedern vom Typ GUEST als 'none' behandelt.
- </ul>
- </ul><br>
- <br>
- <a name="RESIDENTSattr" id="RESIDENTSattr"></a> <b>Attribute</b><br>
- <ul>
- <ul>
- <li>
- <b>rgr_lang</b> - überschreibt globale Spracheinstellung; hilft beim setzen von Device Attributen, um FHEMWEB Anzeigetext zu übersetzen
- </li>
- <li>
- <b>rgr_noDuration</b> - deaktiviert die kontinuierliche, nicht Event-basierte Berechnung der Zeitspannen (siehe Readings durTimer*)
- </li>
- <li>
- <b>rgr_showAllStates</b> - die Status 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0
- </li>
- <li>
- <b>rgr_states</b> - Liste aller in FHEMWEB angezeigter Status; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Status führen zu Fehlern
- </li>
- <li>
- <b>rgr_wakeupDevice</b> - Referenz zu versklavten DUMMY Geräten, welche als Wecker benutzt werden (Teil von RESIDENTS Toolkit's wakeuptimer)
- </li>
- </ul>
- </ul><br>
- <br>
- <br>
- <b>Generierte Readings/Events:</b><br>
- <ul>
- <ul>
- <li>
- <b>lastActivity</b> - der letzte Status Wechsel eines Gruppenmitglieds
- </li>
- <li>
- <b>lastActivityBy</b> - der Name des Gruppenmitglieds, dessen Status zuletzt geändert wurde
- </li>
- <li>
- <b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause
- </li>
- <li>
- <b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus
- </li>
- <li>
- <b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses
- </li>
- <li>
- <b>lastDurAbsence</b> - Dauer der letzten Abwesenheit in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurAbsence_cr</b> - Dauer der letzten Abwesenheit in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastDurPresence</b> - Dauer der letzten Anwesenheit in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurPresence_cr</b> - Dauer der letzten Anwesenheit in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastDurSleep</b> - Dauer des letzten Schlafzyklus in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurSleep_cr</b> - Dauer des letzten Schlafzyklus in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus
- </li>
- <li>
- <b>lastState</b> - der vorherige Status
- </li>
- <li>
- <b>lastWakeup</b> - Zeit der letzten Wake-up Timer Ausführing
- </li>
- <li>
- <b>lastWakeupDev</b> - Device Name des zuletzt verwendeten Wake-up Timers
- </li>
- <li>
- <b>nextWakeup</b> - Zeit der nächsten Wake-up Timer Ausführung
- </li>
- <li>
- <b>nextWakeupDev</b> - Device Name des als nächstes ausgefährten Wake-up Timer
- </li>
- <li>
- <b>presence</b> - gibt den zu Hause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)
- </li>
- <li>
- <b>residentsAbsent</b> - Anzahl der Bewohner mit Status 'absent'
- </li>
- <li>
- <b>residentsAbsentDevs</b> - Gerätename der Bewohner mit Status 'absent'
- </li>
- <li>
- <b>residentsAbsentNames</b> - Gerätealias der Bewohner mit Status 'absent'
- </li>
- <li>
- <b>residentsAsleep</b> - Anzahl der Bewohner mit Status 'asleep'
- </li>
- <li>
- <b>residentsAsleepDevs</b> - Gerätename der Bewohner mit Status 'asleep'
- </li>
- <li>
- <b>residentsAsleepNames</b> - Gerätealias der Bewohner mit Status 'asleep'
- </li>
- <li>
- <b>residentsAwoken</b> - Anzahl der Bewohner mit Status 'awoken'
- </li>
- <li>
- <b>residentsAwokenDevs</b> - Gerätename der Bewohner mit Status 'awoken'
- </li>
- <li>
- <b>residentsAwokenNames</b> - Gerätealias der Bewohner mit Status 'awoken'
- </li>
- <li>
- <b>residentsGone</b> - Anzahl der Bewohner mit Status 'gone'
- </li>
- <li>
- <b>residentsGoneDevs</b> - Gerätename der Bewohner mit Status 'gone'
- </li>
- <li>
- <b>residentsGoneNames</b> - Gerätealias der Bewohner mit Status 'gone'
- </li>
- <li>
- <b>residentsGotosleep</b> - Anzahl der Bewohner mit Status 'gotosleep'
- </li>
- <li>
- <b>residentsGotosleepDevs</b> - Gerätename der Bewohner mit Status 'gotosleep'
- </li>
- <li>
- <b>residentsGotosleepNames</b> - Gerätealias der Bewohner mit Status 'gotosleep'
- </li>
- <li>
- <b>residentsHome</b> - Anzahl der Bewohner mit Status 'home'
- </li>
- <li>
- <b>residentsHomeDevs</b> - Gerätename der Bewohner mit Status 'home'
- </li>
- <li>
- <b>residentsHomeNames</b> - Gerätealias der Bewohner mit Status 'home'
- </li>
- <li>
- <b>residentsTotal</b> - Summe aller aktiven Bewohner unabhängig von ihrem aktuellen Status
- </li>
- <li>
- <b>residentsTotalAbsent</b> - Summe aller aktiven Bewohner, die unterwegs sind
- </li>
- <li>
- <b>residentsTotalAbsentDevs</b> - Gerätename aller aktiven Bewohner, die unterwegs sind
- </li>
- <li>
- <b>residentsTotalAbsentNames</b> - Gerätealias aller aktiven Bewohner, die unterwegs sind
- </li>
- <li>
- <b>residentsTotalGuests</b> - Anzahl der aktiven Gäste, welche momentan du den Bewohnern dazugezählt werden
- </li>
- <li>
- <b>residentsTotalGuestsAbsent</b> - Anzahl der aktiven Gäste, die momentan unterwegs sind
- </li>
- <li>
- <b>residentsTotalGuestsAbsentDevs</b> - Gerätename der aktiven Gäste, die momentan unterwegs sind
- </li>
- <li>
- <b>residentsTotalGuestsAbsentNames</b> - Gerätealias der aktiven Gäste, die momentan unterwegs sind
- </li>
- <li>
- <b>residentsTotalGuestsPresent</b> - Anzahl der aktiven Gäste, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalGuestsPresentDevs</b> - Gerätename der aktiven Gäste, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalGuestsPresentNames</b> - Gerätealias der aktiven Gäste, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalRoommates</b> - Anzahl der Bewohner, die als permanente Bewohner behandelt werden
- </li>
- <li>
- <b>residentsTotalRoommatesAbsent</b> - Anzahl der Besitzer, die momentan unterwegs sind
- </li>
- <li>
- <b>residentsTotalRoommatesAbsentDevs</b> - Gerätename der Besitzer, die momentan unterwegs sind
- </li>
- <li>
- <b>residentsTotalRoommatesAbsentNames</b> - Gerätealias der Besitzer, die momentan unterwegs sind
- </li>
- <li>
- <b>residentsTotalRoommatesPresent</b> - Anzahl der Besitzer, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalRoommatesPresentDevs</b> - Gerätename der Besitzer, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalRoommatesPresentNames</b> - Gerätealias der Besitzer, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalPresent</b> - Summe aller aktiven Bewohner, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalPresentDevs</b> - Gerätename aller aktiven Bewohner, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalPresentNames</b> - Gerätealias aller aktiven Bewohner, die momentan zu Hause sind
- </li>
- <li>
- <b>residentsTotalWakeup</b> - Summe aller Bewohner, bei denen aktuell ein Weckprogramm ausgeführt wird
- </li>
- <li>
- <b>residentsTotalWakeupDevs</b> - Gerätename aller Bewohner, bei denen aktuell ein Weckprogramm ausgeführt wird
- </li>
- <li>
- <b>residentsTotalWakeupNames</b> - Gerätealias aller Bewohner, bei denen aktuell ein Weckprogramm ausgeführt wird
- </li>
- <li>
- <b>residentsTotalWayhome</b> - Summe aller aktiven Bewohner, die momentan auf dem Weg zurück nach Hause sind
- </li>
- <li>
- <b>residentsTotalWayhomeDevs</b> - Gerätename aller aktiven Bewohner, die momentan auf dem Weg zurück nach Hause sind
- </li>
- <li>
- <b>residentsTotalWayhomeNames</b> - Gerätealias aller aktiven Bewohner, die momentan auf dem Weg zurück nach Hause sind
- </li>
- <li>
- <b>residentsTotalWayhomeDelayed</b> - Summe aller Bewohner, die momentan mit Verspätung auf dem Weg zurück nach Hause sind
- </li>
- <li>
- <b>residentsTotalWayhomeDelayedDevs</b> - Gerätename aller Bewohner, die momentan verspätet auf dem Weg zurück nach Hause sind
- </li>
- <li>
- <b>residentsTotalWayhomeDelayedNames</b> - Gerätealias aller Bewohner, die momentan verspätet auf dem Weg zurück nach Hause sind
- </li>
- <li>
- <b>state</b> - gibt den aktuellen Status wieder
- </li>
- <li>
- <b>wakeup</b> - hat den Wert '1' während ein Weckprogramm dieser Bewohner-Gruppe ausgeführt wird
- </li>
- </ul>
- </ul>
- <br>
- <br>
- <b>RESIDENTS Toolkit</b><br>
- <ul>
- <ul>
- Mit dem set-Kommando <code>create</code> können zur Vereinfachung vorkonfigurierte Konfigurationen zu RESIDENTS, <a href="#ROOMMATE">ROOMMATE</a> oder <a href="#GUEST">GUEST</a> Geräten hinzugefügt werden.<br>
- Die folgenden Kommandos sind momentan verfügbar:<br>
- <br>
- <li>
- <b>wakeuptimer</b> - fügt ein Dummy Gerät mit erweiterten Funktionen als Wecker hinzu, um darauf Weck-Automationen aufzubauen.
- <ul>
- Ein notify Gerät wird als Makro erstellt, um die eigentliche Automation auszuführen. Das Makro wird durch ein normales at-Gerät ausgelöst und kann ebenfalls angepasst werden. Die Hauptfunktion wird dabei trotzdem von einer speziellen RESIDENTS Toolkit funktion gehandhabt.<br>
- Die Zeit aktiver Wecker kann mittels +<MINUTEN> oder -<MINUTEN> relativ erhöht bzw. verringert werden. Die Angabe als +HH:MM ist auch möglich.<br>
- <br>
- Die Weckfunktion kann wie folgt über Attribute beinflusst werden:<br>
- <li>
- <i>wakeupAtdevice</i> - Backlink zum at Gerät (notwendig)
- </li>
- <li>
- <i>wakeupDays</i> - Makro nur an bestimmten Tagen auslösen. Mon=1,Di=2,Mi=3,Do=4,Fr=5,Sa=6,So=0 (optional)
- </li>
- <li>
- <i>wakeupDefaultTime</i> - Stellt die Weckzeit nach dem auslösen zurück auf diesen Standardwert (optional)
- </li>
- <li>
- <i>wakeupEnforced</i> - Forciertes wecken (optional; 0=nein, 1=ja, 2=wenn Weckzeit ungleich wakeupDefaultTime, 3=wenn Weckzeit früher ist als wakeupDefaultTime)
- </li>
- <li>
- <i>wakeupHolidays</i> - Makro u.U. an Feiertagen oder Nicht-Feiertagen ausführen (optional; andHoliday=an Feiertagen ggf. zusammen mit wakeupDays, orHoliday=an Feiertagen unabhängig von wakeupDays, andNoHoliday=an Nicht-Feiertagen ggf. zusammen mit wakeupDays, orNoHoliday=an Nicht-Feiertagen unabhängig von wakeupDays)
- </li>
- <li>
- <i>wakeupMacro</i> - Name des notify Makro Gerätes (notwendig)
- </li>
- <li>
- <i>wakeupOffset</i> - Wert in Minuten, die das Makro früher ausgelöst werden soll, z.B. bei komplexen Weckprogrammen über einen Zeitraum von 30 Minuten (Standard ist 0)
- </li>
- <li>
- <i>wakeupResetSwitcher</i> - das DUMMY Device, welches zum schnellen ein/aus schalten der Resetfunktion verwendet wird (optional, Device wird automatisch angelegt)
- </li>
- <li>
- <i>wakeupResetdays</i> - sofern wakeupDefaultTime gesetzt ist, kann der Reset hier auf betimmte Tage begrenzt werden. Mon=1,Di=2,Mi=3,Do=4,Fr=5,Sa=6,So=0 (optional)
- </li>
- <li>
- <i>wakeupUserdevice</i> - Backlink zum RESIDENTS, ROOMMATE oder GUEST Gerät, um dessen Status zu prüfen (notwendig)
- </li>
- <li>
- <i>wakeupWaitPeriod</i> - Schwelle der Wartezeit in Minuten bis das Weckprogramm erneut ausgeführt werden kann, z.B. wenn manuell eine frühere Weckzeit gesetzt wurde als normal während wakeupDefaultTime verwendet wird. Greift nicht, wenn die Weckzeit während dieser Zeit geändert wurde; Standard ist 360 Minuten / 6h (optional)
- </li>
- </ul>
- </li>
- </ul>
- </ul>
- </ul>
- <p><a name="RFHEM"></a>
- <h3>RFHEM</h3>
- <div class='langLinks'>[<a href='commandref.html#RFHEM'>EN</a> DE]</div>
- <ul>Dieses modul verbindet auf einfache Art separate FHEM isnatllationen.</ul>
- <ul>Man kann damit einfache Befehle an andere Installationen sendne oder automatisch senden lassen.</ul>
- <b>Define</b>
- <ul><code>define <Name> RFHEM <hostname[:port]> <[pw]></code></ul><br>
- <ul><code>define remotePI RFHEM christian-pi test123</code></ul><br>
- <a name="RFHEM set"></a>
- <b>Set</b>
- <ul><code>set <Name> cmd <fhem befehl></code></ul><br>
- <ul><code>set remotePI cmd set lampe on</code></ul>
- <b>Attribute</b>
- <li>RFHEMdevs<br>
- Eine durch Komma getrennte Liste von Geräten.
- Alle Events dieser Geräte werden autom. an die entfernte Installation gesendet. Auf der entfernten Seite muss es das Gerät mit selben Namen geben (zb ein Dummy).
- </li><br>
- <li>RFHEMevents<br>
- Eine durch Komma getrennte Liste von Events.
- Alle diese Events ( der Geräte aus RFHEMdevs) werden autom. an die entfernte Installation gesendet
- </li><br>
- <ul>Man kann dieses Modul zb auch in verbindung mit notify nutzen:</ul>
- <ul><code>define LichtschlauchNotify notify wz.LichtschlauchDummy { fhem "set RemotePI cmd set Wohnzimmer.Lichtschlauch $EVENT" }</code></ul><br>
- <p><a name="RFXCOM"></a>
- <h3>RFXCOM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#RFXCOM'>RFXCOM</a><br/>
- </ul>
- <a name="RFXMETER"></a>
- <h3>RFXMETER</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#RFXMETER'>RFXMETER</a><br/>
- </ul>
- <a name="RFXX10REC"></a>
- <h3>RFXX10REC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#RFXX10REC'>RFXX10REC</a><br/>
- </ul>
- <a name="ROOMMATE" id="ROOMMATE"></a>
- <h3>ROOMMATE</h3>
- <div class='langLinks'>[<a href='commandref.html#ROOMMATE'>EN</a> DE]</div>
- <ul>
- <a name="ROOMMATEdefine" id="ROOMMATEdefine"></a> <b>Define</b>
- <ul>
- <code>define <rr_FirstName> ROOMMATE [<Device Name(n) der Bewohnergruppe(n)>]</code><br />
- <br />
- Stellt ein spezielles virtuelles Device bereit, welches einen Mitbewohner repräsentiert.<br />
- Basierend auf dem aktuellen Status und anderen Readings können andere Aktionen innerhalb von FHEM angestoßen werden.<br />
- <br />
- Wird vom übergeordneten Modul <a href="#RESIDENTS">RESIDENTS</a> verwendet, kann aber auch einzeln benutzt werden.<br />
- <br />
- Bei Mitgliedschaft mehrerer Bewohnergruppen werden diese durch Komma getrennt angegeben (siehe Beispiel unten).<br />
- <br />
- Beispiele:<br />
- <ul>
- <code># Einzeln<br />
- define rr_Manfred ROOMMATE<br />
- <br />
- # Typisches Gruppenmitglied<br />
- define rr_Manfred ROOMMATE rgr_Residents # um Mitglied der Gruppe rgr_Residents zu sein<br />
- <br />
- # Mitglied in mehreren Gruppen<br />
- define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # um Mitglied der Gruppen rgr_Residents und rgr_Parents zu sein<br />
- <br />
- # Komplexe Familien Struktur<br />
- define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Elternteil<br />
- define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Elternteil<br />
- define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Kind1<br />
- define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Kind2</code>
- </ul>
- </ul><br />
- <br />
- <a name="ROOMMATEset" id="ROOMMATEset"></a> <b>Set</b>
- <ul>
- <code>set <rr_FirstName> <command> [<parameter>]</code><br />
- <br />
- Momentan sind die folgenden Kommandos definiert.<br />
- <ul>
- <li>
- <b>location</b> - setzt das Reading 'location'; siehe auch Attribut rr_locations, um die in FHEMWEB angezeigte Liste anzupassen
- </li>
- <li>
- <b>mood</b> - setzt das Reading 'mood'; siehe auch Attribut rr_moods, um die in FHEMWEB angezeigte Liste anzupassen
- </li>
- <li>
- <b>state</b> home,gotosleep,asleep,awoken,absent,gone wechselt den Status; siehe auch Attribut rr_states, um die in FHEMWEB angezeigte Liste anzupassen
- </li>
- <li>
- <b>create</b>
- <li><i>locationMap</i> fügt ein vorkonfiguriertes weblink Device hinzu, welches eine Google Map anzeigt, sofern die Readings locationLat+locationLong vorhanden sind.</li>
- <li><i>wakeuptimer</i> fügt diverse Vorkonfigurationen auf Basis von RESIDENTS Toolkit hinzu. Siehe separate Sektion in der <a href="#RESIDENTS">RESIDENTS Modul Kommandoreferenz</a>.</li>
- </li>
- </ul>
- <ul>
- <u>Hinweis:</u> Sofern der Zugriff auf administrative set-Kommandos (-> create) eingeschränkt werden soll, kann in einer FHEMWEB Instanz das Attribut allowedCommands ähnlich wie 'set,set-user' erweitert werden.
- Die Zeichenfolge 'set-user' stellt dabei sicher, dass beim Zugriff auf FHEM über diese FHEMWEB Instanz nur nicht-administrative set-Kommandos ausgeführt werden können.
- </ul>
- </ul><br />
- <br />
- <ul>
- <u>Mögliche Status und ihre Bedeutung</u><br />
- <br />
- <ul>
- Dieses Modul unterscheidet 6 verschiedene Status:<br />
- <br />
- <ul>
- <li>
- <b>home</b> - Mitbewohner ist zu Hause und wach
- </li>
- <li>
- <b>gotosleep</b> - Mitbewohner ist auf dem Weg ins Bett
- </li>
- <li>
- <b>asleep</b> - Mitbewohner schläft
- </li>
- <li>
- <b>awoken</b> - Mitbewohner ist gerade aufgewacht
- </li>
- <li>
- <b>absent</b> - Mitbewohner ist momentan nicht zu Hause, wird aber bald zurück sein
- </li>
- <li>
- <b>gone</b> - Mitbewohner ist für längere Zeit verreist
- </li>
- </ul>
- </ul>
- </ul><br />
- <br />
- <ul>
- <u>Zusammenhang zwischen Anwesenheit/Presence und Aufenthaltsort/Location</u><br />
- <br />
- <ul>
- Unter bestimmten Umständen führt der Wechsel des Status auch zu einer Änderung des Readings 'location'.<br />
- <br />
- Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'absent' auf 'present' wechselt, wird 'location' auf 'home' gesetzt. Sofern das Attribut rr_locationHome gesetzt ist, wird die erste Lokation daraus anstelle von 'home' verwendet.<br />
- <br />
- Wannimmer die Anwesenheit (bzw. das Reading 'presence') von 'present' auf 'absent' wechselt, wird 'location' auf 'underway' gesetzt. Sofern das Attribut rr_locationUnderway gesetzt ist, wird die erste Lokation daraus anstelle von 'underway' verwendet.
- </ul>
- </ul><br />
- <br />
- <ul>
- <u>Auto-Status 'gone'</u><br />
- <br />
- <ul>
- Immer wenn ein Mitbewohner auf 'absent' gesetzt wird, wird ein Zähler gestartet, der nach einer bestimmten Zeit den Status automatisch auf 'gone' setzt.<br />
- Der Standard ist nach 36 Stunden.<br />
- <br />
- Dieses Verhalten kann über das Attribut rr_autoGoneAfter angepasst werden.
- </ul>
- </ul><br />
- <br />
- <ul>
- <u>Anwesenheit mit anderen ROOMMATE oder GUEST Devices synchronisieren</u><br />
- <br />
- <ul>
- Wenn Sie immer zusammen mit anderen Mitbewohnern oder Gästen das Haus verlassen oder erreichen, können Sie ihren Status ganz einfach auf andere Mitbewohner übertragen.<br />
- Durch das Setzen des Attributs rr_PassPresenceTo folgen die dort aufgeführten Mitbewohner ihren eigenen Statusänderungen nach 'home', 'absent' oder 'gone'.<br />
- <br />
- Bitte beachten, dass Mitbewohner mit dem aktuellen Status 'gone' oder 'none' (im Falle von Gästen) nicht beachtet werden.
- </ul>
- </ul><br />
- <br />
- <ul>
- <u>Zusammenhang zwischen Aufenthaltsort/Location und Anwesenheit/Presence</u><br />
- <br />
- <ul>
- Unter bestimmten Umständen hat der Wechsel des Readings 'location' auch einen Einfluss auf den tatsächlichen Status.<br />
- <br />
- Immer wenn eine Lokation mit dem Namen 'home' gesetzt wird, wird auch der Status auf 'home' gesetzt, sofern die Anwesenheit bis dahin noch auf 'absent' stand. Sofern das Attribut rr_locationHome gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'home' aus.<br />
- <br />
- Immer wenn eine Lokation mit dem Namen 'underway' gesetzt wird, wird auch der Status auf 'absent' gesetzt, sofern die Anwesenheit bis dahin noch auf 'present' stand. Sofern das Attribut rr_locationUnderway gesetzt wurde, so lösen alle dort angegebenen Lokationen einen Statuswechsel nach 'underway' aus. Diese Lokationen werden auch nicht in das Reading 'lastLocation' übertragen.<br />
- <br />
- Immer wenn eine Lokation mit dem Namen 'wayhome' gesetzt wird, wird das Reading 'wayhome' auf '1' gesetzt, sofern die Anwesenheit zu diesem Zeitpunkt 'absent' ist. Sofern das Attribut rr_locationWayhome gesetzt wurde, so führt das VERLASSEN einer dort aufgeführten Lokation ebenfalls dazu, dass das Reading 'wayhome' auf '1' gesetzt wird. Es gibt also 2 Möglichkeiten den Nach-Hause-Weg-Indikator zu beeinflussen (implizit und explizit).<br />
- Die Ankunft zu Hause setzt den Wert von 'wayhome' zurück auf '0'.<br />
- <br />
- Wenn Sie auch das <a href="#GEOFANCY">GEOFANCY</a> Modul verwenden, können Sie das Reading 'location' ganz einfach über GEOFANCY Ereignisse aktualisieren lassen. Definieren Sie dazu einen NOTIFY-Trigger wie diesen:<br />
- <br />
- <code>define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred:FILTER=location!=$EVTPART1 location $EVTPART1</code><br />
- <br />
- Durch das Anlegen von Geofencing-Zonen mit den Namen 'home' und 'wayhome' in der iOS App werden zukünftig automatisch alle Statusänderungen wie oben beschrieben durchgeführt.
- </ul>
- </ul><br />
- <br />
- <a name="ROOMMATEattr" id="ROOMMATEattr"></a> <b>Attribute</b><br />
- <ul>
- <ul>
- <li>
- <b>rr_autoGoneAfter</b> - Anzahl der Stunden, nach denen sich der Status automatisch auf 'gone' ändert, wenn der aktuellen Status 'absent' ist; Standard ist 36 Stunden
- </li>
- <li>
- <b>rr_geofenceUUIDs</b> - Mit Komma getrennte Liste von Geräte UUIDs, die ihren Standort über <a href="#GEOFANCY">GEOFANCY</a> aktualisieren. Vermeidet zusätzliche notify/DOIF/watchdog Geräte und kann als Ersatz für das GEOFANCY attribute <i>devAlias</i> dienen. (hier ehr als eine UUID/Device zu hinterlegen ist eher keine gute Idee da die Lokation dann womöglich anfängt zu springen)
- </li>
- <li>
- <b>rr_lang</b> - überschreibt globale Spracheinstellung; hilft beim setzen von Device Attributen, um FHEMWEB Anzeigetext zu übersetzen
- </li>
- <li>
- <b>rr_locationHome</b> - hiermit übereinstimmende Lokationen werden als zu Hause gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'home'
- </li>
- <li>
- <b>rr_locationUnderway</b> - hiermit übereinstimmende Lokationen werden als unterwegs gewertet; der erste Eintrag wird für das Zusammenspiel bei Statusänderungen benutzt; mehrere Einträge durch Leerzeichen trennen; Standard ist 'underway'
- </li>
- <li>
- <b>rr_locationWayhome</b> - das Verlassen einer Lokation, die hier aufgeführt ist, lässt das Reading 'wayhome' auf '1' setzen; mehrere Einträge durch Leerzeichen trennen; Standard ist "wayhome"
- </li>
- <li>
- <b>rr_locations</b> - Liste der in FHEMWEB anzuzeigenden Lokationsauswahlliste in FHEMWEB; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
- </li>
- <li>
- <b>rr_moodDefault</b> - die Stimmung, die nach Ankunft zu Hause oder nach dem Statuswechsel von 'awoken' auf 'home' gesetzt werden soll
- </li>
- <li>
- <b>rr_moodSleepy</b> - die Stimmung, die nach Statuswechsel zu 'gotosleep' oder 'awoken' gesetzt werden soll
- </li>
- <li>
- <b>rr_moods</b> - Liste von Stimmungen, wie sie in FHEMWEB angezeigt werden sollen; mehrere Einträge nur durch Komma trennen und KEINE Leerzeichen verwenden
- </li>
- <li>
- <b>rr_noDuration</b> - deaktiviert die kontinuierliche, nicht Event-basierte Berechnung der Zeitspannen (siehe Readings durTimer*)
- </li>
- <li>
- <b>rr_passPresenceTo</b> - synchronisiere die Anwesenheit mit anderen ROOMMATE oder GUEST Devices; mehrere Devices durch Leerzeichen trennen
- </li>
- <li>
- <b>rr_presenceDevices</b> - übernehmen des presence Status von einem anderen FHEM Device. Bei mehreren Devices diese mit Komma trennen, um ein Update des ROOMMATE Devices auszulösen, sobald ALLE Devices entweder absent oder present sind. Optional kann auch durch : abgetrennt ein Reading Name angegeben werden, ansonsten werden die Readings presence und state berücksichtigt.
- </li>
- <li>
- <b>rr_realname</b> - wo immer ROOMMATE den richtigen Namen verwenden möchte nutzt es den Wert des Attributs alias oder group; Standard ist group
- </li>
- <li>
- <b>rr_showAllStates</b> - die Status 'asleep' und 'awoken' sind normalerweise nicht immer sichtbar, um einen einfachen Zubettgeh-Prozess über das devStateIcon Attribut zu ermöglichen; Standard ist 0
- </li>
- <li>
- <b>rr_states</b> - Liste aller in FHEMWEB angezeigter Status; Eintrage nur mit Komma trennen und KEINE Leerzeichen benutzen; nicht unterstützte Status führen zu Fehlern
- </li>
- <li>
- <b>rr_wakeupDevice</b> - Referenz zu versklavten DUMMY Geräten, welche als Wecker benutzt werden (Teil von RESIDENTS Toolkit's wakeuptimer)
- </li>
- </ul>
- </ul><br />
- <br />
- <br />
- <b>Generierte Readings/Events:</b><br />
- <ul>
- <ul>
- <li>
- <b>durTimerAbsence</b> - Timer, der die Dauer der Abwesenheit in normal lesbarem Format anzeigt (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>durTimerAbsence_cr</b> - Timer, der die Dauer der Abwesenheit in Computer lesbarem Format anzeigt (Minuten)
- </li>
- <li>
- <b>durTimerPresence</b> - Timer, der die Dauer der Anwesenheit in normal lesbarem Format anzeigt (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>durTimerPresence_cr</b> - Timer, der die Dauer der Anwesenheit in Computer lesbarem Format anzeigt (Minuten)
- </li>
- <li>
- <b>durTimerSleep</b> - Timer, der die Schlafdauer in normal lesbarem Format anzeigt (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>durTimerSleep_cr</b> - Timer, der die Schlafdauer in Computer lesbarem Format anzeigt (Minuten)
- </li>
- <li>
- <b>lastArrival</b> - Zeitstempel der letzten Ankunft zu Hause
- </li>
- <li>
- <b>lastAwake</b> - Zeitstempel des Endes des letzten Schlafzyklus
- </li>
- <li>
- <b>lastDeparture</b> - Zeitstempel des letzten Verlassens des Zuhauses
- </li>
- <li>
- <b>lastDurAbsence</b> - Dauer der letzten Abwesenheit in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurAbsence_cr</b> - Dauer der letzten Abwesenheit in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastDurPresence</b> - Dauer der letzten Anwesenheit in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurPresence_cr</b> - Dauer der letzten Anwesenheit in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastDurSleep</b> - Dauer des letzten Schlafzyklus in normal lesbarem Format (Stunden:Minuten:Sekunden)
- </li>
- <li>
- <b>lastDurSleep_cr</b> - Dauer des letzten Schlafzyklus in Computer lesbarem Format (Minuten)
- </li>
- <li>
- <b>lastLocation</b> - der vorherige Aufenthaltsort
- </li>
- <li>
- <b>lastMood</b> - die vorherige Stimmung
- </li>
- <li>
- <b>lastSleep</b> - Zeitstempel des Beginns des letzten Schlafzyklus
- </li>
- <li>
- <b>lastState</b> - der vorherige Status
- </li>
- <li>
- <b>lastWakeup</b> - Zeit der letzten Wake-up Timer Ausführing
- </li>
- <li>
- <b>lastWakeupDev</b> - Device Name des zuletzt verwendeten Wake-up Timers
- </li>
- <li>
- <b>location</b> - der aktuelle Aufenthaltsort
- </li>
- <li>
- <b>mood</b> - die aktuelle Stimmung
- </li>
- <li>
- <b>nextWakeup</b> - Zeit der nächsten Wake-up Timer Ausführung
- </li>
- <li>
- <b>nextWakeupDev</b> - Device Name des als nächstes ausgefährten Wake-up Timer
- </li>
- <li>
- <b>presence</b> - gibt den zu Hause Status in Abhängigkeit des Readings 'state' wieder (kann 'present' oder 'absent' sein)
- </li>
- <li>
- <b>state</b> - gibt den aktuellen Status wieder
- </li>
- <li>
- <b>wakeup</b> - hat den Wert '1' während ein Weckprogramm dieses Bewohners ausgeführt wird
- </li>
- <li>
- <b>wayhome</b> - abhängig vom aktullen Aufenthaltsort, kann der Wert '1' werden, wenn die Person auf dem weg zurück nach Hause ist
- </li>
- </ul>
- </ul>
- </ul>
- <p><a name="RPII2C"></a>
- <h3>RPII2C</h3>
- <div class='langLinks'>[<a href='commandref.html#RPII2C'>EN</a> DE]</div>
- (<a href="commandref.html#RPII2C">en</a> | de)
- <ul>
- <a name="RPII2C"></a>
- Ermöglicht den Zugriff auf die I2C Schnittstellen des Raspberry Pi, BBB, Cubie über logische Module. Register von I2C IC's können auch direkt gelesen und geschrieben werden.<br><br>
- Dieses Modul funktioniert grunsätzlich auf allen Linux Systemen, die <code>/dev/i2c-x</code> bereitstellen.<br><br>
-
- <b>Vorbereitung:</b><br>
- <ul>
- <li>
- I2C Kernelmodule laden (chose <b>one</b> of the following options):<br>
- <ul>
- <li>
- I2C Kernelmodule laden:<br>
- modules Datei öffnen<br>
- <ul><code>sudo nano /etc/modules</code></ul><br>
- folgendes einfügen<br>
- <ul><code>
- i2c-dev<br>
- i2c-bcm2708<br>
- </code></ul>
- </li>
- <li>
- Seit Kernel 3.18.x auf dem Raspberry Pi und evtl. auch auf anderen Systemen ist der "Device tree support" implementiert und standardmäßig aktiviert.
- Um I2C Unterstützung zu aktivieren muß
- <ul><code>device_tree_param=i2c0=on,i2c1=on</code></ul> zur /boot/config.txt hinzu gefügt werden.
- Wenn nur einer der Busse genutzt wird, kann der andere einfach aus der Zeile entfernt werden.
- </li>
- <li>
- Bei Raspbian Images seit 2015 kann der I2C Bus einfach über <code>sudo raspi-config</code> aktiviert werden. Die Parameter werden automatisch in die /boot/config.txt eingetragen.
- </li>
- Neustart
- </ul>
- </li><br>
- <li><b>Eine</b> der folgenden drei Möglichkeiten wählen um dem FHEM User Zugriff auf <code>/dev/i2c-*</code> zu geben:
- <ul>
- <li>
- <code>
- sudo apt-get install i2c-tools<br>
- sudo adduser fhem i2c</code><br>
- </li><br>
- <li>
- Folgende Zeilen entweder in die Datei <code>/etc/init.d/fhem</code> vor <code>perl fhem.pl</code> in start, oder in die Datei <code>/etc/rc.local</code> eingefügen:<br>
- <code>
- sudo chown fhem /dev/i2c-*<br>
- sudo chgrp dialout /dev/i2c-*<br>
- sudo chmod +t /dev/i2c-*<br>
- sudo chmod 660 /dev/i2c-*<br>
- </code>
- </li><br>
- <li>
- Für das Raspberry Pi kann alternativ das gpio Utility der <a href="http://wiringpi.com/download-and-install/">WiringPi</a> Bibliothek benutzt werden um FHEM Schreibrechte auf die I2C Schnittstelle zu bekommen.<br>
- WiringPi Installation ist hier beschrieben: <a href="#RPI_GPIO">RPI_GPIO</a><br>
- Das gpio Utility wird, wenn vorhanden, automatisch verwendet<br>
- Wichtig: um den I2C-0 am P5 Stecker des Raspberry nutzen zu können muss das Attribut <code>swap_i2c0</code> verwendet werden.<br>
- </li>
- </ul>
- </li><br>
- <li>
- <b>Optional</b>: Hardwarezugriff via IOCTL wird standardmäßig genutzt (EMPFOHLEN), wenn Device::SMBus nicht installiert ist<br>
- Soll der Hardwarezugriff über das Perl Modul Device::SMBus erfolgen sind diese Schritte notwendig:<br>
- <ul><code>sudo apt-get install libmoose-perl<br>
- sudo cpan Device::SMBus</code></ul><br>
- </li>
- <li>
- <b>Nur für Raspbian Nutzer</b><br>
- Um I2C-0 am P5 Stecker auf Raspberry Pi modell B mit neueren Raspbian Versionen zu nutzen, welche auch das Raspberry Pi model B+ unterstützen, muss folgende Zeile in die <code>/boot/cmdline.txt</code> eingefügt werden:<br>
- <ul><code>bcm2708.vc_i2c_override=1</code></ul><br>
- </li>
- </ul>
- <a name="RPII2CDefine"></a><br>
- <b>Define</b>
- <ul>
- <code>define <name> RPII2C <I2C Bus Number></code><br>
- Die <code><I2C Bus Number></code> ist die Nummer des I2C Bus an den die I2C IC's angeschlossen werden<br><br>
- </ul>
- <a name="RPII2CSet"></a>
- <b>Set</b>
- <ul>
- <li>
- Schreibe ein Byte (oder auch mehrere nacheinander) direkt auf ein I2C device (manche I2C Module sind so einfach, das es nicht einmal mehrere Register gibt):<br>
- <code>set <name> writeByte <I2C Address> <value></code><br><br>
- </li>
- <li>
- Schreibe n-bytes auf einen Registerbereich (als Folge von Einzelbefehlen), beginnend mit dem angegebenen Register:<br>
- <code>set <name> writeByteReg <I2C Address> <Register Address> <value> [<value> [..]]</code><br><br>
- </li>
- <li>
- Schreibe n-bytes auf ein I2C device (als Blockoperation):<br>
- <code>set <name> writeBlock <I2C Address> <value> [<value> [..]]</code><br><br>
- </li>
- <li>
- Schreibe n-bytes auf einen Registerbereich (als Blockoperation), beginnend mit dem angegebenen Register:<br>
- <code>set <name> writeBlockReg <I2C Address> <Register Address> <value> [<value> [..]]</code><br><br>
- </li><br>
- Beispiele:
- <ul>
- Schreibe 0xAA zu Modul mit I2C Addresse 0x60<br>
- <code>set test1 writeByte 60 AA</code><br>
- Schreibe 0xAA zu Register 0x01 des Moduls mit der I2C Adresse 0x6E<br>
- <code>set test1 writeByteReg 6E 01 AA</code><br>
- Schreibe 0xAA zu Register 0x01 des Moduls mit der I2C Adresse 0x6E, schreibe danach 0x55 in das Register 0x02 als einzelne Befehle<br>
- <code>set test1 writeByteReg 6E 01 AA 55</code><br>
- Schreibe 0xA4 zu Register 0x03, 0x00 zu Register 0x04 und 0xDA zu Register 0x05 des Moduls mit der I2C Adresse 0x60 zusammen als ein Blockbefehl<br>
- <code>set test1 writeBlockReg 60 03 A4 00 DA</code><br>
- </ul><br>
- </ul>
- <a name="RPII2CGet"></a>
- <b>Get</b>
- <ul>
- <li>
- Auslesen der Registerinhalte des I2C Moduls:<br>
- <code>get <name> read <I2C Address> [<Register Address> [<number of registers>]]</code><br><br>
- </li>
- <li>
- Blockweises Auslesen des I2C Moduls (ohne separate Register):<br>
- <code>get <name> readblock <I2C Address> [<number of registers>]</code><br><br>
- </li>
- <li>
- Blockweises Auslesen der Registerinhalte des I2C Moduls:<br>
- <code>get <name> readblockreg <I2C Address> <Register Address> [<number of registers>]</code><br><br>
- </li><br>
- Beispiele:
- <ul>
- Lese Byte vom Modul mit der I2C Adresse 0x60<br>
- <code>get test1 read 60</code><br>
- Lese den Inhalt des Registers 0x01 vom Modul mit der I2C Adresse 0x6E.<br>
- <code>get test1 read 6E 01 AA 55</code><br>
- Lese den Inhalt des Registerbereichs 0x03 bis 0x06 vom Modul mit der I2C Adresse 0x60.<br>
- <code>get test1 read 60 03 4</code><br>
- </ul><br>
- </ul><br>
- <a name="RPII2CAttr"></a>
- <b>Attribute</b>
- <ul>
- <li>swap_i2c0<br>
- Umschalten von I2C-0 des Raspberry Pi Rev. B von J5 auf P5<br>
- Dieses Attribut ist nur für das Raspberry Pi vorgesehen und benötigt das gpio utility wie unter dem Punkt Vorbereitung beschrieben.<br>
- Standard: keiner, gültige Werte: on, off<br><br>
- </li>
- <li>useHWLib<br>
- Ändern der Methode des Hardwarezugriffs.<br>
- Dieses Attribut existiert nur, wenn beide Zugriffsmethoden verfügbar sind<br>
- Standard: IOCTL, gültige Werte: IOCTL, SMBus<br><br>
- </li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#showtime">showtime</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="RPI_GPIO"></a>
- <h3>RPI_GPIO</h3>
- <div class='langLinks'>[<a href='commandref.html#RPI_GPIO'>EN</a> DE]</div>
- (<a href="commandref.html#RPI_GPIO">en</a> | de)
- <ul>
- <a name="RPI_GPIO"></a>
- Das Raspberry Pi ermöglicht direkten Zugriff zu einigen GPIO's über den Pfostenstecker P1 (und P5 bei V2). Die Steckerbelegung ist in den Tabellen unter Define zu finden.
- Dieses Modul ermöglicht es, die herausgeführten GPIO's direkt als Ein- und Ausgang zu benutzen. Die Eingänge können zyklisch abgefragt werden oder auch sofort bei Pegelwechsel gesetzt werden.<br>
- Neben dem Raspberry Pi können auch die GPIO's von BBB, Cubie, Banana Pi und jedem Linuxsystem, das diese im Userspace zugägig macht, genutzt werden.<br>
- <b>Wichtig: Niemals Spannung an einen GPIO anlegen, der als Ausgang eingestellt ist! Die interne Logik der GPIO's arbeitet mit 3,3V. Ein überschreiten der 3,3V zerstört den GPIO und vielleicht auch den ganzen Prozessor!</b><br><br>
- <b>Vorbereitung:</b><br>
- Auf GPIO Pins wird im Modul über sysfs zugegriffen. Die Dateien befinden sich unter <code>/system/class/gpio</code> und sind in der aktuellen Raspbian Distribution (ab Jan 2014) in der Gruppe gpio. Es funktioniert auch mit der Jessie Version. Allerdings NICHT wenn ein Kernelupgrade durchgeführt wird<br>
- Nach dem ausführen folgender Befehle sind die GPIO's von PRI_GPIO aus nutzbar:<br>
- <ul><code>
- sudo adduser fhem gpio<br>
- sudo reboot
- </code></ul><br>
- Wenn das Attribut <code>pud_resistor</code> verwendet werden soll und für ältere Raspbian Distributionen, muss zusätzlich das gpio Tool der <a href="http://wiringpi.com/download-and-install/">WiringPi</a>
- Bibliothek installiert werden, um den internen Pullup/down Widerstand zu aktivieren, bzw. GPIO's zu exportieren und die korrekten Nutzerrechte zu setzen (für den zweiten Fall funktioniert das active_low Attribut <b>nicht</b>).<br>
- Installation WiringPi:<br>
- <ul><code>
- sudo apt-get update<br>
- sudo apt-get upgrade<br>
- sudo apt-get install git-core<br>
- git clone git://git.drogon.net/wiringPi<br>
- cd wiringPi
- ./build
- </code></ul><br>
- Für Linux Systeme bei denen der Zugriff auf <code>/system/class/gpio</code> nur mit root Rechten erfolgen kann, müssen die GPIO's vor FHEM start exportiert und von den Rechten her angepasst werden.<br>
- Dazu in die <code>/etc/rc.local</code> folgendes einfügen (Beispiel für GPIO22 und 23):<br>
- <ul><code>
- echo 22 > /sys/class/gpio/export<br>
- echo 23 > /sys/class/gpio/export<br>
- chown -R fhem:root /sys/devices/virtual/gpio/* (oder chown -R fhem:gpio /sys/devices/platform/gpio-sunxi/gpio/* für Banana Pi)<br>
- chown -R fhem:root /sys/class/gpio/*<br>
- </code></ul><br>
- <a name="RPI_GPIODefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> RPI_GPIO <GPIO number>[ <GPIO-Basedir>[ <WiringPi-gpio-utility>]]</code><br><br>
- Alle verfügbaren <code>GPIO number</code> sind z.B. <a href="http://www.panu.it/raspberry/">hier</a> zu finden<br><br>
-
- Beispiele:
- <pre>
- define Pin12 RPI_GPIO 18
- attr Pin12 poll_interval 5
- define Pin12 RPI_GPIO 18 /sys/class/gpio /usr/somewhere/bin/gpio
- </pre>
- </ul>
- <a name="RPI_GPIOSet"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <value></code>
- <br><br>
- <code>value</code> ist dabei einer der folgenden Werte:<br>
- <ul><li>Für GPIO der als output konfiguriert ist
- <ul><code>
- off<br>
- on<br>
- toggle<br>
- </code>
- </ul>
- Die <a href="#setExtensions"> set extensions</a> werden auch unterstützt.<br>
- </li>
- <li>Für GPIO der als input konfiguriert ist
- <ul><code>
- readval
- </code></ul>
- readval aktualisiert das reading Pinlevel und, wenn attr toggletostate nicht gesetzt ist, auch state
- </ul>
- </li><br>
- Beispiele:
- <ul>
- <code>set Pin12 off</code><br>
- <code>set Pin11,Pin12 on</code><br>
- </ul><br>
- </ul>
- <a name="RPI_GPIOGet"></a>
- <b>Get</b>
- <ul>
- <code>get <name></code>
- <br><br>
- Gibt "high" oder "low" entsprechend dem aktuellen Pinstatus zurück und schreibt den Wert auch in das reading <b>Pinlevel</b>
- </ul><br>
- <a name="RPI_GPIOAttr"></a>
- <b>Attributes</b>
- <ul>
- <li>direction<br>
- Setzt den GPIO auf Ein- oder Ausgang.<br>
- Standard: input, gültige Werte: input, output<br><br>
- </li>
- <li>active_low<br>
- Invertieren des logischen Wertes<br>
- Standard: off, gültige Werte: on, off<br><br>
- </li>
- <li>interrupt<br>
- <b>kann nur gewählt werden, wenn der GPIO als Eingang konfiguriert ist</b><br>
- Aktiviert Flankenerkennung für den GPIO<br>
- bei jedem interrupt Ereignis werden die readings Pinlevel und state aktualisiert<br>
- Standard: none, gültige Werte: none, falling, rising, both<br><br>
- Bei "both" wird ein reading Longpress angelegt, welches auf on gesetzt wird solange der Pin länger als 1s gedrückt wird<br>
- Bei "falling" und "rising" wird ein reading Toggle angelegt, das bei jedem Interruptereignis toggelt und das Reading Counter, das bei jedem Ereignis um 1 hochzählt<br><br>
- </li>
- <li>poll_interval<br>
- Fragt den Zustand des GPIO regelmäßig ensprechend des eingestellten Wertes in Minuten ab<br>
- Standard: -, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>toggletostate<br>
- <b>Funktioniert nur bei auf falling oder rising gesetztem Attribut interrupt</b><br>
- Wenn auf "yes" gestellt wird bei jedem Triggerereignis das <b>state</b> reading invertiert<br>
- Standard: no, gültige Werte: yes, no<br><br>
- </li>
- <li>pud_resistor<br>
- Interner Pullup/down Widerstand<br>
- <b>Funktioniert aussließlich mit installiertem gpio Tool der <a href="http://wiringpi.com/download-and-install/">WiringPi</a> Bibliothek.</b><br>
- Standard: -, gültige Werte: off, up, down<br><br>
- </li>
- <li>debounce_in_ms<br>
- Wartezeit in ms bis nach ausgelöstem Interrupt der entsprechende Pin abgefragt wird. Kann zum entprellen von mechanischen Schaltern verwendet werden<br>
- Standard: 0, gültige Werte: Dezimalzahl<br><br>
- </li>
- <li>unexportpin<br>
- Führe unexport über /sys/class/gpio/unexport aus wenn die Pin-Definition gelöscht wird (z.B. durch rereadcfg, delete,...)<br>
- Standard: yes, , gültige Werte: yes, no<br><br>
- </li>
- <li>restoreOnStartup<br>
- Wiederherstellen der Portzustände nach Neustart<br>
- Standard: last, gültige Werte: last, on, off, no<br><br>
- </li>
- <li>longpressinterval<br>
- <b>Funktioniert nur bei auf both gesetztem Attribut interrupt</b><br>
- Zeit in Sekunden, die ein GPIO auf high verweilen muss, bevor das Reading longpress auf on gesetzt wird <br>
- Standard: 1, gültige Werte: 0.1 - 10<br><br>
- </li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="RSS"></a>
- <h3>RSS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#RSS'>RSS</a><br/>
- </ul>
- <a name="RandomTimer"></a>
- <h3>RandomTimer</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#RandomTimer'>RandomTimer</a><br/>
- </ul>
- <a name="Revolt"></a>
- <h3>Revolt</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Revolt'>Revolt</a><br/>
- </ul>
- <a name="Robonect"></a>
- <h3>Robonect</h3>
- <div class='langLinks'>[<a href='commandref.html#Robonect'>EN</a> DE]</div>
- <ul>
- <p>Robonect ist ein Nachr¨stmodul für automower, die auf der Husky-G3-Steuerung basieren. Es wurde von Fabian H. entwickelt und kann unter www.robonect.de bezogen werden. Dieses Modul gibt Euch Zugriff auf die nötigsten Kommandos. Dieses Modul benötigt libjson-perl. Bitte NICHT VERGESSEN zu installieren!</p>
- <p><a name="RobonectDefine"></a> <b>Define</b></p>
- <ul>
- <code>define <name> Robonect <IP-Adresse oder Name></code>
-
- <p>Mit gesetztem Winterschlaf wird die Kommunikation zum Mäher unterbunden.</p>
-
- <p>Die Zugangsinformationen können im Klartext bei der Definition angegeben werden. Wahlweise auch per Attribut. Standardmäßig wird der Status vom RObonect alle 90s aktualisiert.</p>
- <p>Beispiel:</p>
- <pre>
- define myMower Robonect 192.168.13.5
- define myMower Robonect myMowersDNSName
- </pre>
- </ul>
-
- <p><a name="RobonectSet"></a> <b>Set</b></p>
- <ul>
- <b>Set</b>
- <ul>
- <li>auto<br>
- Dies versetzt den Mäher in den Automatikmodus. Der Mäher reagiert nur auf den internen Timer, bis eine andere Betriebsart gewählt wird. Der Mäher kann mit Stop jederzeit
- angehalten werden. Es wird erst wieder begonnen zu mähen, wenn der Timer (wieder) ein aktives Fenster hat UND Start gesendet wurde.
- </li>
- <li>manuell<br>
- Dies versetzt den Mäher in den manuellen modus. Der interne Timer wird nicht beachtet. Der Mäher reagiert nur auf Start oder Stopp Befehle von FHEM.
- </li>
- <li>home<br>
- Dies schickt den Mäher direkt nach hause. Weiteres mähen wird verhindert, bis auf manuell oder auto umgeschalten wird.
- </li>
- <li>feierabend<br>
- Dies schickt den Mäher für den aktuellen Timerslot direkt nach hause. Beim nächsten aktiven Timerslot wird weitergemäht.
- </li>
- <li>start<br>
- Startet den Mähvorgang im manuellen Modus oder im Automatikmodus bei aktivem Zeitslot.
- </li>
- <li>stop<br>
- Beendet den Mähvorgang. Der Mäher fährt nicht nach Hause und beginnt nicht wieder zu mähen. Er bleibt stehen, bis die Batterie leer ist. Nur mit Bedacht benutzen!
- </li>
- <li>maehauftrag<br>
- Hiermit wird ein (einmaliger) Auftrag an den Mäher abgesetzt. Es können beliebig viele Parameter mitgegeben werden. So kann zum Beispiel der Modus nach dem Auftrag,
- sowie Start- oder Stoppzeit beeinflusst werden.<br>
- Die Parameter müssen wie in der API des Robonect beschrieben lauten. Es erfolgt keine syntaktische Prüfung!<br>
- <br>
- Beispiel:<br>
- Startzeit 15 Uhr, Dauer 120 Minuten, keinen Fernstartpunkt verwenden, keine Betriebsartenumschaltung nach Auftragsende
- <pre>
- set myMower maehauftrag start=15:00 duration=120 remotestart=0 after=4
- </pre>
- </li>
- <li>winterschlaf <on, off><br>
- Wenn aktiviert, wird das Pollen unterbunden. Empfiehlt sich für die Winterpause.
- </li>
- <li>user <user><br>
- Alternativ zur Angabe per Argument kann per Set-Befehl der Benutzername zur Anmeldung am Robonect hier einmalig eingegeben werden. Er wird im Klartext in FhemUtils oder der DB gespeichert.<br>
- Wenn angegeben, werden die Attribute zur Authentisierung ignoriert.
- </li>
- <li>password <password><br>
- Alternativ zur Angabe per Argument kann per Set-Befehl das Passwort zur Anmeldung am Robonect hier einmalig eingegeben werden. Er wird im Klartext in FhemUtils oder der DB gespeichert.<br>
- Wenn angegeben, werden die Attribute zur Authentisierung ignoriert.
- </li>
- </ul>
- </ul>
- <p><a name="RobonectGet"></a> <b>Get</b></p>
- <ul>
- <b>Get</b>
- <ul>
- <li>status<br>
- Holt den aktuellen Status des Mähers. Wird normalerweise nicht benötigt, da automatisch gepolled wird.
- </li>
- <li>health<br>
- Mit diesem Kommando können detailliertere Informationen vom Mäher gelesen werden. Beispielsweise sind einge Spannungen und Umweltbedingungen verfügbar.<br>
- Es werden NICHT ALLE MÄHER UNTERSTÜTZT!!!
- Wenn das entsprechende Attribut gesetzt ist, wird health analog status gepolled.
- This one gets more detailed information - like voltages and temperatures. It is NOT SUPPORTED BY ALL MOWERS!!!<br>
- If enabled via attribute, health is polled accordingly status.
- </li>
- </ul>
- </ul>
-
- <p><a name="RobonectAttr"></a> <b>Attributes</b></p>
- <ul><br>
- Common attributes:<br>
- <a href="#DbLogInclude">DbLogInclude</a><br>
- <a href="#DbLogExclude">DbLogExclude</a><br>
- <a href="#IODev">IODev</a><br>
- <a href="#alias">alias</a><br>
- <a href="#comment">comment</a><br>
- <a href="#devStateIcon">devStateIcon</a><br>
- <a href="#devStateStyle">devStateStyle</a><br>
- <a href="#do_not_notify">do_not_notify</a><br>
- <a href="#readingFnAttributes">readingFnAttributes</a><br>
- <a href="#event-aggregator">event-aggregator</a><br>
- <a href="#event-min-interval">event-min-interval</a><br>
- <a href="#event-on-change-reading">event-on-change-reading</a><br>
- <a href="#event-on-update-reading">event-on-update-reading</a><br>
- <a href="#eventMap">eventMap</a><br>
- <a href="#group">group</a><br>
- <a href="#icon">icon</a><br>
- <a href="#room">room</a><br>
- <a href="#showtime">showtime</a><br>
- <a href="#sortby">sortby</a><br>
- <a href="#stateFormat">stateFormat</a><br>
- <a href="#userReadings">userReadings</a><br>
- <a href="#userattr">userattr</a><br>
- <a href="#verbose">verbose</a><br>
- <a href="#webCmd">webCmd</a><br>
- <a href="#widgetOverride">widgetOverride</a><br>
- <br>
- </ul>
- <p><a name="RobonectCredentials"></a> <b>credentials</b></p>
- <ul>
- Hier kann ein Link auf ein credentials-file angegeben werden. Die Zugansinformationen werden dann aus der Datei geholt. Dieser Mechanismus überschreibt basicAuth.
- </ul>
- <p><a name="RobonectBasicAuth"></a> <b>basicAuth</b></p>
- <ul>
- Hier werden die Zugangsinformationen entweder im Klartext oder base-64-codiert übergeben. Base64-encoder gibts bei google.
- <p>Example:</p>
- <pre>
- define myMower Robonect 192.168.5.1
- attr myMower basicAuth me:mySecret
- </pre>
- <pre>
- define myMower Robonect 192.168.5.1
- attr myMower basicAuth bWU6bXlTZWNyZXQ=
- </pre>
- </ul>
- <p><a name="RobonectPollInterval"></a> <b>pollInterval</b></p>
- <ul>
- Hier kann das polling-interval in Sekunden angegeben werden. Default sind 90s.
- </ul>
-
- <p><a name="RobonectTimeout"></a> <b>timeout</b></p>
- <ul>
- Für das holen der Daten per Wlan kann hier ein Timeout angegeben werden. Default sind 4s.
- </ul>
- <p><a name="RobonectHealth"></a> <b>useHealth</b></p>
- <ul>
- Wenn dieses Attribut auf 1 gesetzt wird, wird der health-status analog dem normalen Status gepolled.<br>
- Bitte beachtet, dass NICHT ALLE MÄHER UNTERSTÜTZT WERDEN!
- Wenn die Funktion nicht gegeben zu sein scheint, bitte den LAST_COMM_STATUS und das Logfile beachten.
- </ul>
- </ul>
- <p>
- <p><a name="S7"></a></p>
- <h3>S7</h3>
- <div class='langLinks'>[<a href='commandref.html#S7'>EN</a> DE]</div>
- <ul>
- <ul>
- <ul>This module connects a SIEMENS PLC (S7,S5,SIEMENS Logo!). The TCP communication (S7, Siemens LOGO!) module is based on settimino (http://settimino.sourceforge.net). The serial Communication is based on a libnodave portation.</ul>
- </ul>
- </ul>
- <p> </p>
- <ul>
- <ul>You can found a german wiki here: httl://www.fhemwiki.de/wiki/S7</ul>
- </ul>
- <p><br /><br /></p>
- <ul>
- <ul>For the communication the following modules have been implemented:
- <ul>
- <li>S7 … sets up the communication channel to the PLC</li>
- <li>S7_ARead … Is used for reading integer Values from the PLC</li>
- <li>S7_AWrite … Is used for write integer Values to the PLC</li>
- <li>S7_DRead … Is used for read bits</li>
- <li>S7_DWrite … Is used for writing bits.</li>
- </ul>
- </ul>
- </ul>
- <p><br /><br /></p>
- <ul>
- <ul>Reading work flow:</ul>
- </ul>
- <p><br /><br /></p>
- <ul>
- <ul>The S7 module reads periodically the configured DB areas from the PLC and stores the data in an internal buffer. Then all reading client modules are informed. Each client module extracts his data and the corresponding readings are set. Writing work flow:</ul>
- </ul>
- <p><br /><br /></p>
- <ul>
- <ul>At the S7 module you need to configure the PLC writing target. Also the S7 module holds a writing buffer. Which contains a master copy of the data needs to send.</ul>
- </ul>
- <p> </p>
- <ul>
- <ul>(Note: after configuration of the writing area a copy from the PLC is read and used as initial fill-up of the writing buffer)</ul>
- </ul>
- <p> </p>
- <ul>
- <ul>Note: The S7 module will send always the whole data block to the PLC. When data on the clients modules is set then the client module updates the internal writing buffer on the S7 module and triggers the writing to the PLC.</ul>
- </ul>
- <p><br /><br /><a name="S7define"></a><strong>Define</strong><code>define <name> S7 <PLC_address> <rack> <slot> [<Interval>] </code><br /><br /><code>define logo S7 10.0.0.241 2 0 </code></p>
- <ul>
- <ul>
- <ul>
- <ul>
- <li>PLC_address … IP address of the S7 PLC (For S5 see below)</li>
- <li>rack … rack of the PLC</li>
- <li>slot … slot of the PLC</li>
- <li>Interval … Intervall how often the modul should check if a reading is required</li>
- </ul>
- </ul>
- </ul>
- </ul>
- <p> </p>
- <ul>
- <ul>
- <ul>Note: For Siemens logo you should use a alternative (more simply configuration method):</ul>
- </ul>
- </ul>
- <p> </p>
- <ul>
- <ul>
- <ul><code>define logo S7 LOGO7 10.0.0.241</code></ul>
- </ul>
- </ul>
- <p> </p>
- <ul>
- <ul>
- <ul>Note: For Siemens S5 you must use a alternative (more simply configuration method):</ul>
- </ul>
- </ul>
- <p> </p>
- <ul>
- <ul>
- <ul>define logo S7 S5 /dev/tty1 in this case the PLC_address is the serial port number</ul>
- </ul>
- </ul>
- <p><br /><br /><strong>Attr</strong></p>
- <ul>
- <ul>The following attributes are supported:</ul>
- </ul>
- <p> </p>
- <ul>
- <ul>
- <ul>
- <li>MaxMessageLength</li>
- <li>receiveTimeoutMs</li>
- <li>Intervall</li>
- </ul>
- </ul>
- </ul>
- <p> </p>
- <ul>
- <ul>MaxMessageLength ... restricts the packet length if lower than the negioated PDULength. This could be used to increate the processing speed. 2 small packages may be smaler than one large package</ul>
- <ul>receiveTimeoutMs ... timeout in ms for TCP receiving packages. Default Value 500ms. </ul>
- <ul>Intervall ... polling intervall in s </ul>
- </ul>
- <p><a name="S7_ARead"></a>
- <h3>S7_ARead</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_ARead'>EN</a> DE]</div>
- <ul>
- This module is a logical module of the physical module S7. <br>
- This module provides analog data (signed / unsigned integer Values).<br>
- Note: you have to configure a PLC reading at the physical module (S7) first.<br>
- <br><br>
- <b>Define</b><br>
- <code>define <name> S7_ARead {inputs|outputs|flags|db} <DB> <start> {u8|s8|u16|s16|u32|s32}</code>
- <br><br>
- <ul>
- <li>inputs|outputs|flags|db … defines where to read.</li>
- <li>DB … Number of the DB</li>
- <li>start … start byte of the reading</li>
- <li>{u8|s8|u16|s16|u32|s32} … defines the datatype: </li>
- <ul>
- <li>u8 …. unsigned 8 Bit integer</li>
- <li>s8 …. signed 8 Bit integer</li>
- <li>u16 …. unsigned 16 Bit integer</li>
- <li>s16 …. signed 16 Bit integer</li>
- <li>u32 …. unsigned 32 Bit integer</li>
- <li>s32 …. signed 32 Bit integer</li>
- <li>float …. 4 byte float </li>
- </ul>
- Note: the required memory area (start – start + datatypelength) need to be with in the configured PLC reading of the physical module.
- </ul>
- <b>Attr</b>
- The following parameters are used to scale every reading
- <ul>
- <li>multiplicator</li>
- <li>offset</li>
- </ul>
- newValue = <multiplicator> * Value + <offset>
- </ul>
- <p><p><a name="S7_AWrite"></a></p>
- <h3>S7_AWrite</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_AWrite'>EN</a> DE]</div>
- <ul>
- <ul>This module is a logical module of the physical module S7.</ul>
- </ul>
- <ul>
- <ul>This module provides sending analog data (unsigned integer Values) to the PLC.</ul>
- </ul>
- <ul>
- <ul>Note: you have to configure a PLC writing at the physical modul (S7) first.</ul>
- </ul>
- <p><br /><br /><strong>Define</strong><br /><code>define <name> S7_AWrite {inputs|outputs|flags|db} <DB> <start> {u8|s8|u16|s16|u32|s32|float}</code><br /><br /></p>
- <ul>
- <ul>
- <ul>
- <ul>
- <li>db … defines where to read. Note currently only writing in to DB are supported.</li>
- <li>DB … Number of the DB</li>
- <li>start … start byte of the reading</li>
- <li>{u8|s8|u16|s16|u32|s32} … defines the datatype:</li>
- <ul>
- <li>u8 …. unsigned 8 Bit integer</li>
- <li>s8 …. signed 8 Bit integer</li>
- <li>u16 …. unsigned 16 Bit integer</li>
- <li>s16 …. signed 16 Bit integer</li>
- <li>u32 …. unsigned 32 Bit integer</li>
- <li>s32 …. signed 32 Bit integer</li>
- <li>float …. 4 byte float</li>
- </ul>
- </ul>
- Note: the required memory area (start – start + datatypelength) need to be with in the configured PLC writing of the physical module.</ul>
- </ul>
- </ul>
- <p>Logo 7 / Logo 8</p>
- <p style="padding-left: 60px;">For Logo7 / Logo 8 also a short notation is supportet:</p>
- <p><code>define <name> S7_AWrite {AI|AM|AQ|NAI|NAQ}X</code></p>
- <p><strong>Set</strong><br /><br /><code>set <name> S7_AWrite <value></code></p>
- <ul>
- <ul>
- <ul>
- <li>value … an numeric value</li>
- </ul>
- </ul>
- </ul>=end html_DE
- =cut
- <p><a name="S7_Client"></a></p>
- <h3>S7_Client</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_Client'>EN</a> DE]</div>
- <ul>
- <ul>abstract interface layer S7 / S5</ul>
- </ul>
- <p><a name="S7_DRead"></a>
- <h3>S7_DRead</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_DRead'>EN</a> DE]</div>
- <ul>
- This module is a logical module of the physical module S7. <br>
- This module provides digital data (ON/OFF).<br>
- Note: you have to configure a PLC reading at the physical modul (S7) first.<br>
- <br><br>
- <b>Define</b>
- <ul>
- <code>define <name> S7_DRead {inputs|outputs|flags|db} <DB> <address></code>
- <ul>
- <li>inputs|outputs|flags|db … defines where to read.</li>
- <li>DB … Number of the DB</li>
- <li>address … address you want to read. bit number to read. Example: 10.3</li>
- </ul>
- Note: the required memory area need to be with in the configured PLC reading of the physical module.
- </ul>
- </ul>
- <p><p><a name="S7_DWrite"></a></p>
- <h3>S7_DWrite</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_DWrite'>EN</a> DE]</div>
- <ul>
- <ul>This module is a logical module of the physical module S7.</ul>
- </ul>
- <ul>
- <ul>This module is used to set/unset a Bit in ad DB of the PLC.</ul>
- </ul>
- <ul>
- <ul>Note: you have to configure a PLC writing at the physical modul (S7) first.</ul>
- </ul>
- <p><br /><br /><br /><strong>Define</strong><code>define <name> S7_DWrite {db} <DB> <position></code></p>
- <ul>
- <ul>
- <ul>
- <ul>
- <li>db … defines where to read. Note currently only writing in to DB are supported.</li>
- <li>DB … Number of the DB</li>
- <li>address … address you want to write. bit number to read. Example: 10.6</li>
- </ul>
- Note: the required memory area need to be with in the configured PLC reading of the physical module.</ul>
- </ul>
- </ul>
- <p><br /><strong>Set</strong><code>set <name> S7_AWrite {ON|OFF|TRIGGER};</code></p>
- <ul>
- <ul>Note: TRIGGER sets the bit for 1s to ON than it will set to OFF.</ul>
- </ul>
- <p><strong>Attr</strong><br /> The following parameters are used to scale every reading</p>
- <ul>
- <li>trigger_length ... sets the on-time of a trigger in Seconds. Note out can also use trigger_length less than 1</li>
- </ul>
- <p><p><a name="S7_S5Client"></a></p>
- <h3>S7_S5Client</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_S5Client'>EN</a> DE]</div>
- <ul>
- <ul>low level interface to S5</ul>
- </ul>
- <p><p><a name="S7_S7Client"></a></p>
- <h3>S7_S7Client</h3>
- <div class='langLinks'>[<a href='commandref.html#S7_S7Client'>EN</a> DE]</div>
- <ul>
- <ul>low level interface to S7</ul>
- </ul>
- <p><a name="SCIVT"></a>
- <h3>SCIVT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SCIVT'>SCIVT</a><br/>
- </ul>
- <a name="SD_RSL"></a>
- <h3>SD_RSL</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SD_RSL'>SD_RSL</a><br/>
- </ul>
- <a name="SD_WS"></a>
- <h3>SD_WS</h3>
- <div class='langLinks'>[<a href='commandref.html#SD_WS'>EN</a> DE]</div>
- <ul>
- Das SD_WS Modul verarbeitet von einem IO Gerät (CUL, CUN, SIGNALDuino, etc.) empfangene Nachrichten von Temperatur-Sensoren.<br>
- <br>
- <b>Unterstützte Modelle:</b>
- <ul>
- <li>Bresser 7009994</li>
- <li>Opus XT300</li>
- <li>BresserTemeo</li>
- <li>WH2 (TFA Dostmann/Wertheim 30.3157(Temperatur!) (Deutschland), Agimex Rosenborg 66796 (Denmark),ClimeMET CM9088 (UK)</li>
- <li>PV-8644 infactory Poolthermometer</li>
- </ul>
- <br>
- Neu empfangene Sensoren werden in FHEM per autocreate angelegt.
- <br><br>
- <a name="SD_WS_Define"></a>
- <b>Define</b>
- <ul>Die empfangenen Sensoren werden automatisch angelegt.<br>
- Die ID der angelgten Sensoren ist entweder der Kanal des Sensors, oder wenn das Attribut longid gesetzt ist, dann wird die ID aus dem Kanal und einer Reihe von Bits erzeugt, welche der Sensor beim Einschalten zufällig vergibt.<br>
- </ul>
- <br>
- <a name="SD_WS Events"></a>
- <b>Generierte Readings:</b>
- <ul>
- <li>State (T: H:)</li>
- <li>temperature (°C)</li>
- <li>humidity: (Luftfeuchte (1-100)</li>
- <li>battery: (low oder ok)</li>
- <li>channel: (Der Sensor Kanal)</li>
- </ul>
- <br>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <a name="SD_WS_Set"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="SD_WS_Parse"></a>
- <b>Set</b> <ul>N/A</ul><br>
- </ul>
- <p><a name="SD_WS07"></a>
- <h3>SD_WS07</h3>
- <div class='langLinks'>[<a href='commandref.html#SD_WS07'>EN</a> DE]</div>
- <ul>
- Das SD_WS07 Modul verarbeitet von einem IO Geraet (CUL, CUN, SIGNALDuino, etc.) empfangene Nachrichten von Temperatur-Sensoren.<br>
- <br>
- <b>Unterstützte Modelle:</b>
- <ul>
- <li>Eurochon EAS800z</li>
- <li>Technoline WS6750/TX70DTH</li>
- <li>TFA 30320902</li>
- <li>FreeTec Aussenmodul fuer Wetterstation NC-7344</li>
- </ul>
- <br>
- Neu empfangene Sensoren werden in FHEM per autocreate angelegt.
- <br><br>
- <a name="SD_WS07_Define"></a>
- <b>Define</b>
- <ul>Die empfangenen Sensoren werden automatisch angelegt.<br>
- Die ID der angelegten Sensoren ist entweder der Kanal des Sensors, oder wenn das Attribut longid gesetzt ist, dann wird die ID aus dem Kanal und einer Reihe von Bits erzeugt, welche der Sensor beim Einschalten zufaellig vergibt.<br>
- </ul>
- <br>
- <a name="SD_WS07 Events"></a>
- <b>Generierte Readings:</b>
- <ul>
- <li>state: (T: H:)</li>
- <li>temperature: (°C)</li>
- <li>humidity: (Luftfeuchte (1-100)</li>
- <li>battery: (low oder ok)</li>
- <li>channel: (Der Sensor Kanal)</li>
- </ul>
- <br>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <a name="SD_WS071_Set"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="SD_WS07_Get"></a>
- <b>Get</b> <ul>N/A</ul><br>
- </ul>
- <p><a name="SD_WS09"></a>
- <h3>SD_WS09</h3>
- <div class='langLinks'>[<a href='commandref.html#SD_WS09'>EN</a> DE]</div>
- <ul>
- Das SD_WS09 Module verarbeitet von einem IO Gerät (CUL, CUN, SIGNALDuino, etc.) empfangene Nachrichten von Temperatur-Sensoren.<br>
- <br>
- Perl-Modul Digest::CRC erforderlich. <br>
- <br>
- cpan install Digest::CRC oder auch <br>
- sudo apt-get install libdigest-crc-perl <br>
- <br>
- <br>
- <b>Unterstütze Modelle:</b>
- <ul>
- <li>WS-0101 --> Model: WH1080</li>
- <li>TFA 30.3189 / WH1080 --> Model: WH1080</li>
- <li>1073 (WS1080) --> Model: WH1080</li>
- <li>WH3080 --> Model: WH1080</li>
- <li>CTW600 --> Model: CTW600</li>
- </ul>
- <br>
- Neu empfangene Sensoren werden in FHEM per autocreate angelegt.
- <br><br>
- <a name="SD_WS09_Define"></a>
- <b>Define</b>
- <ul>Die empfangenen Sensoren werden automatisch angelegt.<br>
- Die ID der angelegten Sensoren wird nach jedem Batteriewechsel geändert, welche der Sensor beim Einschalten zufällig vergibt.<br>
- CRC Checksumme wird zur Zeit noch nicht überprüft, deshalb werden Sensoren bei denen die Luftfeuchte < 0 oder > 100 ist, nicht angelegt.<br>
- </ul>
- <br>
- <a name="SD_WS09 Events"></a>
- <b>Generierte Readings:</b>
- <ul>
- <li>State (T: H: Ws: Wg: Wd: R: ) temperature, humidity, windSpeed, windGuest, Einheit, windDirection, Rain</li>
- <li>Temperature (°C)</li>
- <li>Humidity: (The humidity (1-100 if available)</li>
- <li>Battery: (low or ok)</li>
- <li>ID: (The ID-Number (number if)</li>
- <li>windSpeed/windgust (Einheit siehe Unit_of_Wind) and windDirection (N-O-S-W)</li>
- <li>Rain (mm)</li>
- <li>windDirectionAverage
- Als Ergebnis wird die Windrichtung zurück geliefert, die aus dem aktuellen und
- vergangenen Werten über eine Art exponentiellen Mittelwert berechnet werden.
- Dabei wird zusätzlich die jeweilige Windgeschwindigkeit mit berücksichtigt (höhere Geschwindigkeit
- bedeutet höhere Gewichtung).</li>
- <b>WH3080:</b>
- <li>UV Index</li>
- <li>Lux</li>
-
- </ul>
- <br>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <li>Model<br>
- WH1080, CTW600
- </li><br>
- <li>windKorrektur<br>
- Korrigiert die Nord-Ausrichtung des Windrichtungsmessers, wenn dieser nicht richtig nach Norden ausgerichtet ist.
- -3,-2,-1,0,1,2,3
- </li><br>
- <li>Unit_of_Wind<br>
- Hiermit wird der Einheit eingestellt und im State die entsprechenden Werte + Einheit angezeigt.
- <br>m/s,km/h,ft/s,mph,bft,knot
- </li><br>
-
- <li>WindDirAverageTime<br>
- default ist 600s, Zeitspanne die für die Berechung berücksichtig werden soll
- </li><br>
-
- <li>WindDirAverageMinSpeed<br>
- da bei sehr geringer Windgeschwindigkeit die Windrichtung üblicherweise nicht
- eindeutig ist, kann mit minspeed ein Schwellwert angegeben werden
- Ist die (gewichtetete) mittlere Geschwindigkeit < minspeed wird undef zurück geliefert
- </li><br>
-
- <li>WindDirAverageDecay<br>
- 1 -> alle Werte werden gleich gewichtet <br>
- 0 -> nur der aktuelle Wert wird verwendet.<br>
- in der Praxis wird man Werte so um 0.75 nehmen
- </li><br>
-
- <li>WS09_CRCAUS<br>
- Wird im Signalduino-Modul (00_SIGNALduino.pm) gesetzt
- <br>0: CRC-Prüfung bei WH1080 CRC-Summe = 0
- <br>2: CRC-Summe = 49 (x031) bei WH1080 wird als OK verarbeitet
- </li><br>
-
- </ul>
- <a name="SD_WS09_Set"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="SD_WS09_Parse"></a>
- <b>Parse</b> <ul>N/A</ul><br>
- </ul>
- <p><a name="SD_WS_Maverick"></a>
- <h3>SD_WS_Maverick</h3>
- <div class='langLinks'>[<a href='commandref.html#SD_WS_Maverick'>EN</a> DE]</div>
- <ul>
- Das SD_WS_Maverick Module verarbeitet von einem IO Geraet (CUL, CUN, SIGNALDuino, etc.) empfangene Nachrichten von Temperatur-Sensoren.<br>
- <br>
- <b>Unterstützte Modelle:</b>
- <ul>
- <li>Maverick</li>
- </ul>
- <br>
- Neu empfangene Sensoren werden in FHEM per autocreate angelegt.
- <br><br>
- <a name="SD_WS_Maverick_Define"></a>
- <b>Define</b>
- <ul>Die empfangenen Sensoren werden automatisch angelegt.<br>
- Die ID der angelegten Sensoren ist entweder der Kanal des Sensors, oder wenn das Attribut longid gesetzt ist, dann wird die ID aus dem Kanal und einer Reihe von Bits erzeugt, welche der Sensor beim Einschalten zufällig vergibt.<br>
- </ul>
- <br>
- <a name="SD_WS_Maverick Events"></a>
- <b>Generierte Readings:</b>
- <ul>
- <li>State (T: H:)</li>
- <li>temperature (°C)</li>
- <li>humidity: (Luftfeuchte (1-100)</li>
- <li>battery: (low oder ok)</li>
- <li>channel: (Der Sensor Kanal)</li>
- </ul>
- <br>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#ignore">ignore</a></li>
- <li><a href="#model">model</a> ()</li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <a name="SD_WS_Maverick1_Set"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="SD_WS_Maverick_Parse"></a>
- <b>Set</b> <ul>N/A</ul><br>
- </ul>
- <p><a name="SHC"></a>
- <h3>SHC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SHC'>SHC</a><br/>
- </ul>
- <a name="SHCdev"></a>
- <h3>SHCdev</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SHCdev'>SHCdev</a><br/>
- </ul>
- <a name="SIGNALduino"></a>
- <h3>SIGNALduino</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SIGNALduino'>SIGNALduino</a><br/>
- </ul>
- <a name="SIGNALduino_un"></a>
- <h3>SIGNALduino_un</h3>
- <div class='langLinks'>[<a href='commandref.html#SIGNALduino_un'>EN</a> DE]</div>
- <ul>
- Das SIGNALduino_un module ist ein Hilfsmodul um unbekannte Nachrichten debuggen und analysieren zu koennen.
- Das Modul legt keinerlei Geräte oder ähnliches an.
- <br><br>
- <a name="SIGNALduino_undefine"></a>
- <b>Define</b>
- <code>define <name> SIGNALduino_un <code> </code> <br>
- <br>
- Es ist moeglich ein Geraet manuell zu definieren, aber damit passiert ueberhaupt nichts.
- Autocreate wird auch keinerlei Geraete aus diesem Modul anlegen.
- <br>
- Die einzgeste Funktion dieses Modules ist, ab Verbose 4 Logmeldungen über die Empfangene Nachricht ins Log zu schreiben. Dabei kann man sich leider nicht darauf verlassen, dass die Nachricht korrekt dekodiert wurde.<br>
- Dieses Modul wird alle Nachrichten verarbeiten, welche von anderen Modulen nicht verarbeitet wurden.
- <a name="SIGNALduino_unset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="SIGNALduino_unget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="SIGNALduino_unattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#verbose">Verbose</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="SIP"></a>
- <h3>SIP</h3>
- <div class='langLinks'>[<a href='commandref.html#SIP'>EN</a> DE]</div>
- <ul>
- Definiert ein SIP-Client Device.<br>
- Wiki : <a href="https://wiki.fhem.de/wiki/SIP-Client">https://wiki.fhem.de/wiki/SIP-Client</a>
- <br>
- Forum : <a href="https://forum.fhem.de/index.php/topic,67443.0.html">https://forum.fhem.de/index.php/topic,67443.0.html</a>
- <br><br>
- <a name="SIPdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> SIP</code>
- <br><br>
- Beispiel:
- <ul>
- <code>define MySipClient SIP</code><br>
- </ul>
- </ul>
- <br>
- <a name="SIPset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>set <name> <SIP Passwort></code><br>
- Speichert das Passwort des SIP Users. Ohne gespeichertes Passwort sind die set call und set listen Funktionen gesperrt !<br>
- WICHTIG : wird das SIP Device umbenannt muss dieser Befehl unbedingt wiederholt werden !
- </li>
- <li>
- <code>set <name> reset</code><br>
- Stoppt laufende listen-Prozess und initalisiert das Device.<br>
- </li>
- <li>
- <code>set <name> call <nummer> [<maxtime>] [<nachricht>]</code><br>
- Startet einen Anruf an die angegebene Nummer.<br>
- Optional kann die maximale Zeit angegeben werden. Default ist 30.<br>
- Optional kann eine Nachricht in Form eines Audiofiles angegeben werden . Das File ist mit dem vollen Pfad oder dem relativen ab dem Verzeichnis mit fhem.pl anzugeben..
- </li>
- <li>
- <code>set <name> listen</code><br>
- Attribut sip_listen = dtmf :
- Der SIP-Client wird in einen Status versetzt in dem er Anrufe annimmt. Der Ton wird als Echo zurückgespielt. Über die Eingabe von # gefolgt von 2 unterschiedlichen Zahlen und anschließendem Auflegen kann eine Zahl in das Reading <b>dtmf</b> übergeben werden.<br>
- Attribut sip_listen = wfp :
- Der SIP-Client wird in einen Status versetzt in dem er auf Anrufe wartet. Erfolgt an Anruf an den Client, wechselt der Status zu <b>ringing</b>. Nun kann das Gespräch via set-Command <b>fetch</b> angenommen werden. Das als sip_audiofile angegebene File wird abgespielt. Anschließend wechselt der Status wieder zu <b>listenwfp</b>.<br>
- </li>
- </ul>
- <br>
- <a name="SIPattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a name="#sip_user">sip_user</a><br>
- User Name des SIP-Clients. Default ist 620 (Fritzbox erstes SIP Telefon)
- </li>
- <li><a name="#sip_registrar">sip_registrar</a><br>
- Hostname oder IP-Addresse des SIP-Servers mit dem sich das Modul verbinden soll. (Default fritz.box)
- </li>
- <li><a name="#sip_from">sip_from</a><br>
- SIP-Client-Info. Syntax : sip:sip_user@sip_registrar Default ist sip:620@fritz.box
- </li>
- <li><a name="#sip_ip">sip_ip</a><br>
- Die IP-Addresse von FHEM im Heimnetz. Solange das Attribut nicht gesetzt ist versucht das Modul diese beim Start zu ermitteln.
- </li>
- <li><a name="#sip_port">sip_port</a><br>
- Optinale Portnummer die vom Modul benutzt wird.<br>
- Wenn dem Attribut kein Wert zugewiesen wurde verwendet das Modul eine zufällige Portnummer zwichen 44000 und 45000
- </li>
- <li><b>Audiofiles</b>
- Audiofiles können einfach mit dem externen Programm sox erzeugt werden :<br>
- sox <file>.wav -t raw -r 8000 -c 1 -e a-law <file>.al<br>
- Unterstützt werden nur die beiden RAW Audio Formate a-law und u-law !<br>
- Statt eines echten Audiofiles kann auch eine Text2Speech Nachricht eingetragen werden.<br>
- Bsp : attr mySIP sip_audiofile_call !Hier ist dein FHEM Server
- </li>
- <li><a href="#sip_audiofile_wfp">sip_audiofile_wfp</a><br>
- Audiofile das nach dem Command <b>fetch</b> abgespielt wird.
- </li>
- <li><a href="#sip_audiofile_call">sip_audiofile_call</a></li>
- Audiofile das dem Angerufenen bei set call vorgespielt wird.
- <li><a href="#sip_audiofile_dtmf">sip_audiofile_dtmf</a></li>
- Audiofile das dem Anrufer bei listen_for_dtmf abgespielt wird.
- <li><a href="#sip_audiofile_ok">sip_audiofile_ok</a></li>
- Audiofile das bei erkannter DTMF Sequenz abgespielt wird.
- <li><a href="#sip_listen">sip_listen</a> (none , dtmf, wfp)</li>
- <li><a name="#sip_ringtime">sip_ringtime</a><br>
- Klingelzeit für eingehende Anrufe bei listen_for_dtmf
- </li>
- <li><a name="#sip_dtmf_size">sip_dtmf_size</a><br>
- 1 bis 4 , default 2 Legt die Läge des erwartenden DTMF Events fest.
- </li>
- <li><a name="#sip_dtmf_loop">sip_dtmf_loop</a><br>
- once oder loop , default once ...
- </li>
- <li><a name="#sip_waittime">sip_waittime</a><br>
- Maximale Wartezeit im Status listen_for_wfp bis das Gespräch automatisch angenommen wird.
- </li>
- <li>T2S_Device<br>
- Name des Text2Speech Devices (Wird nur benötigt wenn Sprachnachrichten statt Audiofiles verwendet werden)
- </li>
- <li>T2S_Timeout<br>
- Wartezeit in Sekunden wie lange maximal auf Text2Speech gewartet wird.
- </li>
- <li>audo_converter<br>sox oder ffmpeg, default sox<br>
- Ist f¨r Text2Speech unbedingt erforderlich um die mp3 Dateien in Raw Audio umzuwandeln.<br>
- Installation z.B. mit sudo apt-get install sox und noch die mp3 Unterstützung mit sudo apt-get install libsox-fmt-mp3
- </li>
- <li><a name="#sip_force_interval">sip_force_interval</a><br>
- default 300
- </li>
- <li><a name="#sip_force_max">sip_force_max</a><br>
- default 99
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="SISPM"></a>
- <h3>SISPM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SISPM'>SISPM</a><br/>
- </ul>
- <a name="SIS_PMS"></a>
- <h3>SIS_PMS</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SIS_PMS'>SIS_PMS</a><br/>
- </ul>
- <a name="SMAEM"></a>
- <h3>SMAEM</h3>
- <div class='langLinks'>[<a href='commandref.html#SMAEM'>EN</a> DE]</div>
- <br>
- <a name="SMAEMdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> SMAEM </code><br>
- <br>
- Definiert ein SMA Energy Meter (SMAEM), einen bidirektionalen Stromzähler, der häufig in Photovolatikanlagen der Firma SMA zum Einsatz kommt.
- <br><br>
- Sie brauchen mindest ein SMAEM in Ihrem lokalen Netzwerk oder hinter einen multicastfähigen Netz von Routern, um die Daten des SMAEM über die
- Multicastgruppe 239.12.255.254 auf udp/9522 zu empfangen. Die Multicastpakete werden vom SMAEM einmal pro Sekunde ausgesendet (firmware 1.02.04.R, März 2016).
- <br><br>
- Das update interval kann über das Attribut "interval" gesetzt werden. Wenn es nicht gesetzt wird, werden updates per default alle 60 Sekunden durchgeführt.
- Da das SMAEM seine Daten sekündlich aktualisiert, kann das update interval auf bis zu einer Sekunde reduziert werden. Das wird nicht empfohlen, da FHEM
- sonst unter große Last gesetzt wird.
- <br><br>
- Der Parameter "disableSernoInReading" ändert die Art und Weise, wie die Readings des SMAEN bezeichnet werden: ist der Parameter false
- oder nicht gesetzt, werden die Readings mit "SMAEM<serialnumber_>....." bezeichnet.
- Wird der Parameter auf true gesetzt, wird das Prefix "SMAEM<serialnumber_>....." weg gelassen.
- Sie können diesen Parameter auf true setzen, wenn Sie nicht mehr als ein SMAEM-Gerät in Ihrem Netzwerk haben und kürzere Namen für die Readings wünschen.
- Falls Sie unsicher sind, setzen Sie diesen Parameter nicht.
- <br><br>
- Sie benötigen das Perl-Module IO::Socket::Multicast für dieses FHEM Modul. Unter Debian (basierten) System, kann dies
- mittels <code>apt-get install libio-socket-multicast-perl</code> installiert werden.
- </ul>
- <br>
-
- <a name="SMAEMattr"></a>
- <b>Attribute</b>
- <ul>
- <li><b>disableSernoInReading</b> : unterdrückt das Prefix "SMAEM<serialnumber_>....." </li>
- <li><b>feedinPrice</b> : die individuelle Höhe der Vergütung pro Kilowattstunde </li>
- <li><b>interval</b> : Auswertungsinterval in Sekunden </li>
- <li><b>disable</b> : 1 = das Modul ist disabled </li>
- <li><b>diffAccept</b> : diffAccept legt fest, bis zu welchem Schwellenwert eine berechnete positive Werte-Differenz
- zwischen zwei unmittelbar aufeinander folgenden Zählerwerten (Readings mit *_Diff) akzeptiert werden
- soll (Standard ist 10). <br>
- Damit werden eventuell fehlerhafte Differenzen mit einem unverhältnismäßig hohen Differenzwert von der Berechnung
- ausgeschlossen und der Messzyklus verworfen. </li>
- <li><b>powerCost</b> : die individuelle Höhe der Stromkosten pro Kilowattstunde </li>
- <li><b>timeout</b> : Einstellung timeout für Hintergrundverarbeitung (default 60s). Der timeout-Wert muss größer als das Wert von "interval" sein. </li>
- </ul>
- <br>
- <a name="SMAEMreadings"></a>
- <b>Readings</b> <br><br>
- Die meisten erzeugten Readings von SMAEM sind selbsterklärend.
- Es gibt allerdings Readings die einer Erläuterung bedürfen. <br>
- <ul>
- <li><b><Phase>_THD</b> : (Total Harmonic Distortion) - Verzerrungs- oder Gesamtklirrfaktor - Verhältnis oder
- Anteil des Gesamteffektivwert aller Oberschwingungen zum Effektivwert der
- Grundschwingung. Gesamtanteil an Oberschwingungen und Störung der reinen Sinuswelle
- in % bzw. Verhältnis vom nutzbaren Grundschwingungsstrom zu den
- nicht nutzbaren Oberschwingungsströmen. Es ist ein Maß für Störungen. d ist 0, wenn bei
- sinusförmiger Spannung ein sinusförmiger Strom fließt. Je größer d, um so mehr
- Oberschwingungen sind vorhanden. Nach EN 50160/1999 z.B. darf der Wert 8 % nicht
- überschreiten. Wenn eine Stromstörung so stark ist, dass sie eine Spannungsstörung
- (THD) von über 5 % verursacht, deutet dies auf ein Potentialproblem hin. </li>
- </ul>
- <br>
- <p><a name="SMAInverter"></a>
- <h3>SMAInverter</h3>
- <div class='langLinks'>[<a href='commandref.html#SMAInverter'>EN</a> DE]</div>
- Modul zur Einbindung eines SMA Wechselrichters über Speedwire (Ethernet).<br>
- Getestet mit Sunny Tripower 6000TL-20 und Sunny Island 4.4 mit Speedwire/Webconnect Piggyback.
- <br><br>
- Fragen und Diskussionen rund um dieses Modul finden sie im FHEM-Forum unter:<br>
- <a href="https://forum.fhem.de/index.php/topic,56080.msg476525.html#msg476525">76_SMAInverter.pm - Abfrage von SMA Wechselrichter</a>.
- <br><br>
- <b>Voraussetzungen</b>
- <br><br>
- Dieses Modul benötigt:
- <ul>
- <li>Perl Modul: IO::Socket::INET (apt-get install libio-socket-multicast-perl) </li>
- <li>Perl Modul: Datetime (apt-get install libdatetime-perl) </li>
- <li>Perl Modul: Time::HiRes</li>
- <li>FHEM Modul: 99_SUNRISE_EL.pm</li>
- <li>FHEM Modul: Blocking.pm</li>
- </ul>
- <br>
- <br>
- <b>Define</b>
- <ul>
- <code>define <name> SMAInverter <pin> <hostname/ip></code><br>
- <br>
- <li>pin: Benutzer-Passwort des SMA STP Wechselrichters. Default ist 0000. Kann über die Windows-Software "Sunny Explorer" geändert werden </li>
- <li>hostname/ip: Hostname oder IP-Adresse des Wechselrichters (bzw. dessen Speedwire Moduls mit Ethernetanschluss) </li>
- <li>Der Port des Wechselrichters ist 9522. Dieser Port muss in der Firewall freigeschaltet sein !</li>
- </ul>
- <b>Arbeitsweise</b>
- <ul>
- Das Modul schickt Befehle an den Wechselrichter und überprüft, ob diese unterstützt werden.<br>
- Bei einer positiven Antwort werden die Daten gesammelt und je nach Detail-Level in den Readings dargestellt. <br>
- Sind mehr als ein Wechselrichter installiert, sind die Attribute "target-susyid" und "target-serial" entsprechend zu setzen um die korrekte
- Funktion zu gewährleisten. <br><br>
- Die normale Betriebszeit des Wechselrichters wird in der Zeit vom Sonnenaufgang bis Sonnenuntergang angenommen. In dieser Periode werden die Wechselrichterdaten
- abgefragt. Die Ermittlung von Sonnenaufgang / Sonnenuntergang wird über die Funktionen des FHEM-Moduls 99_SUNRISE_EL.pm vorgenommen. Zu diesem Zweck sollten die globalen
- Attribute longitude und latitude gesetzt sein um den Standort der Anlage genau zu ermitteln. (siehe <a href="#SUNRISE_EL">Commandref SUNRISE_EL</a>) <br><br>
- Mit dem Attribut "suppressSleep" kann der Schlafmodus unterdrückt werden. Das Attribut "offset" dient dazu den effektiven Zeitpunkt des Sonnenaufgangs / Sonnenuntergangs
- um den Betrag "offset" vorzuziehen (Sonnenaufgang) bzw. zu verzögern (Sonnenuntergang) und somit die Abfrageperiode des Wechselrichters zu verlängern. <br><br>
- Im Betriebsmodus "automatic" wird der Wechselrichter entsprechend des eingestellten Attributs "interval" abgefragt. Der Betriebsmodus kann in "manual"
- umgestellt werden um eine manuelle Abfrage zu realisieren (z.B. Synchronisierung mit einem SMA Energymeter über ein Notify). <br><br>
- Während der Betriebszeit des Wechselrichters wird die durchschnittliche Energieerzeugung der letzten 5, 10, 15 Minuten berechnet und in den Readings
- "avg_power_lastminutes_05", "avg_power_lastminutes_10" und "avg_power_lastminutes_15" ausgegeben. <b>Hinweis:</b> Um eine korrekte Berechnung zu
- ermöglichen, sollte auch im Betriebsmodus "manual" das tatsächliche Abfrageinterval im Attribute "interval" hinterlegt werden ! <br><br>
- Die Abfrage des Wechselrichters wird non-blocking ausgeführt. Der Timeoutwert für diesen Hintergrundprozess kann mit dem Attribut "timeout" eingestellt werden. <br>
- </ul>
- <b>Get</b>
- <br>
- <ul>
- <code>get <name> data</code>
- <br><br>
- Die Datenabfrage des Wechselrichters wird ausgeführt. Diese Möglichkeit ist speziell für den Betriebsmodus "manual" vorgesehen (siehe Attribut "mode").
- </ul>
- <b>Attribute</b>
- <ul>
- <li><b>interval</b> : Abfrageinterval in Sekunden </li>
- <li><b>detail-level</b> : "0" - Nur Leistung und Energie / "1" - zusätzlich Strom und Spannung / "2" - Alle Werte </li>
- <li><b>disable</b> : 1 = das Modul ist disabled </li>
- <li><b>mode</b> : automatic = die Wechselrichterwerte werden im eingestellten Interval abgefragt, manual = Abfrage nur mit "get <name> data" </li>
- <li><b>offset</b> : Zeit in Sekunden um die der Sonnenaufgang vorgezogen bzw. Sonnenuntergang verzögert wird (0 ... 7200). Dadurch wird die
- effektive Aktivzeit des Moduls erweitert. </li>
- <li><b>suppressSleep</b> : der Schlafmodus (nach Sonnenuntergang, vor Sonnenaufgang) wird ausgeschaltet und der WR abgefragt. </li>
- <li><b>showproctime</b> : zeigt die für den Hintergrundprozess und die Abfrage des Wechselrichter verbrauchte Zeit. </li>
- <li><b>SBFSpotComp</b> : 1 = die Readings werden kompatibel zu SBFSpot-Ausgaben erzeugt </li>
- <li><b>target-susyid</b> : Im Falle eines Multigate kann die Ziel-SUSyID definiert werden. Ist mehr als ein Wechselrichter installiert,
- muß die Wechselreichter-SUSyID gesetzt werden um den Wechselrichter der Device-Definition eindeutig zuzuweisen.
- Default ist 0xFFFF (=keine Einschränkung)</li>
- <li><b>target-serial</b> : Im Falle eines Multigate kann die Ziel-Seriennummer definiert werden. Ist mehr als ein Wechselrichter installiert,
- muß die Wechselreichter-Seriennummer gesetzt werden um den Wechselrichter der Device-Definition eindeutig zuzuweisen.
- Default ist 0xFFFFFFFF (=keine Einschränkung)</li>
- <li><b>timeout</b> : Einstellung des timeout für die Wechselrichterabfrage (default 60s) </li>
- </ul>
- <b>Readings</b>
- <ul>
- <li><b>BAT_CYCLES / bat_cycles</b> : Akku Ladezyklen </li>
- <li><b>BAT_IDC / bat_idc</b> : Akku Strom </li>
- <li><b>BAT_TEMP / bat_temp</b> : Akku Temperatur </li>
- <li><b>BAT_UDC / bat_udc</b> : Akku Spannung </li>
- <li><b>ChargeStatus / chargestatus</b> : Akku Ladestand </li>
- <li><b>CLASS / device_class</b> : Wechselrichter Klasse </li>
- <li><b>PACMAX1 / pac_max_phase_1</b> : Nominelle Leistung in Ok Mode </li>
- <li><b>PACMAX1_2 / pac_max_phase_1_2</b> : Maximale Leistung (für einige Wechselrichtertypen) </li>
- <li><b>PACMAX2 / pac_max_phase_2</b> : Nominelle Leistung in Warning Mode </li>
- <li><b>PACMAX3 / pac_max_phase_3</b> : Nominelle Leistung in Fault Mode </li>
- <li><b>Serialnumber / serial_number</b> : Wechselrichter Seriennummer </li>
- <li><b>SPOT_ETODAY / etoday</b> : Energie heute</li>
- <li><b>SPOT_ETOTAL / etotal</b> : Energie Insgesamt </li>
- <li><b>SPOT_FEEDTM / feed-in_time</b> : Einspeise-Stunden </li>
- <li><b>SPOT_FREQ / grid_freq.</b> : Netz Frequenz </li>
- <li><b>SPOT_IAC1 / phase_1_iac</b> : Netz Strom phase L1 </li>
- <li><b>SPOT_IAC2 / phase_2_iac</b> : Netz Strom phase L2 </li>
- <li><b>SPOT_IAC3 / phase_3_iac</b> : Netz Strom phase L3 </li>
- <li><b>SPOT_IDC1 / string_1_idc</b> : DC Strom Eingang 1 </li>
- <li><b>SPOT_IDC2 / string_2_idc</b> : DC Strom Eingang 2 </li>
- <li><b>SPOT_OPERTM / operation_time</b> : Betriebsstunden </li>
- <li><b>SPOT_PAC1 / phase_1_pac</b> : Leistung L1 </li>
- <li><b>SPOT_PAC2 / phase_2_pac</b> : Leistung L2 </li>
- <li><b>SPOT_PAC3 / phase_3_pac</b> : Leistung L3 </li>
- <li><b>SPOT_PACTOT / total_pac</b> : Gesamtleistung </li>
- <li><b>SPOT_PDC1 / string_1_pdc</b> : DC Leistung Eingang 1 </li>
- <li><b>SPOT_PDC2 / string_2_pdc</b> : DC Leistung Eingang 2 </li>
- <li><b>SPOT_UAC1 / phase_1_uac</b> : Netz Spannung phase L1 </li>
- <li><b>SPOT_UAC2 / phase_2_uac</b> : Netz Spannung phase L2 </li>
- <li><b>SPOT_UAC3 / phase_3_uac</b> : Netz Spannung phase L3 </li>
- <li><b>SPOT_UDC1 / string_1_udc</b> : DC Spannung Eingang 1 </li>
- <li><b>SPOT_UDC2 / string_2_udc</b> : DC Spannung Eingang 2 </li>
- <li><b>SUSyID / susyid</b> : Wechselrichter SUSyID </li>
- <li><b>INV_TEMP / device_temperature</b> : Wechselrichter Temperatur </li>
- <li><b>INV_TYPE / device_type</b> : Wechselrichter Typ </li>
- <li><b>POWER_IN / power_in</b> : Akku Ladeleistung </li>
- <li><b>POWER_OUT / power_out</b> : Akku Entladeleistung </li>
- <li><b>INV_GRIDRELAY / gridrelay_status</b> : Netz Relais Status </li>
- <li><b>INV_STATUS / device_status</b> : Wechselrichter Status </li>
- <li><b>opertime_start</b> : Beginn Aktivzeit des Wechselrichters entsprechend des ermittelten Sonnenaufgangs mit Berücksichtigung des
- Attributs "offset" (wenn gesetzt) </li>
- <li><b>opertime_stop</b> : Ende Aktivzeit des Wechselrichters entsprechend des ermittelten Sonnenuntergangs mit Berücksichtigung des
- Attributs "offset" (wenn gesetzt) </li>
- <li><b>modulstate</b> : zeigt den aktuellen Modulstatus "normal" oder "sleep" falls der Wechselrichter nicht abgefragt wird. </li>
- <li><b>avg_power_lastminutes_05</b> : durchschnittlich erzeugte Leistung der letzten 5 Minuten. </li>
- <li><b>avg_power_lastminutes_10</b> : durchschnittlich erzeugte Leistung der letzten 10 Minuten. </li>
- <li><b>avg_power_lastminutes_15</b> : durchschnittlich erzeugte Leistung der letzten 15 Minuten. </li>
- <li><b>inverter_processing_time</b> : verbrauchte Zeit um den Wechelrichter abzufragen. </li>
- <li><b>background_processing_time</b> : gesamte durch den Hintergrundprozess (BlockingCall) verbrauchte Zeit. </li>
-
- </ul>
- <br><br>
- <p><a name="SMARTMON"></a>
- <h3>SMARTMON</h3>
- <div class='langLinks'>[<a href='commandref.html#SMARTMON'>EN</a> DE]</div>
- <ul>
- Dieses Modul ist ein FHEM-Frontend zu dem Linux-Tool smartctl.
- Es liefert diverse Informationen zu dem S.M.A.R.T. System einer Festplatte.
- <br><br>
- <b>Define</b>
- <br><br>
- <code>define <name> SMARTMON <device> [<Interval>]</code><br>
- <br>
- Diese Anweisung erstellt eine neue SMARTMON-Instanz.
- Die Parameter geben ein zu überwachenden Gerät und den Aktualisierungsinterval in Minuten an.<br>
- <br>
-
- Beispiel: <code>define sm SMARTMON /dev/sda 60</code>
- <br>
- <br>
- <b>Readings:</b>
- <br><br>
- <ul>
- <li>last_exit_code<br>
- Gibt den Exitcode bei der letzten Ausführung vom smartctl.
- </li>
- <br>
- <li>overall_health_test<br>
- Gibt den allgemeinen Zustand der Platte an. Kann PASSED oder FAILED sein.
- </li>
- <br>
- <li>warnings<br>
- Gibt die Anzahl der vermerkten Warnungen an.
- </li>
- <br>
- Weiterhin können die verfügbaren SMART-Parameter als Readings angezeigt werden (RAW und/oder (teilweise) interpretiert).
- </ul>
- <br>
- <b>Get:</b><br><br>
- <ul>
- <li>version<br>
- Zeigt die verwendete Modul-Version an.
- </li>
- <br>
- <li>update<br>
- Veranlasst die Aktualisierung der gelesenen Parameter.
- </li>
- <br>
- <li>list<br>
- Zeigt verschiedenen Informationen an:
- <ul>
- <li>devices:<br>Liste der im System verfügbaren Geräten.</li>
- </ul><br>
- <ul>
- <li>info:<br>Information zu dem aktuellen Gerät.</li>
- </ul><br>
- <ul>
- <li>data:<br>Liste der SMART-Parameter zu dem aktuellen Gerät.</li>
- </ul><br>
- <ul>
- <li>health:<br>Information zu dem allgemeinen Gesundheitsstatus für das verwendete Gerät.</li>
- </ul><br>
- Für letzten 3 Befehle kann auch noch ein anderes Gerät als zusätzliche Parameter mitgegeben werden.
- </li>
- <br>
- </ul><br>
- <b>Attributes:</b><br><br>
- <ul>
- <li>show_raw<br>
- Gültige Werte: 0: keine RAW-Readings anzeigen (default), 1: alle anzeigen, die nicht in interpretierten Readings enthalten sind, 2: alle anzeigen.
- </li>
- <br>
- <li>include<br>
- Kommaseparierte Liste der IDs gewünschten SMART-Parameter. Wenn nichts angegeben, werden alle verfügbaren angezeigt.
- </li>
- <br>
- <li>disable<br>
- Gültige Werte: 0: Modul aktiv (default), 1: Modul deaktiviert (keine Aktualisierungen).
- </li>
- <br>
- <li>parameters<br>
- Zusatzparameter für den Aufruf von smartctl.
- </li>
- <br>
- </ul><br>
- Für weitere Informationen wird die cmartctrl-Dokumentation empfohlen.
- </ul>
- <p><a name="SMASTP"></a>
- <h3>SMASTP</h3>
- <div class='langLinks'>[<a href='commandref.html#SMASTP'>EN</a> DE]</div>
- Modul zur Einbindung eines Sunny Tripower Wechselrichters der Firma SMA über Speedwire (Ethernet).<br>
- Getestet mit Sunny Tripower 6000TL-20, 10000-TL20 sowie 10000TL-10 mit Speedwire/Webconnect Piggyback
- <p>
- <b>Define</b>
- <ul>
- <code>define <name> SMASTP <pin> <hostname/ip> [port]</code><br>
- <br>
- <li>pin: Benutzer-Passwort des SMA STP Wechselrichters. Default ist 0000. Kann über die Windows-Software "Sunny Explorer" geändert werden </li>
- <li>hostname/ip: Hostname oder IP-Adresse des Wechselrichters (bzw. dessen Speedwire Moduls mit Ethernetanschluss) </li>
- <li>port: Optional der Ports des Wechselrichters. Per default 9522. </li>
- </ul>
- <p>
- <b>Modus</b>
- <ul>
- Das Modul erkennt automatisch eine Inaktivität des Wechselrichters, wenn dieser aufgrund Dunkelheit seinen Betrieb einstellt. <br>
- Diese Betriebspause wird als "Nightmode" bezeichnet. Im Nightmode wird der Wechelrichter nicht mehr über das Netzwerk abgefragt.<br>
- Per default geht das Modul davon aus, dass vor 5:00 und nach 21:00 der Nightmode aktiv ist.<br>
- Diese Grenzen lassen sich mit den Parametern "starttime" (Start des Wechelrichterbetriebs, also Ende des Nightmode) <br>
- und "endtime" (Ende des Wechselrichterbetriebs, also Beginn des Nightmode) umdefinieren. <br>
- Darüber hinaus gibt es den "Inactivitymode": hier wird der Wechselrichter abgefragt, aber es werden keine Readings mehr aktualisiert. <br>
- </ul>
- <b>Parameter</b>
- <ul>
- <li>interval: Abfrageinterval in Sekunden </li>
- <li>suppress-night-mode: Der Nightmode wird deaktiviert </li>
- <li>suppress-inactivity-mode: Der Inactivitymode wird deaktiviert </li>
- <li>starttime: Startzeit des Betriebsmodus (Default 5:00 Uhr) </li>
- <li>endtime: Endezeit des Betriebsmodus (Default 21:00 Uhr) </li>
- <li>force-sleepmode: Der Nightmode wird bei entdeckter Inaktivität auch dann aktiviert, wenn endtime noch nicht erreicht ist </li>
- <li>enable-modulstate: Schaltet das reading "modulstate" (normal / inactive / sleeping) ein </li>
- <li>alarm1-value, alarm2-value, alarm3-value: Setzt einen Alarm in Watt auf das Reading SpotP.
- <br>Die Readings Alarm1..Alarm3 werden entsprechend gesetzt: -1 für SpotP < alarmX-value und 1 für Spot >= alarmX-value. </li>
- </ul>
- <b>Readings</b>
- <ul>
- <li>SpotP: SpotPower - Leistung in W zum Zeitpunkt der Abfrage</li>
- <li>AvP01: Average Power 1 Minute - Durchschnittliche Leistung in W der letzten Minute</li>
- <li>AvP05: Average Power 5 Minuten - Durchschnittliche Leistung in W der letzten 5 Minuten</li>
- <li>AvP15: Average Power 15 Minuten - Durchschnittliche Leistung in W der letzten 15 Minuten</li>
- <li>SpotPDC1: Spot Gleichspannung String 1 </li>
- <li>SpotPDC2: Spot Gleichspannung String 2 </li>
- <li>TotalTodayP: Erzeuge Leistung (in Wh) des heutigen Tages </li>
- <li>AlltimeTotalP: Erzeugte Leistung (in Wh) seit Inbetriebsnahme des Gerätes </li>
- <li>Alarm1..3: Alarm Trigger 1-3. Können über die Parameter "alarmN-value" gesetzt werden </li>
- </ul>
- <p><a name="SML"></a>
- <h3>SML</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SML'>SML</a><br/>
- </ul>
- <a name="SOMFY"></a>
- <h3>SOMFY</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SOMFY'>SOMFY</a><br/>
- </ul>
- <a name="SONOS"></a>
- <h3>SONOS</h3>
- <div class='langLinks'>[<a href='commandref.html#SONOS'>EN</a> DE]</div>
- <p>FHEM-Modul für die Anbindung des Sonos-Systems via UPnP</p>
- <p>Für weitere Hinweise und Beschreibungen bitte auch im Wiki unter <a href="http://www.fhemwiki.de/wiki/SONOS">http://www.fhemwiki.de/wiki/SONOS</a> nachschauen.</p>
- <p>Für die Verwendung sind Perlmodule notwendig, die unter Umständen noch nachinstalliert werden müssen:<ul>
- <li><code>LWP::Simple</code></li>
- <li><code>LWP::UserAgent</code></li>
- <li><code>SOAP::Lite</code></li>
- <li><code>HTTP::Request</code></li></ul>
- Installation z.B. als Debian-Pakete (mittels "sudo apt-get install <packagename>"):<ul>
- <li>LWP::Simple-Packagename (inkl. LWP::UserAgent und HTTP::Request): libwww-perl</li>
- <li>SOAP::Lite-Packagename: libsoap-lite-perl</li></ul>
- <br />Installation z.B. als Windows ActivePerl (mittels Perl-Packagemanager)<ul>
- <li>Package LWP (incl. LWP::UserAgent and HTTP::Request)</li>
- <li>Package SOAP::Lite</li>
- <li>SOAP::Lite-Special für Versionen nach 5.18:<ul>
- <li>Eine andere Paketquelle von den Vorschlägen oder manuell hinzufügen: Bribes de Perl (http://www.bribes.org/perl/ppm)</li>
- <li>Package: SOAP::Lite</li></ul></li></ul>
- <b>Windows ActivePerl 5.20 kann momentan nicht verwendet werden, da es das Paket SOAP::Lite dort momentan nicht gibt.</b></p>
- <p><b>Achtung!</b><br />Das Modul wird nicht auf jeder Plattform lauffähig sein, da Threads und die angegebenen Perl-Module verwendet werden.</p>
- <p>Mehr Informationen im (deutschen) Wiki-Artikel: <a href="http://www.fhemwiki.de/wiki/SONOS">http://www.fhemwiki.de/wiki/SONOS</a></p>
- <p>Das System besteht aus zwei Komponenten:<br />
- 1. Einem UPnP-Client, der als eigener Prozess im Hintergrund ständig läuft, und die Kommunikation mit den Sonos-Geräten übernimmt.<br />
- 2. Dem eigentlichen FHEM-Modul, welches mit dem UPnP-Client zusammenarbeitet, um die Funktionalität in FHEM zu ermöglichen.<br /><br />
- Der Client wird im Notfall automatisch von Modul selbst gestartet.<br />
- Man kann den Server unabhängig von FHEM selbst starten (um ihn dauerhaft und unabhängig von FHEM laufen zu lassen):<br />
- <code>perl 00_SONOS.pm 4711</code>: Startet einen unabhängigen Server, der auf Port 4711 auf eingehende FHEM-Verbindungen lauscht. Dieser Prozess kann dauerhaft laufen, FHEM kann sich verbinden und auch wieder trennen.</p>
- <h4>Beispiel</h4>
- <p>
- Einfachste Definition:<br />
- <b><code>define Sonos SONOS</code></b>
- </p>
- <p>
- Definition mit Kontrolle über den verwendeten Port und das Intervall der IsAlive-Prüfung:<br />
- <b><code>define Sonos SONOS localhost:4711 45</code></b>
- </p>
- <a name="SONOSdefine"></a>
- <h4>Definition</h4>
- <b><code>define <name> SONOS [upnplistener [interval [waittime [delaytime]]]]</code></b>
- <br /><br /> Definiert das Sonos interface für die Kommunikation mit dem Sonos-System.<br />
- <p>
- <b><code>[upnplistener]</code></b><br />Name und Port eines externen UPnP-Client. Wenn nicht angegebenen wird <code>localhost:4711</code> festgelegt. Der Port muss eine freie Portnummer ihres Systems sein. <br />Wenn sie keinen externen Client gestartet haben, startet das Skript einen eigenen.<br />Wenn sie einen eigenen Dienst gestartet haben, dann geben sie hier die entsprechenden Informationen an.</p>
- <p>
- <b><code>[interval]</code></b><br /> Das Interval wird für die Überprüfung eines Zoneplayers benötigt. In diesem Interval wird nachgeschaut, ob der Player noch erreichbar ist, da sich ein Player nicht mehr abmeldet, wenn er abgeschaltet wird :-)<br />Wenn nicht angegeben, wird ein Wert von 10 Sekunden angenommen.</p>
- <p>
- <b><code>[waittime]</code></b><br /> Hiermit wird die Wartezeit eingestellt, die nach dem Starten des SubProzesses darauf gewartet wird.</p>
- <p>
- <b><code>[delaytime]</code></b><br /> Hiermit kann eine Verzögerung eingestellt werden, die vor dem Starten des Netzwerks gewartet wird.</p>
- <a name="SONOSset"></a>
- <h4>Set</h4>
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="SONOS_setter_RefreshShareIndex">
- <b><code>RefreshShareIndex</code></b></a>
- <br />Startet die Aktualisierung der Bibliothek.</li>
- <li><a name="SONOS_setter_RescanNetwork">
- <b><code>RescanNetwork</code></b></a>
- <br />Startet die Erkennung der im Netzwerk vorhandenen Player erneut.</li>
- </ul></li>
- <li><b>Steuerbefehle</b><ul>
- <li><a name="SONOS_setter_Mute">
- <b><code>Mute <state></code></b></a>
- <br />Setzt den Mute-Zustand bei allen Playern.</li>
- <li><a name="SONOS_setter_PauseAll">
- <b><code>PauseAll</code></b></a>
- <br />Pausiert die Wiedergabe in allen Zonen.</li>
- <li><a name="SONOS_setter_Pause">
- <b><code>Pause</code></b></a>
- <br />Synonym für PauseAll.</li>
- <li><a name="SONOS_setter_StopAll">
- <b><code>StopAll</code></b></a>
- <br />Stoppt die Wiedergabe in allen Zonen.</li>
- <li><a name="SONOS_setter_Stop">
- <b><code>Stop</code></b></a>
- <br />Synonym für StopAll.</li>
- </ul></li>
- <li><b>Bookmark-Befehle</b><ul>
- <li><a name="SONOS_setter_DisableBookmark">
- <b><code>DisableBookmark <Groupname></code></b></a>
- <br />Deaktiviert die angegebene Gruppe.</li>
- <li><a name="SONOS_setter_EnableBookmark">
- <b><code>EnableBookmark <Groupname></code></b></a>
- <br />Aktiviert die angegebene Gruppe.</li>
- <li><a name="SONOS_setter_LoadBookmarks">
- <b><code>LoadBookmarks [Groupname]</code></b></a>
- <br />Lädt die angegebene Gruppe (oder alle Gruppen, wenn nicht angegeben) aus den entsprechenden Dateien.</li>
- <li><a name="SONOS_setter_SaveBookmarks">
- <b><code>SaveBookmarks [Groupname]</code></b></a>
- <br />Speichert die angegebene Gruppe (oder alle Gruppen, wenn nicht angegeben) in die entsprechenden Dateien.</li>
- </ul></li>
- <li><b>Gruppenbefehle</b><ul>
- <li><a name="SONOS_setter_Groups">
- <b><code>Groups <GroupDefinition></code></b></a>
- <br />Setzt die aktuelle Gruppierungskonfiguration der Sonos-Systemlandschaft. Das Format ist jenes, welches auch von dem Get-Befehl 'Groups' geliefert wird.<br >Hier kann als GroupDefinition das Wort <i>Reset</i> verwendet werden, um alle Player aus ihren Gruppen zu entfernen.</li>
- </ul></li>
- </ul>
- <a name="SONOSget"></a>
- <h4>Get</h4>
- <ul>
- <li><b>Gruppenbefehle</b><ul>
- <li><a name="SONOS_getter_Groups">
- <b><code>Groups</code></b></a>
- <br />Liefert die aktuelle Gruppierungskonfiguration der Sonos Systemlandschaft zurück. Das Format ist eine Kommagetrennte Liste von Listen mit Devicenamen, also z.B. <code>[Sonos_Kueche], [Sonos_Wohnzimmer, Sonos_Schlafzimmer]</code>. In diesem Beispiel sind also zwei Gruppen definiert, von denen die erste aus einem Player und die zweite aus Zwei Playern besteht.<br />
- Dabei ist die Reihenfolge innerhalb der Unterlisten wichtig, da der erste Eintrag der sogenannte Gruppenkoordinator ist (in diesem Fall also <code>Sonos_Wohnzimmer</code>), von dem die aktuelle Abspielliste un der aktuelle Titel auf die anderen Gruppenmitglieder übernommen wird.</li>
- </ul></li>
- </ul>
- <a name="SONOSattr"></a>
- <h4>Attribute</h4>
- '''Hinweis'''<br />Die Attribute werden erst bei einem Neustart von Fhem verwendet, da diese dem SubProzess initial zur Verfügung gestellt werden müssen.
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="SONOS_attribut_coverLoadTimeout"><b><code>coverLoadTimeout <value></code></b>
- </a><br />Eines von (0..10,15,20,25,30). Definiert den Timeout der für die Abfrage des Covers beim Sonosplayer verwendet wird. Wenn nicht angegeben, dann wird 5 verwendet.</li>
- <li><a name="SONOS_attribut_deviceRoomView"><b><code>deviceRoomView <Both|DeviceLineOnly></code></b>
- </a><br /> Gibt an, was in der Raumansicht zum Sonosplayer-Device angezeigt werden soll. <code>Both</code> bedeutet "normale" Devicezeile zzgl. Cover-/Titelanzeige und u.U. Steuerbereich, <code>DeviceLineOnly</code> bedeutet nur die Anzeige der "normalen" Devicezeile.</li>
- <li><a name="SONOS_attribut_disable"><b><code>disable <value></code></b>
- </a><br />Eines von (0,1). Hiermit kann das Modul abgeschaltet werden. Wirkt sofort. Bei 1 wird der SubProzess beendet, und somit keine weitere Verarbeitung durchgeführt. Bei 0 wird der Prozess wieder gestartet.<br />Damit kann das Modul temporär abgeschaltet werden, um bei der Neueinrichtung von Sonos-Komponenten keine halben Zustände mitzubekommen.</li>
- <li><a name="SONOS_attribut_getFavouritesListAtNewVersion"><b><code>getFavouritesListAtNewVersion <value></code></b>
- </a><br />Eines von (0,1). Mit diesem Attribut kann das Modul aufgefordert werden, die Favoriten (bei definiertem Attribut <code>getListsDirectlyToReadings</code>) bei Aktualisierung automatisch herunterzuladen.</li>
- <li><a name="SONOS_attribut_getPlaylistsListAtNewVersion"><b><code>getPlaylistsListAtNewVersion <value></code></b>
- </a><br />Eines von (0,1). Mit diesem Attribut kann das Modul aufgefordert werden, die Playlisten (bei definiertem Attribut <code>getListsDirectlyToReadings</code>) bei Aktualisierung automatisch herunterzuladen.</li>
- <li><a name="SONOS_attribut_getQueueListAtNewVersion"><b><code>getQueueListAtNewVersion <value></code></b>
- </a><br />Eines von (0,1). Mit diesem Attribut kann das Modul aufgefordert werden, die aktuelle Abspielliste (bei definiertem Attribut <code>getListsDirectlyToReadings</code>) bei Aktualisierung automatisch herunterzuladen.</li>
- <li><a name="SONOS_attribut_getRadiosListAtNewVersion"><b><code>getRadiosListAtNewVersion <value></code></b>
- </a><br />Eines von (0,1). Mit diesem Attribut kann das Modul aufgefordert werden, die Radioliste (bei definiertem Attribut <code>getListsDirectlyToReadings</code>) bei Aktualisierung automatisch herunterzuladen.</li>
- <li><a name="SONOS_attribut_getListsDirectlyToReadings"><b><code>getListsDirectlyToReadings <value></code></b>
- </a><br />Eines von (0,1). Mit diesem Attribut kann das Modul aufgefordert werden, die Listen für Favoriten, Playlists, Radios und Queue direkt in die entsprechenden Readings zu schreiben. Dafür sind dann keine Userreadings mehr notwendig.</li>
- <li><a name="SONOS_attribut_getLocalCoverArt"><b><code>getLocalCoverArt <value></code></b>
- </a><br />Eines von (0,1). Mit diesem Attribut kann das Modul aufgefordert werden, die Cover lokal herunterzuladen (bisheriges Standardverhalten).</li>
- <li><a name="SONOS_attribut_ignoredIPs"><b><code>ignoredIPs <IP-Adresse>[,IP-Adresse]</code></b>
- </a><br />Mit diesem Attribut können IP-Adressen angegeben werden, die vom UPnP-System ignoriert werden sollen. Z.B.: "192.168.0.11,192.168.0.37"</li>
- <li><a name="SONOS_attribut_pingType"><b><code>pingType <string></code></b>
- </a><br /> Eines von (none,tcp,udp,icmp,syn). Gibt an, welche Methode für die Ping-Überprüfung verwendet werden soll. Wenn 'none' angegeben wird, dann wird keine Überprüfung gestartet.</li>
- <li><a name="SONOS_attribut_reusePort"><b><code>reusePort <int></code></b>
- </a><br /> Eines von (0,1). Gibt an, ob die Portwiederwendung für SSDP aktiviert werden soll, oder nicht. Kann Restart-Probleme lösen. Wenn man diese Probleme nicht hat, sollte man das Attribut nicht setzen.</li>
- <li><a name="SONOS_attribut_SubProcessLogfileName"><b><code>SubProcessLogfileName <Pfad></code></b>
- </a><br /> Hiermit kann für den SubProzess eine eigene Logdatei angegeben werden. Unter Windows z.B. überschreiben sich die beiden Logausgaben (von Fhem und SubProzess) sonst gegenseitig. Wenn "-" angegeben wird, wird wie bisher auf STDOUT (und damit im Fhem-Log) geloggt. Der Hauptanwendungsfall ist die mehr oder weniger kurzfristige Fehlersuche. Es werden keinerlei Variablenwerte ersetzt, und der Wert direkt als Dateiname verwendet.</li>
- <li><a name="SONOS_attribut_usedonlyIPs"><b><code>usedonlyIPs <IP-Adresse>[,IP-Adresse]</code></b>
- </a><br />Mit diesem Attribut können IP-Adressen angegeben werden, die ausschließlich vom UPnP-System berücksichtigt werden sollen. Z.B.: "192.168.0.11,192.168.0.37"</li>
- </ul></li>
- <li><b>Bookmark-Einstellungen</b><ul>
- <li><a name="SONOS_attribut_bookmarkSaveDir"><b><code>bookmarkSaveDir <path></code></b>
- </a><br /> Das Verzeichnis, in dem die Dateien für die gespeicherten Bookmarks abgelegt werden sollen. Wenn nicht festgelegt, dann wird "." verwendet.</li>
- <li><a name="SONOS_attribut_bookmarkTitleDefinition"><b><code>bookmarkTitleDefinition <Groupname>:<PlayerdeviceRegEx>:<TrackURIRegEx>:<MinTitleLength>:<RemainingLength>:<MaxAge>:<ReadOnly> [...]</code></b>
- </a><br /> Die Definition für die Verwendung von Bookmarks für Titel.</li>
- <li><a name="SONOS_attribut_bookmarkPlaylistDefinition"><b><code>bookmarkPlaylistDefinition <Groupname>:<PlayerdeviceRegEx>:<MinListLength>:<MaxListLength>:<MaxAge> [...]</code></b>
- </a><br /> Die Definition für die Verwendung von Bookmarks für aktuelle Abspiellisten/Playlisten.</li>
- </ul></li>
- <li><b>Proxy-Einstellungen</b><ul>
- <li><a name="SONOS_attribut_generateProxyAlbumArtURLs"><b><code>generateProxyAlbumArtURLs <int></code></b>
- </a><br /> Aus (0, 1). Wenn aktiviert, werden alle Cober-Links als Proxy-Aufrufe an Fhem generiert. Dieser Proxy-Server wird vom Sonos-Modul bereitgestellt. In der Grundeinstellung erfolgt kein Caching der Cover, sondern nur eine Durchreichung der Cover von den Sonosplayern (Damit ist der Zugriff durch einen externen Proxyserver auf Fhem möglich).</li>
- <li><a name="SONOS_attribut_proxyCacheDir"><b><code>proxyCacheDir <Path></code></b>
- </a><br /> Hiermit wird das Verzeichnis festgelegt, in dem die Cober zwischengespeichert werden. Wenn nicht festegelegt, so wird "/tmp" verwendet.</li>
- <li><a name="SONOS_attribut_proxyCacheTime"><b><code>proxyCacheTime <int></code></b>
- </a><br /> Mit einer Angabe ungleich 0 wird der Caching-Mechanismus des Sonos-Modul-Proxy-Servers aktiviert. Dabei werden Cover, die im Cache älter sind als diese Zeitangabe in Sekunden, neu vom Sonosplayer geladen, alle anderen direkt ausgeliefert, ohne den Player zu fragen.</li>
- <li><a name="SONOS_attribut_webname"><b><code>webname <String></code></b>
- </a><br /> Hiermit kann der zu verwendende Webname für die Cover-Link-Erzeugung angegeben werden. Da vom Modul Links zu Cover u.ä. erzeugt werden, ohne dass es einen FhemWeb-Aufruf dazu gibt, kann das Modul diesen Pfad nicht selber herausfinden. Wenn das Attribut nicht angegeben wird, dann wird 'fhem' angenommen.</li>
- </ul></li>
- <li><b>Sprachoptionen</b><ul>
- <li><a name="SONOS_attribut_targetSpeakDir"><b><code>targetSpeakDir <string></code></b>
- </a><br /> Gibt an, welches Verzeichnis für die Ablage des MP3-Files der Textausgabe verwendet werden soll</li>
- <li><a name="SONOS_attribut_targetSpeakMP3FileConverter"><b><code>targetSpeakMP3FileConverter <string></code></b>
- </a><br /> Hiermit kann ein MP3-Konverter angegeben werden, da am Ende der Verkettung der Speak-Ansage das resultierende MP3-File nochmal sauber durchkodiert. Damit können Restzeitanzeigeprobleme behoben werden. Dadurch vegrößert sich allerdings u.U. die Ansageverzögerung.</li>
- <li><a name="SONOS_attribut_targetSpeakMP3FileDir"><b><code>targetSpeakMP3FileDir <string></code></b>
- </a><br /> Das Verzeichnis, welches als Standard für MP3-Fileangaben in Speak-Texten verwendet werden soll. Wird dieses Attribut definiert, können die Angaben bei Speak ohne Verzeichnis erfolgen.</li>
- <li><a name="SONOS_attribut_targetSpeakURL"><b><code>targetSpeakURL <string></code></b>
- </a><br /> Gibt an, unter welcher Adresse der ZonePlayer das unter targetSpeakDir angegebene Verzeichnis erreichen kann.</li>
- <li><a name="SONOS_attribut_targetSpeakFileTimestamp"><b><code>targetSpeakFileTimestamp <int></code></b>
- </a><br /> One of (0, 1). Gibt an, ob die erzeugte MP3-Sprachausgabedatei einen Zeitstempel erhalten soll (1) oder nicht (0).</li>
- <li><a name="SONOS_attribut_targetSpeakFileHashCache"><b><code>targetSpeakFileHashCache <int></code></b>
- </a><br /> One of (0, 1). Gibt an, ob die erzeugte Sprachausgabedatei einen Hashwert erhalten soll (1) oder nicht (0). Wenn dieser Wert gesetzt wird, dann wird eine bereits bestehende Datei wiederverwendet, und nicht neu erzeugt.</li>
- <li><a name="SONOS_attribut_Speak1"><b><code>Speak1 <Fileextension>:<Commandline></code></b>
- </a><br />Hiermit kann ein Systemaufruf definiert werden, der zu Erzeugung einer Sprachausgabe verwendet werden kann. Sobald dieses Attribut definiert wurde, ist ein entsprechender Setter am Sonosplayer verfügbar.<br />Es dürfen folgende Platzhalter verwendet werden:<br />'''%language%''': Wird durch die eingegebene Sprache ersetzt<br />'''%filename%''': Wird durch den kompletten Dateinamen (inkl. Dateiendung) ersetzt.<br />'''%text%''': Wird durch den zu übersetzenden Text ersetzt.<br />'''%textescaped%''': Wird durch den URL-Enkodierten zu übersetzenden Text ersetzt.</li>
- <li><a name="SONOS_attribut_Speak2"><b><code>Speak2 <Fileextension>:<Commandline></code></b>
- </a><br />Siehe Speak1</li>
- <li><a name="SONOS_attribut_Speak3"><b><code>Speak3 <Fileextension>:<Commandline></code></b>
- </a><br />Siehe Speak1</li>
- <li><a name="SONOS_attribut_Speak4"><b><code>Speak4 <Fileextension>:<Commandline></code></b>
- </a><br />Siehe Speak1</li>
- <li><a name="SONOS_attribut_SpeakCover"><b><code>SpeakCover <Absolute-Imagepath></code></b>
- </a><br />Hiermit kann ein JPG- oder PNG-Bild als Cover für die Sprachdurchsagen definiert werden.</li>
- <li><a name="SONOS_attribut_Speak1Cover"><b><code>Speak1Cover <Absolute-Imagepath></code></b>
- </a><br />Analog zu SpeakCover für Speak1.</li>
- <li><a name="SONOS_attribut_Speak2Cover"><b><code>Speak2Cover <Absolute-Imagepath></code></b>
- </a><br />Analog zu SpeakCover für Speak2.</li>
- <li><a name="SONOS_attribut_Speak3Cover"><b><code>Speak3Cover <Absolute-Imagepath></code></b>
- </a><br />Analog zu SpeakCover für Speak3.</li>
- <li><a name="SONOS_attribut_Speak3Cover"><b><code>Speak3Cover <Absolute-Imagepath></code></b>
- </a><br />Analog zu SpeakCover für Speak3.</li>
- <li><a name="SONOS_attribut_Speak4Cover"><b><code>Speak4Cover <Absolute-Imagepath></code></b>
- </a><br />Analog zu SpeakCover für Speak4.</li>
- <li><a name="SONOS_attribut_SpeakGoogleURL"><b><code>SpeakGoogleURL <GoogleURL></code></b>
- </a><br />Die zu verwendende Google-URL. Wenn dieser Parameter nicht angegeben wird, dann wird ein Standard verwendet. Hier müssen Platzhalter für die Ersetzung durch das Modul eingetragen werden: %1$s -> Sprache, %2$s -> Text<br />Die Standard-URL lautet momentan: <code>http://translate.google.com/translate_tts?tl=%1$s&client=tw-ob&q=%2$s</code></li>
- </ul></li>
- </ul>
- <p><a name="SONOSPLAYER"></a>
- <h3>SONOSPLAYER</h3>
- <div class='langLinks'>[<a href='commandref.html#SONOSPLAYER'>EN</a> DE]</div>
- <p>FHEM Modul für die Steuerung eines Sonos Zoneplayer</p>
- <p>Für weitere Hinweise und Beschreibungen bitte auch im Wiki unter <a href="http://www.fhemwiki.de/wiki/SONOS">http://www.fhemwiki.de/wiki/SONOS</a> nachschauen.</p>
- <p>Im Normalfall braucht man dieses Device nicht selber zu definieren, da es automatisch vom Discovery-Process des Sonos-Device erzeugt wird.</p>
- <h4>Example</h4>
- <p>
- <code>define Sonos_Wohnzimmer SONOSPLAYER RINCON_000EFEFEFEF401400_MR</code>
- </p>
- <a name="SONOSPLAYERdefine"></a>
- <h4>Definition</h4>
- <b><code>define <name> SONOSPLAYER <udn></code></b>
- <p>
- <b><code><udn></code></b><br /> MAC-Addressbasierter eindeutiger Bezeichner des Zoneplayer</p>
- <a name="SONOSPLAYERset"></a>
- <h4>Set</h4>
- <ul>
- <li><b>Grundsätzliche Einstellungen</b><ul>
- <li><a name="SONOSPLAYER_setter_Alarm">
- <b><code>Alarm (Create|Update|Delete|Enable|Disable) <ID[,ID]|All> <Datahash></code></b></a>
- <br />Diese Anweisung wird für die Bearbeitung der Alarme verwendet:<ul><li><b>Create:</b> Erzeugt einen neuen Alarm-Eintrag mit den übergebenen Hash-Daten.</li><li><b>Update:</b> Aktualisiert die Alarme mit den übergebenen IDs und den angegebenen Hash-Daten.</li><li><b>Delete:</b> Löscht die Alarm-Einträge mit den übergebenen IDs.</li><li><b>Enable:</b> Aktiviert die Alarm-Einträge mit den übergebenen IDs.</li><li><b>Disable:</b> Deaktiviert die Alarm-Einträge mit den übergebenen IDs.</li></ul>Bei Angabe des Wortes 'All' als ID, werden alle Alarme dieses Players bearbeitet.<br /><b>Die Hash-Daten:</b><br />Das Format ist ein Perl-Hash und wird mittels der eval-Funktion interpretiert.<br />e.g.: { Repeat => 1 }<br /><br />Die folgenden Schlüssel sind zulässig/notwendig:<ul><li>StartTime</li><li>Duration</li><li>Recurrence_Once</li><li>Recurrence_Monday</li><li>Recurrence_Tuesday</li><li>Recurrence_Wednesday</li><li>Recurrence_Thursday</li><li>Recurrence_Friday</li><li>Recurrence_Saturday</li><li>Recurrence_Sunday</li><li>Enabled</li><li>ProgramURI</li><li>ProgramMetaData</li><li>Shuffle</li><li>Repeat</li><li>Volume</li><li>IncludeLinkedZones</li></ul><br />z.B.:<ul><li>set Sonos_Wohnzimmer Alarm Create 0 { Enabled => 1, Volume => 35, StartTime => '00:00:00', Duration => '00:15:00', Repeat => 0, Shuffle => 0, ProgramURI => 'x-rincon-buzzer:0', ProgramMetaData => '', Recurrence_Once => 0, Recurrence_Monday => 1, Recurrence_Tuesday => 1, Recurrence_Wednesday => 1, Recurrence_Thursday => 1, Recurrence_Friday => 1, Recurrence_Saturday => 0, Recurrence_Sunday => 0, IncludeLinkedZones => 0 }</li><li>set Sonos_Wohnzimmer Alarm Update 17 { Shuffle => 1 }</li><li>set Sonos_Wohnzimmer Alarm Delete 17 {}</li></ul></li>
- <li><a name="SONOSPLAYER_setter_AudioDelay">
- <b><code>AudioDelay <Level></code></b></a>
- <br /> Setzt den AudioDelay der Playbar auf den angegebenen Wert. Der Wert kann zwischen 0 und 5 liegen.</li>
- <li><a name="SONOSPLAYER_setter_AudioDelayLeftRear">
- <b><code>AudioDelayLeftRear <Level></code></b></a>
- <br /> Setzt den AudioDelayLeftRear des Players auf den angegebenen Wert. Der Wert kann zwischen 0 und 2 liegen. Wobei die Werte folgende Bedeutung haben: 0: >3m, 1: >0.6m und <3m, 2: <0.6m</li>
- <li><a name="SONOSPLAYER_setter_AudioDelayRightRear">
- <b><code>AudioDelayRightRear <Level></code></b></a>
- <br /> Setzt den AudioDelayRightRear des Players auf den angegebenen Wert. Der Wert kann zwischen 0 und 2 liegen. Wobei die Werte folgende Bedeutung haben: 0: >3m, 1: >0.6m und <3m, 2: <0.6m</li>
- <li><a name="SONOSPLAYER_setter_ButtonLockState">
- <b><code>ButtonLockState <int></code></b></a>
- <br />One of (0, 1). Setzt den aktuellen Button-Sperr-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_DailyIndexRefreshTime">
- <b><code>DailyIndexRefreshTime <Timestring></code></b></a>
- <br />Setzt die aktuell gültige DailyIndexRefreshTime für alle Zoneplayer.</li>
- <li><a name="SONOSPLAYER_setter_DialogLevel">
- <b><code>DialogLevel <State></code></b></a>
- <br /> Legt den Zustand der Sprachverbesserung der Playbar fest.</li>
- <li><a name="SONOSPLAYER_setter_ExportSonosBibliothek">
- <b><code>ExportSonosBibliothek <filename></code></b></a>
- <br />Exportiert eine Datei mit der textuellen Darstellung eines Struktur- und Titelhashs, das die komplette Navigationsstruktur aus der Sonos-Bibliothek abbildet. Achtung: Benötigt eine große Menge CPU-Zeit und Arbeitsspeicher für die Ausführung!</li>
- <li><a name="SONOSPLAYER_setter_Name">
- <b><code>Name <Zonename></code></b></a>
- <br />Legt den Namen der Zone fest.</li>
- <li><a name="SONOSPLAYER_setter_NightMode">
- <b><code>NightMode <State></code></b></a>
- <br /> Legt den Zustand des Nachtsounds der Playbar fest.</li>
- <li><a name="SONOSPLAYER_setter_OutputFixed">
- <b><code>OutputFixed <State></code></b></a>
- <br /> Setzt den angegebenen OutputFixed-Zustand. Liefert den aktuell gültigen OutputFixed-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_Reboot">
- <b><code>Reboot</code></b></a>
- <br />Führt für den Zoneplayer einen Neustart durch.</li>
- <li><a name="SONOSPLAYER_setter_ResetAttributesToDefault">
- <b><code>ResetAttributesToDefault <DeleteAllOtherAttributes></code></b></a>
- <br />Setzt die Attribute eines Players auf die Voreinstellung zurück, wie sie beim Anlegen des Players gesetzt waren. Wenn der Parameter "DeleteAllOtherAttributes" mit "1" oder "on" angegeben wurde, werden vor dem Setzen alle Attribute gelöscht.</li>
- <li><a name="SONOSPLAYER_setter_RoomIcon">
- <b><code>RoomIcon <Iconname></code></b></a>
- <br />Legt das Icon für die Zone fest</li>
- <li><a name="SONOSPLAYER_setter_SnoozeAlarm">
- <b><code>SnoozeAlarm <Timestring|Seconds></code></b></a>
- <br />Unterbricht eine laufende Alarmwiedergabe für den übergebenen Zeitraum.</li>
- <li><a name="SONOSPLAYER_setter_SubEnable">
- <b><code>SubEnable <State></code></b></a>
- <br /> Legt den Zustand des Sub-Zustands fest.</li>
- <li><a name="SONOSPLAYER_setter_SubGain">
- <b><code>SubGain <Level></code></b></a>
- <br /> Setzt den SubGain auf den angegebenen Wert. Der Wert kann zwischen -15 und 15 liegen.</li>
- <li><a name="SONOSPLAYER_setter_SubPolarity">
- <b><code>SubPolarity <Level></code></b></a>
- <br /> Setzt den SubPolarity auf den angegebenen Wert. Der Wert kann zwischen 0 und 2 liegen.</li>
- <li><a name="SONOSPLAYER_setter_SurroundEnable">
- <b><code>SurroundEnable <State></code></b></a>
- <br />Setzt den SurroundEnable-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_SurroundLevel">
- <b><code>SurroundLevel <Level></code></b></a>
- <br /> Setzt den Surroundlevel auf den angegebenen Wert. Der Wert kann zwischen -15 und 15 liegen.</li>
- <li><a name="SONOSPLAYER_setter_TruePlay">
- <b><code>TruePlay <State></code></b></a>
- <br />Setzt den TruePlay-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_Wifi">
- <b><code>Wifi <State></code></b></a>
- <br />Setzt den WiFi-Zustand des Players. Kann 'off', 'persist-off' oder 'on' sein.</li>
- </ul></li>
- <li><b>Abspiel-Steuerbefehle</b><ul>
- <li><a name="SONOSPLAYER_setter_CurrentTrackPosition">
- <b><code>CurrentTrackPosition <TimePosition></code></b></a>
- <br /> Setzt die Abspielposition innerhalb des Liedes auf den angegebenen Zeitwert (z.B. 0:01:15) oder eine Sekundenangabe (z.B. 81). Man kann hier auch relative Angaben machen wie '+0:00:10' oder nur '+10'. Zusätzlich kann man auch Prozentwerte angeben wie z.B. '+10%'. Natürlich können diese Angaben auch negativ sein.</li>
- <li><a name="SONOSPLAYER_setter_Pause">
- <b><code>Pause</code></b></a>
- <br /> Pausiert die Wiedergabe</li>
- <li><a name="SONOSPLAYER_setter_Previous">
- <b><code>Previous</code></b></a>
- <br /> Springt an den Anfang des vorherigen Titels.</li>
- <li><a name="SONOSPLAYER_setter_Play">
- <b><code>Play</code></b></a>
- <br /> Startet die Wiedergabe</li>
- <li><a name="SONOSPLAYER_setter_PlayURI">
- <b><code>PlayURI <songURI> [Volume]</code></b></a>
- <br /> Spielt die angegebene MP3-Datei ab. Dabei kann eine Lautstärke optional mit angegeben werden.</li>
- <li><a name="SONOSPLAYER_setter_PlayURITemp">
- <b><code>PlayURITemp <songURI> [Volume]</code></b></a>
- <br /> Spielt die angegebene MP3-Datei mit der optionalen Lautstärke als temporäre Wiedergabe ab. Nach dem Abspielen wird der vorhergehende Zustand wiederhergestellt, und läuft an der unterbrochenen Stelle weiter. Wenn die Länge der Datei nicht ermittelt werden kann (z.B. bei Streams), läuft die Wiedergabe genauso wie bei <code>PlayURI</code> ab, es wird also nichts am Ende (wenn es eines geben sollte) wiederhergestellt.</li>
- <li><a name="SONOSPLAYER_setter_Next">
- <b><code>Next</code></b></a>
- <br /> Springt an den Anfang des nächsten Titels</li>
- <li><a name="SONOSPLAYER_setter_Speak">
- <b><code>Speak <Volume> <Language> <Text></code></b></a>
- <br /> Verwendet die Google Text-To-Speech-Engine um den angegebenen Text in eine MP3-Datei umzuwandeln und anschließend mittels <code>PlayURITemp</code> als Durchsage abzuspielen. Mögliche Sprachen können auf der Google-Seite nachgesehen werden. Möglich sind z.B. "de", "en", "fr", "es"...</li>
- <li><a name="SONOSPLAYER_setter_StartFavourite">
- <b><code>StartFavourite <FavouriteName> [NoStart]</code></b></a>
- <br /> Startet den angegebenen Favoriten. Der Name bezeichnet einen Eintrag in der Sonos-Favoritenliste. Der Parameter sollte/kann URL-Encoded werden um auch Spezialzeichen zu ermöglichen. Wenn das Wort 'NoStart' als zweiter Parameter angegeben wurde, dann wird der Favorit geladen und fertig vorbereitet, aber nicht explizit gestartet.<br />Zusätzlich kann ein regulärer Ausdruck für den Namen verwendet werden. Der erste Treffer wird verwendet. Das Format ist z.B. <code>/meine.hits/</code>.</li>
- <li><a name="SONOSPLAYER_setter_StartPlaylist">
- <b><code>StartPlaylist <Playlistname> [EmptyQueueBeforeImport]</code></b></a>
- <br /> Lädt die benannte Playlist und startet sofort die Wiedergabe. Zu den Parametern und Bemerkungen bitte unter "LoadPlaylist" nachsehen.</li>
- <li><a name="SONOSPLAYER_setter_StartRadio">
- <b><code>StartRadio <Radiostationname></code></b></a>
- <br /> Lädt den benannten Radiosender, genauer gesagt, den benannten Radiofavoriten und startet sofort die Wiedergabe. Dabei wird die bestehende Abspielliste beibehalten, aber deaktiviert. Der Parameter kann/muss URL-Encoded sein, um auch Leer- und Sonderzeichen angeben zu können.</li>
- <li><a name="SONOSPLAYER_setter_StartSearchlist">
- <b><code>StartSearchlist <Kategoriename> <KategorieElement> [[TitelfilterRegEx]/[AlbumfilterRegEx]/[ArtistfilterRegEx] [maxElem]]</code></b></a>
- <br /> Lädt die Searchlist und startet sofort die Wiedergabe. Für nähere Informationen bitte unter "LoadSearchlist" nachschlagen.</li>
- <li><a name="SONOSPLAYER_setter_Stop">
- <b><code>Stop</code></b></a>
- <br /> Stoppt die Wiedergabe</li>
- <li><a name="SONOSPLAYER_setter_Track">
- <b><code>Track <TrackNumber|Random></code></b></a>
- <br /> Aktiviert den angebenen Titel der aktuellen Abspielliste. Wenn als Tracknummer der Wert <code>Random</code> angegeben wird, dann wird eine zufällige Trackposition ausgewählt.</li>
- </ul></li>
- <li><b>Einstellungen zum Abspielen</b><ul>
- <li><a name="SONOSPLAYER_setter_Balance">
- <b><code>Balance <BalanceValue></code></b></a>
- <br /> Setzt die Balance auf den angegebenen Wert. Der Wert kann zwischen -100 (voll links) bis 100 (voll rechts) sein. Gibt die wirklich eingestellte Balance als Ergebnis zurück.</li>
- <li><a name="SONOSPLAYER_setter_Bass">
- <b><code>Bass <BassValue></code></b></a>
- <br /> Setzt den Basslevel auf den angegebenen Wert. Der Wert kann zwischen -10 bis 10 sein. Gibt den wirklich eingestellten Basslevel als Ergebnis zurück.</li>
- <li><a name="SONOSPLAYER_setter_CrossfadeMode">
- <b><code>CrossfadeMode <State></code></b></a>
- <br /> Legt den Zustand des Crossfade-Mode fest. Liefert den aktuell gültigen Crossfade-Mode.</li>
- <li><a name="SONOSPLAYER_setter_LEDState">
- <b><code>LEDState <State></code></b></a>
- <br /> Legt den Zustand der LED fest. Liefert den aktuell gültigen Zustand.</li>
- <li><a name="SONOSPLAYER_setter_Loudness">
- <b><code>Loudness <State></code></b></a>
- <br /> Setzt den angegebenen Loudness-Zustand. Liefert den aktuell gültigen Loudness-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_Mute">
- <b><code>Mute <State></code></b></a>
- <br /> Setzt den angegebenen Mute-Zustand. Liefert den aktuell gültigen Mute-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_MuteT">
- <b><code>MuteT</code></b></a>
- <br /> Schaltet den Zustand des Mute-Zustands um. Liefert den aktuell gültigen Mute-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_Repeat">
- <b><code>Repeat <State></code></b></a>
- <br /> Legt den Zustand des Repeat-Zustands fest. Liefert den aktuell gültigen Repeat-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_RepeatOne">
- <b><code>RepeatOne <State></code></b></a>
- <br /> Legt den Zustand des RepeatOne-Zustands fest. Liefert den aktuell gültigen RepeatOne-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_RepeatOneT">
- <b><code>RepeatOneT</code></b></a>
- <br /> Schaltet den Zustand des RepeatOne-Zustands um. Liefert den aktuell gültigen RepeatOne-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_RepeatT">
- <b><code>RepeatT</code></b></a>
- <br /> Schaltet den Zustand des Repeat-Zustands um. Liefert den aktuell gültigen Repeat-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_Shuffle">
- <b><code>Shuffle <State></code></b></a>
- <br /> Legt den Zustand des Shuffle-Zustands fest. Liefert den aktuell gültigen Shuffle-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_ShuffleT">
- <b><code>ShuffleT</code></b></a>
- <br /> Schaltet den Zustand des Shuffle-Zustands um. Liefert den aktuell gültigen Shuffle-Zustand.</li>
- <li><a name="SONOSPLAYER_setter_SleepTimer">
- <b><code>SleepTimer <Timestring|Seconds></code></b></a>
- <br /> Legt den aktuellen SleepTimer fest. Der Wert muss ein kompletter Zeitstempel sein (HH:MM:SS). Zum Deaktivieren darf der Zeitstempel nur Nullen enthalten oder das Wort 'off'.</li>
- <li><a name="SONOSPLAYER_setter_Treble">
- <b><code>Treble <TrebleValue></code></b></a>
- <br /> Setzt den Treblelevel auf den angegebenen Wert. Der Wert kann zwischen -10 bis 10 sein. Gibt den wirklich eingestellten Treblelevel als Ergebnis zurück.</li>
- <li><a name="SONOSPLAYER_setter_Volume">
- <b><code>Volume <VolumeLevel> [RampType]</code></b></a>
- <br /> Setzt die aktuelle Lautstärke auf den angegebenen Wert. Der Wert kann ein relativer Wert mittels + oder - Zeichen sein. Liefert den aktuell gültigen Lautstärkewert zurück.<br />Optional kann ein RampType übergeben werden, der einen Wert zwischen 1 und 3 annehmen kann, und verschiedene von Sonos festgelegte Muster beschreibt.</li>
- <li><a name="SONOSPLAYER_setter_VolumeD">
- <b><code>VolumeD</code></b></a>
- <br /> Verringert die aktuelle Lautstärke um volumeStep-Einheiten.</li>
- <li><a name="SONOSPLAYER_setter_VolumeRestore">
- <b><code>VolumeRestore</code></b></a>
- <br /> Stellt die mittels <code>VolumeSave</code> gespeicherte Lautstärke wieder her.</li>
- <li><a name="SONOSPLAYER_setter_VolumeSave">
- <b><code>VolumeSave <VolumeLevel></code></b></a>
- <br /> Setzt die aktuelle Lautstärke auf den angegebenen Wert. Der Wert kann ein relativer Wert mittels + oder - Zeichen sein. Liefert den aktuell gültigen Lautstärkewert zurück. Zusätzlich wird der alte Lautstärkewert gespeichert und kann mittels <code>VolumeRestore</code> wiederhergestellt werden.</li>
- <li><a name="SONOSPLAYER_setter_VolumeU">
- <b><code>VolumeU</code></b></a>
- <br /> Erhöht die aktuelle Lautstärke um volumeStep-Einheiten.</li>
- </ul></li>
- <li><b>Steuerung der aktuellen Abspielliste</b><ul>
- <li><a name="SONOSPLAYER_setter_AddURIToQueue">
- <b><code>AddURIToQueue <songURI></code></b></a>
- <br /> Fügt die angegebene MP3-Datei an der aktuellen Stelle in die Abspielliste ein.</li>
- <li><a name="SONOSPLAYER_setter_CurrentPlaylist">
- <b><code>CurrentPlaylist</code></b></a>
- <br /> Setzt den Abspielmodus auf die aktuelle Abspielliste, startet aber keine Wiedergabe (z.B. nach dem Hören eines Radiostreams, wo die aktuelle Abspielliste noch existiert, aber gerade "nicht verwendet" wird)</li>
- <li><a name="SONOSPLAYER_setter_DeleteFromQueue">
- <b><code>DeleteFromQueue <index_of_elems></code></b></a>
- <br /> Löscht die angegebenen Elemente aus der aktuellen Abspielliste. Die Angabe erfolgt über die Indizies der Titel. Es können die bei Perl-Array-üblichen Formate verwendet werden: "1..12,17,20..22". Die Indizies beziehen sich auf die aktuell angezeigte Reihenfolge (diese unterscheidet sich zwischen der normalen Abspielweise und dem Shufflemodus).</li>
- <li><a name="SONOSPLAYER_setter_DeletePlaylist">
- <b><code>DeletePlaylist</code></b></a>
- <br /> Löscht die bezeichnete Playliste. Zum möglichen Format des Playlistenamen unter LoadPlaylist nachsehen.</li>
- <li><a name="SONOSPLAYER_setter_EmptyPlaylist">
- <b><code>EmptyPlaylist</code></b></a>
- <br /> Leert die aktuelle Abspielliste</li>
- <li><a name="SONOSPLAYER_setter_LoadFavourite">
- <b><code>LoadFavourite <FavouriteName></code></b></a>
- <br /> Lädt den angegebenen Favoriten. Der Name bezeichnet einen Eintrag in der Sonos-Favoritenliste. Der Parameter sollte/kann URL-Encoded werden um auch Spezialzeichen zu ermöglichen.<br />Zusätzlich kann ein regulärer Ausdruck für den Namen verwendet werden. Der erste Treffer wird verwendet. Das Format ist z.B. <code>/meine.hits/</code>.</li>
- <li><a name="SONOSPLAYER_setter_LoadPlaylist">
- <b><code>LoadPlaylist <Playlistname|Fhem-Devicename> [EmptyQueueBeforeImport]</code></b></a>
- <br /> Lädt die angegebene Playlist in die aktuelle Abspielliste. Der Parameter sollte/kann URL-Encoded werden um auch Spezialzeichen zu ermöglichen. Der Playlistname kann ein Fhem-Sonosplayer-Devicename sein, dann wird dessen aktuelle Abpielliste kopiert. Der Playlistname kann aber auch ein Dateiname sein. Dann muss dieser mit 'file:' beginnen (z.B. 'file:c:/Test.m3u).<br />Wenn der Parameter EmptyQueueBeforeImport mit ''1'' angegeben wirde, wird die aktuelle Abspielliste vor dem Import geleert. Standardmäßig wird hier ''1'' angenommen.<br />Zusätzlich kann ein regulärer Ausdruck für den Namen verwendet werden. Der erste Treffer wird verwendet. Das Format ist z.B. <code>/hits.2014/</code>.</li>
- <li><a name="SONOSPLAYER_setter_LoadRadio">
- <b><code>LoadRadio <Radiostationname></code></b></a>
- <br /> Startet den angegebenen Radiostream. Der Name bezeichnet einen Sender in der Radiofavoritenliste. Die aktuelle Abspielliste wird nicht verändert. Der Parameter sollte/kann URL-Encoded werden um auch Spezialzeichen zu ermöglichen.<br />Zusätzlich kann ein regulärer Ausdruck für den Namen verwendet werden. Der erste Treffer wird verwendet. Das Format ist z.B. <code>/radio/</code>.</li>
- <li><a name="SONOSPLAYER_setter_LoadSearchlist">
- <b><code>LoadSearchlist <Kategoriename> <KategorieElement> [[TitelfilterRegEx]/[AlbumfilterRegEx]/[ArtistfilterRegEx] [[*]maxElem[+|-]]]</code></b></a>
- <br /> Lädt Titel nach diversen Kriterien in die aktuelle Abspielliste. Nähere Beschreibung bitte im Wiki nachlesen.</li>
- <li><a name="SONOSPLAYER_setter_SavePlaylist">
- <b><code>SavePlaylist <Playlistname></code></b></a>
- <br /> Speichert die aktuelle Abspielliste unter dem angegebenen Namen. Eine bestehende Playlist mit diesem Namen wird überschrieben. Der Parameter sollte/kann URL-Encoded werden um auch Spezialzeichen zu ermöglichen. Der Playlistname kann auch ein Dateiname sein. Dann muss dieser mit 'file:' beginnen (z.B. 'file:c:/Test.m3u).</li>
- </ul></li>
- <li><b>Gruppenbefehle</b><ul>
- <li><a name="SONOSPLAYER_setter_AddMember">
- <b><code>AddMember <devicename></code></b></a>
- <br />Fügt dem Device das übergebene Device als Gruppenmitglied hinzu. Die Wiedergabe des aktuellen Devices bleibt erhalten, und wird auf das angegebene Device mit übertragen.</li>
- <li><a name="SONOSPLAYER_setter_CreateStereoPair">
- <b><code>CreateStereoPair <rightPlayerDevicename></code></b></a>
- <br />Fügt dem Device das übergebene Device als rechtes Stereopaar-Element hinzu. Die Wiedergabe des aktuellen Devices bleibt erhalten (als linker Lautsprecher), und wird auf das angegebene Device mit übertragen (als rechter Lautsprecher).</li>
- <li><a name="SONOSPLAYER_setter_GroupMute">
- <b><code>GroupMute <State></code></b></a>
- <br />Setzt den Mute-Zustand für die komplette Gruppe in einem Schritt. Der Wert kann on oder off sein.</li>
- <li><a name="SONOSPLAYER_setter_GroupVolume">
- <b><code>GroupVolume <VolumeLevel></code></b></a>
- <br />Setzt die Gruppenlautstärke in der Art des Original-Controllers. Das bedeutet, dass das Lautstärkeverhältnis der Player zueinander beim Anpassen erhalten bleibt.</li>
- <li><a name="SONOSPLAYER_setter_GroupVolumeD">
- <b><code>GroupVolumeD</code></b></a>
- <br /> Verringert die aktuelle Gruppenlautstärke um volumeStep-Einheiten.</li>
- <li><a name="SONOSPLAYER_setter_GroupVolumeU">
- <b><code>GroupVolumeU</code></b></a>
- <br /> Erhöht die aktuelle Gruppenlautstärke um volumeStep-Einheiten.</li>
- <li><a name="SONOSPLAYER_setter_MakeStandaloneGroup">
- <b><code>MakeStandaloneGroup</code></b></a>
- <br />Macht diesen Player zu seiner eigenen Gruppe.</li>
- <li><a name="SONOSPLAYER_setter_RemoveMember">
- <b><code>RemoveMember <devicename></code></b></a>
- <br />Entfernt dem Device das übergebene Device, sodass die beiden keine Gruppe mehr bilden. Die Wiedergabe des aktuellen Devices läuft normal weiter. Das abgetrennte Device stoppt seine Wiedergabe, und hat keine aktuelle Abspielliste mehr (seit Sonos Version 4.2 hat der Player wieder die Playliste von vorher aktiv).</li>
- <li><a name="SONOSPLAYER_setter_SeparateStereoPair">
- <b><code>SeparateStereoPair</code></b></a>
- <br />Trennt das Stereopaar wieder auf.</li>
- <li><a name="SONOSPLAYER_setter_SnapshotGroupVolume">
- <b><code>SnapshotGroupVolume</code></b></a>
- <br /> Legt das Lautstärkeverhältnis der aktuellen Player der Gruppe für folgende '''GroupVolume'''-Aufrufe fest. Dieses festgelegte Verhältnis wird bis zum nächsten Aufruf von '''SnapshotGroupVolume''' beibehalten.</li>
- </ul></li>
- </ul>
- <a name="SONOSPLAYERget"></a>
- <h4>Get</h4>
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="SONOSPLAYER_getter_Alarm">
- <b><code>Alarm <ID></code></b></a>
- <br /> Ausnahmefall. Diese Get-Anweisung liefert direkt ein Hash zurück, in welchem die Informationen des Alarms mit der gegebenen ID enthalten sind. Es ist die Kurzform für <code>eval(ReadingsVal(<Devicename>, 'Alarmlist', ()))->{<ID>};</code>, damit sich nicht jeder ausdenken muss, wie er jetzt am einfachsten an die Alarm-Informationen rankommen kann.</li>
- <li><a name="SONOSPLAYER_getter_EthernetPortStatus">
- <b><code>EthernetPortStatus <PortNumber></code></b></a>
- <br /> Liefert den Ethernet-Portstatus des gegebenen Ports. Kann 'Active' oder 'Inactive' liefern.</li>
- <li><a name="SONOSPLAYER_getter_PossibleRoomIcons">
- <b><code>PossibleRoomIcons</code></b></a>
- <br /> Liefert eine Liste aller möglichen RoomIcon-Bezeichnungen zurück.</li>
- <li><a name="SONOSPLAYER_getter_SupportLinks">
- <b><code>SupportLinks</code></b></a>
- <br /> Ausnahmefall. Diese Get-Anweisung liefert eine Liste mit passenden Links zu den Supportseiten des Player.</li>
- <li><a name="SONOSPLAYER_getter_WifiPortStatus">
- <b><code>WifiPortStatus</code></b></a>
- <br /> Liefert den Wifi-Portstatus. Kann 'Active' oder 'Inactive' liefern.</li>
- </ul></li>
- <li><b>Listen</b><ul>
- <li><a name="SONOSPLAYER_getter_Favourites">
- <b><code>Favourites</code></b></a>
- <br /> Liefert eine Liste mit den Namen aller gespeicherten Sonos-Favoriten. Das Format der Liste ist eine Komma-Separierte Liste, bei der die Namen in doppelten Anführungsstrichen stehen. z.B. "Liste 1","Eintrag 2","Test"</li>
- <li><a name="SONOSPLAYER_getter_FavouritesWithCovers">
- <b><code>FavouritesWithCovers</code></b></a>
- <br /> Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller gespeicherten Sonos-Favoriten. Z.B.: {'FV:2/22' => {'Cover' => 'urlzumcover', 'Title' => '1. Favorit'}}. Dieser String kann einfach mit '''eval''' in eine Perl-Datenstruktur umgewandelt werden.</li>
- <li><a name="SONOSPLAYER_getter_Playlists">
- <b><code>Playlists</code></b></a>
- <br /> Liefert eine Liste mit den Namen aller gespeicherten Playlists. Das Format der Liste ist eine Komma-Separierte Liste, bei der die Namen in doppelten Anführungsstrichen stehen. z.B. "Liste 1","Liste 2","Test"</li>
- <li><a name="SONOSPLAYER_getter_PlaylistsWithCovers">
- <b><code>PlaylistsWithCovers</code></b></a>
- <br /> Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller gespeicherten Sonos-Playlisten. Z.B.: {'SQ:14' => {'Cover' => 'urlzumcover', 'Title' => '1. Playlist'}}. Dieser String kann einfach mit '''eval''' in eine Perl-Datenstruktur umgewandelt werden.</li>
- <li><a name="SONOSPLAYER_getter_Queue">
- <b><code>Queue</code></b></a>
- <br /> Liefert eine Liste mit den Namen aller Titel in der aktuellen Abspielliste. Das Format der Liste ist eine Komma-Separierte Liste, bei der die Namen in doppelten Anführungsstrichen stehen. z.B. "1. Liste 1 [0:02:14]","2. Eintrag 2 [k.A.]","3. Test [0:14:00]"</li>
- <li><a name="SONOSPLAYER_getter_QueueWithCovers">
- <b><code>QueueWithCovers</code></b></a>
- <br /> Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller Titel der aktuellen Abspielliste. Z.B.: {'Q:0/22' => {'Cover' => 'urlzumcover', 'Title' => '1. Titel'}}. Dieser String kann einfach mit '''eval''' in eine Perl-Datenstruktur umgewandelt werden.</li>
- <li><a name="SONOSPLAYER_getter_Radios">
- <b><code>Radios</code></b></a>
- <br /> Liefert eine Liste mit den Namen aller gespeicherten Radiostationen (Favoriten). Das Format der Liste ist eine Komma-Separierte Liste, bei der die Namen in doppelten Anführungsstrichen stehen. z.B. "Sender 1","Sender 2","Test"</li>
- <li><a name="SONOSPLAYER_getter_RadiosWithCovers">
- <b><code>RadiosWithCovers</code></b></a>
- <br /> Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller gespeicherten Sonos-Radiofavoriten. Z.B.: {'R:0/0/2' => {'Cover' => 'urlzumcover', 'Title' => '1. Radiosender'}}. Dieser String kann einfach mit '''eval''' in eine Perl-Datenstruktur umgewandelt werden.</li>
- <li><a name="SONOSPLAYER_getter_SearchlistCategories">
- <b><code>SearchlistCategories</code></b></a>
- <br /> Liefert eine Liste mit den Namen alle möglichen Kategorien für den Aufruf von "LoadSearchlist". Das Format der Liste ist eine Komma-Separierte Liste, bei der die Namen in doppelten Anführungsstrichen stehen.</li>
- </ul></li>
- <li><b>Informationen zum aktuellen Titel</b><ul>
- <li><a name="SONOSPLAYER_getter_CurrentTrackPosition">
- <b><code>CurrentTrackPosition</code></b></a>
- <br /> Liefert die aktuelle Position innerhalb des Titels.</li>
- </ul></li>
- </ul>
- <a name="SONOSPLAYERattr"></a>
- <h4>Attribute</h4>
- '''Hinweis'''<br />Die Attribute werden erst bei einem Neustart von Fhem verwendet, da diese dem SubProzess initial zur Verfügung gestellt werden müssen.
- <ul>
- <li><b>Grundsätzliches</b><ul>
- <li><a name="SONOSPLAYER_attribut_disable"><b><code>disable <int></code></b>
- </a><br /> One of (0,1). Deaktiviert die Event-Verarbeitung für diesen Zoneplayer.</li>
- <li><a name="SONOSPLAYER_attribut_generateSomethingChangedEvent"><b><code>generateSomethingChangedEvent <int></code></b>
- </a><br /> One of (0,1). 1 wenn ein 'SomethingChanged'-Event erzeugt werden soll. Dieses Event wird immer dann erzeugt, wenn sich irgendein Wert ändert. Dies ist nützlich, wenn man immer informiert werden möchte, egal, was sich geändert hat.</li>
- <li><a name="SONOSPLAYER_attribut_generateVolumeEvent"><b><code>generateVolumeEvent <int></code></b>
- </a><br /> One of (0,1). Aktiviert die Generierung eines Events bei Lautstärkeänderungen, wenn minVolume oder maxVolume definiert sind.</li>
- <li><a name="SONOSPLAYER_attribut_generateVolumeSlider"><b><code>generateVolumeSlider <int></code></b>
- </a><br /> One of (0,1). Aktiviert einen Slider für die Lautstärkekontrolle in der Detailansicht.</li>
- <li><a name="SONOSPLAYER_attribut_getAlarms"><b><code>getAlarms <int></code></b>
- </a><br /> One of (0..1). Richtet eine Callback-Methode für Alarme ein. Damit wird auch die DailyIndexRefreshTime automatisch aktualisiert.</li>
- <li><a name="SONOSPLAYER_attribut_suppressControlButtons"><b><code>suppressControlButtons <int></code></b>
- </a><br /> One of (0,1). Gibt an, ob die Steuerbuttons unter der Cover-/Titelanzeige angezeigt werden sollen (=1) oder nicht (=0).</li>
- </ul></li>
- <li><a name="SONOSPLAYER_attribut_volumeStep"><b><code>volumeStep <int></code></b>
- </a><br /> One of (0..100). Definiert die Schrittweite für die Aufrufe von <code>VolumeU</code> und <code>VolumeD</code>.</li>
- </ul></li>
- <li><b>Informationen generieren</b><ul>
- <li><a name="SONOSPLAYER_attribut_generateInfoSummarize1"><b><code>generateInfoSummarize1 <string></code></b>
- </a><br /> Erzeugt das Reading 'InfoSummarize1' mit dem angegebenen Format. Mehr Informationen dazu im Bereich Beispiele.</li>
- <li><a name="SONOSPLAYER_attribut_generateInfoSummarize2"><b><code>generateInfoSummarize2 <string></code></b>
- </a><br /> Erzeugt das Reading 'InfoSummarize2' mit dem angegebenen Format. Mehr Informationen dazu im Bereich Beispiele.</li>
- <li><a name="SONOSPLAYER_attribut_generateInfoSummarize3"><b><code>generateInfoSummarize3 <string></code></b>
- </a><br /> Erzeugt das Reading 'InfoSummarize3' mit dem angegebenen Format. Mehr Informationen dazu im Bereich Beispiele.</li>
- <li><a name="SONOSPLAYER_attribut_generateInfoSummarize4"><b><code>generateInfoSummarize4 <string></code></b>
- </a><br /> Erzeugt das Reading 'InfoSummarize4' mit dem angegebenen Format. Mehr Informationen dazu im Bereich Beispiele.</li>
- <li><a name="SONOSPLAYER_attribut_getTitleInfoFromMaster"><b><code>getTitleInfoFromMaster <int></code></b>
- </a><br /> Eins aus (0,1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60). Bringt das Device dazu, seine aktuellen Abspielinformationen vom aktuellen Gruppenmaster zu holen, wenn es einen solchen gibt.</li>
- <li><a name="SONOSPLAYER_attribut_simulateCurrentTrackPosition"><b><code>simulateCurrentTrackPosition <int></code></b>
- </a><br /> Eins aus (0, 1). Bringt das Device dazu, seine aktuelle Abspielposition simuliert weiterlaufen zu lassen. Dazu werden die Readings <code>currentTrackPositionSimulated</code> und <code>currentTrackPositionSimulatedSec</code> gesetzt. Gleichzeitig wird auch das Reading <code>currentTrackPositionSimulatedPercent</code> (zwischen 0.0 und 100.0) gesetzt.</li>
- <li><a name="SONOSPLAYER_attribut_simulateCurrentTrackPositionPercentFormat"><b><code>simulateCurrentTrackPositionPercentFormat <Format></code></b>
- </a><br /> Definiert das Format für die sprintf-Prozentausgabe im Reading <code>currentTrackPositionSimulatedPercent</code>.</li>
- <li><a name="SONOSPLAYER_attribut_stateVariable"><b><code>stateVariable <string></code></b>
- </a><br /> One of (TransportState,NumberOfTracks,Track,TrackURI,TrackDuration,Title,Artist,Album,OriginalTrackNumber,AlbumArtist,<br />Sender,SenderCurrent,SenderInfo,StreamAudio,NormalAudio,AlbumArtURI,nextTrackDuration,nextTrackURI,nextAlbumArtURI,<br />nextTitle,nextArtist,nextAlbum,nextAlbumArtist,nextOriginalTrackNumber,Volume,Mute,Shuffle,Repeat,RepeatOne,CrossfadeMode,Balance,<br />HeadphoneConnected,SleepTimer,Presence,RoomName,SaveRoomName,PlayerType,Location,SoftwareRevision,SerialNum,InfoSummarize1,I<br />nfoSummarize2,InfoSummarize3,InfoSummarize4). Gibt an, welche Variable in das Reading <code>state</code> kopiert werden soll.</li>
- </ul></li>
- <li><b>Steueroptionen</b><ul>
- <li><a name="SONOSPLAYER_attribut_maxVolume"><b><code>maxVolume <int></code></b>
- </a><br /> One of (0..100). Definiert die maximale Lautstärke dieses Zoneplayer.</li>
- <li><a name="SONOSPLAYER_attribut_minVolume"><b><code>minVolume <int></code></b>
- </a><br /> One of (0..100). Definiert die minimale Lautstärke dieses Zoneplayer.</li>
- <li><a name="SONOSPLAYER_attribut_maxVolumeHeadphone"><b><code>maxVolumeHeadphone <int></code></b>
- </a><br /> One of (0..100). Definiert die maximale Lautstärke dieses Zoneplayer im Kopfhörerbetrieb.</li>
- <li><a name="SONOSPLAYER_attribut_minVolumeHeadphone"><b><code>minVolumeHeadphone <int></code></b>
- </a><br /> One of (0..100). Definiert die minimale Lautstärke dieses Zoneplayer im Kopfhörerbetrieb.</li>
- <li><a name="SONOSPLAYER_attribut_buttonEvents"><b><code>buttonEvents <Time:Pattern>[ <Time:Pattern> ...]</code></b>
- </a><br /> Definiert, dass bei einer bestimten Tastenfolge am Player ein Event erzeugt werden soll. Die Definition der Events erfolgt als Tupel: Der erste Teil vor dem Doppelpunkt ist die Zeit in Sekunden, die berücksichtigt werden soll, der zweite Teil hinter dem Doppelpunkt definiert die Abfolge der Buttons, die für dieses Event notwendig sind.<br />
- Folgende Button-Kürzel sind zulässig: <ul><li><b>M</b>: Der Mute-Button</li><li><b>H</b>: Die Headphone-Buchse</li><li><b>U</b>: Up-Button (Lautstärke Hoch)</li><li><b>D</b>: Down-Button (Lautstärke Runter)</li></ul><br />
- Das Event, das geworfen wird, heißt <code>ButtonEvent</code>, der Wert ist die definierte Tastenfolge<br />
- Z.B.: <code>2:MM</code><br />
- Hier wird definiert, dass ein Event erzeugt werden soll, wenn innerhalb von 2 Sekunden zweimal die Mute-Taste gedrückt wurde. Das damit erzeugte Event hat dann den Namen <code>ButtonEvent</code>, und den Wert <code>MM</code>.</li>
- </ul></li>
- <li><a name="SONOSPLAYER_attribut_saveSleeptimerInAction"><b><code>saveSleeptimerInAction <int></code></b>
- </a><br /> One of (0..1). Wenn gesetzt, wird ein etwaig gesetztes Attribut "stopSleeptimerInAction" ignoriert.</li>
- <li><a name="SONOSPLAYER_attribut_stopSleeptimerInAction"><b><code>stopSleeptimerInAction <int></code></b>
- </a><br /> One of (0..1). Wenn gesetzt, wird bei einem Wechsel des transportState auf "PAUSED_PLAYBACK" oder "STOPPED" ein etwaig definierter SleepTimer deaktiviert.</li>
- </ul>
- <a name="SONOSPLAYERexamples"></a>
- <h4>Beispiele / Hinweise</h4>
- <ul>
- <li><a name="SONOSPLAYER_examples_InfoSummarize">Format von InfoSummarize:</a><br />
- <code>infoSummarizeX := <NormalAudio>:summarizeElem:</NormalAudio> <StreamAudio>:summarizeElem:</StreamAudio>|:summarizeElem:</code><br />
- <code>:summarizeElem: := <:variable:[ prefix=":text:"][ suffix=":text:"][ instead=":text:"][ ifempty=":text:"]/[ emptyVal=":text:"]></code><br />
- <code>:variable: := TransportState|NumberOfTracks|Track|TrackURI|TrackDuration|Title|Artist|Album|OriginalTrackNumber|AlbumArtist|<br />Sender|SenderCurrent|SenderInfo|StreamAudio|NormalAudio|AlbumArtURI|nextTrackDuration|nextTrackURI|nextAlbumArtURI|<br />nextTitle|nextArtist|nextAlbum|nextAlbumArtist|nextOriginalTrackNumber|Volume|Mute|Shuffle|Repeat|RepeatOne|CrossfadeMode|Balance|<br />HeadphoneConnected|SleepTimer|Presence|RoomName|SaveRoomName|PlayerType|Location|SoftwareRevision|SerialNum|InfoSummarize1|<br />InfoSummarize2|InfoSummarize3|InfoSummarize4</code><br />
- <code>:text: := [Jeder beliebige Text ohne doppelte Anführungszeichen]</code><br /></li>
- </ul>
- <p><a name="SSCam"></a>
- <h3>SSCam</h3>
- <div class='langLinks'>[<a href='commandref.html#SSCam'>EN</a> DE]</div>
- <ul>
- Mit diesem Modul können Operationen von in der Synology Surveillance Station (SVS) definierten Kameras und Funktionen
- der SVS ausgeführt werden. Es basiert auf der SVS API und unterstützt die SVS ab Version 7. <br>
- Zur Zeit werden folgende Funktionen unterstützt: <br><br>
- <ul>
- <ul>
- <li>Start einer Aufnahme</li>
- <li>Stop einer Aufnahme (per Befehl bzw. automatisch nach Ablauf der Aufnahmedauer) </li>
- <li>Aufnehmen eines Schnappschusses und Ablage in der Synology Surveillance Station </li>
- <li>Deaktivieren einer Kamera in Synology Surveillance Station</li>
- <li>Aktivieren einer Kamera in Synology Surveillance Station</li>
- <li>Steuerung der Belichtungsmodi Tag, Nacht bzw. Automatisch </li>
- <li>Umschaltung der Ereigniserkennung durch Kamera, durch SVS oder deaktiviert </li>
- <li>steuern der Erkennungsparameterwerte Empfindlichkeit, Schwellwert, Objektgröße und Prozentsatz für Auslösung </li>
- <li>Abfrage von Kameraeigenschaften (auch mit Polling) sowie den Eigenschaften des installierten SVS-Paketes</li>
- <li>Bewegen an eine vordefinierte Preset-Position (bei PTZ-Kameras) </li>
- <li>Start einer vordefinierten Überwachungstour (bei PTZ-Kameras) </li>
- <li>Positionieren von PTZ-Kameras zu absoluten X/Y-Koordinaten </li>
- <li>kontinuierliche Bewegung von PTZ-Kameras </li>
- <li>auslösen externer Ereignisse 1-10 (Aktionsregel SVS) </li>
- <li>starten und beenden von Kamera-Livestreams, anzeigen der letzten Aufnahme oder des letzten Schnappschusses </li>
- <li>Abruf und Ausgabe der Kamera Streamkeys sowie Stream-Urls (Nutzung von Kamera-Livestreams ohne Session Id) </li>
- <li>abspielen der letzten Aufnahme bzw. Anzeige des letzten Schnappschusses </li>
- <li>anzeigen der gespeicherten Anmeldeinformationen (Credentials) </li>
- <li>Ein- bzw. Ausschalten des Surveillance Station HomeMode und abfragen des HomeMode-Status </li>
- <li>abrufen des Surveillance Station Logs, auswerten des neuesten Eintrags als Reading </li>
- <li>erzeugen einer Gallerie der letzten 1-10 Schnappschüsse (als Popup oder permanentes Device) </li><br>
- </ul>
- </ul>
- Die Aufnahmen stehen in der Synology Surveillance Station (SVS) zur Verfügung und unterliegen, wie jede andere Aufnahme, den in der Synology Surveillance Station eingestellten Regeln. <br>
- So werden zum Beispiel die Aufnahmen entsprechend ihrer Archivierungsfrist gespeichert und dann gelöscht. <br><br>
-
- Wenn sie über dieses Modul diskutieren oder zur Verbesserung des Moduls beitragen möchten, ist im FHEM-Forum ein Sammelplatz unter:<br>
- <a href="http://forum.fhem.de/index.php/topic,45671.msg374390.html#msg374390">49_SSCam: Fragen, Hinweise, Neuigkeiten und mehr rund um dieses Modul</a>.<br><br>
- Weitere Infomationen zum Modul sind im FHEM-Wiki zu finden:<br>
- <a href="http://www.fhemwiki.de/wiki/SSCAM_-_Steuerung_von_Kameras_in_Synology_Surveillance_Station">SSCAM - Steuerung von Kameras in Synology Surveillance Station</a>.<br><br>
-
-
- <b>Vorbereitung </b> <br><br>
- Dieses Modul nutzt das Perl-Modul JSON. <br>
- Auf Debian-Linux basierenden Systemen kann es installiert werden mit: <br><br>
-
- <code>sudo apt-get install libjson-perl</code> <br><br>
-
- Das Modul verwendet für HTTP-Calls die nichtblockierenden Funktionen von HttpUtils bzw. HttpUtils_NonblockingGet. <br>
- Im DSM bzw. der Synology Surveillance Station muß ein Nutzer angelegt sein. Die Zugangsdaten werden später über ein Set-Kommando dem angelegten Gerät zugewiesen. <br>
- Nähere Informationen dazu unter <a href="#SSCam_Credentials">Credentials</a><br><br>
-
- Überblick über die Perl-Module welche von SSCam genutzt werden: <br><br>
-
- JSON <br>
- Data::Dumper <br>
- MIME::Base64 <br>
- Time::HiRes <br>
- HttpUtils (FHEM-Modul) <br><br>
- <a name="SSCamdefine"></a>
- <b>Definition</b>
- <ul>
- <br>
- Bei der Definition wird zwischen einer Kamera-Definition und der Definition einer Surveillance Station (SVS)
- unterschieden. Abhängig von der Art des definierten Devices wird das Internal MODEL auf CAM oder SVS gesetzt und eine
- passende Teilmenge der beschriebenen set/get-Befehle dem Device zugewiesen. <br>
- Der Gültigkeitsbereich von set/get-Befehlen ist nach dem jeweiligen Befehl angegeben (gilt für CAM, SVS, CAM/SVS).
- <br><br>
-
- Eine Kamera wird definiert durch: <br><br>
-
- <code>define <name> SSCAM <Kameraname in SVS> <ServerAddr> [Port] </code> <br><br>
-
- Zunächst muß diese Kamera in der Synology Surveillance Station 7.0 oder höher eingebunden sein und entsprechend
- funktionieren. <br><br>
-
- Ein SVS-Device zur Steuerung von Funktionen der Surveillance Station wird definiert mit: <br><br>
-
- <code>define <name> SSCAM SVS <ServerAddr> [Port] </code> <br><br>
-
- In diesem Fall wird statt <Kameraname in SVS> nur <b>SVS</b> angegeben. <br><br>
-
- Das Modul SSCam basiert auf Funktionen der Synology Surveillance Station API. <br>
- Momentan wird nur das HTTP-Protokoll unterstützt um die Web-Services der Synology DS aufzurufen. <br><br>
-
- Die Parameter beschreiben im Einzelnen:
- <br>
- <br>
-
- <table>
- <colgroup> <col width=15%> <col width=85%> </colgroup>
- <tr><td>name: </td><td>der Name des neuen Gerätes in FHEM</td></tr>
- <tr><td>Kameraname: </td><td>Kameraname wie er in der Synology Surveillance Station angegeben ist für Kamera-Device, "SVS" für SVS-Device. Leerzeichen im Namen sind nicht erlaubt. </td></tr>
- <tr><td>ServerAddr: </td><td>die IP-Addresse des Synology Surveillance Station Host. Hinweis: Es sollte kein Servername verwendet werden weil DNS-Aufrufe in FHEM blockierend sind.</td></tr>
- <tr><td>Port: </td><td>optional - der Port der Synology Surveillance Station. Wenn nicht angegeben wird der Default-Port 5000 (nur HTTP) gesetzt </td></tr>
- </table>
- <br><br>
- <b>Beispiel:</b>
- <pre>
- <code>define CamCP SSCAM Carport 192.168.2.20 [5000] </code>
- erstellt ein neues Kamera-Device CamCP
- <code>define DS1 SSCAM SVS 192.168.2.20 [5000] </code>
- erstellt ein neues SVS-Device DS1
- </pre>
-
- Wird eine neue Kamera definiert, wird diesem Device zunächst eine Standardaufnahmedauer von 15 zugewiesen. <br>
- Über das <a href="#SSCamattr">Attribut</a> "rectime" kann die Aufnahmedauer für jede Kamera individuell angepasst werden. Der Wert "0" für "rectime" führt zu einer Endlosaufnahme, die durch "set <name> off" wieder gestoppt werden muß. <br>
- Ein Logeintrag mit einem entsprechenden Hinweis auf diesen Umstand wird geschrieben. <br><br>
- Wird das <a href="#SSCamattr">Attribut</a> "rectime" gelöscht, greift wieder der Default-Wert (15s) für die Aufnahmedauer. <br><br>
- Mit dem <a href="#SSCamset">Befehl</a> <b>"set <name> on [rectime]"</b> wird die Aufnahmedauer temporär festgelegt und überschreibt einmalig sowohl den Defaultwert als auch den Wert des gesetzten Attributs "rectime". <br>
- Auch in diesem Fall führt <b>"set <name> on 0"</b> zu einer Daueraufnahme. <br><br>
- Eine eventuell in der SVS eingestellte Dauer der Voraufzeichnung wird weiterhin berücksichtigt. <br><br><br>
-
-
- <a name="SSCam_Credentials"></a>
- <b>Credentials </b><br><br>
-
- Nach dem Definieren des Gerätes müssen zuerst die Zugangsparameter gespeichert werden. Das geschieht mit dem Befehl:
-
- <pre>
- set <name> credentials <Username> <Passwort>
- </pre>
-
- Die Passwortlänge beträgt maximal 20 Zeichen. <br>
- Der Anwender kann in Abhängigkeit der beabsichtigten einzusetzenden Funktionen einen Nutzer im DSM bzw. in der Surveillance Station einrichten. <br>
- Ist der DSM-Nutzer der Gruppe Administratoren zugeordnet, hat er auf alle Funktionen Zugriff. Ohne diese Gruppenzugehörigkeit können nur Funktionen mit niedrigeren <br>
- Rechtebedarf ausgeführt werden. Die benötigten Mindestrechte der Funktionen sind in der Tabelle weiter unten aufgeführt. <br>
-
- Alternativ zum DSM-Nutzer kann ein in der SVS angelegter Nutzer verwendet werden. Auch in diesem Fall hat ein Nutzer vom Typ Manager das Recht alle Funktionen <br>
- auszuführen, wobei der Zugriff auf bestimmte Kameras/ im Privilegienprofil beschränkt werden kann (siehe Hilfefunktion in SVS). <br>
- Als Best Practice wird vorgeschlagen jeweils einen User im DSM und einen in der SVS anzulegen: <br><br>
-
- <ul>
- <li>DSM-User als Mitglied der Admin-Gruppe: uneingeschränkter Test aller Modulfunktionen -> session:DSM </li>
- <li>SVS-User als Manager oder Betrachter: angepasstes Privilegienprofil -> session: SurveillanceStation </li>
- </ul>
- <br>
-
- Über das <a href="#SSCamattr">Attribut</a> "session" kann ausgewählt werden, ob die Session mit dem DSM oder der SVS augebaut werden soll. <br>
- Erfolgt der Session-Aufbau mit dem DSM, stehen neben der SVS Web-API auch darüber hinaus gehende API-Zugriffe zur Verfügung die unter Umständen zur Verarbeitung benötigt werden. <br><br>
-
- Nach der Gerätedefinition ist die Grundeinstellung "Login in das DSM", d.h. es können Credentials mit Admin-Berechtigungen genutzt werden um zunächst alle <br>
- Funktionen der Kameras testen zu können. Danach können die Credentials z.B. in Abhängigkeit der benötigten Funktionen auf eine SVS-Session mit entsprechend beschränkten Privilegienprofil umgestellt werden. <br><br>
-
- Die nachfolgende Aufstellung zeigt die Mindestanforderungen der jeweiligen Modulfunktionen an die Nutzerrechte. <br><br>
- <ul>
- <table>
- <colgroup> <col width=20%> <col width=80%> </colgroup>
- <tr><td><li>set ... credentials </td><td> - </li></td></tr>
- <tr><td><li>set ... disable </td><td> session: ServeillanceStation - Manager </li></td></tr>
- <tr><td><li>set ... enable </td><td> session: ServeillanceStation - Manager </li></td></tr>
- <tr><td><li>set ... expmode </td><td> session: ServeillanceStation - Manager </li></td></tr>
- <tr><td><li>set ... extevent </td><td> session: DSM - Nutzer Mitglied von Admin-Gruppe </li></td></tr>
- <tr><td><li>set ... goPreset </td><td> session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera </li></td></tr>
- <tr><td><li>set ... homeMode </td><td> session: ServeillanceStation - Betrachter mit Privileg Home-Modus schalten </li></td></tr>
- <tr><td><li>set ... goAbsPTZ </td><td> session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera </li></td></tr>
- <tr><td><li>set ... move </td><td> session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera </li></td></tr>
- <tr><td><li>set ... motdetsc </td><td> session: ServeillanceStation - Manager </li></td></tr>
- <tr><td><li>set ... on </td><td> session: ServeillanceStation - Betrachter mit erweiterten Privileg "manuelle Aufnahme" </li></td></tr>
- <tr><td><li>set ... off </td><td> session: ServeillanceStation - Betrachter mit erweiterten Privileg "manuelle Aufnahme" </li></td></tr>
- <tr><td><li>set ... runView </td><td> session: ServeillanceStation - Betrachter mit Privileg Liveansicht für Kamera </li></td></tr>
- <tr><td><li>set ... runPatrol </td><td> session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera </li></td></tr>
- <tr><td><li>set ... snap </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>set ... snapGallery </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>set ... stopView </td><td> - </li></td></tr>
- <tr><td><li>get ... caminfo[all] </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... eventlist </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... listLog </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... scanVirgin </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... svsinfo </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... snapfileinfo </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... snapGallery </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... snapinfo </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- <tr><td><li>get ... stmUrlPath </td><td> session: ServeillanceStation - Betrachter </li></td></tr>
- </table>
- </ul>
- <br><br>
-
-
- <a name="SSCam_HTTPTimeout"></a>
- <b>HTTP-Timeout setzen</b><br><br>
-
- Alle Funktionen dieses Moduls verwenden HTTP-Aufrufe gegenüber der SVS Web API. <br>
- Der Standardwert für den HTTP-Timeout beträgt 4 Sekunden. Durch Setzen des <a href="#SSCamattr">Attributes</a> "httptimeout" > 0 kann dieser Wert bei Bedarf entsprechend den technischen Gegebenheiten angepasst werden. <br>
-
-
- </ul>
- <br><br><br>
-
- <a name="SSCamset"></a>
- <b>Set </b>
- <ul>
- <br>
- Die aufgeführten set-Befehle sind für CAM/SVS-Devices oder nur für CAM-Devices bzw. nur für SVS-Devices gültig. Sie stehen im
- Drop-Down-Menü des jeweiligen Devices zur Auswahl zur Verfügung. <br><br>
-
- <ul>
- <li><b> set <name> credentials <username> <password> </b> (gilt für CAM/SVS)</li> <br>
-
- Setzt Username / Passwort für den Zugriff auf die Synology Surveillance Station.
- Siehe <a href="#SSCam_Credentials">Credentials</a><br>
-
- <br><br>
- </ul>
-
- <ul>
- <li><b> set <name> createSnapGallery </b> (gilt für CAM)</li> <br>
-
- Es wird eine Schnappschußgallerie als permanentes (weblink)Device erzeugt. Das Device wird im Raum "SnapGallery" erstellt.
- Mit den "snapGallery..."-<a href="#SSCamattr">Attributen</a> bzw. den spezifischen Attributen des entstandenen Weblink-Devices
- können die Eigenschaften der Schnappschußgallerie beeinflusst werden. <br>
- <br><br>
- </ul>
-
- <ul>
- <li><b> set <name> [enable|disable] </b> (gilt für CAM)</li> <br>
-
- Aktviviert / deaktiviert eine Kamera. <br>
- Um eine Liste von Kameras oder alle Kameras (mit Regex) zum Beispiel um 21:46 zu <b>deaktivieren</b> / zu <b>aktivieren</b> zwei Beispiele mit at:
- <pre>
- define a13 at 21:46 set CamCP1,CamFL,CamHE1,CamTER disable (enable)
- define a14 at 21:46 set Cam.* disable (enable)
- </pre>
-
- Etwas komfortabler gelingt das Schalten aller Kameras über einen Dummy. Zunächst wird der Dummy angelegt:
- <pre>
- define allcams dummy
- attr allcams eventMap on:enable off:disable
- attr allcams room Cams
- attr allcams webCmd enable:disable
- </pre>
-
- Durch Verknüpfung mit zwei angelegten notify, jeweils ein notify für "enable" und "disable", kann man durch Schalten des Dummys auf "enable" bzw. "disable" alle Kameras auf einmal aktivieren bzw. deaktivieren.
- <pre>
- define all_cams_disable notify allcams:.*off set CamCP1,CamFL,CamHE1,CamTER disable
- attr all_cams_disable room Cams
- define all_cams_enable notify allcams:on set CamCP1,CamFL,CamHE1,CamTER enable
- attr all_cams_enable room Cams
- </pre>
- </ul>
- <br>
-
- <ul>
- <li><b> set <name> expmode [day|night|auto] </b> (gilt für CAM)</li> <br>
-
- Mit diesem Befehl kann der Belichtungsmodus der Kameras gesetzt werden. Dadurch wird z.B. das Verhalten der Kamera-LED's entsprechend gesteuert.
- Die erfolgreiche Umschaltung wird durch das Reading CamExposureMode ("get ... caminfoall") reportet. <br><br>
-
- <b> Hinweis: </b> <br>
- Die erfolgreiche Ausführung dieser Funktion ist davon abhängig ob die SVS diese Funktionalität der Kamera unterstützt.
- Ist in SVS -> IP-Kamera -> Optimierung -> Belichtungsmodus das Feld für den Tag/Nachtmodus grau hinterlegt, ist nicht von einer lauffähigen Unterstützung dieser
- Funktion auszugehen.
- <br><br>
- </ul>
- <ul>
- <li><b> set <name> extevent [ 1-10 ] </b> (gilt für SVS)</li> <br>
-
- Dieses Kommando triggert ein externes Ereignis (1-10) in der SVS.
- Die Aktionen, die dieses Ereignis auslöst, sind zuvor in dem Aktionsregeleditor der SVS einzustellen. Es stehen die Ereignisse
- 1-10 zur Verfügung.
- In der Benachrichtigungs-App der SVS können auch Email, SMS oder Mobil (DS-Cam) Nachrichten ausgegeben werden wenn ein externes
- Ereignis ausgelöst wurde.
- Nähere Informationen dazu sind in der Hilfe zum Aktionsregeleditor zu finden.
- Der verwendete User benötigt Admin-Rechte in einer DSM-Session.
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> goAbsPTZ [ X Y | up | down | left | right ] </b> (gilt für CAM)</li> <br>
-
- Mit diesem Kommando wird eine PTZ-Kamera in Richtung einer wählbaren absoluten X/Y-Koordinate bewegt, oder zur maximalen Absolutposition in Richtung up/down/left/right.
- Die Option ist nur für Kameras verfügbar die das Reading "CapPTZAbs=true" (die Fähigkeit für PTZAbs-Aktionen) besitzen. Die Eigenschaften der Kamera kann mit "get <name> caminfoall" abgefragt werden.
- <br><br>
- Beispiel für Ansteuerung absoluter X/Y-Koordinaten: <br>
- <pre>
- set <name> goAbsPTZ 120 450
- </pre>
-
- Dieses Beispiel bewegt die Kameralinse in die Position X=120 und Y=450. <br>
- Der Wertebereich ist dabei:
- <pre>
- X = 0 - 640 (0 - 319 bewegt nach links, 321 - 640 bewegt nach rechts, 320 bewegt die Linse nicht)
- Y = 0 - 480 (0 - 239 bewegt nach unten, 241 - 480 bewegt nach oben, 240 bewegt die Linse nicht)
- </pre>
- Die Linse kann damit in kleinsten bis sehr großen Schritten in die gewünschte Richtung bewegt werden.
- Dieser Vorgang muß ggf. mehrfach wiederholt werden um die Kameralinse in die gewünschte Position zu bringen. <br><br>
- Soll die Bewegung mit der maximalen Schrittweite erfolgen, kann zur Vereinfachung der Befehl:
- <pre>
- set <name> goAbsPTZ [up|down|left|right]
- </pre>
- verwendet werden. Die Optik wird in diesem Fall mit der größt möglichen Schrittweite zur Absolutposition in der angegebenen Richtung bewegt.
- Auch in diesem Fall muß der Vorgang ggf. mehrfach wiederholt werden um die Kameralinse in die gewünschte Position zu bringen.
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> goPreset <Preset> </b> (gilt für CAM)</li> <br>
-
- Mit diesem Kommando können PTZ-Kameras in eine vordefininierte Position bewegt werden. <br>
- Die Preset-Positionen müssen dazu zunächst in der Synology Surveillance Station angelegt worden sein. Das geschieht in der PTZ-Steuerung im IP-Kamera Setup.
- Die Presets werden über das Kommando "get <name> caminfoall" eingelesen (geschieht bei restart von FHEM automatisch). Der Einlesevorgang kann durch ein Kamerapolling
- regelmäßig wiederholt werden. Ein langes Pollingintervall ist in diesem Fall empfehlenswert, da sich die Presetpositionen nur im Fall der Neuanlage bzw. Änderung verändern werden.
- <br><br>
-
- Hier ein Beispiel einer PTZ-Steuerung in Abhängigkeit eines IR-Melder Events:
-
- <pre>
- define CamFL.Preset.Wandschrank notify MelderTER:on.* set CamFL goPreset Wandschrank, ;; define CamFL.Preset.record at +00:00:10 set CamFL on 5 ;;;; define s3 at +*{3}00:00:05 set CamFL snap ;; define CamFL.Preset.back at +00:00:30 set CamFL goPreset Home
- </pre>
-
- Funktionsweise: <br>
- Der IR-Melder "MelderTER" registriert eine Bewegung. Daraufhin wird die Kamera CamFL in die Preset-Position "Wandschrank" gebracht. Eine Aufnahme mit Dauer von 5 Sekunden startet 10 Sekunden
- später. Da die Voraufnahmezeit der Kamera 10s beträgt (vgl. Reading "CamPreRecTime"), startet die effektive Aufnahme wenn der Kameraschwenk beginnt. <br>
- Mit dem Start der Aufnahme werden drei Schnappschüsse im Abstand von 5 Sekunden angefertigt. <br>
- Nach einer Zeit von 30 Sekunden fährt die Kamera wieder zurück in die "Home"-Position. <br><br>
-
- Ein Auszug aus dem Log verdeutlicht den Ablauf:
-
- <pre>
- 2016.02.04 15:02:14 2: CamFL - Camera Flur_Vorderhaus has moved to position "Wandschrank"
- 2016.02.04 15:02:24 2: CamFL - Camera Flur_Vorderhaus Recording with Recordtime 5s started
- 2016.02.04 15:02:29 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully
- 2016.02.04 15:02:30 2: CamFL - Camera Flur_Vorderhaus Recording stopped
- 2016.02.04 15:02:34 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully
- 2016.02.04 15:02:39 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully
- 2016.02.04 15:02:44 2: CamFL - Camera Flur_Vorderhaus has moved to position "Home"
- </pre>
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> homeMode [on|off] </b> (gilt für SVS)</li> <br>
-
- Schaltet den HomeMode der Surveillance Station ein bzw. aus.
- Informationen zum HomeMode sind in der <a href="https://www.synology.com/de-de/knowledgebase/Surveillance/help/SurveillanceStation/home_mode">Synology Onlinehilfe</a>
- enthalten.
- <br><br>
- </ul>
-
- <ul>
- <li><b> set <name> motdetsc [camera|SVS|disable] </b> (gilt für CAM)</li> <br>
-
- Der Befehl "motdetsc" (steht für motion detection source) schaltet die Bewegungserkennung in den gewünschten Modus.
- Wird die Bewegungserkennung durch die Kamera / SVS ohne weitere Optionen eingestellt, werden die momentan gültigen Bewegungserkennungsparameter der
- Kamera / SVS beibehalten. Die erfolgreiche Ausführung der Operation lässt sich u.a. anhand des Status von SVS -> IP-Kamera -> Ereigniserkennung ->
- Bewegung nachvollziehen. <br><br>
- Für die Bewegungserkennung durch SVS bzw. durch Kamera können weitere Optionen angegeben werden. Die verfügbaren Optionen bezüglich der Bewegungserkennung
- durch SVS sind "Empfindlichkeit" und "Schwellwert". <br><br>
- <ul>
- <table>
- <colgroup> <col width=50%> <col width=50%> </colgroup>
- <tr><td>set <name> motdetsc SVS [Empfindlichkeit] [Schwellwert] </td><td># Befehlsmuster </td></tr>
- <tr><td>set <name> motdetsc SVS 91 30 </td><td># setzt die Empfindlichkeit auf 91 und den Schwellwert auf 30 </td></tr>
- <tr><td>set <name> motdetsc SVS 0 40 </td><td># behält gesetzten Wert für Empfindlichkeit bei, setzt Schwellwert auf 40 </td></tr>
- <tr><td>set <name> motdetsc SVS 15 </td><td># setzt die Empfindlichkeit auf 15, Schwellwert bleibt unverändert </td></tr>
- </table>
- </ul>
- <br><br>
-
- Wird die Bewegungserkennung durch die Kamera genutzt, stehen die Optionen "Empfindlichkeit", "Objektgröße" und "Prozentsatz für Auslösung" zur Verfügung. <br><br>
- <ul>
- <table>
- <colgroup> <col width=50%> <col width=50%> </colgroup>
- <tr><td>set <name> motdetsc camera [Empfindlichkeit] [Schwellwert] [Prozentsatz] </td><td># Befehlsmuster </td></tr>
- <tr><td>set <name> motdetsc camera 89 0 20 </td><td># setzt die Empfindlichkeit auf 89, Prozentsatz auf 20 </td></tr>
- <tr><td>set <name> motdetsc camera 0 40 10 </td><td># behält gesetzten Wert für Empfindlichkeit bei, setzt Schwellwert auf 40, Prozentsatz auf 10 </td></tr>
- <tr><td>set <name> motdetsc camera 30 </td><td># setzt die Empfindlichkeit auf 30, andere Werte bleiben unverändert </td></tr>
- </table>
- </ul>
- <br><br>
- Es ist immer die Reihenfolge der Optionswerte zu beachten. Nicht gewünschte Optionen sind mit "0" zu besetzen sofern danach Optionen folgen
- deren Werte verändert werden sollen (siehe Beispiele oben). Der Zahlenwert der Optionen beträgt 1 - 99 (außer Sonderfall "0"). <br><br>
-
- Die jeweils verfügbaren Optionen unterliegen der Funktion der Kamera und der Unterstützung durch die SVS. Es können jeweils nur die Optionen genutzt werden die in
- SVS -> Kamera bearbeiten -> Ereigniserkennung zur Verfügung stehen. Weitere Infos sind der Online-Hilfe zur SVS zu entnehmen. <br><br>
-
- Über den Befehl "get <name> caminfoall" wird auch das <a href="#SSCamreadings">Reading</a> "CamMotDetSc" aktualisiert welches die gegenwärtige Einstellung der Bewegungserkennung dokumentiert.
- Es werden nur die Parameter und Parameterwerte angezeigt, welche die SVS aktiv unterstützt. Die Kamera selbst kann weiterführende Einstellmöglichkeiten besitzen. <br><br>
-
- Beipiel:
- <pre>
- CamMotDetSc SVS, sensitivity: 76, threshold: 55
- </pre>
- <br><br>
- </ul>
-
- <ul>
- <li><b> set <name> move [ right | up | down | left | dir_X ] [Sekunden] </b> (gilt für CAM bis SVS Version 7.1)</li>
- <b> set <name> move [ right | upright | up | upleft | left | downleft | down | downright ] [Sekunden] </b> (gilt für CAM ab SVS Version 7.2) <br><br>
-
- Mit diesem Kommando wird eine kontinuierliche Bewegung der PTZ-Kamera gestartet. Neben den vier Grundrichtungen up/down/left/right stehen auch
- Zwischenwinkelmaße "dir_X" zur Verfügung. Die Feinheit dieser Graduierung ist von der Kamera abhängig und kann dem Reading "CapPTZDirections" entnommen werden. <br><br>
- Das Bogenmaß von 360 Grad teilt sich durch den Wert von "CapPTZDirections" und beschreibt die Bewegungsrichtungen beginnend mit "0=rechts" entgegen dem
- Uhrzeigersinn. D.h. bei einer Kamera mit "CapPTZDirections = 8" bedeutet dir_0 = rechts, dir_2 = oben, dir_4 = links, dir_6 = unten bzw. dir_1, dir_3, dir_5 und dir_7
- die entsprechenden Zwischenrichtungen. Die möglichen Bewegungsrichtungen bei Kameras mit "CapPTZDirections = 32" sind dementsprechend kleinteiliger. <br><br>
- Im Gegensatz zum "set <name> goAbsPTZ"-Befehl startet der Befehl "set <name> move" eine kontinuierliche Bewegung bis ein Stop-Kommando empfangen wird.
- Das Stop-Kommando wird nach Ablauf der optional anzugebenden Zeit [Sekunden] ausgelöst. Wird diese Laufzeit nicht angegeben, wird implizit Sekunde = 1 gesetzt. <br><br>
-
- <b>Beispiele: </b><br>
-
- <pre>
- set <name> move up 0.5 : bewegt PTZ 0,5 Sek. (zzgl. Prozesszeit) nach oben
- set <name> move dir_1 1.5 : bewegt PTZ 1,5 Sek. (zzgl. Prozesszeit) nach rechts-oben
- set <name> move dir_20 0.7 : bewegt PTZ 1,5 Sek. (zzgl. Prozesszeit) nach links-unten ("CapPTZDirections = 32)"
- </pre>
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> [on|off] </b> (gilt für CAM)</li><br>
- Der Befehl "set <name> on" startet eine Aufnahme. Die Standardaufnahmedauer beträgt 15 Sekunden. Sie kann mit dem Attribut "rectime" individuell festgelegt werden.
- Die im Attribut (bzw. im Standard) hinterlegte Aufnahmedauer kann einmalig mit "set <name> on [rectime]" überschrieben werden.
- Die Aufnahme stoppt automatisch nach Ablauf der Zeit "rectime".<br>
- Ein Sonderfall ist der Start einer Daueraufnahme mit "set <name> on 0" bzw. dem Attributwert "rectime = 0". In diesem Fall wird eine Daueraufnahme gestartet die
- explizit wieder mit dem Befehl "set <name> off" gestoppt werden muß.<br>
- Das Aufnahmeverhalten kann weiterhin mit dem Attribut "recextend" wie folgt beeinflusst werden.<br><br>
- <b>Attribut "recextend = 0" bzw. nicht gesetzt (Standard):</b><br><br>
- <ul>
- <li> wird eine Aufnahme mit z.B. rectime=22 gestartet, wird kein weiterer Startbefehl für eine Aufnahme akzeptiert bis diese gestartete Aufnahme nach 22 Sekunden
- beendet ist. Ein Hinweis wird bei verbose=3 im Logfile protokolliert. </li>
- </ul>
- <br>
- <b>Attribut "recextend = 1" gesetzt:</b><br>
- <ul>
- <li> eine zuvor gestartete Aufnahme wird bei einem erneuten "set <name> on" -Befehl um die Aufnahmezeit "rectime" verlängert. Das bedeutet, dass der Timer für
- den automatischen Stop auf den Wert "rectime" neu gesetzt wird. Dieser Vorgang wiederholt sich mit jedem Start-Befehl. Dadurch verlängert sich eine laufende
- Aufnahme bis kein Start-Inpuls mehr registriert wird. </li>
- <li> eine zuvor gestartete Endlos-Aufnahme wird mit einem erneuten "set <name> on"-Befehl nach der Aufnahmezeit "rectime" gestoppt (Timerneustart). Ist dies
- nicht gewünscht, ist darauf zu achten dass bei der Verwendung einer Endlos-Aufnahme das Attribut "recextend" nicht verwendet wird. </li>
- </ul>
- <br>
-
- Beispiele für einfachen <b>Start/Stop einer Aufnahme</b>: <br><br>
- <table>
- <colgroup> <col width=20%> <col width=80%> </colgroup>
- <tr><td>set <name> on [rectime] </td><td>startet die Aufnahme der Kamera <name>, automatischer Stop der Aufnahme nach Ablauf der Zeit [rectime] (default 15s oder wie im <a href="#SSCamattr">Attribut</a> "rectime" angegeben)</td></tr>
- <tr><td>set <name> off </td><td>stoppt die Aufnahme der Kamera <name></td></tr>
- </table>
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> optimizeParams [mirror:<value>] [flip:<value>] [rotate:<value>] [ntp:<value>]</b> (gilt für CAM)</li> <br>
-
- Setzt eine oder mehrere Eigenschaften für die Kamera. Das Video kann gespiegelt (mirror), auf den Kopf gestellt (flip) oder
- gedreht (rotate) werden. Die jeweiligen Eigenschaften müssen von der Kamera unterstützt werden. Mit "ntp" wird der Zeitserver
- eingestellt den die Kamera zur Zeitsynchronisation verwendet. <br><br>
-
- <value> kann sein für: <br>
- <ul>
- <li> <b>mirror, flip, rotate: </b> true | false </li>
- <li> <b>ntp: </b> der Name oder die IP-Adresse des Zeitservers </li>
- </ul>
- <br><br>
-
- <b>Beispiele:</b> <br>
- <code> set <name> optimizeParams mirror:true flip:true ntp:time.windows.com </code><br>
- # Das Bild wird gespiegelt, auf den Kopf gestellt und der Zeitserver auf "time.windows.com" eingestellt.<br>
- <code> set <name> optimizeParams ntp:Surveillance%20Station </code><br>
- # Die Surveillance Station wird als Zeitserver eingestellt. (NTP-Dienst muss im DSM aktiviert sein) <br>
- <code> set <name> optimizeParams mirror:true flip:false rotate:true </code><br>
- # Das Bild wird gespiegelt und um 90 Grad gedreht. <br>
-
- <br><br>
- </ul>
-
- <ul>
- <li><b> set <name> runPatrol <Patrolname> </b> (gilt für CAM)</li> <br>
-
- Dieses Kommando startet die vordefinierterte Überwachungstour einer PTZ-Kamera. <br>
- Die Überwachungstouren müssen dazu zunächst in der Synology Surveillance Station angelegt worden sein.
- Das geschieht in der PTZ-Steuerung im IP-Kamera Setup -> PTZ-Steuerung -> Überwachung.
- Die Überwachungstouren (Patrols) werden über das Kommando "get <name> caminfoall" eingelesen, welches beim Restart von FHEM automatisch abgearbeitet wird.
- Der Einlesevorgang kann durch ein Kamerapolling regelmäßig wiederholt werden. Ein langes Pollingintervall ist in diesem Fall empfehlenswert, da sich die
- Überwachungstouren nur im Fall der Neuanlage bzw. Änderung verändern werden.
- Nähere Informationen zur Anlage von Überwachungstouren sind in der Hilfe zur Surveillance Station enthalten.
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> runView [live_fw | live_link | live_open [<room>] | lastrec_fw | lastrec_open [<room>] | lastsnap_fw] </b> (gilt für CAM)</li> <br>
-
- Mit "live_fw, live_link, live_open" wird ein Livestream (mjpeg-Stream) der Kamera, entweder als eingebettetes Image
- oder als generierter Link, gestartet. <br>
- Die Option "live_open" startet ein separates Browserfenster mit dem Lifestream. Wird dabei optional der Raum mit
- angegeben, wird das Browserfenster nur gestartet wenn dieser Raum aktuell im Browser geöffnet ist. <br><br>
-
- Der Zugriff auf die letzte Aufnahme einer Kamera kann über die Optionen "lastrec_fw" bzw. "lastrec_open" erfolgen.
- Bei Verwendung von "lastrec_fw" wird die letzte Aufnahme als eingebettetes iFrame-Objekt abgespielt. Es stehen entsprechende
- Steuerungselemente zur Wiedergabegeschwindigkeit usw. zur Verfügung. <br><br>
- Der Befehl <b>"set <name> runView lastsnap_fw"</b> zeigt den letzten Schnappschuss der Kamera eingebettet an. <br><br>
- Durch Angabe des optionalen Raumes bei "lastrec_open" erfolgt die gleiche Einschränkung wie bei "live_open". <br><br>
-
- Die Gestaltung der Fenster im FHEMWEB kann durch HTML-Tags im <a href="#SSCamattr">Attribut</a> "htmlattr" beeinflusst werden. <br><br>
-
- <b>Beispiel:</b><br>
- <pre>
- attr <name> htmlattr width="500" height="375"
- attr <name> htmlattr width="500" height="375" top="200" left="300"
- </pre>
-
- Wird der Stream als live_fw gestartet, ändert sich die Größe entsprechend der Angaben von Width und Hight. <br>
- Das Kommando <b>"set <name> runView live_open"</b> startet den Livestreamlink sofort in einem neuen
- Browserfenster (longpoll=1 muß für WEB gesetzt sein).
- Dabei wird für jede aktive FHEM-Session eine Fensteröffnung initiiert. Soll dieses Verhalten geändert werden, kann
- <b>"set <name> runView live_open <room>"</b> verwendet werden um das Öffnen des Browserwindows in einem
- beliebigen, in einer FHEM-Session angezeigten Raum <room>, zu initiieren.<br>
- Das gesetzte <a href="#SSCamattr">Attribut</a> "livestreamprefix" überschreibt im <a href="#SSCamreadings">Reading</a> "LiveStreamUrl"
- die Angaben für Protokoll, Servername und Port. Damit kann z.B. die LiveStreamUrl für den Versand und externen Zugriff
- auf die SVS modifiziert werden. <br><br>
-
- <b>Beispiel:</b><br>
- <pre>
- attr <name> livestreamprefix https://<Servername>:<Port>
- </pre>
-
- Der Livestream wird über das Kommando <b>"set <name> stopView"</b> wieder beendet.
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> snap </b> (gilt für CAM)</li> <br>
-
- Ein <b>Schnappschuß</b> kann ausgelöst werden mit:
- <pre>
- set <name> snap
- </pre>
-
- Nachfolgend einige Beispiele für die <b>Auslösung von Schnappschüssen</b>. <br><br>
-
- Soll eine Reihe von Schnappschüssen ausgelöst werden wenn eine Aufnahme startet, kann das z.B. durch folgendes notify geschehen. <br>
- Sobald der Start der Kamera CamHE1 ausgelöst wird (Attribut event-on-change-reading -> "Record" setzen), werden abhängig davon 3 Snapshots im Abstand von 2 Sekunden getriggert.
- <pre>
- define he1_snap_3 notify CamHE1:Record.*Start define h3 at +*{3}00:00:02 set CamHE1 snap
- </pre>
-
- Triggern von 2 Schnappschüssen der Kamera "CamHE1" im Abstand von 6 Sekunden nachdem der Bewegungsmelder "MelderHE1" einen Event gesendet hat, <br>
- kann z.B. mit folgendem notify geschehen:
- <pre>
- define he1_snap_2 notify MelderHE1:on.* define h2 at +*{2}00:00:06 set CamHE1 snap
- </pre>
- Es wird die ID und der Filename des letzten Snapshots als Wert der Variable "LastSnapId" bzw. "LastSnapFilename" in den Readings der Kamera ausgegeben. <br><br>
- </ul>
- <br><br>
-
- <ul>
- <li><b> set <name> snapGallery [1-10] </b> (gilt für CAM)</li> <br>
-
- Der Befehl ist nur vorhanden wenn das Attribut "snapGalleryBoost=1" gesetzt wurde.
- Er erzeugt eine Ausgabe der letzten [x] Schnappschüsse ebenso wie <a href="#SSCamget">"get <name> snapGallery"</a>. Abweichend von "get" wird mit Attribut
- <a href="#SSCamattr">Attribut</a> "snapGalleryBoost=1" kein Popup erzeugt, sondern die Schnappschußgalerie als Browserseite
- dargestellt. Alle weiteren Funktionen und Attribute entsprechen dem "get <name> snapGallery" Kommando. <br>
- Wenn die Ausgabe einer Schnappschußgalerie, z.B. über ein "at oder "notify", getriggert wird, sollte besser das
- <a href="#SSCamget">"get <name> snapGallery"</a> Kommando anstatt "set" verwendet werden.
- </ul>
- <br><br>
- </ul>
- <br>
- <a name="SSCamget"></a>
- <b>Get</b>
- <ul>
- <br>
- Mit SSCam können die Eigenschaften der Surveillance Station und der Kameras abgefragt werden. <br>
- Die aufgeführten get-Befehle sind für CAM/SVS-Devices oder nur für CAM-Devices bzw. nur für SVS-Devices gültig. Sie stehen im
- Drop-Down-Menü des jeweiligen Devices zur Auswahl zur Verfügung. <br><br>
-
- <ul>
- <li><b> get <name> caminfoall </b> (gilt für CAM/SVS)</li>
- <b> get <name> caminfo </b> (gilt für CAM) <br><br>
-
- Es werden SVS-Parameter und abhängig von der Art der Kamera (z.B. Fix- oder PTZ-Kamera) die verfügbaren Kamera-Eigenschaften
- ermittelt und als Readings zur Verfügung gestellt. <br>
- So wird zum Beispiel das Reading "Availability" auf "disconnected" gesetzt falls die Kamera von der Surveillance Station
- getrennt ist. <br>
- "getcaminfo" ruft eine Teilmenge von "getcaminfoall" ab.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> eventlist </b> (gilt für CAM)</li> <br>
-
- Es wird das <a href="#SSCamreadings">Reading</a> "CamEventNum" und "CamLastRec"
- aktualisiert, welches die Gesamtanzahl der registrierten Kameraevents und den Pfad / Namen der letzten Aufnahme enthält.
- Dieser Befehl wird implizit mit "get <name> caminfoall" ausgeführt. <br>
- Mit dem <a href="#SSCamattr">Attribut</a> "videofolderMap" kann der Inhalt des Readings "VideoFolder" überschrieben werden.
- Dies kann von Vortel sein wenn das Surveillance-Verzeichnis der SVS an dem lokalen PC unter anderem Pfadnamen gemountet ist
- und darüber der Zugriff auf die Aufnahmen erfolgen soll (z.B. Verwendung bei Email-Versand). <br><br>
-
- Ein DOIF-Beispiel für den Email-Versand von Snapshot und Aufnahmelink per non-blocking sendmail:
- <pre>
- define CamHE1.snap.email DOIF ([CamHE1:"LastSnapFilename"])
- ({DebianMailnbl ('Recipient@Domain','Bewegungsalarm CamHE1','Eine Bewegung wurde an der Haustür registriert. Aufnahmelink: \
- \[CamHE1:VideoFolder]\[CamHE1:CamLastRec]','/media/sf_surveillance/@Snapshot/[CamHE1:LastSnapFilename]')})
- </pre>
- </ul>
-
- <ul>
- <li><b> get <name> homeModeState </b> (gilt für SVS)</li> <br>
-
- HomeMode-Status der Surveillance Station wird abgerufen.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> listLog [severity:<Loglevel>] [limit:<Zeilenzahl>] [match:<Suchstring>] </b> (gilt für SVS)</li> <br>
-
- Ruft das Surveillance Station Log vom Synology Server ab. Ohne Angabe der optionalen Zusätze wird das gesamte Log abgerufen. <br>
- Es können alle oder eine Auswahl der folgenden Optionen angegeben werden: <br><br>
-
- <ul>
- <li> <Loglevel> - Information, Warning oder Error. Nur Sätze mit dem Schweregrad werden abgerufen (default: alle) </li>
- <li> <Zeilenzahl> - die angegebene Anzahl der Logzeilen (neueste) wird abgerufen (default: alle) </li>
- <li> <Suchstring> - nur Logeinträge mit dem angegeben String werden abgerufen (Achtung: kein Regex, der Suchstring wird im Call an die SVS mitgegeben) </li>
- </ul>
- <br>
-
- <b>Beispiele</b> <br>
- <ul>
- <code>get <name> listLog severity:Error limit:5 </code> <br>
- Zeigt die letzten 5 Logeinträge mit dem Schweregrad "Error" <br>
- <code>get <name> listLog severity:Information match:Carport </code> <br>
- Zeigt alle Logeinträge mit dem Schweregrad "Information" die den String "Carport" enthalten <br>
- <code>get <name> listLog severity:Warning </code> <br>
- Zeigt alle Logeinträge mit dem Schweregrad "Warning" <br><br>
- </ul>
-
-
- Wurde mit dem <a href="#SSCamattr">Attribut</a> "pollcaminfoall" das Polling der SVS aktiviert, wird das <a href="#SSCamreadings">Reading</a>
- "LastLogEntry" erstellt. <br>
- Im Protokoll-Setup der SVS kann man einstellen was protokolliert werden soll. Für weitere Informationen
- siehe <a href="https://www.synology.com/de-de/knowledgebase/Surveillance/help/SurveillanceStation/log_advanced">Synology Online-Hlfe</a>.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> scanVirgin </b> (gilt für CAM/SVS)</li> <br>
-
- Wie mit get caminfoall werden alle Informationen der SVS und Kamera abgerufen. Allerdings wird in jedem Fall eine
- neue Session ID generiert (neues Login), die Kamera-ID neu ermittelt und es werden alle notwendigen API-Parameter neu
- eingelesen.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> snapGallery [1-10] </b> (gilt für CAM)</li> <br>
-
- Es wird ein Popup mit den letzten [x] Schnapschüssen erzeugt. Ist das <a href="#SSCamattr">Attribut</a> "snapGalleryBoost" gesetzt,
- werden die letzten Schnappschüsse (default 3) über Polling abgefragt und im Speicher gehalten. Das Verfahren hilft die Ausgabe zu beschleunigen,
- kann aber möglicherweise nicht den letzten Schnappschuß anzeigen, falls dieser NICHT über das Modul ausgelöst wurde. <br>
- Diese Funktion kann ebenfalls, z.B. mit "at" oder "notify", getriggert werden. Dabei wird die Schnappschußgalerie auf allen
- verbundenen FHEMWEB-Instanzen als Popup angezeigt. <br><br>
-
- Zur weiteren Steuerung dieser Funktion stehen die <a href="#SSCamattr">Attribute</a>: <br><br>
-
- <ul>
- <li>snapGalleryBoost </li>
- <li>snapGalleryColumns </li>
- <li>snapGalleryHtmlAttr </li>
- <li>snapGalleryNumber </li>
- <li>snapGallerySize </li>
- </ul> <br>
- zur Verfügung.
- </ul> <br>
-
- <ul>
- <b>Hinweis:</b><br>
- Abhängig von der Anzahl und Auflösung (Qualität) der Schnappschuß-Images werden entsprechende ausreichende CPU und/oder
- RAM-Ressourcen benötigt.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> snapfileinfo </b> (gilt für CAM)</li> <br>
-
- Es wird der Filename des letzten Schnapschusses ermittelt. Der Befehl wird implizit mit <b>"get <name> snap"</b>
- ausgeführt.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> snapinfo </b> (gilt für CAM)</li> <br>
-
- Es werden Schnappschussinformationen gelesen. Hilfreich wenn Schnappschüsse nicht durch SSCam, sondern durch die Bewegungserkennung der Kamera
- oder Surveillance Station erzeugt werden.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> stmUrlPath </b> (gilt für CAM)</li> <br>
-
- Mit diesem Kommando wird der aktuelle Streamkey der Kamera abgerufen und das Reading mit dem Key-Wert gefüllt.
- Dieser Streamkey kann verwendet werden um eigene Aufrufe eines Livestreams aufzubauen (siehe Beispiel).
- Wenn das <a href="#SSCamattr">Attribut</a> "showStmInfoFull" gesetzt ist, werden zusaätzliche Stream-Informationen wie "StmKeyUnicst", "StmKeymjpegHttp" ausgegeben.
- Diese Readings enthalten die gültigen Stream-Pfade zu einem Livestream und können z.B. versendet und von einer entsprechenden Anwendung ohne session Id geöffnet werden.
- Wenn das Attribut "livestreamprefix" (Format: "http(s)://<hostname><port>) gesetzt ist, wird der Servername und Port überschrieben soweit es sinnvoll ist.
- Wird Polling der Kameraeigenschaften genutzt, wird die stmUrlPath-Funktion automatisch mit ausgeführt.
- <br><br>
-
- Beispiel für den Aufbau eines Http-Calls zu einem Livestream mit StmKey:
-
- <pre>
- http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceStation.VideoStreaming&version=1&method=Stream&format=mjpeg&cameraId=5&StmKey="31fd87279976d89bb98409728cced890"
- </pre>
-
- cameraId (Internal CAMID), StmKey müssen durch gültige Werte ersetzt werden. <br><br>
-
- <b>Hinweis:</b> <br>
-
- Falls der Stream-Aufruf versendet und von extern genutzt wird sowie hostname / port durch gültige Werte ersetzt und die
- Routerports entsprechend geöffnet werden, ist darauf zu achten, dass diese sensiblen Daten nicht durch unauthorisierte Personen
- für den Zugriff genutzt werden können !
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> storedCredentials </b> (gilt für CAM/SVS)</li> <br>
-
- Die gespeicherten Anmeldeinformationen (Credentials) werden in einem Popup als Klartext angezeigt.
- </ul>
- <br><br>
-
- <ul>
- <li><b> get <name> svsinfo </b> (gilt für CAM/SVS)</li> <br>
-
- Ermittelt allgemeine Informationen zur installierten SVS-Version und andere Eigenschaften. <br>
- </ul>
- <br><br>
-
- </ul>
- <br><br>
- <b>Polling der Kamera/SVS-Eigenschaften:</b><br><br>
- Die Abfrage der Kameraeigenschaften erfolgt automatisch, wenn das Attribut "pollcaminfoall" (siehe Attribute) mit einem Wert > 10 gesetzt wird. <br>
- Per Default ist das Attribut "pollcaminfoall" nicht gesetzt und das automatische Polling nicht aktiv. <br>
- Der Wert dieses Attributes legt das Intervall der Abfrage in Sekunden fest. Ist das Attribut nicht gesetzt oder < 10 wird kein automatisches Polling <br>
- gestartet bzw. gestoppt wenn vorher der Wert > 10 gesetzt war. <br><br>
- Das Attribut "pollcaminfoall" wird durch einen Watchdog-Timer überwacht. Änderungen des Attributwertes werden alle 90 Sekunden ausgewertet und entsprechend umgesetzt. <br>
- Eine Änderung des Pollingstatus / Pollingintervalls wird im FHEM-Logfile protokolliert. Diese Protokollierung kann durch Setzen des Attributes "pollnologging=1" abgeschaltet werden.<br>
- Dadurch kann ein unnötiges Anwachsen des Logs vermieden werden. Ab verbose=4 wird allerdings trotz gesetzten "pollnologging"-Attribut ein Log des Pollings <br>
- zu Analysezwecken aktiviert. <br><br>
- Wird FHEM neu gestartet, wird bei aktivierten Polling der ersten Datenabruf innerhalb 60s nach dem Start ausgeführt. <br><br>
- Der Status des automatischen Pollings wird durch das Reading "PollState" signalisiert: <br><br>
-
- <ul>
- <li><b> PollState = Active </b> - automatisches Polling wird mit Intervall entsprechend "pollcaminfoall" ausgeführt </li>
- <li><b> PollState = Inactive </b> - automatisches Polling wird nicht ausgeführt </li>
- </ul>
- <br>
-
- Die Bedeutung der Readingwerte ist unter <a href="#SSCamreadings">Readings</a> beschrieben. <br><br>
- <b>Hinweise:</b> <br><br>
- Wird Polling eingesetzt, sollte das Intervall nur so kurz wie benötigt eingestellt werden da die ermittelten Werte überwiegend statisch sind. <br>
- Das eingestellte Intervall sollte nicht kleiner sein als die Summe aller HTTP-Verarbeitungszeiten.
- Pro Pollingaufruf und Kamera werden ca. 10 - 20 Http-Calls gegen die Surveillance Station abgesetzt.<br><br>
- Bei einem eingestellten HTTP-Timeout (siehe <a href="#SSCamattr">Attribut</a>) "httptimeout") von 4 Sekunden kann die theoretische Verarbeitungszeit nicht höher als 80 Sekunden betragen. <br>
- In dem Beispiel sollte man das Pollingintervall mit einem Sicherheitszuschlag auf nicht weniger 160 Sekunden setzen. <br>
- Ein praktikabler Richtwert könnte zwischen 600 - 1800 (s) liegen. <br>
- Sind mehrere Kameras in SSCam definiert, sollte "pollcaminfoall" nicht bei allen Kameras auf exakt den gleichen Wert gesetzt werden um Verarbeitungsengpässe <br>
- und dadurch versursachte potentielle Fehlerquellen bei der Abfrage der Synology Surveillance Station zu vermeiden. <br>
- Ein geringfügiger Unterschied zwischen den Pollingintervallen der definierten Kameras von z.B. 1s kann bereits als ausreichend angesehen werden. <br><br>
- <a name="SSCaminternals"></a>
- <b>Internals</b> <br><br>
- <ul>
- Die Bedeutung der verwendeten Internals stellt die nachfolgende Liste dar: <br><br>
- <ul>
- <li><b>CAMID</b> - die ID der Kamera in der SVS, der Wert wird automatisch anhand des SVS-Kameranamens ermittelt. </li>
- <li><b>CAMNAME</b> - der Name der Kamera in der SVS </li>
- <li><b>CREDENTIALS</b> - der Wert ist "Set" wenn die Credentials gesetzt wurden </li>
- <li><b>MODEL</b> - Unterscheidung von Kamera-Device (CAM) und Surveillance Station Device (SVS) </li>
- <li><b>NAME</b> - der Kameraname in FHEM </li>
- <li><b>OPMODE</b> - die zuletzt ausgeführte Operation des Moduls </li>
- <li><b>SERVERADDR</b> - IP-Adresse des SVS Hostes </li>
- <li><b>SERVERPORT</b> - der SVS-Port </li>
-
- <br><br>
- </ul>
- </ul>
- <a name="SSCamattr"></a>
- <b>Attribute</b>
- <br><br>
-
- <ul>
- <ul>
- <li><b>debugactivetoken</b><br>
- wenn gesetzt wird der Status des Active-Tokens gelogged - nur für Debugging, nicht im
- normalen Betrieb benutzen ! </li><br>
-
- <li><b>disable</b><br>
- deaktiviert das Gerätemodul bzw. die Gerätedefinition </li><br>
-
- <li><b>httptimeout</b><br>
- Timeout-Wert für HTTP-Aufrufe zur Synology Surveillance Station, Default: 4 Sekunden (wenn
- httptimeout = "0" oder nicht gesetzt) </li><br>
-
- <li><b>htmlattr</b><br>
- ergänzende Angaben zur Inline-Bilddarstellung um das Verhalten wie Bildgröße zu beeinflussen. <br><br>
-
- <ul>
- <b>Beispiel:</b><br>
- attr <name> htmlattr width="500" height="325" top="200" left="300"
- </ul>
- <br>
- </li>
-
- <li><b>livestreamprefix</b><br>
- überschreibt die Angaben zu Protokoll, Servernamen und Port zur Weiterverwendung der
- Livestreamadresse als z.B. externer Link. Anzugeben in der Form
- "http(s)://<servername>:<port>" </li><br>
-
- <li><b>loginRetries</b><br>
- setzt die Anzahl der Login-Wiederholungen im Fehlerfall (default = 1) </li><br>
-
- <li><b>noQuotesForSID</b><br>
- dieses Attribut kann in bestimmten Fällen die Fehlermeldung "402 - permission denied"
- vermeiden und ein login ermöglichen. </li><br>
-
- <li><b>pollcaminfoall</b><br>
- Intervall der automatischen Eigenschaftsabfrage (Polling) einer Kamera (kleiner 10: kein
- Polling, größer 10: Polling mit Intervall) </li><br>
- <li><b>pollnologging</b><br>
- "0" bzw. nicht gesetzt = Logging Gerätepolling aktiv (default), "1" = Logging
- Gerätepolling inaktiv </li><br>
-
- <li><b>rectime</b><br>
- festgelegte Aufnahmezeit wenn eine Aufnahme gestartet wird. Mit rectime = 0 wird eine
- Endlosaufnahme gestartet. Ist "rectime" nicht gesetzt, wird der Defaultwert von 15s
- verwendet.</li><br>
-
- <li><b>recextend</b><br>
- "rectime" einer gestarteten Aufnahme wird neu gesetzt. Dadurch verlängert sich die
- Aufnahemzeit einer laufenden Aufnahme </li><br>
-
- <li><b>session</b><br>
- Auswahl der Login-Session. Nicht gesetzt oder "DSM" -> session wird mit DSM aufgebaut
- (Standard). "SurveillanceStation" -> Session-Aufbau erfolgt mit SVS </li><br>
-
- <li><b>simu_SVSversion</b><br>
- Simuliert eine andere SVS-Version. (es ist nur eine niedrigere als die installierte SVS
- Version möglich !) </li><br>
-
- <li><b>snapGalleryBoost</b><br>
- Wenn gesetzt, werden die letzten Schnappschüsse (default 3) über Polling im Speicher gehalten und mit "set/get snapGallery"
- aufbereitet angezeigt. Dieser Modus bietet sich an wenn viele bzw. Fullsize Images angezeigt werden sollen.
- Ist das Attribut eingeschaltet, können bei "set/get snapGallery" keine Argumente mehr mitgegeben werden.
- (siehe Attribut "snapGalleryNumber") </li><br>
-
- <li><b>snapGalleryColumns</b><br>
- Die Anzahl der Snaps die in einer Reihe im Popup erscheinen sollen (default 3). </li><br>
-
- <li><b>snapGalleryHtmlAttr</b><br>
- hiermit kann die Bilddarstellung beeinflusst werden. <br>
- Ist das Attribut nicht gesetzt, wird das Attribut "htmlattr" verwendet. <br>
- Ist auch dieses nicht gesetzt, wird eine Standardvorgabe verwendet (width="500" height="325"). <br><br>
-
- <ul>
- <b>Beispiel:</b><br>
- attr <name> snapGalleryHtmlAttr width="325" height="225"
- </ul>
- <br>
- </li>
-
- <li><b>snapGalleryNumber</b><br>
- Die Anzahl der abzurufenden Schnappschüsse (default 3). </li><br>
-
- <li><b>snapGallerySize</b><br>
- Mit diesem Attribut kann die Qualität der Images eingestellt werden (default "Icon"). <br>
- Im Modus "Full" wird die original vorhandene Auflösung der Images abgerufen. Dies erfordert mehr Ressourcen und kann die
- Anzeige verlangsamen. Mit "snapGalleryBoost=1" kann die Ausgabe beschleunigt werden, da in diesem Fall die Aufnahmen über
- Polling abgerufen und nur noch zur Anzeige gebracht werden. </li><br>
-
- <li><b>showStmInfoFull</b><br>
- zusaätzliche Streaminformationen wie LiveStreamUrl, StmKeyUnicst, StmKeymjpegHttp werden
- ausgegeben</li><br>
-
- <li><b>showPassInLog</b><br>
- wenn gesetzt wird das verwendete Passwort im Logfile (verbose 4) angezeigt.
- (default = 0) </li><br>
-
- <li><b>videofolderMap</b><br>
- ersetzt den Inhalt des Readings "VideoFolder", Verwendung z.B. bei gemounteten
- Verzeichnissen </li><br>
-
- <li><b>verbose</b> </li><br>
-
- <ul>
- Es werden verschiedene Verbose-Level unterstützt.
- Dies sind im Einzelnen:
-
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td> 0 </td><td>- Start/Stop-Ereignisse werden geloggt </td></tr>
- <tr><td> 1 </td><td>- Fehlermeldungen werden geloggt </td></tr>
- <tr><td> 2 </td><td>- Meldungen über wichtige Ereignisse oder Alarme </td></tr>
- <tr><td> 3 </td><td>- gesendete Kommandos werden geloggt </td></tr>
- <tr><td> 4 </td><td>- gesendete und empfangene Daten werden geloggt </td></tr>
- <tr><td> 5 </td><td>- alle Ausgaben zur Fehleranalyse werden geloggt. <b>ACHTUNG:</b> möglicherweise werden sehr viele Daten in das Logfile geschrieben! </td></tr>
- </table>
- </ul>
- <br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <br><br>
- </ul>
- <a name="SSCamreadings"></a>
- <b>Readings</b>
- <ul>
- <br>
- Über den Pollingmechanismus bzw. durch Abfrage mit "Get" werden Readings bereitgestellt, deren Bedeutung in der nachfolgenden Tabelle dargestellt sind. <br>
- Die übermittelten Readings können in Abhängigkeit des Kameratyps variieren.<br><br>
- <ul>
- <table>
- <colgroup> <col width=5%> <col width=95%> </colgroup>
- <tr><td><li>Availability</li> </td><td>- Verfügbarkeit der Kamera (disabled, enabled, disconnected, other) </td></tr>
- <tr><td><li>CamEventNum</li> </td><td>- liefert die Gesamtanzahl der in SVS registrierten Events der Kamera </td></tr>
- <tr><td><li>CamExposureControl</li> </td><td>- zeigt den aktuell eingestellten Typ der Belichtungssteuerung </td></tr>
- <tr><td><li>CamExposureMode</li> </td><td>- aktueller Belichtungsmodus (Day, Night, Auto, Schedule, Unknown) </td></tr>
- <tr><td><li>CamForceEnableMulticast</li> </td><td>- sagt aus ob die Kamera verpflichet ist Multicast einzuschalten. </td></tr>
- <tr><td><li>CamIP</li> </td><td>- IP-Adresse der Kamera </td></tr>
- <tr><td><li>CamLastRec</li> </td><td>- Pfad / Name der letzten Aufnahme </td></tr>
- <tr><td><li>CamLastRecTime</li> </td><td>- Datum / Startzeit - Stopzeit der letzten Aufnahme </td></tr>
- <tr><td><li>CamLiveMode</li> </td><td>- Quelle für Live-Ansicht (DS, Camera) </td></tr>
- <tr><td><li>CamModel</li> </td><td>- Kameramodell </td></tr>
- <tr><td><li>CamMotDetSc</li> </td><td>- Status der Bewegungserkennung (disabled, durch Kamera, durch SVS) und deren Parameter </td></tr>
- <tr><td><li>CamNTPServer</li> </td><td>- eingestellter Zeitserver </td></tr>
- <tr><td><li>CamPort</li> </td><td>- IP-Port der Kamera </td></tr>
- <tr><td><li>CamPreRecTime</li> </td><td>- Dauer der der Voraufzeichnung in Sekunden (Einstellung in SVS) </td></tr>
- <tr><td><li>CamRecShare</li> </td><td>- gemeinsamer Ordner auf der DS für Aufnahmen </td></tr>
- <tr><td><li>CamRecVolume</li> </td><td>- Volume auf der DS für Aufnahmen </td></tr>
- <tr><td><li>CamVendor</li> </td><td>- Kamerahersteller Bezeichnung </td></tr>
- <tr><td><li>CamVideoFlip</li> </td><td>- Ist das Video gedreht </td></tr>
- <tr><td><li>CamVideoMirror</li> </td><td>- Ist das Video gespiegelt </td></tr>
- <tr><td><li>CamVideoRotate</li> </td><td>- Ist das Video gedreht </td></tr>
- <tr><td><li>CapAudioOut</li> </td><td>- Fähigkeit der Kamera zur Audioausgabe über Surveillance Station (false/true) </td></tr>
- <tr><td><li>CapChangeSpeed</li> </td><td>- Fähigkeit der Kamera verschiedene Bewegungsgeschwindigkeiten auszuführen </td></tr>
- <tr><td><li>CapPTZAbs</li> </td><td>- Fähigkeit der Kamera für absolute PTZ-Aktionen </td></tr>
- <tr><td><li>CapPTZAutoFocus</li> </td><td>- Fähigkeit der Kamera für Autofokus Aktionen </td></tr>
- <tr><td><li>CapPTZDirections</li> </td><td>- die verfügbaren PTZ-Richtungen der Kamera </td></tr>
- <tr><td><li>CapPTZFocus</li> </td><td>- Art der Kameraunterstützung für Fokussierung </td></tr>
- <tr><td><li>CapPTZHome</li> </td><td>- Unterstützung der Kamera für Home-Position </td></tr>
- <tr><td><li>CapPTZIris</li> </td><td>- Unterstützung der Kamera für Iris-Aktion </td></tr>
- <tr><td><li>CapPTZPan</li> </td><td>- Unterstützung der Kamera für Pan-Aktion </td></tr>
- <tr><td><li>CapPTZTilt</li> </td><td>- Unterstützung der Kamera für Tilt-Aktion </td></tr>
- <tr><td><li>CapPTZZoom</li> </td><td>- Unterstützung der Kamera für Zoom-Aktion </td></tr>
- <tr><td><li>DeviceType</li> </td><td>- Kameratyp (Camera, Video_Server, PTZ, Fisheye) </td></tr>
- <tr><td><li>Error</li> </td><td>- Meldungstext des letzten Fehlers </td></tr>
- <tr><td><li>Errorcode</li> </td><td>- Fehlercode des letzten Fehlers </td></tr>
- <tr><td><li>HomeModeState</li> </td><td>- HomeMode-Status (ab SVS-Version 8.1.0) </td></tr>
- <tr><td><li>LastLogEntry</li> </td><td>- der neueste Eintrag des Surveillance Station Logs (nur SVS-Device und wenn Attribut pollcaminfoall gesetzt) </td></tr>
- <tr><td><li>LastSnapFilename</li> </td><td>- der Filename des letzten Schnapschusses </td></tr>
- <tr><td><li>LastSnapId</li> </td><td>- die ID des letzten Schnapschusses </td></tr>
- <tr><td><li>LastSnapTime</li> </td><td>- Zeitstempel des letzten Schnapschusses </td></tr>
- <tr><td><li>LastUpdateTime</li> </td><td>- Datum / Zeit der letzten Aktualisierung durch "caminfoall" </td></tr>
- <tr><td><li>LiveStreamUrl </li> </td><td>- die LiveStream-Url wenn der Stream gestartet ist. (<a href="#SSCamattr">Attribut</a> "showStmInfoFull" muss gesetzt sein) </td></tr>
- <tr><td><li>Patrols</li> </td><td>- in Surveillance Station voreingestellte Überwachungstouren (bei PTZ-Kameras) </td></tr>
- <tr><td><li>PollState</li> </td><td>- zeigt den Status des automatischen Pollings an </td></tr>
- <tr><td><li>Presets</li> </td><td>- in Surveillance Station voreingestellte Positionen (bei PTZ-Kameras) </td></tr>
- <tr><td><li>Record</li> </td><td>- Aufnahme läuft = Start, keine Aufnahme = Stop </td></tr>
- <tr><td><li>StmKey</li> </td><td>- aktueller StreamKey. Kann zum öffnen eines Livestreams ohne Session Id genutzt werden. </td></tr>
- <tr><td><li>StmKeyUnicst</li> </td><td>- Uni-cast Stream Pfad der Kamera. (<a href="#SSCamattr">Attribut</a> "showStmInfoFull" muss gesetzt sein) </td></tr>
- <tr><td><li>StmKeymjpegHttp</li> </td><td>- Mjpeg Stream Pfad (über http) der Kamera. (<a href="#SSCamattr">Attribut</a> "showStmInfoFull" muss gesetzt sein) </td></tr>
- <tr><td><li>SVScustomPortHttp</li> </td><td>- benutzerdefinierter Port der Surveillance Station (HTTP) im DSM-Anwendungsportal (get mit "svsinfo") </td></tr>
- <tr><td><li>SVScustomPortHttps</li> </td><td>- benutzerdefinierter Port der Surveillance Station (HTTPS) im DSM-Anwendungsportal (get mit "svsinfo") </td></tr>
- <tr><td><li>SVSlicenseNumber</li> </td><td>- die Anzahl der installierten Kameralizenzen (get mit "svsinfo") </td></tr>
- <tr><td><li>SVSuserPriv</li> </td><td>- die effektiven Rechte des verwendeten Users nach dem Login (get mit "svsinfo") </td></tr>
- <tr><td><li>SVSversion</li> </td><td>- die Paketversion der installierten Surveillance Station (get mit "svsinfo") </td></tr>
- <tr><td><li>UsedSpaceMB</li> </td><td>- durch Aufnahmen der Kamera belegter Plattenplatz auf dem Volume </td></tr>
- <tr><td><li>VideoFolder</li> </td><td>- Pfad zu den aufgenommenen Videos </td></tr>
- </table>
- </ul>
- <br><br>
- </ul>
-
- </ul>
- <br><br>
- </ul>
- <p><a name="STACKABLE"></a>
- <h3>STACKABLE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#STACKABLE'>STACKABLE</a><br/>
- </ul>
- <a name="STACKABLE_CC"></a>
- <h3>STACKABLE_CC</h3>
- <div class='langLinks'>[<a href='commandref.html#STACKABLE_CC'>EN</a> DE]</div>
- <ul>
- Mit Hilfe dieses Moduls kann man die "Stackable CC" Geräte von busware.de in
- FHEM integrieren. Diese Geräte ermöglichen eine Menge von CULs an einem RPi
- anzuschliessen.
- Das erste Gerät wird als CUL definiert, alle nachfolgenden als STACKABLE_CC.
- <br><br>
- <a name="STACKABLE_CCdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> STACKABLE_CC <Base-Device-Name></code> <br>
- <br>
- <Base-Device-Name> ist der Name des Gerätes, der als Basis für das
- aktuelle Gerät dient.<br>
- Beispiel:
- <ul><code>
- define SCC0 CUL /dev/ttyAMA0@38400<br>
- attr SCC0 rfmode SlowRF<br>
- define SCC1 STACKABLE_CC SCC0<br>
- attr SCC1 rfmode HomeMatic<br>
- define SCC2 STACKABLE_CC SCC1<br>
- attr SCC2 rfmode Max<br>
- </code></ul>
- <b>Wichtig:</b>
- <ul>
- <li>Das rfmode Attribut muss explizit spezifiziert werden. Das gilt nur
- für die STACKABLE_CC Definitionen, und nicht für die erste, die
- als CUL definiert wurde.</li>
- <li>Falls SlowRF spezifiziert wurde, dann muss das FHTID explizit gesetzt
- werden, mit folgendem Kommando: "set SCCX raw T01HHHH". Auch das ist nur
- für die STACKABLE_CC nötig.</li>
- <li>Falls ein Gerät umbenannt wird, was als Basis für ein STACKABLE_CC
- dient, dann muss es auch in der Definition des abhängigen Gerätes
- umbenannt werden, und FHEM muss neugestartet werden.</li>
- </ul>
- </ul>
- <a name="STACKABLE_CCset"></a>
- <b>Set</b> <ul>Die gleichen wie für das <a href="#CULset">CUL</a>.</ul><br>
- <a name="STACKABLE_CCget"></a>
- <b>Get</b> <ul>Die gleichen wie für das <a href="#CULget">CUL</a>.</ul><br>
- <a name="STACKABLE_CCattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#IODev">IODev</a></li><br>
- <li><a href="#ignore">ignore</a></li><br>
- Die anderen Attribute sind die gleichen wie für das <a href="#CULattr">CUL</a>.
- </ul>
- </ul>
- <p><a name="STOCKQUOTES"></a>
- <h3>STOCKQUOTES</h3>
- <div class='langLinks'>[<a href='commandref.html#STOCKQUOTES'>EN</a> DE]</div>
- (<a href="commandref.html#STOCKQUOTES">en</a> | de)
- <ul>
- <a name="STOCKQUOTES"></a>
- Wertpapierdaten von verschiedenen Quellen holen<br>
- <b>Vorbereitung</b><br>
- Perl Modul Finance::Quote muss installiert werden:<br>
- <code>cpan install Finance::Quote</code> oder <code>sudo apt-get install libfinance-quote-perl</code><br><br>
-
- <b>Define</b>
- <ul>
- <code>define <name> STOCKQUOTES</code><br><br>
- </ul>
- <a name="STOCKQUOTESset"></a>
- <b>Set</b>
- <ul>
- <Symbol> hängt von den jeweiligen Quellen ab. Kann auch eine WKN sein. Hier muss ggf. experimentiert werden.<br><br>
- <li><code>set <name> buy <Symbol> <Menge> <Gesamtpreis></code><br>
- Wertpapier in Depot einbuchen. Wenn dieses Wertpapier bereits vorhanden ist, werden die Neuen einfach dazuaddiert.<br><br>
- </li>
- <li><code>set <name> sell <Symbol> <Menge> <Gesamtpreis></code><br>
- Wertpapier (auch Teilmenge) wieder ausbuchen.<br><br>
- </li>
- <li><code>set <name> add <Symbol></code><br>
- Wertpapier nur beobachten<br><br>
- </li>
- <li><code>set <name> remove <Symbol></code><br>
- Entferne Wertpapier das nur beobachtet wird.<br><br>
- </li>
- <li><code>set <name> clearReadings</code><br>
- Alle Readings löschen.<br><br>
- </li>
- <li><code>set <name> update</code><br>
- Alle Readings aktualisieren.<br><br>
- </li>
- </ul>
-
- <a name="STOCKQUOTESget"></a>
- <b>Get</b>
- <ul>
- <li><code>get <name> sources</code><br>
- Verfügbare Datenquellen auflisten. Diese werden für die Attribute defaultSource und sources benötigt<br><br>
- </li>
- <li><code>get <name> currency <Symbol></code><br>
- Wertpapierwährung ermitteln<br><br>
- </li>
- </ul>
- <a name="STOCKQUOTESattr"></a>
- <b>Attribute</b>
- <ul>
- <li>currency<br>
- Währung, in der die Wertpapiere angezeigt werden.<br>
- Default: EUR, gültige Werte: Währungskürzel<br><br>
- </li>
- <li>defaultSource<br>
- Standardquelle für die Wertpapierdaten.<br>
- Default: europe, gültige Werte: alles was <code>get <name> sources</code> ausgibt.<br><br>
- </li>
- <li>queryTimeout<br>
- Timeout beim holen der Daten in Sekunden.<br>
- Standard: 120, gültige Werte: Zahl<br><br>
- </li>
- <li>pollInterval<br>
- Aktualisierungsintervall in Sekunden.<br>
- Standard: 300, gültige Werte: Zahl<br><br>
- </li>
- <li>sources<br>
- Für jedes Wertpapier kann eine eigene Datenquelle definiert werden.<br>
- Die Datenquellen können über <code>get <name> sources</code> angefragt werden.<br>
- Format: <Symbol>:<Source>[,<Symbol>:<Source>...]<br>
- Beispiel: <code>A0M16S:vwd,532669:unionfunds,849104:unionfunds</code><br>
- Alle nicht aufgeführten Werpapiere werden über die defaultSource abgefragt.<br><br>
- </li>
- <li>stocks<br>
- Wird über buy/sell/add/remove angelegt/modifiziert<br>
- Enthält die Werpapiere im Format <Symbol>:<Anzahl>:<Einstandswert>[,<Symbol>:<Anzahl>:<Einstandswert>...]<br><br>
- </li>
- </ul><br>
- </ul>
- <p><a name="STV"></a>
- <h3>STV</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#STV'>STV</a><br/>
- </ul>
- <a name="SUNRISE_EL"></a>
- <h3>SUNRISE_EL</h3>
- <div class='langLinks'>[<a href='commandref.html#SUNRISE_EL'>EN</a> DE]</div>
- <ul>
- <p>
- <strong>SUNRISE_EL</strong> definiert eine Reihe von Perl-Subroutinen (<abbr>z.B.</abbr> zur Nutzung mit <a href="#at">at</a>):
- </p>
- <ul>
- <li><code>sunrise()</code> - absolute Zeit des nächsten Sonnenaufgangs (+ 24 h, wenn am nächsten Tag)</li>
- <li><code>sunset()</code> - absolute Zeit des nächsten Sonnenuntergangs (+ 24 h, wenn am nächsten Tag)</li>
- <li><code>sunrise_rel()</code> - relative Zeit des nächsten Sonnenaufgangs</li>
- <li><code>sunset_rel()</code> - relative Zeit des nächsten Sonnenuntergangs</li>
- <li><code>sunrise_abs()</code> - absolute Zeit des nächsten Sonnenaufgangs (ohne Stundenzuschlag)</li>
- <li><code>sunset_abs()</code> - relative Zeit des nächsten Sonnenuntergangs (ohne Stundenzuschlag)</li>
- <li><code>sunrise_abs_dat()</code> - absolute Zeit des nächsten Sonnenaufgangs an einem bestimmten Tag</li>
- <li><code>sunset_abs_dat()</code> - relative Zeit des nächsten Sonnenuntergangs an einem bestimmten Tag</li>
- <li><code>isday()</code> - Tag oder Nacht</li>
- </ul>
- <h4>Breite, Länge und Höhenwinkel</h4>
- <p>
- Bevor du <strong>SUNRISE_EL</strong> verwendest, solltest du im <a href="#global">global-Device</a> die
- Werte für <span>latitude</span> (geographische Breite) und <span>longitude</span> (geographische Länge) entsprechend
- deines Standorts setzen.
- </p>
- <div>
- <h4>Exkurs: <span>latitude</span> & <span>longitude</span> ermitteln</h4>
- <p>
- Deine geopgragischen Koordinaten kannst du <abbr>z.B.</abbr> mit <a href="https://maps.google.com">Google Maps</a> bestimmen.
- Dazu setzt du einen Punkt auf der Karte und findest dann im unteren Bereich der Karte die Angabe für beide Werte.
- Der erste Wert ist die geographische Breite (<span>latitude</span>); der zweite Wert die geographische Länge
- (<span>longitude</span>).
- </p>
- <p>
- Der <span>Default</span>-Wert ist 50.112, 8.686 (<a href="https://goo.gl/maps/vkyedDL1DJp">Frankfurt am Main</a>).
- </p>
- </div>
- <p>
- <strong>SUNRISE_EL</strong> geht von einem Höhenwinkel der Sonne bezogen zum Horizont, <var>h</var>, von -6° aus. Dieser Wert bedeutet,
- dass die Sonne 6° <strong>unter</strong> dem Horizont steht und Lesen im Freien ohne künstliche Beleuchtung nicht
- mehr möglich ist (<span>civil twilight</span>, bürgerliche Dämmerung).
- <strong>SUNRISE_EL</strong> speichert diesen Wert in <var><code>$defaultaltit</code></var>.
- </p>
- <p>
- Siehe auch <a href="http://search.cpan.org/~jforget/DateTime-Event-Sunrise-0.0505/lib/DateTime/Event/Sunrise.pm">perldoc DateTime::Event::Sunrise</a> für
- weitere Hinweise.
- </p>
- <h4>Befehlsreferenz</h4>
- <h5>Parameter</h5>
- <p>
- Jede der folgenden Funktionen akzeptiert bis zu vier (<abbr>bzw.</abbr> fünf) Parameter in der angegebenen Reihenfolge:
- </p>
- <dl>
- <dt>
- <var>unix timestamp</var>
- </dt>
- <dd>
- <p>
- <strong>Ausschließlich</strong> <code>sunrise_abs_dat()</code> & <code>sunset_abs_dat()</code>
- erwarten als ersten Parameter einen Unix-Timestamp (Unix-Epoche) in Sekunden, der ein Datum spezifiziert. Andere Subroutinen
- erwarten diesen Parameter nicht!
- </p>
- </dd>
- <dt>
- <var>altitude</var>
- </dt>
- <dd>
- <p>
- Eine der folgenden Zeichenketten, die unterschiedliche Höhenwinkel <var>h</var> definieren und den Wert
- von <code><var>$defaultaltit</var></code> verändern.
- </p>
- <p>
- Erlaubte Werte sind:
- </p>
- <ul>
- <li>
- <code><var>REAL</var></code>, <var>h</var> = 0°,
- </li>
- <li>
- <code><var>CIVIL</var></code>, <var>h</var> = -6°,
- </li>
- <li>
- <code><var>NAUTIC</var></code>, <var>h</var> = -12°,
- </li>
- <li>
- <code><var>ASTRONOMIC</var></code>, <var>h</var> = -18°,
- </li>
- <li>
- oder <code><var>HORIZON=</var></code>, gefolgt von einer positiven oder negativen Zahl ohn Gradzeichen, die einen Höhenwinkel
- angibt.
- </li>
- </ul>
- </dd>
- <dt>
- <var>offset</var>
- </dt>
- <dd>
- <p>
- <span>Offset</span> in Sekunden, der zu dem Rückgabewert der Funktion addiert wird.
- </p>
- <p>
- <code>isday()</code>
- ignoriert diesen Wert.
- </p>
- </dd>
- <dt>
- <var>min</var>
- </dt>
- <dd>
- <p>
- Einen Zeitstempel im Format <var>hh:mm</var>, vor dem keine Aktion ausgeführt werden soll.
- </p>
- <p>
- <code>isday()</code> wird <var>(int) 0</var> zurückliefern, wenn <var>min</var> gesetzt
- und der aktuelle Zeitstempel kleiner ist.
- </p>
- </dd>
- <dt>
- <var>max</var>
- </dt>
- <dd>
- <p>
- Einen Zeitstempel im Format <var>hh:mm</var>, nach dem keine Aktion ausgeführt werden soll.
- </p>
- <p>
- <code>isday()</code> wird <var>(int) 0</var> zurückliefern, wenn <var>max</var> gesetzt
- und der aktuelle Zeitstempel größer ist.
- </p>
- </dd>
- </dl>
- <h5>Subroutinen</h5>
- <dl>
- <dt>
- <p><code>sunrise(), sunset()</code></p>
- </dt>
- <dd>
- liefern den absoluten Wert des nächsten Sonnenauf- <abbr>bzw.</abbr> -untergangs zurück, wobei 24 Stunden zu
- diesem Wert addiert werden,
- wenn der Zeitpunkt am nächsten Tag sein wird, im Format <var>hh:mm:ss</var>.
- </dd>
- <dt>
- <p><code>sunrise_rel(), sunset_rel()</code></p>
- </dt>
- <dd>
- liefern die relative Zeit bis zum nächsten Sonnenauf- <abbr>bzw.</abbr> -untergang im Format
- <var>hh:mm:ss</var>.
- </dd>
- <dt>
- <p><code>sunrise_abs(), sunset_abs()</code></p>
- </dt>
- <dd>
- liefern den nächsten absoluten Zeitpunkt des nächsten Sonnenauf- <abbr>bzw.</abbr> -untergangs
- <strong>ohne</strong> 24 Stunden
- zu addieren im Format <var>hh:mm:ss</var>.
- </dd>
- <dt>
- <p><code>sunrise_abs_dat(), sunset_abs()_dat</code></p>
- </dt>
- <dd>
- liefern den nächsten absoluten Zeitpunkt des nächsten Sonnenauf- <abbr>bzw.</abbr> -untergangs
- <strong>ohne</strong> 24 Stunden zu addieren im Format <var>hh:mm:ss</var> zu einem als ersten Parameter angegebenen Datum.
- </dd>
- <dt>
- <p><code>isday()</code></p>
- </dt>
- <dd>
- liefert <var>(int) 1</var> wenn Tag ist, <var>(int) 0</var> wenn Nacht ist.
- </dd>
- </dl>
- <h5>Beispiele</h5>
- <dl>
- <dt>
- <p>
- <code>sunrise("CIVIL");</code>
- </p>
- </dt>
- <dd>
- <p>
- Zeitpunkt des Sonnenaufgangs bei einem Höhenwinkel der Sonne von -6° unter dem Horizont (identisch zu <code>sunrise()</code>).
- </p>
- </dd>
- <dt>
- <p>
- <code>sunset("HORIZON=-3");</code>
- </p>
- </dt>
- <dd>
- <p>
- Zeitpunkt des Sonnenuntergangs bei einem Höhenwinkel der Sonne von 3° unter dem Horizont
- (zwischen <code><var>REAL</var></code> und <code><var>CIVIL</var></code>).
- </p>
- </dd>
- <dt>
- <p>
- <code>sunset("HORIZON=1");</code>
- </p>
- </dt>
- <dd>
- <p>
- Zeitpunkt des Sonnenaufgangs bei einem Höhenwinkel der Sonne von 1° über dem Horizont.
- </p>
- </dd>
- <dt>
- <p>
- <code>defmod a15 at *{sunset("REAL",0,"18:00","21:00")} set lamp1 on</code>
- </p>
- </dt>
- <dd>
- <p>
- Schalte <var>lamp1</var> an, sobald die Sonne unter den Horizont sinkt (<var>h ≤ 0</var>), jedoch nicht vor 18:00 und nicht nach 21:00.
- </p>
- </dd>
- <dt>
- <p>
- <code>
- my $date = time() + 7*86400;<br />
- sunrise_abs_dat($date);
- </code>
- </p>
- </dt>
- <dd>
- <p>
- Berechne den Sonnenaufgang von heute + sieben Tage.
- </p>
- </dd>
- <dt>
- <p>
- <code>
- my $date = time() + 7*86400;<br />
- sunrise_abs_dat($date, "CIVIL");
- </code>
- </p>
- </dt>
- <dd>
- <p>
- Berechne den Sonnenaufgang von heute + sieben Tage mit einem Höhenwinkel <var>h = -6°</var>.
- </p>
- </dd>
- </dl>
- <h4>Define</h4>
- <blockquote>
- <strong>SUNRISE_EL</strong> kann nicht explizit als <span>Device</span> definiert werden,
- sondern bietet die oben genannten Subroutinen.
- </blockquote>
- <h4>Set</h4>
- <blockquote>
- <strong>SUNRISE_EL</strong> unterstützt <var>set</var> nicht.
- </blockquote>
- <h4>Get</h4>
- <blockquote>
- <strong>SUNRISE_EL</strong> unterstützt <var>get</var> nicht.
- </blockquote>
- <h4>Attribute</h4>
- <p>
- Diese Attribute müssen im <span><a href="#global">global</a>-Device</span> gesetzt werden!
- </p>
- <dl>
- <dt>
- <p>
- <var>latitude</var>
- </p>
- </dt>
- <dd>
- <blockquote>
- Geographische Breite in Dezimalgrad in Form eines <code>float</code>, <abbr>z.B</abbr> <code><var>49.872471</var></code>.
- </blockquote>
- <blockquote>
- <span>Default</span>-Wert ist <code><var>50.112</var></code>.
- </blockquote>
- </dd>
- <dt>
- <p>
- <var>longitude</var>
- </p>
- </dt>
- <dd>
- <blockquote>
- Geographische Länge in Dezimalgrad in Form eines <code>float</code>, <abbr>z.B</abbr> <code><var>8.650991</var></code>.
- </blockquote>
- <blockquote>
- <span>Default</span>-Wert ist <code><var>8.686</var></code>.
- </blockquote>
- </dd>
- <dt>
- <p>
- <var>altitude</var>
- </p>
- </dt>
- <dd>
- <blockquote>
- Höhenwinkel <var>h</var> der Sonne bezogen auf den Horizont in Grad in Form einer Zahl ohne Gradzeichen.
- </blockquote>
- <blockquote>
- <span>Default</span>-Wert ist <code><var>-6</var></code>.
- </blockquote>
- </dd>
- </dl>
- </ul>
- <p><a name="SVG"></a>
- <h3>SVG</h3>
- <div class='langLinks'>[<a href='commandref.html#SVG'>EN</a> DE]</div>
- <ul>
- <a name="SVGlinkdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> SVG <logDevice>:<gplotfile>:<logfile></code>
- <br><br>
- Dies ist das Zeichenmodul von FHEMWEB, mit dem Vektorgrafiken (SVG) erzeugt
- werden. <br><br>
- Beispiel:
- <ul>
- <code>define MyPlot SVG inlog:temp4hum4:CURRENT</code><br>
- </ul>
- <br>
- Hinweise:
- <ul>
- <li>Normalerweise müssen SVG-Geräte nicht manuell erzeugt
- werden, da FHEMWEB es für den Nutzer einfach macht: man muss in
- der Detailansicht eines FileLogs wechseln und auf "Create SVG instance"
- klicken.</li>
- <li>CURRENT als <logfile> wird immer das aktuelle Logfile
- benutzen, selbst dann, wenn der Name des Logfiles sich
- regelmäßig ändert. </li>
- <li>Aus historischen Gründen benötigt jede SVG-Instanz eine
- sog. .gplot Datei, die auch als Input für das gnuplot Programm
- verwendet werden kann. Einige besondere Zeilen (welche mit #FileLog
- oder #DbLog beginnen) werden zusätzlich benutzt, diese werden von
- gnuplot als Kommentar betrachtet. Auf der anderen Seite implementiert
- dieses Modul nicht alle gnuplot-Attribute.</li>
- </ul>
- </ul>
- <br>
- <a name="SVGset"></a>
- <b>Set</b>
- <ul>
- <li>copyGplotFile<br>
- Kopiert die aktuell ausgewählte .gplot Datei in eine neue Datei, die
- den Namen der SVG Instanz trägt; bereits bestehende Dateien mit
- gleichem Namen werden überschrieben. Diese Vorgehensweise ist
- notwendig, wenn man den Ploteditor benutzt. Erzeugt man aus der
- Detailansicht des FileLogs die SVG Instanz, wird eine eindeutige
- .gplot-Datei erzeugt. In diesem Fall ist dieses Befehl nicht
- erforderlich.</li>
- </ul><br>
- <a name="SVGget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="SVGattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="captionLeft"></a>
- <li>captionLeft<br>
- Anzeigen der Legende auf der linken Seite. Überholt, wird
- automatisch nach captionPos konvertiert.
- </li><br>
- <a name="captionPos"></a>
- <li>captionPos<br>
- right - Anzeigen der Legende auf der rechten Seite (default)<br>
- left - Anzeigen der Legende auf der linken Seite<br>
- auto - Anzeigen der Labels der Legende auf der linken oder rechten Seite
- je nach Achsenzugehörigkeit<br>
- </li><br>
- <li><a href="#endPlotNow">endPlotNow</a></li><br>
- <li><a href="#endPlotToday">endPlotToday</a></li><br>
- <a name="fixedoffset"></a>
- <li>fixedoffset <nTage><br>
- Verschiebt den Plot-Offset um einen festen Wert (in Tagen).
- </li><br>
- <a name="fixedrange"></a>
- <li>fixedrange [offset]<br>
- Erste Alternative:<br>
- Enthält zwei Zeit-Spezifikationen in der Schreibweise YYYY-MM-DD,
- getrennt durch ein Leerzeichen. scrollen der Zeitachse ist nicht
- möglich, es wird z.B. verwendet, um sich die Daten verschiedener
- Jahre auf eine Seite anzusehen.<br><br>
- Zweite Alternative:<br>
- Wenn der Wert entweder hour, day, <N>days, week, month oder year
- lautet, kann der Zoom-Level für dieses SVG unabhängig vom
- User-spezifischen Zoom eingestellt werden. Diese Einstellung ist
- nützlich für mehrere Plots auf einer Seite: Eine Grafik ist mit
- dem Standard-Zoom am aussagekräftigsten, die anderen mit einem Zoom
- über eine Woche. Der optionale ganzzahlige Parameter [offset] setzt
- ein anderes Zeitintervall (z.B. letztes Jahr: <code>fixedrange year
- -1</code>, vorgestern:<code> fixedrange day -2</code>).
- </li><br>
- <a name="label"></a>
- <li>label<br>
- Eine Liste, bei der die einzelnen Werte mit einem zweifachen Doppelpunkt
- voneinander getrennt werden. Diese Liste wird verwendet um die <L#>
- Zeichenfolgen in der .gplot-Datei zu ersetzen. Dabei steht das # für
- eine laufende Ziffer beginnend mit 1 (<L1>, <L2>, usw.).
- Jeder Wert wird als Perl-Ausdruck bewertet, deshalb hat man Zugriff z.B.
- auf die hinterlegten Funktionen. <br><br>
- Egal, ob es sich bei der Plotart um gnuplot-scroll(-svg) oder SVG
- handelt, es können ebenfalls die Werte der individuellen Kurve
- für min, max, mindate, maxdate, avg, cnt, sum, currval (letzter
- Wert) und currdate (letztes Datum) durch Zugriff der entsprechenden Werte
- über das data Hash verwendet werden. Siehe untenstehendes
- Beispiel:<br>
- <ul>
- <li>Beschriftunng der rechten und linken y-Achse:<br>
- <ul>
- <li>Fhem config:<br>
- <code>attr wl_1 label "Temperature"::"Humidity"</code></li>
- <li>Eintrag in der .gplot-Datei:<br>
- <code>set ylabel <L1><br>
- set y2label <L2></code></li>
- </ul>
- </li>
- <li>Überschrift aus Maximum und dem letzten Wert der ersten
- Kurve(FileLog)
- <ul>
- <li>Fhem config:<br>
- <code>attr wl_1 label "Max $data{max1}, Current
- $data{currval1}"</code></li>
- <li>Eintrag in der .gplot-Datei:<br>
- <code>set title <L1></code><br></li>
- </ul>
- </li>
- </ul>
- Die Werte minAll und maxAll (die das Minimum/Maximum aller Werte
- repräsentieren) sind ebenfals im data hash vorhanden.
- <br>Überholt, wird durch das plotReplace Attribut abgelöst.
- </li><br>
- <li><a href="#nrAxis">nrAxis</a></li><br>
- <a name="plotfunction"></a>
- <li>plotfunction<br>
- Eine Liste, deren Werte durch Leerzeichen voneinander getrennt sind.
- Diese Liste wird verwendet um die <SPEC#> Zeichenfolgen in der
- .gplot-Datei zu ersetzen. Dabei steht das # für eine laufende Ziffer
- beginnend mit 1 (<SPEC1>, <SPEC2>, usw.) in der #FileLog oder
- #DBLog Anweisung. Mit diesem Attrbute ist es möglich eine
- .gplot-Datei für mehrere Geräte mit einem einzigen logdevice zu
- verwenden. <br><br>
- <ul><b>Beispiel:</b><br>
- <li>#FileLog <SPEC1><br>
- mit:<br>
- <code>attr <SVGdevice> plotfunction "4:IR\x3a:0:"</code><br>
- anstelle von:<br>
- <code>#FileLog 4:IR\x3a:0:</code>
- </li>
- <li>#DbLog <SPEC1><br>
- mit:<br>
- <code>attr <SVGdevice> plotfunction
- "Garage_Raumtemp:temperature::"</code><br>
- anstelle von:<br>
- <code>#DbLog Garage_Raumtemp:temperature::</code>
- </li>
- </ul>
- Überholt, wird durch das plotReplace Attribut abgelöst.
- </li><br>
- <li><a href="#plotmode">plotmode</a></li><br>
- <a name="plotReplace"></a>
- <li>plotReplace<br>
- Leerzeichen getrennte Liste von Name=Wert Paaren. Wert kann Leerzeichen
- enthalten, falls es in "" oder {} eingeschlossen ist. Wert wird als
- perl-Ausdruck ausgewertet, falls es in {} eingeschlossen ist.
- <br>
- In der .gplot Datei werden <Name> Zeichenketten durch den
- zugehoerigen Wert ersetzt, die Auswertung von {} Ausdrücken erfolgt
- <i>nach</i> dem die Daten ausgewertet wurden, d.h. man kann hier
- $data{min1},etc verwenden.
- <br>
- Bei %Name% erfolgt die Ersetzung <i>vor</i> der Datenauswertung, das kann
- man verwenden, um Parameter für die Auswertung zu ersetzen.
- </li><br>
- <li><a href="#plotsize">plotsize</a></li><br>
- <li><a href="#plotWeekStartDay">plotWeekStartDay</a></li><br>
- <a name="startDate"></a>
- <li>startDate<br>
- Setzt das Startdatum für den Plot. Wird für Demo-Installationen
- verwendet.
- </li><br>
- <a name="title"></a>
- <li>title<br>
- Eine besondere Form der Überschrift (siehe oben), bei der die
- Zeichenfolge <TL> in der .gplot-Datei ersetzt wird.
- Standardmäßig wird als <TL> der Dateiname des Logfiles
- eingesetzt.
- <br>Überholt, wird durch das plotReplace Attribut abgelöst.
- </li><br>
- </ul>
- <br>
- <a name="plotEditor"></a>
- <b>Plot-Editor</b>
- <br>
- Dieser Editor ist in der Detailansicht der SVG-Instanz zu sehen. Die
- meisten Features sind hier einleuchtend und bekannt, es gibt aber auch
- einige Ausnahmen:
- <ul>
- <li>wenn für ein Diagramm die Überschrift unterdrückt werden
- soll, muss im Eingabefeld <code>notitle</code> eingetragen werden.
- </li>
- <li>wenn ein fester Wert (nicht aus einer Wertespalte) definiert werden
- soll, für den Fall, das eine Zeichenfoge gefunden wurde (z.B. 1
- für eine FS20 Schalter, der AN ist und 0 für den AUS-Zustand),
- muss zuerst das Tics-Feld gefüllt, und die .gplot-Datei
- gespeichert werden, bevor der Wert über die Dropdownliste erreichbar
- ist.
- <ul><b>Beispiel:</b><br>
- Eingabe im Tics-Feld: ("On" 1, "Off" 0)<br>
- .gplot-Datei speichern<br>
- "1" als Regexp switch.on und "0" für den Regexp switch.off vom
- Spalten-Dropdown auswählen (auf die Gänsefüßchen
- achten!).<br>
- .gplot-Datei erneut speichern<br>
- </ul>
- </li>
- <li>Falls Range der Form {...} entspricht, dann wird sie als Perl -
- Expression ausgewertet. Das Ergebnis muss in der Form [min:max] sein.
- </li>
- </ul>
- Die sichtbarkeit des Plot-Editors kann mit dem FHEMWEB Attribut <a
- href="#ploteditor">ploteditor</a> konfiguriert werden.
- <br>
- </ul>
- <p><a name="SWAP"></a>
- <h3>SWAP</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SWAP'>SWAP</a><br/>
- </ul>
- <a name="SWAP_0000002200000003"></a>
- <h3>SWAP_0000002200000003</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SWAP_0000002200000003'>SWAP_0000002200000003</a><br/>
- </ul>
- <a name="SWAP_0000002200000008"></a>
- <h3>SWAP_0000002200000008</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SWAP_0000002200000008'>SWAP_0000002200000008</a><br/>
- </ul>
- <a name="SYSMON"></a>
- <h3>SYSMON</h3>
- <div class='langLinks'>[<a href='commandref.html#SYSMON'>EN</a> DE]</div>
- (<a href="commandref.html#SYSMON">en</a> | de)
- <ul>
- Dieses Modul liefert diverse Informationen und Statistiken zu dem System, auf dem FHEM-Server ausgeführt wird.
- Weiterhin können auch Remote-Systeme abgefragt werden (Telnet).
- Es werden nur Linux-basierte Systeme unterstützt. Manche Informationen sind hardwarespezifisch und sind daher nicht auf jeder Plattform
- verfügbar.
- Bis jetzt wurde dieses Modul auf folgenden Systemen getestet: Raspberry Pi (Debian Wheezy), BeagleBone Black,
- FritzBox 7390, WR703N unter OpenWrt, CubieTruck und einige andere.
- <br>
- <br>
- Für Informationen zu einer FritzBox beachten Sie bitte auch Module: <a href="#FRITZBOX">FRITZBOX</a> und <a href="#FB_CALLMONITOR">FB_CALLMONITOR</a>.
- <i>Das Modul nutzt das Perlmodule 'Net::Telnet' für den Fernzugriff. Dieses muss ggf. nachinstalliert werden.</i>
- <br><br>
- <b>Define</b>
- <br><br>
- <code>define <name> SYSMON [MODE[:[USER@]HOST][:PORT]] [<M1>[ <M2>[ <M3>[ <M4>]]]]</code><br>
- <br>
- Diese Anweisung erstellt eine neue SYSMON-Instanz.
- Die Parameter M1 bis M4 legen die Aktualisierungsintervalle für verschiedenen Readings (Statistiken) fest.
- Die Parameter sind als Multiplikatoren für die Zeit, die durch INTERVAL_BASE definiert ist, zu verstehen.
- Da diese Zeit fest auf 60 Sekunden gesetzt ist, können die Mx-Parameters als Zeitintervalle in Minuten angesehen werden.<br>
- Wird einer (oder mehrere) Multiplikatoren auf Null gesetzt werden, wird das entsprechende Readings deaktiviert.<br>
- <br>
- Die Parameter sind für die Aktualisierung der Readings nach folgender Schema zuständig:
- <ul>
- <li>M1: (Default-Wert: 1)<br>
- cpu_freq, cpu_temp, cpu_temp_avg, loadavg, stat_cpu, stat_cpu_diff, stat_cpu_percent, stat_cpu_text, power readings<br><br>
- </li>
- <li>M2: (Default-Wert: M1)<br>
- ram, swap<br>
- </li>
- <li>M3: (Default-Wert: M1)<br>
- eth0, eth0_diff, wlan0, wlan0_diff<br><br>
- </li>
- <li>M4: (Default-Wert: 10*M1)<br>
- Filesystem-Informationen<br><br>
- </li>
- <li>folgende Parameter werden immer anhand des Basisintervalls (unabhängig von den Mx-Parameters) aktualisiert:<br>
- fhemuptime, fhemuptime_text, idletime, idletime_text, uptime, uptime_text, starttime, starttime_text<br><br>
- </li>
- </ul>
- Für Abfrage eines entfernten Systems muss mindestens deren Adresse (HOST) angegeben werden, bei Bedarf ergänzt durch den Port und/oder den Benutzernamen.
- Das eventuell benötigte Passwort muss einmalig mit dem Befehl 'set password <pass>' definiert werden.
- Als MODE sind derzeit 'telnet', 'ssh' und 'local' erlaubt. 'local' erfordert keine weiteren Angaben und kann auch ganz weggelassen werden.
- <br>
- Bei SSH-Anmeldung mit Passwort muss 'sshpass' installiert sein (Achtung! Sicherheitstechnisch nicht empfehlenswert! Besser Public-Key-Verfahren benutzen).
- Damit SSH-Anmeldung funktioniert, muss ggf. einmalig eine manuelle SSH-Verbindung an die Remote-Machine von dem FHEM-Acount
- (unter dessen Rechten FHEM läuft) durchgeführt und fingerprint bestätigt werden.
- <br>
- <br>
- <b>Readings:</b>
- <br><br>
- <ul>
- <li>cpu_core_count<br>
- Anzahl der CPU Kerne
- </li>
- <li>cpu_model_name<br>
- CPU Modellname
- </li>
- <li>cpu_bogomips<br>
- CPU Speed: BogoMIPS
- </li>
- <li>cpu_freq (auf den DualCore-Systemen wie Cubietruck auch cpu1_freq)<br>
- CPU-Frequenz
- </li>
- <br>
- <li>cpu_temp<br>
- CPU-Temperatur
- </li>
- <br>
- <li>cpu_temp_avg<br>
- Durchschnitt der CPU-Temperatur, gebildet über die letzten 4 Werte.
- </li>
- <br>
- <li>fhemuptime<br>
- Zeit (in Sekunden) seit dem Start des FHEM-Servers.
- </li>
- <br>
- <li>fhemuptime_text<br>
- Zeit seit dem Start des FHEM-Servers: Menschenlesbare Ausgabe (texttuelle Darstellung).
- </li>
- <br>
- <li>fhemstarttime<br>
- Startzeit (in Sekunden seit 1.1.1970 1:00:00) des FHEM-Servers.
- </li>
- <br>
- <li>fhemstarttime_text<br>
- Startzeit des FHEM-Servers: Menschenlesbare Ausgabe (texttuelle Darstellung).
- </li>
- <br>
- <li>idletime<br>
- Zeit (in Sekunden und in Prozent), die das System (nicht der FHEM-Server!)
- seit dem Start in dem Idle-Modus verbracht hat. Also die Zeit der Inaktivität.
- </li>
- <br>
- <li>idletime_text<br>
- Zeit der Inaktivität des Systems seit dem Systemstart in menschenlesbarer Form.
- </li>
- <br>
- <li>loadavg<br>
- Ausgabe der Werte für die Systemauslastung (load average): 1 Minute-, 5 Minuten- und 15 Minuten-Werte.
- </li>
- <br>
- <li>ram<br>
- Ausgabe der Speicherauslastung.
- </li>
- <br>
- <li>swap<br>
- Benutzung und Auslastung der SWAP-Datei (bzw. Partition).
- </li>
- <br>
- <li>uptime<br>
- Zeit (in Sekenden) seit dem Systemstart.
- </li>
- <br>
- <li>uptime_text<br>
- Zeit seit dem Systemstart in menschenlesbarer Form.
- </li>
- <br>
- <li>starttime<br>
- Systemstart (Sekunden seit Thu Jan 1 01:00:00 1970).
- </li>
- <br>
- <li>starttime_text<br>
- Systemstart in menschenlesbarer Form.
- </li>
- <br>
- <li>Netzwerkinformationen<br>
- Informationen zu den über die angegebene Netzwerkschnittstellen übertragene Datenmengen
- und der Differenz zu der vorherigen Messung.
- <br>
- Beispiele:<br>
- Menge der übertragenen Daten über die Schnittstelle eth0.<br>
- <code>eth0: RX: 940.58 MB, TX: 736.19 MB, Total: 1676.77 MB</code><br>
- Änderung der übertragenen Datenmenge in Bezug auf den vorherigen Aufruf (für eth0).<br>
- <code>eth0_diff: RX: 0.66 MB, TX: 0.06 MB, Total: 0.72 MB</code><br>
- IP and IP v6 Adressen
- <code>eth0_ip 192.168.0.15</code><br>
- <code>eth0_ip6 fe85::49:4ff:fe85:f885/64</code><br>
- </li>
- <br>
- <li>Network Speed (wenn verfügbar)<br>
- Geschwindigkeit der aktuellen Netzwerkverbindung.
- <br>
- Beispiel:<br>
- <code>eth0_speed 100</code><br>
- </li>
- <br>
- <li>Dateisysteminformationen<br>
- Informationen zu der Größe und der Belegung der gewünschten Dateisystemen.<br>
- Seit Version 1.1.0 können Dateisysteme auch benannt werden (s.u.). <br>
- In diesem Fall werden für die diese Readings die angegebenen Namen verwendet.<br>
- Dies soll die Übersicht verbessern und die Erstellung von Plots erleichten.<br>
- Beispiel:<br>
- <code>fs_root: Total: 7340 MB, Used: 3573 MB, 52 %, Available: 3425 MB at /</code>
- </li>
- <br>
- <li>CPU Auslastung<br>
- Informationen zu der Auslastung der CPU(s).<br>
- Beispiel:<br>
- <code>stat_cpu: 10145283 0 2187286 90586051 542691 69393 400342</code><br>
- <code>stat_cpu_diff: 2151 0 1239 2522 10 3 761</code><br>
- <code>stat_cpu_percent: 4.82 0.00 1.81 93.11 0.05 0.00 0.20</code><br>
- <code>stat_cpu_text: user: 32.17 %, nice: 0.00 %, sys: 18.53 %, idle: 37.72 %, io: 0.15 %, irq: 0.04 %, sirq: 11.38 %</code>
- </li>
- <br>
- <li>Benutzerdefinierte Einträge<br>
- Diese Readings sind Ausgaben der Kommanden, die an das Betriebssystem übergeben werden.
- Die entsprechende Angaben werden durch Attributen <code>user-defined</code> und <code>user-fn</code> definiert.
- </li>
- <br>
- <b>FritzBox-spezifische Readings</b>
- <li>wlan_state<br>
- WLAN-Status: on/off
- </li>
- <br>
- <li>wlan_guest_state<br>
- Gast-WLAN-Status: on/off
- </li>
- <br>
- <li>internet_ip<br>
- aktuelle IP-Adresse
- </li>
- <br>
- <li>internet_state<br>
- Status der Internetverbindung: connected/disconnected
- </li>
- <br>
- <li>night_time_ctrl<br>
- Status der Klingelsperre on/off
- </li>
- <br>
- <li>num_new_messages<br>
- Anzahl der neuen Anrufbeantworter-Meldungen
- </li>
- <br>
- <li>fw_version_info<br>
- Angaben zu der installierten Firmware-Version: <VersionNr> <Erstelldatum> <Zeit>
- </li>
- <br>
- <b>DSL Informationen (FritzBox)</b>
- <li>dsl_rate<br>
- Down/Up Verbindungsgeschwindigkeit
- </li>
- <br>
- <li>dsl_synctime<br>
- Sync-Zeit mit Vermittlungsstelle
- </li>
- <br>
- <li>dsl_crc_15<br>
- Nicht behebbare Übertragungsfehler in den letzten 15 Minuten
- </li>
- <br>
- <li>dsl_fec_15<br>
- Behebbare Übertragungsfehler in den letzten 15 Minuten
- </li>
- <br>
- <b>Readings zur Stromversorgung</b>
- <li>power_ac_stat<br>
- Statusinformation für die AC-Buchse: online (0|1), present (0|1), voltage, current<br>
- Beispiel:<br>
- <code>power_ac_stat: 1 1 4.807 264</code><br>
- </li>
- <br>
- <li>power_ac_text<br>
- Statusinformation für die AC-Buchse in menschenlesbarer Form<br>
- Beispiel:<br>
- <code>power_ac_text ac: present / online, Voltage: 4.807 V, Current: 264 mA</code><br>
- </li>
- <br>
- <li>power_usb_stat<br>
- Statusinformation für die USB-Buchse
- </li>
- <br>
- <li>power_usb_text<br>
- Statusinformation für die USB-Buchse in menschenlesbarer Form
- </li>
- <br>
- <li>power_battery_stat<br>
- Statusinformation für die Batterie (wenn vorhanden): online (0|1), present (0|1), voltage, current, actual capacity<br>
- Beispiel:<br>
- <code>power_battery_stat: 1 1 4.807 264 100</code><br>
- </li>
- <br>
- <li>power_battery_text<br>
- Statusinformation für die Batterie (wenn vorhanden) in menschenlesbarer Form
- </li>
- <br>
- <li>power_battery_info<br>
- Menschenlesbare Zusatzinformationen für die Batterie (wenn vorhanden): Technologie, Kapazität, Status, Zustand, Gesamtkapazität<br>
- Beispiel:<br>
- <code>power_battery_info: battery info: Li-Ion , capacity: 100 %, status: Full , health: Good , total capacity: 2100 mAh</code><br>
- Die Kapazität soll in script.bin (z.B. ct-hdmi.bin) eingestellt werden (Parameter pmu_battery_cap). Mit bin2fex konvertieren (bin2fex -> script.fex -> edit -> fex2bin -> script.bin)<br>
- </li>
- <br>
- <li>cpuX_freq_stat<br>
- Frequenz-Statistik für die CPU X: Minimum, Maximum und Durchschnittswert<br>
- Beispiel:<br>
- <code>cpu0_freq_stat: 100 1000 900</code><br>
- </li>
- <br>
- <li>cpuX_idle_stat<br>
- Leerlaufzeit-Statistik für die CPU X: Minimum, Maximum und Durchschnittswert<br>
- Beispiel:<br>
- <code>cpu0_freq_stat: 23.76 94.74 90.75</code><br>
- </li>
- <br>
- <li>cpu[X]_temp_stat<br>
- Temperatur-Statistik für CPU: Minimum, Maximum und Durchschnittswert<br>
- Beispiel:<br>
- <code>cpu_temp_stat: 41.00 42.50 42.00</code><br>
- </li>
- <br>
- <li>ram_used_stat<br>
- Statistik der RAM-Nutzung: Minimum, Maximum und Durchschnittswert<br>
- Example:<br>
- <code>ram_used_stat: 267.55 1267.75 855.00</code><br>
- </li>
- <br>
- <li>swap_used_stat<br>
- Statistik der SWAP-Nutzung: Minimum, Maximum und Durchschnittswert<br>
- Example:<br>
- <code>swap_used_stat: 0 1024.00 250.00</code><br>
- </li>
- <br>
- <br>
- </ul>
- <br>
- <b>Get:</b><br><br>
- <ul>
- <li>interval<br>
- Listet die bei der Definition angegebene Polling-Intervalle auf.
- </li>
- <br>
- <li>interval_multipliers<br>
- Listet die definierten Multipliers.
- </li>
- <br>
- <li>list<br>
- Gibt alle Readings aus.
- </li>
- <br>
- <li>update<br>
- Aktualisiert alle Readings. Alle Werte werden neu abgefragt.
- </li>
- <br>
- <li>version<br>
- Zeigt die Version des SYSMON-Moduls.
- </li>
- <br>
- <br>
- <li>list_lan_devices<br>
- Listet bekannte Geräte im LAN (nur FritzBox).
- </li>
- </ul>
- <br>
- <b>Set:</b><br><br>
- <ul>
- <li>interval_multipliers<br>
- Definiert Multipliers (wie bei der Definition des Gerätes).
- </li>
- <br>
- <li>clean<br>
- Löscht benutzerdefinierbare Readings. Nach einem Update (oder nach der automatischen Aktualisierung) werden neue Readings generiert.<br>
- </li>
- <br>
- <li>clear <reading name><br>
- Löscht den Reading-Eintrag mit dem gegebenen Namen. Nach einem Update (oder nach der automatischen Aktualisierung)
- wird dieser Eintrag ggf. neu erstellt (falls noch definiert). Dieses Mechanismus erlaubt das gezielte Löschen nicht mehr benötigter
- benutzerdefinierten Einträge.<br>
- </li>
- <br>
- <li>password <Passwort><br>
- Definiert das Passwort für den Remote-Zugriff (i.d.R. nur einmalig notwendig).
- </li>
- <br>
- </ul>
- <br>
- <b>Attributes:</b><br><br>
- <ul>
- <li>filesystems <reading name>[:<mountpoint>[:<comment>]],...<br>
- Gibt die zu überwachende Dateisysteme an. Es wird eine kommaseparierte Liste erwartet.<br>
- Reading-Name wird bei der Anzeige und Logging verwendet, Mount-Point ist die Grundlage der Auswertung,
- Kommentar ist relevant für die HTML-Anzeige (s. SYSMON_ShowValuesHTML)<br>
- Beispiel: <code>/boot,/,/media/usb1</code><br>
- oder: <code>fs_boot:/boot,fs_root:/:Root,fs_usb1:/media/usb1:USB-Stick</code><br>
- Im Sinne der besseren Übersicht sollten zumindest Name und MountPoint angegeben werden.
- </li>
- <br>
- <li>network-interfaces <name>[:<interface>[:<comment>]],...<br>
- Kommaseparierte Liste der Netzwerk-Interfaces, die überwacht werden sollen.
- Jeder Eintrag besteht aus dem Reading-Namen, dem Namen
- des Netwerk-Adapters und einem Kommentar für die HTML-Anzeige (s. SYSMON_ShowValuesHTML). Wird kein Doppelpunkt verwendet,
- wird der Wert gleichzeitig als Reading-Name und Interface-Name verwendet.<br>
- Beispiel <code>ethernet:eth0:Ethernet,wlan:wlan0:WiFi</code><br>
- </li>
- <br>
- <li>user-defined <readingsName>:<Interval_Minutes>:<Comment>:<Cmd>,...<br>
- Diese kommaseparierte Liste definiert Einträge mit jeweils folgenden Daten:
- Reading-Name, Aktualisierungsintervall in Minuten, Kommentar und Betriebssystem-Commando.
- <br>Die BS-Befehle werden entsprechend des angegebenen Intervalls ausgeführt und als Readings mit den angegebenen Namen vermerkt.
- Kommentare werden für die HTML-Ausgaben (s. SYSMON_ShowValuesHTML) benötigt.
- <br>Alle Parameter sind nicht optional!
- <br>Es ist wichtig, dass die angegebenen Befehle schnell ausgeführt werden, denn in dieser Zeit wird der gesamte FHEM-Server blockiert!
- <br>Werden Ergebnisse der lang laufenden Operationen benötigt, sollten diese z.B als CRON-Job eingerichtet werden
- und in FHEM nur die davor gespeicherten Ausgaben visualisiert.<br><br>
- Beispiel: Anzeige der vorliegenden Paket-Aktualisierungen für das Betriebssystem:<br>
- In einem cron-Job wird folgendes täglich ausgeführt: <br>
- <code> sudo apt-get update 2>/dev/null >/dev/null</code>
- <code> apt-get upgrade --dry-run| perl -ne '/(\d*)\s[upgraded|aktualisiert]\D*(\d*)\D*install|^ \S+.*/ and print "$1 aktualisierte, $2 neue Pakete"' 2>/dev/null > /opt/fhem/data/updatestatus.txt</code>
- <br>
- Das Attribute <code>uder-defined</code> wird auf <br><code>sys_updates:1440:System Aktualisierungen:cat /opt/fhem/data/updatestatus.txt</code><br> gesetzt.
- Danach wird die Anzahl der verfügbaren Aktualisierungen täglich als Reading 'sys_updates' protokolliert.
- </li>
- <br>
- <li>user-fn <fn_name>:<Interval_Minutes>:<reading_name1>:<reading_name2>...[:<reading_nameX>],...<br>
- Liste der benutzerdefinierten Perlfunktionen.<br>
- Als <fn_name> können entweder Name einer Perlfunktion oder ein Perlausdruck verwendet werden.
- Die Perlfunktion bekommt den Device-Hash als Übergabeparameter und muss ein Array mit Werte liefern.
- Diese Werte werden entsprechend den Parameter <reading_nameX> in Readings übernommen.<br>
- Ein Perlausdruck muss in geschweifte Klammer eingeschlossen werden und kann folgende Paramter verwenden: $HASH (Device-Hash) und $NAME (Device-Name).
- Rückgabe wird analog einer Perlfunktion erwartet.<br>
- Wichtig! Die Trennung zwischen mehreren Benutzerfunktionen muss mit einem Komma UND einem Leerzeichen erfolgen! Innerhalb der Funktiondefinition dürfen Kommas nicht durch Leerzeichen gefolgt werden.
- </li>
- <br>
- <li>disable<br>
- Mögliche Werte: <code>0,1</code>. Bei <code>1</code> wird die Aktualisierung gestoppt.
- </li>
- <br>
- <li>telnet-prompt-regx, telnet-login-prompt-regx<br>
- RegExp zur Erkennung von Login- und Kommandozeile-Prompt. (Nur für Zugriffe über Telnet relevant.)
- </li>
- <br>
- <li>exclude<br>
- Erlaubt das Abfragen bestimmten Informationen zu unterbinden. <br>
- Mögliche Werte: user-defined (s. user-defined und user-fn), cpucount, uptime, fhemuptime,
- loadavg, cputemp, cpufreq, cpuinfo, diskstat, cpustat, ramswap, filesystem, network,
- fbwlan, fbnightctrl, fbnewmessages, fbdecttemp, fbversion, fbdsl, powerinfo
- </li>
- <br>
- </ul>
- <br>
- <b>Plots:</b><br><br>
- <ul>
- Für dieses Modul sind bereits einige gplot-Dateien vordefiniert:<br>
- <ul>
- FileLog-Versionen:<br>
- <code>
- SM_RAM.gplot<br>
- SM_CPUTemp.gplot<br>
- SM_FS_root.gplot<br>
- SM_FS_usb1.gplot<br>
- SM_Load.gplot<br>
- SM_Network_eth0.gplot<br>
- SM_Network_eth0t.gplot<br>
- SM_Network_wlan0.gplot<br>
- SM_CPUStat.gplot<br>
- SM_CPUStatSum.gplot<br>
- SM_CPUStatTotal.gplot<br>
- SM_power_ac.gplot<br>
- SM_power_usb.gplot<br>
- SM_power_battery.gplot<br>
- </code>
- DbLog-Versionen:<br>
- <code>
- SM_DB_all.gplot<br>
- SM_DB_CPUFreq.gplot<br>
- SM_DB_CPUTemp.gplot<br>
- SM_DB_Load.gplot<br>
- SM_DB_Network_eth0.gplot<br>
- SM_DB_RAM.gplot<br>
- </code>
- </ul>
- </ul>
- <br>
- <b>HTML-Ausgabe-Methode (für ein Weblink): SYSMON_ShowValuesHTML(<SYSMON-Instanz>[,<Liste>])</b><br><br>
- <ul>
- Das Modul definiert eine Funktion, die ausgewählte Readings in HTML-Format ausgibt. <br>
- Als Parameter wird der Name des definierten SYSMON-Geräts erwartet.<br>
- Es kann auch ReadingsGroup, CloneDummy oder andere Module genutzt werden, dann werden einfach deren Readings verwendet.<br>
- Der zweite Parameter ist optional und gibt eine Liste der anzuzeigende Readings
- im Format <code><ReadingName>[:<Comment>[:<Postfix>[:<FormatString>]]]</code> an.<br>
- Dabei gibt <code>ReadingName</code> den anzuzeigenden Reading an, der Wert aus <code>Comment</code> wird als der Anzeigename verwendet
- und <code>Postfix</code> wird nach dem eihentlichen Wert angezeigt (so können z.B. Einheiten wie MHz angezeigt werden).
- Mit Hilfe von FormatString kann die Ausgabe beeinflusst werden (s. sprintf in PerlDoku).<br>
- Falls kein <code>Comment</code> angegeben ist, wird eine intern vordefinierte Beschreibung angegeben.
- Bei benutzerdefinierbaren Readings wird ggf. <code>Comment</code> aus der Definition verwendet.<br>
- Wird keine Liste angegeben, wird eine vordefinierte Auswahl verwendet (alle Werte).<br><br>
- <code>define sysv1 weblink htmlCode {SYSMON_ShowValuesHTML('sysmon')}</code><br>
- <code>define sysv2 weblink htmlCode {SYSMON_ShowValuesHTML('sysmon', ('date:Datum', 'cpu_temp:CPU Temperatur: °C', 'cpu_freq:CPU Frequenz: MHz'))}</code>
- </ul>
- <br>
- <b>HTML-Ausgabe-Methode (für ein Weblink): SYSMON_ShowValuesHTMLTitled(<SYSMON-Instance>[,<Title>,<Liste>])</b><br><br>
- <ul>
- Wie SYSMON_ShowValuesHTML, aber mit einer Überschrift darüber. Wird keine Überschrift angegeben, wird alias des Moduls genutzt (falls definiert).<br>
- </ul>
- <br>
- <b>Text-Ausgabe-Methode (see Weblink): SYSMON_ShowValuesText(<SYSMON-Instance>[,<Liste>])</b><br><br>
- <ul>
- Analog SYSMON_ShowValuesHTML, jedoch formatiert als reines Text.<br>
- </ul>
- <br>
- <b>HTML-Ausgabe-Methode (für ein Weblink): SYSMON_ShowValuesTextTitled(<SYSMON-Instance>[,<Title>,<Liste>])</b><br><br>
- <ul>
- Wie SYSMON_ShowValuesText, aber mit einer Überschrift darüber.<br>
- </ul>
- <br>
- <b>Readings-Werte mit Perl lesen: SYSMON_getValues(<name>[, <Liste der gewünschten Schlüssel>])</b><br><br>
- <ul>
- Liefert ein Hash-Ref mit den gewünschten Werten. Wenn keine Liste (array) übergeben wird, werden alle Werte geliefert.<br>
- {(SYSMON_getValues("sysmon"))->{'cpu_temp'}}<br>
- {(SYSMON_getValues("sysmon",("cpu_freq","cpu_temp")))->{"cpu_temp"}}<br>
- {join(" ", values (SYSMON_getValues("sysmon")))}<br>
- {join(" ", values (SYSMON_getValues("sysmon",("cpu_freq","cpu_temp"))))}<br>
- </ul>
- <br>
- <b>Beispiele:</b><br><br>
- <ul>
- <code>
- # Modul-Definition<br>
- define sysmon SYSMON 1 1 1 10<br>
- #attr sysmon event-on-update-reading cpu_temp,cpu_temp_avg,cpu_freq,eth0_diff,loadavg,ram,^~ /.*usb.*,~ /$<br>
- attr sysmon event-on-update-reading cpu_temp,cpu_temp_avg,cpu_freq,eth0_diff,loadavg,ram,fs_.*,stat_cpu_percent<br>
- attr sysmon filesystems fs_boot:/boot,fs_root:/:Root,fs_usb1:/media/usb1:USB-Stick<br>
- attr sysmon network-interfaces eth0:eth0:Ethernet,wlan0:wlan0:WiFi<br>
- attr sysmon group RPi<br>
- attr sysmon room 9.03_Tech<br>
- <br>
- # Log<br>
- define FileLog_sysmon FileLog ./log/sysmon-%Y-%m.log sysmon<br>
- attr FileLog_sysmon group RPi<br>
- attr FileLog_sysmon logtype SM_CPUTemp:Plot,text<br>
- attr FileLog_sysmon room 9.03_Tech<br>
- <br>
- # Visualisierung: CPU-Temperatur<br>
- define wl_sysmon_temp SVG FileLog_sysmon:SM_CPUTemp:CURRENT<br>
- attr wl_sysmon_temp group RPi<br>
- attr wl_sysmon_temp label "CPU Temperatur: Min $data{min2}, Max $data{max2}, Last $data{currval2}"<br>
- attr wl_sysmon_temp room 9.03_Tech<br>
- <br>
- # Visualisierung: Netzwerk-Datenübertragung für eth0<br>
- define wl_sysmon_eth0 SVG FileLog_sysmon:SM_Network_eth0:CURRENT<br>
- attr wl_sysmon_eth0 group RPi<br>
- attr wl_sysmon_eth0 label "Netzwerk-Traffic eth0: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"<br>
- attr wl_sysmon_eth0 room 9.03_Tech<br>
- <br>
- # Visualisierung: Netzwerk-Datenübertragung für wlan0<br>
- define wl_sysmon_wlan0 SVG FileLog_sysmon:SM_Network_wlan0:CURRENT<br>
- attr wl_sysmon_wlan0 group RPi<br>
- attr wl_sysmon_wlan0 label "Netzwerk-Traffic wlan0: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"<br>
- attr wl_sysmon_wlan0 room 9.03_Tech<br>
- <br>
- # Visualisierung: CPU-Auslastung (load average)<br>
- define wl_sysmon_load SVG FileLog_sysmon:SM_Load:CURRENT<br>
- attr wl_sysmon_load group RPi<br>
- attr wl_sysmon_load label "Load Min: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"<br>
- attr wl_sysmon_load room 9.03_Tech<br>
- <br>
- # Visualisierung: RAM-Nutzung<br>
- define wl_sysmon_ram SVG FileLog_sysmon:SM_RAM:CURRENT<br>
- attr wl_sysmon_ram group RPi<br>
- attr wl_sysmon_ram label "RAM-Nutzung Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"<br>
- attr wl_sysmon_ram room 9.03_Tech<br>
- <br>
- # Visualisierung: Dateisystem: Root-Partition<br>
- define wl_sysmon_fs_root SVG FileLog_sysmon:SM_FS_root:CURRENT<br>
- attr wl_sysmon_fs_root group RPi<br>
- attr wl_sysmon_fs_root label "Root Partition Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"<br>
- attr wl_sysmon_fs_root room 9.03_Tech<br>
- <br>
- # Visualisierung: Dateisystem: USB-Stick<br>
- define wl_sysmon_fs_usb1 SVG FileLog_sysmon:SM_FS_usb1:CURRENT<br>
- attr wl_sysmon_fs_usb1 group RPi<br>
- attr wl_sysmon_fs_usb1 label "USB1 Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"<br>
- attr wl_sysmon_fs_usb1 room 9.03_Tech<br>
- <br>
- # Anzeige der Readings zum Einbinden in ein 'Raum'.<br>
- define SysValues weblink htmlCode {SYSMON_ShowValuesHTML('sysmon')}<br>
- attr SysValues group RPi<br>
- attr SysValues room 9.03_Tech<br>
- <br>
- # Anzeige CPU Auslasung<br>
- define wl_sysmon_cpustat SVG FileLog_sysmon:SM_CPUStat:CURRENT<br>
- attr wl_sysmon_cpustat label "CPU(min/max): user:$data{min1}/$data{max1} nice:$data{min2}/$data{max2} sys:$data{min3}/$data{max3} idle:$data{min4}/$data{max4} io:$data{min5}/$data{max5} irq:$data{min6}/$data{max6} sirq:$data{min7}/$data{max7}"<br>
- attr wl_sysmon_cpustat group RPi<br>
- attr wl_sysmon_cpustat room 9.99_Test<br>
- attr wl_sysmon_cpustat plotsize 840,420<br>
- define wl_sysmon_cpustat_s SVG FileLog_sysmon:SM_CPUStatSum:CURRENT<br>
- attr wl_sysmon_cpustat_s label "CPU(min/max): user:$data{min1}/$data{max1} nice:$data{min2}/$data{max2} sys:$data{min3}/$data{max3} idle:$data{min4}/$data{max4} io:$data{min5}/$data{max5} irq:$data{min6}/$data{max6} sirq:$data{min7}/$data{max7}"<br>
- attr wl_sysmon_cpustat_s group RPi<br>
- attr wl_sysmon_cpustat_s room 9.99_Test<br>
- attr wl_sysmon_cpustat_s plotsize 840,420<br>
- define wl_sysmon_cpustatT SVG FileLog_sysmon:SM_CPUStatTotal:CURRENT<br>
- attr wl_sysmon_cpustatT label "CPU-Auslastung"<br>
- attr wl_sysmon_cpustatT group RPi<br>
- attr wl_sysmon_cpustatT plotsize 840,420<br>
- attr wl_sysmon_cpustatT room 9.99_Test<br>
- <br>
- # Anzeige Stromversorgung AC<br>
- define wl_sysmon_power_ac SVG FileLog_sysmon:SM_power_ac:CURRENT<br>
- attr wl_sysmon_power_ac label "Stromversorgung (ac) Spannung: $data{min1} - $data{max1} V, Strom: $data{min2} - $data{max2} mA"<br>
- attr wl_sysmon_power_ac room Technik<br>
- attr wl_sysmon_power_ac group system<br>
- # Anzeige Stromversorgung Battery<br>
- define wl_sysmon_power_bat SVG FileLog_sysmon:SM_power_battery:CURRENT<br>
- attr wl_sysmon_power_bat label "Stromversorgung (bat) Spannung: $data{min1} - $data{max1} V, Strom: $data{min2} - $data{max2} mA"<br>
- attr wl_sysmon_power_bat room Technik<br>
- attr wl_sysmon_power_bat group system<br>
- </code>
- </ul>
- </ul>
- <p><a name="SYSSTAT"></a>
- <h3>SYSSTAT</h3>
- <div class='langLinks'>[<a href='commandref.html#SYSSTAT'>EN</a> DE]</div>
- <ul>
- Das Modul stellt Systemstatistiken für den Rechner, auf dem FHEM läuft bzw.
- für ein entferntes Linux System, das per vorkonfiguriertem ssh Zugang ohne Passwort
- erreichbar ist, zur Vefügung.<br><br>
- Notes:
- <ul>
- <li>Dieses Modul benötigt <code>Sys::Statistics::Linux</code> für Linux.<br>
- Es kann mit '<code>cpan install Sys::Statistics::Linux</code>'<br>
- bzw. auf Debian mit '<code>apt-get install libsys-statistics-linux-perl</code>'
- installiert werden.</li>
- <li>Um einen Zielrechner mit snmp zu überwachen, muss
- <code>Net::SNMP</code> installiert sein.<br></li>
- <li>Um die Lastwerte zu plotten, kann der folgende Code verwendet werden:
- <pre>
- define sysstatlog FileLog /usr/local/FHEM/var/log/sysstat-%Y-%m.log sysstat
- attr sysstatlog nrarchive 1
- define svg_sysstat SVG sysstatlog:sysstat:CURRENT
- attr wl_sysstat label "Load Min: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"
- attr wl_sysstat room System
- </pre></li>
- <li>Um das Wurzel-Dateisystem (Mountpunkt '/') bei Plots der Plattennutzung zu erhalten,
- sollte dieser Code '<code>#FileLog 4:/\x3a:0:</code>' bzw. '<code>#FileLog 4:\s..\s:0:</code>'
- und <b>nicht</b> dieser Code '<code>#FileLog 4:/:0:</code>' verwendet werden, da der letztere
- alle Mountpunkte darstellt.</li>.
- </ul>
- <a name="SYSSTAT_Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> SYSSTAT [<interval> [<interval_fs>] [<host>]]</code><br>
- <br>
- definiert ein SYSSTAT Device.<br><br>
- Die (Prozessor)last wird alle <interval> Sekunden aktualisiert. Standard bzw. Minimum ist 60.<br><br>
- Die Plattennutzung wird alle <interval_fs> Sekunden aktualisiert. Standardwert ist <interval>*60
- und Minimum ist 60.
- <interval_fs> wird nur angenähert und funktioniert am Besten, wenn <interval_fs>
- ein ganzzahliges Vielfaches von <interval> ist.<br><br>
- Wenn <host> angegeben wird, muss der Zugang per ssh ohne Passwort möglich sein.<br><br>
- Beispiele:
- <ul>
- <code>define sysstat SYSSTAT</code><br>
- <code>define sysstat SYSSTAT 300</code><br>
- <code>define sysstat SYSSTAT 60 600</code>
- </ul>
- </ul><br>
- <a name="SYSSTAT_Readings"></a>
- <b>Readings</b>
- <ul>
- <li>load<br>
- die durchschnittliche (Prozessor)last der letzten 1 Minute (für Windows Rechner mit
- snmp angenähertem Wert)</li>
- <li>state<br>
- die durchschnittliche (Prozessor)last der letzten 1, 5 und 15 Minuten (für Windows
- Rechner die Nutzung pro CPU via snmp ermittelt)</li>
- <li>user, system, idle, iowait<br>
- den Prozentsatz der entsprechenden Systemlast (nur für Linux Systeme)</li>
- <li><mountpoint><br>
- Anzahl der freien Bytes für <mountpoint></li>
- </ul><br>
- <a name="SYSSTAT_Get"></a>
- <b>Get</b>
- <ul>
- <code>get <name> <value></code>
- <br><br>
- Werte für <code>value</code> sind<br><br>
- <li>filesystems<br>
- zeigt die Dateisysteme an, die überwacht werden können.</li>
- </ul><br>
- <a name="SYSSTAT_Attr"></a>
- <b>Attributes</b>
- <ul>
- <li>disable<br>
- lässt die Timer weiterlaufen, aber stoppt die Speicherung der Daten.</li>
- <li>filesystems<br>
- Liste mit Komma getrennten Dateisystemen (nicht Mountpunkten) die überwacht
- werden sollen.<br>
- Beispiele:
- <ul>
- <code>attr sysstat filesystems /dev/md0,/dev/md2</code><br>
- <code>attr sysstat filesystems /dev/.*</code><br>
- <code>attr sysstat filesystems 1,3,5</code><br>
- </ul></li>
- <li>mibs<br>
- Leerzeichen getrennte Liste aus <mib>:<reding> Paaren die abgefragt werden sollen.</li>
- <li>showpercent<br>
- Wenn gesetzt, wird die Nutzung in Prozent angegeben. Wenn nicht gesetzt, wird der verfübare
- Platz in Bytes angezeigt.</li>
- <li>snmp<br>
- 1 -> snmp wird verwendet, um Last, Einschaltzeit und Dateisysteme (inkl. physikalischem und
- virtuellem Speicher) zu überwachen</li>
- <li>stat<br>
- 1 -> überwacht Prozentsatz der user, system, idle und iowait Last
- (nur auf Linux Systemen verfügbar)</li>
- <li>raspberrytemperature<br>
- Wenn gesetzt und > 0 wird der Temperatursensor auf dem Raspberry Pi ausgelesen.<br>
- Wenn Wert 2 ist, wird ein geometrischer Durchschnitt der letzten 4 Werte dargestellt.</li>
- <li>synologytemperature<br>
- Wenn gesetzt und > 0 wird die Temperatur einer Synology Diskstation ausgelesen (erfordert snmp).<br>
- Wenn Wert 2 ist, wird ein geometrischer Durchschnitt der letzten 4 Werte dargestellt.</li>
- <li>raspberrycpufreq<br>
- Wenn gesetzt und > 0 wird die Raspberry Pi CPU Frequenz ausgelesen.</li>
- <li>uptime<br>
- Wenn gesetzt und > 0 wird die Betriebszeit (uptime) des Systems ausgelesen.<br>
- Wenn Wert 2 ist, wird die Betriebszeit (uptime) in Sekunden angezeigt.</li>
- <li>useregex<br>
- Wenn Wert gesetzt, werden die Einträge der Dateisysteme als regex behandelt.</li>
- <li>ssh_user<br>
- Der Username für den ssh Zugang auf dem entfernten Rechner.</li>
- <li>snmpVersion</li>
- <li>snmpCommunity</li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- </ul>
- <p><a name="SingleFileLog"></a>
- <h3>SingleFileLog</h3>
- <div class='langLinks'>[<a href='commandref.html#SingleFileLog'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="SingleFileLogdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> SingleFileLog <filename> <regexp>
- </code>
- <br><br>
- Fü jedes Event oder Gerätename:Event, worauf <regexp>
- zutrifft, wird eine separate Datei angelegt, der Inhalt wird von dem
- template Attribut gesteuert (s.u.).
- <code><filename></code> kann %-Wildcards der POSIX strftime-Funktion
- des darunterliegenden OS enthalten (siehe auch man strftime).
- Zusätzlich wird %Q durch eine fortlaufende Zahl ersetzt.<br>
- Falls filename in {} eingeschlossen ist, dann wird sie als perl-Ausdruck
- ausgewertet, was ermöglicht einen vom %L abweichenden globalem Pfad zu
- definieren.
- </ul>
- <br>
- <a name="SingleFileLogset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="SingleFileLogget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="SingleFileLogattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#addStateEvent">addStateEvent</a></li><br>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li><br>
- <li><a href="#dosLineEnding">dosLineEnding</a><br>
- Erzeugt die Datei mit der auf Windows Systemen ueblichen Zeilenenden
- (\r\n)
- </li><br>
- <li><a name="#numberFormat">numberFormat</a><br>
- Falls ein Wort im Event wie eine Zahl aussieht, dann wird es wie in
- numberFormat angegeben, umformatiert, und als $EVTNUMx (analog zu
- $EVTPARTx) zur Verfügung gestellt. Voreinstellung ist %1.6E, siehe
- die printf Formatbeschreibung für Details.
- </li><br>
- <li><a name="#readySuffy">readySuffix</a><br>
- Die in der Definition spezifizierte Datei wird mit dem Suffix .tmp
- angelegt, und nachdem sie fertig ist, mit readySuffix umbenannt.
- Die Voreinstellung ist .rdy; um kein Suffix zu erzeugen, muss man none
- spezifizieren.
- </li><br>
- <li><a name="#syncAfterWrite">syncAfterWrite</a><br>
- Zwingt das Betriebssystem die Datei sofort auf die Platte zu schreiben.
- Achtung: das kann die Geschwindigkeit beeinträchtigen, und bei SSDs
- zu einem früheren Ausfall führen. Die Voreinstellung ist 0
- (aus).
- </li><br>
- <li><a name="#template">template</a><br>
- Damit wird der Inhalt der geschriebenen Datei spezifiziert. Folgende
- Variablen werden vor dem Schreiben der Datei ersetzt:
- <ul>
- <li>$EVENT - das vollständige Event.</li>
- <li>$EVTPART0 $EVTPART1 ... - die einzelnen Wörter des Events.</li>
- <li>$EVTNUM0 $EVTNUM1 ... - umformatiert als Zahl, siehe numberFormat
- weiter oben.</li>
- <li>$NAME - der Name des Gerätes, das das Event generiert.</li>
- <li>$time - die aktuelle Zeit, formatiert als YYYY-MM-DD HH:MM:SS</li>
- <li>$time14 - die aktuelle Zeit, formatiert als YYYYMMDDHHMMSS</li>
- <li>$time16 - die aktuelle Zeit, formatiert als YYYYMMDDHHMMSSCC,
- wobei CC die hundertstel Sekunde ist</li>
- </ul>
- Falls template in {} eingeschlossen ist, dann wird er als perl-Ausdruck
- ausgefuehrt, und das Ergebnis wird in die Datei geschrieben.<br>
- Die Voreinstellung ist $time $NAME $EVENT\n
- </li><br>
- <li><a name="#writeInBackground">writeInBackground</a><br>
- falls gesetzt (auf 1), dann erfolgt das Schreiben in einem
- Hintergrundprozess, um FHEM nicht zu blockieren. Die Voreinstellung ist 0
- (aus).
- </li><br>
- </ul>
- <br>
- </ul>
- <p>
- <a name="Siro"></a>
- <h3>Siro protocol</h3>
- <div class='langLinks'>[<a href='commandref.html#Siro'>EN</a> DE]</div>
- <ul>
-
- <br> Ein <a href="#SIGNALduino">SIGNALduino</a>-Geraet (dieses sollte als erstes angelegt sein).<br>
-
- <br>
- Da sich die Protokolle von Siro und Dooya sehr ähneln, ist ein gleichzeitiger Betrieb dieser Systeme ueber ein "IODev" derzeit schwierig. Das Senden von Befehlen funktioniert ohne Probleme, aber das Unterscheiden der Fernbedienungssignale ist in Signalduino kaum möglich. Zum Betrieb der Siromoduls wird daher empfohlen, das Dooyaprotokoll im SIGNALduino (16) über die Whitelist auszuschliessen. Zur fehlerfreien Erkennung der Fernbedienungssignale ist es weiterhin erforderlich im SIGMALduino das Protokoll "manchesterMC" zu deaktivieren (disableMessagetype manchesterMC). Wird der Empfang von machestercodierten Befehlen benoetigt, wird der Betrieb eines zweiten Signalduinos empfohlen.<br>
- <br>
- <br>
-
- <a name="Sirodefine"></a>
- <br>
- <b>Define</b>
- <br>
- <ul>
- <code>define <name> Siro <id> <channel></code>
- <br>
- <br>
- Bei der <code><ID></code> handelt es sich um einen 7-stelligen Hexcode, der einer Siro Fernbedienung eindeutig und fest zugewiesen ist. <code><Channel></code> ist die einstellige Kanalzuweisung der Fernbedienung und ist ebenfalls hexadezimal. Somit ergeben sich die möglichen Kanäle 0 - 15 (hexadezimal 0-F).
- Eine eindeutige ID muss angegeben werden, der Kanal (Channel) muss ebenfalls angegeben werden. <br>
- Ein Autocreate (falls aktiviert), legt das Device mit der ID der Fernbedienung und dem Kanal automatisch an.
- <br><br>
- Beispiele:<br><br>
- <ul>
- <code>define Siro1 Siro AB00FC1</code><br> erstellt ein Siro-Geraet Siro1 mit der ID: AB00FC und dem Kanal: 1<br>
- </ul>
- </ul>
- <br>
- <a name="Siroset"></a>
- <b>Set </b><br>
- <ul>
- <code>set <name> <value> [<position>]</code>
- <br><br>
- where <code>value</code> is one of:<br>
- <pre>
- on
- off
- stop
- pos (0..100)
- prog
- fav
- </pre>
-
- Beispiele:<br><br>
- <ul>
- <code>set Siro1 on</code><br>
- <code>set Siro1 off</code><br>
- <code>set Siro1 position 50</code><br>
- <code>set Siro1 fav</code><br>
- <code>set Siro1 stop</code><br>
- <code>set Siro1 set_favorite</code><br>
- <code>set Siro1 down_for_timer 5</code><br>
- <code>set Siro1 up_for_timer 5</code><br>
- <code>set Siro1 set_favorite</code><br>
- </ul>
- <br>
- <ul>
- set Siro1 on fährt das Rollo komplett hoch (0%)<br>
- set Siro1 off fährt das Rollo komplett herunter (100%)<br>
- set Siro1 stop stoppt die aktuelle Fahrt des Rollos<br>
- set Siro1 position 45 fährt das Rollo zur angegebenen Position (45%)<br>
- set Siro1 45 fährt das Rollo zur angegebenen Position (45%)<br>
- set Siro1 fav fährt das Rollo in die hardwaremässig programmierte Mittelposition<br>
- et Siro1 down_for_timer 5 fährt das Rollo 5 Sekunden nach unten<br>
- et Siro1 uown_for_timer 5 fährt das Rollo 5 Sekunden nach oben<br>
- set Siro1 prog entspricht der "P2" Taste der Fernbedienung. Das Modul wird in den Programmiermodus versetzt (3 Min.)<br>
- set Siro1 set_favorite programmiert den aktuellen Rollostand als Hardwaremittelposition, das ATTR time_down_to_favorite wird neu berechnet und gesetzt. <br>
- </ul>
- <br>
- Hinweise:<br><br>
- <ul>
- <li>Befindet sich das Modul im Programmiermodus, werden aufeinanderfolgende Stoppbefehle vom Modul erkannt, da diese zur Programmierung zwingend erforderlich sind. In diesem Modus werden die Readings und das State nicht aktualisiert. Der Modus wird nach 3 Minuten automatisch beendet. Die verbleibende Zeit im Programmiermodus wird im Reading "pro_mode" dargestellt. Die Programmierung des Rollos muss in dieser Zeit abgeschlossen sein, da das Modul andernfalls keine aufeinanderfolgenden Stoppbefehle mehr akzeptiert.
- Die Anzeige der Position, des States, ist eine ausschliesslich rechnerisch ermittelte Position, da es keinen Rückkanal zu Statusmeldung gibt. Aufgrund eines ggf. verpassten Fernbedienungsbefehls, Timingproblems etc. kann es vorkommen, dass diese Anzeige ggf. mal falsche Werte anzeigt. Bei einer Fahrt in eine Endposition, ohne die Fahrt zu stoppen (set Siro1 [on/off]), werden Statusanzeige und echte Position bei Erreichen der Position jedes Mal synchronisiert. Diese ist der Hardware geschuldet und technisch leider nicht anders lösbar.
- </li>
- </ul>
- </ul>
- <br>
- <b>Get</b>
- <ul>N/A</ul><br>
- <a name="Siroattr"></a>
- <b>Attributes</b><br><br>
- <ul>
- <a name="IODev"></a>
- <li>IODev<br>
- Das IODev muss das physische Gerät zum Senden und Empfangen der Signale enthalten. Derzeit wird ein SIGNALduino bzw. SIGNALesp unterstützt.
- Ohne der Angabe des "Sende- und Empfangsmodul" "IODev" ist keine Funktion moeglich.</li><br>
-
- <a name="channel_send_mode_1 "></a>
- <li>channel_send_mode_1 <br>
- Beinhaltet den Kanal, der vom Modul im "operation_mode 1" zum Senden genutzt wird.
- Dieses Attribut wird in "operation_mode 0" nicht genutzt
- </li><br>
-
- <a name="down_limit_mode_1 "></a>
- <li>down_limit_mode_1 <br>
- Bei gesetztem Attribut wird das Rollo bei einem Fahrt nach unten nur bis zur angegebenen Position gefahren, egal ob das Kommando über das Modul oder die Fernbedienung ausgloest wurde. Diese Funktion ist nur im Mode 1 aktiv.
- </li><br>
-
- <a name="down_auto_stop "></a>
- <li>down_auto_stop <br>
- Bei gesetztem Attribut fährt das Rollo bei einer Fahrt nach unten nur bis zur angegebenen Position. Eine weiterfahrt erfolgt nach nochmaligem Befehl. Diese Funktion greift nur bei dem Kommando on ( close ) . Hierbei ist es egal, ob das Kommando über das Modul oder die Fernbedienung ausgelöst wird.
- </li><br>
- <a name="operation_mode"></a>
- <li>operation_mode<br>
- Mode 0<br><br>
- Dies ist der Standardmodus. In diesem Modus nutz das Modul nur den Kanal, der von der Fernbedienung vorgegeben ist. Hier kann es durch von FHEM verpasste Signale, Timingproblemen etc. im schlechtesten Fall zu falschen States und Positionsreadings kommen. Diese werden bei Anfahrt einer Endposition wieder synchronisiert.
- <br><br>Mode 1<br><br>
- Erweiterter Modus. In diesem Modus nutzt das Modul zwei Kanäle. Den Standardkanal "channel" zum Empfangen der Fernbedienung. Dieser sollte nicht mehr durch das Rollo selbst empfangen werden. Und den "channel_send_mode_1", zum Senden an den Rollomotor. Hierzu ist eine Umkonfigurierung des Motors erforderlich. Dieser Modus ist in Bezug auf die Darstellung der States "deutlich sicherer", da ein Verpassen eines Signals durch FHEM nicht dazu führt, das falsche Positionen angezeigt werden. Das Rollo fährt nur dann, wenn FHEM das Signal empfangen hat und an den Motor weiterreicht.
- Eine Anleitung zur Konfiguration des Motors folgt.
- </li><br>
- <a name="time_down_to_favorite"></a>
- <li>time_down_to_favorite<br>
- beinhaltet die Fahrtzeit in Sekunden, die das Rollo von der 0% Position bis zur Hardware-Favoriten-Mittelposition benötigt. Diese Zeit muss manuell gemessen werden und eingetragen werden.
- Ohne dieses Attribut ist das Modul nur eingeschränkt funktionsfähig.</li><br>
- <a name="time_to_close"></a>
- <li>time_to_close<br>
- beinhaltet die Fahrtzeit in Sekunden, die das Rollo von der 0% Position bis zur 100% Position benötigt. Diese Zeit muss manuell gemessen werden und eingetragen werden.
- Ohne dieses Attribut ist das Modul nur eingeschränkt funktionsfähig.</li><br>
- <a name="time_to_open"></a>
- <li>time_to_open<br>
- beinhaltet die Fahrtzeit in Sekunden, die das Rollo von der 100% Position bis zur 0% Position benötigt. Diese Zeit muss manuell gemessen werden und eingetragen werden.
- Ohne dieses Attribut ist das Modul nur eingeschränkt funktionsfähig.</li><br>
- <a name="prog_fav_sequence"></a>
- <li>prog_fav_sequence<br>
- beinhaltet die Kommandosequenz zum Programmieren der Harware-Favoritenposition</li><br>
- <a name="debug_mode [0:1]"></a>
- <li>debug_mode [0:1] <br>
- Im Mode 1 werden zusätzliche Readings zur Fehlerbehebung angelegt, in denen die Ausgabe aller Modulelemente ausgegeben werden. Kommandos werden NICHT physisch gesendet.</li><br>
-
- <a name="Info"></a>
- <li>Info<br>
- Die Attribute webcmd und devStateIcon werden beim Anlegen des Devices einmalig gesetzt und im auch im Betrieb an den jeweiligen Mode des Devices angepasst. Die Anpassung dieser Inhalte geschieht nur solange, bis diese durch den Nutzer geändert wurden. Danach erfolgt keine automatische Anpassung mehr.</li><br>
- </ul>
- </ul>
- <p><a name="SmartMeterP1"></a>
- <h3>SmartMeterP1</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#SmartMeterP1'>SmartMeterP1</a><br/>
- </ul>
- <a name="SmartPi"></a>
- <h3>SmartPi</h3>
- <div class='langLinks'>[<a href='commandref.html#SmartPi'>EN</a> DE]</div>
- <p><a name="Snapcast"></a>
- <h3>Snapcast</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Snapcast'>Snapcast</a><br/>
- </ul>
- <a name="Spotify"></a>
- <h3>Spotify</h3>
- <div class='langLinks'>[<a href='commandref.html#Spotify'>EN</a> DE]</div>
- <ul>
- Das <i>Spotify</i> Modul ermöglicht die Steuerung von Spotify (Connect).<br>
- Um die Wiedergabe zu steuern, wird die Spotify WEB API verwendet. Dafür wird eine eigene <a target="_blank" rel="nofollow" href="https://developer.spotify.com/my-applications/#!/applications/create">Spotify API application</a> benötigt.<br>
- Während der Erstellung muss eine <i>redirect_uri</i> angegeben - standardmäßig wird vom Modul <a href="https://oskar.pw/" target="_blank">https://oskar.pw/</a> verwendet, da diese Seite nach der Anmeldung den Code in leserlicher Form ausgibt.<br>
- Die Seite kann bedenkenlos verwendet werden, da der Code ohne <i>client_secret</i> nutzlos und nur wenige Minuten gültig ist.<br>
- Wenn du diese verwenden willst, stelle sicher, diese bei der Erstellung anzugeben (wichtig: das Hinzufügen der URL muss mit <b>add</b> und <b>save</b> bestätigt werden), ansonsten kann jede beliebige andere Seite verwendet werden und der Code aus der URL extrahiert werden.<br>
- <br>
- <a name="Spotify_define"></a>
- <p><b>Define</b></p>
- <ul>
- <code>define <name> Spotify <client_id> <client_secret> [ <redirect_url> ]</code><br>
- </ul>
- <br>
- <ul>
- Beispiel: <code>define Spotify Spotify f88e5f5c2911152d914391592e717738 301b6d1a245e4fe01c2f8b4efd250756</code><br>
- </ul>
- <br>
- Sobald das Gerät angelegt wurde, muss die <i>AUTHORIZATION_URL</i> im Browser geöffnet werden und die Anmeldung mit Spotify erfolgen.<br>
- Sollte der Fehler <b>redirect_uri mismatch</b> auftauchen, stelle sicher, dass <a href="https://oskar.pw/" target="_blank">https://oskar.pw/</a> als <i>redirect_uri</i> hinzugefügt wurde oder die verwendete URL <b>exakt übereinstimmt</b>.<br>
- Sobald der Anmeldecode ermittelt wurde, führe folgenden Befehl aus: <code>set <name> code <code></code> - der Status sollte nun auf connected wechseln und das Gerät ist einsatzbereit.<br>
- <br>
- <a name="Spotify_set"></a>
- <p><b>set <required> [ <optional> ]</b></p>
- Wird kein Zielgerät angegeben, wird das aktive (oder das Standard-Gerät, wenn <i>alwaysStartOnDefaultDevice</i> aktiviert ist) verwendet.<br>
- An den Stellen, wo eine <i><device_id></i> verlangt wird, kann auch der Gerätename, sofern dieser keine Leerzeichen enthält, verwendet werden. Dort wo es <i><device_name></i> heißt, sind auch Leerzeichen im Namen zugelassen.
- Wenn kein aktives oder Standard-Gerät vorhanden ist, wird das erste verfügbare Gerät verwendet.<br>
- Die Spotify URI kann in der (Desktop) App ermittelt werden, wenn man den teilen Knopf bei einem Track/Playlist/Album drückt.<br><br>
- <ul>
- <li>
- <i>findArtistByName</i><br>
- sucht einen Künstler und liefert das Ergebnis in den Readings
- </li>
- <li>
- <i>findTrackByName</i><br>
- sucht einen Track und liefert das Ergebnis in den Readings
- </li>
- <li>
- <i>pause</i><br>
- pausiert die aktuelle Wiedergabe
- </li>
- <li>
- <i>playArtistByName <artist_name> [ <device_id> ]</i><br>
- sucht einen Künstler und spielt dessen Tracks ab
- </li>
- <li>
- <i>playContextByURI <context_uri> [ <nr_of_start_track> ] [ <device_id / device_name> ]</i><br>
- spielt einen Context (Playlist, Album oder Künstler) durch Angabe der URI ab
- </li>
- <li>
- <i>playPlaylistByName <playlist_name> [ <device_id> ]</i><br>
- sucht eine Playlist und spielt diese ab
- </li>
- <li>
- <i>playRandomTrackFromPlaylistByURI <playlist_uri> [ <limit> ] [ <device_id / device_name> ]</i><br>
- spielt einen zufälligen Track aus einer Playlist ab (berücksichtigt nur die ersten <i><limit></i> Tracks der Playlist)
- </li>
- <li>
- <i>playSavedTracks [ <nr_of_start_track> ] [ <device_id / device_name> ]</i><br>
- spielt die gespeicherten Tracks ab (beginnend mit Track Nummer <i><nr_of_start_track></i>)
- </li>
- <li>
- <i>playTrackByName <track_name> [ <device_id> ]</i><br>
- sucht den Song und spielt ihn ab
- </li>
- <li>
- <i>playTrackByURI <track_uri> [ <device_id / device_name> ]</i><br>
- spielt einen Song durch Angabe der URI ab
- </li>
- <li>
- <i>repeat <track,context,off></i><br>
- setzt den Wiederholungsmodus: entweder <i>one</i>, <i>all</i> (Playlist, Album, Künstler) oder <i>off</i>
- </li>
- <li>
- <i>resume [ <device_id / device_name> ]</i><br>
- fährt mit der Wiedergabe (auf einem Gerät) fort
- </li>
- <li>
- <i>seekToPosition <position></i><br>
- spult an die Position <i><position></i> (in Sekunden, erlaubte Formate: 01:20, 80, 00:20, 20)
- </li>
- <li>
- <i>shuffle <off,on></i><br>
- setzt den Shuffle-Modus: entweder <i>on</i> oder <i>off</i>
- </li>
- <li>
- <i>skipToNext</i><br>
- weiter zum nächsten Track
- </li>
- <li>
- <i>skipToPrevious</i><br>
- zurück zum vorherigen Track
- </li>
- <li>
- <i>togglePlayback</i><br>
- toggelt die Wiedergabe (hält an, wenn sie aktiv ist, ansonsten fortsetzen)
- </li>
- <li>
- <i>transferPlayback [ <device_id> ]</i><br>
- überträgt die aktuelle Wiedergabe auf ein anderes Gerät (wenn kein Gerät angegeben wird, wird das nächste inaktive verwendet)
- </li>
- <li>
- <i>update</i><br>
- lädt den aktuellen Zustand neu
- </li>
- <li>
- <i>volume <volume> [ <device_id> ]</i><br>
- setzt die Lautstärke
- </li>
- <li>
- <i>volumeDown [ <step> ] [ <device_id / device_name> ]</i><br>
- verringert die Lautstärke um <i>step</i> (falls nicht gesetzt, um <i>volumeStep</i>)
- </li>
- <li>
- <i>volumeFade <volume> [ <duration> <step> ] [ <device_id> ]</i><br>
- setzt die Lautstärke schrittweise
- </li>
- <li>
- <i>volumeUp [ <step> ] [ <device_id / device_name> ]</i><br>
- erhöht die Lautstärke um <i>step</i> (falls nicht gesetzt, um <i>volumeStep</i>)
- </li>
- </ul>
- <br>
- <a name="Spotify_get"></a>
- <p><b>Get</b></p>
- <ul>
- N/A
- </ul>
- <br>
- <a name="Spotify_attr"></a>
- <p><b>Attributes</b></p>
- <ul>
- <li>
- <i>alwaysStartOnDefaultDevice</i><br>
- startet neue Wiedergabe immer auf dem Standard-Gerät<br>
- default: 0
- </li>
- <li>
- <i>defaultPlaybackDeviceID</i><br>
- das Standard-Gerät durch Angabe der Geräte-ID oder des Geräte-Namens<br>
- </li>
- <li>
- <i>disable</i><br>
- deaktiviert das Gerät<br>
- default: 0
- </li>
- <li>
- <i>updateInterval</i><br>
- Intervall in Sekunden, in dem der Status aktualisiert wird, wenn keine Musik läuft<br>
- default: 300
- </li>
- <li>
- <i>updateIntervalWhilePlaying</i><br>
- Intervall in Sekunden, in dem der Status aktualisiert wird, wenn Musik läuft<br>
- default: 10
- </li>
- <li>
- <i>volumeStep</i><br>
- der Wert, um den die Lautstärke bei volumeUp/volumeDown standardmäßig verändert wird (in Prozent)<br>
- default: 5
- </li>
- </ul>
- </ul>
- <p><a name="TBot_List"></a>
- <h3>TBot_List</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TBot_List'>TBot_List</a><br/>
- </ul>
- <a name="TCM"></a>
- <h3>TCM</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TCM'>TCM</a><br/>
- </ul>
- <a name="TEK603"></a>
- <h3>TEK603</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TEK603'>TEK603</a><br/>
- </ul>
- <a name="THINKINGCLEANER" id="THINKINGCLEANER"></a>
- <h3>THINKINGCLEANER</h3>
- <div class='langLinks'>[<a href='commandref.html#THINKINGCLEANER'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#THINKINGCLEANER'>THINKINGCLEANER</a>
- </ul>
- <p><a name="THRESHOLD"></a>
- <h3>THRESHOLD</h3>
- <div class='langLinks'>[<a href='commandref.html#THRESHOLD'>EN</a> DE]</div>
- <ul>
- Vielfältige Steuerungen, bei denen durch die Auswertung von Sensordaten eine Steuerung erfolgen soll, können mit Hilfe dieses Moduls realisiert werden.
- Nach der Definition eines THRESHOLD-Moduls und der Vorgabe eines Sollwertes beginnt bereits das definierte Modul mit der Steuerung. Im einfachsten Fall liest das Modul einen Sensor aus, der Werte als Dezimalzahlen liefert
- und schaltet beim Überschreiten einer definierten Schwellen-Obergrenze (Sollwert)
- bzw. beim Unterschreiten einer Schwellen-Untergrenze einen Aktor oder führt beliebige FHEM/Perl-Befehle aus.
- Typisches Anwendungsgebiet ist z. B. die Nachbildung eines Thermostats oder Hygrostats - auch Zweipunktregler genannt.<br>
- <br>
- Mit Hilfe des Moduls, bzw. vieler solcher Module, lassen sich einfache oder auch komplexe Steuerungen für Heizung, Kühlung, Lüftung, Entfeuchtung, Beschattung oder z. B. einfache Benachrichtung
- beim Über- oder Unterschreiten eines bestimmten Wertes realisieren. Dabei müssen keine If-Abfragen in Perl oder Notify-Definitionen vorgenommen werden.
- Das führt, nicht nur bei FHEM-Anfängern, zu schnell erstellten und übersichtlichen Steuerungen, ohne zwingend in die Perl-Materie einsteigen zu müssen.<br>
- <br>
- Nach der Definition eines Moduls vom Typ THRESHOLD z. B. mit: <br>
- <br>
- <code>define <name> THRESHOLD <sensor> <actor></code><br>
- <br>
- erfolgt die eigentliche Steuerung über die Vorgabe eines Sollwertes. Das geschieht über:<br>
- <br>
- <code>set <name> desired <value></code><br>
- <br>
- Das Modul beginnt mit der Steuerung erst dann, wenn ein Sollwert gesetzt wird!<br>
- <br>
- Die Vorgabe des Sollwertes kann bereits bei der Definition des Moduls angegeben werden. Alternativ kann der Sollwert von einem weiteren Sensor kommen.
- Damit kann eine Steuerung durch den Vergleich zweier Sensoren stattfinden.
- Typisches Anwendungsbeispiel ist z. B. die Steuerung von Umwälz- oder Zirkulationspumpen.<br>
- <br>
- Die Vorgabe der Solltemperatur kann auch von beliebigen Wandthermostaten (z. B. HM, MAX, FHT) genutzt werden.<br>
- <br>
- Das Schaltverhalten des THRESHOLD-Moduls kann zusätzlich durch einen weiteren Sensor oder eine Sensorgruppe,
- definiert über structure (z. B. Fensterkontakte), über eine AND- bzw. OR-Verknüpfung beeinflusst werden.
- Bei komplexeren Bedingungen mit mehreren and- bzw. or-Verknüpfung sollte man das neuere <a href="http://fhem.de/commandref_DE.html#DOIF">DOIF</a>-Modul verwenden.<br>
- <br>
- Es ist ebenfalls die Kombination mehrerer THRESHOLD-Module miteinander möglich.<br>
- <br>
- <br>
- <b><u>Beispiele für Heizungssteuerung:</u></b><br>
- <br>
- <b>Einfaches Heizungsthermostat:</b><br>
- <br>
- Es soll bis 20 Grad geheizt werden. Beim Unterschreiten der Untergrenze von 19=20-1 Grad (Sollwert-Hysterese) wird die Heizung wieder eingeschaltet.<br>
- <br>
- <code>define TH_room THRESHOLD temp_room heating</code><br>
- <code>set TH_room desired 20</code><br>
- <br>
- <b>Zeitgesteuertes Heizen mit Hilfe des DOIF-Moduls:</b><br>
- <br>
- <code>define TH_room THRESHOLD temp_room heating</code><br>
- <code>define di_room DOIF ([05:30-23:00|8] or [07:00-23:00|7]) (set TH_room desired 20) DOELSE (set TH_room desired 18)</code><br>
- <br>
- <b>Steuerung einer Heizung durch ein Wandthermostat mit Übernahme der Soll- und Ist-Temperatur vom Wandthermostat:</b><br>
- <br>
- <code>define TH_Heizung THRESHOLD WT_ch1:measured-temp:1:WT_ch2:desired-temp Heizung</code><br>
- <br>
- Mit <code>set TH_Heizung desired 17</code> wird die Vorgabe vom Wandthermostat übersteuert bis <code>set TH_Heizung external</code> aufgerufen wird.<br>
- <br>
- <b>Heizung in Kombination mit einem Fensterkontakt mit Zuständen: open, closed:</b><br>
- <br>
- <code>define TH_room THRESHOLD temp_room OR win_sens heating</code><br>
- <br>
- <b>Heizung in Kombination mit mehreren Fensterkontakten:</b><br>
- <br>
- <code>define W_ALL structure W_type W1 W2 W3 ....</code><br>
- <code>attr W_ALL clientstate_behavior relative</code><br>
- <code>attr W_ALL clientstate_priority open closed</code><br>
- <br>
- <code>define thermostat THRESHOLD S1 OR W_ALL heating</code><br>
- <br>
- <b>Kombination mehrerer THRESHOLD-Module miteinander:</b><br>
- <br>
- Es soll bis 21 Grad geheizt werden, aber nur, wenn die Außentemperatur unter 15 Grad ist:<br>
- <br>
- <code>define TH_outdoor THRESHOLD outdoor:temperature:0:15</code><br>
- <code>define TH_room THRESHOLD indoor OR TH_outdoor:state:off heating</code><br>
- <code>set TH_room desired 21</code><br>
- <br>
- <b>Steuerung einer Heizung nach einer Heizkennlinie:</b><br>
- <br>
- Berechnung der Solltemperatur für die Vorlauftemperatur für Fußbodenheizung mit Hilfe der 0,8-Heizkennlinie anhand der Außentemperatur :<br>
- <br>
- <code>define TH_heating THRESHOLD flow:temperature:2:outdoor:temperature heating</code><br>
- <code>attr TH_heating target_func -0.578*_tv+33.56</code><br>
- <br>
- Nachtabsenkung lässt sich zeitgesteuert durch das Setzen von "offset" realisieren.<br>
- Von 22:00 bis 5:00 Uhr soll die Vorlauftemperatur um 10 Grad herabgesetzt werden:<br>
- <br>
- <code>define di_heating DOIF ([22:00-05:00]) (set TH_heating offset -10) DOELSE (set TH_heating offset 0)</code><br>
- <br>
- <br>
- <b><u>Beispiele für Belüftungssteuerung:</u></b><br>
- <br>
- <b>Einfache Belüftung anhand der Luftfeuchtigkeit:</b><br>
- <br>
- Es soll gelüftet werden, wenn die Feuchtigkeit im Zimmer über 70 % ist; bei 60 % geht der Lüfter wieder aus.<br>
- <br>
- <code>define TH_hum THRESHOLD sens:humidity:10:70 ventilator|set @ on|set @ off|1</code><br>
- <br>
- <b>Belüftung anhand des Taupunktes, abhängig von der Luftfeuchtigkeit innen:</b><br>
- <br>
- Es soll gelüftet werden, wenn die Luftfeuchtigkeit im Zimmer über 70 % ist und der Taupunkt innen höher ist als außen.<br>
- <br>
- <code>define TH_hum THRESHOLD sens:humidity:10:70||||on:off|_sc</code><br>
- <code>define dewpoint dewpoint indoor</code><br>
- <code>define dewpoint dewpoint outdoor</code><br>
- <code>define TH_room THRESHOLD indoor:dewpoint:0:outdoor:dewpoint AND TH_hum:state:on ventilator|set @ on|set @ off|2</code><br>
- <br>
- Belüftung in Kombination mit einem Lichtschalter mit Nachlaufsteuerung: siehe <a href="http://fhem.de/commandref_DE.html#DOIF">DOIF</a>-Modul.<br>
- <br>
- <b><u>Beispiele für die Steuerung der Warmwasserzirkulation:</u></b><br>
- <br>
- <b>Zeitgesteuerte Warmwasserzirkulation:</b><br>
- <br>
- In der Hauptzeit soll die Wassertemperatur im Rücklauf mindestens 38 Grad betragen.<br>
- <br>
- <code>define TH_circ TRHESHOLD return_w:temperature:0 circ_pump</code><br>
- <code>define di_circ DOIF ([05:30-23:00|8] or [07:00-23:00|7]) (set TH_circ desired 38) DOELSE (set TH_circ desired 15)</code><br>
- <br>
- <b>Alternative Steuerung mit Sollwert-Vorgabe durch einen weiteren Sensor des Warmwasserspeichers:</b><br>
- <br>
- Die Rücklauftemperatur soll 5 Grad (offset) unter der Warmwasserspeichertemperatur liegen und bis zu 4 Grad (Hysterese) schwanken dürfen.<br>
- <br>
- <code>define TH_circ THRESHOLD return_w:temperature:4:water_storage:temperature:-5 circ_pump</code><br>
- <br>
- <br>
- <b><u>Beispiele für Beschattungssteuerung:</u></b><br>
- <br>
- <b>Beispiel für einfache Beschattung im Sommer:</b><br>
- <br>
- Zwischen 12:00 und 20:00 Uhr (potenzielle Sonnengefahr auf der Südseite) wird der Rolladen auf 30 % heruntergefahren,<br>
- wenn die Raumtemperatur über 23 Grad ist und die Sonne scheint. Im Winter, wenn die Zimmertemperatur niedriger ist (< 23),<br>
- will man von der Sonnenenergie profitieren und den Rollladen oben lassen.<br>
- <br>
- <code>define TH_shutter_room THRESHOLD T_room AND sun:state:on shutter_room|set @ 30||2</code><br>
- <code>define di_shutter DOIF ([12:00-20:00]) (set TH_shutter desired 23) DOELSE (set TH_shutter desired 30)</code><br>
- <br>
- Weitere Beispiele für Beschattung mit Verzögerung und automatischem Hochfahren des Rollladens: siehe <a href="http://fhem.de/commandref_DE.html#DOIF">DOIF</a>-Modul.<br>
- <br>
- <br>
- <b><u>Beispiele für die Ausführung beliebiger FHEM/Perl-Befehlsketten:</u></b><br>
- <br>
- <code>define thermostat THRESHOLD sensor |set Switch1 on;;set Switch2 on|set Switch1 off;;set Switch2 off|1</code><br>
- <code>define thermostat THRESHOLD sensor alarm|{Log 2,"Wert überschritten"}|set @ off|</code><br>
- <code>define thermostat THRESHOLD sensor ||{Log 2,"Wert unterschritten"}|</code><br>
- <br>
- <br>
- <b><u>Einige weitere Bespiele für Entfeuchtung, Klimatisierung, Bewässerung:</u></b><br>
- <br>
- <code>define hygrostat THRESHOLD hym_sens:humidity dehydrator|set @ on|set @ off|1</code><br>
- <code>define hygrostat THRESHOLD hym_sens:humidity AND Sensor2:state:closed dehydrator|set @ on|set @ off|1</code><br>
- <code>define thermostat THRESHOLD temp_sens:temperature:1 aircon|set @ on|set @ off|1</code><br>
- <code>define thermostat THRESHOLD temp_sens AND Sensor2:state:closed aircon|set @ on|set @ off|1</code><br>
- <code>define hygrostat THRESHOLD hym_sens:humidity:20 watering|set @ off|set @ on|2</code><br>
- <br>
- <br>
- <b><u>Beispiele für angepasste Statusanzeige des THRESHOLD-Moduls:</u></b><br>
- <br>
- <code>define thermostat THRESHOLD sensor aircon|set @ on|set @ off|2|on:off</code><br>
- <br>
- <b>Beispiel für reine Zustandanzeige (z. B. für Zustandsauswertung in anderen Modulen) ohne Ausführung von Code:</b><br>
- <br>
- <code>define thermostat THRESHOLD sensor:temperature:0:30</code><br>
- <br>
- entspricht wegen Defaultwerte:<br>
- <br>
- <code>define thermostat THRESHOLD sensor:temperature:0:30||||off:on|_sc</code><br>
- <br>
- <b>Es soll der Modus (mode), Status (state_cmd), Sollvorgabewert (desired_value) und Wert des ersten Sensors (sensor_value) angezeigt werden:</b><br>
- <br>
- <code>define TH_living_room THRESHOLD T_living_room heating|set @ off|set @ on|2|off:on|_m _sc _dv _s1v</code><br>
- <br>
- oder<br>
- <br>
- <code>define TH_living_room THRESHOLD T_living_room heating</code><br>
- <code>attr TH_living_room state_cmd1_gt off</code><br>
- <code>attr TH_living_room state_cmd2_lt on</code><br>
- <code>attr TH_living_room state_format _m _sc _dv _s1v</code><br>
- <br>
- </ul>
- <a name="THRESHOLDdefine"></a>
- <b>Define</b>
- <ul>
- <br>
- <code>define <name> THRESHOLD <sensor>:<reading>:<hysteresis>:<target_value>:<offset> AND|OR <sensor2>:<reading2>:<state> <actor>|<cmd1_gt>|<cmd2_lt>|<cmd_default_index>|<state_cmd1_gt>:<state_cmd2_lt>|<state_format></code><br>
- <br>
- <br>
- <li><b>sensor</b><br>
- ein in FHEM definierter Sensor<br>
- </li>
- <br>
- <li><b>reading</b> (optional)<br>
- Reading des Sensors, der einen Wert als Dezimalzahl beinhaltet<br>
- Defaultwert: temperature<br>
- </li>
- <br>
- <li><b>hysteresis</b> (optional)<br>
- Hysterese, daraus errechnet sich die Untergrenze = Sollwert - hysteresis<br>
- Defaultwert: 1 bei Temperaturen, 10 bei Feuchtigkeit<br>
- </li>
- <br>
- <li><b>target_value</b> (optional)<br>
- bei Zahl: Initial-Sollwert, wenn kein Wert vorgegeben wird, muss er mit "set desired value" gesetzt werden.<br>
- sonst: <sensorname>:<reading>, hier kann ein weiterer Sensor angegeben werden, der den Sollwert dynamisch vorgibt.<br>
- Defaultwert: kein<br>
- </li>
- <br>
- <li><b>offset</b> (optional)<br>
- Offset zum Sollwert<br>
- Damit errechnet sich: die Sollwertobergrenze = Sollwert + offset und die Sollwertuntergrenze = Sollwert - Hysterese + offset<br>
- Defaultwert: 0<br>
- </li>
- <br>
- <br>
- <li><b>AND|OR</b> (optional)<br>
- Verknüpfung mit einem optionalen zweiten Sensor<br>
- </li>
- <br>
- <li><b>sensor2</b> (optional, nur in Verbindung mit AND oder OR)<br>
- ein definierter Sensor, dessen Status abgefragt wird<br>
- </li>
- <br>
- <li><b>reading2</b> (optional)<br>
- Reading, der den Status des Sensors beinhaltet<br>
- Defaultwert: state<br>
- </li>
- <br>
- <li><b>state</b> (optional)<br>
- Status des Sensors, der zu einer Aktion führt<br>
- Defaultwert: open<br>
- </li>
- <br>
- <li><b>actor</b> (optional)<br>
- ein in FHEM definierter Aktor<br>
- </li>
- <br>
- <li><b>cmd1_gt</b> (optional)<br>
- FHEM/Perl Befehl, der beim Überschreiten des Sollwertes ausgeführt wird bzw.
- wenn status des sensor2 übereinstimmt. @ ist ein Platzhalter für den angegebenen Aktor.<br>
- Defaultwert: set actor off, wenn Aktor angegeben ist<br>
- </li>
- <br>
- <li><b>cmd2_lt</b> (optional)<br>
- FHEM/Perl Befehl, der beim Unterschreiten der Untergrenze (Sollwert-Hysterese) ausgeführt wird bzw.
- wenn status des sensor2 nicht übereinstimmt. @ ist ein Platzhalter für den angegebenen Aktor.<br>
- Defaultwert: set actor on, wenn Aktor angegeben ist<br>
- </li>
- <br>
- <li><b>cmd_default_index</b> (optional)<br>
- FHEM/Perl Befehl, der nach dem Setzen des Sollwertes ausgeführt wird, bis Sollwert oder die Untergrenze erreicht wird.<br>
- 0 - kein Befehl<br>
- 1 - cmd1_gt<br>
- 2 - cmd2_lt<br>
- Defaultwert: 2, wenn Aktor angegeben ist, sonst 0<br>
- </li>
- <br>
- <li><b>state_cmd1_gt</b> (optional, wird gleichzeitig als Attribut definiert)<br>
- Status, der angezeigt wird, wenn FHEM/Perl-Befehl cmd1_gt ausgeführt wurde.<br>
- Defaultwert: kein<br>
- </li>
- <br>
- <li><b>state_cmd2_lt</b> (optional, wird gleichzeitig als Attribut definiert)<br>
- Status, der angezeigt wird, wenn FHEM/Perl-Befehl cmd2_lt ausgeführt wurde.<br>
- Defaultwert: kein<br>
- </li>
- <br>
- <li><b>state_format</b> (optional, wird gleichzeitig als Attribut definiert und kann dort verändert werden)<br>
- Format der Statusanzeige: beliebiger Text mit Platzhaltern<br>
- Mögliche Platzhalter:<br>
- _m: mode<br>
- _dv: desired_value<br>
- _s1v: sensor_value<br>
- _s2s: sensor2_state<br>
- _sc: state_cmd<br>
- Defaultwert: _m _dv _sc, _sc, wenn state_cmd1_gt und state_cmd2_lt ohne Aktor gesetzt wird.<br>
- </li>
- <br>
- <br>
- </ul>
- <a name="THRESHOLDset"></a>
- <b>Set </b>
- <ul>
- <li><code>set <name> desired <value><br></code>
- Setzt den Sollwert. Wenn kein Sollwert gesetzt ist, ist das Modul nicht aktiv.
- Sollwert-Vorgabe durch einen Sensor wird hiermit übersteuert, solange bis "set external" gesetzt wird.
- </li>
- <br>
- <li><code>set <name> deactivated <command><br></code>
- Modul wird deaktiviert.<br>
- <command> ist optional. Es kann "cmd1_gt" oder "cmd2_lt" übergeben werden, um vor dem Deaktivieren des Moduls einen definierten Zustand zu erreichen.
- </li>
- <br>
- <li><code>set <name> active<br></code>
- Modul wird aktiviert, falls unter target_value ein Sensor für die Sollwert-Vorgabe definiert wurde, wird der aktuelle Sollwert solange eingefroren bis "set <name> external" gesetzt wird.<br>
- </li>
- <br>
- <li><code>set <name> externel<br></code>
- Modul wird aktiviert, Sollwert-Vorgabe kommt vom Sensor, falls ein Sensor unter target_value definierte wurde.<br>
- </li>
- <br>
- <li><code>set <name> hysteresis <value><br></code>
- Setzt Hysterese-Wert.
- </li>
- <br>
- <li><code>set <name> offset <value><br></code>
- Setzt Offset-Wert.<br>
- Defaultwert: 0
- </li>
- <br>
- <li><code>set <name> cmd1_gt</code><br>
- Führt das unter cmd1_gt definierte Kommando aus.<br>
- </li>
- <br>
- <li><code>set <name> cmd2_lt</code><br>
- Führt das unter cmd2_lt definierte Kommando aus.<br>
- </li>
- </ul>
- <br>
- <a name="THRESHOLDget"></a>
- <b>Get </b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="THRESHOLDattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#disable">disable</a></li>
- <li><a href="#loglevel">loglevel</a></li>
- <li>state_cmd1_gt</li>
- <li>state_cmd2_lt</li>
- <li>state_format</li>
- <li>number_format</li>
- Das angegebene Format wird im Status für die Formatierung von desired_value (_dv) und sensor_value (_s1v) über die sprintf-Funktion benutzt.<br>
- Voreingestellt ist "%.1f" für eine Nachkommastelle. Für weiter Formatierungen - siehe Formatierung in der sprintf-Funktion in der Perldokumentation.<br>
- Wenn das Attribut gelöscht wird, werden Zahlen im Status nicht formatiert.<br>
- <li>target_func</li>
- Hier kann ein Perlausdruck angegeben werden, um aus dem Vorgabewert eines externen Sensors (target_value) einen Sollwert zu berechnen.<br>
- Der Sensorwert wird mit "_tv" im Ausdruck angegeben. Siehe dazu Beispiele oben zur Steuerung der Heizung nach einer Heizkennlinie.<br>
- <li>setOnDeactivated</li>
- Kommando, welches durch das Deaktivieren per "set ... deactivated" automatisch ausgeführt werden soll. Mögliche Angaben: cmd1_gt, cmd2_lt<br>
- <li>desiredActivate</li>
- Wenn das Attribut auf 1 gesetzt ist, wird ein deaktiviertes Modul durch "set ... desired <value>" automatisch aktiviert. "set ... active" ist dann nicht erforderlich.<br>
- </ul>
- <br>
-
- <p><a name="THZ"></a>
- <h3>THZ</h3>
- <div class='langLinks'>[<a href='commandref.html#THZ'>EN</a> DE]</div>
- <ul>
- THZ Modul: Kommuniziert mittels einem seriellen Interface RS232/USB (z.B. /dev/ttyxx), oder mittels ser2net (z.B. 10.0.x.x:5555) mit einer Tecalor / Stiebel
- Eltron Wärmepumpe. <br>
- Getestet mit einer Tecalor THZ303/Sol (Serielle Geschwindigkeit 57600/115200@USB) und einer THZ403 (Serielle Geschwindigkeit 115200) mit identischer
- Firmware 4.39. <br>
- Getestet mit einer Stiebel LWZ404 (Serielle Geschwindigkeit 115200@USB) mit Firmware 5.39. <br>
- Getestet auf FritzBox, nas-qnap, Raspberry Pi and MacOS.<br>
- Dieses Modul funktioniert nicht mit äterer Firmware; Gleichwohl, das "parsing" könnte leicht angepasst werden da die Register gut
- beschrieben wurden.
- https://answers.launchpad.net/heatpumpmonitor/+question/100347 <br>
- Implementiert: Lesen der Statusinformation sowie Lesen und Schreiben einzelner Einstellungen.
- Genauere Beschreinung des Modules --> 00_THZ wiki http://www.fhemwiki.de/wiki/Tecalor_THZ_W%C3%A4rmepumpe
- <br><br>
- <a name="THZdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> THZ <device></code> <br>
- <br>
- <code>device</code> kann einige Parameter beinhalten (z.B. @baudrate, @direction,
- TCP/IP, none) wie das <a href="#CULdefine">CUL</a>, z.B. 57600 baud oder 115200.<br>
- Beispiel:<br>
- Direkte Verbindung
- <ul><code>
- define Mytecalor THZ /dev/ttyUSB0@115200<br>
- </code></ul>
- oder vir Netzwerk (via ser2net)<br>
- <ul><code>
- define Myremotetecalor THZ 192.168.0.244:2323
- </code></ul>
- <br>
- <ul><code>
- define Mythz THZ /dev/ttyUSB0@115200 <br>
- define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz <br>
- attr Mythz event-min-interval s.*:4800 <br>
- attr Mythz event-on-change-reading .* <br>
- attr Mythz interval_sDHW 400 <br>
- attr Mythz interval_sElectrDHWDay 2400 <br>
- attr Mythz interval_sElectrDHWTotal 43200 <br>
- attr Mythz interval_sGlobal 400 <br>
- attr Mythz interval_sHC1 400 <br>
- attr Mythz interval_sHeatDHWDay 2400 <br>
- attr Mythz interval_sHeatDHWTotal 43200 <br>
- attr Mythz interval_sHeatRecoveredDay 2400 <br>
- attr Mythz interval_sHeatRecoveredTotal 43200 <br>
- attr Mythz interval_sHistory 86400 <br>
- attr Mythz interval_sLast10errors 86400 <br>
- attr Mythz room pompa <br>
- attr FileLog_Mythz room pompa <br>
- </code></ul>
- <br>
- Wenn die Attribute interval_XXXXXXX nicht definiert sind (oder 0), ist das interne Polling deaktiviert.
-
- </ul>
- <br>
- </ul>
-
- <p><a name="TPLinkHS110"></a>
- <h3>TPLinkHS110</h3>
- <div class='langLinks'>[<a href='commandref.html#TPLinkHS110'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="TPLinkHS110"></a>
- <b>Define</b>
- <code>define <name> TPLinkHS110 <ip/hostname></code><br>
- <br>
- Definiert eine TP-Link HS100 oder HS110 schaltbare WLAN-Steckdose. <br>
- Der Unterschied zwischen der HS100 und HS110 besteht darin, dass die HS110 eine Echtzeit-Messung von <br>
- Strom, Spannung sowie Leistung durchführt.<br>
- Dieses Modul erkennt automatisch, welchen Typ Sie verwenden und passt die Readings entsprechend an.
- <br><br>
- Das Modul implementiert nicht alle Funktionen der HS100/110.<br>
- Derzeit werden alle für den sinnvollen Betrieb an FHEM benötigten Parameter ausgelesen.<br>
- Geschrieben werden jedoch nur die Schaltzustände "An", "Aus" sowie der Nachtmodus An/Aus (Nachtmodus = LEDs der Steckdose ausschalten).<br>
- Für eine weitergehende Programmierung der Steckdosen wird daher die TP Link App "Kasa" empfohlen, wobei deren<br>
- Funktionen wie Timer etc. letztlich redundant zu Kernfunktionen von FHEM sind.
- <p>
- <b>Attribute</b>
- <ul>
- <li><b>interval</b>: Das Intervall in Sekunden, nach dem FHEM die Messwerte aktualisiert. Default: 300s</li>
- Eine Aktualisierung der Messwerte findet auch bei jedem Schaltvorgang statt.
- <p>
- <li><b>timeout</b>: Der Timeout in Sekunden, der bei der Kommunikation mit der Steckdose verwendet wird. Default: 1s</li>
- <i>Achtung</i>: der Timeout von 1s ist knapp gewählt. Ggf. kann es zu Fehlermeldungen kommen, wenn die Steckdose nicht
- schnell genug antwortet.<br>
- Bitte beachten Sie aber auch, dass längere Timeouts FHEM für den Zeitraum des Requests blockieren!
- <p>
- <li><b>disable</b>: Die Ausführung des Moduls wird gestoppt. Default: no.</li>
- <i>Achtung: wenn Ihre Steckdose nicht in Betrieb oder über das WLAN erreichbar ist, sollten Sie
- dieses FHEM-Modul per Attribut "disable" abschalten, da sonst beim zyklischen Abruf der Messdaten
- der Steckdose Timeouts auftreten, die FHEM unnötig verlangsamen.</i>
- </ul>
- <p>
- <b>Requirements</b>
- <ul>
- Das Modul benötigt die folgenden Perl-Module:<br><br>
- <li> Perl Module: IO::Socket::INET </li>
- <li> Perl Module: IO::Socket::Timeout </li>
- </ul>
- </ul>
- <p><a name="TRAFFIC"></a>
- <h3>TRAFFIC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TRAFFIC'>TRAFFIC</a><br/>
- </ul>
- <a name="TRX"></a>
- <h3>TRX</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TRX'>TRX</a><br/>
- </ul>
- <a name="TRX_ELSE"></a>
- <h3>TRX_ELSE</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TRX_ELSE'>TRX_ELSE</a><br/>
- </ul>
- <a name="TRX_LIGHT"></a>
- <h3>TRX_LIGHT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TRX_LIGHT'>TRX_LIGHT</a><br/>
- </ul>
- <a name="TRX_SECURITY"></a>
- <h3>TRX_SECURITY</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TRX_SECURITY'>TRX_SECURITY</a><br/>
- </ul>
- <a name="TRX_WEATHER"></a>
- <h3>TRX_WEATHER</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TRX_WEATHER'>TRX_WEATHER</a><br/>
- </ul>
- <a name="TUL"></a>
- <h3>TUL</h3>
- <div class='langLinks'>[<a href='commandref.html#TUL'>EN</a> DE]</div>
- <ul>
- <table>
- <tr><td>
- Das Modul TUL stellt die Verbindung von FHEM zum EIB / KNX dar.
- <a href="#KNX">KNX</a> Instanzen stellen die Vrbindung zu den KNX-Gruppen dar und benÖtigen ein TUL-Device als IO-Schnittstelle.<br>
- Das Modul TUL kommuniziert mit dem KNX entweder Über den eibd, den knxd oder den TUL <a href="http://busware.de/tiki-index.php?page=TUL" target="_blank">TUL usb stick</a> hergestellt von busware.de
- Anmerkung: das Modul benÖtigt die Device::SerialPort oder Win32::SerialPort wenn der Stick Über USB angeschlossen wird, und das OS unrealistische Parameter fÜr das Device einstellt.
- </td><td>
- <img src="IMG_0483.jpg" width="100%" height="100%"/>
- </td></tr>
- </table>
- <a name="TULdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> TUL <device> <physical address></code> <br>
- <br>
- TUL usb stick / TPUART serial devices:<br><ul>
- <device> enthält die serielle Schnittstelle der TUL. Der name der Schnittstelle hängt von Eurer Distribution ab. Unter linux wird fÜr gewÖhnlich /dev/ttyACM0 verwandt.
- Wenn Eure Distribution das modul cdc_acm nicht enthält, kÖnnt Ihr das Laden des handles der TUL mit dem folgenden Befehl erzwingen:<ul>modprobe usbserial vendor=0x03eb
- product=0x204b</ul>Dann ist die Schnittstelle meist /dev/ttyUSB0.<br><br>
- Ihr kÖnnt dem Gerät eine Baudrate vorgeben. Dazu dem Gerätenamen das Zeichen @ hinzufÜgen, z.B.: /dev/ttyACM0@19200<br><br>
- Anmerkung: FÜr den TUL-USB-Stick wird die Baudrate 19200 benÖtigt. Dies entspricht der Defaulteinstellung.
- <br><br>
- Beispiel:<br>
- <code>define tul TUL tul:/dev/ttyACM0 1.1.249</code>
- </ul>
-
- EIBD:<br><ul>
- <device> entspricht dem host:port des eibd-servers. z.B. eibd:192.168.0.244:2323. Wenn der Standardport genutzt wird, muss dieser nicht angegeben werden.
- <br><br>
- Beispiel:<br>
- <code>define tul TUL eibd:localhost 1.1.249</code>
- <code>define tul TUL knxd:192.168.178.2 1.1.248</code>
- </ul>
- <br>
- Wenn das Gerät none konfiguriert wird, wird kein device geÖffnet. So kÖnnt Ihr ohne angeschlossene Hardware experimentieren. <br>
- Die physikalische Adresse wird als Absender fÜr KNX-Telegramme genutzt.
- </ul>
- <br>
- <a name="TULattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li><br>
- <li><a href="#attrdummy">dummy</a></li><br>
- <li><a href="#showtime">showtime</a></li><br>
- <li><a href="#verbose">verbose</a></li><br>
- <li><a href="#useEIB">useEIB</a></li><br>
- <ul>
- Das Gerät kann das Modul 10_EIB bedienen, wenn das Flag auf 1 gesetzt ist. Dies ist nur fÜr RÜckwärtskompatibiliät genutzt. Andernfalls wird nur das Modul 10_KNX bedient.
- </ul>
- </ul>
- <br>
- </ul>
- <p><a name="Talk2Fhem"></a>
- <h3>Talk2Fhem</h3>
- <div class='langLinks'>[<a href='commandref.html#Talk2Fhem'>EN</a> DE]</div>
- <ul>
- Das Modul <i>Talk2Fhem</i> stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her.
- Die Konfiguration erfolgt dabei komfortabel über das FHEM Webfrontend.<br>
- Für eine genauere Beschreibung und weiterführende Beispiele siehe <a href="http://wiki.fhem.de/wiki/Modul_Talk2Fhem">Talk2Fhem Wiki</a>.
- <br><br>
- <a name="Talk2Fhemdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Talk2Fhem</code>
- <br><br>
- Beispiel: <code>define talk Talk2Fhem</code>
- <br><br>
- Die eigentliche Konfigration sollte erst auf der FHEM Seite erfolgen.
- <br><br>
- Die einzelnen Sprachphrasen werden Zeile für Zeile konfiguriert. Hierbei fängt eine Konfiguration
- immer mit dem Regulärem Ausdruck an, gefolgt von mindestens einem Leerzeichen oder Tabulator gefolgt
- von einem Gleichheitszeichen.<br>
- Der Kommandoteil fängt nach dem Gleichheitszeichen mit einem Leerzeichen, Tabulator oder Zeilenumbruch an.<br><br>
- <code><regexp> = <command></code>
- <br><br>
- <b>Kurzreferenz:</b>
- <br>
- <code><RegExpPart> [&& [?!]<RegExpPart_n>] = [ <FHEM command> | { <Perl code> } | (<option> => '<wert>' , ... ) ]</code>
- <br><br>
- Beispiel: <code>hallo welt = {Log 1, Hallo Welt}</code>
- <br><br>
- Alles nach einem Hashtag '#' wird bis zum Zeilenende ignoriert.
- <br><br>
- <regexp>
- <ul>Regulärer Ausdruck der den Text beschreibt, bei dem das Kommando ausgeführt werden soll</ul>
- <br><br>
- <command>
- <ul>
- Der ausführende Teil. Folgende Formate sind Zulässig:
- <li>FHEM Kommando</li>
- <li>{Perlcode}</li>
- <li>(<option> => '<wert>' , ... )</li>
- <ul>
- <br><i><option></i><br>
- <li><b>cmd</b><br>FHEM Kommando wie oben</li>
- <li><b>offset</b><br>Ganzzahliger Wert in Sekunden der auf den Zeitpunkt addiert wird</li>
- <li><b>answer</b><br>Perl Code dessen Rückgabe in das Reading answer geschrieben wird</li>
- </ul>
- </ul>
- <br>
- Klammerüberführung:
- <ul>
- Im Regulärem Ausdruck gesetzte Klammern können in den Kommandoteil mit $1, $2, [...], $n überführt und
- modifiziert werden. Folgende Modifizierungsmöglichkeiten stehen hierbei zur Verfügung.
- <li>$n<br>Ohne Änderung direkt das Wort überführen.</li>
- <li>$n{<typ> => <wert>}<br>
- Die Typen sind:<br>
- true, false, integer, float, numeral, /<regexp>/, word, empty, else<br>
- <b>true</b> entspricht: ja|1|true|wahr|ein|eins.*|auf.*|..?ffnen|an.*|rauf.*|hoch.*|laut.*|hell.*<br>
- <b>false</b> entspricht: nein|0|false|falsch|aus.*|null|zu.*|schlie..?en|runter.*|ab.*|leise.*|dunk.*<br>
- <b>integer</b> Wort enthält eine Zahl
- <b>float</b> Wort enthält eine Gleitkommazahl
- <b>numeral</b> Word ist ein Zahlenwort oder Zahl <br>
- <b>/<regexp>/</b> Wort entspricht der <regexp>
- <b>word</b> Wort enthält gleich oder mehr als 4 Zeichen
- <b>empty</b> Wort enthält eine Leere Zeichenkette
- <b>else</b> Falls keines der Fälle zutrifft
- Wird ein <typ> identifiziert wird für $n der <wert> eingesetzt<br>
- Beispiel: <code>licht (\S*) = set light $1{true => on,false => off}</code>
- </li>
- <li>$n[<list>]<br>
- Kommaseparierte Liste: [wert1,wert2,...,[else,value], [empty,value]] oder [@modwordlist]<br>
- Ist $n eine Zahl, wird das Wort das an dieser Position in <list> steht gewählt.<br><br>
- Ist $n ein Text wird in der zugehörigen Klammer im <regexp>-Teil nach einer Liste gesucht. (a|b|c) oder (@keywordlist)
- In dieser Liste, wird nach $n gesucht und bei erfolg dessen Position in <list> für $n gewählt.
- <br>Beispiel: <code>licht .* (küche|flur|bad) (\S*) an = set $1[dev_a,dev_b,dev_c] $2{true => on,false => off}</code>
- </li>
- <li>$n@<br>Das Wort wird so übernommen wie es in der Liste im <regexp>-Teil steht.</li>
- </ul>
- <br>
- Umgebungsvariablen:
- <ul>
- Es stehen eine Reihe von Variablen zur Verfügung auf die im <command>-Teil zugegriffen werden können.
- <li><b>$&</b> Enthält alle gefundenen Wörter</li>
- <li><b>!$&</b> Enthält den Rest der nicht von der RegExp eingeschlossen wurde</li>
- <li><b>$DATE</b> Enthält den Zeit und Datumstext des Sprachbefehls</li>
- <li><b>$AGAIN</b> Enthält das Wort wieder wenn es sich um ein wieder Kommando handelt</li>
- <li><b>$TIME</b> Enthält die erkannte Zeit.</li>
- <li><b>$NAME</b> Enthält den Devicenamen.</li>
- <li><b>$IF</b> Enthält den Text der erkannten T2F_if Konfiguration.</li>
- <li><b>$0</b> Enthält den Text der erkannten T2F_origin RegExp.</li>
- </ul>
-
- </ul>
- <br>
-
- <a name="Talk2Fhemset"></a>
- <b>Set</b><br>
- <ul>
- <code>set <name> [!]<text></code>
- <br><br>
- Über das <i>set</i> Kommando wird der zu interpretierende Text an das Modul gesendet.
- Schaue unter <a href="http://fhem.de/commandref.html#set">commandref#set</a> für weiterführende Hilfe.
- <li>cleartimers</li> Entfernt die wartenden zeitbezogenen Kommandos
- <li>cleartriggers</li> Entfernt die wartenden ereignisbezogenen Kommandos
- </ul>
- <br>
- <a name="Talk2Fhemget"></a>
- <b>Get</b><br>
- <code>get <name> <option></code>
- <br><br>
- Über <i>get</i> lassen sich Informationen aus dem Modul auslesen.
- Siehe <a href="http://fhem.de/commandref.html#get">commandref#get</a> für weitere Informationen zu "get".
- <br><br>
- <option>
- <ul>
- <li><i>@keywordlist</i> <i>@modwordlist</i><br>
- Vergleich der zwei Listen Wort für Wort</li>
- <li><i>keylistno</i><br>
- Eine Auflistung der Konfigurierten "Keyword"-Listen. Zur einfacheren Positionierung der "Modword"-Listen</li>
- <li><i>log</i><br>
- Zeigt die Logeinträge des letzten Kommandos</li>
- <li><i>modificationtypes</i><br>
- Zeigt die RegExp der Modifikationstypen. </li>
- <li><i>standardfilter</i><br>
- Lädt den Standardfilter und schreibt ihn in das Attribut T2F_filter wenn er leer ist</li>
- <li><i>version</i><br>
- Die Modulversion</li>
- </ul>
- <br>
- <a name="Talk2Fhemreadings"></a>
- <b>Readings</b>
- <ul>
- <li><i>set</i><br>
- Enthält den zuletzt über "set" gesendeten Text.
- </li>
- <li><i>cmds</i><br>
- Enthält das zuletzt ausgeführte Kommando. Wird auch bei disable=1 gesetzt.
- </li>
- <li><i>answer</i><br>
- Enthält den Antworttext des letzten Befehls.
- </li>
- <li><i>err</i><br>
- Enthält die letzte Fehlermeldung.<br>
- "No match" Übereinstimmung mit keiner RegExp.<br>
- "Error on Command" siehe FHEM log.
- </li>
- <li><i>response</i><br>
- Enthällt die Rückgabe des FHEM Befhels.
- </li>
- <li><i>origin</i><br>
- Enthält die gefundene Zeichenkette der in dem Attribut T2F_origin definierten RegExp.
- </li>
- <li><i>status</i><br>
- Enthält den Status der Ausgabe.
- response, disabled, err, answers, done
- </li>
- <li><i>ifs</i><br>
- Enthält die Bedingungen bei denen das Kommando ausgeführt werden wird.
- </li>
- <li><i>notifies</i><br>
- Enthält eine Auflistung der Devices die für die aktuell wartenden bedingten Kommandos relevant sind. Auf diesen Devices liegt ein internes notify.
- </li>
- </ul>
- <br>
-
- <a name="Talk2Fhemattr"></a>
- <b>Attribute</b>
- <ul>
- <code>attr <name> <attribute> <value></code>
- <br><br>
- Siehe <a href="http://fhem.de/commandref.html#attr">commandref#attr</a> für weitere Informationen zu den Attributen.
- <br><br>
- Attribute:
- <ul>
- <li><i>T2F_keywordlist</i> <name> = <list><br>
- Eine Komma seperierte Liste von Schlüsselwörtern wie z.B.: Räumen, Namen, Farben usw...<br>
- Mit anderen Worten, mit natürlichem Namen benannte Sachen.
- </li>
- <li><i>T2F_modwordlist</i> <name> = <list><br>
- Eine Komma seperierte Liste von Ersetzungswörten die für die Schlüsselwörter eingesetzt werden.
- z.B.: Gerätenamen in FHEM<br>
- </li>
- <li><i>T2F_if</i><br>
- Eine Auflistung von ereignisgesteuerten Konfigurationen. Die Syntax ist die der Definition. Kommandoteil ist eine IF Bedingung.<br>
- z.B.: wenn .*?tür = [door] eq "open"
- </li>
- <li><i>T2F_filter</i><br>
- Kommaseparierte Liste von RegExp die generell entfernt werden.<br>
- Standard: \bbitte\b,\bauch\b,\bkann\b,\bsoll\b
- </li>
- <li><i>T2F_origin</i><br>
- Eine RegExp die generell entfernt wird und deren Ausgabe über $0 angesprochen werden kann.<br>
- Kann für eine Benutzerzuordnung verwendet werden.
- </li>
- <li><i>T2F_language</i>DE|EN<br>
- Die verwendete Sprache kann über das globale Attribut "language" gesetzt werden. Oder über dieses Attribut überschrieben werden.
- </li>
- <li><i>T2F_disableumlautescaping</i> <0|1><br>
- Deaktiviert das Konvertieren der Umlaute in "\S\S?"</li>
- <li><i>disable</i> <0|1><br>
- Kann zu Testzwecken verwendet werden. Steht das Attribut auf 1, wird das FHEM-Kommando nicht ausgeführt
- aber in das Reading cmds geschrieben.
- </li>
- </ul>
- </ul>
- </ul>
- <p><a name="TechemHKV"></a>
- <h3>TechemHKV</h3>
- <div class='langLinks'>[<a href='commandref.html#TechemHKV'>EN</a> DE]</div>
- <ul>
- Das modul empfängt Daten eines Techem Heizkostenverteilers.
- <br><br>
- Empfangen werden
- <ul>
- <li>Wert des aktuellen Abrechnungszeitraumes</li>
- <li>Wert des vorhergehenden Abrechnungszeitraumes einschließlich des Ablesedatums</li>
- <li>Beide Temperatur Sensoren (sofern der Heizkostenverteiler sie sendet)</li>
- </ul>
- <br>
- Zum Empfang wird ein CUL im WMBUS_T mode benötigt. Dabei ist es ausreichend ihn vorrübergehend in diesen Modus zu schalten.
- Das Modul überwacht den rfmode aller verfügbaren CUL
- <br>
- <br>
- <a name="TechemHKV_Define"></a>
- <b>Define</b>
- <br>
- <code>define <name> TechemHKV <4|8 digit ID> [<speaking name>]</code>
- <ul>
- <li>ID: 4 Ziffern wie auf dem Heizkostenverteiler angezeigt oder 8 Ziffern aus der Abrechnung</li>
- <li>speaking name: (optional) Bezeichnung</li>
- </ul>
- <br>
- <a name="TechemHKV_Readings"></a>
- <b>Readings</b>
- <ul>
- <li>current_period: Wert des aktuellen Abrechnungszeitraumes
- <br><i>Der kumulierte (einheitenlose) Verbrauch seid dem Start des aktuellen Abrechnungszeitraumes. Das reading wird einmal am Tag aktualisiert. Die Zeit kennzeichnet den Stand der Daten. (und nicht den Empfangszeitpunkt der Daten)</i></br>
- </li>
- <li>previous_period: Summe des letzten Abrechnungszeitraum
- <br><i>Die (einheitenlose) Summe der Verbauchs im gesamten letzten Abrechnungszeitraum. Das reading wird jeweils zu Beginn eines neuen Abrechnungszeitraumes aktualisiert. Die Zeit kennzeichnet das Ablesedatum also das Ende des vorherigen Abrechnugszeitraumes. (und nicht den Empfangszeitpunkt der Daten)</i></br>
- </li>
- <li>temp1: Umgebungstemperatur</li>
- <li>temp2: Oberflächentemperatur des Heizkörpers</li>
- <br>
- </ul>
- <a name="TechemHKV_Internals"></a>
- <b>Internals</b>
- <ul>
- <li>friendly: die beim define übergebene, zusätzliche Bezeichnung</li>
- <li>longID: 8 Ziffern ID des Heizkostenverteilers</li>
- <br>
- </ul>
- </ul>
- <p><a name="TechemWZ"></a>
- <h3>TechemWZ</h3>
- <div class='langLinks'>[<a href='commandref.html#TechemWZ'>EN</a> DE]</div>
- <ul>
- Das modul empfängt Daten von Techem Volumenzählern. Unterstützte Zählertypen sind
- <p>
- <ul>
- <li>Messkapsel-Wasserzähler radio 3 (Kalt-, Warmwasser)</li>
- <li>Messkapsel-Wärmemengenzähler compact V</li>
- </ul>
- <br>
- Empfangen werden:
- <ul>
- <li>Wert des aktuellen Abrechnungszeitraumes</li>
- <li>Wert des vorhergehenden Abrechnungszeitraumes einschließlich des Ablesedatums</li>
- <li>Gesamter aufgelaufener Verbrauchswert</li>
- </ul>
- <br>
- Zum Empfang wird ein CUL im WMBUS_T mode benötigt. Dabei ist es ausreichend ihn vorrübergehend in diesen Modus zu schalten. Das Modul überwacht den rfmode aller verfügbaren CUL
- <br>
- <br>
- <a name="TechemWZ_preliminary"></a>
- <b>Vorbereitung</b>
- <p>
- Leider übertragen die Techem Volumenzähler nicht die aufgedruckte Zählernummer. Übertragen wird nur die ID des eingebauten Funkmoduls.
- <p>
- Das Modul stellt daher einen <b>"list-mode"</b> zur Verfügung. Damit kann eine Liste aller empfangenen Techem Volumenzähler anzeigt werden. Der "list-mode" wird aktiviert indem ein TechemWZ device mit der ID "00000000" definiert wird.
- Lassen Sie dieses device einige Zeit laufen damit es Informationen über die verfügbaren Zähler sammeln kann. Rufen Sie dann "get <name> list" auf um eine Liste der empfangenen Techem Volumenzähler, ihrer ID sowie der dazugehörigen Zählerstände zu sehen. Denken Sie daran das dies die Werte des letzten Tageswechsels sind.
- Notieren Sie sich anhand dieser Angaben die ID der gesuchten Zähler und definieren sie damit die entsprechenden TechemWZ device. Das list-mode device mit der ID "00000000" kann danach gefahrlos gelöscht werden.
- <br>
- <br>
- <a name="TechemWZ_Define"></a>
- <b>Define</b>
- <br>
- <code>define <name> TechemWZ <8 digit ID> [<speaking name>]</code>
- <ul>
- <li>ID: 8 stellige ID des Funkmoduls(siehe "list-mode")</li>
- <li>speaking name: (optional) Bezeichnung</li>
- </ul>
- <br>
- <a name="TechemWZ_Readings"></a>
- <b>Readings</b>
- <ul>
- <li>current_period: Wert des aktuellen Abrechnungszeitraumes
- <br><i>Der kumulierte Verbrauch seid dem Start des aktuellen Abrechnungszeitraumes. Das reading wird einmal am Tag aktualisiert. Die Zeit kennzeichnet den Stand der Daten. (und nicht den Empfangszeitpunkt der Daten)</i></br>
- </li>
- <li>previous_period: Wert des letzten Ablesezeitpunktes
- <br><i>Zählerstand zum letzten Abrechnungszeitpunkt. Das reading wird zum Ablesezeitpunkt aktualisiert. Die Zeit kennzeichnet das Ablesedatum (und nicht den Empfangszeitpunkt der Daten)</i></br>
- </li>
- <li>meter: gesamter Verbrauch.
- <br><i>Der Zählerstand so wie er an der (mechanischen) Anzeige des Zählers abgelesen werden kann</i></br>
- </li>
- <br>
- </ul>
- <a name="TechemWZ_Get"></a>
- <b>Get</b>
- <ul>
- <li>list: gibt eine Liste der empfangenen Techem Volumenzähler, ihrer ID sowie der dazugehörigen Zählerstände aus.
- <br><i><u>nur im "list-mode" (ID "00000000") verfügbar</u></i></br>
- </li>
- <br>
- </ul>
- <a name="TechemWZ_Internals"></a>
- <b>Internals</b>
- <ul>
- <li>friendly: die beim define übergebene, zusätzliche Bezeichnung</li>
- <br>
- </ul>
- </ul>
- <p><a name="TelegramBot"></a>
- <h3>TelegramBot</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TelegramBot'>TelegramBot</a><br/>
- </ul>
- <a name="TellStick"></a>
- <h3>TellStick</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TellStick'>TellStick</a><br/>
- </ul>
- <a name="TeslaPowerwall2AC"></a>
- <h3>Tesla Powerwall 2 AC</h3>
- <div class='langLinks'>[<a href='commandref.html#TeslaPowerwall2AC'>EN</a> DE]</div>
- <p><a name="Text2Speech"></a>
- <h3>Text2Speech</h3>
- <div class='langLinks'>[<a href='commandref.html#Text2Speech'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="Text2Speechdefine"></a>
- <b>Define</b>
- <ul>
- <b>Local : </b><code>define <name> Text2Speech <alsadevice></code><br>
- <b>Remote: </b><code>define <name> Text2Speech <host>[:<portnr>][:SSL] [portpassword]</code>
- <b>Server : </b><code>define <name> Text2Speech none</code><br>
- <p>
- Das Modul wandelt Text mittels verschiedener Provider/Ressourcen in Sprache um. Dabei kann das Device als
- Remote, Lokales Device oder als Server konfiguriert werden.
- </p>
-
- <li>
- <b>Local Device</b><br>
- <ul>
- Die Ausgabe erfolgt auf angeschlossenen Audiodevices, zb. Lautsprecher direkt am Gerät oder per
- Bluetooth-Lautsprecher per Mplayer. Dazu ist Mplayer zu installieren.<br>
- <code>apt-get install mplayer</code><br>
- Das angegebene Alsadevice ist in der <code>/etc/asound.conf</code> zu konfigurieren.
- <p>
- <b>Special AlsaDevice: </b><i>default</i><br>
- Ist als Alsa-Device <i>default</i> angegeben, so wird mplayer ohne eine Audiodevice Angabe aufgerufen.
- Dementsprechend verwendet mplayer das Standard Audio Ausgabedevice.
- </p>
- <p>
- <b>Beispiel:</b><br>
- <code>define MyTTS Text2Speech hw=0.0</code><br>
- <code>define MyTTS Text2Speech default</code>
- </p>
- </ul>
- </li>
- <li>
- <b>Remote Device</b><br>
- <ul>
- Das Modul ist Client-Server fäas bedeutet, das auf der Haupt-FHEM Installation eine Text2Speech-Instanz
- als Remote definiert wird. Auf dem Client wird Text2Speech als Local definiert. Die Sprachausgabe erfolgt auf
- der lokalen Instanz.<br>
- Zu beachten ist, das die Text2Speech Instanz (Definition als local Device) auf dem Zieldevice identisch benannt ist.
- <ul>
- <li>Host: Angabe der IP-Adresse</li>
- <li>PortNr: Angabe des TelnetPorts von FHEM; default: 7072</li>
- <li>SSL: Angabe ob der der Zugriff per SSL erfolgen soll oder nicht; default: kein SSL</li>
- <li>PortPassword: Angabe des in der Ziel-FHEM-Installtion angegebene Telnet Portpasswort</li>
- </ul>
- <p>
- <b>Beispiel:</b><br>
- <code>define MyTTS Text2Speech 192.168.178.10:7072 fhempasswd</code>
- <code>define MyTTS Text2Speech 192.168.178.10</code>
- </p>
- Wenn ein PRESENCE Gerät die Host IP-Adresse abfragt, wird die blockierende interne Prüfung auf Erreichbarkeit umgangen und das PRESENCE Gerät genutzt.
- </ul>
- </li>
- <li>
- <b>Server Device</b>
- <ul>
- Im Falle der Verwendung als Server, wird nur die MP3 Datei erstellt und als Reading lastFilename dargestellt. Es macht keinen Sinn
- hier das Attribut <i>TTS_speakAsFastAsPossible</i> zu verwenden. Die Verwendung des Attributes <i>TTS_useMP3Wrap</i> wird dringend empfohlen.
- Ansonsten wird hier nur der letzte Teiltext als mp3 Datei im Reading dargestellt.
- </ul>
- </li>
- </ul>
- </ul>
- <a name="Text2Speechset"></a>
- <b>Set</b>
- <ul>
- <li><b>tts</b>:<br>
- Setzen eines Textes zur Sprachausgabe. Um mp3-Dateien direkt auszugeben, müssen diese mit führenden
- und schließenden Doppelpunkten angegebenen sein. Die MP3-Dateien müssen unterhalb des Verzeichnisses <i>TTS_FileTemplateDir</i> gespeichert sein.<br>
- Der Text selbst darf deshalb selbst keine Doppelpunte beinhalten. Siehe Beispiele.
- </li>
- <li><b>volume</b>:<br>
- Setzen der Ausgabe Lautstärke.<br>
- Achtung: Nur bei einem lokal definierter Text2Speech Instanz möglich!
- </li>
- </ul><br>
- <a name="Text2Speechget"></a>
- <b>Get</b>
- <ul>N/A</ul><br>
- <a name="Text2Speechattr"></a>
- <b>Attribute</b>
- <ul>
- <li>TTS_Delemiter<br>
- Optional: Wird ein Delemiter angegeben, so wird der Sprachbaustein an dieser Stelle geteilt.
- Als Delemiter ist nur ein einzelnes Zeichen zulässig.
- Hintergrund ist die Tatsache, das die Google Sprachengine nur 100Zeichen zulässt.<br>
- Im Standard wird nach jedem Satzende geteilt. Ist ein einzelner Satz länger als 100 Zeichen,
- so wird zusätzlich nach Kommata, Semikolon und dem Verbindungswort <i>und</i> geteilt.<br>
- Achtung: Nur bei einem lokal definierter Text2Speech Instanz möglich und nur bei Nutzung der Google Sprachengine relevant!
- </li>
- <li>TTS_Ressource<br>
- Optional: Auswahl der Sprachengine<br>
- Achtung: Nur bei einem lokal definierter Text2Speech Instanz möglich!
- <ul>
- <li>Google<br>
- Nutzung der Google Sprachengine. Ein Internetzugriff ist notwendig! Aufgrund der Qualität ist der
- Einsatz diese Engine zu empfehlen und der Standard.
- </li>
- <li>VoiceRSS<br>
- Nutzung der VoiceRSS Sprachengine. Die Nutzung ist frei bis zu 350 Anfragen pro Tag.
- Wenn mehr benötigt werden ist ein Bezahlmodell wählbar. Ein Internetzugriff ist notwendig!
- Aufgrund der Qualität ist der Einsatz diese Engine ebenfalls zu empfehlen.
- Wenn diese Engine benutzt wird, ist ein APIKey notwendig (siehe TTXS_APIKey)
- </li>
- <li>ESpeak<br>
- Nutzung der ESpeak Offline Sprachengine. Die Qualitä ist schlechter als die Google Engine.
- ESpeak und lame sind vor der Nutzung zu installieren.<br>
- <code>apt-get install espeak lame</code>
- </li>
- <li>SVOX-pico<br>
- Nutzung der SVOX-Pico TTS-Engine (aus dem AOSP).<br>
- Die Sprachengine sowie <code>lame</code> müssen installiert sein:<br>
- <code>sudo apt-get install libttspico-utils lame</code><br><br>
- Für ARM/Raspbian sind die <code>libttspico-utils</code> leider nicht verfügbar,<br>
- deswegen müsste man diese selbst kompilieren oder das vorkompilierte Paket aus <a target="_blank" href"http://www.robotnet.de/2014/03/20/sprich-freund-und-tritt-ein-sprachausgabe-fur-den-rasberry-pi/">dieser Anleitung</a> verwenden, in aller Kürze:<br>
- <code>sudo apt-get install libpopt-dev lame</code><br>
- <code>cd /tmp</code><br>
- <code>wget http://www.dr-bischoff.de/raspi/pico2wave.deb</code><br>
- <code>sudo dpkg --install pico2wave.deb</code>
- </li>
- </ul>
- </li>
-
- <li>TTS_APIKey<br>
- Wenn VoiceRSS genutzt wird, ist ein APIKey notwendig. Um diesen zu erhalten ist eine vorherige
- Registrierung notwendig. Anschließend erhält man den APIKey <br>
- http://www.voicerss.org/registration.aspx <br>
- </li>
- <li>TTS_User<br>
- Bisher ohne Benutzung. Falls eine Sprachengine zusätzlich zum APIKey einen Usernamen im Request verlangt.
- </li>
- <li>TTS_CacheFileDir<br>
- Optional: Die per Google geladenen Sprachbausteine werden in diesem Verzeichnis zur Wiedeverwendung abgelegt.
- Es findet zurZEit keine automatisierte Löschung statt.<br>
- Default: <i>cache/</i><br>
- Achtung: Nur bei einem lokal definierter Text2Speech Instanz möglich!
- </li>
- <li>TTS_UseMP3Wrap<br>
- Optional: Für eine flüssige Sprachausgabe ist es zu empfehlen, die einzelnen vorher per Google
- geladenen Sprachbausteine zu einem einzelnen Sprachbaustein zusammenfassen zu lassen bevor dieses per
- Mplayer ausgegeben werden. Dazu muss Mp3Wrap installiert werden.<br>
- <code>apt-get install mp3wrap</code><br>
- Achtung: Nur bei einem lokal definierter Text2Speech Instanz möglich!
- </li>
- <li>TTS_MplayerCall<br>
- Optional: Angabe der Systemaufrufes zu Mplayer. Das folgende Beispiel ist der Standardaufruf.<br>
- Beispiel: <code>sudo /usr/bin/mplayer</code>
- </li>
- <li>TTS_SentenceAppendix<br>
- Optional: Angabe einer mp3-Datei die mit jeder Sprachausgabe am Ende ausgegeben wird.<br>
- Voraussetzung ist die Nutzung von MP3Wrap. Die Sprachbausteine müssen bereits als mp3 im
- CacheFileDir vorliegen.
- Beispiel: <code>silence.mp3</code>
- </li>
- <li>TTS_FileMapping<br>
- Angabe von möglichen MP3-Dateien mit deren Templatedefinition. Getrennt duch Leerzeichen.
- Die Templatedefinitionen können in den per <i>tts</i> übergebenen Sprachbausteinen verwendet werden
- und müssen mit einem beginnenden und endenden Doppelpunkt angegeben werden.
- Die Dateien müssen im Verzeichnis <i>TTS_FileTemplateDir</i> gespeichert sein.<br>
- <code>attr myTTS TTS_FileMapping ring:ringtone.mp3 beep:MyBeep.mp3</code><br>
- <code>set MyTTS tts Achtung: hier kommt mein Klingelton :ring: War der laut?</code>
- </li>
- <li>TTS_FileTemplateDir<br>
- Verzeichnis, in dem die per <i>TTS_FileMapping</i> und <i>TTS_SentenceAppendix</i> definierten
- MP3-Dateien gespeichert sind.<br>
- Optional, Default: <code>cache/templates</code>
- </li>
- <li>TTS_VolumeAdjust<br>
- Anhebung der Grundlautstärke zur Anpassung an die angeschlossenen Lautsprecher. <br>
- Default: 110<br>
- <code>attr myTTS TTS_VolumeAdjust 400</code><br>
- </li>
- <li>TTS_noStatisticsLog<br>
- <b>1</b>, verhindert das Loggen von Statistikdaten in DbLog Geräten, default ist <b>0</b><br>
- Bitte zur Beachtung: Das Logging ist wichtig um alte, lang nicht genutzte Cachedateien automatisiert zu loeschen.
- Wenn dieses hier dektiviert wird muss sich der User selbst darum kuemmern.
- </li>
- <li>TTS_speakAsFastAsPossible<br>
- Es wird versucht, so schnell als möglich eine Sprachausgabe zu erzielen. Bei Sprachbausteinen die nicht bereits lokal vorliegen,
- ist eine kurze Pause wahrnehmbar. Dann wird der benötigte Sprachbaustein nachgeladen. Liegen alle Sprachbausteine im Cache vor,
- so hat dieses Attribut keine Auswirkung.<br>
- Attribut nur verfügbar bei einer lokalen oder Server Instanz
- </li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a>
- </li><br>
- <li><a href="#disable">disable</a><br>
- If this attribute is activated, the soundoutput will be disabled.<br>
- Possible values: 0 => not disabled , 1 => disabled<br>
- Default Value is 0 (not disabled)<br><br>
- </li>
- <li><a href="#verbose">verbose</a><br>
- <b>4:</b> Alle Zwischenschritte der Verarbeitung werden ausgegeben<br>
- <b>5:</b> Zusätzlich werden auch die Meldungen von Mplayer und Mp3Wrap ausgegeben
- </li>
- </ul><br>
- <a name="Text2SpeechExamples"></a>
- <b>Beispiele</b>
- <ul>
- <code>define MyTTS Text2Speech hw=0.0</code><br>
- <code>set MyTTS tts Die Alarmanlage ist bereit.</code><br>
- <code>set MyTTS tts :beep.mp3:</code><br>
- <code>set MyTTS tts :mytemplates/alarm.mp3:Die Alarmanlage ist bereit.:ring.mp3:</code><br>
- </ul>
- <p><a name="TrashCal"></a>
- <h3>TrashCal</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#TrashCal'>TrashCal</a><br/>
- </ul>
- <a name="Twilight"></a>
- <h3>Twilight</h3>
- <div class='langLinks'>[<a href='commandref.html#Twilight'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="Twilightdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Twilight <latitude> <longitude> [<indoor_horizon> [<Weather_Position>]]</code><br>
- <br>
- Erstellt ein virtuelles Device für die Dämmerungsberechnung (Zwielicht)<br><br>
- <b>latitude, longitude (geografische Länge & Breite)</b>
- <br>
- Die Parameter <b>latitude</b> und <b>longitude</b> sind Dezimalzahlen welche die Position auf der Erde bestimmen, für welche der Dämmerungs-Status berechnet werden soll.
- <br><br>
- <b>indoor_horizon</b>
- <br>
- Der Parameter <b>indoor_horizon</b> bestimmt einen virtuellen Horizont, der für die Berechnung der Dämmerung innerhalb von Rämen genutzt werden kann. Minimalwert ist -6 (ergibt gleichen Wert wie Zivile Dämmerung). Bei 0 fallen
- indoor- und realer Dämmerungswert zusammen. Werte grösser 0 ergeben frühere Werte für den Abend bzw. spätere für den Morgen.
- <br><br>
- <b>Weather_Position</b>
- <br>
- Der Parameter <b>Weather_Position</b> ist die Yahoo! Wetter-ID welche für den Bezug der Wetterinformationen gebraucht wird. Gehe auf http://weather.yahoo.com/ und gebe einen Ort (ggf. PLZ) ein. In der URL der daraufhin geladenen Seite ist an letzter Stelle die ID. Beispiel: München, Deutschland -> 676757
- <br><br>
- Ein Twilight-Device berechnet periodisch die Dämmerungszeiten und -phasen während des Tages.
- Es berechnet ein virtuelles "Licht"-Element das einen Indikator für die momentane Tageslichtmenge ist.
- Neben der Position auf der Erde wird es vom sog. "indoor horizon" (Beispielsweise hohe Gebäde oder Berge)
- und dem Wetter beeinflusst. Schlechtes Wetter führt zu einer Reduzierung des Tageslichts für den ganzen Tag.
- Das berechnete Licht liegt zwischen 0 und 6 wobei die Werte folgendes bedeuten:<br><br>
- <b>light</b>
- <br>
- <code>0 - Totale Nacht, die Sonne ist mind. -18 Grad hinter dem Horizont</code><br>
- <code>1 - Astronomische Dämmerung, die Sonne ist zw. -12 und -18 Grad hinter dem Horizont</code><br>
- <code>2 - Nautische Dämmerung, die Sonne ist zw. -6 and -12 Grad hinter dem Horizont</code><br>
- <code>3 - Zivile/Bürgerliche Dämmerung, die Sonne ist zw. 0 and -6 hinter dem Horizont</code><br>
- <code>4 - "indoor twilight", die Sonne ist zwischen dem Wert indoor_horizon und 0 Grad hinter dem Horizont (wird nicht verwendet wenn indoor_horizon=0)</code><br>
- <code>5 - Wetterbedingte Dämmerung, die Sonne ist zwischen indoor_horizon und einem virtuellen Wetter-Horizonz (der Wetter-Horizont ist Wetterabhängig (optional)</code><br>
- <code>6 - Maximales Tageslicht</code><br>
- <br>
- <b>Azimut, Elevation, Twilight (Seitenwinkel, Höhenwinkel, Dämmerung)</b>
- <br>
- Das Modul berechnet zusätzlich Azimuth und Elevation der Sonne. Diese Werte können zur Rolladensteuerung verwendet werden.<br><br>
- Das Reading <b>Twilight</b> wird als neuer "(twi)light" Wert hinzugefügt. Er wird aus der Elevation der Sonne mit folgender Formel abgeleitet: (Elevation+12)/18 * 100). Das erlaubt eine detailliertere Kontrolle der Lampen während Sonnenauf - und untergang. Dieser Wert ist zwischen 0% und 100% wenn die Elevation zwischen -12° und 6°
- <br><br>
- Wissenswert dazu ist, dass die Sonne, abhägnig vom Breitengrad, bestimmte Elevationen nicht erreicht. Im Juni und Juli liegt die Sonne in Mitteleuropa nie unter -18°. In nördlicheren Gebieten (Norwegen, ...) kommt die Sonne beispielsweise nicht über 0°.
- <br><br>
- All diese Aspekte müssen berücksichtigt werden bei Schaltungen die auf Twilight basieren.
- <br><br>
- Beispiel:
- <pre>
- define myTwilight Twilight 49.962529 10.324845 3 676757
- </pre>
- </ul>
- <br>
- <a name="Twilightset"></a>
- <b>Set </b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="Twilightget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> <reading></code><br><br>
- <table>
- <tr><td><b>light</b></td><td>der aktuelle virtuelle Tageslicht-Wert</td></tr>
- <tr><td><b>nextEvent</b></td><td>Name des nächsten Events</td></tr>
- <tr><td><b>nextEventTime</b></td><td>die Zeit wann das nächste Event wahrscheinlich passieren wird (während Lichtphase 5 und 6 wird dieser Wert aktualisiert wenn sich das Wetter ändert)</td></tr>
- <tr><td><b>sr_astro</b></td><td>Zeit des astronomitschen Sonnenaufgangs</td></tr>
- <tr><td><b>sr_naut</b></td><td>Zeit des nautischen Sonnenaufgangs</td></tr>
- <tr><td><b>sr_civil</b></td><td>Zeit des zivilen/bürgerlichen Sonnenaufgangs</td></tr>
- <tr><td><b>sr</b></td><td>Zeit des Sonnenaufgangs</td></tr>
- <tr><td><b>sr_indoor</b></td><td>Zeit des "indoor" Sonnenaufgangs</td></tr>
- <tr><td><b>sr_weather</b></td><td>"Wert" des Wetters beim Sonnenaufgang</td></tr>
- <tr><td><b>ss_weather</b></td><td>"Wert" des Wetters beim Sonnenuntergang</td></tr>
- <tr><td><b>ss_indoor</b></td><td>Zeit des "indoor" Sonnenuntergangs</td></tr>
- <tr><td><b>ss</b></td><td>Zeit des Sonnenuntergangs</td></tr>
- <tr><td><b>ss_civil</b></td><td>Zeit des zivilen/bürgerlichen Sonnenuntergangs</td></tr>
- <tr><td><b>ss_nautic</b></td><td>Zeit des nautischen Sonnenuntergangs</td></tr>
- <tr><td><b>ss_astro</b></td><td>Zeit des astro. Sonnenuntergangs</td></tr>
- <tr><td><b>azimuth</b></td><td>aktueller Azimuth der Sonne. 0° ist Norden 180° ist Süden</td></tr>
- <tr><td><b>compasspoint</b></td><td>Ein Wortwert des Kompass-Werts</td></tr>
- <tr><td><b>elevation</b></td><td>the elevaltion of the sun</td></tr>
- <tr><td><b>twilight</b></td><td>Prozentualer Wert eines neuen "(twi)light" Wertes: (elevation+12)/18 * 100) </td></tr>
- <tr><td><b>twilight_weather</b></td><td>Prozentualer Wert eines neuen "(twi)light" Wertes: (elevation-WEATHER_HORIZON+12)/18 * 100). Wenn ein Wetterwert vorhanden ist, ist es immer etwas dunkler als bei klarem Wetter.</td></tr>
- <tr><td><b>condition</b></td><td>Yahoo! Wetter code</td></tr>
- <tr><td><b>condition_txt</b></td><td>Yahoo! Wetter code als Text</td></tr>
- <tr><td><b>horizon</b></td><td>Wert des aktuellen Horizont 0°, -6°, -12°, -18°</td></tr>
- </table>
- </ul>
- <br>
- <a name="Twilightattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- <li><b>useExtWeather <device>:<reading></b></li>
- Nutzt Daten von einem anderen Device um <b>twilight_weather</b> zu berechnen.<br/>
- Das Reading sollte sich im Intervall zwischen 0 und 100 bewegen, z.B. das Reading <b>c_clouds</b> in einem<b><a href="#openweathermap">openweathermap</a></b> device, bei dem 0 heiteren und 100 bedeckten Himmel bedeuten.
- Wird diese Attribut genutzt , werden Wettereffekte wie Starkregen oder Gewitter fuer die Berechnung von <b>twilight_weather</b> nicht mehr herangezogen.
- </ul>
- <br>
- <a name="Twilightfunc"></a>
- <b>Functions</b>
- <ul>
- <li><b>twilight</b>(<b>$twilight</b>, <b>$reading</b>, <b>$min</b>, <b>$max</b>)</li> - implementiert eine Routine um die Dämmerungszeiten wie Sonnenaufgang mit min und max Werten zu berechnen.<br><br>
- <table>
- <tr><td><b>$twilight</b></td><td>Name der twiligh Instanz</td></tr>
- <tr><td><b>$reading</b></td><td>Name des zu verwendenden Readings. Beispiel: ss_astro, ss_weather ...</td></tr>
- <tr><td><b>$min</b></td><td>Parameter min time - optional</td></tr>
- <tr><td><b>$max</b></td><td>Parameter max time - optional</td></tr>
- </table>
- </ul>
- <br>
- Anwendungsbeispiel:
- <pre>
- define BlindDown at *{twilight("myTwilight","sr_indoor","7:30","9:00")} set xxxx position 100
- # xxxx ist ein definiertes Rollo
- </pre>
- </ul>
- <p><a name="UNIRoll"></a>
- <h3>UNIRoll</h3>
- <div class='langLinks'>[<a href='commandref.html#UNIRoll'>EN</a> DE]</div>
- Deutsche Version der Doku nicht vorhanden. Englische Version unter
- <a href='http://fhem.de/commandref.html#<UNIRoll>'>UNIRoll</a>
- <p><a name="USBWX"></a>
- <h3>USBWX</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#USBWX'>USBWX</a><br/>
- </ul>
- <a name="USF1000"></a>
- <h3>USF1000</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#USF1000'>USF1000</a><br/>
- </ul>
- <a name="UWZ"></a>
- <h3>UWZ</h3>
- <div class='langLinks'>[<a href='commandref.html#UWZ'>EN</a> DE]</div>
- <ul>
- <a name="UWZdefine"></a>
- Das Modul extrahiert Unwetterwarnungen von <a href="http://www.unwetterzentrale.de">www.unwetterzentrale.de</a>.
- <br/>
- Hierfür wird die selbe Schnittstelle verwendet die auch die Android App <a href="http://www.alertspro.com">Alerts Pro</a> nutzt.
- Es werden maximal 10 Standortbezogene Unwetterwarnungen zur Verfügung gestellt.
- Weiterhin verfügt das Modul über HTML-Templates welche als weblink verwendet werden können.
- <br>
- <i>Es nutzt die Perl-Module HTTP::Request, LWP::UserAgent, JSON, Encode::Guess und HTML::Parse</i>.
- <br/><br/>
- <b>Define</b>
- <ul>
- <br>
- <code>define <Name> UWZ [Ländercode] [Postleitzahl] [INTERVAL]</code>
- <br><br><br>
- Beispiel:
- <br>
- <code>define Unwetterzentrale UWZ DE 86405 3600</code>
- <br>
- <li><code>[Ländercode]</code>
- <br>
- Mögliche Werte: DE, AT, CH, SEARCH, ...<br/>
- (für ander Länder als Deutschland bitte den SEARCH Parameter nutzen um die AreaID zu ermitteln.)
- </li><br>
- <li><code>[Postleitzahl/AreaID]</code>
- <br>
- Die Postleitzahl/AreaID des Ortes für den Unwetterinformationen abgefragt werden sollen.
- <br>
- </li><br>
- <li><code>[INTERVAL]</code>
- <br>
- Definiert das Interval zur aktualisierung der Unwetterwarnungen. Das Interval wird in Sekunden angegeben, somit aktualisiert das Modul bei einem Interval von 3600 jede Stunde 1 mal.
- <br>
- </li><br>
- </ul>
- <br>
- <a name="UWZget"></a>
- <b>Get</b>
- <ul>
- <br>
- <li><code>get <name> Bodenfrost</code>
- <br>
- Gibt aus ob aktuell eine Bodenfrostwarnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Extremfrost</code>
- <br>
- Gibt aus ob aktuell eine Extremfrostwarnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Gewitter</code>
- <br>
- Gibt aus ob aktuell eine Gewitter Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Glaette</code>
- <br>
- Gibt aus ob aktuell eine Glaettewarnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Glatteisregen</code>
- <br>
- Gibt aus ob aktuell eine Glatteisregen Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Hagel</code>
- <br>
- Gibt aus ob aktuell eine Hagel Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Hitze</code>
- <br>
- Gibt aus ob aktuell eine Hitze Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Regen</code>
- <br>
- Gibt aus ob aktuell eine Regen Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Schneefall</code>
- <br>
- Gibt aus ob aktuell eine Schneefall Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Sturm</code>
- <br>
- Gibt aus ob aktuell eine Sturm Warnung besteht (active|inactive).
- </li><br>
- <li><code>get <name> Waldbrand</code>
- <br>
- Gibt aus ob aktuell eine Waldbrand Warnung besteht (active|inactive).
- </li><br>
- </ul>
-
- <br>
- <b>Get (Search-Mode)</b>
- <ul>
- <br>
- <li><code>get <name> SearchAreaID <gesuchte_stadt></code>
- <br>
- Gibt die AreaID zum eingegebenen Ort aus.
- </li><br>
- </ul>
-
- <br>
- <a name="UWZset"></a>
- <b>Set</b>
- <ul>
- <br>
- <li><code>set <name> update</code>
- <br>
- Startet sofort ein neues Auslesen der Unwetterinformationen.
- </li><br>
- </ul>
-
- <br>
- <a name="UWZattr"></a>
- <b>Attribute</b>
- <ul>
- <br>
- <li><code>download</code>
- <br>
- Download Unwetterkarten während des updates (0|1).
- <br>
- </li>
- <li><code>savepath</code>
- <br>
- Pfad zum speichern der Karten (default: /tmp/).
- <br>
- </li>
- <li><code>maps</code>
- <br>
- Leerzeichen separierte Liste der zu speichernden Karten. Für mögliche Karten siehe <code>UWZAsHtmlKarteLand</code>.
- <br>
- </li>
- <li><code>humanreadable</code>
- <br>
- Anzeige weiterer Readings Warn_?_Start_Date, Warn_?_Start_Time, Warn_?_End_Date, Warn_?_End_Time. Diese Readings enthalten aus dem Timestamp kalkulierte Datums/Zeit Angaben. Weiterhin werden folgende Readings aktivier: Warn_?_Type_Str und Warn_?_uwzLevel_Str welche den Unwettertyp als auch das Unwetter-Warn-Level als Text ausgeben. (0|1)
- <br>
- </li>
- <li><code>lang</code>
- <br>
- Umschalten der angeforderten Sprache für kurz und lange warn text. (de|en|it|fr|es|..).
- <br>
- </li>
- <li><code>sort_readings_by</code>
- <br>
- Sortierreihenfolge der Warnmeldungen. (start|severity|creation).
- <br>
- </li>
- <li><code>htmlsequence</code>
- <br>
- Anzeigereihenfolge der html warnungen. (ascending|descending).
- <br>
- </li>
- <li><code>htmltitle</code>
- <br>
- Titel / Ueberschrift der HTML Ausgabe
- <br>
- </li>
- <li><code>htmltitleclass</code>
- <br>
- css-Class des Titels der HTML Ausgabe
- <br>
- </li>
- <li><code>localiconbase</code>
- <br>
- BaseURL angeben um Warn Icons lokal zu hosten. (Dateityp ist png).
- <br>
- </li>
- <li><code>intervalAtWarnLevel</code>
- <br>
- konfiguriert den Interval je nach WarnLevel. Beispiel: 2=1800,3=900,4=300
- <br>
- </li>
- <br>
- </ul>
- <br>
- <a name="UWZreading"></a>
- <b>Readings</b>
- <ul>
- <br>
- <li><b>Warn_</b><i>0|1|2|3...|9</i><b>_...</b> - aktive Warnmeldungen</li>
- <li><b>WarnCount</b> - Anzahl der aktiven Warnmeldungen</li>
- <li><b>WarnUWZLevel</b> - Gesamt Warn Level </li>
- <li><b>WarnUWZLevel_Color</b> - Gesamt Warn Level Farbe</li>
- <li><b>WarnUWZLevel_Str</b> - Gesamt Warn Level Text</li>
- <li><b>Warn_</b><i>0</i><b>_AltitudeMin</b> - minimum Höhe für Warnung </li>
- <li><b>Warn_</b><i>0</i><b>_AltitudeMax</b> - maximum Höhe für Warnung </li>
- <li><b>Warn_</b><i>0</i><b>_EventID</b> - EventID der Warnung </li>
- <li><b>Warn_</b><i>0</i><b>_Creation</b> - Warnungs Erzeugung </li>
- <li><b>Warn_</b><i>0</i><b>_Creation_Date</b> - Warnungs Erzeugungs Datum </li>
- <li><b>Warn_</b><i>0</i><b>_Creation_Time</b> - Warnungs Erzeugungs Zeit </li>
- <li><b>currentIntervalMode</b> - default/warn, aktuell Verwendeter Interval. Internal INTERVAL oder INTERVALWARN</li>
- <li><b>Warn_</b><i>0</i><b>_Start</b> - Begin der Warnung</li>
- <li><b>Warn_</b><i>0</i><b>_Start_Date</b> - Startdatum der Warnung</li>
- <li><b>Warn_</b><i>0</i><b>_Start_Time</b> - Startzeit der Warnung</li>
- <li><b>Warn_</b><i>0</i><b>_End</b> - Warn Ende</li>
- <li><b>Warn_</b><i>0</i><b>_End_Date</b> - Enddatum der Warnung</li>
- <li><b>Warn_</b><i>0</i><b>_End_Time</b> - Endzeit der Warnung</li>
- <li><b>Warn_</b><i>0</i><b>_Severity</b> - Schwere des Unwetters (0 kein Unwetter, 12 massives Unwetter)</li>
- <li><b>Warn_</b><i>0</i><b>_Hail</b> - Hagelwarnung (1|0)</li>
- <li><b>Warn_</b><i>0</i><b>_Type</b> - Art des Unwetters</li>
- <li><b>Warn_</b><i>0</i><b>_Type_Str</b> - Art des Unwetters (text)</li>
- <ul>
- <li><b>1</b> - unbekannt</li>
- <li><b>2</b> - Sturm/Orkan</li>
- <li><b>3</b> - Schneefall</li>
- <li><b>4</b> - Regen</li>
- <li><b>5</b> - Extremfrost</li>
- <li><b>6</b> - Waldbrandgefahr</li>
- <li><b>7</b> - Gewitter</li>
- <li><b>8</b> - Glätte</li>
- <li><b>9</b> - Hitze</li>
- <li><b>10</b> - Glatteisregen</li>
- <li><b>11</b> - Bodenfrost</li>
- </ul>
- <li><b>Warn_</b><i>0</i><b>_uwzLevel</b> - Unwetterwarnstufe (0-5)</li>
- <li><b>Warn_</b><i>0</i><b>_uwzLevel_Str</b> - Unwetterwarnstufe (text)</li>
- <li><b>Warn_</b><i>0</i><b>_levelName</b> - Level Warn Name</li>
- <li><b>Warn_</b><i>0</i><b>_ShortText</b> - Kurzbeschreibung der Warnung</li>
- <li><b>Warn_</b><i>0</i><b>_LongText</b> - Ausführliche Unwetterbeschreibung</li>
- <li><b>Warn_</b><i>0</i><b>_IconURL</b> - Kumulierte URL um Warnungs-Icon von <a href="http://www.unwetterzentrale.de">www.unwetterzentrale.de</a> anzuzeigen</li>
- </ul>
- <br>
- <a name="UWZweblinks"></a>
- <b>Weblinks</b>
- <ul>
- <br>
- Über die Funktionen <code>UWZAsHtml, UWZAsHtmlLite, UWZAsHtmlFP, UWZAsHtmlKarteLand, UWZAsHtmlMovie</code> wird HTML-Code zur Warnanzeige und Wetterfilme über weblinks erzeugt.
- <br><br><br>
- Beispiele:
- <br>
- <li><code>define UnwetterDetailiert weblink htmlCode {UWZAsHtml("Unwetterzentrale")}</code></li>
- <br>
- <li><code>define UnwetterLite weblink htmlCode {UWZAsHtmlLite("Unwetterzentrale")}</code></li>
- <br>
- <li><code>define UnwetterFloorplan weblink htmlCode {UWZAsHtmlFP("Unwetterzentrale")}</code></li>
- <br>
- <li><code>define UnwetterKarteLand weblink htmlCode {UWZAsHtmlKarteLand("Unwetterzentrale","Bayern")}</code></li>
- <ul>
- <li>Der zweite Parameter kann einer der folgenden sein:
- <ul>
- <li>europa</li>
- <br/>
- <li>deutschland</li>
- <li>deutschland-small</li>
- <li>niedersachsen</li>
- <li>bremen</li>
- <li>bayern</li>
- <li>schleswig-holstein</li>
- <li>hamburg</li>
- <li>mecklenburg-vorpommern</li>
- <li>sachsen</li>
- <li>sachsen-anhalt</li>
- <li>nordrhein-westfalen</li>
- <li>thueringen</li>
- <li>rheinland-pfalz</li>
- <li>saarland</li>
- <li>baden-wuerttemberg</li>
- <li>hessen</li>
- <li>brandenburg</li>
- <li>berlin</li>
- <br/>
- <li>oesterreich</li>
- <li>burgenland</li>
- <li>kaernten</li>
- <li>niederoesterreich</li>
- <li>oberoesterreich</li>
- <li>salzburg</li>
- <li>steiermark</li>
- <li>tirol</li>
- <li>vorarlberg</li>
- <li>wien</li>
- <br/>
- <li>schweiz</li>
- <li>aargau</li>
- <li>appenzell_ausserrhoden</li>
- <li>appenzell_innerrhoden</li>
- <li>basel_landschaft</li>
- <li>basel_stadt</li>
- <li>bern</li>
- <li>fribourg</li>
- <li>geneve</li>
- <li>glarus</li>
- <li>graubuenden</li>
- <li>jura</li>
- <li>luzern</li>
- <li>neuchatel</li>
- <li>nidwalden</li>
- <li>obwalden</li>
- <li>schaffhausen</li>
- <li>schwyz</li>
- <li>solothurn</li>
- <li>stgallen</li>
- <li>ticino</li>
- <li>thurgau</li>
- <li>uri</li>
- <li>waadt</li>
- <li>wallis</li>
- <li>zug</li>
- <li>zuerich</li>
- <br/>
- <li>liechtenstein</li>
- <br/>
- <li>belgique</li>
- <br/>
- <li>denmark</li>
- <br/>
- <li>finnland</li>
- <br/>
- <li>france</li>
- <br/>
- <li>letzebuerg</li>
- <br/>
- <li>nederland</li>
- <br/>
- <li>norwegen</li>
- <br/>
- <li>portugal</li>
- <br/>
- <li>sverige</li>
- <br/>
- <li>espana</li>
- <br/>
- <li>unitedkingdom</li>
- <li>eastofengland</li>
- <li>eastmidlands</li>
- <li>london</li>
- <li>northeastengland</li>
- <li>northernireland</li>
- <li>northwestengland</li>
- <li>scotland</li>
- <li>southeastengland</li>
- <li>southwestengland</li>
- <li>wales</li>
- <li>westmidlands</li>
- <li>yorkshireandthehumber</li>
- <br/>
- <li>isobaren1</li>
- <li>isobaren2</li>
- <li>isobaren3</li>
- </ul>
- </li>
- </ul>
- <li><code>define UnwetterKarteMovie weblink htmlCode {UWZAsHtmlMovie("Unwetterzentrale","niederschlag-wolken-de")}</code></li>
- <ul>
- <li>Der zweite Parameter kann einer der folgenden sein:
- <ul>
- <li>niederschlag-wolken</li>
- <li>stroemung</li>
- <li>temperatur</li>
- <br/>
- <li>niederschlag-wolken-de</li>
- <li>stroemung-de</li>
- <br/>
- <li>niederschlag-wolken-ch</li>
- <li>stroemung-ch</li>
- <br/>
- <li>niederschlag-wolken-at</li>
- <li>stroemung-at</li>
- <br/>
- <li>clouds-precipitation-uk</li>
- <li>currents-uk</li>
- <br/>
- </ul>
- </li>
- </ul>
- <br/><br/>
- </ul>
- <br>
-
- </ul>
- <p><a name="UbiquitiMP"></a>
- <h3>UbiquitiMP</h3>
- <div class='langLinks'>[<a href='commandref.html#UbiquitiMP'>EN</a> DE]</div>
- <ul>
- FHEM Modul für die Ubiquiti mFi mPower Schaltsteckdosen<br>
- Mehr Informationen zu den verschiedenen mPower Modellen im <a href="https://wiki.fhem.de/wiki/Ubiquit_mFi/mPower">Wiki</a> unter https://wiki.fhem.de/wiki/Ubiquit_mFi/mPower<br>
- FHEM Forum : http://forum.fhem.de/index.php/topic,35722.0.html
- <a name="UbiquitiMPdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> UbiquitiMP <IP oder FQDN></code><br>
- Beispiel :<br>
- define myUbi UbiquitiMP 192.168.0.100<br>
- define myUbi UbiquitiMP myhost.mynet.net<br>
- Das Perl Net::Telnet und sowie das JSON Modul werden unbedingt benötigt.
- Auf einem Raspberry Pi können diese mit den folgenden beiden Kommandos installiert werden:<br>
- sudo apt-get install libjson-perl<br>
- sudo apt-get install libnet-telnet-perl
- </ul>
- <br>
- <a name="UbiquitiMPset"></a>
- <b>Set </b>
- <ul>
- <li>Outx on / off (force) -> schaltet den Port x an oder aus</li>
- <li>Outx toggle -> schaltet den Port aus wenn er an ist und umgekehrt</li>
- <li>Outx lock / unlock -> Ist lock bei einem Port gesetzt kann er nicht mehr an oder aus geschaltet werden</li>
- <li>Outx reset -> setzt den internen Verbrauchszähler für diesen Port zurück</li>
- <li>Outx enable / disable -> interne Verbrauchsmessung für diesen Port ein / aus schalten</li>
- <br><b>Bei der mPower mini entfällt die Angabe von Outx !</b><br>
- Zusätzlich unterstützt die mini die <a href="#setExtensions">set Extensions</a> direkt
- </ul>
- <a name="UbiquitiMPget"></a>
- <b>Get</b>
- <ul>
- <li>status -> Gibt den aktuellen Status aller Ports zurück</li>
- <li>info -> liefert einige interne Parameter des Gerätes</li>
- <li>reboot -> Startet das Gerät neu</li><br>
- </ul>
- <a name="UbiquitiMPattr"></a>
- <b>Attributes</b>
- <ul>
- <li>ignoreList -> Liste der Ports die bei Abfragen ignoriert werden sollen, Bsp. <code>attr Ubi ignoreList 456</code><br>
- ignoriert alle Werte der Ports 4,5 und 6</li><br>
- <li>groupPorts -> Durch Kommatas getrennte Liste um Ports in Gruppen zusammen zu fassen.<br>
- Die Gruppen können danach wie win einzelner Port behandelt werden.<br>
- Bsp. <code>attr Ubi groupPorts TV=12 Media=4,5,6</code> (GruppenName=Port Nummer des Ports in der Gruppe)<br>
- <code>set Ubi TV on</code> oder <code>set Ubi Media toggle</code></li><br>
- <li>ledconnect -> Farbe der LED beim Zugriff mit fhem</li><br>
- <li>subDevices -> Legt für jeden Port ein eigenes Subdevice an<br>
- (Default 1 für die 3 and 6 Port mPower, Default 0 für die mPower 1 Port mini) benötigt zusätzlich das Modul 98_UbiquitiOut.pm</li><br>
- <li>interval -> Abfrage Interval in Sekunden, kann ausgeschaltet werden mit dem Wert 0 (Default ist 300)</li><br>
- <li>timeout -> Wartezeit in Sekunden bevor eine Abfrage mit einer Fehlermeldung abgebrochen wird (Default ist 5 Sekunden)<br>
- Werte unter zwei Sekunden werden vom Modul nicht angenommen !</li><br>
- <li>user -> Login Username (Default ubnt)</li><br>
- <li>password -> Login Passwort (Default ubnt)</li>
- </ul>
- <br>
- </ul>
- <p><a name="UbiquitiOut"></a>
- <h3>UbiquitiOut</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#UbiquitiOut'>UbiquitiOut</a><br/>
- </ul>
- <a name="Unifi"></a>
- <h3>Unifi</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Unifi'>Unifi</a><br/>
- </ul>
- <a name="UnifiVideo"></a>
- <h3>UnifiVideo</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#UnifiVideo'>UnifiVideo</a><br/>
- </ul>
- <a name="UpsPico"></a>
- <h3>UpsPico</h3>
- <div class='langLinks'>[<a href='commandref.html#UpsPico'>EN</a> DE]</div>
- <ul>
- <table>
- <tr>
- <td>
- Der UpsPIco ist eine unterbrechungsfreie Stroimversorgung für den Raspberry Pi von PiModules. Dieses Modul wurde für die Firmware ab Version 0x38 und höher geschrieben und wurde nur auf dem "UPS PIco HV3.0A Stack Plus" getestet.<BR>
- Dieses Modul stellt alle internen Daten zur Verfügung, welche in die UpsPIco Register geschrieben und über den I2C - Bus ausgelesen werden. Der set-Befehl ist darüber hinaus in der Lage die Werte der Register entsprechend Ihrer Spezifikation zu ändern.<BR>
- Detailierte Informationen zu den einzelnen Registern stehen in den Register Spezifikationen in der letzten veröffentlichten Anleitung. (Siehe unten)<BR>
- <BR>
- <u>Referenzen:</u><BR>
- <a href="http://www.pimodulescart.com/shop/item.aspx?itemid=29">UPS PIco HV3.0A Stack Plus</a><BR>
- <a href="http://www.forum.pimodules.com/viewforum.php?f=25">UPS PIco HV3.0A : Interne Register Spezification, Anleitung and Firmware Updates</a><BR>
- <BR>
- </td>
- </tr>
- </table>
-
- <table>
- <tr><td><a name="UpsPicodefine"></a><b>Define</b></td></tr>
- </table>
- <table><tr><td><ul><code>define <name> UpsPico <IPv4-address> <Username> <Password></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der Name des Device. Empfehlung: "myUpsPico".</td></tr>
- <tr><td><code><IPv4-address></code> : </td><td>Eine gültige IPv4 Adresse des Raspberry Pi mit UpsPIco. Gegebenenfalls muss der Router für die an den Raspberry Pi vergebene DHCP Adresse konsultiert werden.</td></tr>
- <tr><td><code><GatewayPassword></code> : </td><td>Der Username des entfernten Raspberry Pi.</td></tr>
- <tr><td><code><PrivatePassword></code> : </td><td>Das Passwort des entfernten Raspberry Pi.</td></tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="UpsPicoSet"></a><b>Set</b></td></tr>
- <tr><td>
- <ul>
- Diese Funktion verändert die Werte der register, welche als beschreibbar definiert sind.<BR>
- Sind die entsprechenden Register als kritisch (critical) spezifiziert (Ein falscher Wert könnte zur Beschädigung des UpsPIco führen), muss das Atttribut "WriteCritical" vorher auf "1" gesetzt werden.
- </ul>
- </td></tr>
- </table>
- <table><tr><td><ul><code>set <name> <register> <value></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der name des definierten UpsPico Device<BR></td></tr>
- <tr><td><code><register></code> : </td><td>Der name des Registers welches verändert werden soll. E.g.: "<code>/Status/key</code>"<BR></td></tr>
- <tr><td><code><value></code> : </td><td>Ein gültiger Wert für das Register.<BR></td></tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="UpsPicoGet"></a><b>Get</b></td></tr>
- <tr><td>
- <ul>
- Die get Funktion liest einzelne Register aus und schreibt sie in das entsprechende Reading.<BR>
- Es wird nur der Wert, aber nicht die Einheit oder der gültige Wertebereich zurückgegeben.<BR>
- </ul>
- </td></tr>
- </table>
- <table><tr><td><ul><code>get <name> <register></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der name des definierten UpsPico Device<BR></td></tr>
- <tr><td><code><register></code> : </td><td>Der name des Registers welches ausgelesen werden soll. E.g.: "<code>/Status/key</code>"<BR></td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="UpsPicoAttr"></a><b>Attributes</b></td></tr>
- <tr><td>
- <ul>
- <BR>
- Die folgenden Attribute können neben den allgemeinen Attributen wie <a href="#room">room</a> vergeben werden.<BR>
- </ul>
- </td></tr>
- </table>
- <table>
- <td>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>PollingInterval</code> : </li></td><td>Abrageinterval für den UPS PIco. Der Wert muss >=20s sein um einen vollen Polling Zyklus zu erlauben.<BR>
- Der Defaul Wert ist 300s.<BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>WriteCritical</code> : </li></td><td>Verhindert versehentliche Beschädigungen durch Beschreiben der kritischen Register mit falschen Werten.<BR>
- Musz für jeden einzelnen Schreibvorgang erneut gesetzt werden da dieser zurückgesetzt wird..<BR>
- Der Default Wert ist 0 = Deaktiviert.<BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>Port</code> : </li></td><td>Port Nummer für den SSH Zugang am entfernten Raspberry Pi.<BR>
- Der Default Wert ist 22 = Standard SSH Port<BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>CredentialsEncrypted</code> : </li></td><td>Definiert ob die Anmeldedaten in lesbarer Form (PlainText) oder als base64 verschlüsselt vorliegen.<BR>
- Der Default Wert ist 0 = Anmeldedaten liegen in PlainText vor.<BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>DbLogExclude</code> : </li></td><td>Generelles Attribut um Readings von Loggen auszuschließen. Das Attribut wird automatisch auf "/Status/pico_is_running" gesetzt welchen den kontinuierlichen Watchdog Zähler vom loggen ausnimmt.<BR>
- Es ergibt keinen Sinn dieses Reading zu loggen.<BR>
- Der Default Wert für die Ausnahme vom loggen liegt auf dem Reading "/Status/pico_is_running" <BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>event-on-change-reading</code> : </li></td><td>Generelles Attribut um Events nur bei änderungen von Readings zu erzeugen. Das Attribut wird automatisch auf ".*" gesetzt, was alle Readings nur bei änderungen loggt.<BR>
- Der Default Wert ist ".*" = Alle Readings.<BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- <ul><ul>
- <tr>
- <td>
- <BR>
- <tr><td><ul><li><code>room</code> : </li></td><td>Generelles Attribut zum setzen des Raumes. Das Attribut wird automatisch auf "UpsPIco" gesetzt, damit das device nicht im "Everthing" Raum verschwindet.<BR>
- Der Default Wert ist "UpsPIco".<BR>
- </ul></td></tr>
- </td>
- </tr>
- </ul></ul>
- </td>
- </table>
- </ul>
- <p><a name="Utils"></a>
- <h3>Utils</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#Utils'>Utils</a><br/>
- </ul>
- <a name="VBUSDEV"></a>
- <h3>VBUSDEV</h3>
- <div class='langLinks'>[<a href='commandref.html#VBUSDEV'>EN</a> DE]</div>
- <ul>
- Bei dem VBus handelt es sich um eine bidirektionale halbduplex Zweidrahtschnittstelle.<br><br>
-
- Notwendig ist dazu ein RESOL-Adapter (USB oder LAN), zu dem hier Informationen zu finden sind:<br>
- <a href="http://www.resol.de/">http://www.resol.de/</a><br><br>
-
- Weitere Informationen hierzu findet man unter <a href="http://hobbyelektronik.org/w/index.php/VBus-Decoder"> http://hobbyelektronik.org/w/index.php/VBus-Decoder/</a>
- und auch auf github <a href="https://github.com/pejonp/vbus"> https://github.com/pejonp/vbus </a><br><br><br>
- <br />
- <a name="VBUSDEV_Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> VBUSDEV <id> [<interval>]</code><br />
- <br />
- Definition eines RESOL VBus Geraetes. Wenn das Geraet schon in der Liste hinterlegt ist, wird es automatisch angelegt.<br />
- Beispiel:
- <ul>
- <code>define VBUSDEV_7321 VBUSDEV 7321 </code><br />
- </ul>
- </ul><br />
- <a name="VBUSDEV_Readings"></a>
- <b>Readings</b>
- <ul>
- <li>The readings are dependant of the model of the VBUS device.</li><br />
- </ul><br />
-
- </ul><br />
- <p><a name="VBUSIF"></a>
- <h3>VBUSIF</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#VBUSIF'>VBUSIF</a><br/>
- </ul>
- <a name="VCONTROL"></a>
- <h3>VCONTROL</h3>
- <div class='langLinks'>[<a href='commandref.html#VCONTROL'>EN</a> DE]</div>
- <ul>
- Das VCONTROL ist das fhem-Modul eine VIESSMANN Heizung via Optolink-Schnittstelle auszulesen und zu steuern.<br><br>
-
- Notwendig ist dazu ein Optolink-Adapter (USB oder LAN), zu dem hier Informationen zu finden sind:<br>
- <a href="http://http://openv.wikispaces.com/">http://openv.wikispaces.com/</a><br><br>
-
- Zusätzlich müssen für die verschiedenen Heizungstypen (z.B. V200KW1, VScotHO1, VPlusHO1 ....) Speicher-Adressen bekannt sein,<br>
- unter denen die Messwerte abgefragt oder aber auch Stati gesetzt werden können.<br>
- Informationen hierzu findet man im Forum <a href="http://http://openv.wikispaces.com/">http://openv.wikispaces.com/</a> und auf der wiki Seite <a href="http://http://openv.wikispaces.com/">http://openv.wikispaces.com/</a><br><br><br>
-
- <a name="VCONTROLdefine"><b>Define</b></a>
- <ul>
- <code>define <name> VCONTROL <serial-device/LAN-Device:port> <configfile> [<intervall>] </code><br>
- <br>
- <li><b><serial-device/LAN-Device:port></b><br>
- USB Port (z.B. com4, /dev/ttyUSB3) oder aber TCPIP:portnummer<br>
- </li>
- <li><b><intervall></b><br>
- Anzahl Sekunden wie oft die Heizung ausgelesen werden soll (default 180)<br>
- </li>
-
- <li><b><configfile></b><br>
- Pfad wo die Konfigurationsdatei für das Modul zu finden ist, die die Adressen beinhaltet<br>
- </li>
- <br>
- Beispiel:<br><br>
-
- serielle Schnittstelle über com4, alle 3 Minuten wird gepollt, configfile heisst 99_VCONTROL.cfg und liegt im fhem root Verzeichnis<br><br>
- Windows:<br>
- define Heizung VCONTROL com4 99_VCONTROL.cfg 180<br><br>
-
- Linux:<br>
- define Heizung VCONTROL /dev/ttyUSB3 99_VCONTROL.cfg 180<br>
- </ul>
- <br><br>
- <a name="VCONTROLset"><b>Set</b></a>
- <ul>
- Diese müssen über das configfile konfiguriert werden.
- </ul>
- <br><br>
- <a name="VCONTROLget"><b>Get</b></a>
- <ul>
- get <name> CONFIG<br><br>
- Mit diesem Befehl wird das Modul spezifische configfile nachgeladen.<br><br>
-
- Diese anderen Befehler müssen über das configfile konfiguriert werden.
- </ul>
- <br><br>
- <a name="VCONTROLparameter"><b>configfile</b></a>
- <ul>
- Im configfile hat man nun die folgenden Konfigurations Möglichkeiten.<br><br>
-
- Beispieldateien f¨r die Geräte-Typen V200KW1, VScotHO1, VPlusHO1 sind auf der wiki Seite <a href="http://www.fhemwiki.de/wiki/Vitotronic_200_%28Viessmann_Heizungssteuerung%29">http://www.fhemwiki.de/wiki/Vitotronic_200_%28Viessmann_Heizungssteuerung%29</a> zu finden.<br><br>
- <li>Zeilen die mit "#" beginnen sind Kommentar!<br></li>
- <li>Polling Commandos (POLL) zum Lesen von Werten können konfiguriert werden.<br></li>
- <li>Set Commandos (SET) zum setzen von Werten können konfiguriert werden.<br></li>
- <br>
- <b>Polling Commandos haben den folgenden Aufbau:<br><br></b>
- POLL, ADDRESSE, PARSEMETHODE, DIVISOR, READING-NAME, KUMULATION<br><br>
-
- <ul>
- <li><b>POLL</b><br>
- muss fest auf POLL stehen<br>
- </li>
- <br>
- <li><b>ADDRESSE</b><br>
- Adresse, an der der auszulesende Wert im Speicher zu finden ist.<br>
- Sie besteht aus 3 Teilen:<br>
- <ul>
- <li> beginnt immer mit 01F7 (Kommando zum Lesen)</li>
- <li> danach folgt die eigentliche Addresse<br></li>
- <li> danach muss die Anzahl der zu lesenden Bytes noch an die Adresse angehängt werden.<br></li>
- </ul>
- </li>
- <br>
- <li><b>PARSEMETHODE</b><br>
- Methode wie die gelesenen Bytes interpretiert werden müssen.<br>
- Bisher mögliche Parsemethoden:<br>
- <ul>
- <li>1ByteU :<br> Empfangener Wert in 1 Byte ohne Vorzeichen (wenn Spalte Divisor state ist -> nur 0 / 1 also off / on)<br></li>
- <li>1ByteU2 :<br> Empfangener Wert in 1 Byte ohne Vorzeichen (wenn Spalte Divisor state ist -> nur 0 / 1 also off / on)<br></li>
- <li>1ByteS :<br> Empfangener Wert in 1 Byte mit Vorzeichen (wenn Spalte Divisor state ist -> nur 0 / 1 also off / on)<br></li>
- <li>2ByteS :<br> Empfangener Wert in 2 Byte mit Vorzeichen<br></li>
- <li>2ByteU :<br> Empfangener Wert in 2 Byte ohne Vorzeichen<br></li>
- <li>2BytePercent :<br> Empfangener Wert in 2 Byte als Prozent Wert<br></li>
- <li>2ByteH :<br> Empfangener Wert in 2 Byte als Hex Wert<br></li>
- <li>4Byte :<br> Empfangener Wert in 4 Byte<br></li>
- <li>mode :<br> Empfangener Wert ist der Betriebsstatus<br></li>
- <li>timer :<br> Empfangener Wert ist ein 8 Byte Timer Werte<br></li>
- <li>date :<br> Empfangener Wert ist ein 8 Byte Zeitstempel<br></li>
- POLL Commandos die die Parsemethode timer enthalten werden nicht ständig gelesen, sondern müssen mit einem GET Commando geholt werden.<br>
- GET <devicename> TIMER<br>
- </ul>
- </li>
- <br>
- <li><b>DIVISOR</b><br>
- Wenn der interpretierte Wert noch um einen Faktor zu hoch ist, kann hier ein Divisor angegeben werden.<br>
- Zusätzlich hat man hier bei Werten, die nur 0 oder 1 liefern die möglich state einzutragen.<br>
- Dies führt dazu, dass das Reading mit off (0) und on (1) belegt wird, statt mit dem Wert.<br>
- </li>
- <br>
- <li><b>READING-NAME</b><br>
- Der gelesene und interpretierte Wert wird unter diesem Reading abgelegt.
- </li>
- <br>
- <li><b>KUMULATION</b><br>
- Bei den Polling Commandos mit dem Wert day bei der Spalte KUMULATION werden Tageswerte Kumuliert.<br>
- Es werden dann jeweils nach 00:00 Uhr die Werte des letzten Tages ebenfalls als Readings im Device eingetragen,<br>
- so dass man die Werte pro Tag auch plotten oder auswerten kann.<br>
- Beim Readingnamen wird dann jeweils: DayStart,Today und LastDay angehangen!<br>
- </li>
-
- <br>
- Beispiel:<br><br>
- <code>POLL, 01F7080402, 2ByteS, 10 , Temp-WarmWasser-Ist , -<br></code>
- <code>POLL, 01F7088A02, 2ByteU, 1 , BrennerStarts , day<br></code>
- </ul>
- <br><br>
- <b>Set Commandos haben den folgenden Aufbau:<br><br></b>
- SET,SETCMD, ADRESSE, CONVMETHODE, NEXT_CMD or DAY for timer<br><br>
-
- <ul>
- <li><b>SET</b><br>
- muss fest auf SET stehen<br>
- </li>
- <br>
- <li><b>SETCMD</b><br>
- Die SETCMD sind die Commandos die man in FHEM zum setzen angeben muss<br>
- set <devicename> <setcmd><br>
- z.B. SET <devicename> WW zum setzen auf den Status nur Warm Wasser Aufbereitung<br>
- </li>
- <br>
-
- <li><b>ADDRESSE</b><br>
- Adresse, an der der zu setzende Wert im Speicher zu schreiben ist.<br>
- Sie besteht aus 4 Teilen:<br>
- <ul>
- <li> beginnt immer mit 01F4 (Kommando zum Lesen)</li>
- <li> danach folgt die eigentliche Addresse<br></li>
- <li> danach folgt die Anzahl der zu schreibenden Daten-Bytes<br></li>
- <li> danach müssen die Daten-Bytes selber noch an die Adresse angehängt werden.<br></li>
- </ul>
- <br>
- Es gibt zwei Varianten bei den Adressen:<br>
- <li>Variante 1: Wert steht bereits fest, z.B. Spar Modus einschalten ist fix 01<br></li>
- <li>Variante 2: Wert muss übergeben werden, z.B. Warm Wasser Temperatur<br></li>
- </li>
- <br>
- <li><b>CONVMETHODE</b><br>
- Methode wie der zu schreibende Wert bei Variante 2 in Bytes konvertiert werden muss.<br>
- Bei Variante 1 kann man - eintragen.<br>
- Bisher mögliche Convmethoden:<br>
- <ul>
- <li>1ByteU :<br> Zu sendender Wert in 1 Byte ohne Vorzeichen<br>bei Variante 2 muss eine Zahl übergeben werden<br></li>
- <li>1ByteS :<br> Zu sendender Wert in 1 Byte mit Vorzeichen<br>bei Variante 2 muss eine Zahl übergeben werden<br></li>
- <li>2ByteS :<br> Zu sendender Wert in 2 Byte mit Vorzeichen<br>bei Variante 2 muss eine Zahl übergeben werden<br></li>
- <li>2ByteU :<br> Zu sendender Wert in 2 Byte ohne Vorzeichen<br>bei Variante 2 muss eine Zahl übergeben werden<br></li>
- <li>timer :<br> Zu sendender Wert ist ein 8 Byte Timer Werte<br>bei Variante 2 muss folgender String uebergeben werden:<br>
- 8 Uhrzeiten mit Komma getrennt. (AN1,AUS1,AN2,AUS2,AN3,AUS3,AN4,AUS4)<br>
- Keine Uhrzeit muss als -- angegeben werden.<br>
- Minuten der Uhrzeiten dürfen nur 00,10,20,30,40 oder 50 sein<br>
- Beispiel: 06:10,12:00,16:00,23:00,--,--,--,--</li>
- <li>date :<br> Zu sendender Wert ist ein 8 Byte Zeitstempel<br>bei Variante 2 muss folgender String uebergeben werden:<br>
- es muss das Format DD.MM.YYYY_HH:MM:SS eingehalten werden<br>
- Beispiel: 21.03.2014_21:35:00</li>
- </ul>
- </li>
- <br>
- <li><b>NEXT_CMD or DAY</b><br>
- Diese Spalte erfüllt drei Funktionen:
- <ul>
- <li>Gibt man in dieser Spalte ein anderes konfiguriertes SETCMD an, so wird dies anschließend ausgeführt.<br>
- Beispiel: nach dem Spar Modus (S-ON) gesetzt wurde, muss der Party Modus (P-OFF) ausgeschaltet werden<br>
- </li>
- <li> Ist als CONVMETHODE 1ByteU oder 1ByteS oder 2ByteS oder 2ByteU angegeben, so kann hier ein Faktor angegeben,<br>
- der beim SET auf den angegeben multipliziert wird<br>
- Beispiel: <code>SET, TEMPNHK1 , 01F4200002 , 2ByteU , 10</code>
- Bei <code>SET DEVICE TEMPNHK1 21</code> wird 210 an die Heizung gesendet.
- </li>
- <li>Ist als CONVMETHODE timer angegeben, so muss man in dieser Spalte den Wochentag angeben, für den der Timer gilt.<br>
- Mögliche Werte: MO DI MI DO FR SA SO<br></li>
- </li>
- <br>
- </ul>
- Beispiele:<br><br>
- <code>SET, WW , 01F423010100, state , -<br></code>
- <code>SET, S-ON , 01F423020101, state_spar , P-OFF<br></code>
- <code>SET, WWTEMP , 01F4630001 , 1ByteU , -<br></code>
- <code>SET, TIMER_2_MO, 01F4200008 , timer , MO<br></code>
- </ul>
- </ul>
- <br>
- <a name="VCONTROLreadings"><b>Readings</b></a>
- <ul>Die eingelesenen Werte werden wie oben beschrieben in selbst konfigurierten Readings abgelegt.</ul>
- </ul>
- <p><a name="VIERA"></a>
- <h3>VIERA</h3>
- <div class='langLinks'>[<a href='commandref.html#VIERA'>EN</a> DE]</div>
- <ul>
- <a name="VIERAdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> VIERA <host> [<interval>]</code>
- <br><br>
- Dieses Modul steuert einen Panasonic Fernseher über das Netzwerk. Es ist möglich den Fernseher
- auszuschalten, die Lautstärke zu ändern oder zu muten bzw. unmuten. Dieses Modul kann zusätzlich
- die Fernbedienung simulieren. Somit können also die Schaltaktionen einer Fernbedienung simuliert werden.
- Getestet wurde das Modul mit einem Panasonic Plasma TV tx-p50vt30e
- <br><br>
- Beim definieren des Gerätes in FHEM wird ein interner Timer gestartet, welcher zyklisch alle 30 Sekunden
- den Status der Lautstärke und des Mute-Zustand ausliest. Das Intervall des Timer kann über den Parameter <interval>
- geändert werden. Wird kein Interval angegeben, liest das Modul alle 30 Sekunden die Werte aus und triggert ein notify.
- <br><br>
- <b>Anmerkung:</b><br>
- <ul>Aktivieren von Fernbedienung der Lautstärke per DLNA: Menü -> Setup -> Netzwerk-Setup -> Netzwerkverbindungsein. -> DLNA-Fernbed. Lautst. -> Ein</ul>
- <br>
- Beispiel:
- <ul><code>
- define myTV1 VIERA 192.168.178.20<br><br>
- define myTV1 VIERA 192.168.178.20 60 #Mit einem Interval von 60 Sekunden
- </code></ul>
- </ul>
-
- <br>
- <a name="VIERAset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <command> [<value>]</code>
- <br><br>
- Zur Zeit sind die folgenden Befehle implementiert:
- <ul><code>
- off<br>
- mute [on|off]<br>
- volume [0-100]<br>
- volumeUp<br>
- volumeDown<br>
- channel [1-9999]<br>
- channelUp<br>
- channelDown<br>
- statusRequest<br>
- remoteControl <command><br>
- input [hdmi1|hdmi2|hdmi3|hdmi4|sdCard|tv]<br>
- </code></ul>
- </ul>
- <ul>
- <br>
- <u>Fernbedienung (Kann vielleicht nach Modell variieren)</u><br>
- Das Modul hat die folgenden Fernbedienbefehle implementiert:<br>
- <ul><code>
- 3D => 3D Knopf<br>
- BLUE => Blau<br>
- CANCEL => Cancel / Exit<br>
- CHG_INPUT => AV<br>
- CH_DOWN => Kanal runter<br>
- CH_UP => Kanal hoch<br>
- D0 => Ziffer 0<br>
- D1 => Ziffer 1<br>
- D2 => Ziffer 2<br>
- D3 => Ziffer 3<br>
- D4 => Ziffer 4<br>
- D5 => Ziffer 5<br>
- D6 => Ziffer 6<br>
- D7 => Ziffer 7<br>
- D8 => Ziffer 8<br>
- D9 => Ziffer 9<br>
- DISP_MODE => Anzeigemodus / Seitenverhältnis<br>
- DOWN => Navigieren runter<br>
- ENTER => Navigieren enter<br>
- EPG => Guide / EPG<br>
- FF => Vorspulen<br>
- GREEN => Grün<br>
- HOLD => Bild einfrieren<br>
- INDEX => TTV index<br>
- INFO => Info<br>
- INTERNET => VIERA connect<br>
- LEFT => Navigieren links<br>
- MENU => Menü<br>
- MUTE => Mute<br>
- PAUSE => Pause<br>
- PLAY => Play<br>
- POWER => Power off<br>
- P_NR => P-NR (Geräuschreduzierung)<br>
- REC => Aufnehmen<br>
- RED => Rot<br>
- RETURN => Enter<br>
- REW => Zurückspulen<br>
- RIGHT => Navigieren Rechts<br>
- R_TUNE => Vermutlich die selbe Funktion wie INFO<br>
- SD_CARD => SD-card<br>
- SKIP_NEXT => Skip next<br>
- SKIP_PREV => Skip previous<br>
- STOP => Stop<br>
- STTL => Untertitel<br>
- SUBMENU => Option<br>
- TEXT => TeleText<br>
- TV => TV<br>
- UP => Navigieren Hoch<br>
- VIERA_LINK => VIERA link<br>
- VOLDOWN => Lauter<br>
- VOLUP => Leiser<br>
- VTOOLS => VIERA tools<br>
- YELLOW => Gelb<br>
- </code></ul>
-
- <br>
- Beispiel:<br>
- <ul><code>
- set <name> mute on<br>
- set <name> volume 20<br>
- set <name> remoteControl CH_DOWN<br>
- </code></ul>
- </ul>
-
- <br>
- <a name="VIERAget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> <what></code>
- <br><br>
- Die folgenden Befehle sind definiert und geben den entsprechenden Wert zurück, der vom Fernseher zurückgegeben wurde.
- <ul><code>
- mute<br>
- volume<br>
- power<br>
- presence<br>
- </code></ul>
- </ul>
-
- <br>
- <a name="VIERAattr"></a>
- <b>Attribute</b>
- <ul>blocking [0|1]</ul>
-
- <br>
- <a name="VIERAevents"></a>
- <b>Generierte events:</b>
- <ul>
- <li>volume</li>
- <li>mute</li>
- <li>presence</li>
- <li>power</li>
- <li>state</li>
- </ul>
- </ul>
- <p><a name="Vallox"></a>
- <h3>Vallox</h3>
- <div class='langLinks'>[<a href='commandref.html#Vallox'>EN</a> DE]</div>
- <div>
- <ul>
- Vallox ist ein Hersteller von Belüftungsanlagen mit Wärmetauscher.
- <br>
- Die Systeme verfügen sowohl an der zentralen Lüftungskomponente, als auch an den Terminals über eine RS485-Schnittstelle über die die gesamte interne Kommunikation abgewickelt wird.
- <br>
- Mehr Informationen sind auf der <a href="http://www.fhemwiki.de/wiki/Vallox">FHEM-Wiki-Seite</a> verfügbar.
- <br>
-
- <br>
-
- <a name="Valloxdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Vallox <RS485-Device[@baud]> [BusVersion]</code><br>
- Wird die Baudrate weggelassen wird mit 9600 baud kommuniziert. (Standardrate des Vallox-Busses).<br>
- Die BusVersion kann bei älteren Anlagen auf 1 gesetzt werden. (Standard: 2).<br>
- <br>
- Beispiel: <code>define Ventilation Vallox /dev/ttyUSB1</code>
- </ul>
- <br>
-
- <a name="Valloxset"></a>
- <b>Set</b>
- <ul>
- <li><code>FanSpeed < 1-8 ></code>
- <br>
- Erlaubt das Ändern der Lüftergeschwindigkeit (1 = minimal; 8 = maximal).<br>
- </li><br>
- <li><code>BasicHumidityLevel < 0-100 ></code>
- <br>
- Erlaubt das Ändern des Luftfeuchtigkeits-Grenzwertes (Terminaldisplay: <code>Grenzwert %RH</code>).<br>
- </li><br>
- <li><code>HeatRecoveryCellBypassSetpointTemperature < 0-20 ></code>
- <br>
- Erlaubt das Ändern des Grenzwertes für den Wärmetauscher-Bypass (Terminaldisplay: <code>WRG Bypass</code>)<br>
- </li><br>
- <li><code>raw < HexWert ></code><br>
- HexWert sind <u>zwei</u> 2-stellige Hex-Zahlen, welche den Typ und den Wert der Einstellung identifiziert.
- </li><br>
- <br>
- Beispiel um die Lüftergeschwindigkeit auf 3 zu setzen:<br>
- <code>set Ventilation raw 2907</code><br>
- oder:<br>
- <code>set Ventilation FanSpeed 3</code>
- </ul>
- <br>
-
- <a name="Valloxget"></a>
- <b>Get</b>
- <ul>
- <li><code>reading < readingname ></code>
- <br>
- Erlaubt das Auslesen der vorgegebenen Datenpunkte aus dem Bus.<br>
- </li><br>
- <li><code>raw < HexWert ></code><br>
- HexWert ist <u>eine</u> 2-stellige Hex-Zahl, welche den Typ der abzufragenden Einstellung identifiziert.
- </li><br>
- </ul>
- <br>
-
- <a name="Valloxattr"></a>
- <b>Attribute</b>
- <ul><li><code>ValloxIDDomain < HexWert ></code>
- <br>
- HexWert ist eine 2-stellige Hex-Zahl die als "Adresse" der Bus-Domäne dient. (Standard: 01).
- </li><br>
- <li><code>ValloxIDCentral < HexWert ></code>
- <br>
- HexWert ist eine 2-stellige Hex-Zahl die als "Adresse" der zentralen Ventilationseinheit dient. (Standard: 11).<br>
- In einer normalen Umgebung werden die Ventilationseinheiten mit 11 - 1F adressiert. 10 ist die Broadcast-Adresse.<br>
- </li><br>
- <li><code>ValloxIDFHEM < HexWert ></code>
- <br>
- HexWert ist eine 2-stellige Hex-Zahl die als "Adresse" dieses Systems als virtuelles Kontrollterminal dient. (Standard: 2F).<br>
- Sie darf nicht bereits im Bus genutzt werden.<br>
- In einer normalen Umgebung werden die Kontrollterminals mit 21 - 2F adressiert. 20 ist die Broadcast-Adresse.<br>
- In den Einstellungen der physikalisch vorhandenen Terminals kann die "FBD-Adresse" des jeweiligen Terminals eingestellt werden.<br>
- Hierbei stehen die Werte 1-15 zur Verfügung, was der zweiten Stelle dieser Adresse (1-F) entspricht. Die erste Stelle ist immer 2.<br>
- Das physikalische Kontrollterminal ist üblicherweise die 21.
- </li><br>
- <li><code>ValloxBufferDebug < 0/1 ></code>
- <br>
- Wenn 1, erzeugt das Modul ein Internal in welches die rohen Hex-Daten aus dem Bus herein geschrieben. NUR ZUM DEBUGGEN! (Standard: 0).
- </li><br>
- <li><code>ValloxForceBroadcast < 0/1 ></code>
- <br>
- Wenn 1, sendet das Modul die Befehle nicht nur an die zentrale Ventilationseinheit (11), sondern auch an alle Broadcast-Adressen (10/20). Dies ist manchmal bei älteren Anlagen notwendig, wenn sich die Anzeige auf den Kontrollterminals nicht mit aktualisiert. (Standard: 0; Funktion immer an bei BusVersion 1).
- </li><br>
- <li><code>ValloxProcessOwnCommands < 0/1 ></code>
- <br>
- Wenn 1, behandelt das Modul die eigenen Befehle auch als Empfangene Befehle und verarbeitet sie intern weiter. Dies ist manchmal bei älteren Anlagen notwendig. (Standard: 0; Funktion immer an bei BusVersion 1).
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- </ul>
- </div>
- <p><a name="VantagePro2"></a>
- <h3>VantagePro2</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#VantagePro2'>VantagePro2</a><br/>
- </ul>
- <a name="Verkehrsinfo"></a>
- <h3>Verkehrsinfo</h3>
- <div class='langLinks'>[<a href='commandref.html#Verkehrsinfo'>EN</a> DE]</div>
- <ul>
- <i>Verkehrsinfo</i> kann die aktuellen Verkehrsinformationen von verschiedenen Quellen auslesen.
- <br><br>
- <ul>
- <li>Verkehrsinfo.de</li>
- Um die gewünschten Verkehrsinformation zu erhalten wird die Webseite https://www.verkehrsinfo.de/httpsmobil besucht.
- Hier können Sie dann entweder Straßen oder Bundesländer auswählen. Anschließend wird die URL als Parameter übergeben.
- <br><br>
- <li>Hessenschau.de</li>
- Hier ist keine Konfiguration notwendig, man verwendet die URL http://hessenschau.de/verkehr/index.html als Parameter.
- <br><br>
- <li>RadioSAW.de</li>
- Hier ist keine Konfiguration notwendig, man verwendet als Parameter radiosaw.
- </ul>
- <br><br>
-
- <b>Voraussetzung:</b>
- <ul><br>
- Für dieses Modul werden folgende Perlmodule benötigt:<br>
- <li>HTML::TreeBuilder::XPath<br>
- <code>sudo apt-get install libxml-treebuilder-perl libhtml-treebuilder-xpath-perl</code>
- </li>
- <li>JSON<br>
- <code>sudo apt-get install libjson-perl</code>
- </li>
- </ul>
- <br><br>
-
- <a name="Verkehrsinfodefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Verkehrsinfo <url> <interval></code>
- <br><br>
- Beispiel: <code>define A8 Verkehrsinfo https://www.verkehrsinfo.de/httpsmobil/index.php?c=staulist&street=A8&lat=&lon= 3600 </code>
- <br><br>
- Options:
- <ul>
- <li><i>url</i><br>
- URL der auszulesenden Verkehrsinformationen</li>
- <li><i>interval</i><br>
- Alle wieviel Sekunden die Daten aktualisiert werden</li>
- </ul>
- </ul>
- <br>
-
- <a name="Verkehrsinfoset"></a>
- <b>Set</b><br>
- <ul>
- <code>set <name> <option></code>
- <br><br>
- Options:
- <ul>
- <li><i>update</i><br>
- Update wird sofort ausgeführt</li>
- </ul>
- </ul>
- <br>
-
- <a name="Verkehrsinfoget"></a>
- <b>Get</b><br>
- <ul>
- <code>get <name> <option></code>
- <br><br>
- Options:
- <ul>
- <li><i>info</i><br>
- Ausgeben der aktuellen Verkehrsinformationen</li>
- </ul>
- </ul>
- <br>
-
- <a name="Verkehrsinfoattr"></a>
- <b>Attributes</b><br>
- <ul>
- <code>attr <name> <option> <value></code>
- <br><br>
- Options:
- <ul>
- <li><i>filter_exclude</i><br>
- Dies ist ein Ausschlussfilter. Verkehrsmeldung die eines der Wörter enthalten, werden nicht angezeigt.<br>
- Der Filter unterstütz Regulärer Ausdrücke. Achtung: Regex Steuerzeichen, z.B. Klammern müssen mit einem Backslash "\" maskiert werden.<br>
- Mehrer Suchbegriffe können mit einer Pipe "|" getrennt werden.<br><br></li>
- <li><i>filter_include</i><br>
- Dies ist ein Einschlussfilter. Es werden nur Verkehrsmeldung angezeigt die eines der Wörter enthalten.<br>
- Der Filter unterstütz Regulärer Ausdrücke. Achtung: Regex Steuerzeichen, z.B. Klammern müssen mit einem Backslash "\" maskiert werden.<br>
- Mehrer Suchbegriffe können mit einer Pipe "|" getrennt werden.<br><br></li>
- <li>Hinweis: Beide Filter können gleichzeitig benutzt werden, aber es kann auch wahlweise nur einer verwendet werden.<br>
- Die Filter sind mit einem Logischen UND verknüpft. Das heist z.B.: wenn etwas ausgeschlossen wurde, kann es nicht mit dem Einschlussfilter wiedergeholt werden.<br><br></li>
- <li><i>orderby</i><br>
- Anhand von Zeichefolgen wird eine Sortierung der Meldungen nach Relevanz vorgenommen.<br>
- Die Sortierung unterstützt Regulärer Ausdrücke.<br>
- Mehrer Suchbegriffe können mit einer Pipe "|" getrennt werden.<br><br></li>
- <li><i>msg_format [ road | head | both ]</i> (Nur Verkehrsinfo.de und RadioSAW.de)<br>
- Über diesen Parameter kann die Meldung formatiert werden nach Strasse, Richtung oder beides<br><br></li>
- <li><i><a href="#readingFnAttributes">readingFnAttributes</a></i><br><br></li>
- </ul>
- </ul>
- <br>
-
- <a name="Verkehrsinforeading"></a>
- <b>Readings</b>
- <ul>
- <br>
- <li><b>e_</b><i>0|1|2|3...|9</i><b>_...</b> - aktive Meldungen</li>
- <li><b>count</b> - Anzahl der aktiven Meldungen</li>
- <li><b>e_</b><i>0</i><b>_road</b> - Straße</li>
- <li><b>e_</b><i>0</i><b>_head</b> - Fahrtrichtung</li>
- <li><b>e_</b><i>0</i><b>_msg</b> - Meldung</li>
- </ul>
- <br>
-
- <a name="Verkehrsinfofunktion"></a>
- <b>Funktion</b>
- <ul>
- <code>Verkehrsinfo_GetData(<devicename>)</code>
- <br><br>
- Die Funktion kann überall in FHEM aufgerufen werden und liefert als Rückgabewert das gleiche Ergebnis wie der get <name> info Aufruf.
- Der Rückgabewert als Text, kann dann für weiteres verwendet werden.
- <br><br>
- Beispiel: <code>my $result = Verkehrsinfo_GetData('A8')</code>
- </ul>
- <br>
- </ul>
- <p><a name="VolumeLink"></a>
- <h3>VolumeLink</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#VolumeLink'>VolumeLink</a><br/>
- </ul>
- <a name="WEBCOUNT"></a>
- <h3>WEBCOUNT</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WEBCOUNT'>WEBCOUNT</a><br/>
- </ul>
- <a name="WEBIO"></a>
- <h3>WEBIO</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WEBIO'>WEBIO</a><br/>
- </ul>
- <a name="WEBIO_12DIGITAL"></a>
- <h3>WEBIO_12DIGITAL</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WEBIO_12DIGITAL'>WEBIO_12DIGITAL</a><br/>
- </ul>
- <a name="WINCONNECT"></a>
- <h3>WINCONNECT</h3>
- <div class='langLinks'>[<a href='commandref.html#WINCONNECT'>EN</a> DE]</div>
- <ul>
- Dieses Module dient zur Steuerung eines Windows PCs
- <br><br>
-
- <ul>
- <a name="WINCONNECTdefine" id="WINCONNECTdefine"></a> <b>Define</b>
- <ul>
- <code>define <name> WINCONNECT <ip-address-or-hostname> [<poll-interval>]</code><br>
- <br>
- Für definierte WINCONNECT Geräte wird ein interner Task angelegt, welcher periodisch die Readings aktualisiert. Der Standartpollintervall ist 45 Sekunden.<br>
- <br>
- Example:<br>
- <ul>
- <code>define Buero.PC WINCONNECT 192.168.0.10<br>
- <br>
- # Alternativer poll intervall von 60 seconds<br>
- define Buero.PC WINCONNECT 192.168.0.10 60<br></code>
- </ul>
- </ul>
- </ul>
- <br><br>
- Mehr Information im <a target="_blank" href="https://wiki.fhem.de/wiki/WINCONNECT">FHEM Wiki</a>.<br/>
- <br>
- </ul>
- <p><a name="WMBUS"></a>
- <h3>WMBUS - Wireless M-Bus</h3>
- <div class='langLinks'>[<a href='commandref.html#WMBUS'>EN</a> DE]</div>
- <ul>
- Dieses Modul unterstützt Zähler mit Wireless M-Bus, z. B. für Wasser, Gas oder Elektrizität.
- Wireless M-Bus ist ein standardisiertes Protokoll das von unterschiedlichen Herstellern unterstützt wird.
- Es verwendet das 868 MHz Band für Radioübertragungen.
- Daher wird ein Gerät benötigt das die Wireless M-Bus Nachrichten empfangen kann, z. B. ein <a href="#CUL">CUL</a> mit culfw >= 1.59 oder ein AMBER Wireless AMB8465-M.
- <br>
- WMBus verwendet zwei unterschiedliche Radioprotokolle, T-Mode und S-Mode. Der Empfänger muss daher so konfiguriert werden, dass er das selbe Protokoll
- verwendet wie der Sender. Im Falle eines CUL kann das erreicht werden, in dem das Attribut <a href="#rfmode">rfmode</a> auf WMBus_T bzw. WMBus_S gesetzt wird.
- <br>
- WMBus Geräte senden Daten periodisch abhängig von ihrer Konfiguration. Es können u. U. Tage zwischen einzelnen Nachrichten vergehen oder sie können im
- Minutentakt gesendet werden.
- <br>
- WMBus Nachrichten können optional verschlüsselt werden. Bei verschlüsselten Nachrichten muss der passende Schlüssel mit dem Attribut AESkey angegeben werden.
- Andernfalls wird die Entschlüsselung fehlschlagen und es können keine relevanten Daten ausgelesen werden.
- <br><br>
- <b>Voraussetzungen</b><br>
- Dieses Modul benötigt die perl Module Crypt::CBC, Digest::CRC and Crypt::OpenSSL::AES (AES wird nur benötigt wenn verschlüsselte Nachrichten verarbeitet werden sollen).<br>
- Bei einem Debian basierten System können diese so installiert werden<br>
- <code>
- sudo apt-get install libcrypt-cbc-perl libdigest-crc-perl libssl-dev<br>
- sudo cpan -i Crypt::OpenSSL::AES
- </code>
- <br><br>
- <a name="WMBUSdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> WMBUS [<manufacturer id> <identification number> <version> <type> [<MessageEncoding>]]|<bHexCode></code> <br>
- <br>
- Normalerweise wird ein WMBus Device nicht manuell angelegt. Dies geschieht automatisch bem Empfang der ersten Nachrichten eines Gerätes über den
- fhem <a href="#autocreate">autocreate</a> Mechanismus.
- <br>
- Für eine manuelle Definition gibt es zwei Wege.
- <ul>
- <li>
- Durch Verwendung einer WMBus Rohnachricht wie sie vom IODev empfangen wurde. So eine Nachricht beginnt mit einem kleinen 'b' und enthält mindestens
- 24 hexadezimale Zeichen.
- Das WMBUS Modul extrahiert daraus alle benötigten Informationen.
- </li>
- <li>
- Durch explizite Angabe der Informationen die ein WMBus Gerät eindeutig identfizieren.<br>
- Der Hersteller Code, besteht aus drei Buchstaben als Abkürzung des Herstellernamens. Eine Liste der Abkürzungen findet sich unter
- <a href="http://dlms.com/organization/flagmanufacturesids/index.html">dlms.com</a><br>
- Die Idenitfikationsnummer ist die Seriennummer des Zählers.<br>
- Version ist ein Versionscode des Zählers.<br>
- Typ ist die Art des Zählers, z. B. Wasser oder Elektrizität, kodiert als Zahl.<br>
- MessageEncoding ist entweder CUL oder AMB, je nachdem welche Art von IODev verwendet wird
- </li>
- <br>
- </ul>
- </ul>
- <br>
- <a name="WMBUSset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="WMBUSget"></a>
- <b>Get</b> <ul>N/A</ul><br>
-
- <a name="WMBUSattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#IODev">IODev</a><br>
- Setzt den IO oder physisches Gerät welches für den Empfang der Signale für dieses 'logische' Gerät verwendet werden soll.
- Ein Beispiel für ein solches Gerät ist ein CUL.
- </li><br>
- <li>AESKey<br>
- Ein 16 Bytes langer AES-Schlüssel in hexadezimaler Schreibweise. Wird verwendet um Nachrichten von Zählern zu entschlüsseln bei denen
- die Verschlüsselung aktiviert ist.
- </li><br>
- <li>
- <a href="#ignore">ignore</a>
- </li><br>
- <li>rawmsg_as_reading<br>
- Wenn auf 1 gesetzt so werden empfangene Nachrichten im Reading rawmsg gespeichert. Das kann verwendet werden um Rohnachrichten zu loggen und beim Debugging zu helfen.
- </li>
- </ul>
- <br>
- <a name="WMBUSreadings"></a>
- <b>Readings</b><br>
- <ul>
- Zähler können sehr viele unterschiedliche Informationen senden, abhängig von ihrem Typ. Ein Elektrizitätszähler wird andere Daten senden als ein
- Wasserzähler. Die Information hängt auch vom Hersteller des Zählers ab. Für weitere Informationen siehe die WMBus Spezifikation unter
- <a href="http://www.oms-group.org">oms-group.org</a>.
- <br><br>
- Die Readings werden als Block dargestellt, beginnend mit Block 1. Ein Zähler kann mehrere Blöcke senden.
- Jeder Block enthält zumindest einen Typ, einen Wert und eine Einheit. Für einen Elektrizitätszähler könnte das z. B. so aussehen<br>
- <ul>
- <code>1_type VIF_ENERGY_WATT</code><br>
- <code>1_unit Wh</code><br>
- <code>1_value 2948787</code><br>
- </ul>
- <br>
- Es gibt auch eine Anzahl von festen Readings.
- <ul>
- <li><code>is_encrypted</code> ist 1 wenn die empfangene Nachricht verschlüsselt ist.</li>
- <li><code>decryption_ok</code> ist 1 wenn die Nachricht entweder erfolgreich entschlüsselt wurde oder gar nicht verschlüsselt war.</li>
- <li><code>state</code> enthält den Status des Zählers und kann Fehlermeldungen wie 'battery low' enthalten. Normalerweise ist der Wert 'no error'.</li>
- <li><code>battery</code> enthält ok oder low.</li>
- </ul>
- Für einige bekannte Gerätetypen werden zusätzliche Readings wie der Energieverbrauch in kWh erzeugt.
- </ul>
-
-
- </ul>
- <p><a name="WOL"></a>
- <h3>WOL</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WOL'>WOL</a><br/>
- </ul>
- <a name="WS2000"></a>
- <h3>WS2000</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WS2000'>WS2000</a><br/>
- </ul>
- <a name="WS300"></a>
- <h3>WS300</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WS300'>WS300</a><br/>
- </ul>
- <a name="WS3600"></a>
- <h3>WS3600</h3>
- <div class='langLinks'>[<a href='commandref.html#WS3600'>EN</a> DE]</div>
- <ul>
- Definiert eine Wetterstation, die über ein externes Programm ausgelesen
- wird. Dieses Programm wird zyklisch durch FHEM aufgerufen. Es muss die
- Daten im gleichen Format wie fetch3600 (Details siehe unten) auf der
- Standardausgabe liefern.<br>
- <br>
- <a name="WS3600define"></a> <b>Define</b>
- <ul>
- <code>define <name> WS3600 "<wsreaderprog>
- [<options>]" [<interval>]</code> <br>
- <br>
- <ul>
- <dl>
- <dt><wsreaderprog></dt>
- <dd>kompletter Pfad zum Ausleseprogramm (für Wetterstationen Typ
- WS3600 fetch3600 verwenden)</dd>
- <dt><options></dt>
- <dd>Kommandozeilenparameter für <wsreaderprog>, falls
- erforderlich</dd>
- <dt><interval></dt>
- <dd>optionaler Parameter für das Aufrufintervall [s]. Defaultwert
- ist 60s.</dd>
- </dl>
- </ul>
- <br>
- Unterstützte Stationen sind:<br>
- <ul>
- <li>WS3600 Serie (Europe Supplies, technotrade, usw.; s.a. <a href="http://wiki.wetterstationen.info/index.php?title=LaCrosse_WS3600">Wetterstationen.info</a>
- (deutsch) für Details) in Verbindung mit fetch3600 aus dem Paket <a
- href="https://sourceforge.net/projects/open3600/">open3600</a>).
- Fetch3600 liefert die aktuellen Werte zeilenweise als
- Name-Wert-Paare. Diese werden durch FHEM zyklisch eingelesen, mit
- besser lesbaren Bezeichnungen versehen und als Readings zur
- Verfügung gestellt. </li>
- <li><a href="http://wiki.wetterstationen.info/index.php?title=LaCrosse_WS2300">WS2300</a>
- Serie in Verbindung mit dem Paket <a href="http://www.lavrsen.dk/twiki/bin/view/Open2300/WebHome">open2300</a>
- (ähnlich zu open3600).</li>
- <li><a href="http://wiki.wetterstationen.info/index.php?title=WS1080">WS1080</a>
- (und andere Stationen, die mit der Windows-Software "Easy Weather"
- ausgeliefert werden) in Verbindung mit <a href="https://github.com/ajauberg/fowsr/">fowsr</a>
- (ab Version 2.0)</li>
- </ul>
- <br>
- Es wird vorausgesetzt, dass die Wetterstation am lokalen Computer
- angeschlossen ist und <wsreaderprog> deshalb lokal läuft.
- <wsreaderprog> muss grundsätzlich eine zu fetch3600 vergleichbare
- Ausgabe auf der Standardausgabe liefern. <br>
- Als Beispiel für das erwartete Format hier die Ausgabe von fetch3600:<br>
- <div>
- <pre>Date 14-Nov-2009
- Time 10:50:22
- Ti 22.8
- Timin 20.8
- Timax 27.9
- TTimin 10:27
- DTimin 15-10-2009
- TTimax 23:31
- DTimax 20-08-2009
- To 14.2
- Tomin -0.4
- Tomax 35.6
- TTomin 07:03
- DTomin 15-10-2009
- TTomax 16:52
- DTomax 20-08-2009
- DP 9.2
- DPmin -2.2
- DPmax 20.3
- TDPmin 07:03
- DDPmin 15-10-2009
- TDPmax 11:58
- DDPmax 20-08-2009
- RHi 48
- RHimin 32
- RHimax 57
- TRHimin 17:03
- DRHimin 21-10-2009
- TRHimax 22:24
- DRHimax 07-10-2009
- RHo 72
- RHomin 27
- RHomax 96
- TRHomin 16:41
- DRHomin 20-08-2009
- TRHomax 06:28
- DRHomax 02-11-2009
- WS 0.0
- DIRtext WSW
- DIR0 247.5
- DIR1 247.5
- DIR2 247.5
- DIR3 247.5
- DIR4 247.5
- DIR5 247.5
- WC 14.2
- WCmin -0.4
- WCmax 35.6
- TWCmin 07:03
- DWCmin 15-10-2009
- TWCmax 16:52
- DWCmax 20-08-2009
- WSmin 0.0
- WSmax 25.6
- TWSmin 10:44
- DWSmin 14-11-2009
- TWSmax 19:08
- DWSmax 24-09-2009
- R1h 0.00
- R1hmax 24.34
- TR1hmax 22:34
- DR1hmax 07-10-2009
- R24h 0.00
- R24hmax 55.42
- TR24hmax 07:11
- DR24hmax 08-10-2009
- R1w 29.00
- R1wmax 95.83
- TR1wmax 00:00
- DR1wmax 12-10-2009
- R1m 117.58
- R1mmax 117.58
- TR1mmax 00:00
- DR1mmax 01-11-2009
- Rtot 3028.70
- TRtot 03:29
- DRtot 18-09-2005
- RP 992.200
- AP 995.900
- RPmin 970.300
- RPmax 1020.000
- TRPmin 05:25
- DRPmin 04-11-2009
- TRPmax 09:19
- DRPmax 11-09-2009
- Tendency Falling
- Forecast Cloudy</pre>
- </div>
- Zusätzlich werden folgende Erweiterungen (für WS3080) unterstützt:<br>
- <div>
- <pre>IL 0.0
- UV 8
- Forecast Zeitweise Regen, später zunehmend
- ZCode U</pre>
- </div>
- Welche der vorgenannten Wertepaare durch <wsreaderprog>
- geliefert werden, ist egal. Jedes bekannte wird übersetzt (z.B. <code>Ti</code>
- nach <code>Temp-inside</code>) und als Reading angezeigt, alle
- unbekannten werden kommentarlos verworfen. Mittels geeignetem Programm
- oder Script sollte sich also jede beliebige Wetterstation anschließen
- lassen. <br>
- Anmerkung: Um die Anzahl Readings zu reduzieren, werden jetzt Date- und
- Time-Wertepaare zusammengefasst. Es ist jetzt auch zulässig, dass
- <wsreaderprog> schon kombinierte Wertepaare liefert. Diese sind
- mit dem Prefix <code>DT</code> zu kennzeichnen, also z.B. <code>Date</code>
- + <code>Time</code> --> <code>DTime</code>, <code>DRPmin</code> +
- <code>TRPmin</code> --> <code>DTRPmin</code> usw.).<br>
- <em>Fetch3600 ist auch unter Windows verfügbar, ob das Zusammenspiel mit
- FHEM dort auch funktioniert, wurde noch nicht getestet.</em> <br>
- <br>
- Beispiele:
- <ul>
- <code>define myWS3600 W3600 /usr/local/bin/fetch360</code><br>
- <code>define myWS1080 W3600 "/usr/local/bin/fowsr -c" 300</code><br>
- </ul>
- <br>
- </ul>
- <a name="WS3600set"></a> <b>Set</b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="WS3600get"></a> <b>Get</b>
- <ul>
- N/A
- </ul>
- <br>
- <a name="WS3600attr"></a> <b>Attributes</b>
- <ul>
- <li><a href="#model">model</a> WS3600, WS2300,
- WS1080, WS3080 (z.Zt (noch) ohne Wirkung)</li>
- </ul>
- <br>
- </ul>
- <p><a name="WUup"></a>
- <h3>WUup</h3>
- <div class='langLinks'>[<a href='commandref.html#WUup'>EN</a> DE]</div>
- <ul>
- <a name="WUupdefine"></a>
- <b>Define</b>
- <ul>
- <br/>
- <code>define <name> WUup <stationId> <password></code>
- <br/><br/>
- Dieses Modul stellt eine Verbindung zu <a href="https://www.wunderground.com">www.wunderground.com</a></br>
- her, um Daten einer eigenen Wetterstation zu versenden..<br/>
- </ul>
- <br/><br/>
- <a name="WUupset"></a>
- <b>Set-Befehle</b><br/>
- <ul>
- <li><b>update</b> - sende Daten an Weather Underground</li>
- </ul>
- <br/><br/>
- <a name="WUupget"></a>
- <b>Get-Befehle</b><br/>
- <ul>
- <br/>
- - keine -<br/>
- </ul>
- <br/><br/>
- <a name="WUupattr"></a>
- <b>Attribute</b><br/><br/>
- <ul>
- <li><b><a href="#readingFnAttributes">readingFnAttributes</a></b></li>
- <li><b>interval</b> - Sendeinterval in Sekunden. Wird auf 300 (Default-Wert)
- eingestellt, wenn der Wert kleiner als 3 ist.<br />
- Wenn der Wert kleiner als 300 ist, wird der RapidFire Modus verwendet.</li>
- <li><b>disable</b> - deaktiviert das Modul</li>
- <li><b><a href="#disabledForIntervals">disabledForIntervals</a></b></li>
- <li><b>unit_windspeed</b> - gibt die Einheit der Readings für die
- Windgeschwindigkeiten an (m/s oder km/h)</li>
- <li><b>wu....</b> - Attributname entsprechend dem
- <a href="http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol">Parameternamen aus der API.</a><br />
- Jedes dieser Attribute enthält Informationen über zu sendende Wetterdaten
- im Format <code>sensorName:readingName</code>.<br/>
- Beispiel: <code>attr WUup wutempf outside:temperature</code> definiert
- das Attribut wutempf und sendet das Reading "temperature" vom Gerät "outside" als Parameter "tempf"
- (welches die aktuelle Temperatur angibt).
- <br />
- Einheiten werden automatisch ins anglo-amerikanische System umgerechnet.
- (°C -> °F; km/h(m/s) -> mph; mm -> in; hPa -> inHg)<br/><br/>
- <u>Unterstützte Angaben</u>
- <ul>
- <li>Winddir - [0-360 momentane Windrichtung]</li>
- <li>Windspeedmph - [mph momentane Windgeschwindigkeit]</li>
- <li>Windgustmph - [mph aktuellen Böe, mit Software-spezifischem Zeitraum]</li>
- <li>Windgustdir - [0-360 mit Software-spezifischer Zeit]</li>
- <li>Windspdmph_avg2m - [mph durchschnittliche Windgeschwindigkeit innerhalb 2 Minuten]</li>
- <li>Winddir_avg2m - [0-360 durchschnittliche Windrichtung innerhalb 2 Minuten]</li>
- <li>Windgustmph_10m - [mph Böen der vergangenen 10 Minuten]</li>
- <li>Windgustdir_10m - [0-360 Richtung der Böen der letzten 10 Minuten]</li>
- <li>Feuchtigkeit - [% Außenfeuchtigkeit 0-100%]</li>
- <li>Dewptf- [F Taupunkt im Freien]</li>
- <li>Tempf - [F Außentemperatur]</li>
- <li>Rainin - [in Regen in der vergangenen Stunde]</li>
- <li>Dailyrainin - [in Regenmenge bisher heute]</li>
- <li>Baromin - [inHg barometrischer Druck]</li>
- <li>Soiltempf - [F Bodentemperatur]</li>
- <li>Bodenfeuchtigkeit - [%]</li>
- <li>Solarradiation - [W/m²]</li>
- <li>UV - [Index]</li>
- </ul>
- </li>
- </ul>
- <br/><br/>
- <b>Readings/Events:</b>
- <br/><br/>
- <ul>
- <li><b>data</b> - Daten, die zu www.wunderground.com gesendet werden</li>
- <li><b>response</b> - Antwort, die vom Server empfangen wird</li>
- </ul>
- <br/><br/>
- <b>Notizen</b><br/><br/>
- <ul>
- <li>Die komplette API-Beschreibung findet sich
- <a href="http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol">hier</a></li>
- <li>Viel Spaß!</li><br/>
- </ul>
- </ul>
- <p><a name="WWO"></a>
- <h3>WWO</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WWO'>WWO</a><br/>
- </ul>
- <a name="WaterCalculator"></a>
- <h3>WaterCalculator</h3>
- <div class='langLinks'>[<a href='commandref.html#WaterCalculator'>EN</a> DE]</div>
- <ul>
- <table>
- <tr>
- <td>
- Das WaterCalculator Modul berechnet den Verbrauch an Wasser und die verbundenen Kosten von einem oder mehreren Wasserzählern.<BR>
- <BR>
- <FONT COLOR="#FF0000">Die Funktion des sogenannten Unterwasserzählers ist noch nicht implementiert. Daher müssen bei den Wasserkosten die Abwasserkosten mit einbezogen werden.</FONT>
- <BR>
- Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit den Zählimpulse von einem oder mehreren Wasserzählern zu finden.<BR>
- <BR>
- Sobald das Modul in der fhem.cfg definiert wurde, reagiert das Modul auf jedes durch das regex definierte event wie beispielsweise ein myOWDEVICE:counter.* etc.<BR>
- <BR>
- Das WaterCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Wasserzählern und erstellt die entsprechenden Readings.<BR>
- <BR>
- Um zu verhindern, dass man bis zu 12 Monate warten muss, bis alle Werte der Realität entsprechen, müssen die Readings<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterDay1st</code>,<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterMonth1st</code>,<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterYear1st</code> und<BR>
- <code><DestinationDevice>_<SourceCounterReading>_CounterMeter1st</code><BR>
- entsprechend mit dem <code>setreading</code> - Befehl korrigiert werden.<BR>
- Diese Werte findet man unter Umständen auf der letzten Abrechnung des Wasserversorgers. Andernfalls dauert es bis zu 24h für die täglichen, 30 Tage für die monatlichen und bis zu 12 Monate für die jährlichen Werte bis diese der Realität entsprechen.<BR>
- <BR>
- <BR>
- Intervalle kleienr als 10s werden ignoriert um Spitzen zu verhindern die von Blockaden des fhem Systems hervorgerufen werden (z.B. DbLog - reducelog).
- </td>
- </tr>
- </table>
-
- <table>
- <tr><td><a name="WaterCalculatorDefine"></a><b>Define</b></td></tr>
- </table>
- <table><tr><td><ul><code>define <name> WaterCalculator <regex></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der Name dieses Berechnungs-Device. Empfehlung: "myWaterCalculator".</td></tr>
- <tr><td><code><regex></code> : </td><td>Eine gültige Regular Expression (regex or regexp) von dem Event wo der Zählerstand gefunden werden kann</td></tr>
- </table>
- </ul></ul>
- <table><tr><td><ul>Beispiel: <code>define myWaterCalculator WaterCalculator myWaterCounter:countersA.*</code></ul></td></tr></table>
- <BR>
- <table>
- <tr><td><a name="WaterCalculatorSet"></a><b>Set</b></td></tr>
- <tr><td>
- <ul>
- Die set - Funktion erlaubt individuelle Readings zu verändern um beispielsweise nach einem Stromausfall Werte zu korrigieren.<BR>
- Die set - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.<BR>
- Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit <code>set</code> - Befehl gesetzt werden.<BR>
- </ul>
- </td></tr>
- </table>
- <BR>
- <table>
- <tr><td><a name="WaterCalculatorGet"></a><b>Get</b></td></tr>
- <tr><td>
- <ul>
- Die get - Funktion liefert nur den Wert des jeweiligen Readings zurück.<BR>
- Die get - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.<BR>
- Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit <code>get</code> - Befehl ausgelesen werden.<BR>
- </ul>
- </td></tr>
- </table>
- <BR>
- <table>
- <tr><td><a name="WaterCalculatorAttr"></a><b>Attributes</b></td></tr>
- <tr><td>
- <ul>
- Sollten die unten ausfeg&auuml;hrten Attribute bei der Definition eines entsprechenden Gerätes nicht gesetzt sein, so werden sie vom Modul mit Standard Werten automatisch gesetzt<BR>
- Zusätzlich können die globalen Attribute wie <a href="#room">room</a> verwendet werden.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>BasicPricePerAnnum</code> : </li></td><td> Eine gültige float Zahl für die jährliche Grundgebühr in der gewählten Währung für die Wasser-Versorgung zum Endverbraucher.<BR>
- Dieser Wert stammt vom Wasserversorger und steht auf der Abrechnung.<BR>
- Der Standard Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>Currency</code> : </li></td><td> Eines der vordefinerten Währungssymbole: [€,£,$].<BR>
- Der Standard Wert ist €<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>disable</code> : </li></td><td> Deaktiviert das device. Das Modul wird nicht mehr auf die Events reagieren die durch die Regular Expression definiert wurde.<BR>
- Der Standard Wert ist 0 = aktiviert.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>WaterCounterOffset</code> : </li></td><td> Eine gültige float-Zahl für den Unterschied = Offset (Nicht der Unterschied zwischen Zählimpulsen) zwischen dem am mechanischen Wasserzählern und dem angezeigten Wert im Reading dieses Device.<BR>
- Der Offset-Wert wird wie folgt ermittelt: W<sub>Offset</sub> = W<sub>Mechanisch</sub> - W<sub>Module</sub><BR>
- Der Standard-Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>WaterCubicPerCounts</code> : </li></td><td> Eine gültige float-Zahl für die Menge Kubik pro Zählimpulsen.<BR>
- Der Wert ist durch das mechanische Zählwerk des Wasserzählern vorgegeben. WaterCubicPerCounts = 0.001 bedeutet, dass jeder Zählimpuls ein Tausendstel eines Kubik ist (=Liter).<BR>
- Der Standard-Wert ist 1<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>WaterPricePerCubic</code> : </li></td><td> Eine gültige float-Zahl für den Preis pro Kubik Wasser.<BR>
- <FONT COLOR="#FF0000">Hierbei müssen die Abwasserkosten mit einbezogen werden.</FONT>
- Dieser Wert stammt vom Wasserversorger und steht auf der Abrechnung.<BR>
- Der Standard-Wert ist 2.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>MonthlyPayment</code> : </li></td><td> Eine gültige float-Zahl für die monatlichen Abschlagszahlungen in der gewählten Währung an den Wasserversorger.<BR>
- Der Standard-Wert ist 0.00<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>MonthOfAnnualReading</code> : </li></td><td> Eine gültige Ganz-Zahl für den Monat wenn der mechanische Wasserzähler jedes Jahr durch den Wasserversorger abgelesen wird.<BR>
- Der Standard-Wert ist 5 (Mai)<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ReadingDestination</code> : </li></td><td> Eines der vordefinerten Device als Ziel der errechneten Readings: [CalculatorDevice,CounterDevice].<BR>
- Das CalculatorDevice ist das mit diesem Modul erstellte Device.<BR>
- Das CounterDevice ist das Device von welchem der mechanische Zähler ausgelesen wird.<BR>
- Der Standard-Wert ist CalculatorDevice.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>WFRUnit</code> : </li></td><td> Ein Wert der vorgegebenen Auswahlliste: l/min (Liter/Minute), m³/min (Kubikmeter/Minute), m³/h (Kubikmeter/Stunde).<BR>
- Es definiert welcher Einheit verwendet werden soll und teilt den Wasserdurchsatz entsprechend.<BR>
- Der Standard-Wert ist l/min (Liter/Minute).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="WaterCalculatorReadings"></a><b>Readings</b></td></tr>
- <tr><td>
- <ul>
- Sobald das Device in der Lage war mindestens 2 Werte des Zählers einzulesen, werden automatisch die entsprechenden Readings erzeugt:<BR>
- Der Platzhalter <code><DestinationDevice></code> steht für das Device, welches man in dem Attribut <code>ReadingDestination</code> oben festgelegt hat. Dieser Platzhalter bleibt leer, sobald man dort CalculatorDevice ausgewählt hat.<BR>
- Der Platzhalter <code><SourceCounterReading></code> steht für das Reading welches mit der Regular Expression definiert wurde.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterCurrent</code> : </li></td><td>Aktueller Zählerstand am mechanischen Zähler. Bei Unterschied muss das Offset-Attribut entspechend korrigiert werden.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterDay1st</code> : </li></td><td>Der erste Zählerstand des laufenden Tages seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterDayLast</code> : </li></td><td>Der letzte Zählerstand des vorherigen Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMeter1st</code> : </li></td><td>Der erste Zählerstand seit Mitternacht des ersten Tages der laufenden Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMeterLast</code> : </li></td><td>Der letzte Zählerstand seit Mitternacht des ersten Tages der vorherigen Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMonth1st</code> : </li></td><td>Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterMonthLast</code> : </li></td><td>Der letzte Zählerstand des vorherigen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterYear1st</code> : </li></td><td>Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_CounterYearLast</code> : </li></td><td>Der letzte Zählerstand des letzten Jahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostDayLast</code> : </li></td><td>Wasserkosten des letzten Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostMeterLast</code> : </li></td><td>Wasserkosten der letzten Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostMonthLast</code> : </li></td><td>Wasserkosten des letzten Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostYearLast</code> : </li></td><td>Wasserkosten des letzten Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostDay</code> : </li></td><td>Wasserkosten in gewählter Währung seit Mitternacht des laufenden Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostMeter</code> : </li></td><td>Wasserkosten in gewählter Währung seit Beginn der laufenden Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostMonth</code> : </li></td><td>Wasserkosten in gewählter Währung seit Beginn des laufenden Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionCostYear</code> : </li></td><td>Wasserkosten in gewählter Währung seit Beginn des laufenden Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionDay</code> : </li></td><td>Wasserverbrauch seit Beginn der aktuellen Tages (Mitternacht).<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionDayLast</code> : </li></td><td>Wasserverbrauch in qm des vorherigen Tages.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionMeter</code> : </li></td><td>Wasserverbrauch seit Beginn der aktuellen Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionMeterLast</code> : </li></td><td>Wasserverbrauch in qm der vorherigen Ableseperiode.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionMonth</code> : </li></td><td>Wasserverbrauch seit Beginn des aktuellen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionMonthLast</code> : </li></td><td>Wasserverbrauch in qm des vorherigen Monats.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionYear</code> : </li></td><td>Wasserverbrauch seit Beginn des aktuellen Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_ConsumptionYearLast</code> : </li></td><td>Wasserverbrauch in qm des vorherigen Kalenderjahres.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_FinanceReserve</code> : </li></td><td>Finanzielle Reserve basierend auf den Abschlagszahlungen die jeden Monat an den Wasserversorger gezahlt werden. Bei negativen Werten ist von einer Nachzahlung auszugehen.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_MonthMeterReading</code> : </li></td><td>Anzahl der Monate seit der letzten Zählerablesung. Der Monat der Zählerablesung ist der erste Monat = 1.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_WFRCurrent</code> : </li></td><td>Aktueller Wasserdurchsatz. (Wasserdurchsatz basierend auf aktueller und letzter Messung)<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_WFRDayAver</code> : </li></td><td>Mittlerer Wasserdurchsatz seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_WFRDayMax</code> : </li></td><td>Maximale Wasserdurchsatz seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code><DestinationDevice>_<SourceCounterReading>_WFRDayMin</code> : </li></td><td>Minimale Wasserdurchsatz seit Mitternacht.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- </ul>
- <p><a name="Weather"></a>
- <h3>Weather</h3>
- <div class='langLinks'>[<a href='commandref.html#Weather'>EN</a> DE]</div>
- <ul>
- Es wird das Perl-Modul JSON benötigt. Mit <code>apt-get install libjson-perl</code> kann es unter Debian und Derivaten installiert werden.<br><br>
- <a name="Weatherdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> Weather <location> [<interval> [<language>]]</code><br>
- <br>
- Bezechnet ein virtuelles Gerät für Wettervorhersagen.<br><br>
- Eine solche virtuelle Wetterstation sammelt periodisch aktuelle und zukünftige Wetterdaten aus der Yahoo-Wetter-API.<br><br>
- Der Parameter <code>location</code> entspricht der sechsstelligen WOEID (WHERE-ON-EARTH-ID). Die WOEID für den eigenen Standort kann auf <a href="http://weather.yahoo.com">http://weather.yahoo.com</a> gefunden werden.<br><br>
- Der optionale Parameter <code>interval</code> gibt die Dauer in Sekunden zwischen den einzelnen Aktualisierungen der Wetterdaten an. Der Standardwert ist 3600 (1 Stunde). Wird kein Wert angegeben, gilt der Standardwert.<br><br>
- Der optionale Parameter für die möglichen Sprachen darf einen der folgende Werte annehmen: <code>de</code>, <code>en</code>, <code>pl</code>, <code>fr</code> oder <code>nl</code>. Er bezeichnet die natürliche Sprache, in der die Wetterinformationen dargestellt werden. Der Standardwert ist <code>en</code>. Wird für die Sprache kein Wert angegeben, gilt der Standardwert. Wird allerdings der Parameter für die Sprache gesetzt, muss ebenfalls ein Wert für das Abfrageintervall gesetzt werden.<br><br>
-
-
- Beispiele:
- <pre>
- define MyWeather Weather 673513
- define Forecast Weather 673513 1800
- </pre>
-
- Das Modul unterstützt zusätzlich vier verschiedene Funktionen <code>WeatherAsHtml</code>, <code>WeatherAsHtmlV</code>, <code>WeatherAsHtmlH</code> und <code>WeatherAsHtmlD</code>. Die ersten beiden Funktionen sind identisch: sie erzeugen den HTML-Code für eine vertikale Darstellung des Wetterberichtes. Die dritte Funktion liefert den HTML-Code für eine horizontale Darstellung des Wetterberichtes. Die letztgenannte Funktion wählt automatisch eine Ausrichtung, die abhängig davon ist, ob ein Smallcreen Style ausgewählt ist (vertikale Darstellung) oder nicht (horizontale Darstellung). Alle vier Funnktionen akzeptieren einen zusätzlichen optionalen Paramter um die Anzahl der darzustellenden Icons anzugeben.<br><br>
- Beispiel:
- <pre>
- define MyWeatherWeblink weblink htmlCode { WeatherAsHtmlH("MyWeather") }
- </pre>
-
- </ul>
- <br>
- <a name="Weatherset"></a>
- <b>Set </b>
- <ul>
- <code>set <name> update</code><br><br>
- Erzwingt eine Abfrage der Wetterdaten. Die darauffolgende Abfrage wird gemäß dem eingestellten Intervall <code>interval</code> Sekunden später durchgeführt.<br><br>
- </ul>
- <br>
- <a name="Weatherget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> <reading></code><br><br>
- Gültige ausgelesene Daten (readings) und ihre Bedeutung (das ? kann einen der Werte 1, 2, 3 , 4 oder 5 annehmen und steht für heute, morgen, übermorgen etc.):<br><br>
- <table>
- <tr><td>city</td><td>Name der Stadt, der aufgrund der WOEID übermittelt wird</td></tr>
- <tr><td>code</td><td>Code für die aktuellen Wetterverhältnisse</td></tr>
- <tr><td>condition</td><td>aktuelle Wetterverhältnisse</td></tr>
- <tr><td>current_date_time</td><td>Zeitstempel der letzten Aktualisierung der Wetterdaten vom Server</td></tr>
- <tr><td>fc?_code</td><td>Code für die vorhergesagten Wetterverhältnisse</td></tr>
- <tr><td>fc?_condition</td><td>vorhergesagte Wetterverhältnisse</td></tr>
- <tr><td>fc?_day_of_week</td><td>Wochentag des Tages, der durch ? dargestellt wird</td></tr>
- <tr><td>fc?_high_c</td><td>vorhergesagte maximale Tagestemperatur in Grad Celsius</td></tr>
- <tr><td>fc?_icon</td><td>Icon für Vorhersage</td></tr>
- <tr><td>fc?_low_c</td><td>vorhergesagte niedrigste Tagestemperatur in Grad Celsius</td></tr>
- <tr><td>humidity</td><td>gegenwärtige Luftfeuchtgkeit in %</td></tr>
- <tr><td>icon</td><td>relativer Pfad für das aktuelle Icon</td></tr>
- <tr><td>pressure</td><td>Luftdruck in hPa</td></tr>
- <tr><td>pressure_trend</td><td>Luftdrucktendenz (0= gleichbleibend, 1= steigend, 2= fallend)</td></tr>
- <tr><td>pressure_trend_txt</td><td>textliche Darstellung der Luftdrucktendenz</td></tr>
- <tr><td>pressure_trend_sym</td><td>symbolische Darstellung der Luftdrucktendenz</td></tr>
- <tr><td>temperature</td><td>gegenwärtige Temperatur in Grad Celsius</td></tr>
- <tr><td>temp_c</td><td>gegenwärtige Temperatur in Grad Celsius</td></tr>
- <tr><td>temp_f</td><td>gegenwärtige Temperatur in Grad Celsius</td></tr>
- <tr><td>visibility</td><td>Sichtweite in km</td></tr>
- <tr><td>wind</td><td>Windgeschwindigkeit in km/h</td></tr>
- <tr><td>wind_chill</td><td>gefühlte Temperatur in Grad Celsius</td></tr>
- <tr><td>wind_condition</td><td>Windrichtung und -geschwindigkeit</td></tr>
- <tr><td>wind_direction</td><td>Gradangabe der Windrichtung (0 = Nordwind)</td></tr>
- <tr><td>wind_speed</td><td>Windgeschwindigkeit in km/h (mit wind identisch)</td></tr>
- </table>
- <br>
- Die folgenden Daten helfen zu identifizieren, ob ein Workaround angeschlagen hat, der die Verwendung von
- veralteten Daten auf dem entfernten Server verhindert:
- <table>
- <tr><td>pubDate</td><td>Veröffentlichungszeitpunkt der Wettervorhersage in den aktuellen Daten (readings)</td></tr>
- <tr><td>pubDateRemote</td><td>Veröffentlichungszeitpunkt der Wettervorhersage auf dem entfernten Server</td></tr>
- <tr><td>validity</td><td>stale, wenn der Veröffentlichungszeitpunkt auf dem entfernten Server vor dem Zeitpunkt der aktuellen Daten (readings) liegt</td></tr>
- </table>
- </ul>
- <br>
- <a name="Weatherattr"></a>
- <b>Attribute</b>
- <ul>
- <li>disable: stellt die Abfrage der Wetterdaten ab - der Timer läft gemäß Plan doch es werden keine Daten vom
- API angefordert.</li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="WeekdayTimer"></a>
- <h3>WeekdayTimer</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#WeekdayTimer'>WeekdayTimer</a><br/>
- </ul>
- <a name="WifiLight"></a>
- <h3>WifiLight</h3>
- <div class='langLinks'>[<a href='commandref.html#WifiLight'>EN</a> DE]</div>
- <ul>
- <p>Das Modul steuert eine große Anzahl unterschiedlicher "no name" LED Typen und stellt Ihnen einheitliches Interface zur Verfügung.</p>
- <p>Folgende Typen werden unterstützt:</p>
- <!-- <table rules="all" cellpadding="6" style="border:solid 1px;"> -->
- <table>
- <thead align="left">
- <tr>
- <th>
- Leuchtmitteltyp / bridge
- </th>
- <th>
- Type
- </th>
- <th>
- Notiz
- </th>
- <th>
- Signatur im define
- </th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- Milight RGB erste Generation
- </td>
- <td>
- E27, stripe controller
- </td>
- <td>
- *(1,2,a,C)
- </td>
- <td>
- RGB bridge-V2|3
- </td>
- </tr>
- <tr>
- <td>
- Milight RGBW1 erste Generation
- </td>
- <td>
- RGBW stripe controller
- </td>
- <td>
- *(1,2,a)
- </td>
- <td>
- RGBW1 bridge-V2|3
- </td>
- </tr>
- <tr>
- <td>
- Milight White
- </td>
- <td>
- E14, E27, GU10, stripe controller, Downlight
- </td>
- <td>
- *(1,2,b,W,nK)
- </td>
- <td>
- White bridge-V2|3
- </td>
- </tr>
- <tr>
- <td>
- Milight RGBW2 zweite Generation
- </td>
- <td>
- E14, E27, GU10, stripe controller, Downlight
- </td>
- <td>
- *(2,b,CW,S20)
- </td>
- <td>
- RGBW2 bridge-V3
- </td>
- </tr>
- <tr>
- <td>
- LW12 erste Generation (SSID LEDNet...)
- </td>
- <td>
- RGB stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGB LW12
- </td>
- </tr>
- <tr>
- <td>
- LW12HX (SSID HX...)
- </td>
- <td>
- RGB stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGB LW12HX
- </td>
- </tr>
- <tr>
- <td>
- LW12FC (SSID FC...)
- </td>
- <td>
- RGB stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGB LW12FC
- </td>
- </tr>
- <tr>
- <td>
- LD316 im RGB mode
- </td>
- <td>
- E27
- </td>
- <td>
-
- </td>
- <td>
- RGB LD316
- </td>
- </tr>
- <tr>
- <td>
- LD316 im RGBW mode
- </td>
- <td>
- E27
- </td>
- <td>
- *(S20)
- </td>
- <td>
- RGBW LD316
- </td>
- </tr>
- <tr>
- <td>
- LD316A im RGBW mode
- </td>
- <td>
- E27
- </td>
- <td>
- *(S20)
- </td>
- <td>
- RGBW LD316A
- </td>
- </tr>
- <tr>
- <td>
- LD382 im RGB mode
- </td>
- <td>
- RGB stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGB LD382
- </td>
- </tr>
- <tr>
- <td>
- LD382 im RGBW mode
- </td>
- <td>
- RGBW stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGBW LD382
- </td>
- </tr>
- <tr>
- <td>
- LD382A (FW 1.0.6) im RGB mode
- </td>
- <td>
- RGB stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGB LD382
- </td>
- </tr>
- <tr>
- <td>
- LD382A (FW 1.0.6) im RGBW mode
- </td>
- <td>
- RGBW stripe controller
- </td>
- <td>
-
- </td>
- <td>
- RGBW LD382
- </td>
- </tr>
- <tr>
- <td>
- SENGLED
- </td>
- <td>
- E27 mit WLAN repeater
- </td>
- <td>
-
- </td>
- <td>
- White Sengled
- </td>
- </tr>
- <tr>
- <td>
- SUNRICHER mit RGBW
- </td>
- <td>
- Controller
- </td>
- <td>
- *(!!!)
- </td>
- <td>
- RGBW Sunricher
- </td>
- </tr>
- </tbody>
- </table>
- <p>
- <small>
- (1) milght brigbe V2, V3, V4<br />
- (2) milight bridge V3, V4<br />
- (a) eine Gruppe pro bridge<br />
- (b) vier unabhängige Gruppen pro bridge<br />
- (nK) kein Temperatursupport, Kelvin<br />
- (C) rein Color<br />
- (W) rein White<br />
- (CW) rein Color oder White<br />
- (S20) Saturation <20: umschalten white Channel<br />
- (!!!) EXPERIMENTAL<br />
- </p>
- </small>
- <p>
- <table>
- <tr>
- <td>
- <p><b>Farbangaben</b></p>
- <p>Farben können im RGB oder im HSV Farbraum angegeben werden.</p>
- <p>Farbangaben im <a name="WifiLight_Farbraum_HSV"><b>Farbraum "HSV"</b></a> sind vollständig und in der Regel intuitiver als RGB.</p>
- <p><b>H</b> (HUE: 0..360) gibt die Grundfarbe in einem Farbkreis an.
- <ul>
- <li>Rot liegt bei 0°</li>
- <li>Grün bei 120°</li>
- <li>Blau bei 240°</li>
- </ul>
- </p>
- <p><b>S</b> (Saturation/Sättigung: 0..100) steht für die Sättigung der Farbe. Eine Sättigung von 100 bedeutet die Farbe ist "rein" oder komplett gesättigt. Blau zum Beispiel mit 100% Sättigung entspricht RGB #0000FF.</p>
- <p><b>V</b> (Value: 0..100) gibt die Helligkeit an. Ein V von 50 heißt: "halbe Helligkeit".</p>
- </td>
- <td>
- <a name="WifiLight_Farbkreis">
- <svg style="width:450px; height:320px;" viewBox="-100 -30 500 320">
- <linearGradient id="linearColors1" x1="0" y1="0" x2="1" y2="1">
- <stop offset="0%" stop-color="#FF0000"></stop>
- <stop offset="100%" stop-color="#FFFF00"></stop>
- </linearGradient>
- <linearGradient id="linearColors2" x1="0.5" y1="0" x2="0.5" y2="1">
- <stop offset="0%" stop-color="#FFFF00"></stop>
- <stop offset="100%" stop-color="#00FF00"></stop>
- </linearGradient>
- <linearGradient id="linearColors3" x1="1" y1="0" x2="0" y2="1">
- <stop offset="0%" stop-color="#00FF00"></stop>
- <stop offset="100%" stop-color="#00FFFF"></stop>
- </linearGradient>
- <linearGradient id="linearColors4" x1="1" y1="1" x2="0" y2="0">
- <stop offset="0%" stop-color="#00FFFF"></stop>
- <stop offset="100%" stop-color="#0000FF"></stop>
- </linearGradient>
- <linearGradient id="linearColors5" x1="0.5" y1="1" x2="0.5" y2="0">
- <stop offset="0%" stop-color="#0000FF"></stop>
- <stop offset="100%" stop-color="#FF00FF"></stop>
- </linearGradient>
- <linearGradient id="linearColors6" x1="0" y1="1" x2="1" y2="0">
- <stop offset="0%" stop-color="#FF00FF"></stop>
- <stop offset="100%" stop-color="#FF0000"></stop>
- </linearGradient>
- <linearGradient id="linearColors7" x1="152" y1="130" x2="152" y2="35" gradientUnits="userSpaceOnUse">
- <stop offset="0.2" stop-color="#FFFFFF"></stop>
- <stop offset="1" stop-color="#FF0000"></stop>
- </linearGradient>
- <linearGradient id="linearColors8" x1="152" y1="130" x2="230" y2="190" gradientUnits="userSpaceOnUse">
- <stop offset="0.2" stop-color="#FFFFFF"></stop>
- <stop offset="1" stop-color="#00FF00"></stop>
- </linearGradient>
- <linearGradient id="linearColors9" x1="152" y1="130" x2="70" y2="190" gradientUnits="userSpaceOnUse">
- <stop offset="0.2" stop-color="#FFFFFF"></stop>
- <stop offset="1" stop-color="#0000FF"></stop>
- </linearGradient>
- <marker id="markerArrow" markerWidth="13" markerHeight="13" refX="2" refY="6" orient="auto">
- <path d="M2,2 L2,11 L10,6 L2,2" style="fill:grey;" />
- </marker>
- <path d="M150 10 a120 120 0 0 1 103.9230 60" fill="none" stroke="url(#linearColors1)" stroke-width="20" />
- <path d="M253.9230 70 a120 120 0 0 1 0 120" fill="none" stroke="url(#linearColors2)" stroke-width="20" />
- <path d="M253.9230 190 a120 120 0 0 1 -103.9230 60" fill="none" stroke="url(#linearColors3)" stroke-width="20" />
- <path d="M150 250 a120 120 0 0 1 -103.9230 -60" fill="none" stroke="url(#linearColors4)" stroke-width="20" />
- <path d="M46.077 190 a120 120 0 0 1 0 -120" fill="none" stroke="url(#linearColors5)" stroke-width="20" />
- <path d="M46.077 70 a120 120 0 0 1 103.9230 -60" fill="none" stroke="url(#linearColors6)" stroke-width="20" />
- <path d="M150,50 C250,50 250,180 180,200" fill="none" stroke="grey" stroke-width="2" marker-end="url(#markerArrow)" />
- <text class="Label" x="126" y="208">HUE</text>
- <line x1="152" y1="130" x2="152" y2="35" stroke="url(#linearColors7)" stroke-width="4" />
- <line x1="136" y1="120" x2="136" y2="45" stroke="grey" stroke-width="2" marker-end="url(#markerArrow)" />
- <text class="Label" x="96" y="96">SAT</text>
- <line x1="152" y1="130" x2="230" y2="190" stroke="url(#linearColors8)" stroke-width="4" />
- <line x1="152" y1="130" x2="70" y2="190" stroke="url(#linearColors9)" stroke-width="4" />
- <text x="120" y="-10">0° (Rot)</text>
- <text x="270" y="60">60° (Gelb)</text>
- <text x="270" y="220">120° (Grün)</text>
- <text x="110" y="285">180° (Cyan)</text>
- <text x="-60" y="220">240° (Blau)</text>
- <text x="-90" y="60">300° (Magenta)</text>
- </svg>
- </a>
- </td>
- </tr>
- </table>
- </p>
- <p><b>Farbangaben: HSV gegenüber RGB</b><p>
- <p>
- Im Normalfall kann eine Farbe im HSV Farbraum genauso wie im RGB Farbraum dargestellt werden.
- <p>
- Farben im HSV Farbraum wirken meist verständlicher.
- Um ein Grün im HSV Farbraum etwas mehr in Richtung CYAN zu bewegen wird einfach der HUE Wert (Winkel) etwas erhöht.
- Im RGB Farbraum ist die gleiche Aufgabe weniger intuitiv durch eine Erhöhung von BLAU zu erreichen.
- <p>
- Unterschiede werden jedoch bei Transitions deutlich.
- Um BLAU langsam auf zu dimmen lauten die HSV Transitions 240,100,0 -> 240,100,100.
- Um von ROT (Helligkeit 0) langsam auf BLAU zu dimmen wird im HSV Farbraum 0,100,0 -> 240,100,100 verwendet.
- Im RGB Farbraum (#000000 -> #0000FF) kann nicht zwischen den beiden Varianten unterschieden werden.
- Hier würde (richtiger weise, vermutlich jedoch anders als beabsichtigt) in beiden Fällen ein Weiß (Helligkeit 0) als Startwert erscheinen.
- </p>
- <p><b>Define</b></p>
- <ul>
- <li>
- <p><code>define <name> WifiLight <Leuchtmitteltyp> <bridgetyp>:<IP|FQDN></code></p>
- <p>
- <i><u>Beispiele</u></i>
- <ul>
- <p>
- <i>definiert einen milight RGBW2 Leuchtmittel (Bulb oder LED stripe controller) an einer milight bridge Version 3 oder 4.
- Die LED wird den maximal 4 verfügbaren Gruppen pro bridge in der Reihenfolge der Definition zugeordnet:</i>
- <br/>
- <code>define wz.licht.decke WifiLight RGBW2 bridge-V3:192.168.178.142</code>
- </ul>
- <ul>
- <p>
- <i>definiert einen LD382A Controller mit RGBW Stripe:</i>
- <br/>
- <code>define wz.licht.decke WifiLight RGBW LD382A:192.168.178.142</code>
- </ul>
- <ul>
- <p>
- <i>definiert einen LD382A Controller mit RGB Stripe:</i>
- <br/>
- <code>define wz.licht.decke WifiLight RGB LD382A:192.168.178.142</code>
- </ul>
- <p>WifiLight verfügt über eine <a href="#WifiLight_Farbkalibrierung">"Farbkalibrierung"</a>. Sinnvollerweise sollte nach einem Leuchtmitteltausch oder einem define eine Kalibrierung vorgenommen werden.</p>
- </ul>
- </li>
- <p><b>Set</b></p>
- <ul>
- <li>
- <p><code>set <name> <b>on</b> [ramp]</code></p>
- <p>Schaltet das device ein. Dabei wird entweder 100% Weiß oder die im Attribut "defaultColor" definierte Farbe gewählt.
- <p>Erweiterte Parameter:
- <ul>
- <li>ramp</li>
- </ul>
- </p>
- </li>
- <li>
- <p><code>set <name> <b>off</b> [ramp]</code></p>
- <p>Schaltet das device aus.
- <p>Erweiterte Parameter:
- <ul>
- <li>ramp</li>
- </ul>
- </p>
- </li>
- <li>
- <p><code>set <name> <b>dimup</b></code></p>
- <p>Erhöht die Helligkeit um einen festen Betrag. Dabei wird der im Attribut "dimStep" definierte Wert oder der Default "7" angewendet.<br>Dieser Befehl eignet sich besonders um die Helligkeit über einen Wandschalter oder eine Fernbedienung zu erhöhen.
- <p>Erweiterte Parameter:
- <ul>
- <li>keine</li>
- </ul>
- </p>
- </li>
- <li>
- <p><code>set <name> <b>dimdown</b></code></p>
- <p>Verringert die Helligkeit um einen festen Betrag. Dabei wird der im Attribut "dimStep" definierte Wert oder der Default "7" angewendet.<br>Dieser Befehl eignet sich besonders um die Helligkeit über einen Wandschalter oder eine Fernbedienung zu verringern
- <p>Erweiterte Parameter:
- <ul>
- <li>keine</li>
- </ul>
- </p>
- </li>
- <li>
- <p><code>set <name> <b>dim</b> level [ramp] [q]</code></p>
- <p>Setzt die Helligkeit auf den angegebenen level (0..100).<br>Dieser Befehl behält außerdem die eingestellte Farbe auch bei "dim 0" (ausgeschaltet) und nachfolgendem "dim xx" (eingeschaltet) bei. Daher stellt er eine alternative Form zu "off" / "on" dar. Letzteres würde immer die "defaultColor" wählen.
- <p>Erweiterte Parameter:
- <ul>
- <li>ramp</li>
- </ul>
- </p>
- <p>Flags:
- <ul>
- <li>q</li>
- </ul>
- </p>
- </li>
- <li>
- <p><code>set <name> <b>HSV</b> H,S,V [ramp] [s|l|q] [event]</code></p>
- <p>Setzt die Farbe im <a href="#WifiLight_Farbraum_HSV">HSV Farbraum</a>. Wenn die ramp (als Zeit in Sekunden) angegeben ist, berechnet das modul einen weichen Farbübergang von der aktuellen Farbe zur neu gesetzten.
- <ul><i>Beispiel, setzt ein gesättigtes Blau mit halber Helligkeit:</i><br /><code>set wz.licht.decke HSV 240,100,50</code></ul>
- <p>Erweiterte Parameter:
- <ul>
- <li>ramp</li>
- </ul>
- </p>
- <p>Flags:
- <ul>
- <li>s l q event</li>
- </ul>
- </p>
- </li>
- <li>
- <p><code>set <name> <b>RGB</b> RRGGBB [ramp] [l|s|q] [event]</code></p>
- <p>Setzt die Farbe im RGB Farbraum.
- <p>Erweiterte Parameter:
- <ul>
- <li>ramp</li>
- </ul>
- </p>
- <p>Flags:
- <ul>
- <li>s l q event</li>
- </ul>
- </p>
- </ul>
- </li>
- <p><b>Bedeutung der Flags</b></p>
- Bestimmte Befehle (set) können mit speziellen Flags versehen werden.
- <p>
- <ul>
- <li>ramp:
- <ul>
- Zeit in Sekunden für einen weichen Farb- oder Helligkeitsübergang. Der weiche Übergang startet bei der aktuell sichtbaren Farbe und wird zur angegeben berechnet.
- </ul>
- </li>
- <li>s:
- <ul>
- (short, default). Ein weicher Übergang zu einer anderen Farbe wird im <a href="#WifiLight_Farbkreis">"Farbkreis"</a> auf dem kürzesten Weg durchgeführt.</br>
- Eine Transition von ROT nach GRÜN führt auf dem kürzesten Weg über GELB.
- </ul>
- </li>
- <li>l:
- <ul>
- (long). Ein weicher Übergang zu einer anderen Farbe wird im <a href="#WifiLight_Farbkreis">"Farbkreis"</a> auf dem "langen" Weg durchgeführt.</br>
- Eine Transition von ROT nach GRÜN führt dann über MAGENTA, BLAU, und CYAN.
- </ul>
- </li>
- <li>q:
- <ul>
- (queue). Kommandos mit diesem Flag werden in einer internen Warteschlange zwischengespeichert und erst ausgeführt nachdem die aktuell laufenden weichen Übergänge
- abgearbeitet wurden. Kommandos ohne das Flag werden sofort abgearbeitet. Dabei werden alle laufenden Übergänge sofort abgebrochen und die Warteschlange wird gelöscht.
- </ul>
- </li>
- <li>event:
- <ul>
- Beliebige Bezeichnung ([A-Za-z_0-9])
- <p>
- WifiLight erzeugt bei Verwendung dieses Flags im Verlauf weicher Übergange zu einer anderen Farbe Nachrichten (events) in der Form:
- <p>
- <code>WifiLight <NAME> programm: <EVENT> <XX></code>.
- <p>
- <EVENT> entspricht dem Namen so wie im Flag angegeben.<br/>
- <XX> ist der prozentuale Fortschritt des Übergangs.<br/>
- <p>
- Je nach Gesamtdauer des Übergangs werden die Werte von 0 bis 100 nicht komplett durchlaufen wobei jedoch für 0% und 100% immer ein event garantiert ist. Auf diese events kann dann innerhalb von notify oder DOIF reagiert werden um zum Beispiel:
- <ul>
- <li>die Lautstärke eines Radios anzupassen wenn eine LED morgens langsam hochgedimmt wird</li>
- <li>ein Farbübergang kann in einem notify neu gestartet werden wenn er komplett ist (loop)</li>
- <li>andere Leuchtmittel können mit erstellten Farbübergängen synchronisiert werden</li>
- </ul>
- </ul>
- </li>
- </ul>
- <p><b><a name="WifiLight_Farbkalibrierung"></a>Farbkalibrierung</b></p>
- WifiLight unterstützt zwei unterschiedliche Formen der Farbkalibrierungen:
- <ul>
- <p>
- <b>Korrektur gesättigter Farben</b>
- <p>
- Hintergrund:
- <p>
- GELB, zum Beispiel, ist definiert als Mischung aus ROTEM und GRÜNEM Licht zu gleichen Teilen.
- Je nach verwendeter LED und Ansteuerung ist der GRÜNE Kanal nun möglicherweise viel leuchtstärker.
- Wenn jetzt also die ROTE und GRÜNE LED jeweils voll angesteuert werden überwiegt GRÜN in dieser Mischung und das gewünschte GELB bekäme einen deutlichen Grünstich.
- In diesem Beispiel würde jetzt für HSV 60,100,100 kein Gelb (entsprechend 60° im <a href="#WifiLight_Farbkreis">"Farbkreis"</a>) erzeugt.
- Stattdessen würde GRÜN mit GELBSTICH erzeugt das vielleicht einem geschätzten Farbwinkel von 80° entspricht.
- Die erforderliche Korrektur für GELB würde also minus 20° betragen (60° SOLL - 80° IST = -20° Korrektur).
- GELB müsste als um -20° korrigiert werden. Mögliche Werte pro Korrektur-Punkt sind +/- 29°.
- <p>
- Vorgehen:
- <p>
- Die Korrektur der Vollfarben wird über das Attribut "colorCast" gesteuert. Dabei werden 6 (Komma getrennte) Werte im Bereich -29 bis 29 angegeben.
- Diese Werte stehen entsprechen der Winkelkorrektur für ROT (0°), GELB (60°), GRÜN (120°), CYAN (180°), BLAU (240°) und MAGENTA (300°).
- Zuerst sollte die Abweichung für 60°/180°/300° (die Mischfarben) so wie in obigem Beispiel ermittelt und im Attribut hinterlegt werden.
- Im Anschluss sollten die Primärfarben (0°/120°/240°) so korrigiert werden das die weichen Übergänge zwischen benachbarten reinen Farben möglichst linear erscheinen.
- Dieser Vorgang muss eventuell iterativ mehrfach wiederholt werden bis das Ergebniss stimmig ist.
- <p>
- <b>Weißabgleich</b>
- <p>
- Hintergrund:
- <p>
- Einige Leuchtmittel erzeugen weißes Licht durch Mischung der RGB Kanäle (zum Beispiel LW12).
- Je nach Leuchtstärke der RGB Kanäle der verwendeten LED Streifen unterscheidet sich das Ergebnis und eine oder zwei Farben dominieren.
- Zusätzlich gibt es verschiedene Formen weißen Lichtes. Kaltes Licht hat einen höheren Blauanteil.
- Dagegen wird in Mitteleuropa für Leuchtmittel meist warm-weiß verwendet welches einen hohen ROT- und geringen BLAU Anteil hat.
- <p>
- WifiLight bietet die Möglichkeit bei RGB gemischtem Weiß die Zusammensetzung anzupassen. Die Anpassung erfolgt über das Attribut "whitePoint".
- Dieses erwartet für jeden der drei RGB Kanäle einen Wert zwischen 0 und 1 (ein Komma wird als Punkt angegeben). Die drei Werte werden mit einem normalen Komma getrennt.
- <p>
- Vorgehen:
- <p>
- Eine Angabe von "1,1,1" setzt alle die drei Kanäle auf jeweils 100%. Angenommen der BLAU Anteil des weißen Lichtes soll nun verringert werden.
- Ein Wert von "1,1,0.5" setzt den dritten Kanal (BLAU) bei Weiß auf 0.5 entsprechend 50%. Vor einem Weißabgleich sollte die Korrektur der Vollfarben abgeschlossen sein.
- </ul>
- <p><b>Attribute</b></p>
- <ul>
- <li>
- <code>attr <name> <b>colorCast</b> <R,Y,G,C,B,M></code>
- <p>
- <a href="#WifiLight_Farbkalibrierung">Farbkalibrierung</a> der voll gesättigten Farben.
- R(ed), Y(ellow), G(reen), C(yan), B(lue), M(agenta) im Bereich +/- 29
- </li>
- <li>
- <code>attr <name> <b>defaultColor</b> <H,S,V></code>
- <p>
- HSV Angabe der Lichtfarbe die bei "on" gewählt wird. Default ist Weiß.
- </li>
- <li>
- <code>attr <name> <b>defaultRamp</b> <0 bis X></code>
- <p>
- Zeit in Sekunden. Wenn dieses Attribut gesetzt ist wird implizit immer ein weicher Übergang erzeugt wenn keine Ramp im set angegeben ist.
- </li>
- <li>
- <code>attr <name> <b>dimStep</b> <0 bis 100></code>
- <p>
- Wert um den die Helligkeit bei dimUp und dimDown verändert wird. Default 7.
- </li>
- <li>
- <code>attr <name> <b>gamma</b> <X.X></code>
- <p>
- Das menschliche Auge nimmt Helligkeitsänderungen sehr unterschiedlich wahr (logarithmisch).
- Bei geringer Ausgangshelligkeit wird schon eine kleine Helligkeitsänderung als sehr stark empfunden und auf der anderen Seite sind bei großer Helligkeit starke Änderungen notwendig.
- Daher ist eine logarithmische Korrektur des Helligkeitsanstiegs der Leuchtmittel erforderlich damit der Anstieg als gleichmäßig empfunden wird.
- Einige controller führen diese Korrektur intern durch. In anderen Fällen ist es notwendig diese Korrektur im Modul zu hinterlegen.
- Ein gamma Wert von 1.0 (default) führt zu einer linearen Ausgabe der Werte. Werte kleiner als 1.0 führen zu einer logarithmischem Korrektur.
- </li>
- <li>
- <code>attr <name> <b>whitePoint</b> <R,G,B></code>
- <p>
- <a href="#WifiLight_Farbkalibrierung">Farbkalibrierung</a> für RGB gemischtes weißes Licht.
- </li>
- <li>
- <code>attr <name> <b><a href="#readingFnAttributes">readingFnAttributes</a></b></code>
- </li>
- </ul>
- <p><b>Farbiges Icon für FhemWeb</b>
- <ul>
- <p>
- Um ein farbiges Icon für <a href="#FHEMWEB">FhemWeb</a> zu aktivieren muss das folgende Attribut gesetzt sein:
- <p>
- <li>
- <code>attr <name> <b>devStateIcon</b> {Color_devStateIcon(ReadingsVal($name,"RGB","000000"))}</code>
- </li>
- </ul>
- <p><b>Colorpicker für FhemWeb</b>
- <ul>
- <p>
- Um den Color-Picker für <a href="#FHEMWEB">FhemWeb</a> zu aktivieren müssen folgende Attribute gesetzt werden:
- <p>
- <li>
- <code>attr <name> <b>webCmd</b> RGB</code>
- </li>
- <li>
- <code>attr <name> <b>widgetOverride</b> RGB:colorpicker,RGB</code>
- </li>
- </ul>
- </ul>
- <p><a name="Wunderground" id="Wunderground"></a>
- <h3>Wunderground</h3>
- <div class='langLinks'>[<a href='commandref.html#Wunderground'>EN</a> DE]</div>
- <ul>
- Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:
- </ul>
- <ul>
- <a href='http://fhem.de/commandref.html#Wunderground'>Wunderground</a>
- </ul>
- <p><a name="X10"></a>
- <h3>X10</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#X10'>X10</a><br/>
- </ul>
- <a name="XBMC"></a>
- <h3>XBMC</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#XBMC'>XBMC</a><br/>
- </ul>
- <a name="XiaomiBTLESens"></a>
- <h3>Xiaomi BTLE Sensor</h3>
- <div class='langLinks'>[<a href='commandref.html#XiaomiBTLESens'>EN</a> DE]</div>
- <ul>
- <u><b>XiaomiBTLESens - liest Daten von einem Xiaomi BTLE Sensor</b></u>
- <br />
- Dieser Modul liest Daten von einem Sensor und legt sie in den Readings ab.<br />
- Auf dem (Linux) FHEM-Server werden gatttool und hcitool vorausgesetzt. (sudo apt install bluez)
- <br /><br />
- <a name="XiaomiBTLESensdefine"></a>
- <b>Define</b>
- <ul><br />
- <code>define <name> XiaomiBTLESens <BT-MAC></code>
- <br /><br />
- Beispiel:
- <ul><br />
- <code>define Weihnachtskaktus XiaomiBTLESens C4:7C:8D:62:42:6F</code><br />
- </ul>
- <br />
- Der Befehl legt ein Device vom Typ XiaomiBTLESens an mit dem Namen Weihnachtskaktus und der Bluetooth MAC C4:7C:8D:62:42:6F.<br />
- Nach dem Anlegen des Device werden umgehend und automatisch die aktuellen Daten vom betroffenen Xiaomi BTLE Sensor gelesen.
- </ul>
- <br /><br />
- <a name="XiaomiBTLESensreadings"></a>
- <b>Readings</b>
- <ul>
- <li>state - Status des BTLE Sensor oder eine Fehlermeldung falls Fehler beim letzten Kontakt auftraten.</li>
- <li>battery - aktueller Batterie-Status in Abhängigkeit vom Wert batteryLevel.</li>
- <li>batteryLevel - aktueller Ladestand der Batterie in Prozent.</li>
- <li>fertility - Wert des Fruchtbarkeitssensors (Bodenleitfähigkeit)</li>
- <li>firmware - aktuelle Firmware-Version des BTLE Sensor</li>
- <li>lux - aktuelle Lichtintensität</li>
- <li>moisture - aktueller Feuchtigkeitswert</li>
- <li>temperature - aktuelle Temperatur</li>
- </ul>
- <br /><br />
- <a name="XiaomiBTLESensset"></a>
- <b>Set</b>
- <ul>
- <li></li>
- <br />
- </ul>
- <br /><br />
- <a name="XiaomiBTLESensset"></a>
- <b>Get</b>
- <ul>
- <li>devicename - setzt einen Devicenamen</li>
- <br />
- </ul>
- <br /><br />
- <a name="XiaomiBTLESensGet"></a>
- <b>Get</b>
- <ul>
- <li>sensorData - aktive Abfrage der Sensors Werte</li>
- <li>devicename - liest den Devicenamen aus</li>
- <li>firmware - liest die Firmeware aus</li>
- <br />
- </ul>
- <br /><br />
- <a name="XiaomiBTLESensattribut"></a>
- <b>Attribute</b>
- <ul>
- <li>disable - deaktiviert das Device</li>
- <li>interval - Interval in Sekunden zwischen zwei Abfragen</li>
- <li>disabledForIntervals - deaktiviert das Gerät für den angegebenen Zeitinterval (13:00-18:30 or 13:00-18:30 22:00-23:00)</li>
- <li>minFertility - min Fruchtbarkeits-Grenzwert für ein Ereignis minFertility low </li>
- <li>maxFertility - max Fruchtbarkeits-Grenzwert für ein Ereignis maxFertility high </li>
- <li>minMoisture - min Feuchtigkeits-Grenzwert für ein Ereignis minMoisture low </li>
- <li>maxMoisture - max Feuchtigkeits-Grenzwert für ein Ereignis maxMoisture high </li>
- <li>minTemp - min Temperatur-Grenzwert für ein Ereignis minTemp low </li>
- <li>maxTemp - max Temperatur-Grenzwert für ein Ereignis maxTemp high </li>
- <li>minlux - min Helligkeits-Grenzwert für ein Ereignis minlux low </li>
- <li>maxlux - max Helligkeits-Grenzwert für ein Ereignis maxlux high
- <br /><br />Beispiele für min/max-Ereignisse:<br />
- 2017-03-16 11:08:05 XiaomiBTLESens Dracaena minMoisture low<br />
- 2017-03-16 11:08:06 XiaomiBTLESens Dracaena maxTemp high<br /><br /></li>
- <li>sshHost - FQDN oder IP-Adresse eines entfernten SSH-Systems. Das SSH-System ist auf eine Zertifikat basierte Authentifizierung zu konfigurieren. Am elegantesten geschieht das mit einer .ssh/config Datei auf dem SSH-Client.</li>
- <li>batteryFirmwareAge - wie alt soll der Timestamp des Readings sein bevor eine Aktuallisierung statt findet</li>
- <li>blockingCallLoglevel - Blocking.pm Loglevel für BlockingCall Logausgaben</li>
- </ul>
- </ul>
- <p><a name="XiaomiDevice"></a>
- <h3>XiaomiDevice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#XiaomiDevice'>XiaomiDevice</a><br/>
- </ul>
- <a name="XiaomiFlowerSens"></a>
- <h3>Xiaomi Flower Monitor</h3>
- <div class='langLinks'>[<a href='commandref.html#XiaomiFlowerSens'>EN</a> DE]</div>
- <ul>
- <u><b>XiaomiFlowerSens - liest Daten von einem Xiaomi Flower Monitor</b></u>
- <br />
- Dieser Modul liest Daten von einem Sensor und legt sie in den Readings ab.<br />
- Auf dem (Linux) FHEM-Server werden gatttool und hcitool vorausgesetzt. (sudo apt install bluez)
- <br /><br />
- <a name="XiaomiFlowerSensdefine"></a>
- <b>Define</b>
- <ul><br />
- <code>define <name> XiaomiFlowerSens <BT-MAC></code>
- <br /><br />
- Beispiel:
- <ul><br />
- <code>define Weihnachtskaktus XiaomiFlowerSens C4:7C:8D:62:42:6F</code><br />
- </ul>
- <br />
- Der Befehl legt ein Device vom Typ XiaomiFlowerSens an mit dem Namen Weihnachtskaktus und der Bluetooth MAC C4:7C:8D:62:42:6F.<br />
- Nach dem Anlegen des Device werden umgehend und automatisch die aktuellen Daten vom betroffenen Xiaomi Flower Monitor gelesen.
- </ul>
- <br /><br />
- <a name="XiaomiFlowerSensreadings"></a>
- <b>Readings</b>
- <ul>
- <li>state - Status des Flower Monitor oder eine Fehlermeldung falls Fehler beim letzten Kontakt auftraten.</li>
- <li>battery - aktueller Batterie-Status in Abhängigkeit vom Wert batteryLevel.</li>
- <li>batteryLevel - aktueller Ladestand der Batterie in Prozent.</li>
- <li>fertility - Wert des Fruchtbarkeitssensors (Bodenleitfähigkeit)</li>
- <li>firmware - aktuelle Firmware-Version des Flower Monitor</li>
- <li>lux - aktuelle Lichtintensität</li>
- <li>moisture - aktueller Feuchtigkeitswert</li>
- <li>temperature - aktuelle Temperatur</li>
- </ul>
- <br /><br />
- <a name="XiaomiFlowerSensset"></a>
- <b>Set</b>
- <ul>
- <li>clearFirmwareReading - löscht das Reading firmware für/nach Upgrade</li>
- <br />
- </ul>
- <br /><br />
- <a name="XiaomiFlowerSensGet"></a>
- <b>Get</b>
- <ul>
- <li>statusRequest - aktive Abfrage des aktuellen Status des Xiaomi Flower Monitor und seiner Werte</li>
- <br />
- </ul>
- <br /><br />
- <a name="XiaomiFlowerSensattribut"></a>
- <b>Attribute</b>
- <ul>
- <li>disable - deaktiviert das Device</li>
- <li>interval - Interval in Sekunden zwischen zwei Abfragen</li>
- <li>disabledForIntervals - deaktiviert das Gerät für den angegebenen Zeitinterval (13:00-18:30 or 13:00-18:30 22:00-23:00)</li>
- <li>minFertility - min Fruchtbarkeits-Grenzwert für ein Ereignis minFertility low </li>
- <li>maxFertility - max Fruchtbarkeits-Grenzwert für ein Ereignis maxFertility high </li>
- <li>minMoisture - min Feuchtigkeits-Grenzwert für ein Ereignis minMoisture low </li>
- <li>maxMoisture - max Feuchtigkeits-Grenzwert für ein Ereignis maxMoisture high </li>
- <li>minTemp - min Temperatur-Grenzwert für ein Ereignis minTemp low </li>
- <li>maxTemp - max Temperatur-Grenzwert für ein Ereignis maxTemp high </li>
- <li>minlux - min Helligkeits-Grenzwert für ein Ereignis minlux low </li>
- <li>maxlux - max Helligkeits-Grenzwert für ein Ereignis maxlux high
- <br /><br />Beispiele für min/max-Ereignisse:<br />
- 2017-03-16 11:08:05 XiaomiFlowerSens Dracaena minMoisture low<br />
- 2017-03-16 11:08:06 XiaomiFlowerSens Dracaena maxTemp high<br /><br /></li>
- <li>sshHost - FQDN oder IP-Adresse eines entfernten SSH-Systems. Das SSH-System ist auf eine Zertifikat basierte Authentifizierung zu konfigurieren. Am elegantesten geschieht das mit einer .ssh/config Datei auf dem SSH-Client.</li>
- <li>batteryFirmwareAge - wie alt soll der Timestamp des Readings sein bevor eine Aktuallisierung statt findet</li>
- <li>blockingCallLoglevel - Blocking.pm Loglevel für BlockingCall Logausgaben</li>
- </ul>
- </ul>
- <p><a name="XmlList"></a>
- <h3>XmlList</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#XmlList'>XmlList</a><br/>
- </ul>
- <a name="YAAHM"></a>
- <h3>YAAHM</h3>
- <div class='langLinks'>[<a href='commandref.html#YAAHM'>EN</a> DE]</div>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Modul_YAAHM">Deutsche Dokumentation im Wiki</a> vorhanden, die englische Version gibt es hier: <a href="/fhem/docs/commandref.html#YAAHM">YAAHM</a>
- </ul>
- <p><a name="YAMAHA_AVR"></a>
- <h3>YAMAHA_AVR</h3>
- <div class='langLinks'>[<a href='commandref.html#YAMAHA_AVR'>EN</a> DE]</div>
- <ul>
- <a name="YAMAHA_AVR_define"></a>
- <b>Definition</b>
- <ul>
- <code>define <name> YAMAHA_AVR <IP-Addresse> [<Zone>] [<Status_Interval>]
- <br><br>
- define <name> YAMAHA_AVR <IP-Addresse> [<Zone>] [<Off_Interval>] [<On_Interval>]
- </code>
- <br><br>
- Dieses Modul steuert AV-Receiver des Herstellers Yamaha über die Netzwerkschnittstelle.
- Es bietet die Möglichkeit den Receiver an-/auszuschalten, den Eingangskanal zu wählen,
- die Lautstärke zu ändern, den Receiver "Stumm" zu schalten, sowie den aktuellen Status abzufragen.
- <br><br>
- Bei der Definition eines YAMAHA_AVR-Moduls wird eine interne Routine in Gang gesetzt, welche regelmäßig
- (einstellbar durch den optionalen Parameter <code><Status_Interval></code>; falls nicht gesetzt ist der Standardwert 30 Sekunden)
- den Status des Receivers abfragt und entsprechende Notify-/FileLog-Geräte triggert.
- <br><br>
- Sofern 2 Interval-Argumente übergeben werden, wird der erste Parameter <code><Off_Interval></code> genutzt
- sofern der Receiver ausgeschaltet oder nicht erreichbar ist. Der zweiter Parameter <code><On_Interval></code>
- wird verwendet, sofern der Receiver eingeschaltet ist.
- <br><br>
- Beispiel:<br><br>
- <ul><code>
- define AV_Receiver YAMAHA_AVR 192.168.0.10
- <br><br>
- # Mit modifiziertem Status Interval (60 Sekunden)<br>
- define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60
- <br><br>
- # Mit gesetztem "Off"-Interval (60 Sekunden) und "On"-Interval (10 Sekunden)<br>
- define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60 10
- </code></ul><br><br>
- </ul>
- <b>Zonenauswahl</b><br>
- <ul>
- Wenn der zu steuernde Receiver mehrere Zonen besitzt (z.B. RX-V671, RX-V673,... sowie die AVANTAGE Modellreihe)
- kann die zu steuernde Zone explizit angegeben werden. Die Modellreihen RX-V3xx und RX-V4xx als Beispiel
- haben nur eine Zone (Main Zone). Je nach Receiver-Modell stehen folgende Zonen zur Verfügung, welche mit
- dem optionalen Parameter <Zone> angegeben werden können.<br><br>
- <ul>
- <li><b>mainzone</b> - Das ist die Hauptzone (Standard)</li>
- <li><b>zone2</b> - Die zweite Zone (Zone 2)</li>
- <li><b>zone3</b> - Die dritte Zone (Zone 3)</li>
- <li><b>zone4</b> - Die vierte Zone (Zone 4)</li>
- </ul>
- <br>
- Je nach Receiver-Modell stehen in den verschiedenen Zonen nicht immer alle Eingänge zur Verfügung.
- Dieses Modul bietet nur die tatsächlich verfügbaren Eingänge an.
- <br><br>
- Beispiel:<br><br>
- <ul><code>
- define AV_Receiver YAMAHA_AVR 192.168.0.10 # Wenn keine Zone angegeben ist, wird<br>
- attr AV_Receiver YAMAHA_AVR room Wohnzimmer # standardmäßig "mainzone" verwendet<br>
- <br>
- # Definition der zweiten Zone<br>
- define AV_Receiver_Zone2 YAMAHA_AVR 192.168.0.10 zone2<br>
- attr AV_Receiver_Zone2 room Schlafzimmer<br>
- </code></ul><br><br>
- Für jede Zone muss eine eigene YAMAHA_AVR Definition erzeugt werden, welche dann unterschiedlichen Räumen zugeordnet werden kann.
- Jede Zone kann unabhängig von allen anderen Zonen (inkl. der Main Zone) gesteuert werden.
- <br><br>
- </ul>
-
- <a name="YAMAHA_AVR_set"></a>
- <b>Set-Kommandos </b>
- <ul>
- <code>set <Name> <Kommando> [<Parameter>]</code>
- <br><br>
- Aktuell werden folgende Kommandos unterstützt. Die verfügbaren Eingänge und Szenen können je nach Receiver-Modell variieren.
- Die folgenden Eingänge stehen beispielhaft an einem RX-V473 Receiver zur Verfügung.
- Aktuell stehen folgende Kommandos zur Verfügung.
- <br><br>
- <ul>
- <li><b>on</b> - Schaltet den Receiver ein</li>
- <li><b>off</b> - Schaltet den Receiver aus</li>
- <li><b>dsp</b> hallinmunich,hallinvienna,... - Aktiviert das entsprechende DSP Preset</li>
- <li><b>enhancer</b> on,off - Aktiviert den Sound Enhancer für einen verbesserten Raumklang</li>
- <li><b>3dCinemaDsp</b> auto,off - Aktiviert den CINEMA DSP 3D Modus</li>
- <li><b>adaptiveDrc</b> auto,off - Aktiviert Adaptive DRC</li>
- <li><b>extraBass</b> auto,off - Aktiviert den Extra Bass</li>
- <li><b>ypaoVolume</b> auto,off - Aktiviert YPAO Lautstärke</li>
- <li><b>displayBrightness</b> -4...0 - Steuert die Helligkeitsreduzierung des Front-Displays</li>
- <li><b>partyMode</b> on|off - Aktiviert den Party Modus. In der Main Zone wird hierbei der Party Modus geräteweit aktiviert oder deaktiviert. In den anderen Zonen kann man damit die entsprechende Zone dem Party Modus zuschalten oder entziehen.</li>
- <li><b>navigateListMenu</b> [Element 1]/[Element 2]/.../[Element N] - Wählt ein spezifisches Element aus einer Menüstruktur aus. Nur verwendbar bei Menü-basierenden Eingängen (z.B. Net Radio, USB, Server, etc.). Siehe nachfolgendes Kapitel "<a href="#YAMAHA_AVR_MenuNavigation">Automatische Menü Navigation</a>" für weitere Details und Beispiele.</li>
- <li><b>tunerFrequency</b> [Frequenz] [AM|FM] - setzt die Radio-Frequenz. Das erste Argument ist die Frequenz, der zweite dient optional zu Angabe des Bandes (AM oder FM, standardmäßig FM). Abhängig davon, welches Band man benutzt, wird die Frequenz in kHz (AM-Band) oder MHz (FM-Band) angegeben. Wenn im zweiten Argument kein Band angegeben ist, wird standardmäßig das FM-Band benutzt. Dieser Befehl kann auch benutzt werden, wenn der aktuelle Eingang nicht "tuner" ist. Die neue Frequenz wird dennoch gesetzt und bei der nächsten Benutzung abgespielt.</li>
- <li><b>preset</b> 1...40 - wählt ein gespeichertes Preset für den aktuellen Eingang aus.</li>
- <li><b>presetUp</b> - wählt das nächste Preset für den aktuellen Eingang aus.</li>
- <li><b>presetDown</b> - wählt das vorherige Preset für den aktuellen Eingang aus.</li>
- <li><b>direct</b> on,off - Umgeht alle internen soundverbessernden Maßnahmen (Equalizer, Enhancer, Adaptive DRC,...) und gibt das Signal unverfälscht wieder</li>
- <li><b>input</b> hdmi1,hdmiX,... - Wählt den Eingangskanal (es werden nur die tatsächlich verfügbaren Eingänge angeboten)</li>
- <li><b>hdmiOut1</b> on,off - Aktiviert die Ausgabe via HDMI Ausgang 1</li>
- <li><b>hdmiOut2</b> on,off - Aktiviert die Ausgabe via HDMI Ausgang 2</li>
- <li><b>scene</b> scene1,sceneX - Wählt eine vorgefertigte Szene aus</li>
- <li><b>surroundDecoder</b> dolbypl,... - Setzt den Surround Decoder, welcher genutzt werden soll sofern der DSP Modus "Surround Decoder" aktiv ist.</li>
- <li><b>volume</b> 0...100 [direct] - Setzt die Lautstärke in Prozent (0 bis 100%). Wenn als zweites Argument "direct" gesetzt ist, wird keine weiche Lautstärkenanpassung durchgeführt (sofern aktiviert). Die Lautstärke wird in diesem Fall sofort gesetzt.</li>
- <li><b>volumeStraight</b> -87...15 [direct] - Setzt die Lautstärke in Dezibel (-80.5 bis 15.5 dB) so wie sie am Receiver auch verwendet wird. Wenn als zweites Argument "direct" gesetzt ist, wird keine weiche Lautstärkenanpassung durchgeführt (sofern aktiviert). Die Lautstärke wird in diesem Fall sofort gesetzt.</li>
- <li><b>volumeUp</b> [0...100] [direct] - Erhöht die Lautstärke um 5% oder entsprechend dem Attribut volumeSteps (optional kann der Wert auch als Argument angehangen werden, dieser hat dann Vorang). Wenn als zweites Argument "direct" gesetzt ist, wird keine weiche Lautstärkenanpassung durchgeführt (sofern aktiviert). Die Lautstärke wird in diesem Fall sofort gesetzt.</li>
- <li><b>volumeDown</b> [0...100] [direct] - Veringert die Lautstärke um 5% oder entsprechend dem Attribut volumeSteps (optional kann der Wert auch als Argument angehangen werden, dieser hat dann Vorang). Wenn als zweites Argument "direct" gesetzt ist, wird keine weiche Lautstärkenanpassung durchgeführt (sofern aktiviert). Die Lautstärke wird in diesem Fall sofort gesetzt.</li>
- <li><b>mute</b> on,off,toggle - Schaltet den Receiver stumm</li>
- <li><b>bass</b> [-6...6] Schrittweite 0.5 (main zone), [-10...10] Schrittweite 2 (andere Zonen), [-10...10] Schrittweite 1 (andere Zonen, DSP Modelle) - Stellt die Tiefen in decibel ein</li>
- <li><b>treble</b> [-6...6] Schrittweite 0.5 (main zone), [-10...10] Schrittweite 2 (andere Zonen), [-10...10] Schrittweite 1 (andere Zonen, DSP Modelle) - Stellt die Höhen in decibel ein</li>
- <li><b>straight</b> on,off - Umgeht die interne Codec-Umwandlung und gibt den Original-Codec wieder.</li>
- <li><b>sleep</b> off,30min,60min,...,last - Aktiviert den internen Sleep-Timer zum automatischen Abschalten</li>
- <li><b>shuffle</b> on,off - Aktiviert die Zufallswiedergabe des aktuellen Eingangs (ist nur eingangsabhängig verfügbar)</li>
- <li><b>repeat</b> one,all,off - Wiederholt den aktuellen (one) oder alle (all) Titel des aktuellen Eingangs (ist nur eingangsabhängig verfügbar)</li>
- <li><b>pause</b> - Wiedergabe pausieren (ist nur eingangsabhängig verfügbar)</li>
- <li><b>play</b> - Wiedergabe starten (ist nur eingangsabhängig verfügbar)</li>
- <li><b>stop</b> - Wiedergabe stoppen (ist nur eingangsabhängig verfügbar)</li>
- <li><b>skip</b> reverse,forward - Aktuellen Titel überspringen (ist nur eingangsabhängig verfügbar)</li>
- <li><b>statusRequest</b> - Fragt den aktuell Status des Receivers ab</li>
- <li><b>remoteControl</b> up,down,... - Sendet Fernbedienungsbefehle wie im nächsten Abschnitt beschrieben</li>
- </ul>
- <br><br>
- </ul>
- <u>Fernbedienung (je nach Modell nicht in allen Zonen verfügbar)</u><br><br>
- <ul>
- <u>Cursor Steuerung:</u><br><br>
- <ul><code>
- remoteControl up<br>
- remoteControl down<br>
- remoteControl left<br>
- remoteControl right<br>
- remoteControl enter<br>
- remoteControl return<br>
- </code></ul><br><br>
- <u>Menü Auswahl:</u><br><br>
- <ul><code>
- remoteControl setup<br>
- remoteControl option<br>
- remoteControl display<br>
- </code></ul><br><br>
-
- <u>Radio Steuerung:</u><br><br>
- <ul><code>
- remoteControl tunerPresetUp<br>
-
-
-
- remoteControl tunerPresetDown<br>
- </code></ul><br>
- </ul>
- <a name="YAMAHA_AVR_MenuNavigation"></a>
- <u>Automatische Menü Navigation (nur für Menü-basierte Eingänge wie z.B. Net Radio, Server, USB, ...)</u><br><br>
- <ul>
- Für Menü-basierte Eingänge muss man einen bestimmten Eintrag aus einer komplexen Struktur auswählen um die Wiedergabe zu starten.
- Ein typischer Fall ist das Abspielen von Internet-Radios (Eingang: Net Radio) oder ähnlichen, netzwerkbasierten Diensten.
- Erst durch das Navigieren durch mehrere Menüs und Untermenüs selektiert man das gewünschte Element und die Wiedergabe beginnt.
- <br><br>
- Um diese Navigation durch verschiedene Menüstrukturen zu automatisieren, gibt es das Set-Kommando "navigateListMenu".
- Als Parameter übergibt man den Pfad (ausgehend vom Beginn) zu dem gewünschtem Menüeintrag
- YAMAHA_AVR wird diese Liste von links nach rechts abarbeiten und sich so durch das Menü hangeln.
- Alle angegebenen Menüelemente sind dabei durch einen Schrägstrich (/) getrennt.
- <br><br>
- Ein paar Beispiele:
- Aktueller Eingang ist "netradio":<br><br>
- <ul>
- <code>
- set <name> navigateListMenu Länder/Ozeanien/Australien/Alle Sender/1Radio.FM<br>
- set <name> navigateListMenu Lesezeichen/Favoriten/1LIVE</code>
- </ul><br>
- Wenn man den Receiver mit einem Befehl anschalten möchte und einen bestimmten Internet-Radio Sender auswählen will:<br><br>
- <ul>
- <code>
- set <name> on ; set <name> volume 20 direct ; set <name> input netradio ; set <name> navigateListMenu Lesezeichen/Favoriten/1LIVE<br><br>
- # für tägliches einschalten eines Internet-Radios via <a href="#at">at-Modul</a><br>
- define 1Radio_am_Morgen at *08:00 set <name> on ; set <name> volume 20 direct ; set <name> input netradio ; set <name> navigateListMenu Länder/Ozeanien/Australien/Alle Sender/1Radio.FM<br><br>
- define 1LIVE_am_Abend at *17:00 set <name> on ; set <name> volume 20 direct ; set <name> input netradio ; set <name> navigateListMenu Lesezeichen/Favoriten/1LIVE</code>
- </ul>
- <br>
- Aktueller Eingang ist "server" (Netzwerk-Freigaben via UPnP/DLNA):<br><br>
- <ul>
- <code>
- set <name> navigateListMenu NAS/Musik/Nach Interpret/Alicia Keys/Songs in A Minor/Fallin
- </code>
- </ul>
- <br>
- Die exakte Menüstruktur hängt von ihrer eigenen Receiver-Konfiguration, sowie den zur Verfügung stehenden Freigaben in ihrem Netzwerk ab.
- Jeder einzelne Menüeintrag muss nicht vollständig als Pfadelement angegeben werden.
- Jedes Pfadelement wird als Stichwort verwendet um den richtigen Menüeintrag aus der aktuellen Listenebene zu finden, z.B:
- <br><br>
- <ul>
- Der tatsächliche Menüpfad (wie im Display des Receiveres erkennbar) sieht beispielhaft folgendermaßen aus: <code> <i><b>Lesezeichen</b></i> => <i><b>Favoriten</b></i> => <i><b>foo:BAR 70'er-90'er [[HITS]]</b></i></code><br><br>
- Der letzte Menüeintrag hat in diesem Fall viele Sonderzeichen die einem in einer FHEM-Konfiguration durchaus Probleme bereiten könen.
- Man muss aber nicht die vollständige Bezeichnung in der Pfadangabe benutzen, sondern kann ein kürzeres Stichwort benutzen, was in der vollständigen Bezeichnung jedoch vorkommen muss.
- So kann man beispielsweise folgendes Set-Kommando benutzen um diesen Eintrag auszuwählen und die Wiedergabe damit zu starten:<br><br>
- <code>
- set <name> navigateListMenu Lesezeichen/Favoriten/foo:BAR
- </code>
- <br><br>
- Dieser Befehl funktioniert, obwohl man nicht die vollständige Bezeichnung angegeben hat (<i><code>foo:BAR 70's-90's [[HITS]]</code></i>).
- </ul>
- <br>
- Auf selbe Weiße kann man somit lange Menüeinträge abkürzen, damit die Befehle nicht so lang werden.
- Solche gekürzten Pfadangaben müssen aber trotzdem soweit eindeutig sein, damit sie nur auf das gewünschte Element passen.
- Das erste Element aus einer Listenebene (von oben nach unten), was auf eine Pfadangabe passt, wird ausgewählt.
- <br><br>
- </ul>
- <a name="YAMAHA_AVR_get"></a>
- <b>Get-Kommandos</b>
- <ul>
- <code>get <Name> <Readingname></code>
- <br><br>
- Aktuell stehen via GET lediglich die Werte der Readings zur Verfügung. Eine genaue Auflistung aller möglichen Readings folgen unter "Generierte Readings/Events".
- </ul>
- <br><br>
- <a name="YAMAHA_AVR_attr"></a>
- <b>Attribute</b>
- <ul>
-
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="YAMAHA_AVR_request-timeout">request-timeout</a></li>
- Optionales Attribut. Maximale Dauer einer Anfrage in Sekunden zum Receiver.
- <br><br>
- Mögliche Werte: 1-5 Sekunden. Standardwert ist 4 Sekunden<br><br>
- <li><a name="YAMAHA_AVR_disable">disable</a></li>
- Optionales Attribut zur Deaktivierung des zyklischen Status-Updates. Ein manuelles Update via statusRequest-Befehl ist dennoch möglich.
- <br><br>
- Mögliche Werte: 0 => zyklische Status-Updates, 1 => keine zyklischen Status-Updates.<br><br>
- <li><a name="YAMAHA_AVR_volume-smooth-change">volume-smooth-change</a></li>
- Optionales Attribut, welches einen weichen Lautstärkeübergang aktiviert..
- <br><br>
- Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br><br>
- <li><a name="YAMAHA_AVR_volume-smooth-steps">volume-smooth-steps</a></li>
- Optionales Attribut, welches angibt, wieviele Schritte zur weichen Lautstärkeanpassung
- durchgeführt werden sollen. Standardwert ist 5 Anpassungschritte<br><br>
- <li><a name="YAMAHA_AVR_volumeSteps">volumeSteps</a></li>
- Optionales Attribut, welches den Standardwert zur Lautstärkenerhöhung (volumeUp) und Lautstärkenveringerung (volumeDown) konfiguriert. Standardwert ist 5%
- <br><br>
- <li><a name="YAMAHA_AVR_volumeMax">volumeMax</a></li>
- Optionales Attribut, welches eine maximale Obergrenze in Prozent für die Lautstärke festlegt.
- Wird versucht die Lautstärke auf einen höheren Wert zu setzen, so wird die Lautstärke dennoch die konfigurierte Obergrenze nicht überschreiten.
- <br><br>
- Mögliche Werte: 0-100%. Standardwert ist 100% (keine Begrenzung)
- <br><br>
- </ul>
- <b>Generierte Readings/Events:</b><br>
- <ul>
- <li><b>3dCinemaDsp</b> - Der Status des CINEMA DSP 3D-Modus ("auto" => an, "off" => aus)</li>
- <li><b>adaptiveDrc</b> - Der Status des Adaptive DRC ("auto" => an, "off" => aus)</li>
- <li><b>bass</b> Der aktuelle Basspegel, zwischen -6 and 6 dB (main zone) and -10 and 10 dB (andere Zonen)</li>
- <li><b>direct</b> - Zeigt an, ob soundverbessernde Features umgangen werden oder nicht ("on" => soundverbessernde Features werden umgangen, "off" => soundverbessernde Features werden benutzt)</li>
- <li><b>displayBrightness</b> - Status der Helligkeitsreduzierung des Front-Displays (-4 => maximale Reduzierung, 0 => keine Reduzierung)</li>
- <li><b>dsp</b> - Das aktuell aktive DSP Preset</li>
- <li><b>enhancer</b> - Der Status des Enhancers ("on" => an, "off" => aus)</li>
- <li><b>extraBass</b> - Der Status des Extra Bass ("auto" => an, "off" => aus)</li>
- <li><b>input</b> - Der ausgewählte Eingang entsprechend dem FHEM-Kommando</li>
- <li><b>inputName</b> - Die Eingangsbezeichnung, so wie sie am Receiver eingestellt wurde und auf dem Display erscheint</li>
- <li><b>hdmiOut1</b> - Der Status des HDMI Ausgang 1 ("on" => an, "off" => aus)</li>
- <li><b>hdmiOut2</b> - Der Status des HDMI Ausgang 2 ("on" => an, "off" => aus)</li>
- <li><b>mute</b> - Der aktuelle Stumm-Status ("on" => Stumm, "off" => Laut)</li>
- <li><b>newFirmware</b> - Zeigt an, ob eine neue Firmware zum installieren bereit liegt ("available" => neue Firmware verfügbar, "unavailable" => keine neue Firmware verfügbar; Event wird nur generiert für RX-Vx71, RX-Vx73, RX-Ax10 oder RX-Ax20)</li>
- <li><b>power</b> - Der aktuelle Betriebsstatus ("on" => an, "off" => aus)</li>
- <li><b>presence</b> - Die aktuelle Empfangsbereitschaft ("present" => empfangsbereit, "absent" => nicht empfangsbereit, z.B. Stromausfall)</li>
- <li><b>partyMode</b> - Der Status des Party Modus ( "enabled" => aktiviert, "disabled" => deaktiviert). In der Main Zone stellt dies den geräteweiten Zustand des Party Modus dar. In den einzelnen Zonen zeigt es an, ob die jeweilige Zone für den Party Modus verwendet wird.</li>
- <li><b>straight</b> - Zeigt an, ob die interne Codec Umwandlung umgangen wird oder nicht ("on" => Codec Umwandlung wird umgangen, "off" => Codec Umwandlung wird benutzt)</li>
- <li><b>sleep</b> - Zeigt den Status des internen Sleep-Timers an</li>
- <li><b>surroundDecoder</b> - Zeigt den aktuellen Surround Decoder an</li>
- <li><b>state</b> - Der aktuelle Schaltzustand (power-Reading) oder die Abwesenheit des Gerätes (mögliche Werte: "on", "off" oder "absent")</li>
- <li><b>tunerFrequency</b> - Die aktuelle Empfangsfrequenz für Radio-Empfang in kHz (AM-Band) oder MHz (FM-Band)</li>
- <li><b>tunerFrequencyBand</b> - Das aktuell genutzte Radio-Band ("AM" oder "FM")</li>
- <li><b>treble</b> Der aktuelle Höhenpegel, zwischen -6 and 6 dB (main zone) and -10 and 10 dB (andere Zonen)</li>
- <li><b>volume</b> - Der aktuelle Lautstärkepegel in Prozent (zwischen 0 und 100 %)</li>
- <li><b>volumeStraight</b> - Der aktuelle Lautstärkepegel in Dezibel (zwischen -80.0 und +15 dB)</li>
- <li><b>ypaoVolume</b> - Der Status der YPAO Lautstärke ("auto" => an, "off" => aus)</li>
- <br><u>Eingangsabhängige Readings/Events:</u><br><br>
- <li><b>currentChannel</b> - Nummer des Eingangskanals (nur bei SIRIUS)</li>
- <li><b>currentStation</b> - Name des Radiosenders (nur bei TUNER, HD RADIO, NET RADIO oder PANDORA)</li>
- <li><b>currentStationFrequency</b> - Die Sendefrequenz des aktuellen Radiosender (nur bei Tuner oder HD Radio)</li>
- <li><b>currentAlbum</b> - Album es aktuell gespielten Titel</li>
- <li><b>currentArtist</b> - Interpret des aktuell gespielten Titel</li>
- <li><b>currentTitle</b> - Name des aktuell gespielten Titel</li>
- <li><b>playStatus</b> - Wiedergabestatus des Eingangs</li>
- <li><b>shuffle</b> - Status der Zufallswiedergabe des aktuellen Eingangs</li>
- <li><b>repeat</b> - Status der Titelwiederholung des aktuellen Eingangs</li>
- </ul>
- <br>
- <b>Hinweise des Autors</b>
- <ul>
- Dieses Modul ist nur nutzbar, wenn die Option "Network Standby" am Receiver aktiviert ist. Ansonsten ist die Steuerung nur im eingeschalteten Zustand möglich.
- </ul>
- <br>
- </ul>
- <p><a name="YAMAHA_BD"></a>
- <h3>YAMAHA_BD</h3>
- <div class='langLinks'>[<a href='commandref.html#YAMAHA_BD'>EN</a> DE]</div>
- <ul>
- <a name="YAMAHA_BDdefine"></a>
- <b>Definition</b>
- <ul>
- <code>define <name> YAMAHA_BD <IP-Addresse> [<Status_Interval>]
- <br><br>
- define <name> YAMAHA_BD <IP-Addresse> [<Off_Interval>] [<On_Interval>]
- </code>
- <br><br>
- Dieses Modul steuert Blu-Ray Player des Herstellers Yamaha über die Netzwerkschnittstelle.
- Es bietet die Möglichkeit den Player an-/auszuschalten, die Schublade zu öffnen und schließen,
- die Wiedergabe beeinflussen, sämtliche Fernbedieungs-Befehle zu senden, sowie den aktuellen Status abzufragen.
- <br><br>
- Bei der Definition eines YAMAHA_BD-Moduls wird eine interne Routine in Gang gesetzt, welche regelmäßig
- (einstellbar durch den optionalen Parameter <code><Status_Interval></code>; falls nicht gesetzt ist der Standardwert 30 Sekunden)
- den Status des Players abfragt und entsprechende Notify-/FileLog-Definitionen triggert.
- <br><br>
- Sofern 2 Interval-Argumente übergeben werden, wird der erste Parameter <code><Off_Interval></code> genutzt
- sofern der Player ausgeschaltet oder nicht erreichbar ist. Der zweiter Parameter <code><On_Interval></code>
- wird verwendet, sofern der Player eingeschaltet ist.
- <br><br>
- Beispiel:<br><br>
- <ul><code>
- define BD_Player YAMAHA_BD 192.168.0.10
- <br><br>
- # Mit modifiziertem Status Interval (60 Sekunden)<br>
- define BD_Player YAMAHA_BD 192.168.0.10 60
- <br><br>
- # Mit gesetztem "Off"-Interval (60 Sekunden) und "On"-Interval (10 Sekunden)<br>
- define BD_Player YAMAHA_BD 192.168.0.10 60 10
- </code></ul><br><br>
- </ul>
- <a name="YAMAHA_BDset"></a>
- <b>Set-Kommandos </b>
- <ul>
- <code>set <Name> <Kommando> [<Parameter>]</code>
- <br><br>
- Aktuell werden folgende Kommandos unterstützt.
- <br><br>
- <ul>
- <li><b>on</b> - schaltet den Player ein</li>
- <li><b>off</b> - schaltet den Player aus </li>
- <li><b>tray</b> open,close - öffnet oder schließt die Schublade</li>
- <li><b>statusRequest</b> - fragt den aktuellen Status ab</li>
- <li><b>remoteControl</b> up,down,... - sendet Fernbedienungsbefehle wie im folgenden Kapitel beschrieben.</li>
- </ul><br>
- <u>Wiedergabespezifische Kommandos</u>
- <ul>
- <li><b>play</b> - startet die Wiedergabe des aktuellen Mediums</li>
- <li><b>pause</b> - pausiert die Wiedergabe</li>
- <li><b>stop</b> - stoppt die Wiedergabe</li>
- <li><b>skip</b> forward,reverse - überspringt das aktuelle Kapitel oder den aktuellen Titel</li>
- <li><b>fast</b> forward,reverse - schneller Vor- oder Rücklauf</li>
- <li><b>slow</b> forward,reverse - langsamer Vor- oder Rücklauf</li>
- <li><b>trickPlay</b> normal,repeatChapter,repeatTitle,... - aktiviert Trick-Play Funktionen (Wiederholung, Zufallswiedergabe, ...)</li>
- </ul>
- <br><br>
- </ul>
- <u>Fernbedienung</u><br><br>
- <ul>
- Es stehen folgende Befehle zur Verfügung:<br><br>
- <u>Zahlen Tasten (0-9):</u><br><br>
- <ul><code>
- remoteControl 0<br>
- remoteControl 1<br>
- remoteControl 2<br>
- ...<br>
- remoteControl 9<br>
- </code></ul><br><br>
- <u>Cursor Steuerung:</u><br><br>
- <ul><code>
- remoteControl up<br>
- remoteControl down<br>
- remoteControl left<br>
- remoteControl right<br>
- remoteControl enter<br>
- remoteControl return<br>
- </code></ul><br><br>
- <u>Menü Auswahl:</u><br><br>
- <ul><code>
- remoteControl OSDonScreen<br>
- remoteControl OSDstatus<br>
- remoteControl popupMenu<br>
- remoteControl topMenu<br>
- remoteControl setup<br>
- remoteControl home<br>
- remoteControl clear<br>
- </code></ul><br><br>
- <u>Farbtasten:</u><br><br>
- <ul><code>
- remoteControl red<br>
- remoteControl green<br>
- remoteControl yellow<br>
- remoteControl blue<br>
- </code></ul><br><br>
- <u>Wiedergabetasten:</u><br><br>
- <ul><code>
- remoteControl program<br>
- remoteControl search<br>
- remoteControl repeat<br>
- remoteControl repeat-AB<br>
- remoteControl subtitle<br>
- remoteControl audio<br>
- remoteControl angle<br>
- remoteControl pictureInPicture<br>
- remoteControl secondAudio<br>
- remoteControl secondVideo<br>
- </code></ul><br><br>
- Die Befehlsnamen entsprechen den Tasten auf der Fernbedienung.<br><br>
- </ul>
- <a name="YAMAHA_BDget"></a>
- <b>Get-Kommandos</b>
- <ul>
- <code>get <Name> <Readingname></code>
- <br><br>
- Aktuell stehen via GET lediglich die Werte der Readings zur Verfügung. Eine genaue Auflistung aller möglichen Readings folgen unter "Generierte Readings/Events".
- </ul>
- <br><br>
- <a name="YAMAHA_BDattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#do_not_notify">do_not_notify</a></li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
- <li><a name="disable">disable</a></li>
- Optionales Attribut zur Deaktivierung des zyklischen Status-Updates. Ein manuelles Update via statusRequest-Befehl ist dennoch möglich.
- <br><br>
- Mögliche Werte: 0 => zyklische Status-Updates, 1 => keine zyklischen Status-Updates.<br><br>
- <li><a name="request-timeout">request-timeout</a></li>
- Optionales Attribut. Maximale Dauer einer Anfrage in Sekunden zum Player.
- <br><br>
- Mögliche Werte: 1-5 Sekunden. Standartwert ist 4 Sekunden<br><br>
- </ul>
- <b>Generierte Readings/Events:</b><br>
- <ul>
- <li><b>input</b> - Die aktuelle Wiedergabequelle (z.B. "DISC", "USB", "Network", "YouTube", ...)</li>
- <li><b>discType</b> - Die Art der eingelegten Disc (z.B "No Disc" => keine Disc eingelegt, "CD", "DVD", "BD", ...)</li>
- <li><b>contentType</b> - Die Art des Inhaltes, der gerade abgespielt wird ("audio", "video", "photo" oder "no contents")</li>
- <li><b>error</b> - zeigt an, ob ein interner Fehler im Player vorliegt ("none" => kein Fehler, "fan error" => Lüfterdefekt, "usb overcurrent" => USB Spannungsschutz)</li>
- <li><b>power</b> - Der aktuelle Betriebsstatus ("on" => an, "off" => aus)</li>
- <li><b>presence</b> - Die aktuelle Empfangsbereitschaft ("present" => empfangsbereit, "absent" => nicht empfangsbereit, z.B. Stromausfall)</li>
- <li><b>trayStatus</b> - Der Status der Schublade("open" => geöffnet, "close" => geschlossen)</li>
- <li><b>trickPlay</b> - Der aktuell aktive Trick-Play Modus</li>
- <li><b>state</b> - Der aktuelle Schaltzustand (power-Reading) oder die Abwesenheit des Gerätes (mögliche Werte: "on", "off" oder "absent")</li>
- <br><br><u>Quellenabhängige Readings/Events:</u><br>
- <li><b>currentChapter</b> - Das aktuelle Kapitel eines DVD- oder Blu-Ray-Films</li>
- <li><b>currentTitle</b> - Die Titel-Nummer des aktuellen DVD- oder Blu-Ray-Films</li>
- <li><b>currentTrack</b> - Die aktuelle Track-Nummer der wiedergebenden Audio-CD</li>
- <li><b>currentMedia</b> - Der Name der aktuell wiedergebenden Datei (Nur bei der Wiedergabe über USB)</li>
- <li><b>playTimeCurrent</b> - Der aktuelle Timecode an dem sich die Wiedergabe momentan befindet.</li>
- <li><b>playTimeTotal</b> - Die komplette Spieldauer des aktuellen Films (Nur bei der Wiedergabe von DVD/BD's)</li>
- <li><b>playStatus</b> - Wiedergabestatus des aktuellen Mediums</li>
- <li><b>totalTracks</b> - Gesamtanzahl aller Titel einer Audio-CD</li>
- </ul>
- <br>
- <b>Hinweise des Autors</b>
- <ul>
- <li>Einige ältere Player-Modelle (z.B. BD-S671) können im Auslieferungszustand nicht via Netzwerk gesteuert werden. Um eine Steuerung via FHEM zu ermöglichen ist ein <u><b>Firmware-Update notwending</b></u>!</li>
- <li>Dieses Modul ist nur nutzbar, wenn die Option "Netzwerksteuerung" am Player aktiviert ist. Ansonsten ist die Steuerung nicht möglich.</li>
- </ul>
- <br>
- </ul>
- <p><a name="YAMAHA_NP"></a>
- <h3>YAMAHA_NP</h3>
- <div class='langLinks'>[<a href='commandref.html#YAMAHA_NP'>EN</a> DE]</div>
- <ul>
- <a name="YAMAHA_NPdefine"></a>
- <b>Define</b>
- <br><br>
- <ul>
- <code>
- define <name> YAMAHA_NP <ip–address> [<status_interval>]
- </code>
- <br><br>Alternatitv mit unterschiedlichen off/on Intervalldefinitionen (Default 30 Sek).<br><br>
- <code>
- define <name> YAMAHA_NP <ip–address> [<off_status_interval>] [<on_status_interval>]
- </code>
- <br><br>Dieses FHEM–Modul steuert einen Yamaha Network Player (z.B. MCR–N560, MCR–N560D, CRX–N560, CRX–N560D, CD–N500 or NP–S2000) im lokalen Netzwerk.
- <br>Geräte, die das Kommunikationsprotokoll der Yamaha Network Player App für i*S und Andr*id implementieren, sollten ebenfalls unterstützen werden können.
- <br><br>
- Beispiel:<br>
- <ul><br>
- <code>
- define NP_Player YAMAHA_NP 192.168.0.15<br>
- attr NP_player webCmd input:selectStream:volume<br><br>
- # Mit einem Statusintervall von 60 Sek.<br>
- define NP_Player YAMAHA_NP 192.168.0.15 <b>60</b><br>
- attr NP_player webCmd input:selectStream:volume<br><br>
- # Mit unterschiedlichen Statusintervallen für off/on, 60/10 Sekunden<br>
- define NP_Player YAMAHA_NP 192.168.0.15 <b>60 10</b><br>
- attr NP_player webCmd input:selectStream:volume
- </code>
- </ul>
- </ul>
- <br>
- <a name="YAMAHA_NPset"></a>
- <b>Set</b>
- <ul><br>
- <code>
- set <name> <command> [<parameter>]
- </code>
- <br>
- <br>
- <i>Bemerkung: Bei den Befehlen und Parametern ist die Groß–/Kleinschreibung zu bachten. Das Modul zeigt ausschließlich verfügbare Eingänge, die vom jeweiligen Gerät unterstützt werden. Darüber hinaus sind die Befehle kontextsensitiv, abhängig von dem jeweils gewählten Eingang bzw. Betriebsmodus.</i><br>
- <ul>
- <br>
- <u>Verfügbare Befehle:</u><br><br>
- <li><b>CDTray</b> – Öffnen und Schließen des CD–Fachs.</li>
- <li><b>clockUpdate</b> – Aktualisierung der Systemzeit des Network Players. Die Zeitinformation wird von dem FHEM Server bezogen, auf dem das Modul ausgeführt wird.</li>
- <li><b>dimmer</b> [1..3] – Einstellung der Anzeigehelligkeit</li>
- <li><b>directPlay</b> < input:Stream Level 1,Stream Level 2,... > – ermöglicht direktes Abspielen eines Audiostreams/einer Audiodatei z.B. CD:1, DAB:1, netradio:Bookmarks,SWR3 </li>
- <li><b>favoriteDefine</b> < name:input[,Stream Level 1,Stream Level 2,...] > – Speichert einen Favoriten e.g. CoolSong:CD,1 (vordefinierte Favoriten sind die verfügbaren Eingänge)</li>
- <li><b>favoriteDelete</b> < name > – Löscht einen Favoriten</li>
- <li><b>favoritePlay</b> < name > – Spielt einen Favoriten ab</li>
- <li><b>input</b> [<parameter>] – Auswahl des Eingangs des Network Players. (Nicht verfügbar beim ausgeschaltetem Gerät)</li>
- <li><b>mute</b> [on|off] – Aktiviert/Deaktiviert die Stummschaltung</li>
- <li><b>off</b> – Network Player ausschalten</li>
- <li><b>on</b> – Network Player einschalten</li>
- <li><b>player [<parameter>] </b> – Setzt Player relevante Befehle.</li>
- <ul>
- <li><b>play</b> – play</li>
- <li><b>stop</b> – stop</li>
- <li><b>pause</b> – pause</li>
- <li><b>next</b> – nächstes Audiostück</li>
- <li><b>prev</b> – vorheriges Audiostück</li>
- </ul>
- <li><b>playMode [<parameter>] </b> – Setzt Player relevante Befehle</li>
- <ul>
- <li><b>shuffleAll</b> – setzt shuffle</li>
- <li><b>shuffleOff</b> – setzt no Shuffle mode</li>
- <li><b>repeatOff</b> – repeat off</li>
- <li><b>repeatOne</b> – repeat one</li>
- <li><b>repeatAll</b> – repeat all</li>
- </ul>
- <li><b>selectStream</b> – Direkte kontextsensitive Streamauswahl. Verügbare Menüeinträge werden automatisch generiert. Bedingt durch das KOnzept des Yamaha–Protokolls kann dies etwas Zeit in Anspruch nehmen. (Defaultmässig auf 999 Listeneintäge limitiert. s.a. maxPlayerLineItems Attribut.)</li>
- <li><b>sleep</b> [off|30min|60min|90min|120min] – Aktiviert/Deaktiviert den internen Sleep–Timer</li>
- <li><b>standbyMode</b> [eco|normal] – Umschaltung des Standby Modus.</li>
- <li><b>statusRequest [<parameter>] </b> – Abfrage des aktuellen Status des Network Players.</li>
- <ul>
- <li><b>basicStatus</b> – Abfrage der Elementarparameter (z.B. Lautstärke, Eingang, etc.)</li>
- <li><b>playerStatus</b> – Abfrage des Player–Status.</li>
- <li><b>standbyMode</b> – Abfrage des standby Modus.</li>
- <li><b>systemConfig</b> – Abfrage der Systemkonfiguration.</li>
- <li><b>tunerStatus</b> – Abfrage des Tuner–Status (z.B. FM Frequenz, Preset–Nummer, DAB Information etc.)</li>
- <li><b>timerStatus</b> – Abfrage des internen Wake–up timers.</li>
- <li><b>networkInfo</b> – Abfrage von Netzwerk–relevanten Informationen (z.B: IP–Adresse, Gateway–Adresse, MAC–address etc.)</li>
- </ul>
- <li><b>timerSet</b> – konfiguriert den Timer nach den Vorgaben: timerHour, timerMinute, timerRepeat, timerVolume (s. entprechende Attribute). (ALLE Attribute müssen zuvor gesetzt sein. Dieser Befehl schaltet den Timer nicht ein → 'timer on'.)</li>
- <li><b>timer</b> [on|off] – Schaltet ein/aus den internen Wake–up Timer. <i>(Bemerkung: Der Timer wird basierend auf den im Gerät gespeicherten Parametern aktiviert. Um diese zu ändern, bitte den 'timerSet' Befehl benutzen.)</i></li>
- <li><b>tunerFMFrequency</b> [87.50 ... 108.00] – Setzt die FM Frequenz. Der Wert muss zwischen 87.50 ... 108.00 liegen und muss den Digitalpunkt beinhalten ('.') mit zwei Nachkommastellen.</li>
- <li><b>volume</b> [0...100] – Setzt den relativen Lautstärkepegel in %</li>
- <li><b>volumeStraight</b> [<VOL_MIN>...<VOL_MAX>] – Setzt die absolute Lautstärke wie vom Gerät benutzt und angezeigt. Die Parameter <VOL_MIN> and <VOL_MAX> werden automatisch ermittelt.</li>
- <li><b>volumeUp</b> [<VOL_MIN>...<VOL_MAX>] – Erhöht die Lautstärke um einen absoluten Schritt. Die Parameter <VOL_MIN> and <VOL_MAX> werden automatisch ermittelt.</li>
- <li><b>volumeDown</b> [<VOL_MIN>...<VOL_MAX>] – Reduziert die Lautstärke um einen absoluten Schritt. Die Parameter <VOL_MIN> and <VOL_MAX> werden automatisch ermittelt.</li>
- </ul>
- </ul>
- <br>
- <a name="YAMAHA_NPget"></a>
- <b>Get</b>
- <ul>
- <code>
- get <name> <reading>
- </code>
- <br><br>
- Der 'get' Befehl liest Readingwerte zurück. Die Readings sind kontextsensitiv und hängen von dem/der jeweils gewählten Eingang bzw. Aktion ab.<br><br>
- </ul>
- <a name="YAMAHA_NPattr"></a>
- <b>Attributes</b><br><br>
- <ul>
- <ul>
- <li><b>.DABList</b> – (internes) Attribut zum Speichern von DAB Presets</li>
- <li><b>.favoriteList</b> – (internes) Attribut zum Speichern von Favoriten</li>
- <li><b>autoUpdatePlayerReadings</b> – optionales Attribut zum automtischen aktualisieren der Player–Readings (Default 1)</li>
- <li><b>autoUpdatePlayerlistReadings</b> – optionales Attribut zum automatischen Scannen der Playerlist (Menü) (Default 1). (Aufgrund des Kommunikationskonzeptes bei der Übertragung der Playerlistinformation kann diese Funktion zu längeren Reaktionszeiten bei der Yamaha App führen, wenn gleichzeitig auf den Netzwerkplayer zugegriffen wird.)</li>
- <li><b>autoUpdateTunerReadings</b> – optionales Attribut zum automtischen aktualisieren der Tuner–Readings (Default 1)</li>
- <li><b>directPlaySleepNetradio</b> – optionales Attribut zum Definieren der Sleep-Zeit zwischen zwei netradio Anfragen zum vTuner Server, wenn der Befehl directPlay benutzt wird. Kann bei langsamen Interneverbindungen nützlich sein. (Default 5 Sek.).</li>
- <li><b>directPlaySleepServer</b> – optionales Attribut zum Definieren der Sleep-Zeit zwischen zwei Multimediaserver-Anfragen, wenn der Befehl directPlay benutzt wird. Kann bei langsamen Verbindungen nützlich sein. (Default 2 Sek.).</li>
- <li><b>disable</b> – optionales Attribut zum Deaktivieren des internen zyklischen Timers zum Aktualisieren des NP–Status. Manuelles Update ist nach wie vor möglich. Mögliche Werte: 0 → Zyklisches Update aktiv., 1 → Zyklisches Update inaktiv (Default 1).</li>
- <li><b>do_not_notify</b></li>
- <li><b>maxPlayerListItems</b> – optionales Attribut zum Limitieren der maximalen Anzahl von Menüeinträgen (Default 999).</li>
- <li><b>readingFnAttributes</b></li>
- <li><b>requestTimeout</b> – optionales Attribut zum setzen des HTTP response Timeouts (Default 4)</li>
- <li><b>searchAttempts</b> – optionales Attribut zur Definition von max. Anzahl der Suchversuche des angegebenen Direktoryinhalts bei der Benutzng des directPlay Befehls. Mögliche Werte: 15...100 (Default 15 Sek.).</li>
- <li><b>smoothVolumeChange</b> – optionales Attribut zur sanften Lautstärkeänderung (Erzeugt deutlich mehr Ethernetkommunikation während der Lautstärkeänderung). (Default 1)</li>
- <li><b>timerHour</b> [0...23] – Setzt die Stunde des internen Wake–up Timers</li>
- <li><b>timerMinute</b> [0...59] – Setzt die Minute des internen Wake–up Timers</li>
- <li><b>timerRepeat</b> [once|every] – Setzt den Wiederholungsmodus des internen Wake–up Timers</li>
- <br>
- </ul>
- </ul>
- <b>Readings</b><br>
- <ul>
- <ul>
- <br><u>Generelle Readings:</u><br><br>
- <li><b>deviceInfo</b> – Devicespezifische, konsolidierte Informationen wie z.B. uuid, IP–Adresse, usw.</li>
- <li><b>favoriteList</b> – Listet gespeicherte Favoriten auf</li>
- <li><b>reading [reading]</b> – Gibt Readingwerte zurück</li>
- <ul><br>
- <li>.volumeStraightMax – Devicespezifische maximale Lautstärke</li>
- <li>.volumeStraightMin – Devicespezifische minimale Lautstärke</li>
- <li>.volumeStraightStep – Devicespezifischer minimales Lautstärkenin–/dekrement</li>
- <li>audioSource – Konsolidierte Audiostreaminformation mit aktuell gewähltem Eingang, Playerstatus (wenn aktiv) und Mute Information. (off|reading status...|input [(play|stop|pause[, muted])]])</li>
- <li>directPlay – Status des directPlay Befehls</li>
- <li>input – Aktuell gewählter Eingang</li>
- <li>mute – Mute status</li>
- <li>power – Aktueller Devicestatus (on|off)</li>
- <li>presence – Geräteverfügbarkeit im Netzwerk (present|absent)</li>
- <li>selectStream – Status des selectStream Befehls</li>
- <li>sleep – Sleeptimer Wert (off|30 min|60 min|90 min|120 min)</li>
- <li>standbyMode – Standby Mode Status (normal|eco)</li>
- <li>state – Aktueller Gerätezusand (on|off)</li>
- <li>volume – Relative Lautstärke [0 ... 100]</li>
- <li>volumeStraight – Devicespezifische absolute Lautstärke [<VOL_MIN>...<VOL_MAX>]</li>
- </ul>
- <br><u>Playerspezifische Readings:</u><br><br>
- <li><b>playerPlaybackInfo</b> – Abfrage des aktuellen Player Status (play|stop|pause)</li>
- <li><b>playerAlbum</b> – Abfrage des Albumnamens (falls verfügbar) der aktuellen Wiedergabe</li>
- <li><b>playerAlbumArtURL</b> – Abfrage der Album URL (falls verfügbar) der aktuellen Wiedergabe</li>
- <li><b>playerAlbumArtID</b> – Abfrage der AlbumArtID (falls verfügbar) der aktuellen Wiedergabe</li>
- <li><b>playerAlbumArtFormat</b> – Abfrage des AlbumArt Formats (falls verfügbar) der aktuellen Wiedergabe</li>
- <li><b>playerArtist</b> – Abfrage des Künstler (Artist) (falls verfügbar) der aktuellen Wiedergabe</li>
- <li><b>playerDeviceType</b> – Abfrage des Device Typs (ipod|msc)</li>
- <li><b>playerIpodMode</b> – Abfrage des iP*d/iPh*ne Modus (normal|off)</li>
- <li><b>playerPlayTime</b> – Abfrage der aktuellen Spielzeit (HH:MM:SS)</li>
- <li><b>playerRepeat</b> – Abfrage des Wiederholungsmodus (one|all)</li>
- <li><b>playerShuffle</b> – Abfrage des Zufallswiedergabemodus (on|off)</li>
- <li><b>playerSong</b> – Abfrage des Tracknamens (falls verfügbar) der aktuellen Wiedergabe</li>
- <li><b>playerTotalTracks</b> – Abfrage der Gesamtzahl der zu wiedergebenden Tracks</li>
- <li><b>playerTrackNb</b> – Abfrage der Audiotracknummer</li>
- <br><u>Playerlistspezifische (Menü) Readings:</u><br><br>
- <li>listItem_XXX – Inhalt der Menüeinträge. Prefix 'c_' steht für Container (Directory), Prefix 'i_' für Item (Audiofile/Stream). Die Anzahl kann mit dem Attribut 'maxPlayerLineItems' limitiert werden (Default 999).</li>
- <li>lvlX_ – Zeigt den hierarchischen Directorylevel im Directory Tree an</li>
- <br><u>Tunerspezifische Readings:</u><br><br>
- <li>listItem_XXX – Gespeicherter Preset</li>
- <li>tunerBand – Tuner Band (DAB|FM)</li>
- <br>
- <li>DAB</li>
- <ul><li>tunerDABStation – (DAB|DAB+), Channel: (value), Ensemble: (name)</li></ul>
- <ul><li>tunerDABSignal – (Frequenz), (Signalqualitä), (Bitrate), (Mono|Stereo)</li></ul>
- <ul><li>tunerInfo1 – DAB program service</li></ul>
- <ul><li>tunerPreset – (Preset number DAB Frequenz Sender) oder '–' wenn aktueller Sender nicht als Preset gespeichert wurde</li></ul>
- <ul><li>tunerStation – DAB Sendername</li></ul>
- <br>
- <li>FM</li>
- <ul><li>tunerFrequency – FM Frequenz</li></ul>
- <ul><li>tunerInfo1 – FM Sendername</li></ul>
- <ul><li>tunerInfo2_A – Zusätzliche RDS Information A</li></ul>
- <ul><li>tunerInfo2_A – Zusätzliche RDS Information B</li></ul>
- <ul><li>tunerPreset – (Presetnummer FM Frequenz Sender) oder '–' wenn aktueller Sender nicht als Preset gespeichert wurde</li></ul>
- <br><u>Timerspezifische Readings:</u><br><br>
- <li>timer – Aktueller Timerstatus (on|off)</li>
- <li>timerRepeat – Timer repeat mode (once|every)</li>
- <li>timerStartTime – Timer Startzeit HH:MM</li>
- <li>timerVolume – Timerlautstärke [<VOL_MIN>...<VOL_MAX>]</li>
- </ul>
- </ul>
- </ul>
- <p><a name="ZWCUL"></a>
- <h3>ZWCUL</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ZWCUL'>ZWCUL</a><br/>
- </ul>
- <a name="ZWDongle"></a>
- <h3>ZWDongle</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ZWDongle'>ZWDongle</a><br/>
- </ul>
- <a name="ZWave"></a>
- <h3>ZWave</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ZWave'>ZWave</a><br/>
- </ul>
- <a name="alarmclock"></a>
- <h3>alarmclock</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#alarmclock'>alarmclock</a><br/>
- </ul>
- <a name="alexa"></a>
- <h3>alexa</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#alexa'>alexa</a><br/>
- </ul>
- <a name="allergy"></a>
- <h3>allergy</h3>
- <div class='langLinks'>[<a href='commandref.html#allergy'>EN</a> DE]</div>
- <ul>
- <br>Dieses Modul prognostiziert Allergie Daten für Deutschland.</br>
- Es erfordert dass das Perlmodul XML:: Simple installiert ist.
- <br/><br/>
- <b>Define</b>
- <ul>
- <code>define <name> allergy <Postleitzahl></code>
- <br>
- Beispiel: <code>define allergydata allergy 12345</code>
- <br><br>
- <li><code>Postleitzahl</code>
- <br>
- Deutsche Postleitzahl
- </li><br>
- </ul>
- <br>
- <b>Get</b>
- <ul>
- <li><code>data</code>
- <br>
- Manuelles Datenupdate
- </li><br>
- </ul>
- <br>
- <b>Readings</b>
- <ul>
- <li><code>city</code>
- <br>
- Name der Stadt, für die Prognosen gelesen werden.
- </li><br>
- <li><code>fc<i>n</i>_total</code>
- <br>
- Täglicher Höchstwerte für alle Allergene, die nicht aufgrund der Ignoreliste <i>(attr ignoreList)</i> ignoriert werden<br/>
- </li><br>
- <li><code>fc<i>n</i>_day_of_week</code>
- <br>
- Wochentag, kann durch <i>weekdaysFormat</i> lokalisiert werden.<br/>
- </li><br>
- <li><code>fc<i>n</i>_<i>allergen</i></code>
- <br>
- Tägliche Werte für alle Allergene, die nicht aufgrund der Ignoreliste <i>(attr ignoreList)</i> ignoriert werden.
- </li><br>
- </ul>
- <br>
- <b>Attribute</b>
- <ul>
- <li><code>ignoreList</code>
- <br>
- Kommagetrennte Liste von Allergen-Namen, die bei der Aktualisierung ignoriert werden sollen.
- <br>
- </li><br>
- <li><code>updateEmpty (Standard: 0|1)</code>
- <br>
- Aktualisierung von Allergenen.
- <code> <br>
- 0 = nur Allergene mit Belastung.
- <br>
- 1 = auch Allergene die keine Belastung haben.
- </code>
- </li><br>
- <li><code>updateIgnored (1)</code>
- <br>
- Aktualisierung von Allergenen, die sonst durch die ignoreList entfernt werden.
- </li><br>
- <li><code>levelsFormat (Standard: -,low,moderate,high,extreme)</code>
- <br>
- Lokalisierte Levels, durch Kommas getrennt.
- </li><br>
- <li><code>weekdaysFormat (Standard: Sun,Mon,Tue,Wed,Thu,Fri,Sat)</code>
- <br>
- Lokalisierte Wochentage, durch Kommas getrennt.
- </li><br>
- </ul>
- </ul>
- <p><a name="allowed"></a>
- <h3>allowed</h3>
- <div class='langLinks'>[<a href='commandref.html#allowed'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="alloweddefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> allowed <deviceList></code>
- <br><br>
- Authorisiert das Ausführen von Kommandos oder das Ändern von
- Geräten abhängig vom verwendeten Frontend.<br>
- Falls man mehrere allowed Instanzen definiert hat, die für dasselbe
- Frontend verantwortlich sind, dann müssen alle Authorisierungen
- genehmigt sein, um das Befehl ausführen zu können. Auf der
- anderen Seite reicht es, wenn einer der Authentifizierungen positiv
- entschieden wird. Die Prüfungen werden in alphabetischer Reihenfolge
- der Instanznamen ausgeführt. <br><br>
- <b>Achtung:</b> das Modul sollte wie hier beschrieben funktionieren,
- allerdings können wir keine Garantie geben, daß man sie nicht
- überlisten, und Schaden anrichten kann.<br><br>
- Beispiele:
- <ul><code>
- define allowedWEB allowed<br>
- attr allowedWEB validFor WEB,WEBphone,WEBtablet<br>
- attr allowedWEB basicAuth { "$user:$password" eq "admin:secret" }<br>
- attr allowedWEB allowedCommands set,get<br><br>
- define allowedTelnet allowed<br>
- attr allowedTelnet validFor telnetPort<br>
- attr allowedTelnet password secret<br>
- </code></ul>
- <br>
- </ul>
- <a name="allowedset"></a>
- <b>Set</b>
- <ul>
- <li>basicAuth <username> <password></li>
- <li>password <password></li>
- <li>globalpassword <password><br>
- diese Befehle setzen das entsprechende Attribut, indem sie aus den
- Parameter und ein Salt ein SHA256 Hashwert berechnen. Achtung: das perl
- Modul Device::SHA wird benötigt.
- </li>
- </ul><br>
- <a name="allowedget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="allowedattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#disable">disable</a>
- </li><br>
- <a name="allowedCommands"></a>
- <li>allowedCommands<br>
- Eine Komma getrennte Liste der erlaubten Befehle des passenden
- Frontends (siehe validFor). Bei einer leeren Liste (, dh. nur ein
- Komma) wird dieser Frontend "read-only".
- Falls es auf <code>get,set</code> gesetzt ist, dann sind in dieser
- Frontend keine Konfigurationsänderungen möglich, nur
- "normale" Bedienung der Schalter/etc.
- </li><br>
- <a name="allowedDevices"></a>
- <li>allowedDevices<br>
- Komma getrennte Liste von Gerätenamen, die mit dem passenden
- Frontend (siehe validFor) geändert werden können.
- </li><br>
- <a name="basicAuth"></a>
- <li>basicAuth, basicAuthMsg<br>
- Erzwingt eine Authentifizierung mit Benutzername/Passwort für die
- zugerdnete FHEMWEB Instanzen. Der Wert kann entweder das base64
- kodierte Benutzername:Passwort sein, ein SHA256 hash (was man am besten
- mit dem passenden set Befehl erzeugt), oder, falls er in {}
- eingeschlossen ist, ein Perl Ausdruck. Für Letzteres wird
- $user und $passwort gesetzt, und muss wahr zurückliefern, falls
- Benutzername und Passwort korrekt sind. Beispiele:
- <ul><code>
- attr allowed basicAuth ZmhlbXVzZXI6c2VjcmV0<br>
- attr allowed basicAuth SHA256:F87740B5:q8dHeiClaPLaWVsR/rqkzcBhw/JvvwVi4bEwKmJc/Is<br>
- attr allowed basicAuth {"$user:$password" eq "fhemuser:secret"}<br>
- </code></ul>
- basicAuthMsg wird (in manchen Browsern) in dem Passwort Dialog als
- Überschrift angezeigt.<br>
- </li><br>
- <a name="password"></a>
- <li>password<br>
- Betrifft nur telnet Instanzen (siehe validFor): Bezeichnet ein
- Passwort, welches als allererster String eingegeben werden muss,
- nachdem die Verbindung aufgebaut wurde. Für die Werte gelten die
- Regeln von basicAuth, mit der Ausnahme, dass nur Passwort und kein
- Benutzername spezifiziert wird.<br> Falls dieser Parameter gesetzt
- wird, sendet FHEM telnet IAC Requests, um ein Echo während der
- Passworteingabe zu unterdrücken. Ebenso werden alle
- zurückgegebenen Zeilen mit \r\n abgeschlossen.<br>
- Falls dieses Attribut gesetzt wird, muss als erstes Argument ein
- Passwort angegeben werden, wenn fhem.pl im Client-mode betrieben wird:
- <ul><code>
- perl fhem.pl localhost:7072 secret "set lamp on"
- </code></ul>
- </li><br>
- <a name="globalpassword"></a>
- <li>globalpassword<br>
- Betrifft nur telnet Instanzen (siehe validFor): Entspricht dem
- Attribut password; ein Passwort wird aber ausschließlich für
- nicht-lokale Verbindungen verlangt.
- </li><br>
- <a name="validFor"></a>
- <li>validFor<br>
- Komma separierte Liste von Frontend-Instanznamen. Aktuell werden nur
- Frontends unterstützt, die das FHEM TCP/IP Bibliothek verwenden,
- z.Bsp. telnet und FHEMWEB. Falls nicht gesetzt, ist die allowed Instanz
- nicht aktiv.
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="apptime"></a>
- <h3>apptime</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#apptime'>apptime</a><br/>
- </ul>
- <a name="archetype"></a>
- <h3>archetype</h3>
- <div class='langLinks'>[<a href='commandref.html#archetype'>EN</a> DE]</div>
- ( <a href="commandref.html#archetype">en</a> | de )
- <div>
- <ul>
- Mit einem archetype werden Attribute auf Erben (inheritors), andere
- Geräte, übertragen. Die Erben können, nach einem vorgegeben
- Muster im archetype und für Beziehungen (relations), eine bestimmte
- Gruppe von Geräten, definiert werden.<br>
- <br>
- Hinweise:
- <ul>
- <li>
- <code>$name</code><br>
- Name des Erben
- </li><br>
- <li>
- <code>$room</code><br>
- Raum der Beziehung
- </li><br>
- <li>
- <code>$relation</code><br>
- Name der Beziehung
- </li><br>
- <li>
- <code>$SELF</code><br>
- Name des archetype
- </li>
- </ul>
- <br>
- <a name="archetypecommand"></a>
- <b>Befehle</b>
- <ul>
- <code>clean [check]</code><br>
- Definiert für alle Beziehungen aller archetype die Erben, vererbt für
- alle archetype die unter dem Attribut attributes angegeben Attribute auf
- alle Erben.<br>
- Wird optinal der Parameter "check" angegeben werden alle ausstehenden
- Attribute und Erben angezeigt.
- </ul>
- <br>
- <a name="archetypedefine"></a>
- <b>Define</b>
- <ul>
- <code>
- define <name> archetype [<devspec>] [<devspec>] [...]
- </code><br>
- In den <devspec> werden alle Erben beschrieben die es für dieses
- archetype gibt. Es sollte darauf geachtet werden, dass jeder Erbe nur
- einem archetype zugeordnet ist.<br>
- Wird keine <devspec> angegeben wird diese mit "defined_by=$SELF"
- gesetzt. Diese devspec wird auch immer überprüft, selbst wenn
- sie nicht angegeben ist.<br>
- Siehe den Abschnitt über
- <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.<br>
- <br>
- <code>define <name> archetype derive attributes</code><br>
- Wird in der DEF "derive attributes" angegeben handelt es sich um ein
- besonderes archetype. Es leitet Attribute anhand eines Musters ab.<br>
- Das Muster wird mit den Attributen actual_.+ beschrieben.<br>
- Als Erben werden alle Geräte aufgelistet welche alle Pflicht-
- Attribute eines Musters besitzen.
- </ul>
- <br>
- <a name="archetypeset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>addToAttrList <attribute></code><br>
- Der Befehl ist nur bei einem archetype mit der DEF "derive attributes"
- möglich.<br>
- Fügt global einen Eintrag unter userattr hizu, sodass er für
- alle Geäräte zur Verfügung steht.<br>
- Dies kann sinnvoll sein um den alias nach einem Muster abzuleiten.
- </li>
- <br>
- <li>
- <code>define inheritors</code><br>
- Definiert für alle Beziehungen einen Erben nach dem Muster:<br>
- <ul>
- <code>
- define <metaNAME> <actualTYPE> [<metaDEF>]
- </code>
- </ul>
- Wenn ein Erbe definiert wird, wird er, mit den unter dem Attribut
- initialize angegebenen Befehlen, initialisiert und ihm wir das Attribut
- defined_by mit dem Wert $SELF zugewiesen.<br>
- Die Beziehungen, metaNAME, actualTYPE und metaDEF werden in Attributen
- beschrieben.
- </li>
- <br>
- <li>
- <code>derive attributes</code><br>
- Der Befehl ist nur bei einem archetype mit der DEF "derive attributes"
- möglich.<br>
- Leitet für alle Erben die unter dem Attribut attributes angegeben
- Attribute ab.
- </li>
- <br>
- <li>
- <code>inheritance</code><br>
- Vererbt die eigenen unter dem Attribut attributes angegeben Attribute
- auf alle Erben.
- </li>
- <br>
- <li>
- <code>initialize inheritors</code><br>
- Führt für alle Erben die unter dem Attribut initialize
- angegebenen Befehle aus.
- </li>
- <br>
- <li>
- <code>raw <Befehl></code><br>
- Führt für alle Erben den Befehl aus.
- </li>
- </ul>
- <br>
- <a name="archetypeget"></a>
- <b>Get</b>
- <ul>
- <li>
- <code>inheritors</code><br>
- Listet alle Erben auf.
- </li>
- <br>
- <li>
- <code>relations</code><br>
- Listet alle Beziehungen auf.
- </li>
- <br>
- <li>
- <code>pending attributes</code><br>
- Listet für jeden Erben die unter dem Attribut attributes angegeben
- Attribute auf, die nicht mit den Attributen des archetype
- übereinstimmen.
- </li>
- <br>
- <li>
- <code>pending inheritors</code><br>
- Listet alle Erben auf die aufgrund der Beziehungen noch definiert
- werden sollen.
- </li>
- </ul>
- <br>
- <a name="archetypeattr"></a>
- <b>Attribute</b>
- <ul>
- Hinweise:
- <ul>
- Alle Attribute die vererbt werden können, können vorab mit
- einem Modifikator versehen werden.
- <li>
- <code>attr archetype <attribute> undef:<...></code><br>
- Wird <code>undef:</code> vorangestellt wird das Attribut nur vererbt,
- sofern der Erbe dieses Attribut noch nicht besitzt.
- </li><br>
- <li>
- <code>
- attr archetype <attribute>
- least[(<Trennzeichen>)]:<...>
- </code><br>
- Wird eine Liste vererbt kann mit dem voranstellen von
- <code>least[(<Trennzeichen>)]:</code>
- angegeben werden, dass diese Elemente mindestens vorhanden sein
- sollen.<br>
- Wird kein Trennzeichen angegeben wird das Leerzeichen als
- Trennzeichen verwendet.
- </li>
- </ul>
- <br>
- <li>
- <code>actual_<attribute> <value></code><br>
- <value> kann als <Text> oder als {perl code} angegeben
- werden.<br>
- Wir das Attribut <attribute> vererbt, ersetz die Rückgabe
- des actual_<attribute> Wert des Attributes.<br>
- Bei dem archetype mit der DEF "derive attributes" können Muster
- definiert werden.<br>
- Beispiel:
- <code>
- actual_alias %captionRoom|room%: %description%[ %index%][%suffix%]
- </code><br>
- Alle in % eingeschlossenen Ausdrücke sind Attribute. Eine Reihenfolge
- lässt sich durch | erreichen. Ist ein Ausdruck in [] eingeschlossen ist
- er optional.<br>
- Die Ausdrücke captionRoom, description, index und suffix sind hierbei
- durch addToAttrList hinzugefügte Attribute.<br>
- </li>
- <br>
- <li>
- <code>actualTYPE <TYPE></code><br>
- Legt den TYPE des Erben fest. Der Standardwert ist dummy.
- </li>
- <br>
- <li>
- <code>attributes <attribute> [<attribute>] [...]</code><br>
- Leerzeichen-getrennte Liste der zu vererbenden Attribute.
- </li>
- <br>
- <li>
- <code>
- attributesExclude <attribute> [<attribute>] [...]
- </code><br>
- Leerzeichen-getrennte Liste von Attributen die nicht auf diesen Erben
- vererbt werden.
- </li>
- <br>
- <li>
- <code>autocreate 0</code><br>
- Durch das archetype werden Attribute auf neue devices nicht automatisch
- vererbt und Erben werden nicht automatisch für neue Beziehungen
- angelegt.<br>
- Der Standardwert ist 1.
- </li>
- <br>
- <li>
- <code>defined_by <...></code><br>
- Hilfsattribut um zu erkennen, durch welchen archetype der Erbe
- definiert wurde.
- </li>
- <br>
- <li>
- <code>delteAttributes 1</code><br>
- Wird ein Attribut im archetype gelöscht, wird es auch bei allen Erben
- gelöscht.<br>
- Der Standardwert ist 0.
- </li>
- <br>
- <li>
- <code>disable 1</code><br>
- Es werden keine Attribute mehr vererbt und keine Erben definiert.
- </li>
- <br>
- <li>
- <code>initialize <initialize></code><br>
- <initialize> kann als <Text> oder als {perl code} angegeben
- werden.<br>
- Der <Text> oder die Rückgabe vom {perl code} muss eine
- durch Semikolon (;) getrennte Liste von FHEM-Befehlen sein. Mit diesen
- werden die Erben initialisiert, wenn sie definiert werden.
- </li>
- <br>
- <li>
- <code>metaDEF <metaDEF></code><br>
- <metaDEF> kann als <Text> oder als {perl code} angegeben
- werden und beschreibt den Aufbau der DEF für die Erben.
- </li>
- <br>
- <li>
- <code>metaNAME <metaNAME></code><br>
- <metaNAME> kann als <Text> oder als {perl code} angegeben
- werden und beschreibt den Aufbau des Namen für die Erben.
- </li>
- <br>
- <li>
- <code><a href="#readingList">readingList</a></code>
- </li>
- <br>
- <li>
- <code>relations <devspec> [<devspec>] [...]</code><br>
- In den <relations> werden alle Beziehungen beschrieben die es für
- dieses archetype gibt.<br>
- Siehe den Abschnitt über
- <a href="#devspec">Geräte-Spezifikation</a>
- für Details der <devspec>.
- </li>
- <br>
- <li>
- <code><a href="#setList">setList</a></code>
- </li>
- <br>
- <li>
- <code>splitRooms 1</code><br>
- Gibt für jede Beziehung jeden Raum separat in $room zurück.
- </li>
- <br>
- </ul>
- <br>
- <a name="archetypeexamples"></a>
- <b>Beispiele</b>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Import_von_Code_Snippets">
- <u>
- Die folgenden beispiel Codes können per "Raw defnition"
- importiert werden.
- </u>
- </a>
- <br>
- <br>
- <li>
- <b>
- Es sollen alle Plots in die Gruppe "verlaufsdiagramm" verschoben
- werden:
- </b>
- <br>
- <pre>defmod SVG_archetype archetype TYPE=SVG
- attr SVG_archetype group verlaufsdiagramm
- attr SVG_archetype attributes group</pre>
- </li>
- <br>
- <li>
- <b>
- Zusätzlich soll für alle Plots ein weblink angelegt werden:
- </b>
- <br>
- <pre>defmod SVG_link_archetype archetype
- attr SVG_link_archetype relations TYPE=SVG
- attr SVG_link_archetype actualTYPE weblink
- attr SVG_link_archetype metaNAME $relation\_link
- attr SVG_link_archetype metaDEF link ?detail=$relation
- attr SVG_link_archetype initialize attr $name room $room;;
- attr SVG_link_archetype group verlaufsdiagramm
- attr SVG_link_archetype attributes group</pre>
- </li>
- </ul>
- </ul>
- </div>
- <p><a name="at"></a>
- <h3>at</h3>
- <div class='langLinks'>[<a href='commandref.html#at'>EN</a> DE]</div>
- <ul>
- Startet einen beliebigen FHEM Befehl zu einem späteren Zeitpunkt.<br>
- <br>
- <a name="atdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> at [<timespec>|<datespec>]
- <command></code><br>
- <br>
- <code><timespec></code> Format: [+][*{N}]<timedet><br>
- <ul>
- Das optionale <code>+</code> zeigt, dass die Angabe <i>relativ</i> ist
- (also zur jetzigen Zeit dazugezählt wird).<br>
- Das optionale <code>*</code> zeigt, dass die Ausführung
- <i>wiederholt</i> erfolgen soll.<br>
- Das optionale <code>{N}</code> nach dem * bedeutet, dass der Befehl genau
- <i>N-mal</i> wiederholt werden soll.<br>
- <timespec> ist entweder HH:MM, HH:MM:SS oder {perlfunc()}. perlfunc
- muss ein String in timedet Format zurueckliefern. Achtung: {perlfunc()}
- darf keine Leerzeichen enthalten.<br>
- <datespec> ist entweder ISO8601 (YYYY-MM-DDTHH:MM:SS) oder Anzahl
- der Sekunden seit 1970.
- </ul>
- <br>
- Beispiele:
- <PRE>
- # Absolute Beispiele:
- define a1 at 17:00:00 set lamp on # fhem Befehl
- define a2 at 17:00:00 { Log 1, "Teatime" } # Perl Befehl
- define a3 at 17:00:00 "/bin/echo "Teatime" > /dev/console" # shell Befehl
- define a4 at *17:00:00 set lamp on # Jeden Tag
- # Realtive Beispiele:
- define a5 at +00:00:10 set lamp on # Einschalten in 10 Sekunden
- define a6 at +00:00:02 set lamp on-for-timer 1 # Einmal blinken in 2 Sekunden
- define a7 at +*{3}00:00:02 set lamp on-for-timer 1 # Blinke 3 mal
- # Blinke 3 mal wenn piri einen Befehl sendet
- define n1 notify piri:on.* define a8 at +*{3}00:00:02 set lamp on-for-timer 1
- # Lampe von Sonnenuntergang bis 23:00 Uhr einschalten
- define a9 at +*{sunset_rel()} set lamp on
- define a10 at *23:00:00 set lamp off
- # Elegantere Version, ebenfalls von Sonnenuntergang bis 23:00 Uhr
- define a11 at +*{sunset_rel()} set lamp on-till 23:00
- # Nur am Wochenende ausführen
- define a12 at +*{sunset_rel()} { fhem("set lamp on-till 23:00") if($we) }
- # Schalte lamp1 und lamp2 ein von 7:00 bis 10 Minuten nach Sonnenaufgang
- define a13 at *07:00 set lamp1,lamp2 on-till {sunrise(+600)}
- # Schalte lamp jeden Tag 2 Minuten nach Sonnenaufgang aus
- define a14 at *{sunrise(+120)} set lamp on
- # Schalte lamp1 zum Sonnenuntergang ein, aber nicht vor 18:00 und nicht nach 21:00
- define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on
- </PRE>
- Hinweise:<br>
- <ul>
- <li>wenn kein <code>*</code> angegeben wird, wird der Befehl nur einmal
- ausgeführt und der entsprechende <code>at</code> Eintrag danach
- gelöscht. In diesem Fall wird der Befehl im Statefile gespeichert
- (da er nicht statisch ist) und steht nicht im Config-File (siehe auch <a
- href="#save">save</a>).</li>
- <li>wenn die aktuelle Zeit größer ist als die angegebene Zeit,
- dann wird der Befehl am folgenden Tag ausgeführt.</li>
- <li>Für noch komplexere Datums- und Zeitabläufe muss man den
- Aufruf entweder per cron starten oder Datum/Zeit mit perl weiter
- filtern. Siehe hierzu das letzte Beispiel und das <a href="#perl">Perl
- special</a>. </li>
- </ul>
- <br>
- </ul>
- <a name="atset"></a>
- <b>Set</b>
- <ul>
- <a name="modifyTimeSpec"></a>
- <li>modifyTimeSpec <timespec><br>
- Ändert die Ausführungszeit. Achtung: die N-malige
- Wiederholungseinstellung wird ignoriert. Gedacht zur einfacheren
- Modifikation im FHEMWEB Raumübersicht, dazu muss man
- modifyTimeSpec in <a href="webCmd">webCmd</a> spezifizieren.
- </li>
- <li>inactive<br>
- Deaktiviert das entsprechende Gerät. Beachte den leichten
- semantischen Unterschied zum disable Attribut: "set inactive"
- wird bei einem shutdown automatisch in fhem.state gespeichert, es ist
- kein save notwendig.<br>
- Der Einsatzzweck sind Skripte, um das at temporär zu
- deaktivieren.<br>
- Das gleichzeitige Verwenden des disable Attributes wird nicht empfohlen.
- </li>
- <li>active<br>
- Aktiviert das entsprechende Gerät, siehe inactive.
- </li>
- <li>execNow<br>
- Führt das mit dem at spezifizierte Befehl aus. Beeinflußt
- nicht die Ausführungszeiten relativer Spezifikationen.
- </li>
- </ul><br>
- <a name="atget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="atattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="alignTime"></a>
- <li>alignTime<br>
- Nur für relative Definitionen: Stellt den Zeitpunkt der
- Ausführung des Befehls so, dass er auch zur alignTime
- ausgeführt wird. Dieses Argument ist ein timespec. Siehe oben
- fü die Definition<br>
- Beispiel:<br>
- <ul>
- # Stelle sicher das es gongt wenn eine neue Stunde beginnt.<br>
- define at2 at +*01:00 set Chime on-for-timer 1<br>
- attr at2 alignTime 00:00<br>
- </ul>
- </li><br>
- <a name="computeAfterInit"></a>
- <li>computeAfterInit<br>
- Falls perlfunc() im timespec Readings or Statusinformationen
- benögt, dann wird sie eine falsche Zeit beim FHEM-Start
- zurueckliefern, da zu diesem Zeitpunkt die Readings noch nicht aktiv
- sind. Mit gesetztem computeAfterInit wird perlfunc nach Setzen aller
- Readings erneut ausgefuehrt. (Siehe Forum #56706)
- </li><br>
- <a name="disable"></a>
- <li>disable<br>
- Deaktiviert das entsprechende Gerät.<br>
- Hinweis: Wenn angewendet auf ein <a href="#at">at</a>, dann wird der
- Befehl nicht ausgeführt, jedoch die nächste
- Ausführungszeit berechnet.</li><br>
- <a name="disabledForIntervals"></a>
- <li>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...<br>
- Das Argument ist eine Leerzeichengetrennte Liste von Minuszeichen-
- getrennten HH:MM oder D@HH:MM Paaren. Falls die aktuelle Uhrzeit
- zwischen diesen Werten fällt, dann wird die Ausführung, wie
- beim disable, ausgesetzt. Statt HH:MM kann man auch HH oder HH:MM:SS
- angeben. D ist der Tag der Woche, mit 0 als Sonntag and 3 als
- Mittwoch. Um einen Intervall um Mitternacht zu spezifizieren, muss man
- zwei einzelne angeben, z.Bsp.:
- <ul>
- 23:00-24:00 00:00-01:00
- </ul>
- Falls Teile des Wertes in {} eingeschlossen sind, dann werden sie als
- ein Perl Ausdruck ausgewertet:
- <ul>
- {sunset_abs()}-24 {sunrise_abs()}-08
- </ul>
- </li><br>
- <a name="skip_next"></a>
- <li>skip_next<br>
- Wird bei at Befehlen verwendet um die nächste Ausführung zu
- überspringen</li><br>
- <li><a href="#perlSyntaxCheck">perlSyntaxCheck</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="autocreate"></a>
- <h3>autocreate</h3>
- <div class='langLinks'>[<a href='commandref.html#autocreate'>EN</a> DE]</div>
- <ul>
- Erzeugt für noch nicht definierte FHEM-Geräte automatisch die
- geignete Definition (define). Diese Definition wird aus einer Nachricht
- gewonnen, die von diesen neuen Geräten empfangen wurde. Hinweis:
- Geräte, die mit Polling arbeiten (wie z.B. der Zugriff auf EMEM/EMWZ
- über EM1010PC) werden NICHT automatisch erzeugt.
- <br><br>
- <a name="autocreatedefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> autocreate</code><br>
- <br>
- <ul>
- Durch die Definition dieser Instanz wird das globale Attribut <a
- href="#autoload_undefined_devices">autoload_undefined_devices</a>
- gesetzt, sodass die Module für unbekannte Geräte automatisch
- nachgeladen werden. Das autocreate-Modul interpretiert das
- UNDEFINED-event, welches von jedem Modul gestartet wird, erzeugt ein
- Gerät (device) und bei Bedarf ein FileLog sowie
- SVG-Einträge.<br>
- <b>Hinweis 1:</b> Geräte werden mit einem eindeutigen Namen erzeugt,
- der den Typ und eine individuelle ID für diesen Typ enthält.
- Wird ein Gerät umbenannt (<a href="#rename">rename</a>), wird
- gleichzeitig das automatisch erzeugte FileLog und die SVG Geräte
- unbenannt.<br>
- <b>Hinweis 2:</b> Durch das Setzen des <a
- href="#disable">disable</a>-Attributes kann die automatische Erzeugung
- ausgeschaltet werden. In diesem Fall ist ausschließlich die oben
- erläuterte Umbenennung aktiv. Der <a
- href="#createlog">createlog</a>-Befehl kann zum Hinzufügen von
- FileLog und SVG eines bereits definierten Gerätes benutzt werden.
- <br>
- <b>Hinweis 3:</b>Es macht keinen Sinn, die Instanz dieses Moduls mehrmals
- zu erzeugen.
- </ul>
- <br>
- Beispiel:<PRE>
- define autocreate autocreate
- attr autocreate autosave
- attr autocreate device_room %TYPE
- attr autocreate filelog test2/log/%NAME-%Y.log
- attr autocreate weblink
- attr autocreate weblink_room Plots
- </PRE>
- </ul>
- <a name="autocreateset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="autocreateget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="autocreateattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="autosave"></a>
- <li>autosave<br>
- Nach der Erzeugung eines neuen Gerätes wird automatisch die
- Konfigurationsdatei mit dem Befehl <a href="#save">save</a>
- gespeichert. Der Standardwert ist 1 (d.h. aktiviert), eine 0 schaltet
- die automatische Speicherung aus.<br>
- <b>Achtung:</b> Dieses Attribut ist unerwünscht, bitte stattdessen
- das global autosave Attribut verwenden.
- </li><br>
- <a name="device_room"></a>
- <li>device_room<br>
- "Schiebt" das neu erstellte Gerät in diesen Raum. Der Name kann
- die Wildcards %NAME und %TYPE enthalten, siehe oben stehendes
- Beispiel.</li><br>
- <a name="filelogattr"></a>
- <li>filelog<br>
- Erstellt ein Filelog welches zu einem Gerät gehört. Der
- Dateiname darf die Wildcards %NAME und %TYPE enthalten, siehe oben
- stehendes Beispiel. Das Filelog wird in den gleichen Raum "geschoben"
- wie das zugehörige Gerät.</li><br>
- <a name="weblinkattr"></a>
- <li>weblink<br>
- Erzeugt ein SVG, welches mit dem Gerät/Filelog verknüpft
- ist.</li><br>
- <a name="weblink_room"></a>
- <li>weblink_room<br>
- "Schiebt" das neu erstellte SVG in den bezeichneten Raum. Der Name kann
- die Wildcards %NAME und %TYPE enthalten, siehe oben stehendes
- Beispiel.</li><br>
- <li><a href="#disable">disable</a></li>
- <br>
- <a name="ignoreTypes"></a>
- <li>ignoreTypes<br>
- Dies ist ein Regexp, um bestimmte Geräte zu ignorieren, z.b. der
- Funk-Heizungsthermostat (FHT) des Nachbarn. In dem Ausdruck können
- mehr als ein Gerät über die normale Regexp-Syntax angegeben
- werden. Beispiel:<br>
- attr autocreate ignoreTypes (CUL_HOERMANN.*|FHT_1234|CUL_WS_7)<br>
- Das Wort "Types" ist etwas irreführend, da der Gerätename
- geprüft wird, und nicht der Typ.<br>
- <b>Achtung</b>: ab featurelevel 5.9 wird der Regexp automatisch mit
- ^ und $ ergänzt, muss also den kompletten Namen matchen (genau wie
- bei notify und FileLog).
- </li><br>
- <a name="autocreateThreshold"></a>
- <li>autocreateThreshold<br>
- Eine Liste of <type>:<count>:<interval> tripeln. Ein
- neues Device wird nur dann erzeugt wenn es mindestens <code>count</code>
- Events für den TYPE <code>type</code> in den letzten
- <code>interval</code> Sekunden gegeben hat.<br>
- Beispiel:<br>
- <code>attr autocreateThreshold LaCrosse:2:30,EMT7110:2:60</code>
- </li>
- </ul>
- <br>
- <a name="createlog"></a>
- <b>createlog</b>
- <ul>
- Dieser Befehl wird für ein manuelles Hinzufügen eines Logfile
- oder eines SVG zu einem vorhandenen Gerät verwendet.
- <br><br>
- Dieser Befehl ist Bestandteilteil des autocreate-Modules.
- </ul>
- <br>
- <a name="usb"></a>
- <b>usb</b>
- <ul>
- Verwendung:
- <ul><code>
- usb scan<br>
- usb create<br>
- </code></ul>
- Dieser Befehl durchsucht das /dev-Verzeichnis nach angeschlossenen
- USB-Geräten und versucht gleichzeitig sie zu identifizieren. Mit dem
- Argument scan wird eine Liste von ausführbaren FHEM-Befehlen
- zurückgegeben. Das Argument create gibt keine Liste o.ä.
- zurück, die Geräte werden stattdessen erzeugt.<br><br>
- Es ist zu beachten, dass ein CUL immer noch manuell in den
- HomeMatic-Modus umgeschaltet werden muss. <br><br>
- Unter Linux wird gleichzeitig mit dem lsusb-befehl überprüft,
- ob nichtgeflashte CULs angeschlossen sind. Ist dies der Fall, ruft Linux
- CULflash mit den geeigneten Parametern auf (oder zeigt den
- CULflash-Befehl an, falls scan aufgeführt wurde).
- Pro usb Befehl wird nur ein Gerät geflasht.<br><br>
- Dieser Befehl ist Bestandteilteil des autocreate-Modules.
- </ul>
- </ul> <!-- End of autocreate -->
- <br>
- <p><a name="average"></a>
- <h3>average</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#average'>average</a><br/>
- </ul>
- <a name="backup"></a>
- <h3>backup</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#backup'>backup</a><br/>
- </ul>
- <a name="cloneDummy"></a>
- <h3>cloneDummy</h3>
- <div class='langLinks'>[<a href='commandref.html#cloneDummy'>EN</a> DE]</div>
- <ul>Definiert einen Klon eines lokalen Devices oder von FHEM2FHEM im Logmodus uebergebenen Devices
- und uebernimmt dessen Readings. Sinnvoll um entfernte FHEM-Installationen lesend einzubinden,
- zum Testen oder Programmieren. Dabei werden die von FHEM2FHEM in Form von Events weitergereichten
- entfernten Device-Readings in eigene Readings übernommen. Identische Events, die innerhalb der
- durch das globale Attribut <a href="#dupTimeout">dupTimeout</a> vorgegebenen Zeit auftreten, werden
- zusammengefasst, um überflüssige Events zu verhindern. Dieses Attribut ist mit bedacht zu ändern,
- da sich seine Auswirkungen auch auf andere Bereiche von FHEM erstreckt.<br>
- Die Rangfolge für den STATE ist:
- <ul><li>wenn keine Vorgabe gemacht wurde, dann die Meldung von cloneDummy (initialized, active)</li>
- <li>wenn addStateEvent gesetzt ist, dann der "state" vom geklonten Device (dann kein "state" mehr
- vom cloneDummy)</li>
- <li>wenn das optionale reading im define gesetzt ist, dann der Wert davon (überstimmt die beiden
- vorherigen Zeilen)</li>
- <li>wenn stateFormat als attr gesetzt ist, toppt das alles</li>
- </ul>
- <br>
- <a name="cloneDummydefine"></a>
- <b>Define</b>
- <ul><code>define <name> cloneDummy <Quelldevice> [reading]</code><br>
- <br>
- Aktiviert den cloneDummy, der dann an das Device <Quelldevice> gebunden ist.
- Mit dem optionalen Parameter reading wird bestimmt, welches reading im STATE angezeigt wird,
- stateFormat ist auch weiterhin möglich.<br>
- <br>
- <ul>Beispiel:<br>
- <br>
- Der cloneDummy wird lesend an den Sensor OWX_26_09FF26010000 gebunden und zeigt im
- State temperature an.<br>
- <br>
- <ul><code>define Feuchte cloneDummy OWX_26_09FF26010000 temperature</code><br>
- </ul>
- </ul>
- </ul>
- <br>
- <a name="cloneDummyset"></a>
- <b>Set</b>
- <ul>N/A
- </ul>
- <br>
- <a name="cloneDummyget"></a>
- <b>Get</b>
- <ul>N/A
- </ul>
- <br>
- <a name="cloneDummyattr"></a>
- <b>Attributes</b>
- <ul>
- <li>addStateEvent<br>
- 0 ist Vorgabe im Modul, bei 1 wird der Originalstate des original Devices als STATE verwendet
- (geht z.Z. nicht in Verbindung mit FHEM2FHEM)</li>
- <br>
- <li>clonIgnore<br>
- Eine durch Kommata getrennte Liste der readings, die cloneDummy nicht in eigene readings
- umwandelt</li>
- <br>
- <li>deleteBeforeUpdate<br>
- Ist dieses Attribut auf 1 gesetzt, werden alle readings zuerst gelöscht, bevor neue Readings geschrieben werden.</li>
- <br> <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <b>Wichtig: Es müssen unterschiedliche Namen für <name> und <Quelldevice> verwendet
- werden!</b><br/>
- <br>
- </ul>
- <p><a name="cmdalias"></a>
- <h3>cmdalias</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#cmdalias'>cmdalias</a><br/>
- </ul>
- <a name="configDB"></a>
- <h3>configDB</h3>
- <div class='langLinks'>[<a href='commandref.html#configDB'>EN</a> DE]</div>
- <ul>
- configDB ist die Funktionsbibliothek für die Konfiguration aus einer SQL Datenbank.<br/>
- Die ausführliche Dokumentation findet sich in der <a href="#configdb">configdb Befehlsbeschreibung</a>.
- </ul>
- <p><a name="configdb"></a>
- <h3>configdb</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#configdb'>configdb</a><br/>
- </ul>
- <a name="copy"></a>
- <h3>copy</h3>
- <div class='langLinks'>[<a href='commandref.html#copy'>EN</a> DE]</div>
- <ul>
- <code>copy <orig name> <copy name> [<type dependent arguments>]</code><br>
- <br>
- Erzeugt eine Kopie des Device <orig name> mit dem namen <copy name>.<br>
- Wenn <type dependent arguments> angegeben sind ersetzen die die DEF von <orig name> beim anlegen von <copy name>.
- </ul>
- <p><a name="count"></a>
- <h3>count</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#count'>count</a><br/>
- </ul>
- <a name="dash_dhcp"></a>
- <h3>dash_dhcp</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#dash_dhcp'>dash_dhcp</a><br/>
- </ul>
- <a name="deletefile"></a>
- <h3>deletefile</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#deletefile'>deletefile</a><br/>
- </ul>
- <a name="dewpoint"></a>
- <h3>dewpoint</h3>
- <div class='langLinks'>[<a href='commandref.html#dewpoint'>EN</a> DE]</div>
- <ul>
- Berechnungen des Taupunkts. Es gibt drei Varianten, das Modul dewpoint zu verwenden: <br>
- <ul>
- <li><b>dewpoint</b>: Taupunkt<br>
- Erzeugt ein zusätzliches Ereignis "dewpoint" aus Temperatur- und Luftfeuchtewerten eines Fühlers.</li>
- <li><b>fan</b>: Lüfter<br>
- Erzeugt ein Ereignis, um einen Lüfter einzuschalten, wenn die Außenluft
- weniger Wasser als die Raumluft enthält.</li>
- <li><b>alarm</b>: Alarm<br>
- Erzeugt einen Schimmel-Alarm, wenn eine Referenz-Temperatur unter den Taupunkt fällt.</li>
- </ul>
- <br/>
- <a name="dewpointdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> dewpoint dewpoint <devicename-regex> [<temp_name>
- <hum_name> <new_name>]</code><br>
- <br/>
- Berechnet den Taupunkt des Geräts <devicename-regex> basierend auf Temperatur
- und Luftfeuchte und erzeugt daraus ein neues Reading namens dewpoint.<br/>
- Wenn <temp_name>, <hum_name> und <new_name> angegeben sind,
- werden die Temperatur aus dem Reading <temp_name>, die Luftfeuchte aus dem
- Reading <hum_name> gelesen und als berechneter Taupunkt ins Reading <new_name> geschrieben.<br>
- Wenn <temp_name> T lautet, wird die Temperatur aus state T: H: benutzt
- und <new_name> zu state hinzugefügt.
- <br/>
- Beispiele:
- <pre>
- # Berechnet den Taupunkt aufgrund von Temperatur und Luftfeuchte
- # in Ereignissen, die vom Gerät temp1 erzeugt wurden und erzeugt ein Reading dewpoint.
- define dew_temp1 dewpoint dewpoint temp1
- define dew_temp1 dewpoint dewpoint temp1 temperature humidity dewpoint
- # Berechnet den Taupunkt aufgrund von Temperatur und Luftfeuchte
- # in Ereignissen, die von allen Geräten erzeugt wurden die diese Werte ausgeben
- # und erzeugt ein Reading dewpoint.
- define dew_all dewpoint dewpoint .*
- define dew_all dewpoint dewpoint .* temperature humidity dewpoint
- # Berechnet den Taupunkt aufgrund von Temperatur und Luftfeuchte
- # in Ereignissen, die vom Gerät Aussen_1 erzeugt wurden und ergänzt
- # mit diesem Wert den Status STATE.
- define dew_state dewpoint dewpoint Aussen_1 T H D
- # Berechnet den Taupunkt aufgrund von Temperatur und Luftfeuchte
- # in Ereignissen, die von allen Geräten erzeugt wurden die diese Werte ausgeben
- # und ergänzt mit diesem Wert den Status STATE.
- # Beispiel STATE: "T: 10 H: 62.5" wird verändert nach
- # "T: 10 H: 62.5 D: 3.2"
- define dew_state dewpoint dewpoint .* T H D
- </pre>
- <br/>
- <br/>
- <code>define <name> dewpoint fan <devicename-regex> <devicename-outside> <min-temp> [<diff_temp>]</code><br>
- <br>
- <ul>
- <li>Erzeugt ein Ereignis, um einen Lüfter einzuschalten, wenn die Außenluft
- weniger Wasser als die Raumluft enthält.</li>
- <li>Erzeugt das Ereignis "fan: on" wenn (Taupunkt von <devicename-outside>) +
- <diff_temp> ist niedriger als der Taupunkt von <devicename> und die Temperatur
- von <devicename-outside> >= min-temp ist. Das Ereignis wird nur erzeugt wenn das
- Reading "fan" nicht schon "on" war. Das Ereignis wird für das Gerät <devicename> erzeugt.
- Der Parameter <diff-temp> ist optional.</li>
- <li>Andernfalls wird das Ereignis "fan: off" erzeugt, wenn das Reading von "fan" nicht bereits "off" war.</li>
- </ul>
- <br>
- Beispiel:
- <pre>
- # Erzeugt das Ereignis "fan: on", wenn der Taupunkt des Geräts Aussen_1 zum ersten Mal
- # niedriger ist als der Taupunkt des Geräts basement_tempsensor und die
- # Außentemperatur >= 0 ist und wechselt nach "fan: off" wenn diese Bedingungen nicht
- # mehr zutreffen.
- # Schaltet den Schalter fan_switch abhängig vom Zustand ein oder aus.
- define dew_fan1 dewpoint fan basement_tempsensor Aussen_1 0
- define dew_fan1_on notify basement_tempsensor.*fan:.*on set fan_switch on
- define dew_fan1_off notify basement_tempsensor.*fan:.*off set fan_switch off
- </pre>
- <code>define <name> dewpoint alarm <devicename-regex> <devicename-reference> <diff-temp></code><br>
- <br>
- <ul>
- <li>Erzeugt einen Schimmel-Alarm, wenn eine Referenz-Temperatur unter den Taupunkt fällt.</li>
- <li>Erzeugt ein Reading/Ereignis "alarm: on" wenn die Temperatur von
- <devicename-reference> - <diff-temp> unter den Taupunkt von
- <devicename> fällt und das Reading "alarm" nicht bereits "on" ist.
- Das Ereignis wird für <devicename> erzeugt.</li>
- <li>Erzeugt ein Reading/Ereignis "alarm: off" wenn die Temperatur von
- <devicename-reference> - <diff-temp> über den Taupunkt
- von <devicename> steigt und das Reading "alarm" nicht bereits "off" ist.</li>
- </ul>
- <br>
- Beispiel:
- <pre>
- # Es wird ein Anlegefühler (Wandsensor) und ein Thermo-/Hygrometer (Raumfühler)
- # verwendet, um einen Alarm zu erzeugen, wenn die Wandtemperatur
- # unter den Taupunkt der Luft fällt. In diesem Fall würde sich Wasser an der Wand
- # niederschlagen (kondensieren), weil die Wand zu kalt ist.
- # Der Schalter einer Sirene (alarm_siren) wird über ein notify geschaltet.
- define dew_alarm1 dewpoint alarm roomsensor wallsensor 0
- define roomsensor_alarm_on notify roomsensor.*alarm:.*on set alarm_siren on
- define roomsensor_alarm_off notify roomsensor.*alarm:.*off set alarm_siren off
- # Ohne Wandsensor lässt sich auch der Taupunkt eines Raums mit der Temperatur desselben
- # (oder eines anderen) Fühlers vergleichen.
- # Die Alarmtemperatur ist 5 Grad niedriger gesetzt als die des Vergleichsthermostats.
- define dev_alarm2 dewpoint alarm roomsensor roomsensor 5
- </pre>
- </ul>
- <a name="dewpointset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="dewpointget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="dewpointattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#disable">disable</a></li>
- <li>absFeuchte</li><br>
- <ul>
- Durch setzen des Attributes absFeuchte wird in den Readings auch die absolute Feuchte mit ausgerechnet.
- Durch <a href="#stateFormat">stateFormat</a> kann man diese Info auch im Status anzeigen.
- Beispiel: (<Adapter> = Der FHEM Name des Adapters der geändert werden muss)
- <pre>
- stateFormat:
- {sprintf("T: %.1f H: %.1f D: %.1f A: %.1f", ReadingsVal("<Adapter>","temperature",0), ReadingsVal("<Adapter>","H",0), ReadingsVal("<Adapter>","dewpoint",0), ReadingsVal("<Adapter>","absFeuchte",0))}
- </pre>
- </ul>
- <li>max_timediff</li><br>
- <ul>
- Maximale erlaubter Zeitunterschied in Sekunden zwischen den Temperatur- und Luftfeuchtewerten eines
- Geräts. dewpoint verwendet Readings von Temperatur oder Luftfeuchte wenn sie nicht im Ereignis
- mitgeliefert werden. Das ist sowohl für den Betrieb mit event-on-change-reading nötig
- als auch bei Sensoren die Temperatur und Luftfeuchte in getrennten Ereignissen kommunizieren
- (z.B. Technoline Sensoren TX3TH).<br/>
- Der Standardwert ist 1 Sekunde.
- <br><br>
- Beispiel:
- <pre>
- # Maximal erlaubter Zeitunterschied soll 60 Sekunden sein
- define dew_all dewpoint dewpoint .*
- attr dew_all max_timediff 60
- </pre>
- </ul>
- </ul>
- </ul>
- <p><a name="dummy"></a>
- <h3>dummy</h3>
- <div class='langLinks'>[<a href='commandref.html#dummy'>EN</a> DE]</div>
- <ul>
- Definiert eine Pseudovariable, der mit <a href="#set">set</a> jeder beliebige
- Wert zugewiesen werden kann. Sinnvoll zum Programmieren.
- <br><br>
- <a name="dummydefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> dummy</code>
- <br><br>
- Beispiel:
- <ul>
- <code>define myvar dummy</code><br>
- <code>set myvar 7</code><br>
- </ul>
- </ul>
- <br>
- <a name="dummyset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> <value></code><br>
- Weist einen Wert zu.
- </ul>
- <br>
- <a name="dummyget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="dummyattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <li><a name="readingList">readingList</a><br>
- Leerzeichen getrennte Liste mit Readings, die mit "set" gesetzt werden
- können.</li>
- <li><a name="setList">setList</a><br>
- Liste mit Werten durch Leerzeichen getrennt. Diese Liste wird mit "set
- name ?" ausgegeben. Damit kann das FHEMWEB-Frontend Auswahl-Menüs
- oder Schalter erzeugen.<br> Beispiel: attr dummyName setList on off </li>
- <li><a name="useSetExtensions">useSetExtensions</a><br>
- Falls gesetzt, und setList enthält on und off, dann die <a
- href="#setExtensions">set extensions</a> Befehle sind auch aktiv. In
- diesem Fall werden nur die Befehle aus setList und die set exensions
- akzeptiert.</li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="eventTypes"></a>
- <h3>eventTypes</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#eventTypes'>eventTypes</a><br/>
- </ul>
- <a name="expandJSON"></a>
- <h3>expandJSON</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#expandJSON'>expandJSON</a><br/>
- </ul>
- <a name="fakeRoku"></a>
- <h3>fakeRoku</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#fakeRoku'>fakeRoku</a><br/>
- </ul>
- <a name="fhemdebug"></a>
- <h3>fhemdebug</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#fhemdebug'>fhemdebug</a><br/>
- </ul>
- <a name="fheminfo"></a>
- <h3>fheminfo</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#fheminfo'>fheminfo</a><br/>
- </ul>
- <a name="freezemon"></a>
- <h3>freezemon</h3>
- <div class='langLinks'>[<a href='commandref.html#freezemon'>EN</a> DE]</div>
- <div>
- <ul>
- FREEZEMON Überwacht - Ähnlich wie PERFMON mögliche Freezes, allerdings ist FREEZEMON ein echtes Modul und hat daher:<br>
- <ul>
- <li>Readings - die geloggt werden können und damit viel einfacher ausgewertet werden können</li>
- <li>Attribute - mit denen das Verhalten von freezemon beeinflusst werden kann</li>
- <li>zusätzliche Funktionalität - die versucht das den Freeze verursachende Device zu identifizieren</li>
- </ul>
- Ich würde empfehlen, PERFMON zu deaktivieren, wenn FREEZEMON aktiv ist, da beide auf die selbe Art Freezes erkennen und dann nur alles doppelt kommt.
- <b>Bitte beachten!</b> FREEZEMON versucht nur intelligent zu erraten, welches Device einen freeze verursacht haben könnte (basierend auf den Timern die laufen sollten). Es gibt eine Menge anderer Faktoren (intern oder extern) die einen Freeze verursachen können. FREEZEMON ersetzt keine detaillierte Analyse. Das Modul versucht nur Hinweise zu geben, was optimiert werden könnte.<br><br>
- <br>
- <br>
- <a name="freezemonDefine"></a>
- <b>Define</b>
- <ul>
- FREEZEMON wird ohne Parameter definiert.<br><br>
- <code>define <devicename> freezemon</code><br><br>
- damit ist der Freezemon aktiv (im Log sollte eine entsprechende Meldung geschrieben werden)
- <br><br>
- </ul>
- <a name="freezemonSet"></a>
- <b>Set</b>
- <ul>
- <ul>
- <li>inactive: deaktiviert das Device (identisch zum Attribut "disable", aber ohne die Notwendigkeit su "saven".</li>
- <li>active: reaktiviert das Device nachdem es auf inactive gesetzt wurde</li>
- <li>clear: Löscht alle readings (inklusive der Liste der letzten 20 Freezes).</li>
- </ul>
- </ul>
- <a name="freezemonGet"></a>
- <b>Get</b>
- <ul>
- <ul>
- <li>freeze: gibt die letzten 20 freezes zurück (in Kompakter Darstellung, wie im state) - Dies dient einem schnellen Überblick, für detailliertere Auswertungen empfehle ich die Daten zu loggen.</li>
- <li>log: gibt Zugriff auf die Logfiles die geschrieben werden, wenn fm_logFile aktiv ist</li>
- </ul>
- </ul>
-
- <a name="freezemonReadings"></a>
- <b>Readings</b>
- <ul>
- <ul>
- <li>freezeTime: Dauer des Freezes</li>
- <li>freezeDevice: Liste von möglicherweise den Freeze auslösenden Funktionen(Devices)</li>
- <li>fcDay: kumulierte Anzahl der Freezes pro Tag</li>
- <li>ftDay: kumulierte Dauer der Freezes pro Tag </li>
- <li>fcDayLast: speichert die kumulierte Anzahl der Freezes des vergangenen Tages (um tageweise plots zu erstellen)</li>
- <li>fcDayLast: speichert die kumulierte Dauer der Freezes des vergangenen Tages (um tageweise plots zu erstellen)</li>
- <li>state: s:<StartZeit> e:<EndeZeit> f:<Dauer> d:<Devices></li>
- </ul>
- </ul>
-
- <a name="freezemonAttributes"></a>
- <b>Attribute</b>
- <ul>
- <ul>
- <li>fm_extDetail: stellt in einigen Fällen zusätzliche Details bei erkannten Freezes zur Verfügung. In wenigen Fällen wurde berichtet, dass FHEM crasht, also vorsichtig verwenden.</li>
- <li>fm_freezeThreshold: Wert in Sekunden (Default: 1) - Nur Freezes länger als fm_freezeThreshold werden als Freeze betrachtet </li>
- <li>fm_forceApptime: Wenn FREEZEMON aktiv ist wird automatisch apptime gestartet (falls nicht aktiv)</li>
- <li>fm_ignoreDev: Liste von Komma-getrennten Devices. Wenn einzelne möglicherweise einen Freeze verursachenden Device in dieser Liste sind, wird der Freeze ignoriert (nicht geloggt). Bitte das Attribut fm_ignoreMode beachten</li>
- <li>fm_ignoreMode: Kann die Werte off,single oder all annehmen. Wenn in fm_ignoreDev Devices angegeben sind wirken sich der ignoreMode wie folgt aus: <br>
- all: Ein Freeze wird nur dann ignoriert, wenn alle möglicherweise den Freeze verursachenden Devices in der Ignore-Liste enthalten sind. Dies führt unter Umständen dazu, dass mehr Freezes geloggt werden als erwartet.<br>
- single: Ein Freeze wird ignoriert, sobald ein möglicher Verursacher in der Ignorierliste enthalten ist. Dies führt möglicherweise dazu, dass Freezes übersehen werden.<br>
- off: Alle Freezes werden geloggt.<br>
- Sofern das Attribut nicht gesetzt ist, aber Ignore-Devices angegeben sind, wird im Modus "all" ignoriert.</li>
- <li>fm_log: dynamischer Loglevel, nimmt einen String der Form 10:1 5:2 1:3 entgegen, was bedeutet: Freezes > 10 Sekunden werden mit Loglevel 1 geloggt, >5 Sekunden mit Loglevel 2 usw...</li>
- <li>fm_logFile: ist ein gültiger Filename (wie z.B. ./log/freeze-%Y%m%d-%H%M%S.log). Wenn gesetzt, werdn Meldungen auf Loglevel 5 (auch wenn global Loglevel < 5 ist) vor einem Freeze in einem seperaten File geloggt.</li>
- <li>fm_logExtraSeconds: definiert wieviele Sekunden vor dem Freeze geloggt werden (wenn fm logFile gesetzt ist)</li>
- <li>fm_logKeep: Eine Zahl, die angibt wieviele Logfiles behalten werden sollen. Wenn gesetzt, werden alle Logfiles ausser den letzten n Freezemon Logfiles regelmäßig gelöscht.</li>
- <li>fm_whitelistSub: Komma-getrennte Liste von Subroutinen wo du sicher bist, dass sie keinen Freeze verursachen. Whitelisted Subs erscheinen nicht in der "possibly caused by" Liste. Typischerweise listet man hier Subroutinen, die regelmäßig in der "possibly caused by" Liste auftauchen, wo du aber wirklich sicher bist, dass sie nicht die Ursache sind. Anmerkung: Die Subroutine ist der initiale Teil (vor dem devicename in Klammern) in Freezemon Logmeldungen.</li>
- <li>disable: aktivieren/deaktivieren der Freeze-Erkennung</li>
- </ul>
- </ul>
- </ul>
- </div>
- <p><a name="harmony"></a>
- <h3>harmony</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#harmony'>harmony</a><br/>
- </ul>
- <a name="help"></a>
- <h3>?, help</h3>
- <div class='langLinks'>[<a href='commandref.html#help'>EN</a> DE]</div>
- <ul>
- <code>? [<moduleName|deviceName>] [<language>]</code><br/>
- <code>help [<moduleName|deviceName>] [<language>]</code><br/>
- <br>
- <ul>
- <li>Liefert eine Liste aller Befehle mit einer Kurzbeschreibung zurück.</li>
- <li>Falls moduleName oder deviceName spezifiziert ist, wird die modul-spezifische Hilfe
- aus commandref zurückgeliefert.</li>
- <li>Die anzuzeigende Sprache wird in folgender Reihenfolge bestimmt:
- <ul>
- <li>gültiger Parameter <language> beim Aufruf übergeben</li>
- <li>globales Attribut language</li>
- <li>falls alles fehlt: englisch</li>
- </ul>
- </li>
- </ul>
- </ul>
- <p><a name="holiday"></a>
- <h3>holiday</h3>
- <div class='langLinks'>[<a href='commandref.html#holiday'>EN</a> DE]</div>
- <ul>
- <a name="holidaydefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> holiday</code>
- <br><br>
- Definiert einen Satz mit Urlaubsinformationen. Das Modul versucht die
- Datei <name>.holiday erst in <a href="#modpath">modpath</a>/FHEM zu
- öffnen, und dann in modpath/FHEM/holiday, Letzteres enthält eine
- Liste von per FHEM-update verteilten Dateien für diverse
- (Bundes-)Länder. Diese Liste wird bei einer Fehlermeldung angezeigt.
- Wenn Einträge im der Datei auf den aktuellen Tag passen wird der STATE
- der Holiday-Instanz die im <a href="#list">list</a> Befehl angezeigt wird
- auf die entsprechenden Werte gesetzt. Andernfalls ist der STATE auf den
- Text "none" gesetzt.
-
- Meistens wird dieser Wert mit einem Perl Script abgefragt: siehe Value() im
- <a href="#perl">perl</a> Abschnitt oder im globalen Attribut <a
- href="#holiday2we"> holiday2we</a>.<br> Die Datei wird jede Nacht neu
- eingelesen um den Wert des aktuellen Tages zu erzeugen. Auch jeder "get"
- Befehl liest die Datei neu ein.
- <br><br>
- Holiday file Definition:<br>
- Die Datei darf Kommentare, beginnend mit #, und Leerzeilen enthalten. Die
- entscheidenden Zeilen beginnen mit einer Zahl (Typ) und enthalten durch
- Leerzeichen getrennte Wörter, je nach Typ. Die verschiedenen Typen
- sind:<br>
- <ul>
- <li>1<br>
- Genaues Datum. Argument: <MM-TT> <Feiertag-Name><br>
- Beispiel: 1 12-24 Weihnachten
- </li>
- <li>2<br>
- Oster-abhängiges Datum. Argument: <Tag-Offset>
- <Feiertag-Name>.
- Der Offset wird vom Oster-Sonntag an gezählt.
- <br>
- Beispiel: 2 1 Oster-Montag<br>
- Hinweis: Das Osterdatum kann vorher geprüft werden:
- fhem> { join("-", western_easter(2011)) }
- </li>
- <li>3<br>
- Monats-abhängiges Datum. Argument: <X> <Wochentag>
- <Monat> <Feiertag-Name>.<br>
- Beispiel:<br>
- <ul>
- 3 1 Mon 05 Erster Montag In Mai<br>
- 3 2 Mon 05 Zweiter Montag In Mai<br>
- 3 -1 Mon 05 Letzter Montag In Mai<br>
- 3 0 Mon 05 Jeder Montag In Mai<br>
- </ul>
- </li>
- <li>4<br>
- Intervall. Argument: <MM-TT> <MM-TT> <Feiertag-Name>
- .<br>
- Achtung: Ein Intervall darf kein Jahresende enthalten.
- Beispiel:<br>
- <ul>
- 4 06-01 06-30 Sommerferien<br>
- 4 12-20 01-10 Winterferien # FUNKTIONIER NICHT,
- stattdessen folgendes verwenden:<br>
- 4 12-20 12-31 Winterferien<br>
- 4 01-01 01-10 Winterferien<br>
- </ul>
- </li>
- <li>5<br>
- Datum relativ, Wochentags ein fester Urlaubstag/Feiertag. Argument:
- <X> <Wochentag> <Monat> <Tag>
- <Feiertag-Name><br> Hinweis: Da +0 oder -0 als Offset nicht
- verboten sind, ist das Verhalten hier nicht definiert, kann sich also
- ohne Info ändern;<br>
- Beispiel:<br>
- <ul>
- 5 -1 Wed 11 23 Buss und Bettag (erster Mittwoch vor dem 23. Nov)<br>
- 5 1 Mon 01 31 Erster Montag in Februar<br>
- </ul>
- </li>
- </ul>
- </ul>
- <br>
- <a name="holidayset"></a>
- <b>Set</b>
- <ul>
- <li>createPrivateCopy<br>
- <ul>
- Falls die Datei in der FHEM/holiday Verzeichnis geöffnet wurde,
- dann ist sie nicht beschreibbar, da dieses Verzeichnis mit FHEM
- update aktualisiert wird. Mit createPrivateCopy kann eine private Kopie
- im FHEM Verzeichnis erstellt werden.
- </ul></li>
- <li>deletePrivateCopy<br>
- <ul>
- Entfernt die private Kopie, siehe auch createPrivateCopy
- </ul></li>
- <li>reload<br>
- <ul>
- setzt die state, tomorrow und yesterday Readings. Wird nach einem
- manuellen Bearbeiten der .holiday Datei benötigt.
- </ul></li>
- </ul><br>
- <a name="holidayget"></a>
- <b>Get</b>
- <ul>
- <code>get <name> <MM-DD></code><br>
- <code>get <name> yesterday</code><br>
- <code>get <name> today</code><br>
- <code>get <name> tomorrow</code><br>
- <code>get <name> days <offset></code><br>
- <br><br>
- Gibt den Name des Feiertages zum angebenenen Datum zurück oder den
- Text none.
- <br><br>
- </ul>
- <br>
- <a name="holidayattr"></a>
- <b>Attributes</b><ul>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul><br>
- </ul>
- <p><a name="km200"></a>
- <h3>KM200</h3>
- <div class='langLinks'>[<a href='commandref.html#km200'>EN</a> DE]</div>
- <ul>
- <table>
- <tr>
- <td>
- Das Buderus <a href="https://www.buderus.de/de/produkte/catalogue/alle-produkte/7719_Gateway-Logamatic-web-KM200-KM100-KM50">KM200, KM100 or KM50 (ab hier als KMxxx beschrieben)</a> ist eine Schnittstelle zwischen der Buderus Zentralheizungssteuerung un dem Internet.<BR>
- Es wurde entwickelt um den Bewohnern den Zugang zu Ihrem Heizungssystem durch die Buderus App <a href="http://www.buderus.de/Online_Anwendungen/Apps/fuer_den_Endverbraucher/EasyControl-4848514.html"> EasyControl zu erlauben.</a>.<BR>
- Darüber hinaus erlaubt es nach vorheriger Freigabe dem Heizungs- bzw. Wartungsbetrieb die Heizungsanlage von aussen zu warten und Werte zu verändern.<BR>
- Das km200 fhem-Modul erlaubt den Lese-/Schreibzugriff dieser Parameter durch fhem.<BR>
- <BR>
- Um das KMxxx Gerät mit fhem nutzen zu können, muß zunächst ein privates Passwort mit der Buderus Buderus App <a href="http://www.buderus.de/Online_Anwendungen/Apps/fuer_den_Endverbraucher/EasyControl-4848514.html"> EasyControl</a> - App gesetzt werden.<BR>
- <BR>
- <b><u>Anmerkung:</u></b><BR>
- Unabhängig der Installationsanleitung des Buderus KMxxx Geräts, sollten die Ports 5222 und 5223 am Router geschlossen bleiben um keinen Zugriff von außen auf das Gerät zu erlauben.<BR>
- Der Router sollte entsprechend Konfiguriert bzw. so belassen werden.<BR>
- Wenn der Lese-/Schreibzugriff von aussen gewünscht ist, so sollte man ausschließlich über das fhem-System auf die Zentralheizung zugreifen.<BR>
- <BR>
- Sobald das Modul in der fhem.cfg definiert ist, wird das Modul versuchen alle bekannten Services abzuklopfen ob diese in der angeschlossenen Konstellation überhaupt vorhanden sind.<BR>
- Nach diesem Initial-Kontakt unterscheidet das Modul zwisachen einem Satz an Services die sich ständig (dynamisch) ändern (z.B.: Vorlauftemperatur) sowie sich nicht ständig (statisch) ändernden Werten (z.B.: Firmware Version).<BR>
- Diese beiden Sätze an Services können mir einem individuellen Abfrageintervall versehen werden. Siehe <a href="#KM200Attr">Attributes</a><BR>
- <BR>
- </td>
- </tr>
- </table>
-
- <table>
- <tr><td><a name="KM200define"></a><b>Define</b></td></tr>
- </table>
- <table><tr><td><ul><code>define <name> km200 <IPv4-address> <GatewayPassword> <PrivatePassword></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><name></code> : </td><td>Der Name des Gerätes. Empfehlung: "myKm200".</td></tr>
- <tr><td><code><IPv4-address></code> : </td><td>Eine gültige IPv4 Adresse des KM200. Eventuell im Router nachschauen welche DHCP - Addresse dem KM200/KM50 vergeben wurde.</td></tr>
- <tr><td><code><GatewayPassword></code> : </td><td>Das gateway Passwort, welches auf dem Typenschild des KM200/KM50 zu finden ist.</td></tr>
- <tr><td><code><PrivatePassword></code> : </td><td>Das private Passwort, welches durch den User mit Hilfe der <a href="http://www.buderus.de/Online_Anwendungen/Apps/fuer_den_Endverbraucher/EasyControl-4848514.html"> EasyControl</a> - App vergeben wurde.</td></tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="KM200Set"></a><b>Set</b></td></tr>
- <tr><td>
- <ul>
- Die set Funktion ändert die Werte der Services welche das Flag "schreibbar" innerhalb der KMxxx Service Struktur besitzen.<BR>
- Die meisten dieser beschreibbaren Werte haben eine exklusive Liste von möglichen Werten innerhalb dessen sich der neue Wert bewegen muss.<BR>
- Andere Fließkomma Werte haben einen maximum und minumum Wert, in dessen sich der neue Wert bewegen muß.<BR>
- </ul>
- </td></tr>
- </table>
- <table><tr><td><ul><code>set <service> <value></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr><td><code><service></code> : </td><td>Der Name des Service welcher gesetzt werden soll. Z.B.: "<code>/heatingCircuits/hc1/operationMode</code>"<BR></td></tr>
- <tr><td><code><value></code> : </td><td>Ein gültiger Wert für diesen Service.<BR></td></tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="KM200Get"></a><b>Get</b></td></tr>
- <tr><td>
- <ul>
- Die get-Funktion ist in der Lage einen Wert eines Service innerhalb der KMxxx Service Struktur auszulesen.<BR>
- Die zusätzliche Liste von erlaubten Werten oder der Wertebereich zwischen Minimum und Maximum wird nicht zurück gegeben.<BR>
- </ul>
- </td></tr>
- </table>
- <table><tr><td><ul><code>get <service> <option></code></ul></td></tr></table>
- <ul><ul>
- <table>
- <tr>
- <td><code><service></code> : </td><td>Der Name des Service welcher ausgelesen werden soll. Z.B.: "<code>/heatingCircuits/hc1/operationMode</code>"<BR>
- Es gibt nur den Wert, aber nicht die Werteliste oder den möglichen Wertebereich zurück.<BR>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td><code><option></code> : </td><td>Das optionelle Argument für Ausgabe des get-Befehls Z.B.: "<code>json</code>"<BR>
- Folgende Optionen sind verfügbar:<BR>
- json - Gibt anstelle des Wertes, die gesamte Json Antwort des KMxxx als String zurück
- </td>
- </tr>
- </table>
- </ul></ul>
- <BR>
- <table>
- <tr><td><a name="KM200Attr"></a><b>Attributes</b></td></tr>
- <tr><td>
- <ul>
- Die folgenden Modul-spezifischen Attribute können neben den bekannten globalen Attributen gesetzt werden wie z.B.: <a href="#room">room</a>.<BR>
- </ul>
- </td></tr>
- </table>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>IntervalDynVal</code> : </li></td><td>Ein gültiges Abfrageintervall für die sich ständig verändernden - dynamischen Werte der KMxxx Services. Der Wert muss größer gleich >=20s sein um dem Modul genügend Zeit einzuräumen eine volle Abfrage auszuführen bevor die nächste Abfrage startet.<BR>
- Der Default-Wert ist 300s.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>PollingTimeout</code> : </li></td><td>Ein gültiger Zeitwert um dem KMxxx genügend Zeit zur Antwort einzelner Werte einzuräumen. Normalerweise braucht dieser Wert nicht verändert werden, muss jedoch im Falle eines langsamen Netzwerks erhöht werden<BR>
- Der Default-Wert ist 5s.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>DoNotPoll</code> : </li></td><td>Eine durch Leerzeichen (Blank) getrennte Liste von Services welche von der Abfrage aufgrund irrelevanter Werte oder fhem - Abstürzen ausgenommen werden sollen.<BR>
- Die Liste kann auch Hierarchien von services enthalten. Dies bedeutet, das alle Services unterhalb dieses Services ebenfalls gelöscht werden.<BR>
- Der Default Wert ist (empty) somit werden alle bekannten Services abgefragt.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>ReadBackDelay</code> : </li></td><td>Ein gültiger Zeitwert in Mllisekunden [ms] für die Pause zwischen schreiben und zurücklesen des Wertes durch den "set" - Befehl. Der Wert muss >=0ms sein.<BR>
- Der Default-Wert ist 100 = 100ms = 0,1s.<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- <ul><ul>
- <table>
- <tr>
- <td>
- <tr><td><li><code>disable</code> : </li></td><td>Deaktiviert das Device und löscht alle bestehenden Readings.<BR>
- Der Default-Wert ist 0 = aktiviert<BR>
- </td></tr>
- </td>
- </tr>
- </table>
- </ul></ul>
- </ul>
- <p><a name="logProxy"></a>
- <h3>logProxy</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#logProxy'>logProxy</a><br/>
- </ul>
- <a name="mailcheck"></a>
- <h3>mailcheck</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#mailcheck'>mailcheck</a><br/>
- </ul>
- <a name="monitoring"></a>
- <h3>monitoring</h3>
- <div class='langLinks'>[<a href='commandref.html#monitoring'>EN</a> DE]</div>
- ( <a href="commandref.html#monitoring"><u>en</u></a> | de )
- <div>
- <ul>
- Jedes monitoring verfügt über eine warning- und eine error-Liste,
- welche als Readings gespeichert werden.<br>
- Beim auftreten eines definierten add-events wird das Gerät nach einer
- vorgegeben Zeit auf die warning-Liste gesetzt.<br>
- Nach einer weiteren vorgegeben Zeit wird das Gerät von der
- warning-Liste gelöscht und auf die error-Liste gesetzt.<br>
- Beim auftreten eines definierten remove-events wird das Gerät von
- beiden Listen gelöscht und noch laufende Timer abgebrochen.<br>
- Hiermit lassen sich auf einfache Weise Sammelmeldungen erstellen und durch
- zwei Attribute formatiert ausgeben.<br>
- <br>
- Folgende Anwendungen sind möglich und werden
- <a href="#monitoringexamples"><u>unten</u></a> beschrieben:<br>
- <ul>
- <li>geöffnete Fenster</li>
- <li>Batterie Warnungen</li>
- <li>Activity Monitor</li>
- <li>
- regelmäßige Wartungsarbeiten
- (z.B. Tischwasserfilter wechseln oder Räume putzen)
- </li>
- <li>
- Betriebsstunden abhängige Wartungsarbeiten
- (z.B. Beamer Filter reinigen)
- </li>
- </ul>
- <br>
- Das monitor sendet selbst keine Benachrichtung, hierfür ist ein notify
- oder DOIF notwendig, welches auf das Event "<monitoring-name> error
- add: <name>" reagiert und dann den Rückgabewert von
- "get <monitoring-name> default" versendet.
- <br>
- <br>
- <a name="monitoringdefine"></a>
- <b>Define</b>
- <ul>
- <code>
- define <name> mointoring <add-event> [<remove-event>]
- </code>
- <br>
- Die Syntax für <add-event> und <remove-event> ist die
- gleiche wie für das Suchmuster von
- <a href="commandref_DE.html#notify"><u>notify</u></a> (Gerätename
- oder Gerätename:Event).<br>
- Ist nur ein <add-event> definiert wird beim auftreten das
- Gerät von beiden Listen gelöscht und die Timer für warning
- und error werden gestartet.<br>
- </ul>
- <br>
- <a name="monitoringset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>active</code><br>
- Es passieren zwei Dinge:<br>
- 1. Stellt noch ausstehende Timer wieder her, bzw. setzt die Geräte
- sofort auf die entsprechende Liste, falls der Zeitpunkt in der
- Vergangenheit liegt.<br>
- 2. Führt die unter dem Attribut "setActiveFunc" angegeben Befehle
- aus.
- </li>
- <li>
- <code>clear (warning|error|all)</code><br>
- Entfernt alle Geräte von der angegeben Liste und bricht für
- diese Liste laufende Timer ab. Bei "all" werden alle Geräte von
- beiden Listen entfernt und alle laufenden Timer abgebrochen.
- </li>
- <li>
- <code>errorAdd <name></code><br>
- Fügt <name> zu der error-Liste hinzu.
- </li>
- <li>
- <code>errorRemove <name></code><br>
- Entfernt <name> von der error-Liste.
- </li>
- <li>
- <code>inactive</code><br>
- Deaktiviert das monitoring. Beachte den leichten semantischen
- Unterschied zum disable Attribut: "set inactive" wird bei einem
- shutdown automatisch in fhem.state gespeichert, es ist kein save
- notwendig.
- </li>
- <li>
- <code>warningAdd <name></code><br>
- Fügt <name> zu der warning-Liste hinzu.
- </li>
- <li>
- <code>warningRemove <name></code><br>
- Entfernt <name> von der warning-Liste.
- </li>
- </ul>
- <br>
- <a name="monitoringget"></a>
- <b>Get</b>
- <ul>
- <li>
- <code>all</code><br>
- Gibt, durch eine Leerzeile getrennt, die error- und warning-Liste
- zurück.<br>
- Die Formatierung kann dabei mit den Attributen "errorReturn" und
- "warningReturn" eingestellt werden.
- </li>
- <li>
- <code>default</code><br>
- Der "default" Wert kann in dem Attribut "getDefault" festgelegt werden
- und ist dazu gedacht um die Konfiguration für den
- Rückgabewert im monitoring Gerät zu belassen. Wird nichts
- angegeben wird "all" verwendent.
- </li>
- <li>
- <code>error</code><br>
- Gibt die error-Liste zurück.<br>
- Die Formatierung kann dabei mit dem Attribut "errorReturn" eingestellt
- werden.
- </li>
- <li>
- <code>warning</code><br>
- Gibt die warning-Liste zurück.<br>
- Die Formatierung kann dabei mit dem Attribut "warningReturn"
- eingestellt werden.
- </li>
- </ul>
- <br>
- <a name="monitoringreadings"></a>
- <b>Readings</b><br>
- <ul>
- <li>
- <code>error</code><br>
- Durch Komma getrennte Liste von Geräten.
- </li>
- <li>
- <code>errorAdd_<name></code><br>
- Zeigt den Zeitpunkt an wann das Gerät auf die error-Liste gesetzt
- wird.
- </li>
- <li>
- <code>state</code><br>
- Zeigt den Status (active, inactive oder disabled) an. Bei "active" wird
- angezeigt welches Gerät zu welcher Liste hinzugefügt bzw. von welcher
- Liste entfernt wurde.
- </li>
- <li>
- <code>warning</code><br>
- Durch Komma getrennte Liste von Geräten.
- </li>
- <li>
- <code>warningAdd_<name></code><br>
- Zeigt den Zeitpunkt an wann das Gerät auf die warning-Liste
- gesetzt wird.
- </li>
- </ul>
- <br>
- <a name="monitoringattr"></a>
- <b>Attribute</b>
- <ul>
- <li>
- <a href="#addStateEvent">
- <u><code>addStateEvent</code></u>
- </a>
- </li>
- <li>
- <code>blacklist</code><br>
- Durch Leerzeichen getrennte Liste von devspecs die ignoriert werden.<br>
- Wenn das Attribut gesetzt wird werden alle Geräte die durch die
- devspecs definiert sind von beiden Listen gelöscht.
- </li>
- <li>
- <code>disable (1|0)</code><br>
- 1: Deaktiviert das monitoring.<br>
- 0: siehe "set active"
- </li>
- <li>
- <a href="#disabledForIntervals">
- <u><code>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ...</code></u>
- </a>
- </li>
- <li>
- <code>errorFuncAdd {<perl code>}</code><br>
- In dieser Funktion stehen die folgende Variablen zur Verfügung:
- <br>
- <ul>
- <li>
- <code>$name</code><br>
- Name des Event auslösenden Gerätes
- </li>
- <li>
- <code>$event</code><br>
- Beinhaltet das komplette Event, z.B.
- <code>measured-temp: 21.7 (Celsius)</code>
- </li>
- <li>
- <code>$addMatch</code><br>
- Hat den Wert 1, falls das add-event zutrifft
- </li>
- <li>
- <code>$removeMatch</code><br>
- Hat den Wert 1, falls das remove-event zutrifft
- </li>
- <li>
- <code>$SELF</code><br>
- Eigenname des monitoring
- </li>
- </ul>
- Gibt die Funktion eine 1 zurück, wird das Gerät, nach der
- Wartezeit, auf die error-Liste gesetzt.<br>
- Wenn das Attribut nicht gesetzt ist wird auf <code>$addMatch</code>
- geprüft.
- </li>
- <li>
- <code>errorFuncRemove {<perl code>}</code><br>
- In dieser Funktion stehen die selben Variablen wie bei "errorFuncAdd"
- zur Verfügung.<br>
- Gibt die Funktion eine 1 zurück, wird das Gerät von der
- error-Liste entfernt und noch laufende Timer werden abgebrochen.<br>
- Wenn das Attribut nicht gesetzt ist wird bei einer DEF mit
- <code><remove-event></code> auf <code>$removeMatch</code>
- geprüft und bei einer DEF ohne <code><remove-event></code>
- auf <code>errorFuncAdd</code>.
- </li>
- <li>
- <code>errorWait <perl code></code><br>
- Wartezeit bis das Gerät auf die error-Liste gesetzt wird.
- </li>
- <li>
- <code>errorReturn {<perl code>}</code><br>
- In diesem Attribut stehen folgende Variablen zur Verfügung:
- <ul>
- <li>
- <code>@errors</code><br>
- Array mit allen Geräten auf der error-Liste.
- </li>
- <li>
- <code>@warnings</code><br>
- Array mit allen Geräten auf der warning-Liste.
- </li>
- <li>
- <code>$SELF</code><br>
- Eigenname des monitoring
- </li>
- </ul>
- Mit diesem Attribut kann die Ausgabe die mit "get <name> error"
- erzeugt wird angepasst werden.
- </li>
- <li>
- <code>getDefault (all|error|warning)</code><br>
- Mit diesem Attribut kann festgelegt werden welche Liste/n mit "get
- <name> default" zurück gegeben wird/werden. Wenn das
- Attribut nicht gesetzt ist wird "all" verwendet.
- </li>
- <li>
- <code>setActiveFunc <Anweisung></code><br>
- Die Anweisung ist einer der FHEM
- <a href="#command"><u>Befehlstypen</u></a> und wird beim definieren des
- monitoring oder bei "set active" ausgeführt.<br>
- Für eine Batterie Meldung kann <code>"trigger battery=low
- battery:low"</code> sinnvoll sein.
- </li>
- <li>
- <code>warningFuncAdd {<perl code>}</code><br>
- Wie errorFuncAdd, nur für die warning-Liste.
- </li>
- <li>
- <code>warningFuncRemove {<perl code>}</code><br>
- Wie errorFuncRemove, nur für die warning-Liste.
- </li>
- <li>
- <code>warningWait <perl code></code><br>
- Wie errorWait, nur für die warning-Liste.
- </li>
- <li>
- <code>warningReturn {<perl code>}</code><br>
- Wie errorReturn, nur für die warning-Liste.
- </li>
- <li>
- <code>whitelist {<perl code>}</code><br>
- Durch Leerzeichen getrennte Liste von devspecs die erlaubt sind
- werden.<br>
- Wenn das Attribut gesetzt wird werden alle Geräte die nicht durch die
- devspecs definiert sind von beiden Listen gelöscht.
- </li>
- <li>
- <a href="#readingFnAttributes">
- <u><code>readingFnAttributes</code></u>
- </a>
- </li>
- </ul>
- <br>
- <a name="monitoringexamples"></a>
- <b>Beispiele</b>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Import_von_Code_Snippets">
- <u>
- Die folgenden beispiel Codes können per "Raw defnition"
- importiert werden.
- </u>
- </a>
- <br><br>
- <li>
- <b>
- Globale, flexible Fenster-/Tür-Offen-Meldungen
- <a href="https://forum.fhem.de/index.php/topic,36504">
- <u>(ähnlich wie im Forum beschrieben)</u>
- </a>
- </b>
- <br>
- <pre>defmod Fenster_monitoring monitoring .*:(open|tilted) .*:closed
- attr Fenster_monitoring errorReturn {return unless(@errors);;\
- $_ = AttrVal($_, "alias", $_) foreach(@errors);;\
- return("Das Fenster \"$errors[0]\" ist schon länger geöffnet.") if(int(@errors) == 1);;\
- @errors = sort {lc($a) cmp lc($b)} @errors;;\
- return(join("\n - ", "Die folgenden ".@errors." Fenster sind schon länger geöffnet:", @errors))\
- }
- attr Fenster_monitoring errorWait {AttrVal($name, "winOpenTimer", 60*10)}
- attr Fenster_monitoring warningReturn {return unless(@warnings);;\
- $_ = AttrVal($_, "alias", $_) foreach(@warnings);;\
- return("Das Fenster \"$warnings[0]\" ist seit kurzem geöffnet.") if(int(@warnings) == 1);;\
- @warnings = sort {lc($a) cmp lc($b)} @warnings;;\
- return(join("\n - ", "Die folgenden ".@warnings." Fenster sind seit kurzem geöffnet:", @warnings))\
- }</pre>
- Sobald ein Gerät ein "open" oder "tilded" Event auslöst wird
- das Gerät auf die warning-Liste gesetzt und es wird ein Timer
- gestartet nach dessen Ablauf das Gerät von der warning- auf die
- error-Liste verschoben wird. Die Wartezeit kann für jedes
- Gerät per userattr "winOpenTimer" festgelegt werden. Der
- Vorgabewert sind 10 Minuten.<br>
- Sobald ein Gerät ein "closed" Event auslöst wird das
- Gerät von beiden Listen gelöscht und noch laufende Timer
- werden gestoppt.
- </li>
- <br>
- <li>
- <b>Batterieüberwachung</b><br>
- <pre>defmod Batterie_monitoring monitoring .*:battery:.low .*:battery:.ok
- attr Batterie_monitoring errorReturn {return unless(@errors);;\
- $_ = AttrVal($_, "alias", $_) foreach(@errors);;\
- return("Bei dem Gerät \"$errors[0]\" muss die Batterie gewechselt werden.") if(int(@errors) == 1);;\
- @errors = sort {lc($a) cmp lc($b)} @errors;;\
- return(join("\n - ", "Die folgenden ".@errors." Geräten muss die Batterie gewechselt werden:", @errors))\
- }
- attr Batterie_monitoring errorWait 60*60*24*14
- attr Batterie_monitoring warningReturn {return unless(@warnings);;\
- $_ = AttrVal($_, "alias", $_) foreach(@warnings);;\
- return("Bei dem Gerät \"$warnings[0]\" muss die Batterie demnächst gewechselt werden.") if(int(@warnings) == 1);;\
- @warnings = sort {lc($a) cmp lc($b)} @warnings;;\
- return(join("\n - ", "Die folgenden ".@warnings." Geräten muss die Batterie demnächst gewechselt werden:", @warnings))\
- }</pre>
- Sobald ein Gerät ein "battery: low" Event auslöst wird das
- Gerät auf die warning-Liste gesetzt und es wird ein Timer
- gestartet nach dessen Ablauf das Gerät von der warning- auf die
- error-Liste verschoben wird. Die Wartezeit ist auf 14 Tage
- eingestellt.<br>
- Sobald ein Gerät ein "battery: ok" Event auslöst wird das
- Gerät von beiden Listen gelöscht und noch laufende Timer
- werden gestoppt.
- </li>
- <br>
- <li>
- <b>Activity Monitor</b><br>
- <pre>defmod Activity_monitoring monitoring .*:.*
- attr Activity_monitoring errorReturn {return unless(@errors);;\
- $_ = AttrVal($_, "alias", $_) foreach(@errors);;\
- return("Das Gerät \"$errors[0]\" hat sich seit mehr als 24 Stunden nicht mehr gemeldet.") if(int(@errors) == 1);;\
- @errors = sort {lc($a) cmp lc($b)} @errors;;\
- return(join("\n - ", "Die folgenden ".@errors." Geräten haben sich seit mehr als 24 Stunden nicht mehr gemeldet:", @errors))\
- }
- attr Activity_monitoring errorWait 60*60*24
- attr Activity_monitoring warningReturn {return unless(@warnings);;\
- $_ = AttrVal($_, "alias", $_) foreach(@warnings);;\
- return("Das Gerät \"$warnings[0]\" hat sich seit mehr als 12 Stunden nicht mehr gemeldet.") if(int(@warnings) == 1);;\
- @warnings = sort {lc($a) cmp lc($b)} @warnings;;\
- return(join("\n - ", "Die folgenden ".@warnings." Geräten haben sich seit mehr als 12 Stunden nicht mehr gemeldet:", @warnings))\
- }
- attr Activity_monitoring warningWait 60*60*12</pre>
- Geräte werden erst überwacht, wenn sie mindestens ein Event
- ausgelöst haben. Sollte das Gerät in 12 Stunden kein weiterer
- Event auslösen, wird es auf die warning-Liste gesetzt. Sollte das
- Gerät in 24 Stunden kein weiteres Event auslösen, wird es von
- der warning- auf die error-Liste verschoben.
- </li>
- <br>
- <li>
- <b>
- regelmäßige Wartungsarbeiten
- (z.B. Tischwasserfilter wechseln)
- </b>
- <br>
- <pre>defmod Wasserfilter_monitoring monitoring Wasserfilter_DashButton:.*:.short
- attr Wasserfilter_monitoring errorReturn {return unless(@errors);;\
- return "Der Wasserfilter muss gewechselt werden.";;\
- }
- attr Wasserfilter_monitoring errorWait 60*60*24*30
- attr Wasserfilter_monitoring warningReturn {return unless(@warnings);;\
- return "Der Wasserfilter muss demnächst gewechselt werden.";;\
- }
- attr Wasserfilter_monitoring warningWait 60*60*24*25</pre>
- Hierbei wird ein <a href="#dash_dhcp"><u>DashButton</u></a> genutzt um
- FHEM mitzuteilen, dass der Wasserfilter gewechselt wurde.<br>
- Nach 30 Tagen wird der DashButton auf die error-Liste gesetzt.
- </li>
- <br>
- <li>
- <b>
- regelmäßige Wartungsarbeiten
- (z.B. Räume putzen)
- </b>
- <br>
- <pre>defmod putzen_DashButton dash_dhcp
- attr putzen_DashButton allowed AC:63:BE:2E:19:AF,AC:63:BE:49:23:48,AC:63:BE:49:5E:FD,50:F5:DA:93:2B:EE,AC:63:BE:B2:07:78
- attr putzen_DashButton devAlias ac-63-be-2e-19-af:Badezimmer\
- ac-63-be-49-23-48:Küche\
- ac-63-be-49-5e-fd:Schlafzimmer\
- 50-f5-da-93-2b-ee:Arbeitszimmer\
- ac-63-be-b2-07-78:Wohnzimmer
- attr putzen_DashButton event-min-interval .*:5
- attr putzen_DashButton port 6767
- attr putzen_DashButton userReadings state {return (split(":", @{$hash->{CHANGED}}[0]))[0];;}
- attr putzen_DashButton widgetOverride allowed:textField-long devAlias:textField-long
- defmod putzen_monitoring monitoring putzen_DashButton:.*:.short
- attr putzen_monitoring errorFuncAdd {$event =~ m/^(.+):/;;\
- $name = $1;;\
- return 1;;\
- }
- attr putzen_monitoring errorReturn {return unless(@errors);;\
- return("Der Raum \"$errors[0]\" muss wieder geputzt werden.") if(int(@errors) == 1);;\
- return(join("\n - ", "Die folgenden Räume müssen wieder geputzt werden:", @errors))\
- }
- attr putzen_monitoring errorWait 60*60*24*7</pre>
- Hierbei werden mehrere <a href="#dash_dhcp"><u>DashButton</u></a>
- genutzt um FHEM mitzuteilen, dass die Räume geputzt wurden.<br>
- Nach 7 Tagen wird der Raum auf die error-Liste gesetzt.<br>
- Der Raum Name ist hierbei jedoch nicht der Geräte-Name, sondern der
- Readings-Name und wird in dem <code>errorFuncAdd</code>-Attribut
- geändert.
- </li>
- <br>
- <li>
- <b>
- Betriebsstunden abhängige Wartungsarbeiten
- (z.B. Beamer Filter reinigen)
- </b>
- <br>
- <pre>defmod BeamerFilter_monitoring monitoring Beamer_HourCounter:pulseTimeOverall BeamerFilter_DashButton:.*:.short
- attr BeamerFilter_monitoring userattr errorInterval
- attr BeamerFilter_monitoring errorFuncAdd {return 1\
- if(ReadingsVal($name, "pulseTimeOverall", 0) >= \
- ReadingsVal($name, "pulseTimeService", 0)\
- + (AttrVal($SELF, "errorInterval", 0))\
- && $addMatch\
- );;\
- return;;\
- }
- attr BeamerFilter_monitoring errorFuncRemove {return unless($removeMatch);;\
- fhem(\
- "setreading $name pulseTimeService "\
- .ReadingsVal($name, "pulseTimeOverall", 0)\
- );;\
- return 1;;\
- }
- attr BeamerFilter_monitoring errorInterval 60*60*200
- attr BeamerFilter_monitoring errorReturn {return unless(@errors);;\
- return "Der Filter vom Beamer muss gereinigt werden.";;\
- }
- attr BeamerFilter_monitoring warningFuncAdd {return}
- attr BeamerFilter_monitoring warningFuncRemove {return}</pre>
- Hierbei wird ein <a href="#HourCounter"><u>HourCounter</u></a> genutzt
- um die Betriebsstunden eine Beamer zu erfassen und ein
- <a href="#dash_dhcp"><u>DashButton</u></a> um FHEM mitzuteilen, dass der
- Filter gereinigt wurde.<br>
- Wurde der Filter länger als 200 Betriebsstunden nicht gereinigt
- wird das Gerät auf die error-Liste gesetzt.<br>
- Wurde die Reinigung mit dem DashButton quittiert wird das Gerät
- von der error-Liste entfernt und der aktuelle Betriebsstunden-Stand in
- dem HourCounter Gerät gespeichert.
- </li>
- </ul>
- </ul>
- </div>
- <p> <p>
- <a name="msgConfig" id="msgConfig"></a>
- </p>
- <h3>
- msgConfig
- </h3>
- <div class='langLinks'>[<a href='commandref.html#msgConfig'>EN</a> DE]</div>
- <ul>
- Stellt globale Einstellungen und Tools für das FHEM Kommando <a href="#MSG">msg</a> bereit.<br>
- Ein Device mit dem Namen globalMsg wird automatisch bei der ersten Benutzung des msg Kommandos angelegt, sofern kein msgConfig Device gefunden wurde.<br>
- Der Device Name kann anschließend beliebig umbenannt und umkonfiguriert werden.<br>
- <br>
- <a name="msgConfigdefine" id="msgConfigdefine"></a> <b>Define</b>
- <ul>
- <code>define <name> msgConfig</code><br>
- </ul><br>
- <br>
- <a name="msgConfigset" id="msgConfigset"></a> <b>Set</b>
- <ul>
- <ul>
- <li>
- <b>addLocation</b> <Name der Lokation> <br>
- Erstellt auf einfache Weise ein Dummy Device basierend auf dem übergebenen Lokationsnamen. Es wird for die lokations-basierte Verwendung mit dem msg-Kommando vorkonfiguriert. Das Dummy Device wird automatisch zum Attribut msgLocationDevs hinzugefügt. Anschließend ist eine weitere Konfiguration über die Attribute msgContact* oder msgRecipient* notwendig, die auf entsprechende Gateway Devices verweisen, die an dieser Lokation stehen.
- </li>
- </ul>
- </ul>
- </ul>
- <p><a name="msgDialog"></a>
- <h3>msgDialog</h3>
- <div class='langLinks'>[<a href='commandref.html#msgDialog'>EN</a> DE]</div>
- <ul>
- Mit msgDialog können Dialoge für Sofortnachrichten über
- TelegramBot, Jabber und yowsup (WhatsApp) definiert werden.<br>
- Die Kommunikation erfolgt über den msg Befehl. Daher muss ein Gerät
- vom Typ msgConfig zuerst definiert werden.<br>
- Für jeden Dialog kann festgelegt werden welche Person dazu berechtigt
- ist. Dazu sind Geräte vom Typ ROOMMATE oder GUEST mit definiertem
- msgContactPush Attribut erforderlich. Es ist darauf zu achten, dass das
- Reading fhemMsgRcvPush ein Event erzeugt.<br>
- <br>
- Vorraussetzungen:
- <ul>
- Das Perl-Modul "JSON" wird benötigt.<br>
- Unter Debian (basierten) System, kann dies mittels
- <code>"apt-get install libjson-perl"</code> installiert werden.
- </ul>
- <br>
- <a name="msgDialogdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> msgDialog <JSON></code><br>
- Aufgrunder komplexität ist es am einfachsten erst einen leeren Dialog
- zu definieren.
- <code>define <name> msgDialog {}</code>
- Anschließend die DEF dann in der Detail-Ansicht bearbeiten.
- <PRE>
- {
- "<TRIGGER>": {
- "match": "<regex>",
- "setOnly": (true|false),
- "commands": "(fhem command|{perl code})",
- "message": [
- "{perl code}",
- "text"
- ],
- "<NEXT TRIGGER 1>": {
- ...
- },
- "<NEXT TRIGGER 2>": {
- ...
- }
- }
- }
- </PRE>
- <li>
- <code>TRIGGER</code><br>
- Kann ein beliebiger Text sein. Es wird geprüft ob die eingehende
- Nachricht damit übereinstimmt. Falls ja, wird der Dialog an dieser
- Stelle fortgesetzt.
- </li>
- <br>
- <li>
- <code>match</code><br>
- Wenn nicht nur genau eine Nachricht zugelassen werden soll, kann noch
- eine regex angegeben werden. Die regex muss auf die gesamte eingehnde
- Nachricht zutreffen.
- </li>
- <br>
- <li>
- <code>setOnly</code><br>
- Kann optional auf true oder false gestellt werden. In beiden
- fällen wird der TRIGGER dann nicht bei "get <name> trigger"
- zurück gegeben.<br>
- Wenn setOnly auf true gestellt wird kann der Dialog an dieser Stelle
- nicht durch eingehnde Nachrichten ausgelöst werden, sondern nur
- über "get <name> say TRIGGER".<br>
- Dies kann dazu genutzt werden um einen Dialog von FHEM zu aus zu
- initieren.
- </li>
- <br>
- <li>
- <code>commands</code><br>
- Kann einen einzelnen oder mehrere Befehle enthalten:
- <PRE>
- "commands": "single command"
- "commands": [
- "command 1",
- "command 2",
- "{perl command}"
- ]
- </PRE>
- </li>
- <li>
- <code>message</code><br>
- Kann einen einzelnen oder mehrere Textte enthalten die mit einen
- Zeilenumbruch verbunden werden:
- <PRE>
- "message": "text"
- "message": [
- "text 1",
- "text 2",
- "{return from perl command}"
- ]
- </PRE>
- </li>
- Bei mehrstufigen Dialogen wird diese Struktur ineinander verschachtelt
- angegeben.<br>
- <br>
- Es werden Variablen und unter dem Attribut evalSpecials definierte
- Platzhalter ausgewertet.<br>
- Variablen:
- <li>
- <code>$SELF</code><br>
- Eigenname des msgDialog
- </li>
- <br>
- <li>
- <code>$message</code><br>
- eingegangene Nachricht
- </li>
- <br>
- <li>
- <code>$recipient</code><br>
- Name des Dialogpartners
- </li>
- </ul>
- <br>
- <a name="msgDialogset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>reset</code><br>
- Setzt den Dialog für alle Benutzer zurück.
- </li>
- <br>
- <li>
- <code>
- say [@<recipient1>[,<recipient2>,...]]
- <TRIGGER>[|<NEXT TRIGGER>|...]
- </code><br>
- Der Dialog wird für alle angegeben Empänger an der angegeben
- Stelle fortgeführt.<br>
- Sind keine Empfänger angegeben wird der Dialog für alle unter
- dem Attribut allowed angegebenen Empfänger fortgeführt.
- </li>
- <br>
- <li>
- <code>updateAllowed</code><br>
- Aktualisiert die Auswahl für das Attribut allowed.
- </li>
- </ul>
- <br>
- <a name="msgDialogget"></a>
- <b>Get</b>
- <ul>
- <li>
- <code>trigger</code><br>
- Listet alle TRIGGER der ersten Ebene auf bei denen nicht setOnly
- angegeben ist.
- </li>
- </ul>
- <br>
- <a name="msgDialogattr"></a>
- <b>Attribute</b>
- <ul>
- <li>
- <code>allowed</code><br>
- Liste mit allen RESIDENTS und ROOMMATE die für diesen Dialog
- berechtigt sind.
- </li>
- <br>
- <li>
- <code>disable 1</code><br>
- Dialog ist deaktiviert.
- </li>
- <br>
- <li>
- <a href="#disabledForIntervals">
- <u><code>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM ...</code></u>
- </a>
- </li>
- <br>
- <li>
- <code>evalSpecials key1=value1 key2=value2 ...</code><br>
- Leerzeichen getrennte Liste von Name=Wert Paaren.<br>
- Wert kann Leerzeichen enthalten, falls es in "" oder {} eingeschlossen
- ist.<br>
- Wert wird als
- perl-Ausdruck ausgewertet, falls es in {} eingeschlossen ist.<br>
- In der DEF werden %Name% Zeichenketten durch den zugehörigen Wert
- ersetzt.<br>
- Dieses Attribut ist als "msgDialog_evalSpecials" im msgConfig Gerät
- vorhanden.<br>
- Wenn der selbe Name im msgConfig und msgDialog definiert wurde, wird der
- Wert aus msgDialog verwendet.
- </li>
- <br>
- <li>
- <code>msgCommand <command></code><br>
- Befehl der zum Versenden einer Nachricht verwendet wird.<br>
- Die Vorgabe ist
- <code>"msg push \@$recipients $message"</code><br>
- Dieses Attribut ist als "msgDialog_msgCommand" im msgConfig Gerät
- vorhanden.
- </li>
- </ul>
- <br>
- <a name="msgDialogreadings"></a>
- <b>Reading</b>
- <ul>
- <li>
- <code>$recipient_history</code><br>
- Durch | getrennte Liste von TRIGGERN um den aktuellen Zustand des Dialogs
- zu sichern.<br>
- Für jeden Dialogpartner wird ein Readings angelegt. Wenn der Dialog
- beendet ist wird das Reading zurückgesetzt.
- </li>
- </ul>
- <br>
- <a name="msgDialogTelegramBot"></a>
- <b>Hinweise zur Benutzung mit Telegram:</b>
- <ul>
- Es kann notwendig sein, dass im TelegramBot das Attribut "utf8specials" auf
- 1 gesetzt wird, damit Nachrichten mit Umlauten gesendert werden.<br>
- <br>
- Bei dem msg Befehl kann der TelegramBot_MTYPE angegeben werden. Die Vorgabe
- ist message. Durch den Wert queryInline lässt sich ein inline Keyboard
- erzeugen.
- </ul>
- <br>
- <a name="msgDialogJabber"></a>
- <b>Hinweise zur Benutzung mit Jabber:</b>
- <ul>
- Bei dem msg Befehl kann der Jabber_MTYPE angegeben werden. Die Vorgabe ist
- leer. Durch den Wert otr lässt sich eine OTR Nachricht versenden.
- </ul>
- <br>
- <a name="msgDialogyowsub"></a>
- <b>Hinweise zur Benutzung mit yowsub (WhatsApp):</b>
- <ul>
- Bisher noch keine Erfahungen.
- </ul>
- <br>
- <a name="msgDialogexamples"></a>
- <b>Beispiele:</b>
- <ul>
- <a href="https://wiki.fhem.de/wiki/Import_von_Code_Snippets">
- <u>
- Die folgenden beispiel Codes können nur per "Raw defnition"
- importiert werden.
- </u>
- </a>
- <br>
- <br>
- Alle Beispiele sind für die Kommunikation über den TelegramBot
- ausgelegt. Bei der Verwendung von Jabber oder yowsup müssen diese
- gegebenenfalls angepasst werden.<br>
- Es wird davon ausgegangen, dass im msgConfig Gerät das evalSpecials
- "me" mit einem Namen gepflegt ist, über welchen der Bot angesprochen
- wird.<br>
- <br>
- <b>Meta Dialog zur auflistung aller Berechtigten Dialoge:</b>
- <ul>
- <PRE>
- defmod meta_Dialog msgDialog {\
- "%me%": {\
- "match": "\/?(start|%me%)",\
- "commands": "deletereading TYPE=msgDialog $recipient_history",\
- "message": [\
- "{return('(' . join(') (', sort(split('\n', fhem('get TYPE=msgDialog:FILTER=NAME!=$SELF:FILTER=allowed=.*($recipient|everyone).* trigger'))), 'abbrechen') . ') ')}",\
- "Ich kann folgendes für dich tun:"\
- ]\
- },\
- "zurück": {\
- "commands": "set $recipient_history=.+|.+ say @$recipient {(ReadingsVal($DEV, '$recipient_history', '') =~ m/(.+)\\|.+$/;; return $2 ? $2 : $1;;)}"\
- },\
- "abbrechen": {\
- "match": "\/?abbrechen",\
- "commands": "deletereading TYPE=msgDialog $recipient_history",\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Dialog abgebrochen."\
- ]\
- },\
- "beenden": {\
- "match": "\/?beenden",\
- "commands": "deletereading TYPE=msgDialog $recipient_history",\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Dialog beendet."\
- ]\
- }\
- }
- attr meta_Dialog allowed everyone
- </PRE>
- </ul>
- <b>Abfrage der aktuellen Krafstoffpreise</b>
- <ul>
- <PRE>
- defmod Tankstelle_Dialog msgDialog {\
- "Tankstelle": {\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Die Krafstoffpreise der betragen aktuell folgende Werte:",\
- "",\
- "AIVA",\
- "",\
- "[%AIVA%:Diesel] €/l Diesel",\
- "[%AIVA%:Super] €/l Super",\
- "[%AIVA%:E10] €/l E10",\
- "[%AIVA%:Autogas] €/l Autogas"\
- ]\
- }\
- }
- attr Tankstelle_Dialog evalSpecials AIVA=AIVA_petrolStation
- </PRE>
- </ul>
- <b>Programmierung der Waschmaschine</b>
- <ul>
- <PRE>
- defmod Waschmaschine_Dialog msgDialog { "Waschmaschine": {\
- "message": [\
- "{return('(Zeitprogramm stoppen) ') if(ReadingsVal('%controlUnit%', 'controlMode', '') eq 'auto')}",\
- "{return('(programmieren) ') if(ReadingsVal('%actor%', 'state', '') ne 'on')}",\
- "{return('(einschalten) ') if(ReadingsVal('%actor%', 'state', '') ne 'on')}",\
- "(Verlaufsdiagramm) ",\
- "(abbrechen) ",\
- "{return('Waschmaschine: ' . (ReadingsVal('%actor%', 'state', '') eq 'on' ? 'eingeschaltet' : 'ausgeschaltet'))}",\
- "{return('Modus: ' . (ReadingsVal('%controlUnit%', 'controlMode', '') eq 'auto' ? 'Automatik' : 'Manuell (' . ReadingsVal('%controlUnit%', 'time', '') . ')'))}"\
- ],\
- "Zeitprogramm stoppen": {\
- "commands": "set %controlUnit% controlMode manual",\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Das Zeitprogramm wurde gestoppt."\
- ]\
- },\
- "programmieren": {\
- "message": [\
- "(bestätigen|zurück|abbrechen) ",\
- "( 00:00 | 00:15 | 00:30 | 00:45 ) ",\
- "( 01:00 | 01:15 | 01:30 | 01:45 ) ",\
- "( 02:00 | 02:15 | 02:30 | 02:45 ) ",\
- "( 03:00 | 03:15 | 03:30 | 03:45 ) ",\
- "( 04:00 | 04:15 | 04:30 | 04:45 ) ",\
- "( 05:00 | 05:15 | 05:30 | 05:45 ) ",\
- "( 06:00 | 06:15 | 06:30 | 06:45 ) ",\
- "( 07:00 | 07:15 | 07:30 | 07:45 ) ",\
- "( 08:00 | 08:15 | 08:30 | 08:45 ) ",\
- "( 09:00 | 09:15 | 09:30 | 09:45 ) ",\
- "( 10:00 | 10:15 | 10:30 | 10:45 ) ",\
- "( 11:00 | 11:15 | 11:30 | 11:45 ) ",\
- "( 12:00 | 12:15 | 12:30 | 12:45 ) ",\
- "( 13:00 | 13:15 | 13:30 | 13:45 ) ",\
- "( 14:00 | 14:15 | 14:30 | 14:45 ) ",\
- "( 15:00 | 15:15 | 15:30 | 15:45 ) ",\
- "( 16:00 | 16:15 | 16:30 | 16:45 ) ",\
- "( 17:00 | 17:15 | 17:30 | 17:45 ) ",\
- "( 18:00 | 18:15 | 18:30 | 18:45 ) ",\
- "( 19:00 | 19:15 | 19:30 | 19:45 ) ",\
- "( 20:00 | 20:15 | 20:30 | 20:45 ) ",\
- "( 21:00 | 21:15 | 21:30 | 21:45 ) ",\
- "( 22:00 | 22:15 | 22:30 | 22:45 ) ",\
- "( 23:00 | 23:15 | 23:30 | 23:45 ) ",\
- "Wann soll die Wäsche fertig sein?",\
- "Bitte Uhrzeit in HH:MM angeben.",\
- "Aktuell ist [%controlUnit%:time] Uhr eingestellt."\
- ],\
- "Uhrzeit": {\
- "match": " ?([0-1][0-9]|2[0-3]):[0-5][0-9] ?",\
- "commands": [\
- "set %controlUnit% time $message",\
- "set $SELF say @$recipient Waschmaschine|programmieren|bestätigen"\
- ]\
- },\
- "bestätigen": {\
- "commands": "set %controlUnit% controlMode auto",\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Das Zeitprogramm wurde eingestellt.",\
- "Die Wäsche wird voraussichtlich um [%controlUnit%:time] Uhr fertig sein.",\
- "Bitte die Waschmaschine vorbereiten."\
- ]\
- }\
- },\
- "einschalten": {\
- "commands": [\
- "set %controlUnit% controlMode manual",\
- "set %actor% on"\
- ]\
- },\
- "Verlaufsdiagramm": {\
- "commands": "set %TelegramBot% cmdSend {plotAsPng('%plot%')}",\
- "message": "TelegramBot_MTYPE=queryInline (%me%) $message"\
- }\
- },\
- "auto": {\
- "setOnly": true,\
- "commands": [\
- "set %actor% on",\
- "set %controlUnit% controlMode manual"\
- ],\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Die Wachmaschine wurde automatisch eingeschaltet."\
- ]\
- },\
- "manual": {\
- "setOnly": true,\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Die Wachmaschine wurde manuell eingeschaltet."\
- ]\
- },\
- "done": {\
- "setOnly": true,\
- "commands": "set %actor% off",\
- "message": [\
- "TelegramBot_MTYPE=queryInline (%me%) ",\
- "Die Wachmaschine ist fertig."\
- ]\
- }\
- }
- attr Waschmaschine_Dialog evalSpecials actor=HM_2C10D8_Sw\
- controlUnit=Waschkeller_washer_controlUnit\
- plot=Waschkeller_washer_SVG
- </PRE>
- </ul>
- </ul>
- </ul>
- <p><a name="netatmo"></a>
- <h3>netatmo</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#netatmo'>netatmo</a><br/>
- </ul>
- <a name="notice"></a>
- <h3>notice</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#notice'>notice</a><br/>
- </ul>
- <a name="notify"></a>
- <h3>notify</h3>
- <div class='langLinks'>[<a href='commandref.html#notify'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="notifydefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> notify <Suchmuster> <Anweisung></code>
- <br><br>
- Führt eine oder mehrere Anweisungen aus, wenn ein Event generiert
- wurde, was dem <Suchmuster> (Gerätename oder
- Gerätename:Event) entspricht.
- Die Anweisung ist einer der FHEM <a href="#command">Befehlstypen</a>.
- Zum Test dient das <a href="#trigger">trigger</a>-Kommando.
- <br><br>
- Beispiele:
- <ul>
- <code>define b3lampV1 notify btn3 set lamp $EVENT</code><br>
- <code>define b3lampV2 notify btn3 { fhem "set lamp $EVENT" }</code><br>
- <code>define b3lampV3 notify btn3 "/usr/local/bin/setlamp
- "$EVENT""</code><br>
- <code>define b3lampV3 notify btn3 set lamp1 $EVENT;;set lamp2
- $EVENT</code><br>
- <code>define wzMessLg notify wz:measured.* "/usr/local/bin/logfht $NAME
- "$EVENT""</code><br>
- <code>define LogUndef notify global:UNDEFINED.* "send-me-mail.sh
- "$EVENT""</code><br>
- </ul>
- <br>
- Hinweise:
- <ul>
- <li><code><Suchmuster></code> ist entweder der Name des
- auslösenden ("triggernden") Gerätes oder die Kombination aus
- Gerät und auslösendem Ereignis (Event)
- <code>Gerätename:Event</code>.</li>
- <li>Das <code><Suchmuster></code> muss exakt (!)
- entweder dem Gerätenamen entsprechen oder der Zusammenfügung
- aus Gerätename:Event. Events lassen sich mit "inform" in Telnet
- oder durch Beobachtung des "Event-Monitors" in FHEMWEB ermitteln.</li>
- <li>In der Anweisung von Notify kann das auslösende Ereignis (Event)
- genutzt werden:
- <ul>
- <li>Die Anweisung $EVENT wird das komplette Ereignis (Event)
- beinhalten, z.B. <code>measured-temp: 21.7 (Celsius)</code></li>
- <li>$EVTPART0,$EVTPART1,$EVTPART2,etc enthalten die durch Leerzeichen
- getrennten Teile des Events der Reihe nach (im Beispiel also
- <code>$EVTPART0="measured-temp:", $EVTPART1="21.7",
- $EVTPART2="(Celsius)"</code>.<br> Diese Daten sind verfügbar
- als lokale Variablen in Perl, als Umgebungs-Variablen für
- Shell-Scripts, und werden als Text ausgetauscht in
- FHEM-Kommandos.</li>
- <li>$NAME und $TYPE enthalten den Namen bzw. Typ des Ereignis
- auslösenden Gerätes, z.B. myFht und FHT</li>
- </ul></li>
- <li>Achtung: Folgende Vorgehensweise ist abgekündigt, funktioniert
- bis featurelevel 5.6 und wird in einem zukünftigen Release von
- FHEM nicht mehr unterstützt. Wenn keine der oben genannten
- Variablen ($NAME/$EVENT/usw.) in der Anweisung gefunden wird, werden
- Platzhalter ersetzt.
- <ul>
- <li>Das Zeichen % wird ersetzt mit dem empfangenen
- Ereignis (Event), z.B. mit on oder off oder
- <code>measured-temp: 21.7 (Celsius)</code>.
- </li>
- <li>Das Zeichen @ wird ersetzt durch den
- Gerätenamen.</li>
- <li>Um % oder @ im Text selbst benutzen zu können, müssen
- sie verdoppelt werden (%% oder @@).</li>
- <li>Anstelle von % und @, können die
- Parameter %EVENT (funktionsgleich mit %),
- %NAME (funktionsgleich mit @) und
- %TYPE (enthält den Typ des Gerätes, z.B.
- FHT) benutzt werden. Die von Leerzeichen unterbrochenen
- Teile eines Ereignisses (Event) sind verfügbar als %EVTPART0,
- %EVTPART1, usw. Ein einzeln stehendes % verliert seine
- oben beschriebene Bedeutung, falls auch nur einer dieser Parameter
- in der Definition auftaucht.</li>
- </ul></li>
- <li>Folgende spezielle Ereignisse werden für das Gerät "global"
- erzeugt:
- <ul>
- <li>INITIALIZED sobald die Initialization vollständig ist.</li>
- <li>REREADCFG nachdem die Konfiguration erneut eingelesen wurde.</li>
- <li>SAVE bevor die Konfiguration gespeichert wird.</li>
- <li>SHUTDOWN bevor FHEM heruntergefahren wird.</li>
- <li>DEFINED <devname> nach dem Definieren eines
- Gerätes.</li>
- <li>DELETED <devname> nach dem Löschen eines
- Gerätes.</li>
- <li>RENAMED <old> <new> nach dem Umbenennen eines
- Gerätes.</li>
- <li>UNDEFINED <defspec> beim Auftreten einer Nachricht für
- ein undefiniertes Gerät.</li>
- </ul></li>
- <li>Notify kann dazu benutzt werden, um Makros für eine manuelle
- Ausführung zu speichern. Mit einem <a
- href="#trigger">trigger</a> Kommando können solche Makros dann
- ausgeführt werden. Z.B.<br> <code>fhem> define MyMacro notify
- MyMacro { Log 1, "Hello"}</code><br> <code>fhem> trigger
- MyMacro</code><br> </li>
- </ul>
- </ul>
- <br>
- <a name="notifyset"></a>
- <b>Set </b>
- <ul>
- <li>addRegexpPart <device> <regexp><br>
- Fügt ein regexp Teil hinzu, der als device:regexp aufgebaut ist.
- Die Teile werden nach Regexp-Regeln mit | getrennt. Achtung: durch
- hinzufügen können manuell erzeugte Regexps ungültig
- werden.</li>
- <li>removeRegexpPart <re><br>
- Entfernt ein regexp Teil. Die Inkonsistenz von addRegexpPart /
- removeRegexPart-Argumenten hat seinen Ursprung in der Wiederverwendung
- von Javascript-Funktionen.</li>
- <li>inactive<br>
- Deaktiviert das entsprechende Gerät. Beachte den leichten
- semantischen Unterschied zum disable Attribut: "set inactive"
- wird bei einem shutdown automatisch in fhem.state gespeichert, es ist
- kein save notwendig.<br>
- Der Einsatzzweck sind Skripte, um das notify temporär zu
- deaktivieren.<br>
- Das gleichzeitige Verwenden des disable Attributes wird nicht empfohlen.
- </li>
- <li>active<br>
- Aktiviert das entsprechende Gerät, siehe inactive.
- </li>
- </ul>
- <br>
- <a name="notifyget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="notifyattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <a name="addStateEvent"></a>
- <li>addStateEvent<br>
- Das mit dem state Reading verknüpfte Event ist speziell, da das
- dazugehörige Prefix "state: " entfernt wird, d.h. $EVENT ist nicht
- "state: on", sondern nur "on". In manchen Fällen ist es aber
- erwünscht das unmodifizierte Event zu bekommen, d.h. wo "state: "
- nicht entfernt ist. Für diese Fälle sollte addStateEvent auf 1
- gesetzt werden, die Voreinstellung ist 0 (deaktiviert).<br>
- Achtung:
- <ul>
- <li>dieses Attribut muss beim Empfänger (notify, FileLog, etc)
- gesetzt werden.</li>
- <li>dieses Attribut zeigt nur für solche Geräte-Events eine
- Wirkung, die <a href="#readingFnAttributes">readingFnAttributes</a>
- unterstützen.</li>
- </ul>
- </li>
- <a name="forwardReturnValue"></a>
- <li>forwardReturnValue<br>
- Rückgabe der Werte eines ausgeführten Kommandos an den
- Aufrufer. Die Voreinstellung ist 0 (ausgeschaltet), um weniger
- Meldungen im Log zu haben.
- </li>
- <a name="ignoreRegexp"></a>
- <li>ignoreRegexp regexp<br>
- Es ist nicht immer einfach ein Regexp zu bauen, was etwas _nicht_
- matcht. Dieses Attribu hilft in diesen Fällen: das Event wird
- ignoriert, falls den angegebenen Regexp. Syntax ist gleich wie in der
- Definition.
- </li>
- <a name="readLog"></a>
- <li>readLog<br>
- Das notify wird für Meldungen, die im FHEM-Log erscheinen,
- ausgegeführt. Das "Event-Generierende-Gerät" wird auf dem
- notify selbst gesetzt. Z.Bsp. kann man mit folgendem notify auf die
- Startup Meldung reagieren:
- <ul><code>
- define n notify n:.*Server.started.* { Log 1, "Wirklich" }<br>
- attr n readLog
- </code></ul>
- </li>
- <a name="perlSyntaxCheck"></a>
- <li>perlSyntaxCheck<br>
- nach setzen des <b>global</b> Attributes perlSyntaxCheck wird eine
- Syntax-Prüfung der Anweisung durchgeführt bei jeder
- Änderung (define oder modify), falls die Anweisung Perl ist, und
- FHEM bereits gestartet ist. </li>
- </ul>
- <br>
- </ul>
- <p><a name="panStamp"></a>
- <h3>panStamp</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#panStamp'>panStamp</a><br/>
- </ul>
- <a name="pilight"></a>
- <h3>pilight</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight'>pilight</a><br/>
- </ul>
- <a name="pilight_contact"></a>
- <h3>pilight_contact</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_contact'>pilight_contact</a><br/>
- </ul>
- <a name="pilight_ctrl"></a>
- <h3>pilight_ctrl</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_ctrl'>pilight_ctrl</a><br/>
- </ul>
- <a name="pilight_dimmer"></a>
- <h3>pilight_dimmer</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_dimmer'>pilight_dimmer</a><br/>
- </ul>
- <a name="pilight_raw"></a>
- <h3>pilight_raw</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_raw'>pilight_raw</a><br/>
- </ul>
- <a name="pilight_smoke"></a>
- <h3>pilight_smoke</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_smoke'>pilight_smoke</a><br/>
- </ul>
- <a name="pilight_switch"></a>
- <h3>pilight_switch</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_switch'>pilight_switch</a><br/>
- </ul>
- <a name="pilight_temp"></a>
- <h3>pilight_temp</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#pilight_temp'>pilight_temp</a><br/>
- </ul>
- <a name="ping"></a>
- <h3>ping</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#ping'>ping</a><br/>
- </ul>
- <a name="plex"></a>
- <h3>plex</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#plex'>plex</a><br/>
- </ul>
- <a name="powerMap"></a>
- <h3>powerMap</h3>
- <div class='langLinks'>[<a href='commandref.html#powerMap'>EN</a> DE]</div>
- (<a href="commandref.html#powerMap">en</a> | de)
- <div>
- <ul>
- powerMap ermittelt die aktuelle Leistungsaufnahme eines Geräts und
- berechnet den Energieverbrauch bei Änderung oder in einem
- regelmäßigen Intervall.<br>
- Diese neuen Werte können genutzt werden, um den Stromverbrauch für
- Geräte ohne Zähler (z.B. Kühlschrank, Beleuchtung oder
- FHEM-Server) zu erfassen und mit dem Modul ElectricityCalculator weiter
- zu verarbeiten.<br>
- <br>
- <a name="powerMapdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> powerMap</code><br>
- Es kann immer nur eine powerMap Instanz definiert sein.
- </ul><br>
- <a name="powerMapset"></a>
- <b>Set</b>
- <ul>
- <li>
- <code>assign <a href="#devspec"><devspec></a></code><br>
- Weist einem oder mehreren Geräten vordefinierte powerMap Attribute zu,
- um diese anschließend anpassen zu können.
- </li>
- </ul><br>
- <a name="powerMapget"></a>
- <b>Get</b>
- <ul>
- <li>
- <code>devices</code><br>
- Listet alle Geräte auf, die das Attribut 'powerMap' gesetzt haben.
- </li>
- </ul><br>
- <a name="powerMapreadings"></a>
- <b>Readings</b><br>
- <ul>
- Gerätespezifische Readings:
- <ul>
- <li>
- <code>pM_energy</code><br>
- Ein Zähler für die bisher bezogene Energie in Wh.<br>
- Hinweis: Für eine korrekte Berechnung darf das Attribut
- <code>timestamp-on-change-reading</code> nicht für das Reading
- pM_energy gesetzt sein!
- </li><br>
- <li>
- <code>pM_energy_begin</code><br>
- Unix Timestamp, an dem die Aufzeichnung begonnen wurde und das
- Gerät erstmalig Energie verbraucht hat.
- </li><br>
- <li>
- <code>pM_consumption</code><br>
- Die aktuelle Leistungsaufnahme des Gerätes in W.
- </li>
- </ul><br>
- </ul>
- <a name="powerMapattr"></a>
- <b>Attribute</b>
- <ul>
- <li>
- <code>disable 1</code><br>
- Es werden keine Readings mehr durch das Modul erzeugt oder berechnet.
- </li><br>
- <li>
- <code>powerMap_eventChainWarnOnly <1></code><br>
- Sofern gesetzt, wird die Ereigniskette NICHT automatisch repariert, falls
- Readings zwar als für powerMap notwendig identifiziert wurden, ihre
- Events jedoch derzeit dadurch unterdrückt werden, weil sie nicht in
- einem der Attribute event-on-change-reading oder event-on-update-reading
- enthalten sind. Stattdessen ist ein manueller Eingriff erforderlich.
- </li><br>
- <li>
- <code>powerMap_interval <seconds></code><br>
- Intervall in Sekunden, in dem neue Werte für die Energie berechnet
- werden.<br>
- Der Vorgabewert ist 900 Sekunden.
- </li><br>
- <li>
- <code>powerMap_noEnergy 1</code><br>
- Für das Gerät wird kein Energieverbrauch berechnet.
- </li><br>
- <li>
- <code>powerMap_noPower 1</code><br>
- Für das Gerät wird keine Leistungsaufnahme abgeleitet und
- daher auch kein Energieverbrauch berechnet.
- </li><br>
- <li>
- <code>powerMap_rname_E</code><br>
- Definiert den Reading Namen, in dem der Zähler für die bisher
- bezogene Energie gespeichert wird.<br>
- Der Vorgabewert ist 'pM_energy'.
- </li><br>
- <li>
- <code>powerMap_rname_P</code><br>
- Definiert den Reading Namen, in dem die aktuelle Leistungsaufnahme
- des Gerätes gespeichert wird.<br>
- Der Vorgabewert ist 'pM_consumption'.
- </li><br>
- <li>
- <code>powerMap<pre>
- {
- '<reading>' => {
- '<value>' => <power>,
- '<value>' => <power>,
- ...
- },
- '<reading>' {
- '<value>' => <power>,
- '<value>' => <power>,
- ...
- },
- ...
- }</pre>
- </code> (gerätespezifisch)<br>
- Ein Hash mit den Event(=Reading) Namen und seinen möglichen Werten, um diesen
- die dazugehörige Leistungsaufnahme zuzuordnen.<br>
- Bei dimmbaren Geräten wird für die Zwischenschritte der Wert
- durch eine lineare Interpolation ermittelt, so dass mindestens zwei Zahlenwerte ausreichen.<br>
- <br>
- Aus Textwerten, die eine Zahl enthalten, wird automatisch die Zahl extrahiert und
- für die Interpolation verwendet (Beispiel: dim50% wird automatisch als 50 interpretiert).<br>
- Außerdem werden "off" und "on" automatisch als 0 respektive 100 interpretiert.<br>
- Nicht interpretierbare Werte führen dazu, dass eine Leistungsaufnahme von 0 angenommen wird.<br>
- Explizit in powerMap enthaltene Definitionen haben immer vorrang.<br>
- <br>
- Für den Fall, dass mehrere Verbrauchswerte addiert werden sollen, kann der Name von anderen
- Readings direkt hinter dem eigentliche Wert mit einem Komma abgetrennt angegeben werden.
- Der aktuelle Status dieses Readings wird dann bei der Berechnung des Gesamtverbrauchs ebenfalls
- ber&uumL;cksichtigt. Sollen alle in powerMap bekannten Readings berücksichtigt werden, kann
- auch einfach ein * angegeben werden.<br>
- <br>
- Beispiel für einen FS20 Stecker:
- <ul>
- <code><pre>
- 'state' => {
- '0' => 0,
- '100' => 60,
- },
- </pre></code><br>
- </ul><br>
- Beispiel für eine HUE white Glühlampe:
- <ul>
- <code><pre>
- 'pct' => {
- '0' => 0.4,
- '10' => 1.2,
- '20' => 1.7,
- '30' => 1.9,
- '40' => 2.3,
- '50' => 2.7,
- '60' => 3.4,
- '70' => 4.7,
- '80' => 5.9,
- '90' => 7.5,
- '100' => 9.2,
- },
- 'state' => {
- 'unreachable' => 0,
- '*' => 'pct',
- },
- </pre></code><br>
- </ul>
- </li>
- </ul>
- </ul>
- </div>
- <p><a name="rain"></a>
- <h3>rain</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#rain'>rain</a><br/>
- </ul>
- <a name="readingsChange"></a>
- <h3>readingsChange</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#readingsChange'>readingsChange</a><br/>
- </ul>
- <a name="readingsGroup"></a>
- <h3>readingsGroup</h3>
- <div class='langLinks'>[<a href='commandref.html#readingsGroup'>EN</a> DE]</div>
- <ul>
- Zeigt eine Sammlung von Messwerten von einem oder mehreren Geräten an.
- <br><br>
- <a name="readingsGroup_Define"></a>
- <b>Define</b>
- <ul>
- <code>define <name> readingsGroup <device>[:regex] [<device-2>[:regex-2]] ... [<device-n>[:regex-n]]</code><br>
- <br>
- Anmerkungen:
- <ul>
- <li><device> kann die Form INTERNAL=VALUE haben, wobei INTERNAL der Name eines internen Wertes ist und VALUE ein Regex.</li>
- <li><device> kann die Form ATTRIBUTE&VALUE haben, wobei ATTRIBUTE der Name eines Attributs ist und VALUE ein Regex.</li>
- <li><device> kann die Form <STRING> oder <{perl}> haben, wobei STRING oder die von Perl zurückgegebene Zeichenfolge als Zeile in die Readings List eingefügt wird. Wird übersprungen, wenn STRING undef ist.</li>
- <li><device> kann ein devspec sein (siehe <a href="#devspec">devspec</a>) mit mindestens einem FILTER-Ausdruck sein.</li>
- <li>Wenn Regex eine Komma separarierte Liste ist, werden die Reading-Values in einer einzelnen Zeile angezeigt.</li>
- <li>Wenn Regex mit einem "+" beginnt, wird es mit den internen Werten (Internals) des Geräts anstelle der Readings verglichen.</li>
- <li>Wenn Regex mit einem '?' beginnt, wird es mit den Attributen des Geräts verglichen und nicht mit den Werten (Readings) verglichen.</li>
- <li>Wenn Regex mit einem '!' beginnt, wird die Anzeige des Wertes erzwungen, auch wenn kein Reading mit diesem Namen verfügbar ist.</li>
- <li>Wenn Regex mit einem '$' beginnt, ist die Berechnung mit Wert-Spalten und Zeilen möglich.</li>
- <li>Die folgenden <a href="#set">"set magic"</a> Präfixe und Suffixe können mit Regex verwendet werden:
- <ul>
- <li>Sie können anstelle von + und ? ein Präfix i :, r: oder a: verwenden. Analog zur devspec-Filterung.</li>
- <li>Der Suffix :d ruft die erste Nummer ab.</li>
- <li>Der Suffix :i ruft den ganzzahligen Teil der ersten Zahl ab.</li>
- <li>Der Suffix :r<n> ruft die erste Zahl ab und rundet sie auf <n> Nachkommastellen ab. Wenn <n> fehlt, wird es auf eine Dezimalstelle gerundet.</li>
- <li>Der Suffix :t gibt den Zeitstempel zurück (funktioniert nur mit Readings).</li>
- <li>Der Suffix :sec gibt die Anzahl der Sekunden seit dem das Reading gesetzt wurde zurück. Wahrscheinlich nicht nützlich mit readingsGroups.</li>
- </ul></li>
- <li>Regex kann von der Form <regex>@device sein, um Readings von einem anderen Gerät zu verwenden.<br>
- Wenn der Gerätename mit einem '!' beginnt, wird die Anzeige deaktiviert. Verwenden Sie in Verbindung mit ! den Reading-Name.</li>
- <li>Regex kann die Form <regex>@{perl} haben, um Readings von einem anderen Gerät zu verwenden.</li>
- <li>Regex kann von der Form <STRING> oder <{perl}[@readings]> sein, wobei STRING oder die von Perl zurückgegebene Zeichenfolge als Reading eingefügt wird, oder:
- <ul><li>das Element wird übersprungen, wenn STRING undef ist</li>
- <li>wenn STRING br ist, wird eine neue Zeile gestartet</li>
- <li>wenn STRING hr ist, wird eine horizontale Linie eingefügt</li>
- <li>wenn STRING tfoot ist, wird der Tabellenfuß gestartet</li>
- <li>wenn STRING die Form hat, %ICON[%CMD] ICON wird als Name eines Symbols anstelle von Text und CMD als der Befehl verwendet, der ausgeführt werden soll, wenn auf das Symbol geklickt wird. Siehe auch die Befehlsattribute.</li></ul>
- Wenn Readings aktualisiert werden, wird der Perl-Ausdruck bei Longpoll-Aktualisierungen erneut ausgewertet.</li>
- <li>Wenn der erste Regex '@<index>' ist, gibt es den Index der folgenden Regex an, mit dem die Messwerte gruppiert werden sollen. Wenn Erfassungsgruppen verwendet werden, können sie durch #<number> refferenziert werden. z.Bsp:<br><ul>
- <code><IP-Adress><Hostname><MAC><Vendor><br>
- nmap:@2,<#1>,(.*)_hostname,#1_macAddress,#1_macVendor</code></ul></li>
- <li>Für interne Werte (Internals) und Attribute ist longpoll update nicht möglich. Aktualisieren Sie die Seite, um die Werte zu aktualisieren.</li>
- <li>Der Ausdruck <{perl}> ist auf Ausdrücke ohne Leerzeichen beschränkt. Es ist am besten, eine kleine Sub in 99_myUtils.pm aufzurufen, anstatt einen complexen Ausdruck im Define zu haben.</li>
- </ul><br>
- Beispiele:
- <ul>
- <code>
- define batteries readingsGroup .*:battery</code><br>
- <br>
- <code>define temperatures readingsGroup s300th.*:temperature</code><br>
- <code>define temperatures readingsGroup TYPE=CUL_WS:temperature</code><br>
- <br>
- <code>define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI</code><br>
- <br>
- <code>define heizung readingsGroup t1:temperature t2:temperature t3:temperature<br>
- attr heizung notime 1<br>
- attr heizung mapping {'t1.temperature' => 'Vorlauf', 't2.temperature' => 'R&uuml;cklauf', 't3.temperature' => 'Zirkulation'}<br>
- attr heizung style style="font-size:20px"<br>
- <br>
- define systemStatus readingsGroup sysstat<br>
- attr systemStatus notime 1<br>
- attr systemStatus nostate 1<br>
- attr systemStatus mapping {'load' => 'Systemauslastung', 'temperature' => 'Systemtemperatur in &deg;C'}<br>
- <br>
- define Verbrauch readingsGroup TYPE=PCA301:state,power,consumption<br>
- attr Verbrauch mapping %ALIAS<br>
- attr Verbrauch nameStyle style="font-weight:bold"<br>
- attr Verbrauch style style="font-size:20px"<br>
- attr Verbrauch valueFormat {power => "%.1f W", consumption => "%.2f kWh"}<br>
- attr Verbrauch valueIcon { state => '%devStateIcon' }<br>
- attr Verbrauch valueStyle {($READING eq "power" && $VALUE > 150)?'style="color:red"':'style="color:green"'}<br>
- <br>
- define rg_battery readingsGroup TYPE=LaCrosse:[Bb]attery<br>
- attr rg_battery alias Batteriestatus<br>
- attr rg_battery commands { "battery.low" => "set %DEVICE replaceBatteryForSec 60" }<br>
- attr rg_battery valueIcon {'battery.ok' => 'batterie', 'battery.low' => 'batterie@red'}<br>
- <br>
- define rgMediaPlayer readingsGroup myMediaPlayer:currentTitle,<>,totaltime,<br>,currentAlbum,<>,currentArtist,<br>,volume,<{if(ReadingsVal($DEVICE,"playStatus","")eq"paused"){"%rc_PLAY%set+$DEVICE+play"}else{"%rc_PAUSE%set+$DEVICE+pause"}}@playStatus>,playStatus<br>
- attr rgMediaPlayer commands { "playStatus.paused" => "set %DEVICE play", "playStatus.playing" => "set %DEVICE pause" }<br>
- attr rgMediaPlayer mapping <br>
- attr rgMediaPlayer notime 1<br>
- attr rgMediaPlayer valueFormat { "volume" => "Volume: %i" }<br>
- #attr rgMediaPlayer valueIcon { "playStatus.paused" => "rc_PLAY", "playStatus.playing" => "rc_PAUSE" }<br>
- </code><br>
- </ul>
- </ul><br>
- <a name="readingsGroup_Set"></a>
- <b>Set</b>
- <ul>
- <li>hide<br>
- Alle sichtbaren Instanzen dieser ReadingsGroup werden ausgeblendet</li>
- <li>show<br>
- Zeigt alle sichtbaren Instanzen dieser ReadingsGroup an</li>
- <li>toggle<br>
- Schaltet den versteckten / angezeigten Zustand aller sichtbaren Instanzen dieser ReadingsGroup an.</li>
- <li>toggle2<br>
- schaltet den erweiterten / kollabierten Zustand aller sichtbaren Instanzen dieser ReadingsGroup an.</li>
- </ul><br>
- <a name="readingsGroup_Get"></a>
- <b>Get</b>
- <ul>
- </ul><br>
- <a name="readingsGroup_Attr"></a>
- <b>Attribute</b>
- <ul>
- <li>alwaysTrigger<br>
- 1 -> alwaysTrigger Ereignisse aktualisieren auch wenn nicht sichtbar.<br>
- 2 -> trigger Ereignisse für berechnete Werte.</li><br>
- <li>disable<br>
- 1 -> Deaktivieren der Benachrichtigung Verarbeitung und Longpoll-Updates. Hinweis: Dadurch wird auch die Umbenennung und Löschbehandlung deaktiviert.<br>
- 2 -> Deaktivieren der HTML-Tabellenerstellung<br>
- 3 -> Deaktivieren der HTML-Erstellung vollständig</li><br>
- <li>sortDevices<br>
- 1 -> Sortieren der Geräteliste alphabetisch. Verwenden Sie das erste von sortby oder alias oder name, das für jedes Gerät definiert ist.</li>
- <li>noheading<br>
- Wenn sie auf 1 gesetzt ist, hat die Readings-Tabelle keine Überschrift.</li><br>
- <li>nolinks<br>
- Deaktiviert die HTML-Links von der Überschrift und den Readings-Namen.</li><br>
- <li>nostate<br>
- Wenn der Wert 1 ist, wird der Status nicht berücksichtigt.</li><br>
- <li>nonames<br>
- Wenn der Wert auf 1 gesetzt ist, wird der Readings-Name / Zeilentitel nicht angezeigt.</li><br>
- <li>notime<br>
- Wenn der Wert auf 1 gesetzt, wird der Readings-Timestamp nicht angezeigt.</li><br>
- <li>mapping<br>
- Kann ein einfacher String oder ein in {} eingeschlossener Perl-Ausdruck sein, der einen Hash zurückgibt, der den Reading-Name dem angezeigten Namen zuordnet.
- Der Schlüssel kann entweder der Name des Readings oder <device>.<reading> oder <reading>.<value> oder <device>.<reading>.<value> sein.
- %DEVICE, %ALIAS, %ROOM, %GROUP, %ROW und %READING werden durch den Gerätenamen, Gerätealias, Raumattribut ersetzt. Sie können diesen Keywords auch ein Präfix voranstellen $ anstatt von %. Beispiele:<br>
- <code>attr temperatures mapping $DEVICE-$READING</code><br>
- <code>attr temperatures mapping {temperature => "%DEVICE Temperatur"}</code>
- </li><br>
- <li>separator<br>
- Das zu verwendende Trennzeichen zwischen dem Gerätealias und dem Reading-Namen, wenn keine Zuordnung angegeben ist, standardgemäß ':'
- Ein Leerzeichen wird so dargestellt <code>&nbsp;</code></li><br>
- <li>setList<br>
- Eine durch Leerzeichen getrennte Liste von Befehlen, die zurückgegeben werden "set name ?",
- Das FHEMWEB-Frontend kann also ein Dropdown-Menü erstellen und An / Aus-Schalter anbieten.
- Set-Befehle, die nicht in dieser Liste enthalten sind, werden zurückgewiesen.</li><br>
- <li>setFn<br>
- Perl-Ausdruck, der für die Befehle aus der setList ausgeführt wird. Es hat Zugriff auf $CMD und $ARGS.</li><br>
- <li>style<br>
- Geben Sie einen HTML-Stil für die Readings-Tabelle an, z.Bsp:<br>
- <code>attr temperatures style style="font-size:20px"</code></li><br>
- <li>cellStyle<br>
- Geben Sie einen HTML-Stil für eine Zelle der Readings-Tabelle an. Normale Zeilen und Spalten werden gezählt beginnend mit 1,
- Die Zeilenüberschriften beginnt mit der Spaltennummer 0. Perl-Code hat Zugriff auf $ROW und $COLUMN. Schlüssel für Hash-Lookup können sein:
- r:#, c:# oder r:#,c:# , z.Bsp:<br>
- <code>attr temperatures cellStyle { "c:0" => 'style="text-align:right"' }</code></li><br>
- <li>nameStyle<br>
- Geben Sie einen HTML-Stil für die Readings-Namen an, z.Bsp:<br>
- <code>attr temperatures nameStyle style="font-weight:bold"</code></li><br>
- <li>valueStyle<br>
- Geben Sie einen HTML-Stil für die Readings-Werte an, z.Bsp:<br>
- <code>attr temperatures valueStyle style="text-align:right"</code></li><br>
- <li>valueColumn<br>
- Geben Sie die Mindestspalte an, in der ein Messwert angezeigt werden soll. z.Bsp:<br>
- <code>attr temperatures valueColumn { temperature => 2 }</code></li><br>
- <li>valueColumns<br>
- Geben Sie einen HTML-Colspan für die Readings-Werte an, z.Bsp:<br>
- <code>attr wzReceiverRG valueColumns { eventdescription => 'colspan="4"' }</code></li><br>
- <li>valueFormat<br>
- Geben Sie eine Sprintf-Stilformat-Zeichenfolge an, die zum Anzeigen der Readings-Werte verwendet wird. Wenn die Formatzeichenfolge undef ist
- wird dieser Messwert übersprungen. Es kann als String angegeben werden, ein Perl-Ausdruck, der einen Hash- oder Perl-Ausdruck zurückgibt, der einen String zurückgibt, z.Bsp:<br>
- <code>attr temperatures valueFormat %.1f °C</code><br>
- <code>attr temperatures valueFormat { temperature => "%.1f °C", humidity => "%i %" }</code><br>
- <code>attr temperatures valueFormat { ($READING eq 'temperature')?"%.1f °C":undef }</code></li><br>
- <li>valuePrefix<br>
- Text, der dem Readings-Wert vorangestellt wird</li><br>
- <li>valueSuffix<br>
- Text, der nach dem Readings-Wert angehängt wird<br>
- <code>attr temperatures valueFormat { temperature => "%.1f", humidity => "%i" }</code><br>
- <code>attr temperatures valueSuffix { temperature => "°C", humidity => " %" }</code></li><br>
- <li>nameIcon<br>
- Geben Sie das Symbol an, das anstelle des Readings-Name verwendet werden soll. Es kann ein einfacher String oder ein in {} eingeschlossener Perl-Ausdruck sein, der einen Hash zurückgibt, der dem Readings-Name den Icon-Namen zuordnet. z.Bsp:<br>
- <code>attr devices nameIcon $DEVICE</code></li><br>
- <li>valueIcon<br>
- Geben Sie ein Symbol an, das anstelle des Readings-Wert verwendet werden soll. Es kann ein einfacher String oder ein in {} eingeschlossener Perl-Ausdruck sein, der einen Hash zurückgibt, der dem Readings-Wert dem Symbolnamen zuordnet. z.Bsp:<br>
- <code>attr devices valueIcon $VALUE</code><br>
- <code>attr devices valueIcon {state => '%VALUE'}</code><br>
- <code>attr devices valueIcon {state => '%devStateIcon'}</code><br>
- <code>attr rgMediaPlayer valueIcon { "playStatus.paused" => "rc_PLAY", "playStatus.playing" => "rc_PAUSE" }</code></li><br>
- <li>commands<br>
- Kann auf verschiedene Arten verwendet werden:
- <ul>
- <li>Um ein Reading oder ein Symbol anklickbar zu machen, indem Sie direkt den Befehl angeben, der ausgeführt werden soll. z.Bsp:<br>
- <code>attr rgMediaPlayer commands { "playStatus.paused" => "set %DEVICE play", "playStatus.playing" => "set %DEVICE pause" }</code></li>
- <li>Wenn der zugeordnete Befehl die Form <command>:[<modifier>] hat, wird das normale <a href="#FHEMWEB">FHEMWEB</a> webCmd-Widget für <Modifikator> für diesen commands verwendet. z.Bsp:<br>
- <code>attr rgMediaPlayer commands { volume => "volume:slider,0,1,100" }</code><br>
- <code>attr lights commands { pct => "pct:", dim => "dim:" }</code></li>
- <li>commands können für Attribute verwendet werden. z.Bsp:<br>
- <code>attr <rg> commands { disable => "disable:" }</code></li>
- </ul></li><br>
- <li>visibility<br>
- Wenn sie auf hidden oder hideable eingestellt ist, wird eine kleine Schaltfläche links neben dem Namen der Readings-Group angezeigt, um den Inhalt der Readings-Group zu erweitern / auszublenden. Wenn eine Readings-Group erweitert wird, werden alle anderen Gruppen derselben Gruppe ausgeblendet.<br>
- <ul>
- hidden -> Standardmäßig ist hidden aktiv, kann jedoch erweitert werden.<br>
- hideable -> Standardmäßig ist hideable aktiv, kann jedoch ausgeblendet werden.<br><br>
- </ul>
- Wenn diese Option auf "collapsed" oder "collapsible" eingestellt ist, erkennt readingsGroup die Specials <->,<+> und <+-> als die ersten Elemente von
- eine Linie, um dieser Linie ein + oder - Symbol hinzuzufügen. Durch Klicken auf das + oder - Symbol wird zwischen erweitertem und reduziertem Zustand umgeschaltet. Wenn eine Readings-Group erweitert wird, werden alle anderen Gruppen in der gleichen Gruppe ausgeblendet.
- <ul>
- - -> Die Linie wird im expandierten Zustand sichtbar sein.<br>
- + -> Die Linie wird im zusammengefalteten Zustand angezeigt.<br>
- +- -> Die Linie wird in beiden Zuständen sichtbar sein.<br>
- <br>
- collapsed -> Der Standardstatus ist reduziert, kann jedoch erweitert werden.<br>
- collapsible -> Der Standardstatus ist sichtbar, kann jedoch minimiert werden.<br><br></li>
- </ul>
- <li>headerRows<br><br>
- </li>
- <li>sortColumn<br>
- > 0 -> sortiert die Tabelle automatisch nach dem Laden der Seite nach dieser Spalte<br>
- 0 -> sortiert Sie nicht automatisch, sondern durch Klicken auf eine Spaltenüberschrift<br>
- < 0 -> sortiert die Tabelle automatisch nach dem Laden der Seite nach dieser Spalte
- </li>
- <br><li><a href="#perlSyntaxCheck">perlSyntaxCheck</a></li>
- </ul><br>
- Für die Hash-Version aller Zuordnungsattribute kann ein Standardwert angegeben werden mit <code>{ '' => <default> }</code>.<br><br>
- Die Stilattribute können auch einen in {} eingeschlossenen Perl-Ausdruck enthalten, der die zu verwendende Stilzeichenfolge zurückgibt. Für nameStyle und valueStyle, kann der Perl-Code $DEVICE,$READING,$VALUE und $NUM verwendet werden. z.Bsp:<br>
- <ul>
- <code>attr batteries valueStyle {($VALUE ne "ok")?'style="color:red"':'style="color:green"'}</code><br>
- <code>attr temperatures valueStyle {($DEVICE =~ m/aussen/)?'style="color:green"':'style="color:red"'}</code>
- </ul><br>
- Hinweis: Nur valueStyle, valueFomat, valueIcon und <{...}@reading> werden bei Longpoll-Updates ausgewertet und valueStyle muss für jeden möglichen Wert einen nicht leeren Stil zurückgeben. Alle anderen Perl-Ausdrücke werden nur einmal während der HTML-Erstellung ausgewertet und geben keine Wertupdates mit longpoll wieder.
- Aktualisieren Sie die Seite, um den dynamischen Stil zu aktualisieren. Für nameStyle funktioniert das Farbattribut momentan nicht, die font -... und background Attribute funktionieren.<br><br>
- Berechnung: Bitte sehen Sie sich dafür diese <a href="http://www.fhemwiki.de/wiki/ReadingsGroup#Berechnungen">Beschreibung</a> an in der Wiki.<br>
- z.Bsp: <code>define rg readingsGroup .*:temperature rg:$avg</code>
-
- </ul>
- <p><a name="readingsHistory"></a>
- <h3>readingsHistory</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#readingsHistory'>readingsHistory</a><br/>
- </ul>
- <a name="readingsProxy"></a>
- <h3>readingsProxy</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#readingsProxy'>readingsProxy</a><br/>
- </ul>
- <a name="remotecontrol"></a>
- <h3>remotecontrol</h3>
- <div class='langLinks'>[<a href='commandref.html#remotecontrol'>EN</a> DE]</div>
- <ul>
- Erzeugt eine graphische Fernbedienung. Buttons (=icons) können frei ausgewählt und angeordnet werden. Vordefinierte layouts sind verfügbar für z.B. Samsung-TV und iTunes.
- Jeder "Knopfdruck" kann an das entsprechende fhem-Gerät weitergegeben werden.<br>
- Weitere Erklaerungen finden sich im <a href="http://www.fhemwiki.de/wiki/Remotecontrol">Wiki-Eintrag</a>.<br>
- <a name="remotecontroldefine"></a><br>
- <b>Define</b>
- <ul>
- <code>define <rc-name> remotecontrol</code><br><br>
- Typische Schritte zur Einrichtung:<br>
- <table>
- <tr><td><code>define rc1 remotecontrol</code></td><td><code># erzeugt eine "leere" remotecontrol</code></td></tr>
- <tr><td><code>get rc1 layout</code></td><td><code># zeigt alle vorhandenen vordefinierten layouts an</code></td></tr>
- <tr><td><code>set rc1 layout samsung</code></td><td><code># laedt das layout für SamsungTV</code></td></tr>
- <tr><td><code>set rc1 makenotify myTV</code></td><td><code># erzeugt notify_rc1, das jeden Tastendruck an myTV weitergibt</code></td></tr>
- <tr><td><b>Hinweis:</b>die Tastenbelegung kann jederzeit geaendert werden, ohne dass der weblink erneut erzeugt werden muss.</td></tr>
- <tr><td><code>attr rc1 row15 VOLUP,VOLDOWN</code></td></tr>
- </table>
- </ul>
- <a name="remotecontrolset"></a><br>
- <b>Set</b>
- <ul>
- <li><code>set <rc-name> layout [delete|<layoutname>]</code><br>
- <code>layout delete</code> loescht alle rowXX-Attribute<br>
- <code>layout <layoutname></code> laedt das vordefinierte layout in die rowXX-Attribute</li>
- <li><code>set <rc-name> makeweblink [<name>]</code><br>
- erzeugt einen weblink zur Anzeige der remotecontrol in FHEMWEB oder FLOORPLAN. Default-Name ist weblink_<rc-name> .</li>
- <li><code>set rc1 makenotify mySamsungTV</code><br>
- erzeugt <code>notify_rc1</code> das jeden Tastendruck an mySamsungTV zur Ausfuehrung weitergibt</li>
- </ul>
-
- <a name="remotecontrolattr"></a><br>
- <b>Attribute</b>
- <ul>
- <li><a href="#loglevel">loglevel</a></li>
- <li><a name="rc_iconpath">rc_iconpath</a><br>
- Pfad für icons, default ist "icons" . Der Attribut-Wert wird für alle icon-Dateien verwendet ausser .svg .</li>
- <li><a name="rc_iconprefix">rc_iconprefix</a><br>
- Prefix für icon-Dateien, default ist "" . Der Attribut-Wert wird für alle icon-Dateien verwendet ausser .svg .</li>
- <li>Note: Icon-Namen (Tasten-Bild-Datei-Namen) werden zusammengesetzt als fhem/<rc_iconpath>/<rc_iconprefix><command|image><br>
- Fuer .svg -icons ist die Zugriffsfolge gemaess dem FHEMWEB-Attribut iconPath, default ist openautomation:fhemSVG:default .
- </li>
- <li><a name="rc_devStateIcon">rc_devStateIcon</a><br>
- Zeigt das button-layout auf dem remotecontrol-device selbst in der FHEMWEB-Raumansicht an. Default ist 1, durch setzen auf 0 erscheint in der FHEMWEB-Raumansciht nicht das layout, sondern nur der Status "Initialized".</li>
- <br>
- <li><a href="#rowXX">rowXX</a><br>
- <code>attr <rc-name> rowXX <command>[:<image>]</code><br>
- Komma-separarierte Liste von Tasten/Icons je Tastaturzeile. Eine Tastaturzeile kann beliebig viele Tasten enthalten.</li><br>
- <li><command> ist der event, der bei Tastendruck ausgelöst wird. Gross/Kleinschreibung beachten.</li>
- <li><image> ist der Dateiname des als Taste angezeigten icons</li>
- <li>Verwenden Sie je Taste</li>
- <li><command> wobei als Taste/icon <code><rc_iconprefix><command></code> angezeigt wird<br>
- Beispiel:<br>
- <code>attr rc1 rc_iconprefix black_btn_ # gilt für alle Tasten/icons</code><br>
- <code>attr rc1 row00 VOLUP</code><br>
- -> icon ist <code>black_btn_VOLUP</code>, ein Tastendruck erzeugt den event <code>VOLUP</code>
- </li><br>
- oder
- <li><command>:<image> wobei als Taste/icon <rc_iconprefix><image> angezeigt wird.<br>
- Beispiel:<br>
- <code>attr rc1 row00 LOUDER:VOLUP</code><br>
- icon ist black_btn_VOLUP, ein Tastendruck erzeugt den event LOUDER<br>
- Beispiele:
- <code>attr rc1 row00 1,2,3,TV,HDMI</code><br>
- <code>attr rc2 row00 play:PLAY,pause:PAUSE,louder:VOLUP,quieter:VOLDOWN</code><br>
- </li>
- <li><b>Hinweis:</b> verwenden Sie :blank für eine 'leere Taste', oder z.B. :blank,:blank,:blank für eine Abstands-Leerzeile.</li>
- </ul>
- </ul>
- <p><a name="restore"></a>
- <h3>restore</h3>
- <div class='langLinks'>[<a href='commandref.html#restore'>EN</a> DE]</div>
- <ul>
- <code>restore list [<filename|directory>]<br>
- restore [<filename|directory>]<br>
- restore -a [<filename|directory>]</code>
- <br><br>
- Restauriert die beim update gesicherten Dateien. Mit dem Argument list kann
- man die Liste der verf&ügbaeren Sicherungen anzeigen, und mit der Angabe
- der direkten Datei/Verzeichnis kann man das zurücksichern anstossen.
- Siehe auch das update Befehl, bzw. das restoreDirs Attribut.
- Nach restore ist meistens ein "shutdown restart" notwendig.<br>
- Falls die -a Option spezifiziert wurde, dann werden auch die
- Konfigurationsdateien wiederhergestellt.
- </ul>
- <p><a name="rssFeed"></a>
- <h3>rssFeed</h3>
- <div class='langLinks'>[<a href='commandref.html#rssFeed'>EN</a> DE]</div>
- <ul>
- Mit diesem Hilfs-Device kann ein RSS-Feed per URL abgerufen werden.
- Das Ergebnis wird zum einen in entsprechende Readings (s.u.) eingetragen,
- zum Anderen können die Schlagzeilen (Headlines) noch per GET oder per
- bereitgestellter Funktion als Ticker-Daten abgerufen werden.
- Die Daten des RSS-Feeds werden dabei jeweils im angegebenen Interval
- aktualisiert.
- <br><br>
- <a name="rssFeeddefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> rssFeed <url> [interval]</code>
- <br><br>
- <ul>
- url = URL zum RSS-Feed
- </ul>
- <ul>
- interval = Aktualisierungsinterval in Sekunden<br>
- minimum Wert sind 600 Sekunden (10 Minuten)<br>
- maximum Wert sind 86400 Sekunden (24 Stunden)
- </ul>
- <br>
- Beispiel:
- <ul>
- <code>define rssGEA rssFeed http://www.gea.de/rss?cat=Region%20Reutlingen&main=true 3600</code>
- <br><br>
- Damit wird stündlich der RSS-Feed des Reutlinger Generalanzeigers
- abgerufen.
- </ul>
- </ul>
- <br>
- <a name="rssFeedset"></a>
- <b>Set</b>
- <ul>
- <code>set <name> update</code><br>
- Abrufen der Daten vom rssFeed und aktualisieren der Readings
- </ul>
- <br>
- <a name="rssFeedget"></a>
- <b>Get</b><br>
- <ul>
- <code>get <name> ticker</code><br>
- Abrufen der zuletzt gelesenen Schlagzeilen im gewünschten
- Format (s. Attribute)
- </ul>
- <br>
- <a name="rssFeedattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a name="disabled">disabled</a><br>
- Mit diesem Attribut kann das Device deaktiviert (1) werden
- bzw. auch wieder aktiviert (0 oder Attribut nicht vorhandn).
- Wenn das device deaktiviert ist, sind keine Readings mehr
- vorhanden, außer state. Außerdem werden die Daten nicht mehr
- zyklisch aktualisiert und get ticker liefert nur noch die
- Information zurück, dass der Ticker nicht mehr aktiv ist
- (s. dazu auch Attribut rfDisabledText).
- <br>
- </li>
- <li><a name="rfDisabledText">rfDisabledText</a><br>
- Der hier eingetragenee Text wird beim Abruf der Schlagzeilen als einzige
- Zeile angezeigt, wenn der rssFeed disabled ist (s. Attribut disabled).
- Ist dieses Attribut nicht angegeben, so wird ein Standardtext angezeigt.<br>
- Beispiel: <code>attr <name> rfDisabledText Dieser Feed wurde deaktiviert</code>
- </li>
- <li><a name="rfTickerChars">rfTickerChars</a><br>
- Hiermit kann eine Zeichenfolge festgelegt werden, die bei den Schlagzeilen
- für den get-Abruf vor und nach jeder Schlagzeile, wie bei einem Nachrichten-Ticker
- angefügt wird.
- Beispiel: <code>attr <name> rfTickerChars +++</code>
- <br>
- Ergebnis: <code>+++ Dies ist eine Beispiel-Schlagzeile +++</code>
- <br>
- Diese Zeichenkette wird auch als Trenner für die Marquee-Ticker-Daten verwendet.
- <br>
- </li>
- <li><a name="rfMaxLines">rfMaxLines</a><br>
- Bestimmt, wieviele Schlagzeilen maximal aus dem Feed extrahiert werden sollen.<br>
- Sind weniger Nachrichten-Elemente im Feed enthalten, als über rfMaxLines angegeben,
- so werden eben nur so viele Schlagzeilen extrahiert, wie vorhanden sind.<br>
- Ist dieses Attribut nich angegeben, so wird dafür der Standard-Wert 10 angenommen.<br>
- Beispiel: <code>attr <name> rfMaxLines 15</code>
- <br>
- </li>
- <li><a name="rfDisplayTickerReadings">rfDisplayTickerReadings</a><br/>
- Wenn dieses Attribut gesetzt ist werden 2 zusätzliche Readings erzeugt, die
- die Tickerdaten einmal für s.g. "Toast"-Ticker (der Inhalt ist der selbe,
- wie die Ausgabe von rssFeedGetTicker()) und einmal für s.g. "Marquee"-Ticker, also
- in einer einzigen Zeile.
- <br>
- </li>
- <li><a name="rfEncode">rfEncode</a><br>
- Hier kann eine Encoding-Methode (Bspw. utf8) angegeben werden.
- Die Texte die aus dem Feed extrahiert werden (title, descripton, ...)
- werden dann vor der Zuwesung an die Readings mittels encode (Perl core-Module Encode)
- enkodiert. Fehlt dieses Attribut, so findet keine umkodierung statt.
- Das kann u.U. notwendig sein, wenn in den zurückgelieferten Feed-Daten s.g. wide Characters
- enthalten sind. Dies kann evtl. dazu führen, das u.a. die Darstellung in FHEMWEB nicht mehr
- korrekt erfolgt.
- Dies betrifft auch das Ergebnis von rssFeedFunctions, bzw. get ticker.<br/>
- Dieses Attribut wird beim ersten define per default auf utf8 gesetzt.
- <br>
- </li>
- <li><a name="rfReadings">rfReadings</a><br>
- Über dieses Attribut kann angegeben werden, welche Daten aus dem RSS-Feed in
- Readings extrahiert werden sollen. Das Attribut ist als Komma getrennte Liste
- anzugeben.<br>
- Zur Auswahl stehen dabei folgende möglichen Werte:
- <ul>
- <li>title = Titelzeile<br>
- Dies erzeugt ein Reading für den Feed-Titel und für jedes
- Nachrichten-Element aus dem Feed.<br>
- </li>
- <li>description = Beschreibungstext
- Dies erzeugt ein Reading für die Feed-Beschreibung, bzw.
- für den Beschreibungstext jeden Nachrichten-Eelements.<br>
- </li>
- <li>encodedContent = content:encoded Abschnitt<br/>
- Sofern vorhanden ist in diesem Abschnitt quasi ein Langtext
- der Nachrihtenmeldung enthalten.
- <br/>
- </li>
- <li>pubDate = Zeitpunkt der Veröffentlichung des Feeds, bzw. der einzelnen
- Nachrichten-Elemente
- <br>
- </li>
- <li>link = Link zum Feed, bzw. zum einzelnen Nachrichten-Element auf
- der Homepage des Feeds.
- <br>
- </li>
- <li>buildDate = Zeitpunkt der letzten aktualisierung der Feed-Daten
- vom Feed-Betreiber.
- <br>
- </li>
- <li>imageURl = URL zum ggf. vorhandenen Bild eines Nachrichten-Elements,
- bzw. zum Nachrichten-Feed.
- <br>
- </li>
- <li>imageTitle = Titel eines ggf. zum Feed oder Nachrichten-Element
- vorhandenen Bildes.
- <br>
- </li>
- </ul>
- Ist Dieses Attribut nicht vorhanden, so werden die Werte "title,description,pubDate" als
- Voreinstellung angenommen. Beim ersten Anlegen des Device wird das Attribut automatisch
- erste einmal mit genau dieser Voreinstellung belegt.
-
- <br>
- </li>
- <li><a name="rfCustomTextPrepFn">rfCustomTextPrepFn</a><br>
- Hier kann eine Funktion angegeben werden, die bspw. in 99_myUtils.pm
- definiert wird. In dieser Funktion können Textinhalte vor dem
- Setzen der Readings, bzw. Tickerzeilen beliebig modifiziert werden.
- Der Funktion wird dabei zum Einen eine Kennung für den Text übergeben und zum
- Anderen der Text selbst. Zurückgegeben wird dann der modifizierte Text.
- <br/>
- Mögliche Kennungen sind dabei (s.a. rfReadings)<br>
- <ul>
- <li>feedTitle</li>
- <li>feedDescription</li>
- <li>imageTitle</li>
- <li>desctiption</li>
- <li>encodedContent</li>
- </ul>
- <br/>
- Beispiel für 99_myUtils.pm:
- <pre>
- #Text-Modifikation für rssFeedDevices
- sub rssFeedPrep($$)
- {
- my($texttype,$text) = @_;
- #Länge von descriptions auf maximal 50 begrenzen
- my $tLn=length $text;
- $text=substr($text,0,47).'...' if ($tLn >50 && ($texttype=~/description/));
- #Filtern von texten, die fälschlicherweise auf HASH(xxxxxx) stehen
- #von beliebigen Texten
- return ' ' if ($text=~/HASH\(.*\)/);
- #Setzen eines eigenen Titels für den Feed
- return 'Mein eigener Feed-Titel' if ($texttype =~/feedTitle/);
- #jetzt noch den modifizierten Text zurück geben
- return $text;
- }
- </pre>
- zur Verwendung muss das Attribut noch entsprechend gesetzt werden:<br/>
- <code>attr <rssFeedDevice> rfCustomTextPrepFn rssFeedPrep</code>
- <br/>
- </li>
- <li>
- <a name="rfReadings">rfAllReadingsEvents</a><br/>
- Wenn dieses Attribut auf 1 gesetzt wird, so werden für ALLE Readings,
- die während des Feed-Updates erzeugt werden auch entsprechende Events
- generiert (abh. von den event-on-... Attributen).
- Von Haus aus werden, v.a. für die Readings mit den Feed-Daten keine
- Events generiert.
- </li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- <a name="rssFeedfunctions"></a>
- <b>Funktionen</b>
- <ul>
- <li>rssFeedGetTicker<br>
- Diese Funktion gibt die ermittelten und formatierten Schlagzeilen als Zeichenkette
- zurück. Die einzelnen Schlagzeilen sind dabei durch Zeilenvorschub getrenn.
- Dieses Ergebnis kann bspw. in einem InfoPanel für einen Ticker verwendet werden.
- Der Funktion muss dazu der Name eines rssFeed-Devices übergeben werden.
- Die Ausgabe ist praktisch die selbe wie das Ergebnis, das bei <code>get ticker</code>
- geliefert wird.<br>
- Syntax: <code> rssFeedGetTicker(<rssFeedDevice>)</code><br>
- </li>
- </ul><br>
- <a name="rssFeedreadings"></a>
- <b>Readings</b>
- <ul>
- Je nach Auswahl der Attribute werden verschiedene Readings bereitgestellt.
- Diese Readings sind teilweise mit einem Präfix versehen um sie bspw. dem Feed
- selbst oder einem Nachrichten-Element zuozuordnen.
- </ul>
- <ul>
- <br>
- <li><code>Nxx_</code><br>
- Diese Readings beziehen sich alle auf die einzelnen Nachrichten-Elemente, wobei
- <code>xx</code> den Index des jeweiligen Nachrichten-Elements angibt.
- <br>
- Beispiel für die Readings eines Nachrichten-Elements:<br>
- <ul>
- <code> N00_title </code><br/>
- <code> N00_descripton </code><br/>
- <code> N00_pubDate </code><br/>
- </ul>
- </li>
- <li><code>f_</code><br>
- Diese Readings beziehen sich alle auf den Nachrichten-Feed selbst.
- <br>
- Beispiel für die Readings des Nachrichten-Feeds<br>
- <ul>
- <code> f_title </code><br/>
- <code> f_descripton </code><br/>
- <code> f_buildDate </code><br/>
- </ul>
- </li>
- <li><code>preparedLines</code><br>
- Dieses Reading gibt an, wie viele Schlagzeilen tatsächlich beim letzten
- update aus dem Nachrichten-Feed extrahiert wurden.
- </li>
- <li>
- <code>tickerToast</code><br/>
- Dieses Reading entä die selben Daten, wie sie von der rssFeedGetTicker()
- Funktion zurückgeliefert werden (if attribute rfDisplayTickerReadings is set)
- <br>
- Beispiel: <code>+++ Headline 1 +++ \n +++ Headline 2 +++ \n +++ Headline 3 +++ </code>
- </li>
- <li>
- <code>tickerMarquee</code><br/>
- Dieses Reading enthält die Tickerdaten für "marquee"-artige Ticker,
- also auf einer Zeile (if attribute rfDisplayTickerReadings is set)
- <br>
- Beispiel: <code>Headline 1 +++ Hadline 2 +++ Headline 3 +++</code>
- </li>
- <li><code>gzippedFeed</code><br>
- Manche Feeds werden in gezippter (gzip) Form ausgeliefert. Das wird vom
- Modul automatisch erkannt und die Daten im Bedarfsfall dekomprimiert.
- Wurde beim letzten update der Feed in gezippter Form ausgeliefert, so wird
- dieses Reading auf 1 gesetzt, andernfalls auf 0.
- </li>
- <li><code>state</code><br>
- Dieses Reading gibt, wenn das Device nicht disabled ist, den Zeitpunkt
- der letzten aktualisierung mittels update an, egal ob automatisch oder
- manuell ausgelöst. Ist das device disabled, steht genau das im Reading.
- Beim Anlegegen des Device mittels define findet das erste Aktualisieren
- der Daten verzögert statt. Während dieser Verzögerung steht der state
- auf "defined".
- </li>
- </ul><br>
-
- </ul>
- <p><a name="sequence"></a>
- <h3>sequence</h3>
- <div class='langLinks'>[<a href='commandref.html#sequence'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="sequencedefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> sequence <re1> <timeout1>
- <re2> [<timeout2> <re3> ...]</code>
- <br><br>
- Ein sequence kann verwendet werden, um ein neues Event zu generieren, wenn
- eine bestimmte Folge von anderen Events in einem festgelegten Zeitraum
- eingetroffen ist. Z.Bsp. um eine Lampe dann einzuschalten, falls Btn1:on,
- dann Btn2:off und zum Schluss Btn1:on innerhalb einer Sekunde gedrückt
- wurde, definiert man folgendes:<br>
- <ul>
- <code>
- define lampseq sequence Btn1:on 0.5 Btn2:off 0.5 Btn1:on<br>
- define lampon notify lampseq:trigger set lamp on
- </code>
- </ul>
- Nachfolgende Regexps können den Namen des Gerätes weglassen, in
- diesem Fall werden nur die Events des beim ersten Event eingetroffenen
- Gerätes beachtet:
- <br>
- <ul>
- <code>
- define lampseq sequence Btn.:on 0.5 :off<br>
- </code>
- </ul>
- <br>
- Timeout kann als <code><delay>:<timeout></code> spezifiziert
- werden, dabei setzt delay die Zeit, wo kein passendes Event empfangen
- werden darf, ansonsten wird sequence abgebrochen. Das kann verwendet
- werden, um "press and hold" auszuwerten. Folgendes
- <ul>
- <code>
- define lampseq sequence Btn1:on 2:3 :off<br>
- </code>
- </ul>
- ist nur erfolgreich, falls Btn1 zwischen 2 und 5 Sekunden lang gedrückt
- wurde.
- </ul>
- <br>
- <a name="sequenceset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="sequenceget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="sequenceattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#disable">disable</a></li>
- <li><a href="#triggerPartial">triggerPartial</a><br>
- Falls gesetzt (auf 1), und nicht alle erwarteten Events eingetroffen
- sind, dann wird ein partial_X Event generiert, wobei X durch Anzahl der
- eingetroffenen Events ersetzt wird. Beispiel:<br><code><ul>
- fhem> define seq sequence d1:on 1 d1:on 1 d1:on<br>
- fhem> attr seq triggerPartial<br>
- fhem> set d1 on;; sleep 0.5;; set d1 on<br>
- </ul></code>
- erzeugt das Event "seq partial_2". Dies kann verwendet werden, um z.Bsp.
- einer Taste unterschiedliche Aufgaben zuzuweisen, jenachdem wie oft sie
- gedrückt wurde.
- </li>
- </ul>
- <br>
- <a name="sequenceattr"></a>
- <b>Attributes</b>
- <ul>
- <li><a href="#disable">disable</a></li>
- <li><a href="#showtime">showtime</a></li>
- <li><a href="#triggerPartial">triggerPartial</a><br>
- Falls gesetzt (auf 1), und nicht alle erwarteten Events eingetroffen
- sind, dann wird ein partial_X Event generiert, wobei X durch Anzahl der
- eingetroffenen Events ersetzt wird. Beispiel:<br><code><ul>
- fhem> define seq sequence d1:on 1 d1:on 1 d1:on<br>
- fhem> attr seq triggerPartial<br>
- fhem> set d1 on;; sleep 0.5;; set d1 on<br>
- </ul></code>
- erzeugt das Event "seq partial_2". Dies kann verwendet werden, um z.Bsp.
- einer Taste unterschiedliche Aufgaben zuzuweisen, jenachdem wie oft sie
- gedrückt wurde.
- </li><br>
- <li><a href="#reportEvents">reportEvents</a><br>
- Falls gesetzt (auf 1), meldet trigger die empfangenen Events (Leerzeichen
- getrennt) nach dem "trigger" oder "partial_X" Schlüsselwort.
- Das kann verwendet werden, um generische sequence Instanzen zu definieren:
- <br>
- <ul><code>
- define seq sequence remote:btn.* remote:btn.*<br>
- attr seq reportEvents<br>
- define n_b1b2 notify seq:trigger.remote:btn1.remote:btn2 set lamp1 on<br>
- define n_b2b1 notify seq:trigger.remote:btn2.remote:btn1 set lamp1 off<br>
- </code></ul>
- </li>
- </ul>
- <br>
- </ul>
- <p><a name="siri"></a>
- <h3>siri</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#siri'>siri</a><br/>
- </ul>
- <a name="speedtest"></a>
- <h3>speedtest</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#speedtest'>speedtest</a><br/>
- </ul>
- <a name="statistics"></a>
- <h3>statistics</h3>
- <div class='langLinks'>[<a href='commandref.html#statistics'>EN</a> DE]</div>
- <div>
- <ul>
- Dieses Modul wertet von den angegebenen Geräten (als regulärer Ausdruck) bestimmte Werte statistisch aus und fügt das Ergebnis den jeweiligen Geräten als neue Werte hinzu.
- <br>
- Für detailierte Anleitungen bitte die <a href="http://www.fhemwiki.de/wiki/Statistics"><b>FHEM-Wiki</b></a> konsultieren und ergänzen.
- <br>
- <br>
- Es unterscheidet in vier Statistik-Typen denen bereits standardmässig Gerätewerte zugeordnet sind:
- <ul>
- <li><b>Min|Avg|Max</b> Minimum, Durchschnitt und Maximum von Momentanwerten:
- <br>
- über den Zeitraum Tag, Monat und Jahr:
- <br>
- <i>brightness, current, energy_current, humidity, luminosity, temperature, voltage</i>
- <br>
- über den Zeitraum Stunde, Tag, Monat und Jahr:
- <br>
- <i>wind, wind_speed, windSpeed</i>
- </li><br>
- <li><b>Tendency</b> Tendenz über 1h, 2h, 3h und 6h: <i>pressure</i>
- </li><br>
- <li><b>Delta</b> Differenz zwischen Anfangs- und Endwerte innerhalb eines Zeitraums (Stunde, Tag, Monat, Jahr):
- <br>
- <i>count, energy, energy_total, power, total, rain, rain_rate, rain_total</i>
- </li><br>
- <li><b>Duration</b> Dauer und Anzahl der Zustände (on, off, open, closed...) innerhalb eines Zeitraums (Tag, Monat, Jahr):
- <br>
- <i>lightsensor, lock, motion, Window, window, state (wenn kein anderer Gerätewert gültig)</i>
- </li><br>
- </ul>
- Über die <a href="#statisticsattr">Attribute</a> <code>deltaReadings, durationReadings, minAvgMaxReadings, tendencyReadings</code> können weitere Gerätewerte hinzugefügt oder
- einem anderen Statistik-Typ zugeordnet werden.
- <br>
- <br>
-
- <b>Define</b>
- <ul>
- <br>
- <code>define <Name> statistics <GeräteNameRegExp> [Prefix]</code>
- <br>
- Beispiel: <code>define Statistik statistics Wettersensor|Badsensor</code>
- <br>
- <li><code><GeräteNameRegExp></code>
- <br>
- Regulärer Ausdruck für den Gerätenamen. <b>!!! Nicht die Gerätewerte !!!</b>
- </li><br>
- <li><code>[Prefix]</code>
- <br>
- Optional. Der Prefix wird vor den Namen der statistischen Gerätewerte gesetzt. Standardmässig <i>stat</i>
- </li><br>
- </ul>
-
- <br>
- <b>Set</b>
- <ul>
- <br>
- <li><code>resetStatistics <All|Gerätename></code>
- <br>
- Setzt die Statistiken der ausgewählten Geräte zurück.
- </li><br>
- <li><code>doStatistics</code>
- <br>
- Berechnet die aktuellen Statistiken aller beobachteten Geräte.
- </li><br>
- </ul>
- <br>
- <b>Get</b>
- <ul>nicht implementiert
- </ul>
- <br>
- <a name="statisticsattr"></a>
- <b>Attributes</b>
- <ul>
- <br>
- <li><code>dayChangeTime <Zeit></code>
- <br>
- Uhrzeit des Tageswechsels. Standardmässig 00:00. Bei Wetterdaten kann der Tageswechsel z.B. auf 6:50 gesetzt werden.
- </li><br>
- <li><code>deltaReadings <Gerätewerte></code>
- <br>
- Durch Kommas getrennte Liste von weiteren Gerätewerten, für welche die Differenz zwischen den Werten am Anfang und Ende einer Periode (Stunde/Tag/Monat/Jahr) bestimmt wird.
- </li><br>
- <li><code>durationPeriodHour < 1 | 0 ></code>
- <br>
- Wenn auf 1 gesetzt, dann werden für "durationReadings" auch stündliche Statistiken gebildet.
- </li><br>
- <li><code>durationReadings <Gerätewerte></code>
- <br>
- Durch Kommas getrennte Liste von weiteren Gerätewerten, für welche die Dauer einzelner Gerätewerte innerhalb bestimmte Zeiträume (Stunde/Tag/Monat/Jahr) erfasst wird.
- </li><br>
- <li><code>excludedReadings <GerätenameRegExp:GerätewertRegExp></code>
- <br>
- Regulärer Ausdruck der Gerätewerte die nicht ausgewertet werden sollen.
- z.B. <code>FritzDect:current|Sensor_.*:humidity</code>
- <br>
- </li><br>
- <li><code>ignoreDefaultAssignments <code><0 | 1></code></code>
- <br>
- Ignoriert die Standardzuordnung von Gerätewerten zu Statistiktypen..<br>
- D.h., nur die Gerätewerte, die über Attribute den Statistiktypen zugeordnet sind, werden ausgewertet.
- <br>
- </li><br>
-
- <li><code>hideAllSummaryReadings <0 | 1></code>
- <br>
- noch nicht implementiert - Es werden keine gesammelten Statistiken angezeigt, sondern nur die unter "singularReadings" definierten Einzelwerte
- </li><br>
- <li><code>minAvgMaxReadings <Gerätewerte></code>
- <br>
- Durch Kommas getrennte Liste von Gerätewerten, für die in bestimmten Zeiträumen (Tag, Monat, Jahr) Minimum, Mittelwert und Maximum erfasst werden.
- </li><br>
- <li><code>periodChangePreset <Sekunden></code>
- <br>
- Start der Berechnung der periodischen Daten, standardmässig 5 Sekunden vor der vollen Stunde,
- <br>
- Erlaubt die korrekte zeitliche Zuordnung in Plots, kann je nach Systemauslastung verringert oder vergrößert werden.
- <br>
- </li><br>
- <li><code>singularReadings <GerätRegExp:GeräteWertRegExp:Statistiktyp:Zeitraum></code>
- <ul>
- <li>Statistiktyp: Min|Avg|Max|Delta|<i>DurationState</i>|<span style="color:blue;">Tendency</span></li>
- <li>Zeitraum: Hour|Day|Month|Year|<span style="color:blue;">1h|2h|3h|6h</span></li>
- </ul>
- Regulärer Ausdruck statistischer Werte, die <u>zusätzlich</u> auch als einzelne Werte gespeichert werden sollen.
- Erleichtert die Erzeugung von Plots und anderer Auswertungen (notify).
- <br>
- Für "duration"-Gerätewerte muss der Name des jeweiligen Statuswertes als <code>Statistiktyp</code> eingesetzt werden.
- <dt>Beispiel:</dt>
- <dd>
- <code>Wettersensor:rain:Delta:(Hour|Day)|FritzDect:power:Delta:Day</code>
- <br>
- <code>Wettersensor:rain:Delta:(Hour|Day)|FritzDect:power:Delta:Day</code>
- </dd>
- </li><br>
- <li><code>specialDeltaPeriods <Gerät:Gerätewert:Zeitraum:Anzahl1:Anzahl2:...></code>
- <br>
- Erzeugt für die angegebenen "delta"-Gerätewerte zusätzliche Einzelwerte über die angegebene Anzahl eines Zeitraums (Hour, Day, Month).
- <br>
- Reguläre Ausdrücke können <u>nicht</u> genutzt werden. Es können auch mehrere Gerätewert und/oder Zeiträume hinzugefügt werden. Diese müssen durch Kommas (ohne Leerzeichen) getrennt werden.
- <br>
- <dt>Beispiel:</dt>
- <dd>
- <code>attr Statistik specialDeltaPeriods Wettersensor:rain:Hour:06:72:96</code>
- <br>
- Dies erzeugt 3 zusätzliche Werte für die Regenmenge in den letzten 6, 72, 96 Stunden.
- <br>
- <code>attr Statistik specialDeltaPeriods Wettersensor:rain:Hour:48,Wettersensor:rain:Day:30,EZaehler:energy:Month:6:12</code>
- <br>
- Dies erzeugt 4 zusätzliche Werte für die Regenmenge in den letzten 48 Stunden und den letzten 30 Tagen und den Energieverbrauch der letzten 6 und 12 Monate.
- </dd>
- </li><br>
- <li><code>specialDeltaPeriodHours</code>
- <br>
- veraltet
- </li><br>
- <li><code>tendencyReadings <Gerätewerte></code>
- <br>
- Durch Kommas getrennte Liste von weiteren Gerätewerten, für die innerhalb bestimmter Zeiträume (1h, 2h, 3h, 6h) die Differenz zwischen Anfangs- und Endwert ermittelt wird.
- </li><br>
- <li><a href="#readingFnAttributes">readingFnAttributes</a>
- </li><br>
- </ul>
- </ul>
- </div>
- <p><a name="structure"></a>
- <h3>structure</h3>
- <div class='langLinks'>[<a href='commandref.html#structure'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="structuredefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> structure <struct_type> <dev1>
- <dev2> ...</code> <br><br>
- Mit dem Device "Structure" werden Strukturen/Zusammenstellungen von anderen
- Devices erstellt um sie zu Gruppen zusammenzufassen. (Beispiel: im Haus
- alles ausschalten) <br>
- Die Liste der Devices die einer Struktur zugeordnet sind kann duch das
- Kommando <code>addstruct / delstruct</code> im laufenden Betrieb
- verändert werden. Es können sowohl einzelne Devices als auch
- Gruppen von Devices (TYPE=FS20) zugefügt werden. Jedes zugefügt
- Device erhält zwei neue Attribute <struct_type>=<name>
- sowie <struct_type>_map wenn es zu einer Struktur zugefügt
- wurde. Diese Attribute werden wieder automatisch entfernt, sobald das
- Device von der Struktur entfernt wird.<br>
- Eine Struktur kann ebenfalls zu einer anderen Struktur zugefügt
- werden. Somit können z b. kaskadierende Strukturen erstellt werden.
- (Z.b. KG,EG,OG, Haus)
- Beispiel:<br>
- <ul>
- <li>define Kueche structure room lampe1 lampe2</li>
- <li>addstruct Kueche TYPE=FS20</li>
- <li>delstruct Kueche lampe1</li>
- <li>define house structure building kitchen living</li>
- <li>set house off</li>
- </ul>
- <br>
- </ul>
- <br>
- <a name="structureset"></a>
- <b>Set</b>
- <ul>
- <li>saveStructState <readingName><br>
- Der Status (genauer: state Reading) aller Mitglieder wird im angegebenen
- Reading Komma separiert gespeichert.
- </li><br>
- <li>restoreStructState <readingName><br>
- Der Status der Mitglieder wird aus dem angegebenen Reading gelesen, und
- via "set Mitgliedsname StatusWert" gesetzt.
- </li><br>
- Jedes andere set Kommando wird an alle Devices dieser Struktur
- weitergegeben.<br>
- Aussnahme: das Attribut structexclude ist in einem Device definiert und
- dessen Attributwert matched als Regexp zum Namen der aktuellen
- Struktur.<br> Wenn das set Kommando diese Form hat <code>set
- <structure> [FILTER=<filter>] <type-specific></code> wird
- :FILTER=<filter> bei der Weitergebe der set an jeden Devicenamen wie
- folgt angehängt: <code>set <devN>:FILTER=<filter>
- <type-specific></code><br>
- Falls der letzte Parameter reverse ist, dann werden die Befehle in der
- umgekehrten Reihenfolge ausgeführt.
- </ul>
- <br>
- <a name="structureget"></a>
- <b>Get</b>
- <ul>
- Get wird im Structur-Device nicht unterstützt.
- </ul>
- <br>
- <a name="structureattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="async_delay"></a>
- <li>async_delay<br>
- Wenn dieses Attribut gesetzt ist, werden ungefilterte set Kommandos nicht
- sofort an die Clients weitergereicht. Stattdessen werden sie einer
- Warteschlange hinzugefügt, um später ausgeführt zu werden.
- Das set Kommando kehrt sofort zurück, die Clients werden danach
- timer-gesteuert einzeln abgearbeitet. Die Zeit zwischen den
- Timer-Aufrufen ist dabei durch den Wert von async_delay (in Sekunden)
- gegeben, ein Wert von 0 entspricht der schnellstmöglichen Abfolge.
- So können besonders lange Verzögerungen, die gerade bei
- großen structures vorkommen können, in unproblematischere
- Häppchen zerlegt werden.
- </li>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <a name="clientstate_behavior"></a>
- <li>clientstate_behavior<br>
- Der Status einer Struktur hängt von den Status der zugefügten
- Devices ab. Dabei wird das propagieren der Status der Devices in zwei
- Gruppen klassifiziert und mittels diesem Attribut definiert:
- <ul>
- <li>absolute<br>
- Die Struktur wird erst dann den Status der zugefügten Devices
- annehmen, wenn alle Devices einen identischen Status vorweisen. Bei
- unterschiedlichen Devictypen kann dies per Attribut
- <struct_type>_map pro Device beinflusst werden. Andernfalls hat
- die Struktur den Status "undefined".
- </li>
- <li>relative<br>
- S.u. clientstate_priority.
- </li>
- <li>relativeKnown<br>
- wie relative, reagiert aber nicht auf unbekannte, in
- clientstate_priority nicht beschriebene Ereignisse. Wird für
- HomeMatic Geräte benötigt.
- </li>
- <li>last<br>
- Die Struktur übernimmt den Status des zuletzt geänderten
- Gerätes.
- </li>
- </ul>
- </li>
- <a name="clientstate_priority"></a>
- <li>clientstate_priority<br>
- Wird die Struktur auf ein relatives Verhalten eingestellt, so wird die
- Priorität der Devicestatus über das Attribut
- <code>clientstate_priority</code> beinflusst. Die Prioritäten sind
- in absteigender Reihenfolge anzugeben. Dabei können Gruppen mit
- identischer Priorität angegeben werden, um zb. unterschiedliche
- Devicetypen zusammenfassen zu können. Jede Gruppe wird durch
- Leerzeichen oder /, jeder Eintrag pro Gruppe durch Pipe getrennt. Der
- Status der Struktur ist der erste Eintrag in der entsprechenden Gruppe.
- <br>Beispiel:
- <ul>
- <li>attr kueche clientstate_behavior relative</li>
- <li>attr kueche clientstate_priority An|On|on Aus|Off|off</li>
- <li>attr haus clientstate_priority Any_On|An All_Off|Aus</li>
- </ul>
- In diesem Beipiel nimmt die Struktur <code>kueche</code>entweder den
- Status <code>An</code> oder <code>Aus</code> an. Die Struktur
- <code>haus</code> nimmt entweder den Status <code>Any_on</code> oder
- <code>All_off</code> an. Sobald ein Device der Struktur
- <code>haus</code> den Status <code>An</code> hat nimmt die Struktur den
- Status <code>Any_On</code> an. Um dagegen den Status <code>All_off</code>
- anzunehmen, müssen alle Devices dieser Struktur auf <code>off</code>
- stehen.
- </li>
- <li><struct_type>_map<br>
- Mit diesem Attribut, das dem Struktur-<b>Mitglied</b> zugewiesen werden
- muss, koennen die Werte, die die einzelnen Struktur- Mitglieder melden,
- umdefiniert werden, damit man unterschiedliche Geraeteklassen
- zusammenfassen kann. Es existieren drei Varianten:
- <ul>
- <li>readingName<br>
- nehme den Wert von readingName anstatt von state
- </li>
- <li>oldVal:newVal<br>
- falls der Wert der state Reading oldVal (als regex) ist, dann ersetze
- diesen mit newVal.
- </li>
- <li>readingName:oldVal:newVal<br>
- falls der Wert der readingName oldVal (als regex) ist, dann ersetze
- diesen mit newVal.
- </li>
- </ul>
- Beispiel:<br>
- <ul>
- <li>define tuer OWSWITCH <ROMID></li>
- <li>define lampe1 dummy</li>
- <li>attr lampe1 cmdlist on off</li>
- <li>define kueche structure struct_kitchen lamp1 door</li>
- <li>attr kueche clientstate_priority An|on OK|Aus|off</li>
- <li>attr lampe1 struct_kitchen_map on:An off:Aus</li>
- <li>attr tuer struct_kitchen_map A:open:on A:closed:off</li>
- <li>attr tuer2 struct_kitchen_map A</li>
- </ul>
- </li>
- <a name="evaluateSetResult"></a>
- <li>evaluateSetResult<br>
- Falls ein set Befehl den Status der Struktur-Mitglieder auf was
- unterschiedliches setzt (wie z.Bsp. beim set statusRequest), dann muss
- dieses Attribut auf 1 gesetzt werden, wenn die Struktur Instanz diesen
- neuen Status auswerten soll.
- </li>
- <li>structexclude<br>
- Bei gesetztem Attribut wird set, attr/deleteattr ignoriert. Dies
- trifft ebenfalls auf die Weitergabe des Devicestatus an die Struktur zu.
- Fuer set und fuer die Status-Weitergabe muss der Wert den Strukturnamen
- matchen, bei einem Attribut-Befehl die Kombination
- Strukturname:Attributname.
- Beispiel:
- <ul>
- <code>
- define kitchen structure room lamp1 lamp2<br>
- attr lamp1 structexclude kitchen<br>
- attr lamp1 structexclude kitchen:stateFormat<br>
- </code>
- </ul>
- </li>
- <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
- </ul>
- <br>
- </ul>
- <p><a name="tahoma"></a>
- <h3>tahoma</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#tahoma'>tahoma</a><br/>
- </ul>
- <a name="telnet"></a>
- <h3>telnet</h3>
- <div class='langLinks'>[<a href='commandref.html#telnet'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="telnetdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> telnet <portNumber>
- [global|hostname]</code><br> oder<br>
- <code>define <name> telnet <servername>:<portNummer></code>
- <br><br>
- Erste Form, <b>Server</b>-mode:<br>
- Überwacht den TCP/IP-Port <code><portNummer></code> auf
- ankommende Verbindungen. Wenn der zweite Parameter <b>nicht</b>
- angegeben wird, wird der Server nur auf Verbindungen von localhost achten.
- Falls der zweite Parameter global ist, dann wird telnet auf allen lokalen
- Netzwerk-Interfaces zuhören, ansonsten wird der Parameter als Hostname
- oder Adresse interpretiert, und nur diese lokale Adresse bedient.
- <br>
- Für den Gebrauch von IPV6 muss die Portnummer als IPV6:<nummer>
- angegeben werden, in diesem Fall wird das Perl-Modul IO::Socket:INET6
- angesprochen. Unter Linux kann es sein, dass dieses Modul mittels cpan -i
- IO::Socket::INET6 oder apt-get libio-socket-inet6-perl nachinstalliert werden
- muss; OSX und Fritzbox-7390 enthalten bereits dieses Modul.<br>
- Beispiele:
- <ul>
- <code>define tPort telnet 7072 global</code><br>
- <code>attr tPort SSL</code><br>
- <code>attr allowed_tPort allowed</code><br>
- <code>attr allowed_tPort validFor tPort</code><br>
- <code>attr allowed_tPort globalpassword mySecret</code><br>
- </ul>
- Hinweis: Das alte (pre 5.3) "global attribute port" wird automatisch in
- eine telnet-Instanz mit dem Namen telnetPort umgewandelt. Im Rahmen dieser
- Umwandlung geht das globale Attribut allowfrom verloren.
- <br><br>
- Zweite Form, <b>Client</b>-mode:<br>
- Verbindet zu einem angegebenen Server-Port und führt die von dort aus
- empfangenen Anweisungen - genau wie im Server-mode - aus. Dies kann
- verwendet werden, um sich mit einer fhem-Instanz, die sich hinter einer
- Firewall befindet, zu verbinden, für den Fall, wenn das Installieren
- von Ausnahmen in der Firewall nicht erwünscht oder nicht möglich
- sind. Hinweis: Dieser Client-mode unterstützt zwar SSL, aber nicht
- IPV6.<br>
- Beispiel:
- <ul>
- Starten von tcptee auf einem öffentlich erreichbaren Host ausserhalb
- der Firewall:<ul>
- <code>perl contrib/tcptee.pl --bidi 3000</code></ul>
- Konfigurieren von fhem innerhalb der Firewall:<ul>
- <code>define tClient telnet <tcptee_host>:3000</code></ul>
- Verbinden mit fhem (hinter der Firewall) von ausserhalb der Firewall:<ul>
- <code>telnet <tcptee_host> 3000</code></ul>
- </ul>
- </ul>
- <br>
- <a name="telnetset"></a>
- <b>Set</b> <ul>N/A</ul><br>
- <a name="telnetget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="telnetattr"></a>
- <b>Attribute</b>
- <ul>
- <a name="prompt"></a>
- <li>prompt<br>
- Gibt die Zeichenkette an, welche in der Telnet-Sitzung als
- Kommandoprompt ausgegeben wird. Die Voreinstellung ist fhem>
- </li><br>
- <a name="SSL"></a>
- <li>SSL<br>
- SSL-Verschlüsselung für eine Verbindung aktivieren. <a
- href="#HTTPS">Hier</a> gibt es eine Beschreibung, wie das erforderliche
- SSL-Zertifikat generiert werden kann. Um eine Verbindung mit solch
- einem Port herzustellen, sind folgende Befehle möglich:
- <ul>
- <code>
- socat openssl:fhemhost:fhemport,verify=0 readline<br>
- ncat --ssl fhemhost fhemport<br>
- openssl s_client -connect fhemhost:fhemport<br>
- </code>
- </ul>
- </li><br>
- <a name="allowfrom"></a>
- <li>allowfrom<br>
- Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut
- gesetzt wurde, werden ausschließlich Verbindungen von diesen
- Adressen akzeptiert.<br>
- Achtung: falls allowfrom nicht gesetzt ist, und keine gütige
- allowed Instanz definiert ist, und die Gegenstelle eine nicht lokale
- Adresse hat, dann wird die Verbindung abgewiesen. Folgende Adressen
- werden als local betrachtet:
- <ul>
- IPV4: 127/8, 10/8, 192.168/16, 172.16/10, 169.254/16<br>
- IPV6: ::1, fe80/10<br>
- </ul>
- </li><br>
- <a name="connectTimeout"></a>
- <li>connectTimeout<br>
- Gibt die maximale Wartezeit in Sekunden an, in der die Verbindung
- aufgebaut sein muss. Standardwert ist 2.
- </li><br>
- <a name="connectInterval"></a>
- <li>connectInterval<br>
- Gibt die Dauer an, die entweder nach Schließen einer Verbindung
- oder für den Fall, dass die Verbindung nicht zustande kommt,
- gewartet werden muss, bis ein erneuter Verbindungsversuch gestartet
- werden soll. Standardwert ist 60.
- </li><br>
- <a name="encoding"></a>
- <li>encoding<br>
- Bezeichnet die Zeichentabelle für die zum Client gesendeten Daten.
- Mögliche Werte sind utf8 und latin1. Standardwert ist utf8.
- </li><br>
- <li>sslVersion<br>
- Siehe das global Attribut sslVersion.
- </li><br>
- </ul>
- </ul>
- <p><a name="template"></a>
- <h3>template</h3>
- <div class='langLinks'>[<a href='commandref.html#template'>EN</a> DE]</div>
- <ul>
- <code>template [use|show] <filename> [<param1>=<value1> [<param2>=<value2> [...]]]</code>
- <br><br>
- Includes a file with parameter substitution, i.e. read the file and process every line as a FHEM command.
- For any given parameter/value pair <code><param>=<value></code> on the command line,
- a literal <code>%<param>%</code> in the file is replaced by <value> before executing the command.<br><br>
- This can be used to to code recurring definitions of one or several devices only once and use it many times.
- <code>template show ..</code> shows what would be done, including a parameter listing, while
- <code>template use ...</code> actually does the job. The word <code>use</code> can be omitted.<br><br>
-
- <b>Example</b><br><br>
-
- File <i>H.templ</i>:<br><br>
- <code>
- define %name% FHT %fhtcode%<br>
- attr %name% IODev CUN<br>
- attr %name% alias %alias%<br>
- attr %name% group %group%<br>
- attr %name% icon icoTempHeizung.png<br>
- attr %name% room %room%,Anlagen/Heizungen<br>
- <br>
- define watchdog.%name% watchdog %name% 00:15:00 SAME set %name% report2 255<br>
- attr watchdog.%name% group %group%<br>
- attr watchdog.%name% room Control/Heizungen<br>
- <br>
- define %name%.log FileLog /opt/fhem/log/%name%-%Y%m.log %name%:.*<br>
- attr %name%.log group %group%<br>
- attr %name%.log icon icoLog.png<br>
- attr %name%.log logtype fht<br>
- attr %name%.log room Control/Heizungen<br>
- <br>
- define %name%.weblink SVG %name%.log:%name%:CURRENT<br>
- attr %name%.weblink label sprintf("Temperatur: %.0f °C (%.0f °C .. %.0f °C) Aktor: %.0f %% (%.0f %% .. %.0f %%)", $data{currval1}, $data{min1}, $data{max1}, $data{currval2}, $data{min2}, $data{max2} )<br>
- attr %name%.weblink room %room%<br>
- attr %name%.weblink alias %alias%<br>
- </code><br><br>
-
- Configuration:<br><br>
-
- <code>te H.templ name=3.dz.hzg fhtcode=3f4a alias=Dachzimmerheizung group=Heizung room=Dachzimmer</code><br><br>
-
- Please note that although %Y% in the FileLog definition looks like a parameter, it is not substituted since no parameter
- Y is given on the command line. You get detailed information at verbosity level 5 when you run the command.
-
- </ul>
- <p><a name="update"></a>
- <h3>update</h3>
- <div class='langLinks'>[<a href='commandref.html#update'>EN</a> DE]</div>
- <ul>
- <code>update [<fileName>|all|check|force]
- [http://.../controlfile]</code>
- <br>oder<br>
- <code>update [add source|delete source|list|reset]</code>
- <br>
- <br>
- Erneuert die FHEM Installation. D.h. es wird (werden) zuerst die
- Kontroll-Datei(en) heruntergeladen, und mit der lokalen Version dieser Datei
- in moddir/FHEM verglichen. Danach werden alle in der Kontroll-Datei
- spezifizierten Dateien heruntergeladen, deren Größe oder
- Zeitstempel sich unterscheidet. Wenn dieser Ablauf abgeschlossen ist, wird
- das globale UPDATE Ereignis ausgelöst.
- <br>
- Mit den Befehlen add/delete/list/reset kann man die Liste der Kontrolldateien
- pflegen.
- <br>
- <br>
- Zu beachten:
- <ul>
- <li>Das contrib Verzeichnis wird nicht heruntergeladen.</li>
- <li>Die Dateien werden auf der Webseite einmal am Tag um 07:45 MET/MEST aus
- der Quell-Verwaltungssystem (SVN) bereitgestellt.</li>
- <li>Das all Argument ist die Voreinstellung.</li>
- <li>Das force Argument beachtet die lokale controls_fhem.txt Datei
- nicht.</li>
- <li>Das check Argument zeigt die neueren Dateien an, und den letzten
- Abschnitt aus der CHANGED Datei</li>
- <li>Falls man <fileName> spezifiziert, dann werden nur die Dateien
- heruntergeladen, die diesem Regexp entsprechen.</li>
- </ul>
- Siehe also das restore Befehl.<br>
- <br>
- Beispiele:<br>
- <ul>
- <li>update check</li>
- <li>update</li>
- <li>update force</li>
- <li>update check http://fhem.de/fhemupdate/controls_fhem.txt</li>
- </ul>
- <a name="updateattr"></a>
- <br>
- <b>Attribute</b> (sind mit attr global zu setzen)
- <ul>
- <a name="updateInBackground"></a>
- <li>updateInBackground<br>
- Wenn dieses Attribut gesetzt ist, wird das update Befehl in einem
- separaten Prozess ausgeführt, und alle Meldungen werden per Event
- übermittelt. In der telnet Sitzung wird inform, in FHEMWEB wird
- das Event Monitor aktiviert. Die Voreinstellung ist an, zum
- Deaktivieren bitte Attribut auf 0 setzen.
- </li><br>
- <a name="updateNoFileCheck"></a>
- <li>updateNoFileCheck<br>
- Wenn dieses Attribut gesetzt ist, wird die Größe der bereits
- vorhandenen, lokalen Datei nicht mit der Sollgröße
- verglichen. Dieses Attribut wurde nach nicht genau spezifizierten Wnsch
- erfahrener FHEM Benutzer eingefuehrt, die Voreinstellung ist 0.
- </li><br>
- <a name="backup_before_update"></a>
- <li>backup_before_update<br>
- Wenn dieses Attribut gesetzt ist, erstellt FHEM eine Sicherheitskopie
- der FHEM Installation vor dem update mit dem backup Befehl. Die
- Voreinstellung is "nicht gesetzt", da update sich auf das restore
- Feature verlässt, s.u.<br>
- Beispiel:<br>
- <ul>
- attr global backup_before_update
- </ul>
- </li><br>
- <a name="exclude_from_update"></a>
- <li>exclude_from_update<br>
- Enthält eine Liste durch Leerzeichen getrennter Dateinamen
- (regexp), welche nicht im update berücksichtigt werden.<br>
- Falls der Wert commandref enthält, dann wird commandref_join.pl
- nach dem update nicht aufgerufen, d.h. die Gesamtdokumentation ist
- nicht mehr aktuell. Die Moduldokumentation bleibt weiterhin aktuell.
- <br>
- Beispiel:<br>
- <ul>
- attr global exclude_from_update 21_OWTEMP.pm temp4hum4.gplot
- </ul>
- Der Regexp wird gegen den Dateinamen und gegen Quelle:Dateiname
- geprüft. Um die Datei FILE.pm von updates von fhem.de
- auszuschließen, weil sie von einer anderen Quelle bezogen wird,
- kann man fhem.de.*:FILE.pm spezifizieren.
- </li><br>
- <li><a href="#restoreDirs">restoreDirs</a></li><br>
- </ul>
- </ul>
- <p><a name="uptime"></a>
- <h3>uptime</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#uptime'>uptime</a><br/>
- </ul>
- <a name="version"></a>
- <h3>version</h3>
- <div class='langLinks'>[<a href='commandref.html#version'>EN</a> DE]</div>
- <ul>
- <code>version [<filter>|revision] [noheader]</code>
- <br><br>
- Gibt die Versionsinformation von fhem.pl und aller geladenen Module aus. Mit
- dem optionalen Parameter kann man die Ausgabe filtern. Der spezielle Filterwert "revision"
- zeigt nur die aktuellste Revisions-Nummer seit dem letzten Update an.
- <br><br>
- Der optionale Parameter <code>noheader</code> unterdrückt die Ausgabe des Listenkopfs (Latest Revision, File, Rev, Last Change).
- <br><br>
- Wenn dieser Befehl über die FHEMWEB-Kommandozeile eingegeben wird, werden zusätzlich alle aktuell geladenen JavaScript-Dateien mit ihren zugehörigen Versionsinformationen angezeigt.
- <br><br>
- Beispiel der Ausgabe von <code>version</code>:
- <ul>
- <code><br>
- Latest Revision: 10814<br><br>
- File Rev Last Change<br><br>
- fhem.pl 10769 2016-02-08 12:11:51Z rudolfkoenig<br>
- 90_at.pm 10048 2015-11-29 14:51:40Z rudolfkoenig<br>
- 98_autocreate.pm 10165 2015-12-13 11:14:15Z rudolfkoenig<br>
- 00_CUL.pm 10146 2015-12-10 10:17:42Z rudolfkoenig<br>
- 10_CUL_HM.pm 10411 2016-01-08 15:18:17Z martinp876<br>
- ...
- </code>
- </ul>
- <br>
- Beispiel der Ausgabe von <code>version fhem</code>:
- <ul>
- <code><br>
- File Rev Last Change<br><br>
- fhem.pl 10769 2016-02-08 12:11:51Z rudolfkoenig<br>
- </code>
- </ul>
- <br>
- Beispiel der Ausgabe von <code>version fhem.pl noheader</code>:
- <ul>
- <code><br>
- fhem.pl 10769 2016-02-08 12:11:51Z rudolfkoenig<br>
- </code>
- </ul>
- </ul>
- <p><a name="watchdog"></a>
- <h3>watchdog</h3>
- <div class='langLinks'>[<a href='commandref.html#watchdog'>EN</a> DE]</div>
- <ul>
- <br>
- <a name="watchdogdefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> watchdog <regexp1> <timespec>
- <regexp2> <command></code><br>
- <br>
- Startet einen beliebigen FHEM Befehl wenn nach dem Empfang des
- Ereignisses <regexp1> nicht innerhalb von <timespec> ein
- <regexp2> Ereignis empfangen wird.<br>
- Der Syntax für <regexp1> und <regexp2> ist der gleiche wie
- regexp für <a href="#notify">notify</a>.<br>
- <timespec> ist HH:MM[:SS]<br>
- <command> ist ein gewöhnlicher fhem Befehl wie z.B. in <a
- href="#at">at</a> oderr <a href="#notify">notify</a>
- <br><br>
- Beispiele:
- <code><ul>
- # Frage Daten vom FHT80 _einmalig_ ab, wenn wir keine Nachricht für<br>
- # 15 Minuten erhalten haben.<br>
- define w watchdog FHT80 00:15:00 SAME set FHT80 date<br><br>
- # Frage Daten vom FHT80 jedes Mal ab, wenn keine Nachricht für<br>
- # 15 Minuten emfpangen wurde, d.h. reaktiviere den Watchdog nachdem er
- getriggert wurde.<br>
- # Kann gefährlich sein, da er so in einer Schleife getriggert werden
- kann.<br>
- define w watchdog FHT80 00:15:00 SAME set FHT80 date;; trigger w .<br><br>
- # Alarmiere einmalig wenn vom HMS100-FIT für eine Stunde keine
- Nachricht empfangen wurde.<br>
- define w watchdog HMS100-FIT 01:00 SAME "alarm-fit.sh"<br><br>
- # Sende eine Mail wenn das Fenster offen gelassen wurde<br>
- define w watchdog contact1:open 00:15 contact1:closed "mail_me close
- window1"<br>
- attr w regexp1WontReactivate<br><br>
- </ul></code>
- Hinweise:<br>
- <ul>
- <li>Wenn <regexp1> . (Punkt) ist, dann aktiviere den Watchdog zur
- definierten Zeit. Sonst wird er durch den Empfang des ersten passenden
- Events aktiviert.</li>
- <li><regexp1> Resetet den Timer eines laufenden Watchdogs. Um das
- zu verhindern wird das regexp1WontReactivate Attribut gesetzt.</li>
- <li>Wenn <regexp2> SAME ist , dann ist es das gleiche wie das erste
- regexp, und wird reaktiviert wenn es empfangen wird. </li>
- <li>trigger <watchdogname> . aktiviert den Trigger wenn dessen
- Status defined ist und setzt ihn in den Status defined wenn sein status
- triggered oder aktiviert (Next:...) ist.<br>
- Der Watchdog musst immer mit diesem Befehl reaktiviert werden wenn er
- getriggert wurde.</li>
- <li>Ein generischer Watchdog (ein Watchdog, verantwortlich für
- mehrere Devices) ist derzeit nicht möglich.</li>
- <li>Bei modify sind alle Parameter optional, und werden nicht geaendert,
- falls nicht spezifiziert.</li>
- </ul>
- <br>
- </ul>
- <a name="watchdogset"></a>
- <b>Set </b>
- <ul>
- <li>inactive<br>
- Deaktiviert das entsprechende Gerät. Beachte den leichten
- semantischen Unterschied zum disable Attribut: "set inactive"
- wird bei einem shutdown automatisch in fhem.state gespeichert, es ist
- kein save notwendig.<br>
- Der Einsatzzweck sind Skripte, um das notify temporär zu
- deaktivieren.<br>
- Das gleichzeitige Verwenden des disable Attributes wird nicht empfohlen.
- </li>
- <li>active<br>
- Aktiviert das entsprechende Gerät, siehe inactive.
- </li>
- </ul>
- <br>
- <a name="watchdogget"></a>
- <b>Get</b> <ul>N/A</ul><br>
- <a name="watchdogattr"></a>
- <b>Attribute</b>
- <ul>
- <li><a href="#addStateEvent">addStateEvent</a></li>
- <li><a href="#disable">disable</a></li>
- <li><a href="#disabledForIntervals">disabledForIntervals</a></li>
- <li><a name="regexp1WontReactivate">regexp1WontReactivate</a><br>
- Wenn ein Watchdog aktiv ist, wird ein zweites Ereignis das auf regexp1
- passt normalerweise den Timer zurücksetzen. Dieses Attribut wird
- das verhindern.</li>
- <li><a href="#execOnReactivate">execOnActivate</a>
- Falls gesetzt, wird der Wert des Attributes als FHEM Befehl
- ausgeführt, wenn ein regexp1 Ereignis den Watchdog
- aktiviert nachdem er ausgelöst wurde.</li>
- <li><a href="#autoRestart">autoRestart</a>
- Wenn dieses Attribut gesetzt ist, wird der Watchdog nach dem er
- getriggert wurde, automatisch wieder in den Zustand defined
- gesetzt (Wartet also wieder auf Aktivierung durch regexp1)</li>
- </ul>
- <br>
- </ul>
- <p><a name="weblink"></a>
- <h3>weblink</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#weblink'>weblink</a><br/>
- </ul>
- <a name="weekprofile"></a>
- <h3>weekprofile</h3>
- <div class='langLinks'>[<a href='commandref.html#weekprofile'>EN</a> DE]</div>
- <ul>
- Beschreibung im Wiki: http://www.fhemwiki.de/wiki/Weekprofile
-
- Mit dem Modul 'weekprofile' können mehrere Wochenprofile verwaltet und an unterschiedliche Geräte
- übertragen werden. Aktuell wird folgende Hardware unterstützt:
- <li>alle MAX Thermostate</li>
- <li>andere weekprofile Module</li>
- <li>Homatic (Kanal _Clima bzw. _Climate)</li>
-
- Im Standardfall wird das Modul mit einem Geräte = 'Master-Gerät' assoziiert,
- um das Wochenprofil vom Gerät grafisch bearbeiten zu können und andere Profile auf das Gerät zu übertragen.
- Wird kein 'Master-Gerät' angegeben, wird erstmalig ein Default-Profil angelegt.
- <br>
- Ein weiterer Anwendungsfall ist die Verwendung von Rubriken\Kategorien 'Topics'.
- Hier sollte kein 'Master-Gerät' angegeben werden. Dieses Feature muss erst über das Attribut 'useTopics' aktiviert werden.
- Topics sind z.B. Winter, Sommer, Urlaub, Party, etc.
- Innerhalb einer Topic kann es mehrere Wochenprofile geben. Sinnvollerweise sollten es soviele wie Thermostate sein.
- Über ein Userattribut 'weekprofile' im Thermostat wird ein Wochenprofile ohne Topicname angegeben.
- Mittels 'restore_topic' wird dann das angebene Wochenprofil der Topic an das Thermostat übertragen.
- Somit kann man einfach zwischen den Topics wechseln und die Thermostate bekommen das passende Wochenprofil.
- <br><br>
- <b>Achtung:</b> Das Übertragen von Wochenprofilen erfordet eine Menge an Credits.
- Dies wird vom Modul nicht berücksichtigt. So kann es sein, dass nach dem
- Setzen\Aktualisieren eines Profils das Profil im Modul nicht mit dem Profil im Gerät
- übereinstimmt solange das komplette Profil übertragen wurde.
- <br>
- Beim Homatic HM-TC-IT-WM-W-EU wird nur das 1. Profil (R_P1_...) genommen!
- <br>
- <b>Für das Module wird libjson-perl benötigt</b>
- <br><br>
- <b>Events:</b><br>
- Aktuell werden folgende Events erzeugt:<br>
- <li>PROFILE_TRANSFERED: wenn ein Profil oder Teile davon zu einem Gerät gesended wurden</li>
- <li>PROFILES_SAVED: wenn Profile in die Konfigurationsdatei gespeichert wurden (auch wenn es keine Änderung gab!)</li>
- <a name="weekprofiledefine"></a>
- <b>Define</b>
- <ul>
- <code>define <name> weekprofile [master device]</code><br>
- <br>
- Aktiviert das Modul. Bei der Angabe eines 'Master-Gerätes' wird das Profil 'master'
- entprechende dem Wochenrofil vom Gerät angelegt.
- Sonderbehandlung des 'master' Profils:
- <li>Kann nicht gelöscht werden</li>
- <li>Bei Ändern\Setzen des Proils wird es automatisch an das 'Master-Geräte' gesendet</li>
- <li>Es wird sind mit abgespeicht</li>
- <br>
- Wird kein 'Master-Geräte' angegeben, wird ein 'default' Profil angelegt.
- </ul>
-
- <a name="weekprofileset"></a>
- <b>Set</b>
- <ul>
- <li>profile_data<br>
- <code>set <name> profile_data <profilname> <json data> </code><br>
- Es wird das Profil 'profilname' geändert. Die Profildaten müssen im json-Format übergeben werden.
- </li>
- <li>send_to_device<br>
- <code>set <name> send_to_device <profilname> [devices] </code><br>
- Das Profil wird an ein oder mehrere Geräte übertragen. Wird kein Gerät angegeben, wird das 'Master-Gerät' verwendet.
- 'Devices' ist eine kommagetrennte Auflistung von Geräten
- </li>
- <li>copy_profile<br>
- <code>set <name> copy_profile <quelle> <ziel> </code><br>
- Kopiert das Profil 'quelle' auf 'ziel'. 'ziel' wird überschrieben oder neu angelegt.
- </li>
- <li>remove_profile<br>
- <code>set <name> remove_profile <profilname> </code><br>
- Das Profil 'profilname' wird gelöscht.
- </li>
- <li>reference_profile<br>
- <code>set <name> reference_profile <quelle> <ziel> </code><br>
- Referenziert das Profil 'ziel'auf 'quelle'. 'ziel' wird überschrieben oder neu angelegt.
- </li>
- <li>restore_topic<br>
- <code>set <name> restore_topic <topic></code><br>
- Alle Wochenpläne in der Topic werden zu den entsprechenden Geräten übertragen.
- Dazu muss im Gerät ein Userattribut 'weekprofile' mit dem Namen des Wochenplans <b>ohne</b> Topic gesetzt sein.
- </li>
- <li>reread_master<br>
- Aktualisiert das master profile indem das 'Master-Geräte' neu ausgelesen wird.
- </li>
- </ul>
-
- <a name="weekprofileget"></a>
- <b>Get</b>
- <ul>
- <li>profile_data<br>
- <code>get <name> profile_data <profilname> </code><br>
- Liefert die Profildaten von 'profilname' im json-Format
- </li>
- <li>profile_names<br>
- <code>set <name> profile_names [topic_name]</code><br>
- Liefert alle Profilnamen getrennt durch ',' einer Topic 'topic_name'
- Ist 'topic_name' gleich '*' werden alle Profilnamen zurück gegeben.
- </li>
- <li>profile_references [name]<br>
- Liefert eine Liste von Referenzen der Form <br>
- <code>
- ref_topic:ref_profile>dest_topic:dest_profile
- </code>
- Ist name 'topicname:profilename' wird '0' der Name der Referenz zurück gegeben.
- </li>
- </ul>
-
- <a name="weekprofilereadings"></a>
- <p><b>Readings</b></p>
- <ul>
- <li>active_topic<br>
- Aktive\zuletzt gesetzter Topicname.
- </li>
- <li>profile_count<br>
- Anzahl aller Profile mit Referenzen.
- </li>
- </ul>
-
- <a name="weekprofileattr"></a>
- <b>Attribute</b>
- <ul>
- <li>widgetTranslations<br>
- Liste von Übersetzungen der Form <german>:<Übersetzung> getrennt durch ',' um Texte im Widget zu übersetzen.
- <code>attr name widgetTranslations Abbrechen:Abbr,Speichern:Save</code>
- </li>
- <li>widgetWeekdays<br>
- Liste von Wochentagen getrennt durch ',' welche im Widget angzeigt werden.
- Beginnend bei Montag. z.B.
- <code>attr name widgetWeekdays Montag,Dienstag,Mittwoch,Donnerstag,Freitag,Samstag,Sonntag</code>
- </li>
- <li>widgetEditDaysInRow<br>
- Anzahl in der in einer Reihe dargestellten Tage während der Bearbeitung. Default 2.<br>
- </li>
- <li>widgetEditOnNewPage<br>
- Wenn gesetzt ('1'), dann wird die Bearbeitung auf einer separaten\neuen Webseite gestartet.
- </li>
- <li>configFile<br>
- Pfad und Dateiname wo die Profile gespeichert werden sollen.
- Default: ./log/weekprofile-<name>.cfg
- </li>
- <li>icon<br>
- Änders des Icons zum Bearbeiten
- Default: edit_settings
- </li>
- <li>useTopics<br>
- Verwendung von Topic aktivieren.
- </li>
- <li>tempON<br>
- Temperature für 'on'. z.B. 30
- </li>
- <li>tempOFF<br>
- Temperature für 'off'. z.B. 4
- </li>
- </ul>
-
- </ul>
- <p><a name="withings"></a>
- <h3>withings</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#withings'>withings</a><br/>
- </ul>
- <a name="xs1Bridge"></a>
- <h3>xs1Bridge</h3>
- <div class='langLinks'>[<a href='commandref.html#xs1Bridge'>EN</a> DE]</div>
- <ul>
- Mit diesem Modul können Sie das Gerät xs1 der Firma <a href="http://www.ezcontrol.de/">EZcontrol</a> auslesen. Das Modul ruft die Daten des xs1 via der Kommunikationsschnittstelle ab. Mit einem HTTP GET Requests erhält man die Antworten in Textform welche im Datenformat JSON (JavaScript Object Notation) ausgegeben werden.
- Es werden Aktoren | Sensoren | Timer | Informationen vom xs1 ausgelesen und in Readings geschrieben. Bei jedem Auslesen werden nur Readings angelegt bzw. aktualisiert, welche auch im xs1 definiert und aktiv sind. Aktor | Sensor bzw. Timer Definitionen welche deaktiviert sind im xs1, werden NICHT ausgelesen.
- <br><br>
- Das Modul wurde entwickelt basierend auf dem Firmwarestand v4-Beta des xs1. Es kann aufgrund von unterschiedlichen Anpassungen innerhalb der Firmware des Herstellers zu Fehlern kommen.<br>
- Getestete Firmware: v4.0.0.5326 (Beta) @me | v3.0.0.4493 @ForumUser<br><br>
- <a name="xs1Bridge_define"></a>
- <b>Define</b><br>
- <ul>
- <code>define <NAME> xs1Bridge <IP></code>
- <br><br>
- Ein anlegen des Modules ohne Angabe der IP vom xs1 ist nicht möglich. Sollte die IP bei der Moduldefinierung nicht erreichbar sein, so bricht der Define Vorgang ab.
- <ul>
- <li><code><IP></code> ist IP-Adresse im lokalen Netzwerk.</li>
- </ul><br>
- Beispiel:
- <ul>
- define EZcontrol_xs1 xs1Bridge 192.168.1.45
- </ul>
- </ul><br>
- <b>Set</b>
- <ul>N/A</ul><br>
- <b>Get</b><br>
- <ul>N/A</ul><br>
- <a name="xs1_attr"></a>
- <b>Attribute</b>
- <ul>
- <li>debug (0,1)<br>
- Dies bringt das Modul in eine sehr ausführliche Debug-Ausgabe im Logfile. Somit lassen sich Programmteile kontrollieren und Fehler überprüfen.<br>
- (Default, debug 0)
- </li><br>
- <li>disable (0,1)<br>
- Diese Funktion deaktiviert den Interval. Mit <code>disable 1</code> werden keine Readings aktualisiert.<br>
- (Default, disable 0)
- </li><br>
- <li>interval (30,60,180,360)<br>
- Das ist der Intervall in Sekunden, in dem die Readings neu gelesen werden vom xs1.<br>
- <i>Bei Aktoren werden nur unterschiedliche Zustände aktualisiert im eingestellten Intervall.</i><br>
- <i>Sensoren werden unabhängig vom Zustand immer im Intervall aktualisiert.</i><br>
- (Default, interval 60)
- </li><br>
- <li>update_only_difference (0,1)<br>
- Die Aktoren welche im xs1 definiert wurden, werden nur bei Wertänderung aktualisiert.<br>
- (Default, update_only_difference 0)</li><br>
- <li>view_Device_name (0,1)<br>
- Die Aktor Namen welche im xs1 definiert wurden, werden als Reading ausgelesen.<br>
- (Default, view_Device_name 0)<br>
- </li><br>
- <li>view_Device_function (0,1)<br>
- Die Aktor Funktionen welche im xs1 definiert wurden, werden als Reading ausgelesen.<br>
- (Default, view_Device_function 0)<br>
- </li><br>
- <li>xs1_control (0,1)<br>
- Die Freigabe zur Steuerung des xs1. Nach Aktivierung dieser, wird durch das xs1Dev Modul jeder Aktor und Sensor in FHEM angelegt.<br>
- (Default, xs1_control 0)<br>
- </li><br><br>
- </ul>
- <b>Erläuterung:</b>
- <ul>
- <li>Auszug Readings:</li>
- <ul>
- <li>Aktor_(01-64)</li> definierter Aktor mit jeweiligem Zustand im Gerät<br>
- <li>Aktor_(01-64)_name</li> definierter Aktorname im Gerät<br>
- <li>Aktor_(01-64)_function(1-4)</li> definierte Aktorfunktion im Gerät<br>
- <li>Sensor_(01-64)</li> definierter Sensor im Gerät<br>
- <li>Sensor_(01-64)</li> definierter Sensorname im Gerät<br>
- <li>Timer_(01-128)</li> definierter Timer im Gerät<br>
- <li>xs1_bootloader</li> Firmwareversion des Bootloaders<br>
- <li>xs1_dhcp</li> DHCP an/aus<br>
- <li>xs1_features</li> erworbene Feature beim Kauf (A = SENDEN | B = EMPFANGEN | C = Skripte/Makros | D = Speicherkartenzugriff)<br>
- <li>xs1_firmware</li> Firmwareversion<br>
- <li>xs1_start</li> Gerätestart<br>
- </ul><br>
- <li>Die Meldung "<code>Error: Can't connect ...</code>" oder "<code>ERROR: empty answer received</code>" im System-Logfile, besagt das kurzzeitig keine Abfrage erfolgen konnte.<br>
- (Das kann häufiger bei DLAN vorkommen.)<br><br></li>
- <li>Sollte das Gerät nach 5 Verbindungsversuchen ebenfalls keine Verbindung erhalten haben, so schaltet das Modul auf < disable > !</li><br>
- <li>Logfile Erstellung erfolgt automatisch nach dem definieren. | Schema: <code>define FileLog_xs1Bridge FileLog ./log/xs1Bridge-%Y-%m.log <Name></code><br>
- Folgende Werte werden im Logfile erfasst: Timer | xs1-Statusinformationen</li><br>
- <li>Sollte das Gerät nach 5 Verbindungsversuchen ebenfalls keine Verbindung erhalten haben, so schaltet das Modul auf < disable > !</li><br>
- </ul>
- </ul>
- <p><a name="xs1Dev"></a>
- <h3>xs1Dev</h3>
- <div class='langLinks'>[<a href='commandref.html#xs1Dev'>EN</a> DE]</div>
- <ul>
- Dieses Modul arbeitet mit dem Modul xs1Bridge zusammen. (Das Attribut <code>xs1_control</code> im Modul xs1Bridge muss auf 1 gestellt sein!) <br>
- Es kommuniziert mit diesem und legt sämtliche Aktoren des xs1 als Device im FHEM an. So kann man vom FHEM aus, die Aktoren der xs1 steuern.
- <br><br>
- Das Modul wurde entwickelt basierend auf dem Firmwarestand v4-Beta des xs1. Es kann aufgrund von unterschiedlichen Anpassungen innerhalb der Firmware des Herstellers zu Fehlern kommen.
- <br><br>
- <a name="xs1Dev_define"></a>
- <b>Define</b><br>
- <ul>
- <code>define <name> xs1Dev <Typ> <ID> IODev=<NAME></code>
- <br><br>
- Ein anlegen des Modules ohne Angabe des Typ und der ID vom xs1 ist nicht möglich.
- <ul>
- <li><code><ID></code> ist interne ID im xs1.</li>
- </ul>
- <ul>
- <li><code><Typ></code> ist der Kürzel A für Aktoren oder S für Sensoren.</li>
- </ul><br>
- Beispiel:
- <ul>
- define xs1Dev_Aktor_02 xs1Dev A 02 IODev=ezControl
- </ul>
- </ul><br>
- <b>Set</b>
- <ul><code>set <name> <value> </code></ul><br>
- Wobei <code>value</code> einer der folgenden Werte sein kann:<br>
- <ul><code>
- dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50% dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%<br>
- dimdown<br>
- dimup<br>
- dimupdown<br>
- off<br>
- off-for-timer<br>
- on<br>
- on-for-timer<br>
- </code></ul><br>
- <b>Get</b><br>
- <ul>N/A</ul><br>
- <a name="xs1_attr"></a>
- <b>Attribute</b>
- <ul>
- <li>debug (0,1)<br>
- Dies bringt das Modul in eine sehr ausführliche Debug-Ausgabe im Logfile. Somit lassen sich Programmteile kontrollieren und Fehler überprüfen.<br>
- (Default, debug 0)
- </li>
- <li>useSetExtensions (0,1)<br>
- Schaltet die SetExtensions ein bzw. aus.<br>
- (Default, useSetExtensions 0)
- </li>
- </ul><br>
- <b>Erläuterung:</b>
- <ul>
- <li>Auszug Internals:</li>
- <ul>
- xs1_function(1-4): definierte Funktion im Gerät<br>
- xs1_name: definierter Name im Gerät<br>
- xs1_typ: definierter Typ im Gerät<br>
- </ul><br>
-
- <li>Folgende xs1-Gerätetypen sind bereits integriert: dimmer | shutter | switch | timerswitch</li>
- </ul>
-
- </ul>
- <p><a name="xxLG7000"></a>
- <h3>xxLG7000</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#xxLG7000'>xxLG7000</a><br/>
- </ul>
- <a name="yowsup"></a>
- <h3>yowsup</h3>
- <ul>
- Leider keine deutsche Dokumentation vorhanden. Die englische Version gibt es
- hier: <a href='commandref.html#yowsup'>yowsup</a><br/>
- </ul>
- <a name="perl"></a>
- <h3>Perl specials</h3>
- <div class='langLinks'>[<a href='commandref.html#perl'>EN</a> DE]</div>
- Wenn Sie einige Aufgaben automatisieren wollen, dann sollten Sie die Befehle
- <a href="#at">at</a> oder <a href="#notify">notify</a> nutzen. Für
- komplexere Aufgaben sollten Sie lieber ein SHELL-Skript oder einen PERL
- "oneliner" als das at/notify argument anwenden. Dieser Abschnitt gibt Ihnen
- einige Tipps zur Anwendung der PERL-oneliner.<br><br>
- <li>Um PERL-"oneliner" zu testen, geben Sie diese am
- "telnet" Prompt (oder in der FHEMWEB Text-Eingabezeile)
- eingeschlossen von geschweiften Klammern {} in einer Zeile ein. Die letzte
- Beispielzeile schreibt nur etwas in die Logdatei, während das Ergebnis
- der anderen Zeilen direkt auf der Webseite sichtbar ist.<ul>
- Beispiele:<p>{ "Hello" }<br>
- { 1+3*4 }<br>
- { `ls /etc` }<br>
- { Log 1, "Hello" }<br>
- </p>
- </ul>
- <br>
- </li>
- <li>
- PERL Ausdrücke werden durch ein Semikolon (;) getrennt. In FHEM
- "oneliners" müssen sie durch ein weiteres Semikolon (;;)
- "escaped" (maskiert) werden<br>
- Beispiel:<ul>
- { my $a = 1+1;; Log 1, "Hello $a" }
- </ul>
- </li><br>
- <li>Um FHEM-Kommandos in den PERL-Ausdrücken zu verwenden, benutzen
- Sie bitte die Funktion <var>fhem()</var>, mit einem Textargument. Dieser Text wird als
- FHEM-Kommando interpretiert.<br>
- <p> Beispiel<ul>
- { fhem "set light on" }<br>
- define n1 notify piri:on { fhem "set light on" }
- <p> </p>
- </ul>
- Bemerkung: Wenn diese Funktion einen wert zurück liefert, wird dieser
- in der allgemeinen Logdatei gespeichert.. Benutzen sie "1" als
- zweites Argument um dieses speichern zu verhindern. Sinnvoll ist dieses
- Argument bei der Abfrage von Werten mittels "get...".
- </li><br>
- <li>Notify kann auch dazu verwendet werden, um Macros manuell
- auszuführen. Verwenden Sie den <a href="#trigger">trigger</a>-Befehl
- um das Makro zu starten:<br>
- <ul>
- define MyMacro notify MyMacro { Log 1, "Hello"}<br>
- trigger MyMacro<br>
- define MacroWithArg notify MyMacro { Log 1, "Hello %"}<br>
- trigger MyMacro MyArg<br>
- </ul>
- <br>
- </li>
- <li>Um die Verwendung von Datum und Zeitangaben zu vereinfachen, wurden die
- Variablen <var>$sec</var>, <var>$min</var>, <var>$hour</var>, <var>$mday</var>,
- <var>$month</var>, <var>$year</var>, <var>$wday</var>, <var>$yday</var>, <var>$isdst</var> und <var>$hms</var>
- für die Verwendung in PERL-"oneliners" eingeführt (s.
- unter <var>perldoc -f localtime</var>). Ausnahmen: <var>$month</var> hat einen Wertebereich von 1
- bis 12 und <var>$year</var> ist korrigiert von 1900.
- Weiterhin enthält <var>$hms</var> die Zeit in dem HH:MM:SS Format und <var>$today</var> das
- aktuellen Datum in YYYY-MM-DD Format.
- <br>
- Die Variabe <var>$we</var> hat den Wert 1 wenn der abgefragte Tag auf ein Wochenende
- fällt (Z.B. <var>$wday</var> == 0 [Sonntag] oder <var>$wday</var> == 6 [Samstag]), und 0
- für die anderen Wochentage. Wenn man das global <a
- href="#holiday2we">holiday2we</a> Attribut setzt, dann ist <var>$we</var> ebenfalls 1
- bei Urlaubstagen.<br>
- <ul>
- define n2 notify piri:on { if($hour > 18 || $hour < 5) {
- fhem "set light on" } }<br>
- define roll_en *07:45:00 { fhem "trigger SwitchAllRoll on" if(!$we) }<br>
- define roll_en *08:30:00 { fhem "trigger SwitchAllRoll on" if($we) }<br>
- </ul>
- <br>
- </li><li>
- Die folgenden Hilfsfunktionen sind in der Datei 99_Util.pm definiert (wird
- wie jede mit 99_ beginnende Datei automatisch geladen):
- <ul>
- <li>min(a,b), max(a,b)</li>
- <li>time_str2num("YYYY-MM-DD HH:MM:SS") gibt einen numerischen Wert
- zurück, der die Berechnung von Zeitdifferenzen vereinfacht</li>
- <li>abstime2rel("HH:MM:SS") wandelt absolute in relative Zeitangaben um
- </li>
- </ul>
- </li>
- <li>
- Um auf die Gerätestatus/Attribute zuzugreifen benutzen Sie bitte die
- folgenden Funktionen:
- <br>
- <ul>
- <li>Value(<devicename>)<br>
- gibt den Status eines Gerätes zurück (entsprechend dem
- Ausdruck in Klammern, den Sie beim List-Befehl sehen).
- </li><br>
- <li>OldValue(<devicename>)</li>
- <li>OldTimestamp(<devicename>)<br>
- gibt den vorherigen Wert/Zeitstempel des Gerätes zurück.
- </li><br>
- <li>
- ReadingsVal(<devicename>,<reading>,<defaultvalue>)<br>
- Gibt den Inhalt der "readings" zurück (den Inhalt der in
- dem "Readings"-Abschnitt von "list device" angezeigt wird)
- </li><br>
- <li>
- ReadingsNum(<devicename>,<reading>,
- <defaultvalue>,<round>)<br>
- Gibt die erste Zahl aus dem Readingswert zurück.
- Falls <round> spezifiziert ist, wird sie auf diese Anzahl von
- Dezimalstellen gerundet.
- </li><br>
- <li>ReadingsTimestamp(<devicename>,
- <reading>,<defaultvalue>)<br>
- gibt den Zeitstempel des Readings zurück.
- </li><br>
- <li>ReadingsAge(<devicename>,<reading>,<defaultvalue>)
- <br>
- gibt das Alter des Readings in Sekunden zurück.
- </li><br>
- <li>
- OldReadingsVal(<devicename>,<reading>
- ,<defaultvalue>)<br>
- OldReadingsNum(<devicename>,<reading>,
- <defaultvalue>,<round>)<br>
- OldReadingsTimestamp(<devicename>,<reading>
- ,<defaultvalue>)<br>
- OldReadingsAge(<devicename>,<reading>,<
- defaultvalue>)<br>
- analog zu den Routinen oben, aber zum Zugriff auf die vorherigen Werte.
- siehe: <a href="#oldreadings">oldreadings</a><br>
- </li><br>
- <li>
- AttrVal(<devicename>,<attribute>,<defaultvalue>)<br>
- Gibt das entsprechende Attribut des Gerätes zurück
- <br><br>
- { Value("wz") }<br>
- { OldValue("wz") }<br>
- { time_str2num(OldTimestamp("wz")) }<br>
- { ReadingsVal("wz", "measured-temp", "20")+0 }<br>
- { ReadingsTimestamp("wz", "measured-temp", 0)}<br>
- { AttrVal("wz", "room", "none") }<br>
- </li><br>
- <li>
- AttrNum(<devicename>,<attribute>,
- <defaultvalue>,<round>)<br>
- Gibt die erste Zahl aus dem Attributwert zurück.
- Falls <round> spezifiziert ist, wird sie auf diese Anzahl von
- Dezimalstellen gerundet.
- </li><br>
- <li>
- InternalVal(<devicename>,<internal>,
- <defaultvalue>)<br>
- Gibt den Inhalt der "internal" zurück (den Inhalt der in
- dem "Internals"-Abschnitt von "list device" angezeigt wird)
- </li><br>
- <li>
- InternalNum(<devicename>,<internal>,
- <defaultvalue>,<round>)<br>
- Gibt die erste Zahl aus dem "internal" zurück.
- Falls <round> spezifiziert ist, wird sie auf diese Anzahl von
- Dezimalstellen gerundet.
- </li><br>
- </ul>
- </li><li>
- Wenn Sie das 99_SUNRISE_EL.pm Modul benutzen, haben Sie zugriff auf
- folgende Funktionen: <br>
- <ul>
- sunset($offset, $min, $max)<br>
- sunrise($offset, $min, $max)<br>
- isday()<br>
- </ul>
- Der Wert von "offset" wird in Sekunden angegeben und das Format
- für min/max ist "HH:MM" oderr "HH:MM:SS". isday gibt 1 zurück,
- wenn die Sonne sichtbar ist und ansonsten den Wert 0. </li>
- <br>
- <br>
- <!-- perl end - diese Zeile nicht entfernen! -->
- <a name="gnuplot-syntax"></a>
- <h3>gnuplot file syntax</h3>
- <div class='langLinks'>[<a href='commandref.html#gnuplot-syntax'>EN</a> DE]</div>
- Die .gplot Dateien werden ebenso von den <a href="#FHEMWEB">FHEMWEB</a>/SVG
- Modulen falls das <a href="#plotmode">plotmode</a>-Attribut auf SVG gesetzt
- ist. In diesem Fall wird nur eine geringere Anzahl der .gnuplot Attribute
- benutzt, und einige Linien haben eine besondere Bedeutung: Die Unterschiede
- werden in diesem Kapitel erklärt. Lesen Sie bitte auch <a
- href="http://wiki.fhem.de/wiki/Creating_Plots"> diesen</a> FHEM Wiki Eintrag
- zur Erstellung von Logdateien.<br> Im folgenden ist eine minimale .gplot
- Definition (gültig nur bei Plotmode SVG):<br>
- <pre> set terminal size <SIZE>
- #FileLog 4:::
- plot title 'Temperature' with lines
- </pre>
- Die .gnuplot Datei besteht aus 3 Teilen:
- <ul>
- <li>set Befehle<br>
- Folgende "sets" werden erkannt:
- <ul>
- <li>terminal, nur die Größenparameter.<br>
- Dieser ist in der Regel auf <SIZE> gesetzt, welcher ersetzt wird
- durch das <a href="#plotsize">plotsize</a> Attribut von FHEMWEB oder
- einer Weblink-Instanz.</li>
- <li>title<br>
- Normalerweise gesetzt auf <TL> welcher durch das Weblink <a
- href="#title">title</a>-Attribut, oder durch <Lx>, welches
- wiederum vom Weblink <a href="#label">label</a> Attribut ersetzt
- wird.</li>
- <li>ylabel,y2label<br>
- Linke und rechte vertikale Achsenbeschriftungen. Are also subject to
- label replacement.</li>
- <li>yrange,y2range<br>
- Legen den Wertebereich der linken und rechten y-Achse fest.
- Beispiele:<br>
- <ul>
- set yrange [-0.1:1.1]<br>
- set y2range [0:]<br>
- </ul>
- </li>
- <li>ytics,y2tics<br>
- Beschriftung für die Werte der rechten/linken y-Achse.
- Beispiele:<br>
- <ul>
- set ytics ("on" 0, "off" 1)<br>
- set y2tics<br>
- </ul>
- </li>
- </ul>
- </li>
- <br>
- <li>#FileLog Einträge<br>
- Jede Line des Plots muss eine dazugehörige #FileLog
- Zeile haben. Zur Syntax lesen Sie bitte den Abschnitt "column_spec
- paragraph" von der <a href="#FileLogget">Filelog get</a>
- Beschreibung. Beachten sie bitte, das bei SVG-Plots die erste Spalte der
- Datei unbedingt im FHEM-Zeitstempelformat (YYYY-MM-DD_HH:MM:SS)
- formatiert sein muss
- </li>
- <br>
- <li>Plot Einträge<br>
- bestehen immer aus einem Plotbefehl und aus durch Kommata getrenne
- Argumentblöcke. Jeder Argumentblock repräsentiert eine
- darzustellende Linie und hat seine eigenen Paramter.
- Folgende Parameter werden are anerkannt:
- <ul>
- <li>axes x1y1 / x1y2<br>
- weist das Programm an die aktuelle Zeile einer der beiden Achsen (links
- oder rechts) zuzuweisen.
- </li>
- <li>title<br>
- Beschriftung der Linie. Wenn man auf diesen Titel klickt, dann
- ändert ein kleines Javascript-Programm den Titel auf die min/max
- und last-Werte des Plots, Weiterhin erlaubt das Programm diese Linie zu
- kopieren oder eine bereits kopierte Linie einzufügen (die
- existierende Skalierung des Plots wird dabei nicht verändert, nur
- die eingefügte Linie wird skaliert/angepasst. Andere Linien des
- Plots werden zeitweise nicht angezeigt.</li>
- <li>with <linetype><br>
- spezifiziert die Art der Linie. Folgende Linienarten können
- verwendet werden: points, steps, fsteps, histeps and lines. Nicht
- bekannte Linienarten werden als Typ "lines" dargestellt.
- SVG Spezial: cubic und quadratic werden zu den SVG path Typen C und Q
- gewandelt.
- </li>
- <li>ls <linestyle><br>
- Der Linienstil stellt die erste Linie als l0 dar, die zweite
- Linie als l1 und so weiter. Definiert ist dies in der svg_style.css
- Datei. Darin sind zwei Sets definiert: l0-l8 and l0fill-l6fill. Das
- zweite Set muss aber explizit angegeben werden. Wenn der Name des
- Linienstils das Wort "fill" enthält, dann haben Plots
- des Linientyps "lines" ein zusätzliches Start- und Endsegment
- für eine korrekte Darstellung.<br> Bitte lesen sie die SVG
- Spezifikationen, um Details über diese css-Datei zu erfahren.
- Notiz: Wenn Sie dieses Attribut einsetzen möchten, müssen Sie
- es für alle Linien (Attributblocks) im Plotbefehl spezifizieren.
- </li>
- <li>lw <linewidth><br>
- Setzt die Linienbreite der Linie. Dieses Attribut ist veraltet. Das
- entprechende Feature der css-Datei/(Attribut ls) muss verwendet werden.
- </li>
- </ul>
- </li></ul>
- </div> <!-- right -->
- </body>
- </html>
|