bambu_mqtt.py 464 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179
  1. """Bambu Lab MQTT communication service.
  2. IMPORTANT: Always use qos=1 for all MQTT publish calls!
  3. The printer ignores qos=0 messages when busy broadcasting status updates.
  4. Using qos=1 ensures the printer acknowledges and processes our commands immediately.
  5. This was discovered when K-profile requests with qos=0 took 20-30 seconds,
  6. but with qos=1 they respond instantly.
  7. """
  8. import asyncio
  9. import json
  10. import logging
  11. import os
  12. import ssl
  13. import threading
  14. import time
  15. from collections import deque
  16. from collections.abc import Callable
  17. from dataclasses import dataclass, field
  18. from datetime import datetime, timezone
  19. import paho.mqtt.client as mqtt
  20. from backend.app.services.hms_actions import HMSAction, get_actions_for_error_code
  21. from backend.app.services.hms_errors import alert_level_from_print_error, describe_fault
  22. from backend.app.utils.ams_drying import ACTIVE_DRY_STATUSES, DRY_COUNTDOWN_STALL_SECONDS
  23. from backend.app.utils.ams_humidity import ams_humidity_percent
  24. from backend.app.utils.paho_teardown import discard_queued_publishes, retire_paho_client
  25. from backend.app.utils.tray_ids import (
  26. AMS3H_UNIT_ID,
  27. RACK_SLOT_COUNT,
  28. AmsType,
  29. TrayLayout,
  30. ams_type_from_info,
  31. decode_wire_slot,
  32. external_tray_id,
  33. global_tray_id,
  34. is_ams_ht_id,
  35. is_external_tray,
  36. is_rack_ams,
  37. legacy_tray_index,
  38. mapped_trays_with_slot,
  39. tray_flag_bit,
  40. unit_ams_type,
  41. unit_label,
  42. )
  43. logger = logging.getLogger(__name__)
  44. # How long a manual load's tray target stays a hint for an H2D's tray_now: long
  45. # enough for a real load to report, short enough that a refused one cannot
  46. # relabel a later print's load of the same slot number (FW-C7).
  47. PENDING_TRAY_TARGET_TTL = 120.0
  48. # AMS module name prefixes used in get_version responses.
  49. # The numeric suffix after '/' is the AMS unit ID as reported in push_status.
  50. # "ams/<id>" – original AMS (X1C, X1E, P1S, …)
  51. # "ams_f1/<id>" – AMS Lite (A1, A1 Mini; the A2L reports id 16, stored as 6)
  52. # "n3f/<id>" – AMS 2 Pro (H2D Pro and similar)
  53. # "n3s/<id>" – AMS HT (H2D Pro and similar; IDs typically start at 128)
  54. # "n10a" – AMS 3H (H3C), no suffix: read as "n10a/<its unit id>"
  55. _AMS_MODULE_PREFIXES = ("ams/", "ams_f1/", "n3f/", "n3s/", "n10a/")
  56. # gcode_state values that mean the printer is not idle and must not be handed a
  57. # new start-print (#2598). The firmware rejects a project_file while busy with
  58. # 0500_4004 "Device is busy and cannot start a new task", and on some models
  59. # (A1 mini reported) that error cancels the RUNNING job. IDLE / FINISH / FAILED
  60. # are valid start targets and are deliberately excluded. Mirrors
  61. # printer_manager.ACTIVE_PRINT_STATES and print_scheduler._ACTIVE_PRINT_STATES.
  62. _ACTIVE_PRINT_STATES = frozenset({"PREPARE", "SLICING", "RUNNING", "PAUSE"})
  63. # A drying cycle that runs to term ends with its countdown all but exhausted, so
  64. # the last dry_time we saw before the drop to 0 tells us whether the firmware
  65. # ended the cycle on schedule or aborted it. More than this many minutes still on
  66. # the clock means it was cut short, and the firmware's own reason codes are worth
  67. # capturing at INFO — #2770 aborted a 12-hour cycle 20 minutes in (700 minutes
  68. # left), and the log said only "drying complete", so the report carried no
  69. # evidence of why. The margin absorbs a stale last observation between AMS
  70. # pushes; it is not a judgement about how short "short" is.
  71. _EARLY_DRY_END_MINUTES = 5
  72. # CONNACK reason codes that mean the printer actively refused our credentials,
  73. # as opposed to being unreachable or busy. Bambu speaks MQTT 3.1.1, whose
  74. # single-byte CONNACK return codes paho maps onto the v5 reason-code space:
  75. # return code 4 ("bad user name or password") -> 134, and 5 ("not authorized")
  76. # -> 135. Both mean the same thing in practice for a Bambu printer: the access
  77. # code (or, on some firmware, the serial used as the username) is wrong.
  78. _CONNACK_AUTH_REJECTED = frozenset({134, 135})
  79. # Short, stable slugs recorded on the client and surfaced to the connection
  80. # diagnostic as a `params.reason` variant. Deliberately not free text — the
  81. # frontend picks a localized message key off these.
  82. CONNECT_ERROR_AUTH_REJECTED = "auth_rejected"
  83. CONNECT_ERROR_REFUSED = "refused"
  84. def parse_ams_filament_backup_from_cfg(cfg_raw: object) -> bool | None:
  85. """Extract AMS Filament Backup state from a Bambu push_status ``print.cfg`` value.
  86. OrcaSlicer reads bit 18 of the hex string via
  87. ``get_flag_bits(cfg, 18)`` (DeviceManager.cpp:4961). Old-protocol families
  88. (A1 / A1 Mini) omit ``cfg`` entirely; this returns ``None`` for any input
  89. that doesn't yield a clean integer so downstream consumers preserve today's
  90. behaviour rather than treating "absent" as "OFF".
  91. """
  92. if not isinstance(cfg_raw, str) or not cfg_raw:
  93. return None
  94. try:
  95. return bool((int(cfg_raw, 16) >> 18) & 1)
  96. except ValueError:
  97. return None
  98. def parse_ams_filament_backup_from_home_flag(home_flag: object) -> bool | None:
  99. """Extract AMS Filament Backup state from a push_status ``print.home_flag`` value.
  100. Bambu Studio reads bit 10 for every family (DeviceManager.cpp
  101. ``parse_home_flag``: ``SetAutoRefillEnabled((flag >> 10) & 0x1)``). It's
  102. the only source on the P1S, P1P, A1 and A1 Mini, which never send ``cfg``
  103. (#3259). On every printer that sends both, the two bits agree in all
  104. captured snapshots, ON and OFF alike. Returns ``None`` for anything that
  105. isn't an integer.
  106. """
  107. if isinstance(home_flag, bool) or not isinstance(home_flag, int):
  108. return None
  109. # Negative values are the 32-bit flag read as signed; bit 10 is the same.
  110. return bool((home_flag >> 10) & 1)
  111. def is_printer_status_frame(print_data: dict) -> bool:
  112. """True when a ``print`` payload is the printer reporting its own state.
  113. Bambu firmware echoes a command's fields back in its acknowledgement, so a
  114. `project_file` ack carries whatever Bambuddy put on the wire — including
  115. the `cfg` bitmask and the per-job `timelapse` flag. Ingesting those as
  116. telemetry means reading our own request back as the printer's state
  117. (#3040). Only `push_status` (and the odd firmware that omits `command`
  118. entirely on a status frame) describes the printer.
  119. """
  120. command = print_data.get("command")
  121. return command is None or command == "push_status"
  122. # ── A2L "AMS Lite" unit-id normalisation (issue capture 2026-07-20) ──────────
  123. # The A2L reports its 4-slot AMS Lite as physical unit **id 16**, but the
  124. # firmware is internally inconsistent about it:
  125. # - its tray bitmasks (tray_exist_bits etc.) sit at **bit base 24**, i.e. the
  126. # position for id 6 (6*4), NOT id 16 (which would be bit 64);
  127. # - it reports `tray_now` as a **local** 0-3 slot, not a global id;
  128. # - `ams_mapping2` and per-unit commands use the **physical** id 16.
  129. # So we normalise 16 -> 6 at the MQTT ingest boundary. Global tray ids then land
  130. # at 24-27, which every `ams_id*4+slot` consumer handles unchanged, collides with
  131. # nothing (regular AMS 0-15, AMS-HT 128-135, external 254/255) and passes the
  132. # `ams_id <= 7` DB constraint. We translate 6 -> 16 (and the local slot) back to
  133. # the physical form ONLY on the outbound wire. See memory a2l-am-unit-16.
  134. A2L_LITE_PHYSICAL_AMS_ID = 16
  135. A2L_LITE_NORMALIZED_AMS_ID = 6
  136. A2L_LITE_GLOBAL_BASE = A2L_LITE_NORMALIZED_AMS_ID * 4 # 24
  137. def normalize_am_unit_id(ams_id: int) -> int:
  138. """Map the A2L AMS-Lite's physical unit id (16) to its normalised id (6).
  139. Self-scoping: only id 16 is remapped, and no other Bambu device reports an
  140. AMS unit at id 16 (regular AMS 0-3, AMS-HT 128-135). All other ids pass
  141. through untouched.
  142. """
  143. return A2L_LITE_NORMALIZED_AMS_ID if ams_id == A2L_LITE_PHYSICAL_AMS_ID else ams_id
  144. def wire_tray_color(tray_color: str | None) -> str:
  145. """Normalise a colour to the form AMS firmware actually parses: UPPERCASE hex.
  146. P1S firmware 01.10.00.00 parses every lowercase hex letter in ``tray_color``
  147. as a zero, and does it silently: the command response echoes the value you
  148. sent and reports ``result: "success"``, so only the next AMS push shows what
  149. was really stored. Measured on the reporter's machine (#2987), where the
  150. spool's own ``rgba`` is stored lowercase and went out verbatim:
  151. sent 09ff00ff -> AMS reports 09000000
  152. sent ff5100ff -> AMS reports 00510000
  153. sent 090000FF -> AMS reports 090000FF
  154. A mangled colour is not merely cosmetic. The auto-unlink sweep compares the
  155. tray against the spool it is assigned to, so the tray Bambuddy just wrote no
  156. longer matches the spool that asked for it and the assignment is deleted
  157. seconds after being made -- and re-assigning through the slot modal writes
  158. the mangled colour back, because the modal seeds itself from the tray.
  159. Applied here, at the one place the command is built, rather than in each of
  160. the four callers: a caller that forgets is exactly how this arrived.
  161. A leading ``#`` is stripped -- the wire format carries bare hex -- and a
  162. blank stays blank, which is how a slot is cleared.
  163. """
  164. return (tray_color or "").strip().lstrip("#").upper()
  165. def a2l_lite_wire_ids(ams_id: int, tray_id: int) -> tuple[int, int, int] | None:
  166. """Translate a normalised A2L slot back to the physical wire form.
  167. Returns ``(wire_ams_id, wire_slot_id, wire_global_tray)`` for the AMS-Lite
  168. (normalised id 6), else ``None`` for every other unit.
  169. CONFIRMED from the firmware's own `ams_mapping2` ({ams_id:16, slot_id:0-3}):
  170. the wire uses the physical unit id 16 with a **local** 0-3 slot. NOT yet
  171. confirmed by capture: the physical **global** tray value the extrusion_cali
  172. commands put in `tray_id` — we extrapolate it as 16*4+slot = 64-67 to stay
  173. consistent with the physical unit id. BambuStudio's source sends 24+slot
  174. there instead (``GetTrayIndexMap``); a BambuStudio->A2L capture of a cali
  175. command would settle it, and it lives only here. Load's `target` is not this
  176. value: see ``change_filament_wire_ids``.
  177. """
  178. if ams_id != A2L_LITE_NORMALIZED_AMS_ID:
  179. return None
  180. local_slot = tray_id % 4
  181. return (
  182. A2L_LITE_PHYSICAL_AMS_ID,
  183. local_slot,
  184. legacy_tray_index(A2L_LITE_PHYSICAL_AMS_ID, local_slot),
  185. )
  186. def change_filament_wire_ids(tray_id: int, layout: TrayLayout | None = None) -> tuple[int, int, int]:
  187. """``(ams_id, slot_id, target)`` of ``ams_change_filament`` for an AMS tray.
  188. As BambuStudio's ``command_ams_change_filament`` builds them: a regular AMS
  189. is addressed by unit and local slot with the global tray as target; a unit
  190. id of 16 or more (the A2L AMS-Lite's physical 16, an AMS-HT's 128-135) has
  191. the unit id itself as target. An AMS-HT holds one tray, so its global tray
  192. id is its unit id and its slot is 0.
  193. """
  194. if is_ams_ht_id(tray_id):
  195. return tray_id, 0, tray_id
  196. ams_id, slot_id = (layout or TrayLayout()).slot_key(tray_id)
  197. if (a2l := a2l_lite_wire_ids(ams_id, tray_id)) is not None:
  198. return a2l[0], a2l[1], a2l[0]
  199. return ams_id, slot_id, tray_id
  200. # The H3C's AMS 3H is one unit (32, AMS type 6) with nine slots, numbered 28 + k
  201. # (utils.tray_ids). Its tray_now / tray_tar / tray_pre are the raw slot 0-8;
  202. # print.mapping and the snow fields encode a slot as (32 << 8) | k. Commands
  203. # address it as {ams_id: 32, slot_id: k}.
  204. AMS3H_MODULE_NAME = "n10a" # its get_version module (no "/<unit>" suffix)
  205. def _mqtt_int(value: object) -> int | None:
  206. """An MQTT id / number field as an int (they arrive as int or numeric str), else None."""
  207. if isinstance(value, bool) or not isinstance(value, (int, str)):
  208. return None
  209. try:
  210. return int(value)
  211. except ValueError:
  212. return None
  213. # AMS 3H drying (Bambu Studio 02.09, AMSDryControl.cpp): the unit reports
  214. # `zone_info[]` and only a zone with exactly two slots can dry; the others are
  215. # ambient readings. A drying start carries the filament's softening temperature
  216. # as `cooling_temp` (the preset's filament_dev_drying_softening_temperature).
  217. AMS3H_DRY_COOLING_TEMP = {"PLA": 65, "PETG": 75, "ABS": 95, "ASA": 95, "TPU": 70, "PA": 150, "PC": 120}
  218. AMS3H_DRY_COOLING_TEMP_DEFAULT = 50
  219. def ams3h_drying_zone(zone_info: object) -> dict | None:
  220. """The zone of an AMS 3H's `zone_info` that can dry: the first holding exactly two slots."""
  221. if not isinstance(zone_info, list):
  222. return None
  223. for zone in zone_info:
  224. if isinstance(zone, dict) and isinstance(zone.get("zone_slots"), list) and len(zone["zone_slots"]) == 2:
  225. return zone
  226. return None
  227. def ams3h_drying_cooling_temp(filament: str) -> int:
  228. """`cooling_temp` for an AMS 3H drying start: the filament's softening temperature."""
  229. base = (filament or "").upper().split("-")[0].split(" ")[0]
  230. return AMS3H_DRY_COOLING_TEMP.get(base, AMS3H_DRY_COOLING_TEMP_DEFAULT)
  231. def _ams3h_unit_drying_fields(unit: dict) -> dict:
  232. """An AMS 3H's drying state, which lives on its drying zone, lifted onto the unit."""
  233. zone = ams3h_drying_zone(unit.get("zone_info"))
  234. if zone is None:
  235. return {}
  236. fields: dict = {"dry_zone_id": zone.get("zone_id", 0), "dry_zone_slots": list(zone.get("zone_slots") or [])}
  237. for key in ("dry_time", "dry_setting", "dry_sf_reason"):
  238. if key in zone:
  239. fields[key] = zone[key]
  240. if "info" not in unit and "info" in zone:
  241. fields["info"] = zone["info"]
  242. if "humidity_raw" in zone:
  243. fields["dry_zone_humidity_raw"] = zone["humidity_raw"]
  244. if "temp" in zone:
  245. fields["dry_zone_temp"] = zone["temp"]
  246. return fields
  247. def _ams3h_unit_env_fields(unit: dict) -> dict:
  248. """An AMS 3H's humidity and temperature (the unit has none) from its first non-drying zone, as Studio shows it."""
  249. zones = unit.get("zone_info")
  250. if not isinstance(zones, list):
  251. return {}
  252. dry_zone = ams3h_drying_zone(zones)
  253. ambient = next((z for z in zones if isinstance(z, dict) and z is not dry_zone), None)
  254. if ambient is None:
  255. return {}
  256. return {key: ambient[key] for key in ("humidity_raw", "temp") if key in ambient and key not in unit}
  257. def apply_rack_ams_zone_fields(ams_list: object, known_types: dict[int, AmsType] | None = None) -> None:
  258. """Lift a rack AMS's per-zone readings and drying state onto the unit, in place (type from `info`, else ``known_types``)."""
  259. if not isinstance(ams_list, list):
  260. return
  261. for unit in ams_list:
  262. if not isinstance(unit, dict) or not isinstance(unit.get("zone_info"), list):
  263. continue
  264. uid = _mqtt_int(unit.get("id"))
  265. if uid is None:
  266. continue
  267. kind = ams_type_from_info(unit.get("info"))
  268. if kind is None:
  269. kind = (known_types or {}).get(uid, unit_ams_type(uid))
  270. if not is_rack_ams(kind):
  271. continue
  272. unit.update({**_ams3h_unit_env_fields(unit), **_ams3h_unit_drying_fields(unit)})
  273. def resolve_external_spools_in_mapping(
  274. ams_mapping: object, ams_mapping2: object, is_dual_nozzle: bool, layout: TrayLayout | None = None
  275. ) -> object:
  276. """Put the external spool back into a captured flat ``ams_mapping`` (#3166).
  277. The firmware rejects 254/255 in the flat list, so BambuStudio and our own
  278. dispatch both write an external spool there as -1 -- the same value as a
  279. slot that isn't fed at all -- and carry the real target only in
  280. ``ams_mapping2`` as ``{ams_id: 254|255, slot_id: 0}``. Capturing the flat
  281. list alone turns "printed from the external spool" into "unmapped", and
  282. usage then lands on whatever tray the fallback guesses.
  283. Each -1 whose ``ams_mapping2`` entry names an external spool becomes the
  284. global tray the rest of Bambuddy uses: the ams_id itself on dual-nozzle
  285. printers (254 = left/deputy, 255 = right/main), 254 on single-nozzle
  286. printers, which have one external spool that the wire always calls 255.
  287. ``{255, 255}`` is the unmapped marker and stays -1.
  288. An A2L AMS-Lite tray is the local slot 0-3 in the flat list and
  289. ``{ams_id: 16, slot_id: n}`` in ``ams_mapping2``; it becomes its normalised
  290. global tray 24+n. Kept local, it read as a regular AMS tray, so usage was
  291. charged to the wrong spool. A rack AMS slot (``{ams_id: 32, slot_id: k}``)
  292. becomes its global tray 28+k, and on a rack printer each external input
  293. 247-255 keeps its own id. Every other entry is left exactly as captured.
  294. Without a usable ``ams_mapping2`` the input is returned unchanged.
  295. """
  296. if not isinstance(ams_mapping, list) or not isinstance(ams_mapping2, list):
  297. return ams_mapping
  298. if len(ams_mapping2) != len(ams_mapping):
  299. return ams_mapping
  300. resolved = list(ams_mapping)
  301. layout = layout or TrayLayout()
  302. for i, (flat, detail) in enumerate(zip(ams_mapping, ams_mapping2, strict=True)):
  303. if not isinstance(detail, dict):
  304. continue
  305. ams_id = detail.get("ams_id")
  306. slot_id = detail.get("slot_id")
  307. if ams_id == A2L_LITE_PHYSICAL_AMS_ID and slot_id in (0, 1, 2, 3):
  308. resolved[i] = A2L_LITE_GLOBAL_BASE + slot_id
  309. continue
  310. if (
  311. isinstance(ams_id, int)
  312. and isinstance(slot_id, int)
  313. and not is_external_tray(ams_id, layout.rack)
  314. and is_rack_ams(layout.ams_type(ams_id))
  315. and 0 <= slot_id < RACK_SLOT_COUNT
  316. ):
  317. resolved[i] = layout.global_tray_id(ams_id, slot_id)
  318. continue
  319. if flat != -1 or not is_external_tray(ams_id, layout.rack) or slot_id == 255:
  320. continue
  321. resolved[i] = ams_id if is_dual_nozzle or layout.rack else 254
  322. return resolved
  323. def unit_reported_absent(ams_id, ams_list: list, ams_exist_bits) -> bool:
  324. """Whether a push that doesn't list AMS unit ``ams_id`` says it is unplugged.
  325. ``ams_exist_bits`` (hex) has bit n set for AMS unit n, measured on an X1C
  326. (unit 1 -> "2", none -> "0") and an H2C (units 0, 1, 2 and HT 128 -> "17").
  327. So an AMS unit 0-3 whose bit is clear is gone. An empty unit list with no
  328. bits set means no unit at all, which is what the X1C sends with its AMS
  329. unplugged. Anything else is kept, as the merge always did: a partial push
  330. lists only some units, and the bits of an AMS HT or AMS Lite next to other
  331. units are not measured well enough to read.
  332. """
  333. if ams_exist_bits is None:
  334. return False
  335. try:
  336. bits = int(ams_exist_bits, 16) if isinstance(ams_exist_bits, str) else int(ams_exist_bits)
  337. unit = int(ams_id)
  338. except (TypeError, ValueError):
  339. return False
  340. if bits == 0 and not ams_list:
  341. return True
  342. return 0 <= unit <= 3 and not bits >> unit & 1
  343. def apply_tray_exist_bits(
  344. units: list,
  345. tray_exist_bits_str: str | int | None,
  346. *,
  347. power_on_flag: bool = True,
  348. log_label: str | None = None,
  349. annotate_exists: bool = False,
  350. ) -> int:
  351. """Wipe stale per-tray filament fields on slots whose `tray_exist_bits` bit is 0.
  352. `tray_exist_bits` is firmware's canonical "which slots have a spool" bitmask
  353. (BambuStudio uses it too). For every slot whose bit is 0, promote the tray
  354. `state` to 9 (firmware's "no spool" code) and clear `tray_type` / `tray_color`
  355. / `tray_info_idx` / `tag_uid` / `tray_uuid` / `remain` etc so downstream
  356. readers (Bambuddy's AMS card, the VP slicer-facing cache, inventory short-
  357. circuits keyed on `state in {9, 10}`) all see one canonical empty-slot signal
  358. instead of guessing from payload shape (#1322, #147).
  359. Two callers share this helper to keep their views consistent:
  360. 1. ``_handle_ams_data`` for Bambuddy's internal AMS state (printer card).
  361. 2. ``virtual_printer.mqtt_bridge._on_printer_raw`` for the cached slicer-
  362. facing push_status (#1726 — without this the VP would forward stale
  363. per-tray fields for empty slots, and BambuStudio's Sync would render
  364. phantom loaded slots).
  365. Skipped only on the printer-shutdown pattern: all-zero bits paired with
  366. ``power_on_flag=False`` (#765). Non-zero bits with ``power_on_flag=False``
  367. is valid idle-printer state (#1365 — X1C between prints) and MUST be applied
  368. so spool removal is detected without requiring a manual reconnect.
  369. AMS-HT units (``id`` 128-135) are single-tray dry boxes whose presence bit
  370. is packed as ONE consecutive bit starting at 16 (``16 + (ams_id - 128)``),
  371. NOT ``ams_id * 4`` (which would overflow to bit 512+). This is the firmware's
  372. authoritative empty signal for the HT — the only working clear path, since
  373. the HT keeps echoing stale ``tray_type`` and its ``state`` is firmware-variant
  374. (#2670). Verified against OrcaSlicer ``DevFilaSystem.cpp``
  375. (``is_exists = tray_exist_bits >> (16 + (ams_id-128))``) and a live H2D
  376. capture (HT-A → bit 16). The A2L-Lite lands at bits 24-27 via the regular
  377. ``ams_id * 4`` formula, matching OrcaSlicer's ``AMS_LITE_MIXED`` offset; the
  378. unit id is folded through ``normalize_am_unit_id`` first so callers holding
  379. the raw physical id 16 get the same bit base as callers holding the
  380. normalised 6 (#2697).
  381. `tray_exist_bits_str` is expected as a hex string (firmware sends it that
  382. way). Ints are tolerated for defensive symmetry but typically not seen
  383. on the wire. ``None`` / empty / unparseable → no-op.
  384. ``annotate_exists`` writes a per-tray ``exists`` bool (from the bitmask) on
  385. every processed slot. This is firmware's authoritative "spool physically
  386. present" signal — the same one BambuStudio uses to draw a ``?`` for a
  387. non-RFID spool in an otherwise-unidentified slot. Bambuddy's AMS card keys
  388. empty-vs-unknown off it so a non-Bambu spool shows ``?`` instead of "Empty"
  389. (#2527). Only the internal (printer-card) caller sets this; the VP bridge
  390. leaves it False so the ``exists`` key never reaches the slicer wire format.
  391. Mutates ``units`` in place. Returns the number of slots cleared.
  392. """
  393. if not tray_exist_bits_str:
  394. return 0
  395. try:
  396. if isinstance(tray_exist_bits_str, int):
  397. tray_exist_bits = tray_exist_bits_str
  398. else:
  399. tray_exist_bits = int(tray_exist_bits_str, 16)
  400. except (ValueError, TypeError):
  401. return 0
  402. if tray_exist_bits == 0 and not power_on_flag:
  403. return 0
  404. if not isinstance(units, list):
  405. return 0
  406. cleared = 0
  407. for ams_unit in units:
  408. if not isinstance(ams_unit, dict):
  409. continue
  410. ams_id_raw = ams_unit.get("id")
  411. if ams_id_raw is None:
  412. continue
  413. try:
  414. ams_id = int(ams_id_raw) if isinstance(ams_id_raw, str) else ams_id_raw
  415. except (ValueError, TypeError):
  416. continue
  417. if not isinstance(ams_id, int):
  418. continue
  419. # The A2L AMS-Lite reaches this helper under either id: `_handle_ams_data`
  420. # normalises 16 -> 6 before calling, but the VP bridge parses the raw
  421. # printer payload itself (`mqtt_bridge._on_printer_raw`) and still holds
  422. # the physical 16. Both mean bit base 24, so fold them together here
  423. # rather than relying on every caller to normalise first — reading 16 as
  424. # 16*4 = bit 64 finds nothing set and wipes every A2L slot (#2697).
  425. ams_id = normalize_am_unit_id(ams_id)
  426. # AMS-HT (n3s, id 128-135): single tray, presence bit at 16+(ams_id-128).
  427. # Regular AMS (and the A2L-Lite normalised to id 6): ams_id*4 + tray_id.
  428. # A rack AMS (unit 32): its global tray id 28 + slot.
  429. # Anything outside those has no known bit layout — don't guess it.
  430. kind = unit_ams_type(ams_id, ams_unit.get("info"))
  431. if tray_flag_bit(ams_id, 0, kind) is None:
  432. continue
  433. for tray in ams_unit.get("tray", []):
  434. if not isinstance(tray, dict):
  435. continue
  436. tray_id_raw = tray.get("id")
  437. if tray_id_raw is None:
  438. continue
  439. try:
  440. tray_id = int(tray_id_raw) if isinstance(tray_id_raw, str) else tray_id_raw
  441. except (ValueError, TypeError):
  442. continue
  443. if not isinstance(tray_id, int):
  444. continue
  445. global_bit = tray_flag_bit(ams_id, tray_id, kind)
  446. if global_bit is None or global_bit < 0:
  447. continue
  448. slot_exists = (tray_exist_bits >> global_bit) & 1
  449. if annotate_exists:
  450. tray["exists"] = bool(slot_exists)
  451. if slot_exists:
  452. continue
  453. tray["state"] = 9
  454. if tray.get("tray_type"):
  455. if log_label:
  456. logger.debug(
  457. f"[{log_label}] Clearing empty slot: AMS {ams_id} slot {tray_id} "
  458. f"(tray_exist_bits bit {global_bit} = 0)"
  459. )
  460. tray["tray_type"] = ""
  461. tray["tray_sub_brands"] = ""
  462. tray["tray_color"] = ""
  463. tray["tray_id_name"] = ""
  464. tray["tag_uid"] = "0000000000000000"
  465. tray["tray_uuid"] = "00000000000000000000000000000000"
  466. tray["tray_info_idx"] = ""
  467. tray["remain"] = 0
  468. cleared += 1
  469. return cleared
  470. # --- H2C nozzle-rack dispatch mapping (#2800) -------------------------------
  471. #
  472. # Physical nozzle IDs the H2C reports for its six rack slots, verified on
  473. # hardware. They sit well clear of the fixed hotend's own physical ID, so a
  474. # rack position is never mistakable for the nozzle on the other carriage.
  475. #
  476. # Extruder indices are a different namespace that happens to overlap these
  477. # low numbers -- index 1 means the rack, physical ID 1 means the fixed hotend.
  478. # Nothing below may pass a value from one namespace to the other untranslated;
  479. # doing exactly that is what #2800 was.
  480. _RACK_NOZZLE_IDS = frozenset(range(16, 22))
  481. # BambuStudio dispatches a fixed-length nozzle_mapping on rack models: one
  482. # physical nozzle ID per filament slot, -1 for slots the plate does not print.
  483. #
  484. # Briefly changed to the plate's own slot count on the strength of a single
  485. # 3-entry capture, then changed back: Studio's dispatch of a real 3-filament
  486. # project print on the maintainer's H2C is 32 entries ([16, 1, 18, -1 x29],
  487. # captured 2026-08-13 17:20, and that print completed). The 3-entry capture was
  488. # a calibration job, so the length varies with whatever Studio is doing rather
  489. # than with the filament count -- which makes it the wrong thing to derive.
  490. _RACK_WIRE_SLOTS = 32
  491. # The two carriages, as extruder indices in the form the queue stores (already
  492. # translated through the file's physical_extruder_map).
  493. #
  494. # Measured on the maintainer's H2C 2026-08-14, from three sources that agree:
  495. #
  496. # - telemetry: ``ams_extruder_map {'0': 1, '1': 0, '2': 0}`` -- AMS 0 feeds
  497. # extruder 1, AMS 1 and 2 feed extruder 0;
  498. # - BambuStudio's own dispatch of a plate using all three units sent AMS 0's
  499. # filament to physical nozzle 1 and AMS 1's to rack positions 16 and 18,
  500. # and that print completed. So extruder 1 is the fixed hotend and extruder
  501. # 0 is the rack;
  502. # - our own constants were internally inconsistent about it: physical nozzle
  503. # id N sits on extruder N (see the L/R split in PrintersPage), and
  504. # ``_FIXED_NOZZLE_ID`` is 1, which cannot be reconciled with a fixed
  505. # extruder index of 0.
  506. #
  507. # These were the other way round until then, which is what dispatched a plate
  508. # to the carriage that had not been levelled and printed its first layer in
  509. # mid-air. That value came from #2800, where dispatching [17, -1, -1, 1] printed
  510. # in mid-air and [1, -1, -1, 17] printed correctly -- but that A/B measured
  511. # which *wire* worked, and the extruder indices were only inferred from it by
  512. # pairing with a slot_extruders list the then-buggy 3MF reader had produced. The
  513. # wire result stands; the inference from it did not.
  514. _FIXED_EXTRUDER_ID = 1
  515. _RACK_EXTRUDER_ID = 0
  516. # The fixed hotend's physical ID, which is *not* its extruder index. The same
  517. # hardware A/B ruled the index out: [0, -1, -1, 17] was rejected by the printer
  518. # outright, which would not start the job at all. Native BambuStudio captures
  519. # of a mixed plate agree -- [1, 17, ...], and [17, 1, ...] once the filament
  520. # slot order is swapped, so the fixed side is 1 whichever slot it lands in.
  521. _FIXED_NOZZLE_ID = 1
  522. def resolve_rack_nozzle_mapping(
  523. slot_extruders: list[int],
  524. rack_nozzle_id: int | None,
  525. ) -> list[int] | None:
  526. """Expand a per-slot extruder mapping into an H2C physical nozzle_mapping.
  527. ``slot_extruders`` is the compact form stored on the queue item: MQTT
  528. extruder index per filament slot (index 0 = slot 1), -1 for a slot the
  529. plate does not print. ``rack_nozzle_id`` is the rack position the printer
  530. reports as live.
  531. Returns a ``_RACK_WIRE_SLOTS``-long list of physical nozzle IDs, or None
  532. when the mapping cannot be resolved with confidence -- in which case the
  533. caller omits the field entirely and the firmware falls back to its own
  534. nozzle pick, exactly as it did before this translation existed. Omitting
  535. is deliberately the failure mode: a *wrong* physical ID makes the printer
  536. level with one nozzle and print with another several millimetres off the
  537. bed, which is far worse than letting the firmware choose.
  538. Returns None specifically when:
  539. - a slot needs the rack but the printer has not reported a live rack
  540. position (mid-swap, or a stale connection);
  541. - no slot needs the rack at all. BambuStudio omits nozzle_mapping entirely
  542. for a plate sliced for the fixed hotend only (#2800 capture), so this
  543. matches it rather than naming a nozzle it does not have to name;
  544. - a slot names a carriage that is neither of the two an H2C has, which
  545. means the file was mapped for a machine this translation does not model;
  546. - the plate needs more slots than the wire format carries;
  547. - the input is not a list of whole numbers.
  548. Total by construction: it raises nothing, because the only caller is
  549. building an MQTT print command with no exception handler above it and the
  550. queue item has already been committed as `printing` by then. An
  551. unparseable input has to degrade to "let the firmware pick", not to a job
  552. wedged in a state no print will ever leave.
  553. """
  554. if not isinstance(slot_extruders, list) or not slot_extruders:
  555. return None
  556. if len(slot_extruders) > _RACK_WIRE_SLOTS:
  557. return None
  558. if not isinstance(rack_nozzle_id, int) or isinstance(rack_nozzle_id, bool):
  559. return None
  560. if rack_nozzle_id not in _RACK_NOZZLE_IDS:
  561. return None
  562. # Normalise first so the checks below, and the values that reach the wire,
  563. # are known ints. bool is an int subclass and would otherwise serialise as
  564. # a JSON `true`; None means "slot not printed" and is folded into -1.
  565. normalised: list[int] = []
  566. for extruder in slot_extruders:
  567. if extruder is None:
  568. normalised.append(-1)
  569. elif isinstance(extruder, int) and not isinstance(extruder, bool):
  570. normalised.append(extruder)
  571. else:
  572. return None
  573. if _RACK_EXTRUDER_ID not in normalised:
  574. return None
  575. wire = [-1] * _RACK_WIRE_SLOTS
  576. for index, extruder in enumerate(normalised):
  577. if extruder < 0:
  578. continue
  579. if extruder == _RACK_EXTRUDER_ID:
  580. wire[index] = rack_nozzle_id
  581. elif extruder == _FIXED_EXTRUDER_ID:
  582. wire[index] = _FIXED_NOZZLE_ID
  583. else:
  584. # An H2C has these two carriages and no others. A third index is a
  585. # file mapped for something else, and forwarding it raw would name
  586. # a physical nozzle by an index that does not identify one.
  587. return None
  588. return wire
  589. # A rack position as the operator counts it (and as the printer card and
  590. # BambuStudio both label it) is 1-based; the physical nozzle id is 15 higher.
  591. # Measured 2026-08-14: a plate dispatched with the operator picking R1 and R2
  592. # sent 16 and 17, and the same plate picking R1 and R3 sent 16 and 18.
  593. _RACK_POSITION_BASE = 15
  594. RACK_POSITIONS = tuple(range(1, len(_RACK_NOZZLE_IDS) + 1))
  595. def rack_position_to_nozzle_id(position: int) -> int | None:
  596. """Physical nozzle id for a 1-based rack position, or None if out of range."""
  597. if not isinstance(position, int) or isinstance(position, bool):
  598. return None
  599. if position not in RACK_POSITIONS:
  600. return None
  601. return _RACK_POSITION_BASE + position
  602. def _rack_slot_is_eligible(slot: dict, diameter: str, volume_type: str) -> bool:
  603. """Whether a live rack slot can print a group wanting this nozzle.
  604. Mirrors the filter BambuStudio applies in its own picker: the position has
  605. to hold a nozzle at all, and that nozzle has to match the slice's diameter
  606. and flow type. A mismatch here is not cosmetic -- it is the printer being
  607. asked to lay down a 0.4 extrusion through a 0.2 orifice.
  608. """
  609. if not isinstance(slot, dict):
  610. return False
  611. slot_diameter = str(slot.get("diameter") or "").strip()
  612. slot_type = str(slot.get("type") or "").strip()
  613. if not slot_diameter and not slot_type:
  614. return False # empty position
  615. # "0.40" and "0.4" are the same nozzle spelled two ways -- the 3MF pads,
  616. # the printer does not.
  617. try:
  618. if round(float(slot_diameter), 2) != round(float(diameter), 2):
  619. return False
  620. except (TypeError, ValueError):
  621. return False
  622. # Flow type: the printer reports a code ("HS", "HH01"), the slice reports a
  623. # name ("Standard", "High Flow"). Compared only when both are stated, so a
  624. # printer that omits the code is not thereby ruled ineligible.
  625. wanted = volume_type.strip().lower()
  626. if wanted and slot_type:
  627. is_high_flow = slot_type.upper().startswith("HH")
  628. if wanted.startswith("high flow") != is_high_flow:
  629. return False
  630. return True
  631. # The nozzle currently picked up onto the rack carriage. Physical id 1 is the
  632. # fixed hotend (``_FIXED_NOZZLE_ID``), so the other carriage entry is 0.
  633. _RACK_CARRIAGE_NOZZLE_ID = 0
  634. def _rack_by_position(rack_slots: list[dict]) -> dict[int, dict]:
  635. """Live rack contents keyed by 1-based position, mounted nozzle included.
  636. The firmware omits a rack id entirely while that nozzle is picked up onto
  637. the carriage (#943) -- it does not send an empty placeholder. Taking the
  638. omission at face value would rule the nozzle ineligible for the very print
  639. that wants it, and it is the single most likely position to be picked,
  640. because it is the one the last print left mounted.
  641. The absent id is recoverable only when exactly one is missing: rack ids are
  642. fixed at 16..21, so a single gap alongside a loaded carriage is that
  643. carriage's nozzle. Two or more gaps are genuinely ambiguous -- an operator
  644. with four nozzles in six positions looks the same -- so those stay absent
  645. and the caller treats them as empty.
  646. Measured 2026-08-14 09:02 on the maintainer's H2C: ``IDs: [16, 1, 21, 19,
  647. 18, 0, 20]`` -- both carriages present, rack id 17 the lone gap.
  648. """
  649. by_position: dict[int, dict] = {}
  650. carriage: dict | None = None
  651. for slot in rack_slots or []:
  652. if not isinstance(slot, dict) or not isinstance(slot.get("id"), int):
  653. continue
  654. if slot["id"] == _RACK_CARRIAGE_NOZZLE_ID:
  655. carriage = slot
  656. continue
  657. position = slot["id"] - _RACK_POSITION_BASE
  658. if position in RACK_POSITIONS:
  659. by_position[position] = slot
  660. missing = [position for position in RACK_POSITIONS if position not in by_position]
  661. if len(missing) == 1 and carriage is not None and (carriage.get("diameter") or carriage.get("type")):
  662. by_position[missing[0]] = carriage
  663. return by_position
  664. def resolve_rack_plan_mapping(
  665. slot_groups: list[int],
  666. groups: dict[int, dict],
  667. choice: dict[int, int],
  668. rack_slots: list[dict],
  669. ) -> tuple[list[int] | None, str | None]:
  670. """Build a physical ``nozzle_mapping`` from a rack plan and a position pick.
  671. This is the multi-hotend counterpart to :func:`resolve_rack_nozzle_mapping`.
  672. That one can only name the single live rack position, so a plate wanting a
  673. different hotend per group is unresolvable to it. Here each group carries
  674. its own position, which is the operator's choice (#1784) -- the 3MF states
  675. it nowhere, proven by dispatching one plate twice with different picks and
  676. diffing the two files down to float noise.
  677. ``choice`` may be partial or empty; groups it does not name are assigned
  678. from the live rack, preferring a position already loaded with the group's
  679. own filament colour and otherwise taking the lowest eligible one.
  680. Returns ``(wire, None)`` on success, or ``(None, reason)`` where *reason*
  681. is a sentence naming what could not be satisfied. The caller decides what
  682. to do with a failure, and the two cases differ: a stale *explicit* pick
  683. should stop the print, while a failed auto-assignment should degrade to
  684. letting the firmware choose, exactly as before this existed.
  685. """
  686. if not isinstance(slot_groups, list) or not slot_groups:
  687. return None, "the plate lists no filament slots"
  688. if len(slot_groups) > _RACK_WIRE_SLOTS:
  689. return None, f"the plate needs {len(slot_groups)} filament slots and the printer takes {_RACK_WIRE_SLOTS}"
  690. by_position = _rack_by_position(rack_slots)
  691. # Assign every rack-bound group a position before building the wire, so a
  692. # group can never be handed one an earlier group already took. Explicit
  693. # picks are placed first: an auto-assignment must yield to them rather than
  694. # claim a position the operator asked for.
  695. assigned: dict[int, int] = {}
  696. rack_group_ids = sorted(gid for gid, g in groups.items() if g.get("on_rack"))
  697. for group_id in rack_group_ids:
  698. position = choice.get(group_id)
  699. if position is None:
  700. continue
  701. group = groups[group_id]
  702. if rack_position_to_nozzle_id(position) is None:
  703. return None, f"rack position {position} does not exist"
  704. if position in assigned.values():
  705. return None, f"rack position {position} is picked for more than one filament group"
  706. slot = by_position.get(position)
  707. if slot is None:
  708. return None, f"the printer reports nothing at rack position {position}"
  709. if not _rack_slot_is_eligible(slot, group.get("nozzle_diameter", ""), group.get("volume_type", "")):
  710. return None, (
  711. f"rack position {position} holds a "
  712. f"{slot.get('diameter') or 'missing'} {slot.get('type') or ''} nozzle, "
  713. f"and the plate needs {group.get('nozzle_diameter')} {group.get('volume_type')}".replace(" ", " ")
  714. )
  715. assigned[group_id] = position
  716. for group_id in rack_group_ids:
  717. if group_id in assigned:
  718. continue
  719. group = groups[group_id]
  720. eligible = [
  721. position
  722. for position in RACK_POSITIONS
  723. if position not in assigned.values()
  724. and position in by_position
  725. and _rack_slot_is_eligible(
  726. by_position[position], group.get("nozzle_diameter", ""), group.get("volume_type", "")
  727. )
  728. ]
  729. if not eligible:
  730. return None, (
  731. f"no free rack position holds a {group.get('nozzle_diameter')} "
  732. f"{group.get('volume_type')} nozzle for filament group {group_id}"
  733. )
  734. # Prefer a position already carrying this group's colour: picking it
  735. # means the operator does not have to move filament to make the print
  736. # match what they asked for.
  737. wanted_colour = str(group.get("filament_color") or "").strip().lstrip("#").upper()[:6]
  738. assigned[group_id] = next(
  739. (
  740. position
  741. for position in eligible
  742. if wanted_colour
  743. and str(by_position[position].get("filament_color") or "").strip().lstrip("#").upper()[:6]
  744. == wanted_colour
  745. ),
  746. eligible[0],
  747. )
  748. wire = [-1] * _RACK_WIRE_SLOTS
  749. for index, group_id in enumerate(slot_groups):
  750. if not isinstance(group_id, int) or isinstance(group_id, bool) or group_id < 0:
  751. continue # slot this plate does not print
  752. group = groups.get(group_id)
  753. if group is None:
  754. return None, f"filament slot {index + 1} names group {group_id}, which the plate does not describe"
  755. if not group.get("on_rack"):
  756. wire[index] = _FIXED_NOZZLE_ID
  757. continue
  758. nozzle_id = rack_position_to_nozzle_id(assigned[group_id])
  759. if nozzle_id is None: # pragma: no cover - assigned only ever holds valid positions
  760. return None, f"filament group {group_id} resolved to no rack position"
  761. wire[index] = nozzle_id
  762. if all(value == -1 for value in wire):
  763. return None, "the plate assigns no filament to a nozzle"
  764. return wire, None
  765. @dataclass(frozen=True)
  766. class DryingCycleEnd:
  767. """What Bambuddy saw of one AMS drying cycle, reported when it ends (#2863).
  768. ``peak_minutes`` is the highest ``dry_time`` observed during the cycle and
  769. ``remaining_minutes`` the last one before the drop to 0. ``start_seen`` says
  770. whether the countdown was watched from its first minute; when it was not
  771. (Bambuddy started mid-cycle) the peak is only a lower bound on the length.
  772. ``target_temp`` / ``target_hours`` are known only for cycles Bambuddy itself
  773. started, because the printer never echoes them.
  774. """
  775. ams_id: int
  776. remaining_minutes: int
  777. peak_minutes: int
  778. start_seen: bool
  779. target_temp: int | None = None
  780. target_hours: int | None = None
  781. @dataclass
  782. class MQTTLogEntry:
  783. """Log entry for MQTT message debugging."""
  784. timestamp: str
  785. topic: str
  786. direction: str # "in" or "out"
  787. payload: dict
  788. @dataclass
  789. class HMSError:
  790. """Health Management System error from printer."""
  791. code: str
  792. attr: int # Attribute value for constructing wiki URL
  793. module: int
  794. # Bambu's alert level: 1 error (task stopped), 2 warning (task paused),
  795. # 3 notification, 0 invalid. From `code >> 16` for `hms[]` faults, and from
  796. # the error's first hex digit for `print_error` (#2728).
  797. severity: int
  798. # The bundled catalogue's sentence for this fault, resolved once here so
  799. # every surface that reports it — the status response, the WebSocket
  800. # broadcast, the completion payload, notifications — says the same thing.
  801. # None when Bambu publishes no text for the code; see `describe_fault`.
  802. # Replaces a `message` field that was never set or read anywhere.
  803. description: str | None = None
  804. # User-facing remediation actions from the bundled HMS catalog (e.g. "RESUME_PRINTING",
  805. # "CHECK_ASSISTANT"). Defaults to an empty list rather than None so the field always
  806. # satisfies HMSErrorResponse.actions: list[str] — a future code path that builds an
  807. # HMSError without explicitly passing actions can't silently land None on the schema
  808. # boundary and raise ValidationError at routes/printers.py response time.
  809. actions: list[str] = field(default_factory=list)
  810. # The `subtask_id` snapshotted from PrinterState when this error surfaced; Bambu's
  811. # HMS-aware commands echo it back as `job_id`. None for idle errors with no job.
  812. job_id: str | None = None
  813. # Canonical hex identifier for the firmware's `err` matching: 16 chars for the
  814. # 64-bit `hms[]` array path (`f"{attr:08X}{code:08X}"`), 8 chars for the
  815. # 32-bit `print_error` path. The frontend echoes this back to
  816. # execute_hms_action; the truncated 8-char short code that `_parse_status`
  817. # used to send caused the firmware to silently reject HMS commands on H2C
  818. # (#1830) and on `hms[]`-sourced faults generally.
  819. full_code: str = ""
  820. def completion_payload(self) -> dict:
  821. """This error as a print-complete payload carries it, for the failure reason."""
  822. return {
  823. "code": self.code,
  824. "attr": self.attr,
  825. "module": self.module,
  826. "severity": self.severity,
  827. # Lets the queue's failure reason label an `hms[]` fault
  828. # with its full code rather than a lossy short one (#2728).
  829. "full_code": self.full_code,
  830. # Carried so the queue's failure reason quotes the same
  831. # sentence the status response and the broadcast do,
  832. # rather than resolving the code a fourth time (#2926).
  833. "description": self.description,
  834. }
  835. def _is_print_error_entry(error: HMSError) -> bool:
  836. """Whether this entry came from the 32-bit `print_error` field, whose
  837. full code has 8 hex digits; an `hms[]` entry's has 16."""
  838. return len(error.full_code) == 8
  839. def _hms_short_code(error: HMSError) -> str:
  840. """The MMMM_EEEE short code of an entry from either source."""
  841. module = (error.attr >> 16) & 0xFFFF
  842. # The low half only: an hms[] code carries its alert level above it
  843. # (0x18061 for 0500_8061), and read whole it never matched, listing the
  844. # fault twice (M-U9).
  845. number = (int(error.code.replace("0x", ""), 16) & 0xFFFF) if error.code else 0
  846. return f"{module:04X}_{number:04X}"
  847. def _hms_short_codes(errors: list) -> set[str]:
  848. return {_hms_short_code(e) for e in errors}
  849. # HMS short codes the firmware emits during normal user-cancel sequences.
  850. # These aren't faults — they're status echoes that confirm the cancel happened.
  851. # Filtering them at parse-time keeps them out of state.hms_errors entirely,
  852. # so they don't drive the printer card's "X problem" badge, the red pip, or
  853. # any other consumer that treats hms_errors as the active-fault list.
  854. _HMS_USER_ACTION_CODES: frozenset[str] = frozenset(
  855. {
  856. "0300_400C", # "The task was canceled."
  857. "0500_400E", # "Printing was cancelled."
  858. }
  859. )
  860. # "MQTT command verification failed" — the printer's authorization/authentication
  861. # protection (firmware >= 01.08.03.00beta / 01.08.05.00) rejecting a control
  862. # command it could not verify. Queries (get_version, extrusion_cali_get,
  863. # pushall) still answer, so the connection looks perfectly healthy while
  864. # project_file, gcode_line and ams_change_filament are all silently dropped —
  865. # which is exactly how it presents: uploads succeed, the printer echoes our
  866. # subtask_id, then sits at IDLE forever (#2732).
  867. #
  868. # The 16-char form is load-bearing. This code's meaning lives in attr's low half
  869. # (0500) and code's high half (0001); the MMMM_EEEE short code collapses it to
  870. # "0500_0007", which matches nothing in any catalog.
  871. HMS_MQTT_VERIFY_FAILED: str = "0500050000010007"
  872. @dataclass
  873. class KProfile:
  874. """Pressure advance (K) calibration profile from printer."""
  875. slot_id: int
  876. extruder_id: int
  877. nozzle_id: str
  878. nozzle_diameter: str
  879. filament_id: str
  880. name: str
  881. k_value: str
  882. n_coef: str = "0.000000"
  883. ams_id: int = 0
  884. tray_id: int = -1
  885. setting_id: str | None = None
  886. @dataclass
  887. class NozzleInfo:
  888. """Nozzle hardware configuration."""
  889. nozzle_type: str = "" # "stainless_steel" or "hardened_steel"
  890. nozzle_diameter: str = "" # e.g., "0.4"
  891. # What await_cali_ack reports when the printer did not answer a K-profile write
  892. # in time. Not a refusal: firmware that predates the ack never answers.
  893. CALI_ACK_UNCONFIRMED = "no acknowledgement from printer"
  894. class KProfileReadError(Exception):
  895. """The printer's K-profile table could not be read: not connected, or no
  896. answer to any attempt. Not an empty table, which is a printer without
  897. profiles for that nozzle (#3404)."""
  898. # Time the printer has to list a skipped object in s_obj before the skip is
  899. # logged as not confirmed.
  900. SKIP_CONFIRM_TIMEOUT_S = 60.0
  901. # Answers to K-profile commands: they echo the command's own fields (the nozzle
  902. # diameter among them), never the printer's status.
  903. _KPROFILE_COMMAND_ANSWERS = frozenset(
  904. {"extrusion_cali_get", "extrusion_cali_set", "extrusion_cali_del", "extrusion_cali_sel"}
  905. )
  906. @dataclass
  907. class FilaSwitchState:
  908. """Filament Track Switch (FTS) accessory state.
  909. The FTS is an external accessory that mediates filament routing between an
  910. AMS and the printer's extruders. When installed, the AMS no longer has a
  911. fixed extruder assignment — any slot can be routed to any extruder via the
  912. track switch. Detected from print.device.fila_switch in MQTT.
  913. The switch has two inlets (In-A, In-B) and two outlets (Out-A, Out-B), and
  914. can pair any inlet with any outlet. Which AMS sits on which *inlet* is the
  915. stable, operator-visible relationship — it is set on the printer's "Manual
  916. AMS Setup" screen and read back from AMS ``info`` bits 24-27, not from here.
  917. Field semantics below are taken from BambuStudio's own parser
  918. (``DevFilaSwitch::ParseFilaSwitchInfo``), not inferred.
  919. """
  920. installed: bool = False
  921. # Raw ``in`` array, as it arrives. **Index 0 is In-B and index 1 is In-A** —
  922. # the arrays are ordered B-then-A, which is the opposite of how they read.
  923. # Each value is snow-encoded: bits 8-15 = AMS id, bits 0-7 = slot. -1 = the
  924. # inlet is empty. Use `inlet_slot()` rather than indexing this directly.
  925. in_slots: list[int] = field(default_factory=list)
  926. # Raw ``out`` array, same B-then-A order. out[i] = the extruder that *outlet*
  927. # terminates at (0 = right/main, 1 = left/deputy), or 0xE when unset. Note
  928. # this is the outlet's static wiring, NOT the live inlet→outlet route: which
  929. # inlet is currently paired with which outlet is not reported at all.
  930. out_extruders: list[int] = field(default_factory=list)
  931. stat: int = 0 # CaliStatus: 0 = idle, 1 = calibration stepping
  932. info: int = 0 # bit 0 = inlet has filament
  933. def inlet_slot(self, inlet: str) -> tuple[int, int] | None:
  934. """Decode ``in`` for inlet ``"A"`` or ``"B"`` into ``(ams_id, slot)``.
  935. Returns None when the inlet is empty, unreported, or ``inlet`` is not
  936. one of A/B.
  937. """
  938. index = {"A": 1, "B": 0}.get(inlet.upper())
  939. if index is None or index >= len(self.in_slots):
  940. return None
  941. raw = self.in_slots[index]
  942. if raw < 0:
  943. return None
  944. return (raw >> 8) & 0xFF, raw & 0xFF
  945. # ``snow``/``spre``/``star`` all use this sentinel for "nothing here". Studio
  946. # only special-cases it on single-extruder machines, but 0xFFFF decodes to AMS
  947. # 255 slot 255 and slot 255 is not a real slot on any machine, so treating it
  948. # as empty everywhere is strictly safer than reading it as the external spool.
  949. _EXTRUDER_SLOT_EMPTY = 0xFFFF
  950. @dataclass
  951. class ExtruderSlot:
  952. """Which AMS slot an extruder is currently fed from.
  953. Parsed from ``print.device.extruder.info[i]`` — ``snow`` is snow-encoded
  954. exactly like ``fila_switch.in`` (bits 8-15 = AMS id, bits 0-7 = slot), and
  955. bit 1 of ``info`` says whether the extruder actually holds filament. Field
  956. semantics from BambuStudio's ``DevExtruderSystem::ParseExtruderInfo``.
  957. ``state.tray_now`` cannot answer this: it is a single value for the whole
  958. printer, so on a dual-nozzle machine with both hotends loaded it names only
  959. one of them. Unloading a specific slot needs to know which extruder is
  960. holding it, which is what this is for.
  961. """
  962. ams_id: int | None = None
  963. slot_id: int | None = None
  964. has_filament: bool = False
  965. def holds(self, ams_id: int, slot_id: int) -> bool:
  966. """True when this extruder is fed from exactly ``(ams_id, slot_id)``."""
  967. return self.ams_id == ams_id and self.slot_id == slot_id
  968. @dataclass
  969. class PrintOptions:
  970. """AI detection and print options from xcam data."""
  971. # Core AI detectors
  972. spaghetti_detector: bool = False
  973. print_halt: bool = False
  974. halt_print_sensitivity: str = "medium" # Spaghetti sensitivity
  975. first_layer_inspector: bool = False
  976. printing_monitor: bool = False # AI print quality monitoring
  977. buildplate_marker_detector: bool = False
  978. allow_skip_parts: bool = False
  979. # Additional AI detectors - decoded from cfg bitmask
  980. nozzle_clumping_detector: bool = True
  981. nozzle_clumping_sensitivity: str = "medium"
  982. pileup_detector: bool = True
  983. pileup_sensitivity: str = "medium"
  984. airprint_detector: bool = True
  985. airprint_sensitivity: str = "medium"
  986. auto_recovery_step_loss: bool = True # Uses print.print_option command
  987. filament_tangle_detect: bool = False
  988. @dataclass
  989. class PrinterState:
  990. connected: bool = False
  991. state: str = "unknown"
  992. current_print: str | None = None
  993. subtask_name: str | None = None
  994. progress: float = 0.0
  995. remaining_time: int = 0
  996. layer_num: int = 0
  997. total_layers: int = 0
  998. temperatures: dict = field(default_factory=dict)
  999. raw_data: dict = field(default_factory=dict)
  1000. gcode_file: str | None = None
  1001. subtask_id: str | None = None
  1002. hms_errors: list = field(default_factory=list) # List of HMSError
  1003. kprofiles: list = field(default_factory=list) # List of KProfile
  1004. sdcard: bool = False # SD card inserted
  1005. # Whether the printer has ever actually told us about `sdcard`. Without this
  1006. # the default False is indistinguishable from a real "no card", and any
  1007. # consumer that treats False as evidence would act on silence — which is how
  1008. # a storage gate turns into a regression for every printer whose firmware
  1009. # simply doesn't publish the field (#2780).
  1010. sdcard_reported: bool = False
  1011. store_to_sdcard: bool = False # Store sent files on SD card (home_flag bit 11)
  1012. # Scheme+path of a `project_file` dispatch seen on the request topic, from
  1013. # whoever sent it (the slicer or us). Bambu states where the sliced file
  1014. # went: `ftp://<name>` is external storage, which FTPS serves, while
  1015. # `brtc://emmc/<name>` is the printer's internal storage, which it does not.
  1016. #
  1017. # Two fields, because the two readers need different guarantees.
  1018. # ``current_project_url`` belongs to the print now running and is cleared
  1019. # when that print ends, so a print Bambuddy saw no dispatch for reads as
  1020. # "unknown" rather than inheriting the previous job's answer. That matters:
  1021. # 18% of the print starts in #2780's bundle had no dispatch on the request
  1022. # topic at all (touchscreen reprints, restart recovery), and a stale
  1023. # internal-storage URL would make those skip an FTPS sweep that could have
  1024. # found the file — losing an archive that works today.
  1025. #
  1026. # ``last_project_url`` is sticky and exists for reporting only: the
  1027. # connection diagnostic is usually run *after* the print that prompted it,
  1028. # by which point the per-print value is rightly gone.
  1029. #
  1030. # None means we never saw a dispatch — say nothing, don't guess.
  1031. current_project_url: str | None = None
  1032. last_project_url: str | None = None
  1033. timelapse: bool = False # Timelapse recording active
  1034. ipcam: bool = False # Live view / camera streaming enabled
  1035. wifi_signal: int | None = None # WiFi signal strength in dBm
  1036. wired_network: bool = False # Ethernet connection detected (home_flag bit 18)
  1037. door_open: bool = False # Enclosure door open (home_flag bit 23; models with a door sensor: X1/X1C/X1E/X2D/P2S/H2*)
  1038. # Nozzle hardware info. Indexed by EXTRUDER id: [0] is the RIGHT hotend and
  1039. # [1] the left, measured 2026-08-27 on an H2D fitted with 0.4 left / 0.6
  1040. # right. (The legacy parser below writes left -> [0], but it only ever runs
  1041. # for single-nozzle printers -- every dual-nozzle model reports
  1042. # device.nozzle.info instead.) Read it through services.slot_nozzle rather
  1043. # than indexing it directly.
  1044. nozzles: list = field(default_factory=lambda: [NozzleInfo(), NozzleInfo()])
  1045. # AI detection and print options
  1046. print_options: PrintOptions = field(default_factory=PrintOptions)
  1047. # Calibration stage tracking (from stg_cur and stg fields)
  1048. stg_cur: int = -1 # Current stage index (-1 = not calibrating)
  1049. stg: list = field(default_factory=list) # List of stages to execute
  1050. # Air conditioning mode (0=cooling, 1=heating)
  1051. airduct_mode: int = 0
  1052. # Print speed level (1=silent, 2=standard, 3=sport, 4=ludicrous)
  1053. speed_level: int = 2
  1054. # Chamber light on/off
  1055. chamber_light: bool = False
  1056. # Active extruder for dual nozzle (0=right, 1=left) - from device.extruder.info[X].hnow
  1057. active_extruder: int = 0
  1058. # Currently loaded tray (global ID): 254/255 = external spools, 255 = no filament on legacy printers
  1059. tray_now: int = 255
  1060. # Firmware's target/previous tray as reported in print.ams (RAW, not globalised):
  1061. # tray_tar = the slot the paused/loading print now expects
  1062. # tray_pre = the slot that was loaded before (e.g. the one that ran out)
  1063. # For a single regular AMS these equal the global tray ID; for multi-AMS they
  1064. # are local slot IDs (0-3) that must be resolved against the mapping field, and
  1065. # for AMS-HT they are already global (128-135). 255 = none/idle, 254 = external.
  1066. # Surfaced during a runout PAUSE so the UI can name the expected slot (#2587).
  1067. tray_tar: int = 255
  1068. tray_pre: int = 255
  1069. # Last valid tray_now (0-253) — survives unload (255) for usage tracking after print completes
  1070. last_loaded_tray: int = -1
  1071. # Pending load target - used to track what tray we're loading for H2D disambiguation
  1072. pending_tray_target: int | None = None
  1073. # When it was set (time.monotonic): see PENDING_TRAY_TARGET_TTL.
  1074. pending_tray_target_at: float | None = None
  1075. # AMS status for filament change tracking (from print.ams.ams_status field)
  1076. # ams_status is a combined value: lower 8 bits = sub status, bits 8-15 = main status
  1077. # Main status: 0=idle, 1=filament_change, 2=rfid_identifying, 3=assist, 4=calibration, etc.
  1078. ams_status: int = 0
  1079. ams_status_main: int = 0 # (ams_status >> 8) & 0xFF
  1080. ams_status_sub: int = 0 # ams_status & 0xFF
  1081. # mc_print_sub_stage - filament change step indicator from print.mc_print_sub_stage
  1082. # Used by OrcaSlicer/BambuStudio to track progress during filament load/unload
  1083. mc_print_sub_stage: int = 0
  1084. # AMS mapping for dual nozzle: which slot is active (from ams.ams_exist_bits/tray_exist_bits)
  1085. ams_mapping: list = field(default_factory=list)
  1086. # The running print's AMS mapping (global tray per filament, -1 = none),
  1087. # as captured from its print command. None when no print has one.
  1088. print_ams_mapping: list | None = None
  1089. # Per-AMS extruder map: {ams_id: extruder_id} where 0=right/main, 1=left/deputy
  1090. ams_extruder_map: dict = field(default_factory=dict)
  1091. # Filament Track Switch (FTS) accessory — when installed, AMS info reports
  1092. # bits 8-11 = 0xE (uninitialized) because routing is dynamic. See #1162.
  1093. fila_switch: "FilaSwitchState" = field(default_factory=lambda: FilaSwitchState())
  1094. # Per-AMS FTS inlet binding: {ams_id: "A" | "B"}. Which of the switch's two
  1095. # filament inlets an AMS is plumbed into, as set on the printer's "Manual AMS
  1096. # Setup" screen. Only populated when an FTS is installed — without one an AMS
  1097. # is bound to an extruder instead and this stays empty. See FilaSwitchState.
  1098. ams_switch_inlet: dict = field(default_factory=dict)
  1099. # Which AMS slot each extruder is fed from: {extruder_id: ExtruderSlot}.
  1100. # Only populated by printers that report ``device.extruder.info`` (H2/X2
  1101. # series). Empty elsewhere, which every reader has to tolerate — see
  1102. # ExtruderSlot for why tray_now cannot stand in for it.
  1103. extruder_slots: dict = field(default_factory=dict)
  1104. # Plate dispatched by Bambuddy for the current print. Some firmware versions
  1105. # (P1S 01.10.00.00) only put the .3mf filename in print.gcode_file, so the
  1106. # regex used to derive the plate number from the path always falls back to
  1107. # plate 1 — and the printer card shows the wrong thumbnail (#1166). When
  1108. # Bambuddy dispatches the print itself we know the plate authoritatively;
  1109. # we record it here and prefer it over the gcode_file regex. The subtask
  1110. # field guards against staleness: if the printer is currently running a
  1111. # different subtask (e.g. a Studio-direct dispatch), these values are
  1112. # ignored. Cleared on disconnect.
  1113. dispatched_plate_id: int | None = None
  1114. dispatched_subtask: str | None = None
  1115. # H2D per-extruder tray_now from snow field: {extruder_id: normalized_global_tray_id}
  1116. # snow encodes AMS ID in high byte: ams_id = snow >> 8, slot = snow & 0xFF
  1117. h2d_extruder_snow: dict = field(default_factory=dict)
  1118. # H2C nozzle rack: full device.nozzle.info array for tool-changer printers (>2 nozzles)
  1119. nozzle_rack: list = field(default_factory=list)
  1120. # H2C rack position currently mounted / being moved to, from
  1121. # device.nozzle.src_id / tar_id. These are PHYSICAL nozzle IDs (16-21 for
  1122. # the six rack slots), not extruder indices, and they are what the
  1123. # dispatch `nozzle_mapping` array has to carry (#2800). Only the printer
  1124. # can tell us which hotend is in the carriage right now, so this is read
  1125. # live rather than derived from the queued job.
  1126. nozzle_rack_src_id: int | None = None
  1127. nozzle_rack_tar_id: int | None = None
  1128. # Timestamp of last AMS data update (for RFID refresh detection)
  1129. last_ams_update: float = 0.0
  1130. # Printable objects for skip object functionality: {identify_id: object_name}
  1131. printable_objects: dict = field(default_factory=dict)
  1132. # Objects that have been skipped during the current print
  1133. skipped_objects: list = field(default_factory=list)
  1134. # Pauses the slicer put into the running print, from its archived 3MF
  1135. # (#2984): threemf_tools.PausePoint, in print order. Empty when unknown.
  1136. pause_points: list = field(default_factory=list)
  1137. # Layers of those pauses a heads-up notification already went out for.
  1138. pause_warned_layers: set = field(default_factory=set)
  1139. # Fan speeds (0-100 percentage, None if not available for this model)
  1140. cooling_fan_speed: int | None = None # Part cooling fan
  1141. big_fan1_speed: int | None = None # Auxiliary fan
  1142. big_fan2_speed: int | None = None # Chamber/exhaust fan
  1143. heatbreak_fan_speed: int | None = None # Hotend heatbreak fan
  1144. # Left auxiliary part cooling fan (optional accessory on P2S/X2D). Reported ONLY
  1145. # via device.airduct.parts (decoded part id 10 = FAN_REMOTE_COOLING_1 in Bambu
  1146. # Studio's AIR_FUN enum) — the firmware does NOT mirror it into any flat
  1147. # big_fanX_speed field, which is why it was previously dropped. 0-100 percent.
  1148. left_aux_fan_speed: int | None = None
  1149. # Chamber exhaust fan, derived from the airduct parts list containing decoded
  1150. # id 3. On the P2S this is the External Exhaust Fan kit and a base machine
  1151. # omits it, which is the case this flag exists to detect.
  1152. #
  1153. # NOTE: the flag is not P2S/X2D-specific despite the name. The H2 series
  1154. # (H2C/H2D/H2S) also reports part 3, so this goes True there too. That is
  1155. # harmless because only the P2S/X2D badge consults it — those models keep
  1156. # their unconditional "Chamber Fan" badge — but do not read this as
  1157. # "an exhaust kit is fitted" without also checking the model.
  1158. exhaust_fan_present: bool = False
  1159. # Tray change history during current print: [(global_tray_id, layer_num), ...]
  1160. # Used by usage tracker to split filament weight on mid-print tray switch
  1161. tray_change_log: list = field(default_factory=list)
  1162. # Spools assigned to a tray during the current print, and the spool each
  1163. # assigned tray held at its start (services.spool_swaps, #3325).
  1164. spool_change_log: list = field(default_factory=list)
  1165. # Firmware version info (from info.module[name="ota"].sw_ver)
  1166. firmware_version: str | None = None
  1167. # Developer LAN mode: parsed from MQTT "fun" field bit 0x20000000
  1168. # True = dev mode ON (no encryption), False = dev mode OFF (encryption required), None = unknown
  1169. developer_mode: bool | None = None
  1170. # AMS Filament Backup: bit 18 of top-level print.cfg hex on new-protocol Bambu
  1171. # printers (H/X/P/H2 families). True=ON, False=OFF, None=unknown (e.g. A1 family
  1172. # which uses the old protocol path; field not yet found). Consumers must treat
  1173. # None as "no opinion" — preserving today's behaviour, NOT as "disabled".
  1174. ams_filament_backup: bool | None = None
  1175. # Stage name mapping from BambuStudio DeviceManager.cpp
  1176. STAGE_NAMES = {
  1177. 0: "Printing",
  1178. 1: "Auto bed leveling",
  1179. 2: "Heatbed preheating",
  1180. 3: "Vibration compensation",
  1181. 4: "Changing filament",
  1182. 5: "M400 pause",
  1183. 6: "Paused (filament ran out)",
  1184. 7: "Heating nozzle",
  1185. 8: "Calibrating dynamic flow",
  1186. 9: "Scanning bed surface",
  1187. 10: "Inspecting first layer",
  1188. 11: "Identifying build plate type",
  1189. 12: "Calibrating Micro Lidar",
  1190. 13: "Homing toolhead",
  1191. 14: "Cleaning nozzle tip",
  1192. 15: "Checking extruder temperature",
  1193. 16: "Paused by the user",
  1194. 17: "Pause (front cover fall off)",
  1195. 18: "Calibrating the micro lidar",
  1196. 19: "Calibrating flow ratio",
  1197. 20: "Pause (nozzle temperature malfunction)",
  1198. 21: "Pause (heatbed temperature malfunction)",
  1199. 22: "Filament unloading",
  1200. 23: "Pause (step loss)",
  1201. 24: "Filament loading",
  1202. 25: "Motor noise cancellation",
  1203. 26: "Pause (AMS offline)",
  1204. 27: "Pause (low speed of the heatbreak fan)",
  1205. 28: "Pause (chamber temperature control problem)",
  1206. 29: "Cooling chamber",
  1207. 30: "Pause (Gcode inserted by user)",
  1208. 31: "Motor noise showoff",
  1209. 32: "Pause (nozzle clumping)",
  1210. 33: "Pause (cutter error)",
  1211. 34: "Pause (first layer error)",
  1212. 35: "Pause (nozzle clog)",
  1213. 36: "Measuring motion precision",
  1214. 37: "Enhancing motion precision",
  1215. 38: "Measure motion accuracy",
  1216. 39: "Nozzle offset calibration",
  1217. 40: "High temperature auto bed leveling",
  1218. 41: "Auto Check: Quick Release Lever",
  1219. 42: "Auto Check: Door and Upper Cover",
  1220. 43: "Laser Calibration",
  1221. 44: "Auto Check: Platform",
  1222. 45: "Confirming BirdsEye Camera location",
  1223. 46: "Calibrating BirdsEye Camera",
  1224. 47: "Auto bed leveling - phase 1",
  1225. 48: "Auto bed leveling - phase 2",
  1226. 49: "Heating chamber",
  1227. 50: "Cooling heatbed",
  1228. 51: "Printing calibration lines",
  1229. 52: "Auto Check: Material",
  1230. 53: "Live View Camera Calibration",
  1231. 54: "Waiting for heatbed temperature",
  1232. 55: "Auto Check: Material Position",
  1233. 56: "Cutting Module Offset Calibration",
  1234. 57: "Measuring Surface",
  1235. 58: "Thermal Preconditioning",
  1236. 59: "Homing Blade Holder",
  1237. 60: "Calibrating Camera Offset",
  1238. 61: "Calibrating Blade Holder Position",
  1239. 62: "Hotend Pick and Place Test",
  1240. 63: "Waiting for Chamber temperature",
  1241. 64: "Preparing Hotend",
  1242. 65: "Calibrating nozzle clumping detection",
  1243. 66: "Purifying the chamber air",
  1244. 74: "Preparing", # Seen on H2D during print preparation
  1245. 77: "Preparing AMS",
  1246. }
  1247. def get_stage_name(stage: int) -> str:
  1248. """Get human-readable stage name from stage number."""
  1249. try:
  1250. return STAGE_NAMES.get(stage, f"Unknown stage ({stage})")
  1251. except TypeError:
  1252. # `stage` is an int by convention only -- it comes straight out of the
  1253. # printer's JSON, and an unhashable value there would otherwise raise
  1254. # from inside the f-string that builds the stage-change log line, which
  1255. # is evaluated on every transition whatever the log level is set to.
  1256. # Labelling a value must not be able to abort the state update.
  1257. return f"Unknown stage ({stage})"
  1258. # #2547 end-of-print telemetry probe.
  1259. #
  1260. # The finish photo needs a "printing is done, toolhead parked, filament unload
  1261. # not started yet" moment. ``stg_cur=22`` was meant to be that moment (#1721)
  1262. # but fires on no model in the field: across 247 support bundles there is not a
  1263. # single ``FINISH PHOTO MOMENT (stage-22)``, including the 2026-06-13..07-08
  1264. # window where it was the only pre-FINISH trigger in the code (104 captures on
  1265. # A1, A1 Mini, H2C, H2D, P1S, P2S, X1C, X2D — all of them the FINISH fallback).
  1266. #
  1267. # We can't design a replacement from bundles we already have, because out of
  1268. # this window Bambuddy only ever parses ``stg_cur`` and ``mc_print_sub_stage``;
  1269. # every other stage/action field is dropped unread. The obvious candidates
  1270. # (``print_real_action``, ``mc_action``, ``mc_stage``) are also absent from
  1271. # A1/A1 Mini/P1S payloads, so none of them can be the universal answer on its
  1272. # own. Dumping the raw values for the window between the last object layer and
  1273. # ``gcode_state=FINISH`` lets one debug bundle per model settle what — if
  1274. # anything — marks that moment.
  1275. #
  1276. # Every field here is machine telemetry (stage codes, counters, bitfields).
  1277. # Nothing identifying, and nothing that could carry an access code.
  1278. _END_OF_PRINT_PROBE_FIELDS = (
  1279. "gcode_state",
  1280. "state",
  1281. "print_error",
  1282. "stg_cur",
  1283. "stg",
  1284. "stg_cd",
  1285. "mc_print_stage",
  1286. "mc_print_sub_stage",
  1287. "mc_action",
  1288. "mc_stage",
  1289. "print_real_action",
  1290. "print_gcode_action",
  1291. "spd_lvl",
  1292. "mc_percent",
  1293. "mc_remaining_time",
  1294. "layer_num",
  1295. "total_layer_num",
  1296. "home_flag",
  1297. "prepare_per",
  1298. )
  1299. # Frame budget for one print's probe. A long final layer can hold the window
  1300. # open for minutes at ~1 frame/second; this stops a single print from filling
  1301. # the log the user then has to upload.
  1302. _END_OF_PRINT_PROBE_MAX_FRAMES = 400
  1303. # States that close the window. FINISH is the interesting one — the probe's
  1304. # whole job is to show what happened in the run-up to it.
  1305. _END_OF_PRINT_PROBE_CLOSING_STATES = frozenset({"FINISH", "FAILED", "IDLE", "PREPARE"})
  1306. class BambuMQTTClient:
  1307. """MQTT client for Bambu Lab printer communication."""
  1308. MQTT_PORT = 8883
  1309. # Class-level cache: serial_number -> False when request topic is known unsupported.
  1310. # Persists across client instances so reconnects don't re-trigger failed subscriptions.
  1311. _request_topic_cache: dict[str, bool] = {}
  1312. # serial_number -> consecutive disconnects seen shortly after subscribing to
  1313. # the request topic. A SUBACK failure is the broker answering the question;
  1314. # a disconnect is only circumstantial, and any drop inside the window looks
  1315. # identical -- a network blip, the printer rebooting, the container being
  1316. # stopped mid-probe. Latching on the first one costs ams_mapping capture for
  1317. # the rest of the process on a printer that supports it perfectly well
  1318. # (#2953). Require the drop to repeat before believing it; a printer that
  1319. # really does refuse the topic answers the same way every time and pays one
  1320. # extra reconnect for it.
  1321. _request_topic_probe_failures: dict[str, int] = {}
  1322. _REQUEST_TOPIC_PROBE_LIMIT: int = 2
  1323. # Counter for generating unique MQTT client IDs across instances.
  1324. _client_instance_counter: int = 0
  1325. # #2582: how long to wait for the AMS telemetry to echo back an assignment
  1326. # before declaring it un-confirmed. The printer re-broadcasts tray state
  1327. # every few seconds (and register_assignment_verification nudges a fresh
  1328. # pushall), so this only has to survive a couple of idle push intervals.
  1329. ASSIGNMENT_VERIFY_TIMEOUT: float = 30.0
  1330. def __init__(
  1331. self,
  1332. ip_address: str,
  1333. serial_number: str,
  1334. access_code: str,
  1335. model: str | None = None,
  1336. on_state_change: Callable[[PrinterState], None] | None = None,
  1337. on_print_start: Callable[[dict], None] | None = None,
  1338. on_print_complete: Callable[[dict], None] | None = None,
  1339. on_ams_change: Callable[[list], None] | None = None,
  1340. on_layer_change: Callable[[int], None] | None = None,
  1341. on_print_progress: Callable[[int], None] | None = None,
  1342. on_bed_temp_update: Callable[[float], None] | None = None,
  1343. on_drying_complete: Callable[[int], None] | None = None,
  1344. on_drying_cycle_end: Callable[[DryingCycleEnd], None] | None = None,
  1345. on_print_running_observed: Callable[[dict], None] | None = None,
  1346. on_finish_photo_moment: Callable[[dict], None] | None = None,
  1347. on_assignment_verified: Callable[[int, int, bool, dict], None] | None = None,
  1348. on_tray_change: Callable[[int, int], None] | None = None,
  1349. on_fts_inlet_change: Callable[[int, str], None] | None = None,
  1350. ):
  1351. self.ip_address = ip_address
  1352. self.serial_number = serial_number
  1353. self.access_code = access_code
  1354. self.model = model
  1355. # Last value logged by _debug_on_change(), keyed by log site. See there.
  1356. self._debug_last: dict[str, object] = {}
  1357. self.on_state_change = on_state_change
  1358. self.on_print_start = on_print_start
  1359. self.on_print_complete = on_print_complete
  1360. self.on_ams_change = on_ams_change
  1361. # Fired when an AMS is moved to the switch's other inlet, which changes
  1362. # the nozzle it feeds and so invalidates its slots' K-profile bindings.
  1363. self.on_fts_inlet_change = on_fts_inlet_change
  1364. self.on_layer_change = on_layer_change
  1365. # #2547: fired when `mc_percent` advances during a running print.
  1366. # `on_layer_change` stops firing the instant the final layer starts, so
  1367. # it is blind to the last few percent of a print — which is exactly the
  1368. # window the finish-photo frame bank needs to keep refreshing through.
  1369. # Progress is the one field that keeps ticking there and then freezes
  1370. # before the end G-code runs, so banking on it stays inside the print.
  1371. self.on_print_progress = on_print_progress
  1372. self.on_bed_temp_update = on_bed_temp_update
  1373. # #1349: fired when an AMS unit's dry_time falls from >0 to 0 — i.e.
  1374. # the drying cycle just finished (auto- or manually-triggered).
  1375. # Receives the AMS id of the unit that finished drying.
  1376. self.on_drying_complete = on_drying_complete
  1377. # #2863: fired on the same edge with what was seen of the cycle, so the
  1378. # spools in that AMS can be stamped as dried.
  1379. self.on_drying_cycle_end = on_drying_cycle_end
  1380. # #1485 follow-up: fired the first time we see RUNNING state in a
  1381. # session WHEN on_print_start was suppressed (Bambuddy started mid-
  1382. # print, the #1304 first-push guard skipped the start event). Lets
  1383. # main.py capture a fresh timelapse baseline at restart-recovery
  1384. # time so the completion-time snapshot-diff still works. Receives
  1385. # the same shape as on_print_start (filename / subtask_name /
  1386. # remaining_time / raw_data / ams_mapping).
  1387. self.on_print_running_observed = on_print_running_observed
  1388. # Fired for every entry appended to ``state.tray_change_log`` so main.py
  1389. # can mirror it into ``active_print_sessions``. The in-memory log dies
  1390. # with the process, and a long print outliving a restart would
  1391. # otherwise lose the segment boundaries the usage tracker splits on.
  1392. # Receives (global_tray_id, layer_num).
  1393. self.on_tray_change = on_tray_change
  1394. # #1721: fired the moment the printer enters the end-of-print
  1395. # "Filament unloading" phase (stg_cur=22 while progress>=99 or
  1396. # we've hit the last layer / remaining_time<=0). This is the
  1397. # framing #1397 was after — toolhead parked, bed not yet
  1398. # dropped — but reached via a clean state signal instead of
  1399. # the per-layer M622 J1 macros which caused per-layer nozzle
  1400. # parks on slicer profiles with Timelapse Type = Smooth.
  1401. # A FINISH-state fallback below fires this same callback if
  1402. # stage 22 never arrives (cancel mid-print, external-spool-
  1403. # only prints, HMS halt before unload, firmware variants).
  1404. self.on_finish_photo_moment = on_finish_photo_moment
  1405. # #2582: fired after a spool assignment (ams_filament_setting +
  1406. # extrusion_cali_sel) once the tray's telemetry either confirms the
  1407. # push landed or a timeout elapses without it. Receives
  1408. # (ams_id, tray_id, verified: bool, detail: dict). Lets the frontend
  1409. # tell the user "loaded" vs "assignment didn't take" instead of the
  1410. # historic fire-and-forget silence that made the AMS/Studio hand-off
  1411. # feel random. See _check_assignment_verifications.
  1412. self.on_assignment_verified = on_assignment_verified
  1413. # Pending read-back verifications, keyed by (ams_id, tray_id). Each
  1414. # value is the desired end-state we just pushed plus a monotonic
  1415. # deadline. Populated by register_assignment_verification, drained by
  1416. # _check_assignment_verifications on every AMS push.
  1417. self._pending_assignments: dict[tuple[int, int], dict] = {}
  1418. # Per-AMS previous dry_time, used to detect the falling edge above.
  1419. # Seeded lazily as we observe each AMS unit.
  1420. self._previous_dry_times: dict[int, int] = {}
  1421. # Per-AMS monotonic stamp of the last time dry_time CHANGED value.
  1422. # A live cycle's countdown ticks once a minute; a command the firmware
  1423. # accepted but never actually started (observed on an H2D mid-print
  1424. # with two AMS-HT cycles already running: the third unit's timer sat
  1425. # frozen at its full duration) never ticks. dry_time > 0 with no tick
  1426. # for DRY_COUNTDOWN_STALL_SECONDS and no active dry_status phase is
  1427. # reported as dry_countdown_stalled so the UI can stop claiming an
  1428. # active cycle that is not running.
  1429. self._dry_time_changed_at: dict[int, float] = {}
  1430. # Per-AMS active-cycle target params (filament + temp) we sent on the
  1431. # last start. Bambu does not echo these back in the per-tick AMS push
  1432. # — only the dry_time countdown — so we cache what we sent to drive
  1433. # the UI badge. Cleared on stop or on the dry_time falling edge to 0.
  1434. self._drying_targets: dict[int, dict[str, object]] = {}
  1435. # AMS ids we have sent a stop for and not yet seen end. A stop always
  1436. # ends a cycle far short of its duration, which on the telemetry alone
  1437. # is indistinguishable from the firmware abandoning it — so the cycle-end
  1438. # log would otherwise blame the printer for our own decision (#2770).
  1439. self._drying_stops_sent: set[int] = set()
  1440. # Per-AMS record of the cycle in progress: the highest dry_time seen,
  1441. # whether its first minute was observed, and the target we sent for it.
  1442. # The target is copied here when the countdown starts because a stop
  1443. # drops _drying_targets before the cycle ends (#2863).
  1444. self._dry_cycles: dict[int, dict[str, object]] = {}
  1445. # Stage numbers this printer has reported that STAGE_NAMES has no entry
  1446. # for, so each is reported once rather than on every transition into it.
  1447. self._unnamed_stages_seen: set[int] = set()
  1448. self.state = PrinterState()
  1449. self._client: mqtt.Client | None = None
  1450. self._loop: asyncio.AbstractEventLoop | None = None
  1451. self._previous_gcode_state: str | None = None
  1452. self._previous_gcode_file: str | None = None
  1453. self._was_running: bool = False # Track if we've seen RUNNING state for current print
  1454. self._completion_triggered: bool = False # Prevent duplicate completion triggers
  1455. self._timelapse_during_print: bool = False # Track if timelapse was active during this print
  1456. # #1721: one-shot guard so the end-of-print stage-22 detector
  1457. # and the FINISH-state fallback don't both fire on the same
  1458. # print. Reset to False on every print start.
  1459. self._finish_photo_captured: bool = False
  1460. # #2702: one-shot re-request of the layer total. Armed at print start
  1461. # when the starting frame carried no `total_layer_num`, spent on the
  1462. # first layer advance that still has no denominator. Bambu firmware
  1463. # only re-sends *changed* fields, so a total we never received (or
  1464. # dropped) is only recoverable via a full pushall.
  1465. self._total_layers_refresh_armed: bool = False
  1466. # #2547 end-of-print telemetry probe state. `_armed` is cleared once the
  1467. # window has run for a print so a late FINISH re-send can't reopen it.
  1468. self._eop_probe_armed: bool = True
  1469. self._eop_probe_open: bool = False
  1470. self._eop_probe_frames: int = 0
  1471. self._eop_probe_last: dict = {}
  1472. self._last_valid_progress: float = 0.0 # Last non-zero progress (firmware resets on cancel)
  1473. self._last_valid_layer_num: int = 0 # Last non-zero layer (firmware resets on cancel)
  1474. # #3317: the layer the previous print ended on. Right after a print
  1475. # starts, the printer can send one frame that still carries it (H2S:
  1476. # `layer_num` 357 with `mc_percent` 0, then 0 a second later). Taken at
  1477. # face value, the 0 that follows saved 357 as this print's last layer,
  1478. # and a print failing at layer 0 was charged as finished. Frames with
  1479. # this value are ignored until the new print reports another layer.
  1480. self._stale_layer_num: int = 0
  1481. # The subtask_id minted for the most recent start_print() command. The
  1482. # printer echoes it back in status, but often not within the first few
  1483. # seconds — so on_print_start uses this as the id source when the
  1484. # printer hasn't reported it yet, letting queue/scheduled archives
  1485. # persist a restart-stable id from the moment they dispatch (#1485).
  1486. self.last_dispatch_subtask_id: str | None = None
  1487. # The printer's answer to the last print start it refused, as (result,
  1488. # reason); cleared when the next start is sent. The start watchdog
  1489. # reads it to stop waiting for a print that will not come.
  1490. self.last_start_refusal: tuple[str, str | None] | None = None
  1491. self._is_dual_nozzle: bool = False # Set when device.extruder.info has >= 2 entries
  1492. self._message_log: deque[MQTTLogEntry] = deque(maxlen=100)
  1493. self._logging_enabled: bool = False
  1494. self._last_message_time: float = 0.0 # Track when we last received a message
  1495. # Count of report-topic messages received since the last (re)connect.
  1496. # Lets check_staleness() distinguish "printer never sent a status
  1497. # report" (typically a wrong / mis-cased serial) from a normal quiet
  1498. # gap mid-session. _zero_report_hint_logged keeps the actionable hint
  1499. # to once per client lifetime so the stale loop doesn't spam it (#1465).
  1500. self._report_messages_since_connect: int = 0
  1501. self._zero_report_hint_logged: bool = False
  1502. # Set by mark_power_off() to the gcode_state held just before we
  1503. # optimistically forced the printer to "unknown" (#2629). Restored on
  1504. # the next inbound message, because message traffic proves the power
  1505. # was never actually cut. None whenever no power-off is presumed.
  1506. self._state_before_power_off: str | None = None
  1507. # Raw-message fan-out for VP MQTT bridge (non-proxy modes republish the
  1508. # printer's pushes verbatim to slicers connected to a virtual printer).
  1509. # Handlers receive (topic, payload_bytes) before JSON parsing.
  1510. self._raw_message_handlers: list[Callable[[str, bytes], None]] = []
  1511. self._disconnection_event: threading.Event | None = None
  1512. self._previous_ams_hash: str | None = None # Track AMS changes
  1513. # Track external-spool (vt_tray) identity changes separately: the AMS
  1514. # hash above covers only AMS units, so an external-spool-only filament
  1515. # swap would never re-trigger inventory reconciliation (#2575).
  1516. self._previous_vt_tray_hash: str | None = None
  1517. # Cache AMS firmware/SN from get_version in case it arrives before AMS status
  1518. # Key: ams_id (int). Value: {'sw_ver': str, 'sn': str}
  1519. self._ams_version_cache: dict[int, dict[str, str]] = {}
  1520. # Track which (ams_id, field) warnings have already been emitted this connection
  1521. # so that missing-serial / missing-firmware warnings fire only once per connection.
  1522. self._ams_version_warned: set[tuple[int | str, str]] = set()
  1523. # K-profile command tracking. One entry per in-flight extrusion_cali_get,
  1524. # keyed by the sequence_id we sent, so two concurrent requests for
  1525. # different nozzle sizes can't steal each other's response (#1748).
  1526. # Value: {"nozzle": str, "event": asyncio.Event, "profiles": list | None}.
  1527. self._sequence_id: int = 0
  1528. self._pending_kprofile_requests: dict[str, dict] = {}
  1529. # The printer's calibration table, one bucket per nozzle diameter.
  1530. #
  1531. # An extrusion_cali_get response is the complete table for *one* nozzle
  1532. # size, and the printer answers whoever asks — including BambuStudio,
  1533. # whose queries land on the same report topic we subscribe to. Assigning
  1534. # each response straight to state.kprofiles therefore let any single
  1535. # answer stand for the whole printer: a GitHub backup probing
  1536. # 0.2/0.4/0.6/0.8 in turn finished on 0.8, which holds no profiles on a
  1537. # 0.4+0.6 machine, and left the list empty until something refilled it.
  1538. # Measured on the maintainer's H2 on 2026-08-25, and visible on the AMS
  1539. # card because H2-series trays carry no `k` of their own — the slot's
  1540. # K value is resolved from cali_idx against exactly this list.
  1541. #
  1542. # Keyed by diameter so a response only ever replaces the bucket it
  1543. # actually describes; state.kprofiles is then the union across buckets.
  1544. # An empty answer for a nozzle the printer doesn't have empties that
  1545. # bucket alone.
  1546. self._kprofiles_by_nozzle: dict[str, list] = {}
  1547. # Acks for K-profile *writes* (extrusion_cali_set / extrusion_cali_del),
  1548. # keyed by the sequence_id we sent. The printer echoes it back, measured
  1549. # on both an X1C and an H2D (#2718). Filled by the MQTT thread, drained
  1550. # by await_cali_ack.
  1551. self._pending_cali_acks: dict[str, dict | None] = {}
  1552. # Objects sent in skip_objects that the printer's s_obj list has not
  1553. # shown yet: object id -> when it was sent. And the ids of each
  1554. # command by its sequence_id, for its answer.
  1555. self._unconfirmed_skips: dict[int, float] = {}
  1556. self._skip_commands: dict[str, list[int]] = {}
  1557. # Acks for RFID re-reads (ams_get_rfid, and the M620 R gcode_line
  1558. # fallback), keyed the same way. Drained by ams_refresh_tray (#3206).
  1559. self._pending_rfid_acks: dict[str, dict | None] = {}
  1560. # Identifies the one project_file *we* dispatched, so its echo on the
  1561. # topic can be told apart from a slicer's. One-shot: consumed by the
  1562. # first frame that matches. See _project_file_key.
  1563. self._own_project_file_key: str | None = None
  1564. # Xcam hold timers - OrcaSlicer pattern: ignore incoming data for 3 seconds after command
  1565. # Key: module_name, Value: timestamp when command was sent
  1566. self._xcam_hold_start: dict[str, float] = {}
  1567. self._xcam_hold_time: float = 3.0 # Ignore incoming data for 3 seconds after command
  1568. # True once the printer has sent `cfg`; from then on AMS Filament Backup
  1569. # is read from cfg only, never from home_flag (#3259).
  1570. self._backup_cfg_seen: bool = False
  1571. # True once a full status report arrived without `cfg`; from then on
  1572. # home_flag bit 10 is read from every status frame (#3259).
  1573. self._backup_home_flag_trusted: bool = False
  1574. # Whether the frame being handled carried the nozzles' snow: only then
  1575. # may snow overrule the slot the same frame reports as tray_now.
  1576. self._snow_in_frame = False
  1577. # The captured ams_mapping lives on the state (print_ams_mapping), so
  1578. # the status the card reads carries it; see _captured_ams_mapping.
  1579. # The destination of the dispatch it was captured from.
  1580. self._captured_mapping_url: str | None = None
  1581. # True once we've seen (and normalised 16->6) an A2L AMS-Lite unit in the
  1582. # AMS telemetry. Used to globalise the Lite's local `tray_now` to 24+slot.
  1583. # See normalize_am_unit_id / a2l_lite_wire_ids and memory a2l-am-unit-16.
  1584. self._has_a2l_am_unit: bool = False
  1585. # Rack AMS units already logged as detected (once per unit).
  1586. self._rack_ams_logged: set[int] = set()
  1587. self._tray_layout_key: tuple | None = None
  1588. self._tray_layout = TrayLayout()
  1589. # Why the last connection attempt was refused by the printer, or None
  1590. # when we have never seen a CONNACK failure since the last success.
  1591. # Without this a rejected access code was completely invisible: paho
  1592. # reports the follow-up disconnect as the generic "Unspecified error"
  1593. # and `_on_connect`'s failure branch used to log nothing at all, so a
  1594. # printer stuck in a reconnect loop looked identical whether it was
  1595. # powered off, on the wrong IP, or refusing our credentials (#2698).
  1596. # One of the CONNECT_ERROR_* slugs; the paired name is the paho reason
  1597. # string, kept for the log line only.
  1598. self.last_connect_error: str | None = None
  1599. self.last_connect_error_name: str | None = None
  1600. # Request topic subscription tracking
  1601. # Some printer MQTT brokers (e.g. P1S, A1) reject subscriptions to the request
  1602. # topic by killing the TCP connection. We detect this and gracefully degrade.
  1603. # Check class-level cache first so new client instances don't retry known-bad subscriptions.
  1604. self._request_topic_supported: bool = BambuMQTTClient._request_topic_cache.get(self.serial_number, True)
  1605. self._request_topic_sub_mid: int | None = None
  1606. self._request_topic_sub_time: float = 0.0
  1607. self._request_topic_confirmed: bool = False
  1608. # Developer mode probe: when the "fun" field is absent (A1/P1 printers),
  1609. # we probe by sending an ams_filament_setting and checking the response.
  1610. # "mqtt message verify failed" → dev mode OFF, success → dev mode ON.
  1611. self._dev_mode_probed: bool = False
  1612. self._dev_mode_needs_probe: bool = False # True after seeing a pushall without "fun"
  1613. self._dev_mode_probe_seq: str | None = None
  1614. self._dev_mode_probe_time: float = 0.0 # monotonic timestamp when probe was sent
  1615. self._dev_mode_probe_failures: int = 0 # consecutive unanswered probes
  1616. # True while developer_mode=False came from HMS_MQTT_VERIFY_FAILED rather
  1617. # than from the probe or the "fun" bit. The HMS is a latch, not a level:
  1618. # the printer reports it until the fault clears, so when a later hms[]
  1619. # arrives without it (user enabled Developer Mode and restarted the
  1620. # printer) we drop back to "unknown" and let the probe re-run instead of
  1621. # leaving a permanently-wrong False behind (#2732).
  1622. self._dev_mode_from_hms: bool = False
  1623. self._connect_time: float = 0.0 # monotonic timestamp of last _on_connect
  1624. # Set when check_staleness() force-closes the socket to trigger reconnect.
  1625. # Prevents _on_disconnect from redundantly broadcasting state (already done).
  1626. self._stale_reconnecting: bool = False
  1627. # Timestamp of last stale reconnect — prevents rapid-fire socket closes
  1628. # when the frontend polls status faster than paho can reconnect.
  1629. self._last_stale_reconnect: float = 0.0
  1630. # Zombie session detection via ams_filament_setting response tracking (#887).
  1631. # The dev-mode probe only runs on first connect; this catches zombie sessions
  1632. # that develop later (telemetry flows but publishes silently fail).
  1633. self._last_ams_cmd_time: float = 0.0 # monotonic time of last published command
  1634. self._ams_cmd_unanswered: int = 0 # consecutive commands with no response
  1635. @property
  1636. def topic_subscribe(self) -> str:
  1637. return f"device/{self.serial_number}/report"
  1638. @property
  1639. def topic_publish(self) -> str:
  1640. return f"device/{self.serial_number}/request"
  1641. @property
  1642. def report_messages_since_connect(self) -> int:
  1643. """Count of report-topic messages received since the latest (re)connect.
  1644. Exposed for the connection diagnostic so it can distinguish "MQTT
  1645. broker accepted us but the printer never published" (typically a
  1646. wrong / mis-cased serial — #1622 follow-up to #1602) from a healthy
  1647. bridge that happens to be idle right now. Zero immediately after a
  1648. fresh connect is normal; zero after a full status push cycle is the
  1649. wrong-serial failure mode.
  1650. """
  1651. return self._report_messages_since_connect
  1652. # Maximum time (seconds) without a message before considering connection stale
  1653. STALE_TIMEOUT = 60.0
  1654. def is_stale(self) -> bool:
  1655. """Check if the connection is stale (no messages for too long)."""
  1656. if self._last_message_time == 0:
  1657. return False # Never received a message yet
  1658. time_since_last = time.time() - self._last_message_time
  1659. return time_since_last > self.STALE_TIMEOUT
  1660. def mark_power_off(self) -> bool:
  1661. """Presume the printer lost power (smart plug switched off).
  1662. Optimistic: it skips the MQTT stale timeout so the UI updates at once.
  1663. The presumption is undone by ``_on_message`` if the printer keeps
  1664. talking — inbound traffic proves the power was never cut (#2629).
  1665. Returns True when the state was actually changed.
  1666. """
  1667. if not self.state.connected:
  1668. return False
  1669. previous = self.state.state
  1670. # Blank the state BEFORE recording what to restore. This runs on the
  1671. # event loop while _on_message runs on the paho thread, and the restore
  1672. # is a two-step (read saved state, compare against "unknown"). Writing
  1673. # "unknown" first means an interleaved message either sees no saved
  1674. # state yet (and skips, leaving the next message to restore) or sees a
  1675. # consistent pair — never a saved state paired with a live state it
  1676. # then discards, which would strand the printer on "unknown".
  1677. self.state.connected = False
  1678. self.state.state = "unknown"
  1679. # Only the first mark wins: a second call before any message arrives
  1680. # must not overwrite the real state with the "unknown" it just wrote.
  1681. # Nothing to restore if the state was already blank.
  1682. if self._state_before_power_off is None and previous not in ("", "unknown"):
  1683. self._state_before_power_off = previous
  1684. return True
  1685. def _restore_state_after_false_power_off(self) -> bool:
  1686. """Undo a presumed power-off once the printer proves it is alive.
  1687. ``connected`` self-heals on the next message, but ``state`` does not:
  1688. it is only rewritten when a payload carries ``gcode_state``, and the
  1689. steady-state ``push_status`` frames are partial. Without this the
  1690. forced "unknown" sticks until a full pushall (a manual Force Refresh),
  1691. and the queue scheduler treats the printer as not idle the whole time
  1692. (#2629). Returns True when a state was restored.
  1693. """
  1694. previous = self._state_before_power_off
  1695. self._state_before_power_off = None
  1696. if previous is None or self.state.state != "unknown":
  1697. return False
  1698. logger.info(
  1699. "[%s] Printer still responding after presumed power-off — restoring state %s",
  1700. self.serial_number,
  1701. previous,
  1702. )
  1703. self.state.state = previous
  1704. return True
  1705. # Minimum seconds between stale reconnect attempts. Frontend polls
  1706. # status every few seconds — without a cooldown, each poll would
  1707. # force-close the socket before paho has time to reconnect.
  1708. STALE_RECONNECT_COOLDOWN = 30.0
  1709. def check_staleness(self) -> bool:
  1710. """Check staleness and update connected state if stale. Returns True if connected."""
  1711. if self.state.connected and self.is_stale():
  1712. # Don't force-close again if we already did recently — give paho
  1713. # time to reconnect and the printer time to send its first message.
  1714. now = time.time()
  1715. if now - self._last_stale_reconnect < self.STALE_RECONNECT_COOLDOWN:
  1716. return self.state.connected
  1717. logger.warning(
  1718. f"[{self.serial_number}] Connection stale - no message for {now - self._last_message_time:.1f}s, forcing reconnect"
  1719. )
  1720. # A connection that keeps going stale without ever receiving a
  1721. # status report is almost always a wrong or mis-cased serial
  1722. # number — the broker accepts the connection and the subscription
  1723. # regardless, but the printer publishes to device/<real-serial>/
  1724. # report, which is case-sensitive. Surface that once so the user
  1725. # has something actionable instead of an endless reconnect loop.
  1726. # Only meaningful once the *current* session has had time to receive
  1727. # something. _report_messages_since_connect is reset by _on_connect,
  1728. # so a reconnect that lands microseconds before this check leaves it
  1729. # at 0 for reasons that have nothing to do with the serial — which is
  1730. # how a healthy P1S ended up being told to go check its serial number
  1731. # 1 ms after reconnecting (#2732). Requiring STALE_TIMEOUT of silence
  1732. # on this session means the hint only fires when the printer really
  1733. # has published nothing to the topic we subscribed to.
  1734. # _connect_time of 0 means we have no timestamp to judge by (never went
  1735. # through _on_connect); fall back to the old unconditional behaviour
  1736. # rather than silently swallowing the hint.
  1737. session_too_young = self._connect_time > 0 and (time.monotonic() - self._connect_time) < self.STALE_TIMEOUT
  1738. if self._report_messages_since_connect == 0 and not session_too_young and not self._zero_report_hint_logged:
  1739. self._zero_report_hint_logged = True
  1740. logger.warning(
  1741. "[%s] Connected and subscribed, but the printer has sent zero "
  1742. "status reports. The most common cause is a wrong or mis-cased "
  1743. "serial number — the device/<serial>/report MQTT topic is "
  1744. "case-sensitive. Verify the serial number configured in Bambuddy "
  1745. "exactly matches the printer.",
  1746. self.serial_number,
  1747. )
  1748. self._last_stale_reconnect = now
  1749. self.state.connected = False
  1750. if self.on_state_change:
  1751. self.on_state_change(self.state)
  1752. # Route based on caller thread — see force_reconnect_stale_session.
  1753. # check_staleness is normally called from FastAPI handlers (async,
  1754. # gets the hard-reset path) but the dispatcher exists for safety.
  1755. self._stale_reconnecting = True
  1756. self._reset_client_for_reconnect()
  1757. return self.state.connected
  1758. def force_reconnect_stale_session(self, reason: str) -> None:
  1759. # Heals the #887/#936/#1136 half-broken session: telemetry keeps
  1760. # arriving but our publishes don't reach the printer.
  1761. #
  1762. # Two routing paths:
  1763. #
  1764. # Async-context callers (queue dispatch deadline)
  1765. # → full client teardown + fresh client_id. Wipes paho's client-side
  1766. # QoS 1 queue, which is exactly the #1136 reproducer: an unacked
  1767. # `project_file` from the broken session would otherwise replay on
  1768. # reconnect, mixing stale commands into the next dispatch and
  1769. # triggering 0500_4003 SD R/W on the printer.
  1770. #
  1771. # Paho-network-thread callers (dev-mode probe and ams_filament_setting
  1772. # zombie detection, both inside `_update_state`)
  1773. # → socket-close fallback. There is no running loop on that thread to
  1774. # hand the rebuilt client, so close the socket and let paho's own
  1775. # loop detect the broken connection and auto-reconnect (same
  1776. # instance, same client_id). paho would re-send its old outbox on
  1777. # that reconnect; _on_connect empties it first (#3454).
  1778. logger.warning("[%s] Forcing MQTT reconnect: %s", self.serial_number, reason)
  1779. self._stale_reconnecting = True
  1780. self.state.connected = False
  1781. if self.on_state_change:
  1782. self.on_state_change(self.state)
  1783. self._reset_client_for_reconnect()
  1784. def _reset_client_for_reconnect(self) -> None:
  1785. """Route between hard-reset and socket-close based on caller thread.
  1786. Hard-reset (preferred) rebuilds the client, and the rebuild needs a
  1787. running loop to hand to ``connect()``. ``asyncio.get_running_loop()``
  1788. answers that and identifies the caller in one go — paho's callback
  1789. thread has no loop; every legitimate hard-reset caller (FastAPI
  1790. handlers, background async tasks) does."""
  1791. try:
  1792. loop = asyncio.get_running_loop()
  1793. except RuntimeError:
  1794. loop = None
  1795. if loop is not None:
  1796. self._loop = loop
  1797. self._hard_reset_client()
  1798. else:
  1799. self._socket_close_for_reconnect()
  1800. def _hard_reset_client(self) -> None:
  1801. """Tear down the paho client entirely and rebuild it with a fresh
  1802. client_id, so the broker drops the old session and paho's local
  1803. QoS 1 queue is gone. Must NOT be called from paho's network thread.
  1804. Caller is responsible for setting ``_stale_reconnecting`` and
  1805. broadcasting the disconnected state.
  1806. Returns as fast as it can build a client: the old one's teardown is
  1807. handed off rather than waited on, because waiting on it is what
  1808. stopped the event loop in #3068. See ``retire_paho_client``."""
  1809. old_client = self._client
  1810. self._client = None
  1811. if old_client is not None:
  1812. retire_paho_client(old_client, self.serial_number)
  1813. # Skip reconnect if no asyncio loop is available (test environment or
  1814. # pre-init). The next initial connect() call from PrinterManager will
  1815. # set up the client fresh.
  1816. if self._loop is None:
  1817. return
  1818. try:
  1819. self.connect(loop=self._loop)
  1820. except Exception as e:
  1821. logger.error("[%s] Hard reset reconnect failed: %s", self.serial_number, e)
  1822. def _socket_close_for_reconnect(self) -> None:
  1823. """Close the underlying socket so paho's loop thread detects the
  1824. broken connection and triggers auto-reconnect on the SAME client
  1825. instance. Safe to call from paho's own network thread (the loop
  1826. polls the socket on every iteration and handles a closed socket
  1827. gracefully). Used as a fallback when hard-reset isn't safe. The old
  1828. outbox is not re-sent: _on_connect empties it first (#3454)."""
  1829. if self._client:
  1830. try:
  1831. sock = self._client.socket()
  1832. if sock:
  1833. sock.close()
  1834. except Exception:
  1835. pass
  1836. def _drop_previous_connection_commands(self, client) -> None:
  1837. """Forget every command queued on an earlier connection (#3454).
  1838. Called first in on_connect, which paho runs before it re-sends its
  1839. old outbox. Makes every printer command at most once per connection;
  1840. a command lost in the seconds before a drop is clicked again."""
  1841. dropped = discard_queued_publishes(client)
  1842. if dropped is None:
  1843. logger.warning(
  1844. "[%s] Cannot clear paho's outbox on reconnect (paho internals changed); "
  1845. "commands from the previous connection may be sent again",
  1846. self.serial_number,
  1847. )
  1848. elif dropped:
  1849. logger.info(
  1850. "[%s] Dropped %d command(s) queued on the previous MQTT connection",
  1851. self.serial_number,
  1852. dropped,
  1853. )
  1854. def _on_connect(self, client, userdata, flags, rc, properties=None):
  1855. if rc == 0:
  1856. # First, before anything here publishes on the new connection.
  1857. self._drop_previous_connection_commands(client)
  1858. self.state.connected = True
  1859. self.last_connect_error = None
  1860. self.last_connect_error_name = None
  1861. self._stale_reconnecting = False # Clear stale-reconnect flag on successful connect
  1862. # A dropped-and-restored MQTT session means the presumed power-off was
  1863. # real (or at least that the printer restarted): there is nothing
  1864. # legitimate left to restore, and the printer will send a full status
  1865. # push shortly. Dropping the saved state keeps a stale one from being
  1866. # broadcast ahead of the first real report (#2629, #1679).
  1867. self._state_before_power_off = None
  1868. # Reset per-connection warning state so warnings fire once per (re)connection
  1869. self._ams_version_warned = set()
  1870. # Preserve cached developer_mode across auto-reconnects to avoid
  1871. # re-probing on every reconnect. The probe (ams_filament_setting to
  1872. # ext slot) can destabilize some firmware MQTT brokers, causing a
  1873. # reconnect → probe → disconnect feedback loop (#887). Only probe
  1874. # once when developer_mode is truly unknown (first connect).
  1875. # Reset probe tracking so stale timeout state doesn't carry over.
  1876. self._dev_mode_probed = False
  1877. self._dev_mode_needs_probe = False
  1878. self._dev_mode_probe_seq = None
  1879. self._dev_mode_probe_time = 0.0
  1880. self._dev_mode_probe_failures = 0
  1881. self._connect_time = time.monotonic()
  1882. self._report_messages_since_connect = 0
  1883. self._last_ams_cmd_time = 0.0
  1884. self._ams_cmd_unanswered = 0
  1885. # Drop any assignment verifications that were mid-flight before the
  1886. # reconnect — their deadlines are stale and the tray state we would
  1887. # compare against is about to be re-pushed from scratch (#2582).
  1888. # Dropping is silent (no failure event) on purpose.
  1889. self._pending_assignments.clear()
  1890. client.subscribe(self.topic_subscribe)
  1891. # Subscribe to request topic for ams_mapping capture (if supported by broker)
  1892. if self._request_topic_supported:
  1893. result, mid = client.subscribe(self.topic_publish)
  1894. if result == mqtt.MQTT_ERR_SUCCESS:
  1895. self._request_topic_sub_mid = mid
  1896. self._request_topic_sub_time = time.time()
  1897. self._request_topic_confirmed = False
  1898. else:
  1899. logger.warning(
  1900. "[%s] Failed to send request topic subscription",
  1901. self.serial_number,
  1902. )
  1903. self._request_topic_supported = False
  1904. BambuMQTTClient._request_topic_cache[self.serial_number] = False
  1905. # Request full status update (includes nozzle info in push_status response)
  1906. self._request_push_all()
  1907. # Request firmware version info
  1908. self._request_version()
  1909. # Note: get_accessories returns stale nozzle data on H2D, so we don't use it.
  1910. # The correct nozzle data comes from push_status.
  1911. # Prime K-profile request (Bambu printers often ignore first request)
  1912. self._prime_kprofile_request()
  1913. # Immediately broadcast connection state change
  1914. if self.on_state_change:
  1915. self.on_state_change(self.state)
  1916. else:
  1917. self.state.connected = False
  1918. self._record_connect_refusal(rc)
  1919. def _record_connect_refusal(self, rc) -> None:
  1920. """Log and remember why the printer refused the MQTT connection.
  1921. The failure branch of ``_on_connect`` used to be a bare
  1922. ``connected = False``, which threw away the only signal that says
  1923. *why* a printer never comes online. The user-visible result was a
  1924. 30-second reconnect loop logging nothing but paho's generic
  1925. ``MQTT disconnected: rc=Unspecified error`` — indistinguishable from a
  1926. powered-off printer, so "my printer won't print" reports could not be
  1927. triaged without a round trip (#2698).
  1928. Never logs the access code itself; the code is the likely culprit but
  1929. printing it would put a credential in every support bundle.
  1930. """
  1931. code = getattr(rc, "value", rc)
  1932. name = rc.getName() if hasattr(rc, "getName") else str(rc)
  1933. self.last_connect_error_name = name
  1934. if isinstance(code, int) and code in _CONNACK_AUTH_REJECTED:
  1935. self.last_connect_error = CONNECT_ERROR_AUTH_REJECTED
  1936. logger.warning(
  1937. "[%s] MQTT connection refused by the printer: %s (code %s). The access code "
  1938. "or serial number is wrong — the access code changes every time LAN Only or "
  1939. "Developer Mode is toggled, so re-read it from the printer's screen.",
  1940. self.serial_number,
  1941. name,
  1942. code,
  1943. )
  1944. else:
  1945. self.last_connect_error = CONNECT_ERROR_REFUSED
  1946. logger.warning(
  1947. "[%s] MQTT connection refused by the printer: %s (code %s).",
  1948. self.serial_number,
  1949. name,
  1950. code,
  1951. )
  1952. def _on_subscribe(self, client, userdata, mid, reason_code_list, properties=None):
  1953. """Handle SUBACK responses to detect request topic subscription rejection."""
  1954. if mid == self._request_topic_sub_mid:
  1955. for rc in reason_code_list:
  1956. if rc.is_failure:
  1957. logger.warning(
  1958. "[%s] Request topic subscription rejected (code=%d: %s). "
  1959. "ams_mapping capture from slicer-initiated prints unavailable.",
  1960. self.serial_number,
  1961. rc.value,
  1962. rc.getName(),
  1963. )
  1964. self._request_topic_supported = False
  1965. BambuMQTTClient._request_topic_cache[self.serial_number] = False
  1966. else:
  1967. logger.info(
  1968. "[%s] Request topic subscription accepted. "
  1969. "ams_mapping capture enabled for slicer-initiated prints.",
  1970. self.serial_number,
  1971. )
  1972. self._request_topic_confirmed = True
  1973. BambuMQTTClient._request_topic_cache[self.serial_number] = True
  1974. BambuMQTTClient._request_topic_probe_failures.pop(self.serial_number, None)
  1975. self._request_topic_sub_mid = None
  1976. self._request_topic_sub_time = 0.0
  1977. def _on_disconnect(self, client, userdata, disconnect_flags=None, rc=None, properties=None):
  1978. # Always unblock disconnect() callers, regardless of whether we suppress
  1979. # the state broadcast below. disconnect() sets _disconnection_event and
  1980. # waits on it — every callback path must fire it.
  1981. if self._disconnection_event:
  1982. self._disconnection_event.set()
  1983. # If we intentionally closed the socket for stale reconnect, don't broadcast
  1984. # another state change — check_staleness() already set connected=False and
  1985. # notified the UI. Just log and let paho auto-reconnect.
  1986. if self._stale_reconnecting:
  1987. logger.info(
  1988. "[%s] Disconnect callback after stale reconnect (expected), rc=%s",
  1989. self.serial_number,
  1990. rc,
  1991. )
  1992. return
  1993. # Ignore spurious disconnect callbacks if we've received a message recently
  1994. # Paho-mqtt sometimes fires disconnect callbacks while the connection is still active.
  1995. # BUT: never suppress error disconnects (keepalive timeout, connection lost, etc.)
  1996. # — only suppress when rc indicates a clean/normal disconnect.
  1997. is_error_disconnect = rc is not None and hasattr(rc, "is_failure") and rc.is_failure
  1998. time_since_last_message = time.time() - self._last_message_time
  1999. if not is_error_disconnect and time_since_last_message < 10.0 and self._last_message_time > 0:
  2000. logger.debug(
  2001. f"[{self.serial_number}] Ignoring spurious disconnect (last message {time_since_last_message:.1f}s ago)"
  2002. )
  2003. return
  2004. # Carry the last CONNACK refusal into the disconnect line. paho reports
  2005. # the drop that follows a refused CONNACK as "Unspecified error", so on
  2006. # its own this line says nothing useful about a printer that is looping
  2007. # on bad credentials — and this is the line that fills a support bundle
  2008. # (#2698).
  2009. if self.last_connect_error:
  2010. logger.warning(
  2011. "[%s] MQTT disconnected: rc=%s, flags=%s (last connection attempt was refused: %s)",
  2012. self.serial_number,
  2013. rc,
  2014. disconnect_flags,
  2015. self.last_connect_error_name,
  2016. )
  2017. else:
  2018. logger.warning("[%s] MQTT disconnected: rc=%s, flags=%s", self.serial_number, rc, disconnect_flags)
  2019. # Detect if request topic subscription caused the disconnect.
  2020. # If we just subscribed and got disconnected before any SUBACK confirmation,
  2021. # the broker likely killed the connection due to the unauthorized subscription.
  2022. if (
  2023. self._request_topic_sub_time > 0
  2024. and not self._request_topic_confirmed
  2025. and time.time() - self._request_topic_sub_time < 10.0
  2026. # A disconnect we asked for says nothing about the subscription.
  2027. and self._disconnection_event is None
  2028. ):
  2029. failures = BambuMQTTClient._request_topic_probe_failures.get(self.serial_number, 0) + 1
  2030. BambuMQTTClient._request_topic_probe_failures[self.serial_number] = failures
  2031. if failures >= BambuMQTTClient._REQUEST_TOPIC_PROBE_LIMIT:
  2032. logger.warning(
  2033. "[%s] Disconnected shortly after request topic subscription %d times. "
  2034. "Disabling request topic for this printer — ams_mapping capture from "
  2035. "slicer-initiated prints is unavailable, and their filament will be "
  2036. "attributed from the printer's own tray reporting instead.",
  2037. self.serial_number,
  2038. failures,
  2039. )
  2040. self._request_topic_supported = False
  2041. BambuMQTTClient._request_topic_cache[self.serial_number] = False
  2042. else:
  2043. logger.info(
  2044. "[%s] Disconnected shortly after request topic subscription (%d/%d). "
  2045. "Retrying it on the next connection before giving up.",
  2046. self.serial_number,
  2047. failures,
  2048. BambuMQTTClient._REQUEST_TOPIC_PROBE_LIMIT,
  2049. )
  2050. self._request_topic_sub_mid = None
  2051. self._request_topic_sub_time = 0.0
  2052. self.state.connected = False
  2053. if self.on_state_change:
  2054. self.on_state_change(self.state)
  2055. def _log_message(self, topic: str, direction: str, raw: str) -> None:
  2056. """Record a message for the MQTT Debug log, as it arrived.
  2057. Parsed again from the raw text rather than shared with the handlers:
  2058. processing keeps the payload's "print" dict as the new raw_data and
  2059. writes Bambuddy's merged AMS list and other state into it, so a shared
  2060. dict showed Bambuddy's state instead of what the printer sent (#3356).
  2061. """
  2062. self._message_log.append(
  2063. MQTTLogEntry(
  2064. timestamp=datetime.now(timezone.utc).isoformat(),
  2065. topic=topic,
  2066. direction=direction,
  2067. payload=json.loads(raw),
  2068. )
  2069. )
  2070. def _on_message(self, client, userdata, msg):
  2071. for handler in self._raw_message_handlers:
  2072. try:
  2073. handler(msg.topic, msg.payload)
  2074. except Exception:
  2075. logger.exception(
  2076. "[%s] raw-message handler crashed for topic=%s",
  2077. self.serial_number,
  2078. msg.topic,
  2079. )
  2080. try:
  2081. try:
  2082. raw = msg.payload.decode()
  2083. except UnicodeDecodeError:
  2084. # Some firmware versions (e.g. A1 Mini 01.07.02.00) send payloads
  2085. # with non-UTF-8 bytes. Replace invalid bytes to keep JSON parseable.
  2086. raw = msg.payload.decode(errors="replace")
  2087. logger.warning(
  2088. "[%s] MQTT payload contained non-UTF-8 bytes (topic=%s, len=%d)",
  2089. self.serial_number,
  2090. msg.topic,
  2091. len(msg.payload),
  2092. )
  2093. payload = json.loads(raw)
  2094. # Track last message time - receiving a message proves we're connected
  2095. self._last_message_time = time.time()
  2096. self.state.connected = True
  2097. # Intercept request-topic messages (print commands from slicer/Bambuddy)
  2098. if msg.topic == self.topic_publish:
  2099. # Record it before returning. This topic carries every command
  2100. # travelling *to* the printer, including the ones Bambu Studio
  2101. # sends, and it used to be the one thing an MQTT capture could
  2102. # never show -- which is why "what does Studio put in the drying
  2103. # command?" had no answer from a user's log (#2774). Filed as
  2104. # "out" so the direction filter groups it with our own commands
  2105. # rather than with printer telemetry; anything we send
  2106. # lands twice, once on publish and once on the
  2107. # broker's echo, and the pair is itself evidence the command
  2108. # reached the broker.
  2109. if self._logging_enabled:
  2110. self._log_message(msg.topic, "out", raw)
  2111. self._handle_request_message(payload)
  2112. return
  2113. # Count status reports per connection so check_staleness() can tell
  2114. # "printer never sent a report" apart from a mid-session quiet gap.
  2115. if msg.topic == self.topic_subscribe:
  2116. self._report_messages_since_connect += 1
  2117. # Only report-topic traffic proves the *printer* is alive — the
  2118. # request topic also carries slicer/Bambuddy commands.
  2119. if self._state_before_power_off is not None:
  2120. if self._restore_state_after_false_power_off() and self.on_state_change:
  2121. self.on_state_change(self.state)
  2122. # Log message if logging is enabled
  2123. if self._logging_enabled:
  2124. self._log_message(msg.topic, "in", raw)
  2125. self._process_message(payload)
  2126. except json.JSONDecodeError:
  2127. pass # Ignore non-JSON MQTT messages (e.g. binary or malformed payloads)
  2128. @property
  2129. def _captured_ams_mapping(self):
  2130. """The ams_mapping captured from the current print's command.
  2131. Kept on the state so the status shows it (the slot pills, #1762): the
  2132. printer's own push almost never carries one.
  2133. """
  2134. return self.state.print_ams_mapping
  2135. @_captured_ams_mapping.setter
  2136. def _captured_ams_mapping(self, mapping) -> None:
  2137. self.state.print_ams_mapping = mapping
  2138. def _handle_request_message(self, data: dict) -> None:
  2139. """Intercept print commands on the request topic to capture ams_mapping."""
  2140. print_data = data.get("print", {})
  2141. if not isinstance(print_data, dict):
  2142. return
  2143. command = print_data.get("command", "")
  2144. if command == "project_file":
  2145. # Where the dispatcher put the sliced file. Captured for every
  2146. # project_file, ours included: we publish to this same topic and
  2147. # subscribe to it, so whoever dispatched last wins, which is exactly
  2148. # the print the archive lookup is about to go looking for (#2780).
  2149. url = print_data.get("url")
  2150. if isinstance(url, str) and url:
  2151. self.state.current_project_url = url
  2152. self.state.last_project_url = url
  2153. if "ams_mapping" in print_data:
  2154. self._captured_ams_mapping = self._resolve_captured_mapping(print_data)
  2155. self._captured_mapping_url = url if isinstance(url, str) else None
  2156. logger.info(
  2157. "[%s] Captured ams_mapping from print command: %s",
  2158. self.serial_number,
  2159. self._captured_ams_mapping,
  2160. )
  2161. # Diagnostic for #1162 follow-up (X2D + FTS routing): when a
  2162. # slicer-launched project_file passes through the request topic,
  2163. # log the full payload so we can diff Studio's field set against
  2164. # ours.
  2165. #
  2166. # This used to read `sequence_id != "20000"`, on the belief that
  2167. # 20000 was ours alone. It is not: 20000 is the slicer convention
  2168. # Bambuddy adopted -- bind_server documents the slicer sending it
  2169. # during detect, and measured on the wire OrcaSlicer dispatched
  2170. # 20000 then 20001 while BambuStudio was on 20009/20010, both
  2171. # counting up from the same base. So the test swallowed whichever
  2172. # slicer dispatch happened to land on 20000, which on a fresh
  2173. # slicer start is the first one. Match our own dispatch instead.
  2174. if self._project_file_key(print_data) == self._own_project_file_key:
  2175. self._own_project_file_key = None
  2176. else:
  2177. logger.info(
  2178. "[%s] External project_file payload: %s",
  2179. self.serial_number,
  2180. json.dumps(print_data),
  2181. )
  2182. def _capture_report_project_file(self, print_data: dict) -> None:
  2183. """Read a print's destination off a ``project_file`` *response* (#1820).
  2184. ``_handle_request_message`` only ever sees the request topic, so a print
  2185. started from the printer's own touchscreen -- which publishes nothing --
  2186. left ``current_project_url`` at None, and the storage verdict fell
  2187. through to the ``sdcard`` fallback for the one case it was written for.
  2188. On an H2S that flag is True (its "card" is the internal eMMC), so the
  2189. verdict came back reachable and the ~110-connection sweep ran in full.
  2190. The printer does announce it: an unsolicited ``project_file`` response
  2191. on the report topic, ~2 s before ``gcode_state`` reaches PREPARE,
  2192. carrying ``file:///userdata/model/history/<name>.gcode.3mf``.
  2193. This also covers an install nobody had in view: some brokers refuse the
  2194. request-topic subscription, and on those no print of any kind has ever
  2195. populated the field.
  2196. Both kinds of ``project_file`` on this topic are read -- the printer's
  2197. echo of a dispatch and a screen start -- because both name the
  2198. destination in ``url``, which is the only thing the verdict wants. What
  2199. this must NOT do is reuse ``_handle_request_message``'s "External
  2200. project_file payload" diagnostic: our own dispatch is echoed on *both*
  2201. topics, the request-topic echo arrives first and clears
  2202. ``_own_project_file_key``, so by the time this frame lands the key is
  2203. already None and every Bambuddy-started print would log itself as
  2204. someone else's.
  2205. """
  2206. # Same shape as _handle_request_message: the frame is whatever the
  2207. # printer put on the wire, and this is the first thing to touch it.
  2208. if not isinstance(print_data, dict) or print_data.get("command") != "project_file":
  2209. return
  2210. # A refused dispatch names a file that was never written. Acting on it
  2211. # would pin an archive on a destination nothing ever went to. Logged:
  2212. # nothing else says the printer refused a print it was sent.
  2213. result = str(print_data.get("result") or "")
  2214. if result.upper() != "SUCCESS":
  2215. logger.info(
  2216. "[%s] Printer refused a print start (project_file): result=%s reason=%s url=%s",
  2217. self.serial_number,
  2218. result,
  2219. print_data.get("reason"),
  2220. print_data.get("url"),
  2221. )
  2222. self.last_start_refusal = (result, print_data.get("reason"))
  2223. return
  2224. url = print_data.get("url")
  2225. if not isinstance(url, str) or not url:
  2226. return
  2227. if self.state.current_project_url != url:
  2228. logger.info(
  2229. "[%s] Print destination from the report topic: %s",
  2230. self.serial_number,
  2231. url,
  2232. )
  2233. self.state.current_project_url = url
  2234. self.state.last_project_url = url
  2235. # On a screen start this frame is the only place the mapping appears --
  2236. # no slicer ever sent one. Fill a gap only: when the request topic
  2237. # already captured this print's mapping that copy is the slicer's own,
  2238. # and the echo can arrive without the field at all. A mapping captured
  2239. # for another destination is from a dispatch that never ran (refused,
  2240. # or cancelled before it started, so no completion cleared it).
  2241. stale = self._captured_ams_mapping is not None and self._captured_mapping_url != url
  2242. if (self._captured_ams_mapping is None or stale) and isinstance(print_data.get("ams_mapping"), list):
  2243. self._captured_ams_mapping = self._resolve_captured_mapping(print_data)
  2244. self._captured_mapping_url = url
  2245. logger.info(
  2246. "[%s] Captured ams_mapping from print response: %s",
  2247. self.serial_number,
  2248. self._captured_ams_mapping,
  2249. )
  2250. def _resolve_captured_mapping(self, print_data: dict) -> object:
  2251. """The ``ams_mapping`` of a project_file, with external spools resolved
  2252. from its ``ams_mapping2`` (#3166)."""
  2253. from backend.app.utils.printer_models import is_dual_nozzle_model
  2254. return resolve_external_spools_in_mapping(
  2255. print_data.get("ams_mapping"),
  2256. print_data.get("ams_mapping2"),
  2257. self._is_dual_nozzle or is_dual_nozzle_model(self.model),
  2258. self.tray_layout,
  2259. )
  2260. @staticmethod
  2261. def _project_file_key(print_data: dict) -> str:
  2262. """Identity of a project_file dispatch, for telling ours from a slicer's.
  2263. Sequence id alone cannot do it -- every slicer counts up from the same
  2264. 20000 -- so this also carries the file and its destination, which differ
  2265. between any two real dispatches.
  2266. """
  2267. return "|".join(str(print_data.get(field, "")) for field in ("sequence_id", "file", "url", "subtask_name"))
  2268. def _debug_on_change(self, key: str, value: object, msg: str, *args: object) -> None:
  2269. """``logger.debug``, but only when ``value`` differs from the last call for ``key``.
  2270. The state dumps in the push_status handler fire whenever their field is
  2271. *present* in the frame — and a full push_status carries every field, so
  2272. they fire on every frame regardless of whether anything changed. Several
  2273. even say "updated" or "changes" in their own comment while doing nothing
  2274. of the sort.
  2275. On one printer that is ~1.5 lines/s and nobody noticed. On the 19-printer
  2276. farm in #2555 it is ~100 lines/s, which fills the 5 MB log inside five
  2277. minutes: the reporter enabled debug logging as asked and the support
  2278. bundle came back holding under five minutes of history, almost none of it
  2279. about the queue problem we were chasing. 27,727 of its 29,830 lines were
  2280. these dumps.
  2281. Deduplicating on the value keeps every transition — which is the only part
  2282. anyone reads these lines for — and drops the steady-state repetition.
  2283. ``value`` must capture everything interpolated into ``msg``, or a change
  2284. will be swallowed; pass a tuple when the message renders several fields.
  2285. """
  2286. if not logger.isEnabledFor(logging.DEBUG):
  2287. # Debug logging is toggled at RUNTIME (POST /support/debug-logging),
  2288. # and these clients outlive the toggle. Letting INFO-level frames warm
  2289. # the cache would be self-defeating: the operator turns debug on
  2290. # precisely to see the printer's current state, and a cache already
  2291. # holding every steady-state value would suppress that baseline until
  2292. # something happened to change. On an idle printer the bundle would
  2293. # come back with none of these lines at all.
  2294. #
  2295. # So while debug is off we record nothing and drop whatever we had.
  2296. # Every enable then starts cold and dumps a full baseline on the next
  2297. # frame, exactly as it did before this method existed.
  2298. self._debug_last.clear()
  2299. return
  2300. if self._debug_last.get(key) == value:
  2301. return
  2302. self._debug_last[key] = value
  2303. logger.debug(msg, *args)
  2304. def _process_message(self, payload: dict):
  2305. """Process incoming MQTT message from printer."""
  2306. # Handle top-level AMS data (comes outside of "print" key)
  2307. # Wrap in try/except to prevent breaking the MQTT connection
  2308. if "ams" in payload:
  2309. try:
  2310. self._snow_in_frame = False # a bare AMS frame carries no extruder data
  2311. self._handle_ams_data(payload["ams"])
  2312. except Exception as e:
  2313. logger.error("[%s] Error handling AMS data: %s", self.serial_number, e)
  2314. # Handle xcam data (camera settings and AI detection) at top level
  2315. if "xcam" in payload:
  2316. xcam_data = payload["xcam"]
  2317. logger.debug("[%s] Received xcam data at top level: %s", self.serial_number, xcam_data)
  2318. self._parse_xcam_data(xcam_data)
  2319. # Fire state change callback for top-level xcam (not nested in "print")
  2320. if "print" not in payload and self.on_state_change:
  2321. self.on_state_change(self.state)
  2322. # Handle system responses (accessories info, etc.)
  2323. if "system" in payload:
  2324. system_data = payload["system"]
  2325. logger.debug("[%s] Received system data: %s", self.serial_number, system_data)
  2326. self._handle_system_response(system_data)
  2327. # Handle info responses (firmware version info from get_version command)
  2328. if "info" in payload:
  2329. info_data = payload["info"]
  2330. if isinstance(info_data, dict) and info_data.get("command") == "get_version":
  2331. self._handle_version_info(info_data)
  2332. # Parse WiFi signal at top level (some printers send it here)
  2333. if "wifi_signal" in payload:
  2334. wifi_signal = payload["wifi_signal"]
  2335. if isinstance(wifi_signal, (int, float)):
  2336. self.state.wifi_signal = int(wifi_signal)
  2337. elif isinstance(wifi_signal, str):
  2338. try:
  2339. self.state.wifi_signal = int(wifi_signal.replace("dBm", "").strip())
  2340. except ValueError:
  2341. pass # Ignore unparseable wifi_signal strings; field is non-critical
  2342. # Detect ethernet: wifi_signal == -90 is a sentinel for "WiFi disabled/ethernet"
  2343. from backend.app.utils.printer_models import has_ethernet
  2344. if has_ethernet(self.model):
  2345. self.state.wired_network = self.state.wifi_signal == -90
  2346. # Parse developer LAN mode from top-level "fun" field
  2347. # Some firmware versions send "fun" at the top level, others inside "print"
  2348. if "fun" in payload:
  2349. try:
  2350. fun_val = payload["fun"]
  2351. fun_int = fun_val if isinstance(fun_val, int) else int(fun_val, 16)
  2352. self.state.developer_mode = (fun_int & 0x20000000) == 0
  2353. except (ValueError, TypeError):
  2354. pass
  2355. if "print" in payload:
  2356. print_data = payload["print"]
  2357. # Before anything reads the state: this is where a touchscreen-
  2358. # started print announces where its file lives, and the print-start
  2359. # handler asks ~2 s later (#1820).
  2360. self._capture_report_project_file(print_data)
  2361. # Check if xcam is nested inside print data
  2362. if "xcam" in print_data:
  2363. logger.debug("[%s] Found xcam inside print data: %s", self.serial_number, print_data["xcam"])
  2364. self._parse_xcam_data(print_data["xcam"])
  2365. # Log when we see gcode_state changes
  2366. if "gcode_state" in print_data:
  2367. logger.debug(
  2368. f"[{self.serial_number}] Received gcode_state: {print_data.get('gcode_state')}, "
  2369. f"gcode_file: {print_data.get('gcode_file')}, subtask_name: {print_data.get('subtask_name')}"
  2370. )
  2371. # AMS Filament Backup state lives in bit 18 of top-level print.cfg on
  2372. # new-protocol printers. Verified against OrcaSlicer's
  2373. # DeviceManager.cpp:4961 SetAutoRefillEnabled(get_flag_bits(cfg, 18))
  2374. # and live H2D ON/OFF capture 2026-06-20.
  2375. #
  2376. # Families without cfg (P1S, P1P, A1, A1 Mini) carry it in home_flag
  2377. # bit 10 (#3259). Trusted once a full status report (the same
  2378. # >30-key test as the developer-mode probe) arrived without cfg;
  2379. # from then on every status frame that carries home_flag is read,
  2380. # so a toggle in the slicer shows up without a Force Refresh (P1S
  2381. # capture: each toggle came in a 4-6 key update frame). Before
  2382. # that nothing is read from small frames, so a cfg printer can't
  2383. # be misread from a frame that arrives ahead of its first cfg.
  2384. # Printers that send cfg keep reading it alone.
  2385. #
  2386. # Hold-timer guard: when the user just toggled via the badge, the
  2387. # next 1-2 push_status frames may still carry the printer's OLD cfg
  2388. # for ~3 s before the firmware reflects the change. Without this
  2389. # gate the UI would flicker ON→OFF→ON. Same pattern xcam uses.
  2390. # Only from a status frame: a project_file ack echoes our own
  2391. # `"cfg": "0"` back, which read as "printer says backup is OFF" and
  2392. # stuck on every family that doesn't repeat `cfg` in its periodic
  2393. # frames — P1S, A1, A1 Mini, A2L (#3040).
  2394. new_backup = None
  2395. if is_printer_status_frame(print_data):
  2396. if "cfg" in print_data:
  2397. self._backup_cfg_seen = True
  2398. new_backup = parse_ams_filament_backup_from_cfg(print_data["cfg"])
  2399. elif not self._backup_cfg_seen:
  2400. if len(print_data) > 30:
  2401. self._backup_home_flag_trusted = True
  2402. if self._backup_home_flag_trusted:
  2403. new_backup = parse_ams_filament_backup_from_home_flag(print_data.get("home_flag"))
  2404. if new_backup is not None and new_backup != self.state.ams_filament_backup:
  2405. hold_start = self._xcam_hold_start.get("print_option_auto_switch_filament")
  2406. if hold_start is not None and (time.time() - hold_start) <= self._xcam_hold_time:
  2407. logger.debug(
  2408. "[%s] AMS Filament Backup push ignored (hold active for %.1fs)",
  2409. self.serial_number,
  2410. time.time() - hold_start,
  2411. )
  2412. else:
  2413. logger.info(
  2414. "[%s] AMS Filament Backup: %s",
  2415. self.serial_number,
  2416. "ON" if new_backup else "OFF",
  2417. )
  2418. self.state.ams_filament_backup = new_backup
  2419. self._xcam_hold_start.pop("print_option_auto_switch_filament", None)
  2420. # Detect dual-nozzle BEFORE processing AMS data (tray_now disambiguation needs it)
  2421. # device.extruder.info with >= 2 entries only exists on dual-nozzle printers (H2D, H2D Pro)
  2422. if not self._is_dual_nozzle and "device" in print_data:
  2423. dev = print_data.get("device")
  2424. if isinstance(dev, dict):
  2425. ext_info = dev.get("extruder", {}).get("info", [])
  2426. if isinstance(ext_info, list) and len(ext_info) >= 2:
  2427. self._is_dual_nozzle = True
  2428. logger.info("[%s] Detected dual-nozzle printer from device.extruder.info", self.serial_number)
  2429. # Must run before _handle_ams_data: the per-AMS inlet binding is read
  2430. # out of the AMS info bits, but only means anything once we know a
  2431. # switch is installed. Parsing them the other way round would lose
  2432. # the binding on every frame where the two arrive together.
  2433. self._parse_fila_switch(print_data)
  2434. # Before _handle_ams_data too: an H2D's tray_now is a bare slot that
  2435. # this frame's extruder data places (which nozzle, which AMS).
  2436. self._snow_in_frame = self._parse_extruder_position(print_data)
  2437. self._parse_extruder_slots(print_data)
  2438. # Handle AMS data that comes inside print key
  2439. if "ams" in print_data:
  2440. try:
  2441. self._handle_ams_data(print_data["ams"])
  2442. except Exception as e:
  2443. logger.error("[%s] Error handling AMS data from print: %s", self.serial_number, e)
  2444. # Handle vir_slot (H2-series external spool data) — list of external trays
  2445. # Process vir_slot FIRST so it takes priority over vt_tray
  2446. if "vir_slot" in print_data:
  2447. vir_slot = print_data["vir_slot"]
  2448. if isinstance(vir_slot, list) and vir_slot:
  2449. # Fix: single-nozzle printers (X1C, P1S, A1) report their single
  2450. # external slot with id=255 in vir_slot, but tray_now=254 when active.
  2451. # Remap id=255→254 for single-slot printers so active detection works.
  2452. # Dual-nozzle (H2D) has 2 slots: id=254 (Ext-L) and id=255 (Ext-R).
  2453. # A nozzle-rack printer (H3C) reports one input per hotend,
  2454. # 247-255, kept as reported.
  2455. if len(vir_slot) == 1 and str(vir_slot[0].get("id", "")) == "255":
  2456. vir_slot[0]["id"] = "254"
  2457. self.state.raw_data["vt_tray"] = vir_slot
  2458. # Handle vt_tray (virtual tray / external spool) data
  2459. # Only use vt_tray if vir_slot is NOT in this message AND we don't already
  2460. # have vir_slot data (H2-series sends vt_tray as a single active spool dict
  2461. # which would overwrite the correct multi-slot vir_slot data)
  2462. if "vt_tray" in print_data and "vir_slot" not in print_data:
  2463. vt_tray = print_data["vt_tray"]
  2464. existing = self.state.raw_data.get("vt_tray")
  2465. # Don't let a single-spool vt_tray dict overwrite multi-slot vir_slot data
  2466. if isinstance(vt_tray, dict) and isinstance(existing, list) and len(existing) > 1:
  2467. pass # Keep the vir_slot data
  2468. else:
  2469. if isinstance(vt_tray, dict):
  2470. vt_tray = [vt_tray]
  2471. self.state.raw_data["vt_tray"] = vt_tray
  2472. # The regular AMS change-hash (in _handle_ams_data) only sees AMS
  2473. # units, and _handle_ams_data runs before this block — so a change
  2474. # to the external spool alone (e.g. swapping generic TPU for generic
  2475. # ABS on the printer) never re-triggers on_ams_change, leaving a
  2476. # stale inventory assignment on the ams_id=255 slot (#2575). Detect
  2477. # external-spool identity changes here and fire the same callback.
  2478. self._maybe_trigger_external_spool_change()
  2479. # Parse ams_status directly from print data (NOT from print.ams)
  2480. # ams_status is a combined value: lower 8 bits = sub status, bits 8-15 = main status
  2481. # Main status: 0=idle, 1=filament_change, 2=rfid_identifying, 3=assist, 4=calibration
  2482. # Sub status (when main=1): 2=heating, 3=AMS feeding, 4=retract, 6=push, 7=purge
  2483. if "ams_status" in print_data:
  2484. raw_ams_status = print_data["ams_status"]
  2485. if isinstance(raw_ams_status, str):
  2486. try:
  2487. self.state.ams_status = int(raw_ams_status)
  2488. except ValueError:
  2489. self.state.ams_status = 0
  2490. else:
  2491. self.state.ams_status = raw_ams_status if raw_ams_status is not None else 0
  2492. # Compute main and sub status
  2493. self.state.ams_status_sub = self.state.ams_status & 0xFF
  2494. self.state.ams_status_main = (self.state.ams_status >> 8) & 0xFF
  2495. # Log when ams_status changes (for filament change tracking debug)
  2496. self._debug_on_change(
  2497. "ams_status:print",
  2498. self.state.ams_status,
  2499. "[%s] ams_status: %s (main=%s, sub=%s)",
  2500. self.serial_number,
  2501. self.state.ams_status,
  2502. self.state.ams_status_main,
  2503. self.state.ams_status_sub,
  2504. )
  2505. # Check for command responses
  2506. if "command" in print_data:
  2507. cmd = print_data.get("command")
  2508. logger.debug("[%s] Received command response: %s", self.serial_number, cmd)
  2509. if cmd in ("extrusion_cali_set", "extrusion_cali_del"):
  2510. # INFO, not debug: this is the printer's verdict on a write
  2511. # the user just made, and it was invisible in support
  2512. # bundles for as long as it sat at DEBUG (#2718). Same
  2513. # reasoning as ams_filament_drying below.
  2514. logger.info(
  2515. "[%s] %s response: result=%s reason=%s seq=%s",
  2516. self.serial_number,
  2517. cmd,
  2518. print_data.get("result"),
  2519. print_data.get("reason", ""),
  2520. print_data.get("sequence_id"),
  2521. )
  2522. logger.debug("[%s] %s full response: %s", self.serial_number, cmd, print_data)
  2523. ack_seq = str(print_data.get("sequence_id", ""))
  2524. if ack_seq in self._pending_cali_acks:
  2525. self._pending_cali_acks[ack_seq] = print_data
  2526. elif cmd == "skip_objects":
  2527. self._handle_skip_objects_answer(print_data)
  2528. elif cmd in ("extrusion_cali_sel", "ams_filament_setting"):
  2529. logger.debug("[%s] %s response: %s", self.serial_number, cmd, print_data)
  2530. # A refused ams_filament_setting is the printer's verdict on
  2531. # a write the user just made, and at DEBUG it never reached
  2532. # a support bundle: #2756 reported six manual Configure Slot
  2533. # attempts on an X1C, each returning HTTP 200 with the
  2534. # read-back still showing the previous profile, and no
  2535. # record of what the printer said about any of them. Same
  2536. # promotion as extrusion_cali_set (#2718) and
  2537. # ams_filament_drying (#1447) — but only on a non-success,
  2538. # because unlike those two this command is not rare: every
  2539. # spool assignment and every K-profile re-apply sends one,
  2540. # so promoting each ack would bury the interesting line.
  2541. #
  2542. # The developer-mode probe is excluded. It sends this exact
  2543. # command to the external slot precisely to see it refused
  2544. # on P1 firmware, so its failure is a normal reading rather
  2545. # than a fault. Its response is still matched below (this
  2546. # runs before _handle_dev_mode_probe_response clears the
  2547. # seq), and user-initiated commands can't be mistaken for
  2548. # it — they publish a hardcoded sequence_id of "0".
  2549. result = print_data.get("result")
  2550. is_dev_mode_probe = (
  2551. self._dev_mode_probe_seq is not None
  2552. and print_data.get("sequence_id") == self._dev_mode_probe_seq
  2553. )
  2554. # extrusion_cali_sel too (FW-C3): every RFID re-read
  2555. # re-applies the spool's K-profile and logs "Applied PA
  2556. # profile", so its refusal must reach the bundle beside it.
  2557. # The printer's word, not a verdict: the extrusion_cali_*
  2558. # acks are known to say "fail" for writes that applied.
  2559. if not is_dev_mode_probe and isinstance(result, str) and result.lower() != "success":
  2560. logger.info(
  2561. "[%s] %s refused: result=%s reason=%s ams_id=%s tray_id=%s",
  2562. self.serial_number,
  2563. cmd,
  2564. result,
  2565. print_data.get("reason", ""),
  2566. print_data.get("ams_id"),
  2567. print_data.get("tray_id"),
  2568. )
  2569. # AMS drying responses are rare (user-initiated only) and the
  2570. # full payload — including `result` and any `reason` code —
  2571. # is the only way to diagnose silent rejections like #1447.
  2572. # INFO level so the body lands in support bundles by default.
  2573. elif cmd == "ams_filament_drying":
  2574. logger.info("[%s] ams_filament_drying response: %s", self.serial_number, print_data)
  2575. # RFID re-reads are user-initiated and rare, and a refusal was
  2576. # invisible until #3206 (X1Plus answering FAIL / ERROR STATE).
  2577. # gcode_line acks are only of interest when they answer our
  2578. # M620 R fallback, so those are matched by sequence_id alone.
  2579. ack_seq = str(print_data.get("sequence_id", ""))
  2580. if (
  2581. cmd in ("ams_get_rfid", "gcode_line")
  2582. and ack_seq in self._pending_rfid_acks
  2583. and "result" in print_data
  2584. ):
  2585. logger.info(
  2586. "[%s] %s response: result=%s reason=%s seq=%s",
  2587. self.serial_number,
  2588. cmd,
  2589. print_data.get("result"),
  2590. print_data.get("reason", ""),
  2591. ack_seq,
  2592. )
  2593. self._pending_rfid_acks[ack_seq] = print_data
  2594. # Check for developer mode probe response
  2595. if (
  2596. cmd == "ams_filament_setting"
  2597. and self._dev_mode_probe_seq is not None
  2598. and print_data.get("sequence_id") == self._dev_mode_probe_seq
  2599. ):
  2600. self._handle_dev_mode_probe_response(print_data)
  2601. # Track user-initiated ams_filament_setting responses (#887
  2602. # zombie detection). Reset both the timer AND the unanswered
  2603. # counter on ANY response — the response proves the channel is
  2604. # alive, so the counter must not stay armed even when the
  2605. # watchdog already zeroed `_last_ams_cmd_time` on a previous
  2606. # tick. The original `and self._last_ams_cmd_time > 0` guard
  2607. # caused #1164: one sluggish response (>10s) would set the
  2608. # counter to 1 and zero the timer; the late response arrived
  2609. # but was ignored by this branch (timer is 0); the counter
  2610. # stayed at 1 indefinitely; the very next slow response —
  2611. # possibly hours later, on a totally unrelated command — would
  2612. # take it to 2 and force-reconnect, surfacing as "filament
  2613. # config doesn't reach the printer ~6 changes in".
  2614. elif cmd == "ams_filament_setting":
  2615. self._last_ams_cmd_time = 0.0
  2616. self._ams_cmd_unanswered = 0
  2617. is_kprofile_response = "command" in print_data and print_data.get("command") == "extrusion_cali_get"
  2618. if is_kprofile_response:
  2619. self._handle_kprofile_response(print_data)
  2620. # An extrusion_cali_get response echoes the *requested* nozzle
  2621. # diameter (get_kprofiles probes 0.2/0.4/0.6/0.8 in turn), not the
  2622. # installed hardware. Feeding it to _update_state clobbered the real
  2623. # nozzle size (#2663) — typically leaving 0.8, the last size probed,
  2624. # which then failed the #1899 dispatch guard. The response carries no
  2625. # status telemetry, so skip it; the true nozzle comes from pushall.
  2626. # (Same reasoning as get_accessories in _handle_system_response.)
  2627. # The answers to K-profile writes and selections echo the diameter
  2628. # the command named in the same way, so none of them is status.
  2629. if print_data.get("command") not in _KPROFILE_COMMAND_ANSWERS:
  2630. self._update_state(print_data)
  2631. def _handle_system_response(self, data: dict):
  2632. """Handle system responses including accessories info.
  2633. Note: get_accessories returns stale/incorrect nozzle_type data on H2D.
  2634. The correct nozzle data comes from push_status, so we don't update
  2635. nozzle type/diameter from get_accessories. We just log the response
  2636. for debugging purposes.
  2637. """
  2638. command = data.get("command")
  2639. if command == "get_accessories":
  2640. # Log response for debugging - but DON'T use it to update nozzle data
  2641. # because it returns stale values (e.g., 'stainless_steel' when the
  2642. # actual nozzle is 'HH01' hardened steel high-flow)
  2643. logger.debug("[%s] Accessories response (not used for nozzle data): %s", self.serial_number, data)
  2644. def _handle_version_info(self, data: dict):
  2645. """Handle version info response from get_version command.
  2646. Parses firmware version from the 'ota' module in the module list.
  2647. Also extracts AMS unit firmware versions from AMS modules and stores
  2648. them on the corresponding AMS unit in raw_data so the status route can
  2649. expose them to the frontend.
  2650. AMS module naming conventions (numeric suffix is the AMS unit ID):
  2651. - ``ams/<id>`` – original AMS
  2652. - ``ams_f1/<id>`` – AMS Lite (#3348)
  2653. - ``n3f/<id>`` – AMS 2 Pro (H2D Pro and similar)
  2654. - ``n3s/<id>`` – AMS HT (H2D Pro and similar)
  2655. Message format:
  2656. {
  2657. "command": "get_version",
  2658. "module": [
  2659. {"name": "ota", "sw_ver": "01.08.05.00"},
  2660. {"name": "rv1126", "sw_ver": "00.00.14.74"},
  2661. {"name": "ams/0", "sw_ver": "00.00.06.96", "sn": "ABC123"},
  2662. {"name": "n3f/0", "sw_ver": "03.00.21.29", "sn": "19C06A552504488"},
  2663. {"name": "n3s/128", "sw_ver": "03.00.21.29", "sn": "19F06A561801096"},
  2664. ...
  2665. ]
  2666. }
  2667. """
  2668. modules = data.get("module", [])
  2669. if not isinstance(modules, list):
  2670. return
  2671. state_changed = False
  2672. for module in modules:
  2673. if not isinstance(module, dict):
  2674. continue
  2675. if module.get("name") == "ota":
  2676. version = module.get("sw_ver")
  2677. if version:
  2678. old_version = self.state.firmware_version
  2679. self.state.firmware_version = version
  2680. if old_version != version:
  2681. logger.info("[%s] Firmware version: %s", self.serial_number, version)
  2682. state_changed = True
  2683. break
  2684. # Extract AMS unit firmware versions from AMS modules.
  2685. # See module-level _AMS_MODULE_PREFIXES for supported naming conventions.
  2686. # Always cache regardless of whether AMS data has arrived yet — get_version
  2687. # often arrives before the first push_status, so caching must be unconditional.
  2688. ams_raw = self.state.raw_data.get("ams")
  2689. for module in modules:
  2690. if not isinstance(module, dict):
  2691. continue
  2692. name = module.get("name", "")
  2693. if name == AMS3H_MODULE_NAME:
  2694. name = f"{name}/{self._ams3h_unit_id()}"
  2695. if not any(name.startswith(prefix) for prefix in _AMS_MODULE_PREFIXES):
  2696. continue
  2697. try:
  2698. # The A2L's AMS Lite is unit 16 here but stored as 6, like
  2699. # everywhere else it is ingested.
  2700. ams_id = normalize_am_unit_id(int(name.split("/", 1)[1]))
  2701. except (ValueError, IndexError):
  2702. continue
  2703. sw_ver = module.get("sw_ver", "")
  2704. sn = module.get("sn", "")
  2705. # Extract module type from prefix (e.g. "ams/0" → "ams", "n3f/0" → "n3f")
  2706. module_type = name.split("/", 1)[0]
  2707. # Always cache so _apply_ams_version_cache can apply it when AMS data arrives
  2708. if sw_ver or sn or module_type:
  2709. self._ams_version_cache[ams_id] = {"sw_ver": sw_ver, "sn": sn, "module_type": module_type}
  2710. state_changed = True
  2711. # Also directly update any AMS unit already present in raw_data
  2712. if ams_raw and isinstance(ams_raw, list):
  2713. for ams_unit in ams_raw:
  2714. if not isinstance(ams_unit, dict):
  2715. continue
  2716. try:
  2717. unit_id = int(ams_unit.get("id")) if ams_unit.get("id") is not None else None
  2718. except (ValueError, TypeError):
  2719. unit_id = None
  2720. if unit_id == ams_id:
  2721. if sw_ver:
  2722. ams_unit["sw_ver"] = sw_ver
  2723. logger.debug("[%s] AMS %s firmware: %s", self.serial_number, ams_id, sw_ver)
  2724. # Only set sn from version info if not already present in AMS data
  2725. if sn and not ams_unit.get("sn"):
  2726. ams_unit["sn"] = sn
  2727. if module_type:
  2728. ams_unit["module_type"] = module_type
  2729. break
  2730. # Trigger state change callback AFTER both loops so AMS sn/sw_ver are
  2731. # included in the broadcast (not just the printer firmware version).
  2732. if state_changed and self.on_state_change:
  2733. self.on_state_change(self.state)
  2734. # Warn if any AMS unit is still missing serial number or firmware version
  2735. # after processing the version info response. Warn only once per connection
  2736. # to avoid repeated noise on older firmware that doesn't report these fields.
  2737. if ams_raw and isinstance(ams_raw, list):
  2738. for ams_unit in ams_raw:
  2739. if not isinstance(ams_unit, dict):
  2740. continue
  2741. ams_id = ams_unit.get("id", "?")
  2742. if not ams_unit.get("sn") and not ams_unit.get("serial_number"):
  2743. key = (ams_id, "sn")
  2744. if key not in self._ams_version_warned:
  2745. self._ams_version_warned.add(key)
  2746. logger.warning(
  2747. "[%s] AMS unit %s: serial number not available in version info",
  2748. self.serial_number,
  2749. ams_id,
  2750. )
  2751. if not ams_unit.get("sw_ver"):
  2752. key = (ams_id, "sw_ver")
  2753. if key not in self._ams_version_warned:
  2754. self._ams_version_warned.add(key)
  2755. logger.warning(
  2756. "[%s] AMS unit %s: firmware version not available in version info",
  2757. self.serial_number,
  2758. ams_id,
  2759. )
  2760. def _apply_ams_version_cache(self, ams_list: list) -> None:
  2761. """Apply cached AMS firmware/SN (from get_version) onto an AMS list in-place.
  2762. get_version may arrive before pushall/AMS status, and AMS unit IDs may be
  2763. strings in MQTT payloads. This helper normalizes IDs and fills missing
  2764. sw_ver/sn fields without overwriting values already present.
  2765. """
  2766. if not ams_list or not isinstance(ams_list, list):
  2767. return
  2768. cache = self._ams_version_cache
  2769. if not cache:
  2770. return
  2771. for unit in ams_list:
  2772. if not isinstance(unit, dict):
  2773. continue
  2774. raw_id = unit.get("id")
  2775. try:
  2776. unit_id = int(raw_id) if raw_id is not None else None
  2777. except (ValueError, TypeError):
  2778. unit_id = None
  2779. if unit_id is None:
  2780. continue
  2781. cached = cache.get(unit_id)
  2782. if not cached:
  2783. continue
  2784. sw_ver = cached.get("sw_ver") or ""
  2785. sn = cached.get("sn") or ""
  2786. if sw_ver and not unit.get("sw_ver"):
  2787. unit["sw_ver"] = sw_ver
  2788. # Only set sn if not already present in AMS data
  2789. if sn and not unit.get("sn") and not unit.get("serial_number"):
  2790. unit["sn"] = sn
  2791. module_type = cached.get("module_type") or ""
  2792. if module_type and not unit.get("module_type"):
  2793. unit["module_type"] = module_type
  2794. def _parse_xcam_data(self, xcam_data):
  2795. """Parse xcam data for camera settings and AI detection options."""
  2796. if not isinstance(xcam_data, dict):
  2797. return
  2798. current_time = time.time()
  2799. # Helper to check if we should accept incoming value for a module
  2800. # OrcaSlicer pattern: simple hold timer, ignore ALL data for 3 seconds after command
  2801. def should_accept_value(module_name: str, incoming_value: bool) -> bool:
  2802. """Check if we should accept an incoming xcam value.
  2803. OrcaSlicer pattern: After sending a command, ignore incoming data
  2804. for 3 seconds. After that, accept whatever the printer sends.
  2805. """
  2806. if module_name not in self._xcam_hold_start:
  2807. return True # No hold timer, accept incoming
  2808. hold_start = self._xcam_hold_start[module_name]
  2809. elapsed = current_time - hold_start
  2810. if elapsed > self._xcam_hold_time:
  2811. # Hold timer expired - accept incoming and clear hold
  2812. del self._xcam_hold_start[module_name]
  2813. logger.debug("[%s] Hold expired for %s, accepting %s", self.serial_number, module_name, incoming_value)
  2814. return True
  2815. # Within hold period - ignore incoming data
  2816. logger.debug(
  2817. f"[{self.serial_number}] Ignoring {module_name}={incoming_value} "
  2818. f"(hold active, {elapsed:.1f}s < {self._xcam_hold_time}s)"
  2819. )
  2820. return False
  2821. # Log all xcam fields for debugging
  2822. logger.debug("[%s] Parsing xcam data - all fields: %s", self.serial_number, list(xcam_data.keys()))
  2823. # The cfg bitmask contains the ACTUAL detector states - the individual boolean
  2824. # fields (spaghetti_detector, etc.) are often stale/cached.
  2825. # CFG bitmask structure (each detector uses 3 bits: [sens_low, sens_high, enabled]):
  2826. # - Bits 5-7: spaghetti_detector (sens in 5-6, enabled in 7)
  2827. # - Bits 8-10: pileup_detector (sens in 8-9, enabled in 10)
  2828. # - Bits 11-13: clump_detector/nozzle_clumping (sens in 11-12, enabled in 13)
  2829. # - Bits 14-16: airprint_detector (sens in 14-15, enabled in 16)
  2830. # Sensitivity values: 0=low, 1=medium, 2=high
  2831. if "cfg" in xcam_data:
  2832. cfg = xcam_data["cfg"]
  2833. logger.debug("[%s] xcam cfg bitmask: %s (binary: %s)", self.serial_number, cfg, bin(cfg))
  2834. def decode_detector(start_bit):
  2835. """Decode a detector from cfg: returns (enabled, sensitivity_str)"""
  2836. sens_bits = (cfg >> start_bit) & 0x3
  2837. enabled = bool((cfg >> (start_bit + 2)) & 1)
  2838. sensitivity = {0: "low", 1: "medium", 2: "high"}.get(sens_bits, "medium")
  2839. return enabled, sensitivity
  2840. # Spaghetti detector (bits 5-7)
  2841. cfg_spaghetti, cfg_sensitivity = decode_detector(5)
  2842. if should_accept_value("spaghetti_detector", cfg_spaghetti):
  2843. old_value = self.state.print_options.spaghetti_detector
  2844. if cfg_spaghetti != old_value:
  2845. logger.debug(
  2846. f"[{self.serial_number}] spaghetti_detector changed (from cfg): {old_value} -> {cfg_spaghetti}"
  2847. )
  2848. self.state.print_options.spaghetti_detector = cfg_spaghetti
  2849. # Check hold timer for sensitivity before accepting
  2850. if "halt_print_sensitivity" not in self._xcam_hold_start:
  2851. if cfg_sensitivity != self.state.print_options.halt_print_sensitivity:
  2852. logger.debug(
  2853. f"[{self.serial_number}] Sensitivity changed (from cfg): "
  2854. f"{self.state.print_options.halt_print_sensitivity} -> {cfg_sensitivity}"
  2855. )
  2856. self.state.print_options.halt_print_sensitivity = cfg_sensitivity
  2857. else:
  2858. hold_start = self._xcam_hold_start["halt_print_sensitivity"]
  2859. elapsed = current_time - hold_start
  2860. if elapsed <= self._xcam_hold_time:
  2861. logger.debug(
  2862. f"[{self.serial_number}] Ignoring cfg sensitivity={cfg_sensitivity} "
  2863. f"(hold active, {elapsed:.1f}s < {self._xcam_hold_time}s)"
  2864. )
  2865. else:
  2866. # Hold expired - accept from cfg
  2867. if cfg_sensitivity != self.state.print_options.halt_print_sensitivity:
  2868. logger.debug(
  2869. f"[{self.serial_number}] Sensitivity synced (from cfg after hold): "
  2870. f"{self.state.print_options.halt_print_sensitivity} -> {cfg_sensitivity}"
  2871. )
  2872. self.state.print_options.halt_print_sensitivity = cfg_sensitivity
  2873. del self._xcam_hold_start["halt_print_sensitivity"]
  2874. # Pileup detector (bits 8-10)
  2875. cfg_pileup, cfg_pileup_sens = decode_detector(8)
  2876. if should_accept_value("pileup_detector", cfg_pileup):
  2877. if cfg_pileup != self.state.print_options.pileup_detector:
  2878. logger.debug(
  2879. f"[{self.serial_number}] pileup_detector changed (from cfg): {self.state.print_options.pileup_detector} -> {cfg_pileup}"
  2880. )
  2881. self.state.print_options.pileup_detector = cfg_pileup
  2882. # Pileup sensitivity with hold timer
  2883. if "pileup_sensitivity" not in self._xcam_hold_start:
  2884. if cfg_pileup_sens != self.state.print_options.pileup_sensitivity:
  2885. logger.debug(
  2886. f"[{self.serial_number}] pileup_sensitivity changed (from cfg): {self.state.print_options.pileup_sensitivity} -> {cfg_pileup_sens}"
  2887. )
  2888. self.state.print_options.pileup_sensitivity = cfg_pileup_sens
  2889. else:
  2890. hold_start = self._xcam_hold_start["pileup_sensitivity"]
  2891. elapsed = current_time - hold_start
  2892. if elapsed > self._xcam_hold_time:
  2893. if cfg_pileup_sens != self.state.print_options.pileup_sensitivity:
  2894. logger.debug(
  2895. f"[{self.serial_number}] pileup_sensitivity synced (from cfg after hold): {self.state.print_options.pileup_sensitivity} -> {cfg_pileup_sens}"
  2896. )
  2897. self.state.print_options.pileup_sensitivity = cfg_pileup_sens
  2898. del self._xcam_hold_start["pileup_sensitivity"]
  2899. # Clump/nozzle clumping detector (bits 11-13)
  2900. cfg_clump, cfg_clump_sens = decode_detector(11)
  2901. if should_accept_value("clump_detector", cfg_clump):
  2902. if cfg_clump != self.state.print_options.nozzle_clumping_detector:
  2903. logger.debug(
  2904. f"[{self.serial_number}] nozzle_clumping_detector changed (from cfg): {self.state.print_options.nozzle_clumping_detector} -> {cfg_clump}"
  2905. )
  2906. self.state.print_options.nozzle_clumping_detector = cfg_clump
  2907. # Clump sensitivity with hold timer
  2908. if "nozzle_clumping_sensitivity" not in self._xcam_hold_start:
  2909. if cfg_clump_sens != self.state.print_options.nozzle_clumping_sensitivity:
  2910. logger.debug(
  2911. f"[{self.serial_number}] nozzle_clumping_sensitivity changed (from cfg): {self.state.print_options.nozzle_clumping_sensitivity} -> {cfg_clump_sens}"
  2912. )
  2913. self.state.print_options.nozzle_clumping_sensitivity = cfg_clump_sens
  2914. else:
  2915. hold_start = self._xcam_hold_start["nozzle_clumping_sensitivity"]
  2916. elapsed = current_time - hold_start
  2917. if elapsed > self._xcam_hold_time:
  2918. if cfg_clump_sens != self.state.print_options.nozzle_clumping_sensitivity:
  2919. logger.debug(
  2920. f"[{self.serial_number}] nozzle_clumping_sensitivity synced (from cfg after hold): {self.state.print_options.nozzle_clumping_sensitivity} -> {cfg_clump_sens}"
  2921. )
  2922. self.state.print_options.nozzle_clumping_sensitivity = cfg_clump_sens
  2923. del self._xcam_hold_start["nozzle_clumping_sensitivity"]
  2924. # Airprint detector (bits 14-16)
  2925. cfg_airprint, cfg_airprint_sens = decode_detector(14)
  2926. if should_accept_value("airprint_detector", cfg_airprint):
  2927. if cfg_airprint != self.state.print_options.airprint_detector:
  2928. logger.debug(
  2929. f"[{self.serial_number}] airprint_detector changed (from cfg): {self.state.print_options.airprint_detector} -> {cfg_airprint}"
  2930. )
  2931. self.state.print_options.airprint_detector = cfg_airprint
  2932. # Airprint sensitivity with hold timer
  2933. if "airprint_sensitivity" not in self._xcam_hold_start:
  2934. if cfg_airprint_sens != self.state.print_options.airprint_sensitivity:
  2935. logger.debug(
  2936. f"[{self.serial_number}] airprint_sensitivity changed (from cfg): {self.state.print_options.airprint_sensitivity} -> {cfg_airprint_sens}"
  2937. )
  2938. self.state.print_options.airprint_sensitivity = cfg_airprint_sens
  2939. else:
  2940. hold_start = self._xcam_hold_start["airprint_sensitivity"]
  2941. elapsed = current_time - hold_start
  2942. if elapsed > self._xcam_hold_time:
  2943. if cfg_airprint_sens != self.state.print_options.airprint_sensitivity:
  2944. logger.debug(
  2945. f"[{self.serial_number}] airprint_sensitivity synced (from cfg after hold): {self.state.print_options.airprint_sensitivity} -> {cfg_airprint_sens}"
  2946. )
  2947. self.state.print_options.airprint_sensitivity = cfg_airprint_sens
  2948. del self._xcam_hold_start["airprint_sensitivity"]
  2949. # Camera settings
  2950. if "ipcam_record" in xcam_data:
  2951. self.state.ipcam = xcam_data.get("ipcam_record") == "enable"
  2952. if "timelapse" in xcam_data:
  2953. self.state.timelapse = xcam_data.get("timelapse") == "enable"
  2954. # Track if timelapse was ever active during this print
  2955. if self.state.timelapse and self._was_running:
  2956. self._timelapse_during_print = True
  2957. # Skip spaghetti_detector boolean field - we read from cfg bitmask above
  2958. if "print_halt" in xcam_data:
  2959. self.state.print_options.print_halt = bool(xcam_data.get("print_halt"))
  2960. # Skip halt_print_sensitivity field - it's always stale ("medium")
  2961. # We read the actual sensitivity from cfg bits 5-6 above
  2962. if "first_layer_inspector" in xcam_data:
  2963. new_value = bool(xcam_data.get("first_layer_inspector"))
  2964. if should_accept_value("first_layer_inspector", new_value):
  2965. self.state.print_options.first_layer_inspector = new_value
  2966. if "printing_monitor" in xcam_data:
  2967. new_value = bool(xcam_data.get("printing_monitor"))
  2968. if should_accept_value("printing_monitor", new_value):
  2969. self.state.print_options.printing_monitor = new_value
  2970. if "buildplate_marker_detector" in xcam_data:
  2971. new_value = bool(xcam_data.get("buildplate_marker_detector"))
  2972. if should_accept_value("buildplate_marker_detector", new_value):
  2973. self.state.print_options.buildplate_marker_detector = new_value
  2974. if "allow_skip_parts" in xcam_data:
  2975. new_value = bool(xcam_data.get("allow_skip_parts"))
  2976. if should_accept_value("allow_skip_parts", new_value):
  2977. self.state.print_options.allow_skip_parts = new_value
  2978. # Additional AI detectors - these are decoded from cfg bitmask above, not from
  2979. # individual boolean fields (which are not sent by the printer)
  2980. # pileup_detector, nozzle_clumping_detector, airprint_detector - from cfg
  2981. # auto_recovery_step_loss and filament_tangle_detect - tracked locally only
  2982. if "auto_recovery_step_loss" in xcam_data:
  2983. self.state.print_options.auto_recovery_step_loss = bool(xcam_data.get("auto_recovery_step_loss"))
  2984. if "filament_tangle_detect" in xcam_data:
  2985. self.state.print_options.filament_tangle_detect = bool(xcam_data.get("filament_tangle_detect"))
  2986. @staticmethod
  2987. def _resolve_local_slot_from_mapping(
  2988. local_slot: int, mapping_raw: list | None, units: list[int] | None = None
  2989. ) -> int | None:
  2990. """Resolve a local AMS slot ID to a global tray ID using the MQTT mapping field.
  2991. The MQTT mapping field is an array of snow-encoded values:
  2992. each entry = ams_hw_id * 256 + slot_id (65535 = unmapped).
  2993. Finds entries where the local slot matches, then computes the global tray ID.
  2994. When several match and ``units`` is given (the AMS units on the active
  2995. extruder of a dual-nozzle printer), only those units' trays count.
  2996. Returns the global ID if exactly one AMS matches, or None if ambiguous/unavailable.
  2997. """
  2998. if not isinstance(mapping_raw, list) or not mapping_raw:
  2999. return None
  3000. candidates = mapped_trays_with_slot(mapping_raw, local_slot) # global tray ID -> AMS unit
  3001. if len(candidates) > 1 and units:
  3002. candidates = {tray: unit for tray, unit in candidates.items() if unit in units}
  3003. if len(candidates) == 1:
  3004. return next(iter(candidates))
  3005. return None
  3006. def _maybe_trigger_external_spool_change(self):
  3007. """Fire on_ams_change when the external spool (vt_tray) identity changes.
  3008. The AMS change-hash in _handle_ams_data is built only from AMS units, so
  3009. an external-spool-only filament swap would otherwise never re-run the
  3010. inventory reconciliation that unlinks a stale ams_id=255 assignment
  3011. (#2575). The reconciliation reads vt_tray from live status itself, so we
  3012. just need to re-fire the callback with the current merged AMS data.
  3013. """
  3014. import hashlib
  3015. vt_tray = self.state.raw_data.get("vt_tray")
  3016. if not isinstance(vt_tray, list):
  3017. return
  3018. # Identity fields only — deliberately exclude `remain` so a print's
  3019. # steadily-dropping fill percentage doesn't fire on every MQTT push.
  3020. fp_parts = [
  3021. f"{vt.get('id')}:{vt.get('tray_type')}:{vt.get('tray_color')}:"
  3022. f"{vt.get('tag_uid')}:{vt.get('tray_uuid')}:{vt.get('tray_info_idx')}"
  3023. for vt in vt_tray
  3024. if isinstance(vt, dict)
  3025. ]
  3026. vt_hash = hashlib.md5(":".join(fp_parts).encode(), usedforsecurity=False).hexdigest()
  3027. if vt_hash == self._previous_vt_tray_hash:
  3028. return
  3029. self._previous_vt_tray_hash = vt_hash
  3030. if self.on_ams_change:
  3031. logger.debug(
  3032. "[%s] External spool (vt_tray) changed, triggering sync callback",
  3033. self.serial_number,
  3034. )
  3035. self.on_ams_change(self.state.raw_data.get("ams") or [])
  3036. def _normalize_a2l_am_units(self, ams_list) -> None:
  3037. """A2L AMS-Lite normalisation (#a2l-am-unit-16): rewrite the physical unit
  3038. id 16 -> 6 in place, as early as possible, so every downstream reader —
  3039. the merge, apply_tray_exist_bits (bit base 24), the API, usage tracking,
  3040. the DB constraint — sees the normalised id and needs no special-casing.
  3041. ``tray_now`` (local) and the outbound wire are handled separately. Only id
  3042. 16 is ever touched, so every other printer/AMS type is untouched. Runs on
  3043. both the dict-wrapped and bare-list AMS shapes.
  3044. """
  3045. if not isinstance(ams_list, list):
  3046. return
  3047. for unit in ams_list:
  3048. if not isinstance(unit, dict):
  3049. continue
  3050. try:
  3051. uid = int(unit.get("id"))
  3052. except (TypeError, ValueError):
  3053. continue
  3054. if uid == A2L_LITE_PHYSICAL_AMS_ID:
  3055. unit["id"] = A2L_LITE_NORMALIZED_AMS_ID
  3056. if not self._has_a2l_am_unit:
  3057. logger.info(
  3058. "[%s] A2L AMS-Lite detected (unit id 16) — normalising to id %d",
  3059. self.serial_number,
  3060. A2L_LITE_NORMALIZED_AMS_ID,
  3061. )
  3062. self._has_a2l_am_unit = True
  3063. @property
  3064. def tray_layout(self) -> TrayLayout:
  3065. """How this printer numbers its trays (utils.tray_ids); rebuilt only when its units change."""
  3066. raw = self.state.raw_data
  3067. units, vt_trays = raw.get("ams"), raw.get("vt_tray")
  3068. key = (
  3069. tuple((u.get("id"), u.get("info")) for u in units if isinstance(u, dict))
  3070. if isinstance(units, list)
  3071. else (),
  3072. tuple(vt.get("id") for vt in vt_trays if isinstance(vt, dict)) if isinstance(vt_trays, list) else (),
  3073. self.model,
  3074. )
  3075. if key != self._tray_layout_key:
  3076. from backend.app.utils.printer_models import has_ams3h
  3077. self._tray_layout = TrayLayout.from_state(self.state, has_ams3h(self.model))
  3078. self._tray_layout_key = key
  3079. return self._tray_layout
  3080. def _layout_with(self, ams_list: object) -> TrayLayout:
  3081. """``tray_layout`` including the units of a push not merged into the state yet."""
  3082. if not isinstance(ams_list, list) or not any(isinstance(u, dict) for u in ams_list):
  3083. return self.tray_layout
  3084. units = [u for u in ams_list if isinstance(u, dict)]
  3085. known = self.state.raw_data.get("ams")
  3086. if isinstance(known, list):
  3087. units.extend(u for u in known if isinstance(u, dict))
  3088. vt_trays = self.state.raw_data.get("vt_tray")
  3089. return TrayLayout.from_units(units, vt_trays if isinstance(vt_trays, list) else None)
  3090. def _note_rack_ams(self, layout: TrayLayout) -> None:
  3091. """Log a rack AMS the first time this connection sees it."""
  3092. for ams_id, kind in layout.rack_units:
  3093. if ams_id in self._rack_ams_logged:
  3094. continue
  3095. self._rack_ams_logged.add(ams_id)
  3096. logger.info(
  3097. "[%s] Rack AMS detected: unit %s (AMS type %s), global tray ids %s-%s",
  3098. self.serial_number,
  3099. ams_id,
  3100. int(kind),
  3101. global_tray_id(ams_id, 0, kind),
  3102. global_tray_id(ams_id, RACK_SLOT_COUNT - 1, kind),
  3103. )
  3104. def _ams3h_unit_id(self) -> int:
  3105. """The unit id of this printer's AMS 3H (32 on the H3C)."""
  3106. return next((uid for uid, kind in self.tray_layout.rack_units if kind == AmsType.ZMULTI_A), AMS3H_UNIT_ID)
  3107. def _rack_ams_type(self, ams_id: int) -> AmsType | None:
  3108. """The type of unit ``ams_id`` when it is one of this printer's rack AMS units, else None."""
  3109. for uid, kind in self.tray_layout.rack_units:
  3110. if uid == ams_id:
  3111. return kind
  3112. return None
  3113. def _parse_fila_switch(self, data: dict) -> None:
  3114. """Read the Filament Track Switch block out of a print payload — #1162.
  3115. Presence of ``device.fila_switch`` means the accessory is installed. Kept
  3116. separate from the rest of the state update because ``_handle_ams_data``
  3117. needs the answer before it parses the AMS info bits, and that runs first.
  3118. """
  3119. if not isinstance(data.get("device"), dict):
  3120. return
  3121. fs_data = data["device"].get("fila_switch")
  3122. if not isinstance(fs_data, dict):
  3123. return
  3124. in_raw = fs_data.get("in")
  3125. out_raw = fs_data.get("out")
  3126. self.state.fila_switch = FilaSwitchState(
  3127. installed=True,
  3128. in_slots=list(in_raw) if isinstance(in_raw, list) else [],
  3129. out_extruders=list(out_raw) if isinstance(out_raw, list) else [],
  3130. stat=int(fs_data.get("stat", 0) or 0),
  3131. info=int(fs_data.get("info", 0) or 0),
  3132. )
  3133. def _parse_extruder_position(self, data: dict) -> bool:
  3134. """Read which nozzle is active and which tray each nozzle holds.
  3135. From ``device.extruder``: ``state`` bit 8 is the active nozzle, each
  3136. ``info`` entry's ``snow`` names its AMS and slot. Run on a frame before
  3137. its AMS block, because an H2D's tray_now is a bare slot that only the
  3138. extruder data of the same frame places. Returns True when the frame
  3139. carried the active nozzle's snow. A malformed value is skipped, never
  3140. raised: this runs ahead of everything else the frame carries.
  3141. """
  3142. device = data.get("device")
  3143. extruder = device.get("extruder") if isinstance(device, dict) else None
  3144. if not isinstance(extruder, dict):
  3145. return False
  3146. try:
  3147. state_val = int(extruder["state"]) if "state" in extruder else None
  3148. except (TypeError, ValueError):
  3149. state_val = None
  3150. if state_val is not None:
  3151. # Extract bit 8 for extruder position
  3152. new_extruder = (state_val >> 8) & 0x1
  3153. if new_extruder != self.state.active_extruder:
  3154. logger.debug(
  3155. f"[{self.serial_number}] ACTIVE EXTRUDER CHANGED (state bit 8): {self.state.active_extruder} -> {new_extruder} (0=right, 1=left) [state={state_val}]"
  3156. )
  3157. self.state.active_extruder = new_extruder
  3158. extruder_info = extruder.get("info")
  3159. if not isinstance(extruder_info, list) or len(extruder_info) < 2:
  3160. return False
  3161. # Parse H2D snow field (slot now) for accurate tray_now disambiguation
  3162. # snow encodes AMS ID in high byte: ams_id = snow >> 8, slot = snow & 0xFF
  3163. snow_read: set[int] = set()
  3164. for ext_info in extruder_info:
  3165. if not isinstance(ext_info, dict) or "id" not in ext_info or "snow" not in ext_info:
  3166. continue
  3167. try:
  3168. ext_id = int(ext_info["id"])
  3169. snow = int(ext_info["snow"])
  3170. except (TypeError, ValueError):
  3171. continue
  3172. if ext_id <= 1:
  3173. snow_read.add(ext_id)
  3174. # Normalize H2D snow value to global tray ID (255 = unloaded)
  3175. global_tray = 255 if snow == 0xFFFF else decode_wire_slot(snow)
  3176. if global_tray is None:
  3177. continue
  3178. if self.state.h2d_extruder_snow.get(ext_id) != global_tray:
  3179. logger.debug(
  3180. f"[{self.serial_number}] H2D extruder[{ext_id}] snow: raw={snow} -> global tray {global_tray}"
  3181. )
  3182. self.state.h2d_extruder_snow[ext_id] = global_tray
  3183. return self.state.active_extruder in snow_read
  3184. def _parse_extruder_slots(self, data: dict) -> None:
  3185. """Read which AMS slot each extruder is fed from — ``device.extruder.info``.
  3186. Absent on printers that do not report the block, in which case the
  3187. previous answer is kept rather than cleared: a partial payload carrying
  3188. only temperatures must not look like "both hotends are now empty".
  3189. """
  3190. device = data.get("device")
  3191. if not isinstance(device, dict):
  3192. return
  3193. info = device.get("extruder", {}).get("info") if isinstance(device.get("extruder"), dict) else None
  3194. if not isinstance(info, list) or not info:
  3195. return
  3196. slots: dict[int, ExtruderSlot] = {}
  3197. for entry in info:
  3198. if not isinstance(entry, dict) or "id" not in entry:
  3199. continue
  3200. try:
  3201. ext_id = int(entry["id"])
  3202. snow = int(entry.get("snow", _EXTRUDER_SLOT_EMPTY))
  3203. flags = int(entry.get("info", 0) or 0)
  3204. except (TypeError, ValueError):
  3205. continue
  3206. if snow == _EXTRUDER_SLOT_EMPTY or snow < 0:
  3207. ams_id = slot_id = None
  3208. else:
  3209. ams_id = (snow >> 8) & 0xFF
  3210. slot_id = snow & 0xFF
  3211. slots[ext_id] = ExtruderSlot(
  3212. ams_id=ams_id,
  3213. slot_id=slot_id,
  3214. has_filament=bool(flags & 0b10),
  3215. )
  3216. if slots:
  3217. self.state.extruder_slots = slots
  3218. def _handle_ams_data(self, ams_data):
  3219. """Handle AMS data changes for Spoolman integration.
  3220. This is called when we receive top-level AMS data in MQTT messages.
  3221. It detects changes and triggers the callback for Spoolman sync.
  3222. """
  3223. import hashlib
  3224. # Handle nested ams structure: {"ams": {"ams": [...]}} or {"ams": [...]}
  3225. # Also handle P1S partial updates: {"tray_now": ..., "tray_tar": ...} without "ams" key
  3226. ams_list = None
  3227. if isinstance(ams_data, dict):
  3228. if "ams" in ams_data:
  3229. ams_list = ams_data["ams"]
  3230. self._normalize_a2l_am_units(ams_list)
  3231. apply_rack_ams_zone_fields(ams_list, dict(self.tray_layout.units))
  3232. # Log all AMS dict fields to debug tray_now for H2D dual-nozzle
  3233. non_list_fields = {k: v for k, v in ams_data.items() if k != "ams"}
  3234. if non_list_fields:
  3235. self._debug_on_change(
  3236. "ams_dict_fields",
  3237. non_list_fields,
  3238. "[%s] AMS dict fields: %s",
  3239. self.serial_number,
  3240. non_list_fields,
  3241. )
  3242. # IMPORTANT: Parse ams_status FIRST before tray_now, so we have fresh status
  3243. # when checking if we're in filament change mode for tray_now disambiguation
  3244. if "ams_status" in ams_data:
  3245. raw_ams_status = ams_data["ams_status"]
  3246. if isinstance(raw_ams_status, str):
  3247. try:
  3248. self.state.ams_status = int(raw_ams_status)
  3249. except ValueError:
  3250. self.state.ams_status = 0
  3251. else:
  3252. self.state.ams_status = raw_ams_status if raw_ams_status is not None else 0
  3253. # Compute main and sub status
  3254. self.state.ams_status_sub = self.state.ams_status & 0xFF
  3255. self.state.ams_status_main = (self.state.ams_status >> 8) & 0xFF
  3256. self._debug_on_change(
  3257. "ams_status:ams",
  3258. self.state.ams_status,
  3259. "[%s] ams_status: %s (main=%s, sub=%s)",
  3260. self.serial_number,
  3261. self.state.ams_status,
  3262. self.state.ams_status_main,
  3263. self.state.ams_status_sub,
  3264. )
  3265. # Parse tray_tar / tray_pre (RAW). These identify the slot the firmware
  3266. # now expects (tray_tar) and the slot loaded before (tray_pre) — the key
  3267. # signal for a runout PAUSE where AMS Filament Backup has advanced to the
  3268. # next compatible slot (#2587). Stored raw here; globalised at the API
  3269. # boundary because that resolution needs the AMS layout. On H2D/multi-AMS
  3270. # these are local slot numbers (0-3), not global IDs.
  3271. for _tk, _attr in (("tray_tar", "tray_tar"), ("tray_pre", "tray_pre")):
  3272. if _tk in ams_data:
  3273. _raw = ams_data[_tk]
  3274. if isinstance(_raw, str):
  3275. try:
  3276. _val = int(_raw)
  3277. except ValueError:
  3278. _val = 255
  3279. else:
  3280. _val = _raw if _raw is not None else 255
  3281. prev = getattr(self.state, _attr)
  3282. setattr(self.state, _attr, _val)
  3283. # Log changes only while paused — the moment the operator cares —
  3284. # so a healthy print's normal tar churn doesn't spam the log.
  3285. if _val != prev and _val not in (255, -1) and self.state.state == "PAUSE":
  3286. logger.info(
  3287. "[%s] AMS %s changed to %s while paused (expected/previous slot signal, #2587)",
  3288. self.serial_number,
  3289. _tk,
  3290. _val,
  3291. )
  3292. # Parse tray_now from AMS dict - this is the currently loaded tray global ID
  3293. # Note: tray_tar is also available but on H2D it's just slot number (0-3), not global ID
  3294. if "tray_now" in ams_data:
  3295. raw_tray_now = ams_data["tray_now"]
  3296. # Convert string to int if needed
  3297. if isinstance(raw_tray_now, str):
  3298. try:
  3299. parsed_tray_now = int(raw_tray_now)
  3300. except ValueError:
  3301. parsed_tray_now = 255
  3302. else:
  3303. parsed_tray_now = raw_tray_now if raw_tray_now is not None else 255
  3304. # H2D dual-nozzle printers report only slot number (0-3), not global tray ID
  3305. # Use active_extruder + ams_extruder_map to determine which AMS the slot belongs to
  3306. # Single-nozzle printers with multiple AMS (e.g. P2S) also report local slot IDs (#420)
  3307. # — disambiguated below using MQTT mapping field
  3308. ams_map = self.state.ams_extruder_map
  3309. # A rack AMS reports tray_now as its raw slot 0-8 (global 28 +
  3310. # slot). Its units may arrive in this same push, before the merge.
  3311. rack_layout = self._layout_with(ams_list)
  3312. self._note_rack_ams(rack_layout)
  3313. if rack_layout.rack_units and not self._is_dual_nozzle:
  3314. rack_tray = rack_layout.raw_slot_to_global(parsed_tray_now)
  3315. # 255 (nothing on the toolhead, also mid-swap) and any
  3316. # external input id are kept as reported.
  3317. self.state.tray_now = rack_tray if rack_tray is not None else parsed_tray_now
  3318. elif self._is_dual_nozzle and 0 <= parsed_tray_now <= 3:
  3319. # First, check if we have a pending target that matches this slot
  3320. pending_target = self.state.pending_tray_target
  3321. pending_at = self.state.pending_tray_target_at
  3322. if (
  3323. pending_target is not None
  3324. and pending_at is not None
  3325. and time.monotonic() - pending_at > PENDING_TRAY_TARGET_TTL
  3326. ):
  3327. # A load the printer refused or dropped: nothing clears
  3328. # it (tray_now stays 255), and a print loading the same
  3329. # slot number on another AMS long after was shown as
  3330. # this target (FW-C7). Fall through to the snow field.
  3331. self.state.pending_tray_target = None
  3332. self.state.pending_tray_target_at = None
  3333. pending_target = None
  3334. if pending_target is not None:
  3335. # Same slot rule as the snow branch below: an AMS-HT
  3336. # (128-135) has its one tray in slot 0.
  3337. pending_slot = 0 if is_ams_ht_id(pending_target) else pending_target % 4
  3338. if pending_slot == parsed_tray_now:
  3339. # Slot matches our pending target - use the full global ID
  3340. logger.debug(
  3341. f"[{self.serial_number}] H2D tray_now disambiguation: "
  3342. f"slot {parsed_tray_now} matches pending_tray_target {pending_target} -> using global ID {pending_target}"
  3343. )
  3344. self.state.tray_now = pending_target
  3345. # Clear pending target now that load is confirmed
  3346. self.state.pending_tray_target = None
  3347. else:
  3348. # Slot doesn't match our pending target - something changed, use slot as-is
  3349. logger.warning(
  3350. f"[{self.serial_number}] H2D tray_now: slot {parsed_tray_now} doesn't match "
  3351. f"pending_tray_target {pending_target} (slot {pending_slot}) - using slot as global ID"
  3352. )
  3353. self.state.tray_now = parsed_tray_now
  3354. # Clear pending target since it's stale
  3355. self.state.pending_tray_target = None
  3356. else:
  3357. # No pending target - use h2d_extruder_snow for accurate disambiguation
  3358. # H2D sends snow field in device.extruder.info with AMS ID in high byte
  3359. active_ext = self.state.active_extruder # 0=right, 1=left
  3360. # Best source: use snow value from device.extruder.info if available
  3361. snow_tray = self.state.h2d_extruder_snow.get(active_ext)
  3362. # Regular AMS: slot = global_id % 4; AMS HT (128-135): single slot = 0
  3363. snow_slot = (
  3364. None
  3365. if snow_tray is None
  3366. else snow_tray % 4
  3367. if snow_tray < 128
  3368. else (0 if is_ams_ht_id(snow_tray) else -1)
  3369. )
  3370. # A snow from an earlier frame may predate a swap: it
  3371. # names the tray only while it agrees with the slot.
  3372. snow_usable = (
  3373. snow_tray is not None
  3374. and snow_tray != 255
  3375. and (snow_slot == parsed_tray_now or self._snow_in_frame)
  3376. )
  3377. if snow_usable and snow_tray is not None:
  3378. # snow_tray is already normalized to global ID
  3379. if snow_slot == parsed_tray_now:
  3380. if self.state.tray_now != snow_tray:
  3381. logger.debug(
  3382. f"[{self.serial_number}] H2D tray_now from snow: "
  3383. f"extruder[{active_ext}] snow={snow_tray} (slot {snow_slot})"
  3384. )
  3385. self.state.tray_now = snow_tray
  3386. else:
  3387. # Slot mismatch in one frame: the extruder's own
  3388. # report is the complete answer, trust snow
  3389. logger.debug(
  3390. f"[{self.serial_number}] H2D tray_now: ams.tray_now slot {parsed_tray_now} "
  3391. f"!= snow slot {snow_slot}, using snow value {snow_tray}"
  3392. )
  3393. self.state.tray_now = snow_tray
  3394. else:
  3395. # Fallback: snow not available, use ams_extruder_map (less reliable)
  3396. # Find ALL AMS units on the active extruder
  3397. ams_on_extruder = []
  3398. for ams_id_str, ext_id in ams_map.items():
  3399. if ext_id == active_ext:
  3400. try:
  3401. ams_on_extruder.append(int(ams_id_str))
  3402. except ValueError:
  3403. pass # Skip AMS IDs that aren't valid integers
  3404. # Several AMS (or none the map knows of) leave the
  3405. # slot ambiguous. The printer's own mapping names the
  3406. # trays the running print uses: one of them at this
  3407. # slot is the one feeding (#3242). Only while a print
  3408. # runs: an idle H2 keeps reporting the previous
  3409. # print's mapping.
  3410. mapped_tray = None
  3411. if len(ams_on_extruder) != 1 and self._was_running and not self._completion_triggered:
  3412. mapped_tray = self._resolve_local_slot_from_mapping(
  3413. parsed_tray_now, self.state.raw_data.get("mapping"), ams_on_extruder
  3414. )
  3415. if mapped_tray is not None:
  3416. if self.state.tray_now != mapped_tray:
  3417. logger.debug(
  3418. f"[{self.serial_number}] H2D tray_now: AMS {ams_on_extruder} on extruder "
  3419. f"{active_ext}, slot {parsed_tray_now} -> global ID {mapped_tray} (from mapping)"
  3420. )
  3421. self.state.tray_now = mapped_tray
  3422. elif len(ams_on_extruder) == 1:
  3423. # Single AMS on this extruder - unambiguous
  3424. active_ams_id = ams_on_extruder[0]
  3425. # AMS-HT: single slot per unit, global ID = unit ID
  3426. fallback_tray = global_tray_id(active_ams_id, parsed_tray_now)
  3427. logger.debug(
  3428. f"[{self.serial_number}] H2D tray_now fallback: "
  3429. f"slot {parsed_tray_now} + single AMS {active_ams_id} -> global ID {fallback_tray}"
  3430. )
  3431. self.state.tray_now = fallback_tray
  3432. elif len(ams_on_extruder) > 1:
  3433. # Multiple AMS on this extruder - keep current if valid, else try to narrow down
  3434. current_tray = self.state.tray_now
  3435. # Determine which AMS unit and slot the current tray belongs to
  3436. if 0 <= current_tray <= 15 or is_ams_ht_id(current_tray):
  3437. # AMS-HT: ID = tray ID, one slot
  3438. current_ams, current_slot = rack_layout.slot_key(current_tray)
  3439. else:
  3440. current_ams = -1
  3441. current_slot = -1
  3442. if current_ams in ams_on_extruder and current_slot == parsed_tray_now:
  3443. # Current is valid and matches slot - keep it
  3444. logger.debug(
  3445. f"[{self.serial_number}] H2D tray_now: multiple AMS {ams_on_extruder}, "
  3446. f"keeping current {current_tray} (matches slot {parsed_tray_now})"
  3447. )
  3448. else:
  3449. # Filter candidates: AMS-HT (128-135) only valid for slot 0
  3450. if parsed_tray_now > 0:
  3451. candidates = [a for a in ams_on_extruder if a <= 3]
  3452. else:
  3453. candidates = ams_on_extruder
  3454. if len(candidates) == 1:
  3455. cand = candidates[0]
  3456. resolved = global_tray_id(cand, parsed_tray_now)
  3457. logger.debug(
  3458. f"[{self.serial_number}] H2D tray_now: multiple AMS {ams_on_extruder}, "
  3459. f"narrowed to AMS {cand} -> global ID {resolved}"
  3460. )
  3461. self.state.tray_now = resolved
  3462. else:
  3463. # Genuinely ambiguous. This is the second between a
  3464. # filament change reaching the AMS report and the
  3465. # extruder's snow, which then names the tray. Using
  3466. # the bare slot would point at AMS 0 and put that
  3467. # tray in the usage change log (#3242), so keep the
  3468. # current tray until snow arrives.
  3469. logger.debug(
  3470. f"[{self.serial_number}] H2D tray_now: multiple AMS {ams_on_extruder} on "
  3471. f"extruder {active_ext}, slot {parsed_tray_now} is ambiguous without snow, "
  3472. f"keeping {current_tray}"
  3473. )
  3474. else:
  3475. # No AMS on this extruder that the map knows of: the
  3476. # slot can't be placed, keep the current tray (#3242)
  3477. logger.debug(
  3478. f"[{self.serial_number}] H2D tray_now: no AMS on extruder {active_ext}, "
  3479. f"slot {parsed_tray_now} can't be placed without snow, keeping {self.state.tray_now}"
  3480. )
  3481. elif not self._is_dual_nozzle and 0 <= parsed_tray_now <= 3:
  3482. # Single-nozzle printer with tray_now in 0-3 range.
  3483. # #1822: H2S firmware reports tray_now as the AMS's idle
  3484. # slot (typically 0) when the active feed is actually the
  3485. # external spool. X1C / P1S / A1 correctly report 254 in
  3486. # that case; H2S does not. When the slicer-captured
  3487. # ams_mapping is all-external (every entry is 254, or -1
  3488. # when the command carried no ams_mapping2 to resolve it
  3489. # from, #3166), the print can only be feeding from the
  3490. # external spool, so promote tray_now to 254. Mixed (e.g. [5, 254]) and
  3491. # AMS-only mappings are NOT overridden — there's no
  3492. # evidence the firmware misreports in those cases. Prints
  3493. # started without a captured mapping (printer-screen start,
  3494. # or before Bambuddy connected) fall through unchanged.
  3495. captured = self._captured_ams_mapping
  3496. if captured and all(s in (-1, 254, 255) for s in captured):
  3497. if self.state.tray_now != 254:
  3498. logger.debug(
  3499. f"[{self.serial_number}] tray_now external-spool override (#1822): "
  3500. f"slot {parsed_tray_now} -> 254 (ams_mapping={captured})"
  3501. )
  3502. self.state.tray_now = 254
  3503. else:
  3504. # P2S (and possibly other models) with multiple AMS units sends LOCAL slot IDs
  3505. # in tray_now, not global tray IDs (#420). Use the MQTT mapping field
  3506. # (snow-encoded) to resolve the correct AMS unit.
  3507. ams_exist_raw = ams_data.get("ams_exist_bits", "0")
  3508. try:
  3509. ams_exist = int(ams_exist_raw, 16) if isinstance(ams_exist_raw, str) else int(ams_exist_raw)
  3510. except (ValueError, TypeError):
  3511. ams_exist = 0
  3512. num_ams = bin(ams_exist).count("1")
  3513. if self._has_a2l_am_unit and num_ams <= 1:
  3514. # A2L AMS-Lite (normalised unit 6): the firmware reports
  3515. # tray_now as a LOCAL 0-3 slot, so globalise to 24+slot —
  3516. # otherwise usage tracking keys the wrong spool (it would
  3517. # deduct from AMS 0's slot). Confirmed by capture:
  3518. # tray_now="2" while printing physical slot 3.
  3519. self.state.tray_now = A2L_LITE_GLOBAL_BASE + parsed_tray_now
  3520. elif num_ams > 1:
  3521. # Multiple AMS on single-nozzle — tray_now is likely a local slot ID.
  3522. # Cross-reference with MQTT mapping field to find the correct AMS unit.
  3523. if self._has_a2l_am_unit:
  3524. # A2L Lite + a regular AMS attached together is out of
  3525. # scope: the flat mapping ids are unknown for that combo
  3526. # and could collide with AMS 0. Fall through to the
  3527. # mapping-based resolve, but warn — a capture is needed.
  3528. logger.warning(
  3529. "[%s] A2L AMS-Lite alongside another AMS unit is unsupported — "
  3530. "tray_now resolution may be wrong (needs a mixed-setup capture)",
  3531. self.serial_number,
  3532. )
  3533. mapping_raw = self.state.raw_data.get("mapping")
  3534. resolved = self._resolve_local_slot_from_mapping(parsed_tray_now, mapping_raw)
  3535. if resolved is not None:
  3536. if resolved != parsed_tray_now:
  3537. logger.debug(
  3538. f"[{self.serial_number}] Multi-AMS tray_now: "
  3539. f"local slot {parsed_tray_now} -> global ID {resolved} (from mapping)"
  3540. )
  3541. self.state.tray_now = resolved
  3542. else:
  3543. # No mapping available (not printing, or ambiguous) — use as-is.
  3544. # This matches the old behavior and is correct for AMS 0.
  3545. self.state.tray_now = parsed_tray_now
  3546. else:
  3547. # Single AMS — local slot 0-3 equals global ID
  3548. self.state.tray_now = parsed_tray_now
  3549. else:
  3550. # tray_now > 3 means it's already a global ID, or 255 means unloaded
  3551. # Note: Do NOT clear pending_tray_target on tray_now=255 here.
  3552. # During filament change, the printer sends 255 first (unload), then the slot.
  3553. # We only clear pending_tray_target explicitly in ams_unload_filament().
  3554. # Trust the printer's reported value.
  3555. self.state.tray_now = parsed_tray_now
  3556. # Track last valid tray for usage tracking (survives retract → 255 at print end)
  3557. tn = self.state.tray_now
  3558. if rack_layout.is_loaded_tray(tn):
  3559. # Log tray change for mid-print usage splitting. Gate on the
  3560. # print-lifecycle flags (`_was_running` set on first RUNNING /
  3561. # new print, `_completion_triggered` set when on_print_complete
  3562. # fires) instead of `state in ("RUNNING", "PAUSE")` — P2S
  3563. # firmware briefly transitions out of RUNNING during AMS
  3564. # auto-fallback (#957), so a literal-string gate misses the
  3565. # switch and the usage tracker double-credits at completion.
  3566. if tn != self.state.last_loaded_tray and self._was_running and not self._completion_triggered:
  3567. self.state.tray_change_log.append((tn, self.state.layer_num))
  3568. logger.info(
  3569. "[%s] Tray change during print: tray=%d at layer=%d",
  3570. self.serial_number,
  3571. tn,
  3572. self.state.layer_num,
  3573. )
  3574. if self.on_tray_change:
  3575. self.on_tray_change(tn, self.state.layer_num)
  3576. self.state.last_loaded_tray = self.state.tray_now
  3577. self._debug_on_change(
  3578. "tray_now",
  3579. self.state.tray_now,
  3580. "[%s] tray_now updated: %s",
  3581. self.serial_number,
  3582. self.state.tray_now,
  3583. )
  3584. # NOTE: ams_status is parsed BEFORE tray_now (see above) to ensure correct
  3585. # state when checking filament change mode for H2D disambiguation
  3586. # P1S/P1P send partial updates without "ams" key - this is valid, not an error
  3587. # We've already processed the status fields above, so just return if no ams list
  3588. if ams_list is None:
  3589. logger.debug("[%s] AMS partial update (no tray data)", self.serial_number)
  3590. return
  3591. elif isinstance(ams_data, list):
  3592. ams_list = ams_data
  3593. self._normalize_a2l_am_units(ams_list)
  3594. apply_rack_ams_zone_fields(ams_list, dict(self.tray_layout.units))
  3595. else:
  3596. logger.warning("[%s] Unexpected AMS data format: %s", self.serial_number, type(ams_data))
  3597. return
  3598. # Merge AMS data instead of replacing, to handle partial updates
  3599. # During prints, the printer may only send updates for active AMS units
  3600. # We need deep merging at the tray level to preserve fields like tray_sub_brands
  3601. existing_ams = self.state.raw_data.get("ams", [])
  3602. existing_by_id = {ams.get("id"): ams for ams in existing_ams if ams.get("id") is not None}
  3603. # Update existing units with new data, add new units
  3604. for ams_unit in ams_list:
  3605. ams_id = ams_unit.get("id")
  3606. if ams_id is not None:
  3607. existing_unit = existing_by_id.get(ams_id)
  3608. if existing_unit and "tray" in ams_unit:
  3609. # Deep merge trays to preserve fields from previous updates
  3610. existing_trays = {t.get("id"): t for t in existing_unit.get("tray", []) if t.get("id") is not None}
  3611. merged_trays = []
  3612. for new_tray in ams_unit.get("tray", []):
  3613. tray_id = new_tray.get("id")
  3614. if tray_id is not None and tray_id in existing_trays:
  3615. # Merge: start with existing, update with new non-empty values
  3616. merged_tray = existing_trays[tray_id].copy()
  3617. # Detect slot-clearing updates (spool removal):
  3618. # When tray_type is explicitly empty, clear everything
  3619. # including RFID data (tag_uid/tray_uuid).
  3620. slot_clearing = new_tray.get("tray_type") == ""
  3621. # Some printers (e.g. H2D) only send {id, state} in
  3622. # incremental updates when a tray is not fully loaded.
  3623. # state=11 means loaded; other values (9=empty,
  3624. # 10=spool present but filament not in feeder) indicate
  3625. # the slot should be cleared. Without this, old
  3626. # tray_type/tray_color persist indefinitely (#784).
  3627. #
  3628. # BUT this is regular-AMS semantics. An AMS-HT (single-
  3629. # tray high-temp dry box, id >= 128) reports its loaded
  3630. # tray as state=9, not 11 — it doesn't feed filament into
  3631. # a shared buffer the way a 4-slot AMS does. Applying the
  3632. # `state != 11 → empty` rule to an HT unit wiped a present
  3633. # spool on every power-on, when the printer sends a partial
  3634. # {id, state=9} for the HT tray (#2594). Skip the state
  3635. # heuristic for HT units — a genuine HT spool removal still
  3636. # clears via the explicit tray_type=="" case above and the
  3637. # tray_exist_bits cleanup below.
  3638. try:
  3639. _is_ht_unit = int(ams_id) >= 128
  3640. except (TypeError, ValueError):
  3641. _is_ht_unit = False
  3642. tray_state = new_tray.get("state")
  3643. if (
  3644. tray_state is not None
  3645. and tray_state != 11
  3646. and not _is_ht_unit
  3647. and "tray_type" not in new_tray
  3648. and merged_tray.get("tray_type")
  3649. ):
  3650. logger.info(
  3651. "[%s] AMS %s tray %s: state=%s (not loaded) — clearing stale tray data",
  3652. self.serial_number,
  3653. ams_id,
  3654. tray_id,
  3655. tray_state,
  3656. )
  3657. slot_clearing = True
  3658. # The incremental update only has {id, state} — inject
  3659. # empty values for all content fields so the merge loop
  3660. # below clears the stale data from merged_tray.
  3661. new_tray.update(
  3662. {
  3663. "tray_type": "",
  3664. "tray_sub_brands": "",
  3665. "tray_color": "",
  3666. "tray_id_name": "",
  3667. "tray_info_idx": "",
  3668. "tag_uid": "0000000000000000",
  3669. "tray_uuid": "00000000000000000000000000000000",
  3670. "remain": 0,
  3671. "k": None,
  3672. "cali_idx": None,
  3673. }
  3674. )
  3675. for key, value in new_tray.items():
  3676. # Fields that should always be updated (even with empty/zero values):
  3677. # - remain, k, id, cali_idx: status indicators where 0 is valid
  3678. # - tray_type, tray_sub_brands, tray_info_idx, tray_color,
  3679. # tray_id_name: slot content indicators that must be cleared
  3680. # when a spool is removed (fixes #147 - old AMS empty slot)
  3681. # NOTE: tag_uid and tray_uuid are NOT in always_update_fields.
  3682. # They are only cleared during spool removal (slot_clearing=True).
  3683. # Periodic AMS updates often include empty RFID fields which
  3684. # would overwrite valid data from the initial pushall.
  3685. always_update_fields = (
  3686. "remain",
  3687. "k",
  3688. "id",
  3689. "cali_idx",
  3690. "tray_type",
  3691. "tray_sub_brands",
  3692. "tray_info_idx",
  3693. "tray_color",
  3694. "tray_id_name",
  3695. )
  3696. if (
  3697. key in always_update_fields
  3698. or slot_clearing
  3699. or value
  3700. not in (
  3701. None,
  3702. "",
  3703. "0000000000000000",
  3704. "00000000000000000000000000000000",
  3705. )
  3706. ):
  3707. merged_tray[key] = value
  3708. merged_trays.append(merged_tray)
  3709. else:
  3710. merged_trays.append(new_tray)
  3711. # Update ams_unit with merged trays. Spread existing_unit
  3712. # FIRST so top-level fields the partial update omits —
  3713. # dry_time, info (which drives dry_status / dry_sub_status),
  3714. # humidity, temp — are preserved instead of dropped. The
  3715. # printer sends tray-bearing partials that carry no drying
  3716. # fields; without this, dry_time reads as absent → 0 and the
  3717. # falling-edge detector below fires a false "drying complete"
  3718. # (#1462). Mirrors the no-tray branch's merge semantics.
  3719. ams_unit = {**existing_unit, **ams_unit, "tray": merged_trays}
  3720. elif existing_unit:
  3721. # Partial update without tray data: merge new fields into existing
  3722. # unit to preserve tray, sn, sw_ver, and other accumulated data.
  3723. ams_unit = {**existing_unit, **ams_unit}
  3724. existing_by_id[ams_id] = ams_unit
  3725. # The merge keeps a unit the push doesn't list, so an unplugged AMS used
  3726. # to stay until Bambuddy restarted (#3356). Drop one only on the
  3727. # printer's own word that it is gone.
  3728. if isinstance(ams_data, dict):
  3729. listed = {ams_unit.get("id") for ams_unit in ams_list}
  3730. for ams_id in [i for i in existing_by_id if i not in listed]:
  3731. if unit_reported_absent(ams_id, ams_list, ams_data.get("ams_exist_bits")):
  3732. logger.info("[%s] AMS %s no longer attached, removing it", self.serial_number, ams_id)
  3733. del existing_by_id[ams_id]
  3734. # Convert back to list, sorted by ID for consistent ordering
  3735. merged_ams = sorted(existing_by_id.values(), key=lambda x: x.get("id", 0))
  3736. # Empty-slot cleanup via tray_exist_bits (#147, #1322, #765, #1365).
  3737. # Shared with the VP bridge cache so the slicer-facing view stays in
  3738. # sync with Bambuddy's AMS card (#1726). See the helper's docstring
  3739. # for the full rationale and the printer-shutdown guard.
  3740. if isinstance(ams_data, dict):
  3741. apply_tray_exist_bits(
  3742. merged_ams,
  3743. ams_data.get("tray_exist_bits"),
  3744. power_on_flag=ams_data.get("power_on_flag", True),
  3745. log_label=self.serial_number,
  3746. annotate_exists=True,
  3747. )
  3748. self.state.raw_data["ams"] = merged_ams
  3749. # Apply cached AMS firmware/SN from get_version (handles ordering and id type mismatches)
  3750. self._apply_ams_version_cache(merged_ams)
  3751. # Update timestamp for RFID refresh detection (frontend can detect "new data arrived")
  3752. self.state.last_ams_update = time.time()
  3753. self._debug_on_change(
  3754. "merged_ams",
  3755. (len(ams_list), len(merged_ams)),
  3756. "[%s] Merged AMS data: %s new units, %s total",
  3757. self.serial_number,
  3758. len(ams_list),
  3759. len(merged_ams),
  3760. )
  3761. # Extract ams_extruder_map from each AMS unit's info field
  3762. # BambuStudio DevFilaSystem.cpp parses info as hex string:
  3763. # type_id = get_flag_bits(info, 0, 4) // bits 0-3: AMS type
  3764. # extruder_id = get_flag_bits(info, 8, 4) // bits 8-11: extruder assignment
  3765. # bind_switch_in = get_flag_bits(info, 24, 4) // bits 24-27: FTS inlet
  3766. # where get_flag_bits uses std::stoull(str, nullptr, 16) — hex parsing.
  3767. # extruder_id: 0=right/main, 1=left/deputy, 0xE=routing is not fixed
  3768. #
  3769. # 0xE does not mean "broken". On a Filament Track Switch machine it is the
  3770. # normal steady state: the AMS is bound to a switch *inlet* rather than to
  3771. # one extruder, and reaches both nozzles through it. Bits 24-27 then name
  3772. # that inlet — 0 = In-B, 1 = In-A (BambuStudio's SwitchPos enum, which is
  3773. # ordered B-then-A). Without an FTS, 0xE really is an uninitialised unit
  3774. # and bits 24-27 carry nothing, which is why the inlet read is gated on
  3775. # the switch being installed.
  3776. #
  3777. # Use merged_ams (not ams_list) to avoid partial MQTT updates overwriting
  3778. # the full map. Merge into existing map to preserve entries from prior updates.
  3779. fts_installed = self.state.fila_switch.installed
  3780. inlet_moves: list[tuple[int, str]] = []
  3781. ams_extruder_map = dict(self.state.ams_extruder_map) if self.state.ams_extruder_map else {}
  3782. ams_switch_inlet = dict(self.state.ams_switch_inlet) if self.state.ams_switch_inlet else {}
  3783. # A rack AMS feeds the one extruder of a rack printer; listed here it
  3784. # would make the slot/dispatch code assume two nozzles.
  3785. rack_ams_ids = {uid for uid, _ in TrayLayout.from_units(merged_ams).rack_units}
  3786. for ams_unit in merged_ams:
  3787. ams_id = ams_unit.get("id")
  3788. info = ams_unit.get("info")
  3789. if _mqtt_int(ams_id) in rack_ams_ids:
  3790. continue
  3791. if ams_id is not None and info is not None:
  3792. try:
  3793. # info is a hex-encoded string in MQTT JSON (e.g. "10001003")
  3794. info_val = int(str(info), 16)
  3795. # Extract 4 bits starting at bit 8 for extruder assignment
  3796. extruder_id = (info_val >> 8) & 0xF
  3797. if extruder_id == 0xE:
  3798. if fts_installed:
  3799. inlet = {0: "B", 1: "A"}.get((info_val >> 24) & 0xF)
  3800. if inlet is not None:
  3801. previous = ams_switch_inlet.get(str(ams_id))
  3802. ams_switch_inlet[str(ams_id)] = inlet
  3803. self._debug_on_change(
  3804. f"ams_inlet:{ams_id}",
  3805. inlet,
  3806. "[%s] AMS %s info=0x%s -> FTS inlet %s",
  3807. self.serial_number,
  3808. ams_id,
  3809. info,
  3810. inlet,
  3811. )
  3812. if previous is not None and previous != inlet:
  3813. # Only a genuine move, never the first sighting:
  3814. # re-applying K-profiles on every reconnect would
  3815. # fight a binding the operator set deliberately.
  3816. logger.info(
  3817. "[%s] AMS %s moved to FTS inlet %s (was %s)",
  3818. self.serial_number,
  3819. ams_id,
  3820. inlet,
  3821. previous,
  3822. )
  3823. inlet_moves.append((int(ams_id), inlet))
  3824. continue
  3825. ams_extruder_map[str(ams_id)] = extruder_id
  3826. self._debug_on_change(
  3827. f"ams_info:{ams_id}",
  3828. (info, extruder_id),
  3829. "[%s] AMS %s info=0x%s -> extruder %s",
  3830. self.serial_number,
  3831. ams_id,
  3832. info,
  3833. extruder_id,
  3834. )
  3835. except (ValueError, TypeError):
  3836. pass # Skip AMS units with unparseable info bitmask values
  3837. if ams_extruder_map:
  3838. self.state.raw_data["ams_extruder_map"] = ams_extruder_map
  3839. self.state.ams_extruder_map = ams_extruder_map
  3840. logger.debug("[%s] ams_extruder_map: %s", self.serial_number, ams_extruder_map)
  3841. if ams_switch_inlet:
  3842. self.state.ams_switch_inlet = ams_switch_inlet
  3843. for moved_ams_id, moved_inlet in inlet_moves:
  3844. if self.on_fts_inlet_change:
  3845. self.on_fts_inlet_change(moved_ams_id, moved_inlet)
  3846. # Extract drying status from info hex string and dry_sf_reason per AMS unit
  3847. # BambuStudio DevFilaSystem.cpp parses info bits:
  3848. # dry_status = get_flag_bits(info, 4, 4) // bits 4-7
  3849. # dry_sub_status = get_flag_bits(info, 22, 4) // bits 22-25
  3850. for ams_unit in merged_ams:
  3851. info = ams_unit.get("info")
  3852. if info is not None:
  3853. try:
  3854. info_val = int(str(info), 16)
  3855. ams_unit["dry_status"] = (info_val >> 4) & 0xF
  3856. ams_unit["dry_sub_status"] = (info_val >> 22) & 0xF
  3857. except (ValueError, TypeError):
  3858. pass # Skip unparseable info values
  3859. # dry_sf_reason is a per-unit array of cannot-dry reason codes
  3860. if "dry_sf_reason" in ams_unit:
  3861. sf_reason = ams_unit["dry_sf_reason"]
  3862. if isinstance(sf_reason, list):
  3863. ams_unit["dry_sf_reason"] = [
  3864. int(r) for r in sf_reason if isinstance(r, int) or (isinstance(r, str) and r.isdigit())
  3865. ]
  3866. else:
  3867. ams_unit["dry_sf_reason"] = []
  3868. # Persist updated drying fields back to raw_data
  3869. self.state.raw_data["ams"] = merged_ams
  3870. # Detect AMS drying-complete falling edge per-unit (#1349). When an
  3871. # AMS's `dry_time` transitions from >0 to 0 the cycle just finished
  3872. # — fire the callback so smart-plug auto-off-after-drying can run,
  3873. # and drop our cached target-cycle params so the badge stops claiming
  3874. # an active cycle. Works identically for queue-triggered, ambient,
  3875. # and manual drying because we observe the firmware-reported state.
  3876. for ams_unit in merged_ams:
  3877. try:
  3878. ams_id = int(ams_unit.get("id", -1))
  3879. except (TypeError, ValueError):
  3880. continue
  3881. if ams_id < 0:
  3882. continue
  3883. # The firmware phase outranks the stalled-countdown heuristic even
  3884. # on a transient-zero frame, which the completion guard below skips.
  3885. # Clear a previously raised flag before that early continue.
  3886. if ams_unit.get("dry_status") in ACTIVE_DRY_STATUSES:
  3887. ams_unit["dry_countdown_stalled"] = False
  3888. # Only evaluate the edge when this update carries an explicit
  3889. # dry_time. An absent / unparseable value is NOT zero — treating
  3890. # it as 0 lets a tray-only partial fake a drying-complete edge
  3891. # (#1462). Skip without touching the remembered value so the
  3892. # next update that DOES carry dry_time sees the true previous.
  3893. raw_dry_time = ams_unit.get("dry_time")
  3894. if raw_dry_time is None:
  3895. continue
  3896. try:
  3897. current = int(raw_dry_time)
  3898. except (TypeError, ValueError):
  3899. continue
  3900. # A dry_time of 0 only means "finished" when the unit also reports
  3901. # an idle phase. Between the command ack and the countdown settling
  3902. # the firmware publishes a transient 0 while the AMS is still
  3903. # Checking — #2759 caught a 720 → 0 → 719 sequence one minute into a
  3904. # 12-hour cycle. Taking that at face value dropped the cached target
  3905. # (leaving the badge to guess the filament from tray 1, so a PLA
  3906. # cycle read "PETG @ 65°C") and fired on_drying_complete, which
  3907. # schedules smart-plug auto-off. dry_status comes from the same info
  3908. # hex parsed above; when it is absent we let the edge through, so a
  3909. # firmware that never reports one still ends its cycles.
  3910. if current == 0 and ams_unit.get("dry_status") in ACTIVE_DRY_STATUSES:
  3911. # Leave the remembered value alone, exactly as the absent-
  3912. # dry_time skip above does: whichever push ends the cycle for
  3913. # real must still see a non-zero previous.
  3914. logger.debug(
  3915. "[%s] AMS %d reported dry_time 0 in phase %s — cycle still live, ignoring",
  3916. self.serial_number,
  3917. ams_id,
  3918. ams_unit.get("dry_status"),
  3919. )
  3920. continue
  3921. seen_before = ams_id in self._previous_dry_times
  3922. previous = self._previous_dry_times.get(ams_id, 0)
  3923. self._previous_dry_times[ams_id] = current
  3924. if current > 0:
  3925. cycle = self._dry_cycles.get(ams_id)
  3926. if cycle is None or previous == 0:
  3927. cycle = {
  3928. "peak": current,
  3929. # A rise from an observed 0 is the cycle's first minute.
  3930. # A first sighting already counting down is not.
  3931. "start_seen": seen_before,
  3932. "target": self._drying_targets.get(ams_id),
  3933. }
  3934. self._dry_cycles[ams_id] = cycle
  3935. elif current > int(cycle["peak"]):
  3936. cycle["peak"] = current
  3937. # Stall detection: stamp value CHANGES only — a live countdown
  3938. # decrements once a minute, so repeats of the same value within
  3939. # the minute must not refresh the stamp, and a frame without a
  3940. # dry_time never reaches here (the absent-value skip above).
  3941. now_mono = time.monotonic()
  3942. if current != previous or ams_id not in self._dry_time_changed_at:
  3943. self._dry_time_changed_at[ams_id] = now_mono
  3944. ams_unit["dry_countdown_stalled"] = bool(
  3945. current > 0
  3946. and ams_unit.get("dry_status") not in ACTIVE_DRY_STATUSES
  3947. and now_mono - self._dry_time_changed_at[ams_id] > DRY_COUNTDOWN_STALL_SECONDS
  3948. )
  3949. if previous > 0 and current == 0:
  3950. self._log_drying_cycle_end(ams_id, previous, ams_unit, self._drying_targets.pop(ams_id, None))
  3951. if self.on_drying_complete:
  3952. self.on_drying_complete(ams_id)
  3953. cycle = self._dry_cycles.pop(ams_id, None) or {"peak": previous, "start_seen": False, "target": None}
  3954. if self.on_drying_cycle_end:
  3955. self.on_drying_cycle_end(self._drying_cycle_end(ams_id, previous, cycle))
  3956. # Create a hash of relevant AMS data to detect changes.
  3957. # Hash the MERGED state, not the raw incoming ams_list: a removal signalled
  3958. # only by tray_exist_bits (firmware still echoing the old tray_type in the
  3959. # payload, unchanged remain) clears merged_ams via apply_tray_exist_bits
  3960. # above but leaves the raw payload's tracked fields untouched — so a
  3961. # raw-based hash never flips and on_ams_change never fires, leaving the
  3962. # spool_assignment row bound to an emptied slot (#2670). merged_ams also
  3963. # always spans every unit, so a partial single-unit update can't produce a
  3964. # spuriously different hash from a full pushall.
  3965. ams_hash_data = []
  3966. for ams_unit in merged_ams:
  3967. for tray in ams_unit.get("tray", []):
  3968. # Include fields that matter for filament tracking
  3969. ams_hash_data.append(
  3970. f"{ams_unit.get('id')}:{tray.get('id')}:"
  3971. f"{tray.get('tray_type')}:{tray.get('tag_uid')}:{tray.get('remain')}"
  3972. )
  3973. ams_hash = hashlib.md5(":".join(ams_hash_data).encode(), usedforsecurity=False).hexdigest()
  3974. # Only trigger callback if AMS data actually changed
  3975. if ams_hash != self._previous_ams_hash:
  3976. self._previous_ams_hash = ams_hash
  3977. if self.on_ams_change:
  3978. logger.debug("[%s] AMS data changed, triggering sync callback", self.serial_number)
  3979. # Pass merged AMS data (not raw ams_list) — partial MQTT updates
  3980. # may lack fields like 'remain' that the merged state preserves
  3981. self.on_ams_change(merged_ams)
  3982. # #2582: read-back check runs on EVERY AMS push, not just hash changes.
  3983. # The change hash keys on tray_type/tag_uid/remain — NOT tray_info_idx
  3984. # or cali_idx — so an assignment that only swaps the filament id on an
  3985. # already-loaded slot would not flip the hash, and gating the check on
  3986. # it would miss exactly the confirmation we are after.
  3987. if self._pending_assignments:
  3988. self._check_assignment_verifications()
  3989. @staticmethod
  3990. def _drying_cycle_end(ams_id: int, remaining: int, cycle: dict[str, object]) -> DryingCycleEnd:
  3991. """Build the cycle-end report from the record kept while it ran."""
  3992. target = cycle.get("target")
  3993. target_temp: int | None = None
  3994. target_hours: int | None = None
  3995. if isinstance(target, dict):
  3996. try:
  3997. target_temp = int(target.get("temp") or 0) or None
  3998. target_hours = int(target.get("duration_hours") or 0) or None
  3999. except (TypeError, ValueError):
  4000. target_temp = target_hours = None
  4001. return DryingCycleEnd(
  4002. ams_id=ams_id,
  4003. remaining_minutes=remaining,
  4004. peak_minutes=max(int(cycle.get("peak") or 0), remaining),
  4005. start_seen=bool(cycle.get("start_seen")),
  4006. target_temp=target_temp,
  4007. target_hours=target_hours,
  4008. )
  4009. def _log_drying_cycle_end(
  4010. self,
  4011. ams_id: int,
  4012. remaining: int,
  4013. ams_unit: dict,
  4014. target: dict[str, object] | None,
  4015. ) -> None:
  4016. """Report a finished drying cycle, with the firmware's reason when it was
  4017. cut short (#2770).
  4018. A cycle that reaches its configured duration needs no explanation and
  4019. keeps the one-line "drying complete" it has always had. One that ends
  4020. with most of its countdown left was ended by somebody, and there are
  4021. only two candidates: a stop Bambuddy sent — the print-takes-priority
  4022. stop, or the user's Stop button — which is named as such, or the
  4023. firmware.
  4024. For the firmware case the only account of why lives in fields we already
  4025. parse but have never written down: the ``dry_status`` /
  4026. ``dry_sub_status`` phase from the info hex, the per-unit
  4027. ``dry_sf_reason`` constraint codes, and whatever HMS errors are live at
  4028. that moment. Logging them at INFO puts them in every support bundle by
  4029. default, which is what a report like #2770 needs before its cause can be
  4030. argued about at all.
  4031. The unit's ``temp`` and ``humidity_raw`` at the moment of the end are
  4032. logged for every cycle, early or not, because they are what decides
  4033. whether auto-drying re-arms. Reconstructing them for #2770 meant
  4034. cross-referencing hourly alarm lines against 30-second scheduler debug
  4035. that was switched off at the time; one line here says it outright — a
  4036. cycle ending at 63 degC with the reading still above the threshold is
  4037. the whole shape of the re-arm loop.
  4038. """
  4039. box = f"temp={ams_unit.get('temp')} humidity={ams_humidity_percent(ams_unit)}"
  4040. if ams_id in self._drying_stops_sent:
  4041. self._drying_stops_sent.discard(ams_id)
  4042. logger.info(
  4043. "[%s] AMS %d drying stopped by Bambuddy (dry_time %d → 0, %s)",
  4044. self.serial_number,
  4045. ams_id,
  4046. remaining,
  4047. box,
  4048. )
  4049. return
  4050. if remaining <= _EARLY_DRY_END_MINUTES:
  4051. logger.info(
  4052. "[%s] AMS %d drying complete (dry_time %d → 0, %s)",
  4053. self.serial_number,
  4054. ams_id,
  4055. remaining,
  4056. box,
  4057. )
  4058. return
  4059. requested_minutes: int | None = None
  4060. if target is not None:
  4061. try:
  4062. requested_minutes = int(target.get("duration_hours") or 0) * 60 or None
  4063. except (TypeError, ValueError):
  4064. requested_minutes = None
  4065. logger.info(
  4066. "[%s] AMS %d drying ended early — %d of %s minutes still on the clock. "
  4067. "Bambuddy sent no stop command, so the firmware ended this cycle: "
  4068. "dry_status=%s dry_sub_status=%s dry_sf_reason=%s hms=%s %s",
  4069. self.serial_number,
  4070. ams_id,
  4071. remaining,
  4072. requested_minutes if requested_minutes is not None else "?",
  4073. ams_unit.get("dry_status"),
  4074. ams_unit.get("dry_sub_status"),
  4075. ams_unit.get("dry_sf_reason") or [],
  4076. [e.full_code for e in self.state.hms_errors] or "none",
  4077. box,
  4078. )
  4079. def register_assignment_verification(
  4080. self,
  4081. ams_id: int,
  4082. tray_id: int,
  4083. tray_info_idx: str,
  4084. tray_color: str,
  4085. cali_idx: int | None,
  4086. ) -> None:
  4087. """Record an assignment we just pushed so subsequent AMS telemetry can
  4088. confirm the tray actually accepted it (#2582).
  4089. Called right after ``ams_set_filament_setting`` + ``extrusion_cali_sel``.
  4090. ``tray_info_idx`` is the primary signal — the slicer/printer echoes the
  4091. accepted filament id back in the per-tray push, so a match means the
  4092. setting landed. ``cali_idx`` (when >= 0) is verified as a secondary
  4093. signal so we can specifically flag "filament loaded but K-profile not
  4094. applied", which is the exact symptom the reporter chased via flow-cal.
  4095. A blank ``tray_info_idx`` means we had nothing resolvable to send, so
  4096. there is nothing to verify and no record is stored.
  4097. """
  4098. want_idx = (tray_info_idx or "").strip().upper()
  4099. if not want_idx:
  4100. return
  4101. self._pending_assignments[(ams_id, tray_id)] = {
  4102. "tray_info_idx": want_idx,
  4103. "tray_color": (tray_color or "").strip().upper(),
  4104. "cali_idx": cali_idx,
  4105. "deadline": time.monotonic() + self.ASSIGNMENT_VERIFY_TIMEOUT,
  4106. "last_seen_idx": None,
  4107. }
  4108. def _find_verify_tray(self, ams_id: int, tray_id: int) -> dict | None:
  4109. """Locate the live tray dict for a pending verification.
  4110. External spools (ams_id 255) live in ``vt_tray`` under global ids
  4111. 254/255; regular and HT AMS trays live under ``ams[].tray[]``. HT units
  4112. report a single tray whose id may not equal the logical tray_id, so fall
  4113. back to the sole tray when an id match fails.
  4114. """
  4115. raw = self.state.raw_data or {}
  4116. if ams_id == 255:
  4117. want_ext = external_tray_id(tray_id)
  4118. for vt in raw.get("vt_tray", []) or []:
  4119. if isinstance(vt, dict) and str(vt.get("id")) == str(want_ext):
  4120. return vt
  4121. return None
  4122. for unit in raw.get("ams", []) or []:
  4123. if str(unit.get("id")) != str(ams_id):
  4124. continue
  4125. trays = unit.get("tray", []) or []
  4126. for tray in trays:
  4127. if str(tray.get("id")) == str(tray_id):
  4128. return tray
  4129. if ams_id >= 128 and len(trays) == 1:
  4130. return trays[0]
  4131. return None
  4132. return None
  4133. def _check_assignment_verifications(self) -> None:
  4134. """Compare each pending assignment against live tray telemetry and fire
  4135. ``on_assignment_verified`` on a match or once the deadline passes.
  4136. Runs on every AMS push. Non-matching-but-still-within-window entries are
  4137. left in place for the next push. The timeout branch only fires when a
  4138. later push arrives after the deadline; if the printer goes silent we
  4139. simply never confirm, which is preferable to inventing a failure.
  4140. """
  4141. now = time.monotonic()
  4142. for key, want in list(self._pending_assignments.items()):
  4143. ams_id, tray_id = key
  4144. tray = self._find_verify_tray(ams_id, tray_id)
  4145. actual_idx = str((tray or {}).get("tray_info_idx") or "").strip().upper()
  4146. if tray is not None and actual_idx:
  4147. want["last_seen_idx"] = actual_idx
  4148. if actual_idx and actual_idx == want["tray_info_idx"]:
  4149. self._pending_assignments.pop(key, None)
  4150. kprofile_applied = True
  4151. want_cali = want.get("cali_idx")
  4152. if want_cali is not None and want_cali >= 0:
  4153. actual_cali = tray.get("cali_idx")
  4154. kprofile_applied = actual_cali == want_cali
  4155. self._fire_assignment_verified(
  4156. ams_id,
  4157. tray_id,
  4158. True,
  4159. {
  4160. "tray_info_idx": actual_idx,
  4161. "kprofile_applied": kprofile_applied,
  4162. },
  4163. )
  4164. elif now >= want["deadline"]:
  4165. self._pending_assignments.pop(key, None)
  4166. self._fire_assignment_verified(
  4167. ams_id,
  4168. tray_id,
  4169. False,
  4170. {
  4171. "expected_tray_info_idx": want["tray_info_idx"],
  4172. "actual_tray_info_idx": want.get("last_seen_idx"),
  4173. # True when we saw the tray at least once (so the push
  4174. # channel is alive and the printer really stored a
  4175. # different/blank id) vs never observing it at all.
  4176. "saw_tray": want.get("last_seen_idx") is not None,
  4177. },
  4178. )
  4179. def _fire_assignment_verified(self, ams_id: int, tray_id: int, verified: bool, detail: dict) -> None:
  4180. if verified:
  4181. logger.info(
  4182. "[%s] Assignment verified: AMS%d-T%d now reports %s (kprofile_applied=%s)",
  4183. self.serial_number,
  4184. ams_id,
  4185. tray_id,
  4186. detail.get("tray_info_idx"),
  4187. detail.get("kprofile_applied"),
  4188. )
  4189. else:
  4190. logger.warning(
  4191. "[%s] Assignment NOT confirmed: AMS%d-T%d expected %s, tray shows %s (saw_tray=%s)",
  4192. self.serial_number,
  4193. ams_id,
  4194. tray_id,
  4195. detail.get("expected_tray_info_idx"),
  4196. detail.get("actual_tray_info_idx"),
  4197. detail.get("saw_tray"),
  4198. )
  4199. if self.on_assignment_verified:
  4200. try:
  4201. self.on_assignment_verified(ams_id, tray_id, verified, detail)
  4202. except Exception:
  4203. logger.exception("[%s] on_assignment_verified callback failed", self.serial_number)
  4204. @staticmethod
  4205. def _probe_number(value, fallback: float | None = None) -> float | None:
  4206. """Coerce a telemetry field to a number, or return `fallback`.
  4207. Firmware is inconsistent about whether these arrive as ints or as
  4208. numeric strings, and the probe must never raise on a surprise type.
  4209. """
  4210. try:
  4211. return float(value)
  4212. except (TypeError, ValueError):
  4213. return fallback
  4214. def _probe_end_of_print(self, data: dict) -> None:
  4215. """Log raw end-of-print telemetry for one print at DEBUG (#2547).
  4216. Opens on the first frame that looks like end-of-print (last object
  4217. layer reached, progress at 99+, or no remaining time), then logs each
  4218. frame in which any probed field changed, and closes on the transition
  4219. out of RUNNING. Armed once per print — see the module-level comment on
  4220. ``_END_OF_PRINT_PROBE_FIELDS`` for why this window is the one we can't
  4221. currently see into.
  4222. Read-only with respect to printer state: this is instrumentation, and
  4223. nothing downstream may come to depend on it.
  4224. """
  4225. if not logger.isEnabledFor(logging.DEBUG):
  4226. return
  4227. if not self._eop_probe_open and not (self._eop_probe_armed and self._was_running):
  4228. return
  4229. present = {k: data[k] for k in _END_OF_PRINT_PROBE_FIELDS if k in data}
  4230. if not present:
  4231. return
  4232. if not self._eop_probe_open:
  4233. # Open on any end-of-print signal. Read from the raw frame first so
  4234. # the frame that *carries* the signal is itself captured — state
  4235. # fields are only updated further down this same call.
  4236. frame_layer = data.get("layer_num")
  4237. if self._is_stale_layer(frame_layer):
  4238. frame_layer = None
  4239. layer = self._probe_number(frame_layer, self.state.layer_num) or 0
  4240. total = self._probe_number(data.get("total_layer_num"), self.state.total_layers) or 0
  4241. percent = self._probe_number(data.get("mc_percent"), self.state.progress) or 0
  4242. remaining = self._probe_number(data.get("mc_remaining_time"), self.state.remaining_time)
  4243. at_last_layer = total > 0 and layer >= total
  4244. # `remaining <= 0` is only meaningful once the print has actually
  4245. # progressed — it reads 0 during the pre-print calibration too.
  4246. out_of_time = remaining is not None and remaining <= 0 and percent > 0
  4247. if not (at_last_layer or percent >= 99 or out_of_time):
  4248. return
  4249. self._eop_probe_open = True
  4250. self._eop_probe_frames = 0
  4251. self._eop_probe_last = {}
  4252. logger.debug(
  4253. "[%s] EOP-PROBE open — layer=%s/%s percent=%s remaining=%s",
  4254. self.serial_number,
  4255. layer,
  4256. total,
  4257. percent,
  4258. remaining,
  4259. )
  4260. closing = str(data.get("gcode_state") or "") in _END_OF_PRINT_PROBE_CLOSING_STATES
  4261. changed = {k: v for k, v in present.items() if self._eop_probe_last.get(k, object()) != v}
  4262. self._eop_probe_last.update(present)
  4263. if self._eop_probe_frames >= _END_OF_PRINT_PROBE_MAX_FRAMES and not closing:
  4264. if self._eop_probe_frames == _END_OF_PRINT_PROBE_MAX_FRAMES:
  4265. self._eop_probe_frames += 1
  4266. logger.debug(
  4267. "[%s] EOP-PROBE frame budget (%s) reached — suppressing until FINISH",
  4268. self.serial_number,
  4269. _END_OF_PRINT_PROBE_MAX_FRAMES,
  4270. )
  4271. return
  4272. if changed or closing:
  4273. self._eop_probe_frames += 1
  4274. logger.debug(
  4275. "[%s] EOP-PROBE %s%s: %s",
  4276. self.serial_number,
  4277. self._eop_probe_frames,
  4278. " CLOSE" if closing else "",
  4279. # `changed` on a closing frame can be empty; fall back to the
  4280. # full picture so the last line is always self-contained.
  4281. changed if changed else present,
  4282. )
  4283. if closing:
  4284. self._eop_probe_open = False
  4285. self._eop_probe_armed = False
  4286. self._eop_probe_last = {}
  4287. @property
  4288. def layer_before_new_print(self) -> int:
  4289. """The layer the printer was on when a print start was detected, until
  4290. it reports another (#3317); 0 when none.
  4291. For a print that is resumed rather than new, which a restart while it
  4292. was paused makes look new, that is the layer it is still on (#2984).
  4293. """
  4294. return self._stale_layer_num
  4295. def _is_stale_layer(self, value) -> bool:
  4296. """Whether a frame's `layer_num` is the previous print's last layer (#3317)."""
  4297. if not self._stale_layer_num:
  4298. return False
  4299. try:
  4300. return int(value) == self._stale_layer_num
  4301. except (TypeError, ValueError):
  4302. return False
  4303. def _update_state(self, data: dict):
  4304. """Update printer state from message data."""
  4305. _previous_state = self.state.state
  4306. # #2547: instrumentation only — runs before any state mutation so the
  4307. # frame carrying an end-of-print signal is logged as it arrived.
  4308. try:
  4309. self._probe_end_of_print(data)
  4310. except Exception: # pragma: no cover - a probe must never break ingest
  4311. logger.debug("[%s] EOP-PROBE failed", self.serial_number, exc_info=True)
  4312. # Update state fields
  4313. if "gcode_state" in data:
  4314. self.state.state = data["gcode_state"]
  4315. if "gcode_file" in data:
  4316. self.state.gcode_file = data["gcode_file"]
  4317. self.state.current_print = data["gcode_file"]
  4318. # The answer to a print start the printer refused names the job it
  4319. # refused, not one it runs: read as status, its job id told the start
  4320. # watchdog the file had landed.
  4321. refused_start = (
  4322. data.get("command") == "project_file"
  4323. and data.get("result") is not None
  4324. and str(data["result"]).upper() != "SUCCESS"
  4325. )
  4326. if "subtask_name" in data and not refused_start:
  4327. self.state.subtask_name = data["subtask_name"]
  4328. # Prefer subtask_name as current_print if available
  4329. if data["subtask_name"]:
  4330. self.state.current_print = data["subtask_name"]
  4331. if "subtask_id" in data and not refused_start:
  4332. self.state.subtask_id = data["subtask_id"]
  4333. if "mc_percent" in data:
  4334. # Billing: retain this frame's latest positive value immediately.
  4335. # A display-side abort may be the very next frame (and may omit
  4336. # mc_percent entirely), so retaining only the previous frame can
  4337. # lose the only usable estimate for proportional charging.
  4338. previous_progress = self.state.progress
  4339. new_progress = float(data["mc_percent"])
  4340. if new_progress > 0:
  4341. self._last_valid_progress = new_progress
  4342. self.state.progress = new_progress
  4343. # #2547: strictly-increasing only. The firmware resets progress to 0
  4344. # on cancel and re-reports the same percent on most frames; neither
  4345. # is the print advancing, and both would make the frame bank grab a
  4346. # camera frame for nothing.
  4347. if self.state.progress > previous_progress and self._was_running and self.on_print_progress:
  4348. self.on_print_progress(int(self.state.progress))
  4349. if "mc_remaining_time" in data:
  4350. self.state.remaining_time = int(data["mc_remaining_time"])
  4351. if "mc_print_sub_stage" in data:
  4352. new_sub_stage = int(data["mc_print_sub_stage"])
  4353. if new_sub_stage != self.state.mc_print_sub_stage:
  4354. logger.debug(
  4355. f"[{self.serial_number}] mc_print_sub_stage changed: "
  4356. f"{self.state.mc_print_sub_stage} -> {new_sub_stage}"
  4357. )
  4358. self.state.mc_print_sub_stage = new_sub_stage
  4359. # Positive `total_layer_num` carried by *this* frame, or 0. Read up
  4360. # front because three places below consult it and they run in an order
  4361. # that is not the order they read most naturally in: the layer-advance
  4362. # refresh (#2702) must not fire on a frame that already answers it, the
  4363. # apply step must ignore firmware-reset 0s (#1771), and the new-print
  4364. # reset must not discard a total that belongs to the starting print.
  4365. total_from_this_frame = 0
  4366. if "total_layer_num" in data:
  4367. try:
  4368. total_from_this_frame = max(int(data["total_layer_num"] or 0), 0)
  4369. except (TypeError, ValueError):
  4370. # Must not escape. `_on_message` catches only JSONDecodeError
  4371. # and paho is left at `suppress_exceptions = False`, so an
  4372. # exception raised here is re-raised on the network thread and
  4373. # takes the printer connection down over one unusable field.
  4374. # Treat it as "not reported": the refresh below then recovers
  4375. # the real total from a pushall.
  4376. logger.debug(
  4377. "[%s] ignoring unusable total_layer_num: %r",
  4378. self.serial_number,
  4379. data["total_layer_num"],
  4380. )
  4381. if "layer_num" in data:
  4382. try:
  4383. new_layer = int(data["layer_num"])
  4384. except (TypeError, ValueError):
  4385. # Contained for the same reason as `total_layer_num` above: an
  4386. # exception raised here escapes `_update_state` and paho
  4387. # re-raises it on the network thread. Losing this frame would
  4388. # also lose the print-start and completion detection further
  4389. # down, which is worse than losing a layer number.
  4390. #
  4391. # Held at the last known layer rather than substituted with 0:
  4392. # a fabricated 0 reads as the firmware's cancel reset, which
  4393. # would move `_last_valid_layer_num` and show layer 0 in the UI
  4394. # until the next good frame.
  4395. logger.debug(
  4396. "[%s] ignoring unusable layer_num: %r",
  4397. self.serial_number,
  4398. data["layer_num"],
  4399. )
  4400. new_layer = self.state.layer_num
  4401. if self._is_stale_layer(new_layer):
  4402. logger.debug(
  4403. "[%s] ignoring layer_num %s: last layer of the previous print",
  4404. self.serial_number,
  4405. new_layer,
  4406. )
  4407. new_layer = self.state.layer_num
  4408. elif new_layer > 0:
  4409. # The new print reports a layer of its own; from here on the
  4410. # previous print's value is a layer this print can reach.
  4411. self._stale_layer_num = 0
  4412. old_layer = self.state.layer_num
  4413. # Save last non-zero layer for usage tracking (firmware resets to 0 on cancel)
  4414. if old_layer > 0:
  4415. self._last_valid_layer_num = old_layer
  4416. self.state.layer_num = new_layer
  4417. # Trigger layer change callback if layer increased
  4418. if new_layer > old_layer and self.on_layer_change:
  4419. self.on_layer_change(new_layer)
  4420. # #2702: the print is demonstrably laying down layers but we still
  4421. # have no denominator, so the pushall requested at print start
  4422. # either went unanswered or raced the printer learning the total.
  4423. # Ask once more — by layer 1 the printer definitely knows it.
  4424. # One-shot: an unanswered pushall must not turn into a per-layer
  4425. # retry loop for the rest of the print.
  4426. if (
  4427. new_layer > old_layer
  4428. and self._total_layers_refresh_armed
  4429. and not self.state.total_layers
  4430. and not total_from_this_frame
  4431. ):
  4432. self._total_layers_refresh_armed = False
  4433. logger.debug(
  4434. "[%s] layer %s with no total_layer_num — re-requesting full status",
  4435. self.serial_number,
  4436. new_layer,
  4437. )
  4438. self._request_push_all()
  4439. # #2547: there is deliberately NO finish-photo trigger on the
  4440. # last-layer edge. `layer_num` reaching `total_layer_num` is the
  4441. # moment the printer *starts* the final layer, not the moment it
  4442. # finishes it — on the H2C capture that closed #2547 the edge
  4443. # arrived at 92% with `mc_remaining_time=2`, three minutes and a
  4444. # filament change before the print actually ended, so the photo
  4445. # showed the toolhead mid-print over the part. Worse, the trigger
  4446. # latched `_finish_photo_captured`, locking out both the stage-22
  4447. # and FINISH triggers below for the rest of the print.
  4448. #
  4449. # #1867 (End G-code ejects the plate before FINISH) is handled
  4450. # where it belongs instead: `on_finish_photo_moment` prefers the
  4451. # in-print frame bank when the dispatcher recorded that it injected
  4452. # End G-code into this print. See services/print_dispatch_context.
  4453. if total_from_this_frame:
  4454. # Firmware (P1S observed) resets `total_layer_num` to 0 at print
  4455. # end — same shape as the `layer_num` reset guarded above. Applying
  4456. # only positive values preserves the last known good denominator so
  4457. # the usage-tracker split path (#1771) survives the reset frame.
  4458. self.state.total_layers = total_from_this_frame
  4459. # Fan speeds (MQTT sends as string "0"-"15" representing speed levels, or percentage)
  4460. # Convert to 0-100 percentage for display
  4461. def parse_fan_speed(value: str | int | None) -> int | None:
  4462. if value is None:
  4463. return None
  4464. try:
  4465. speed = int(value)
  4466. # MQTT reports 0-15 speed levels, convert to percentage (0-100)
  4467. # 15 = 100%, so multiply by 100/15 ≈ 6.67
  4468. if speed <= 15:
  4469. return round(speed * 100 / 15)
  4470. # If already a percentage (0-255 scale from some printers), convert
  4471. elif speed <= 255:
  4472. return round(speed * 100 / 255)
  4473. return speed
  4474. except (ValueError, TypeError):
  4475. return None
  4476. # Log fan fields once for debugging
  4477. if not hasattr(self, "_fan_fields_logged"):
  4478. fan_fields = {k: v for k, v in data.items() if "fan" in k.lower()}
  4479. if fan_fields:
  4480. logger.debug("[%s] Fan fields in MQTT data: %s", self.serial_number, fan_fields)
  4481. self._fan_fields_logged = True
  4482. if "cooling_fan_speed" in data:
  4483. self.state.cooling_fan_speed = parse_fan_speed(data["cooling_fan_speed"])
  4484. if "big_fan1_speed" in data:
  4485. self.state.big_fan1_speed = parse_fan_speed(data["big_fan1_speed"])
  4486. if "big_fan2_speed" in data:
  4487. self.state.big_fan2_speed = parse_fan_speed(data["big_fan2_speed"])
  4488. if "heatbreak_fan_speed" in data:
  4489. self.state.heatbreak_fan_speed = parse_fan_speed(data["heatbreak_fan_speed"])
  4490. # Calibration stage tracking
  4491. if "stg_cur" in data:
  4492. new_stg = data["stg_cur"]
  4493. prev_stg = self.state.stg_cur
  4494. # Always log ANY stg_cur change for debugging filament operations
  4495. if new_stg != prev_stg:
  4496. logger.debug(
  4497. f"[{self.serial_number}] stg_cur changed: {prev_stg} -> {new_stg} ({get_stage_name(new_stg)})"
  4498. )
  4499. # A stage we cannot name is the one worth seeing at the default
  4500. # log level: the DEBUG line above is off in normal running, so
  4501. # an unnamed stage otherwise reaches the user as "Unknown stage
  4502. # (72)" on a card with nothing behind it to say when it
  4503. # happened or what the printer was doing. Recorded once per
  4504. # stage number per session, with the stage it came from and the
  4505. # print state, which is what naming it later needs. Guarded on
  4506. # the int type because the field is whatever the firmware sent.
  4507. if (
  4508. isinstance(new_stg, int)
  4509. and not isinstance(new_stg, bool)
  4510. # -1 is Bambuddy's own "not in a stage" sentinel and the
  4511. # initial value of the field, not something the firmware
  4512. # reports; every print would otherwise report it on the way
  4513. # out of its last real stage.
  4514. and new_stg != -1
  4515. and new_stg not in STAGE_NAMES
  4516. and new_stg not in self._unnamed_stages_seen
  4517. ):
  4518. self._unnamed_stages_seen.add(new_stg)
  4519. logger.info(
  4520. "[%s] Unnamed print stage %s on model %s, entered from %s (%s); "
  4521. "state=%s progress=%s%% layer=%s/%s",
  4522. self.serial_number,
  4523. new_stg,
  4524. self.model,
  4525. prev_stg,
  4526. get_stage_name(prev_stg),
  4527. self.state.state,
  4528. self.state.progress,
  4529. self.state.layer_num,
  4530. self.state.total_layers,
  4531. )
  4532. self.state.stg_cur = new_stg
  4533. # #1721 end-of-print finish photo trigger.
  4534. # Stage 22 = "Filament unloading" fires at end-of-print AND
  4535. # during mid-print color swaps. The end-of-print gate
  4536. # (progress>=99 / layer>=total / remaining<=0) disambiguates
  4537. # — those signals only line up at the real end. Edge-only
  4538. # (prev != 22) so the trigger fires once per stage entry.
  4539. if (
  4540. new_stg == 22
  4541. and prev_stg != 22
  4542. and self._was_running
  4543. and not self._finish_photo_captured
  4544. and self.on_finish_photo_moment
  4545. ):
  4546. progress = self.state.progress or 0.0
  4547. layer_num = self.state.layer_num or 0
  4548. total_layers = self.state.total_layers or 0
  4549. remaining = self.state.remaining_time or 0
  4550. is_end_of_print = progress >= 99 or (total_layers > 0 and layer_num >= total_layers) or remaining <= 0
  4551. if is_end_of_print:
  4552. self._finish_photo_captured = True
  4553. logger.info(
  4554. f"[{self.serial_number}] FINISH PHOTO MOMENT (stage-22) — "
  4555. f"progress={progress}, layer={layer_num}/{total_layers}, "
  4556. f"remaining={remaining}min, timelapse_active={self._timelapse_during_print}"
  4557. )
  4558. self.on_finish_photo_moment(
  4559. {
  4560. "trigger": "stage_22",
  4561. "filename": self._previous_gcode_file or self.state.gcode_file,
  4562. "subtask_name": self.state.subtask_name,
  4563. "timelapse_was_active": self._timelapse_during_print,
  4564. }
  4565. )
  4566. if "stg" in data:
  4567. self.state.stg = data["stg"] if isinstance(data["stg"], list) else []
  4568. # Temperature data
  4569. temps = {}
  4570. # Log all fields for debugging dual-nozzle temperature discovery (only once)
  4571. if "bed_temper" in data and not hasattr(self, "_temp_fields_logged"):
  4572. temp_fields = {k: v for k, v in data.items() if "temp" in k.lower() or "chamber" in k.lower()}
  4573. logger.debug("[%s] Temperature-related fields: %s", self.serial_number, temp_fields)
  4574. # Log ALL keys in print data for H2D temperature discovery
  4575. all_keys = sorted(data.keys())
  4576. logger.debug("[%s] ALL print data keys (%s): %s", self.serial_number, len(all_keys), all_keys)
  4577. self._temp_fields_logged = True
  4578. # Log vir_slot data (once) - this may contain per-extruder slot mapping for H2D
  4579. if "vir_slot" in data and not hasattr(self, "_vir_slot_logged"):
  4580. logger.debug("[%s] vir_slot data: %s", self.serial_number, data["vir_slot"])
  4581. self._vir_slot_logged = True
  4582. # Log nozzle hardware info fields (once)
  4583. nozzle_fields = {
  4584. k: v
  4585. for k, v in data.items()
  4586. if "nozzle" in k.lower() or "hw" in k.lower() or "extruder" in k.lower() or "upgrade" in k.lower()
  4587. }
  4588. if nozzle_fields and not hasattr(self, "_nozzle_fields_logged"):
  4589. logger.debug("[%s] Nozzle/hardware fields in MQTT data: %s", self.serial_number, nozzle_fields)
  4590. self._nozzle_fields_logged = True
  4591. # Parse active extruder from device.extruder.state bit 8
  4592. # bit 8 = 0 → RIGHT extruder (active_extruder=0)
  4593. # bit 8 = 1 → LEFT extruder (active_extruder=1)
  4594. if "device" in data and isinstance(data.get("device"), dict):
  4595. device = data["device"]
  4596. # One-shot identification probe: surface whatever the firmware uses to
  4597. # name itself so an unknown model in a support bundle becomes self-
  4598. # diagnosing. INFO level so it shows up without debug logging. Falls
  4599. # back to dumping device.keys() if none of the known fields are present
  4600. # (so a future Bambu rename like `model_name` is still observable).
  4601. if not getattr(self, "_device_id_logged", False):
  4602. id_fields = {
  4603. k: device.get(k)
  4604. for k in ("dev_model_name", "dev_product_name", "dev_id", "project_name")
  4605. if k in device
  4606. }
  4607. if id_fields:
  4608. logger.info("[%s] Device identification: %s", self.serial_number, id_fields)
  4609. else:
  4610. logger.info(
  4611. "[%s] Device identification: no known id fields; device.keys=%s",
  4612. self.serial_number,
  4613. sorted(device.keys()),
  4614. )
  4615. self._device_id_logged = True
  4616. self._parse_extruder_position(data)
  4617. # Log device.extruder structure for active extruder
  4618. if "device" in data and isinstance(data.get("device"), dict):
  4619. device = data["device"]
  4620. if "extruder" in device:
  4621. ext_data = device["extruder"]
  4622. # Log 'state' field - OrcaSlicer uses bits 12-14 for switch state
  4623. if "state" in ext_data:
  4624. state_val = ext_data["state"]
  4625. # Extract bits 12-14 (3 bits) for switch state
  4626. switch_state = (state_val >> 12) & 0x7
  4627. self._debug_on_change(
  4628. "extruder_state",
  4629. state_val,
  4630. "[%s] device.extruder.state=%s (switch_state bits 12-14: %s)",
  4631. self.serial_number,
  4632. state_val,
  4633. switch_state,
  4634. )
  4635. # Log 'cur' field if present (might indicate current/active extruder)
  4636. if "cur" in ext_data:
  4637. logger.debug("[%s] device.extruder.cur: %s", self.serial_number, ext_data["cur"])
  4638. # Also parsed earlier in _process_message, because _handle_ams_data needs
  4639. # it first. Repeated here so _update_state stays a complete "absorb this
  4640. # payload" step for any other caller; re-parsing the same block is free.
  4641. self._parse_fila_switch(data)
  4642. self._parse_extruder_slots(data)
  4643. if "bed_temper" in data:
  4644. temps["bed"] = float(data["bed_temper"])
  4645. if "bed_target_temper" in data:
  4646. temps["bed_target"] = float(data["bed_target_temper"])
  4647. # Check if this is H2D (has device.extruder.info with 2 extruders)
  4648. has_h2d_extruder_info = (
  4649. "device" in data
  4650. and isinstance(data.get("device"), dict)
  4651. and "extruder" in data["device"]
  4652. and isinstance(data["device"]["extruder"].get("info"), list)
  4653. and len(data["device"]["extruder"]["info"]) >= 2
  4654. )
  4655. # Standard nozzle fields: these are for the RIGHT/default nozzle on H2D
  4656. # For H2D, we use these for nozzle_2 (RIGHT), for others use as nozzle (primary)
  4657. # NOTE: On H2D, nozzle_temper seems to mirror left nozzle - we override with extruder_info[0] later
  4658. if "nozzle_temper" in data:
  4659. if has_h2d_extruder_info:
  4660. temps["nozzle_2"] = float(data["nozzle_temper"]) # Will be overridden by extruder_info[0]
  4661. else:
  4662. temps["nozzle"] = float(data["nozzle_temper"])
  4663. if "nozzle_target_temper" in data:
  4664. if has_h2d_extruder_info:
  4665. temps["nozzle_2_target"] = float(data["nozzle_target_temper"]) # RIGHT target on H2D
  4666. else:
  4667. temps["nozzle_target"] = float(data["nozzle_target_temper"])
  4668. # Second nozzle for dual-extruder printers - skip for H2D (uses device.extruder.info instead)
  4669. if not has_h2d_extruder_info:
  4670. # Try multiple possible field names used by different firmware versions
  4671. if "nozzle_temper_2" in data:
  4672. val = float(data["nozzle_temper_2"])
  4673. if -50 < val < 500: # Valid temp range
  4674. temps["nozzle_2"] = val
  4675. else:
  4676. logger.debug("[%s] nozzle_temper_2=%s out of range", self.serial_number, val)
  4677. elif "right_nozzle_temper" in data:
  4678. val = float(data["right_nozzle_temper"])
  4679. if -50 < val < 500: # Valid temp range
  4680. temps["nozzle_2"] = val
  4681. else:
  4682. logger.debug("[%s] right_nozzle_temper=%s out of range", self.serial_number, val)
  4683. if "nozzle_target_temper_2" in data:
  4684. val = float(data["nozzle_target_temper_2"])
  4685. if 0 <= val < 500: # Valid temp range
  4686. temps["nozzle_2_target"] = val
  4687. else:
  4688. logger.debug("[%s] nozzle_target_temper_2=%s out of range", self.serial_number, val)
  4689. elif "right_nozzle_target_temper" in data:
  4690. val = float(data["right_nozzle_target_temper"])
  4691. if 0 <= val < 500: # Valid temp range
  4692. temps["nozzle_2_target"] = val
  4693. else:
  4694. logger.debug("[%s] right_nozzle_target_temper=%s out of range", self.serial_number, val)
  4695. # Also check for left nozzle as primary (some H2 models)
  4696. if "left_nozzle_temper" in data and "nozzle" not in temps:
  4697. temps["nozzle"] = float(data["left_nozzle_temper"])
  4698. if "left_nozzle_target_temper" in data and "nozzle_target" not in temps:
  4699. temps["nozzle_target"] = float(data["left_nozzle_target_temper"])
  4700. if "chamber_temper" in data:
  4701. chamber_val = float(data["chamber_temper"])
  4702. logger.debug("[%s] chamber_temper raw value: %s", self.serial_number, chamber_val)
  4703. # Check if we recently set the target locally (within 5 seconds)
  4704. local_set_time = self.state.temperatures.get("_chamber_target_set_time", 0)
  4705. respect_local = (time.time() - local_set_time) < 5.0
  4706. # H2D protocol: chamber_temper encoding indicates heater state
  4707. # - When > 500: encoded as (target * 65536 + current) - heater is ON
  4708. # - When < 500: direct Celsius current temp only - heater is OFF
  4709. if -50 < chamber_val < 100:
  4710. # Direct value = heater is OFF
  4711. temps["chamber"] = chamber_val
  4712. if not respect_local:
  4713. temps["chamber_target"] = 0.0 # Heater off means target = 0
  4714. logger.debug("[%s] chamber_temper direct value: %s°C (heater OFF)", self.serial_number, chamber_val)
  4715. else:
  4716. logger.debug("[%s] chamber_temper %s out of direct range", self.serial_number, chamber_val)
  4717. # Try to decode if it looks like an encoded value
  4718. if chamber_val > 500:
  4719. mqtt_target = int(chamber_val) // 65536
  4720. current = int(chamber_val) % 65536
  4721. logger.debug(
  4722. f"[{self.serial_number}] chamber_temper decoded: mqtt_target={mqtt_target}, current={current}, respect_local={respect_local}"
  4723. )
  4724. if -50 < current < 100:
  4725. temps["chamber"] = float(current)
  4726. # Store decoded target for later use, but DON'T set chamber_heating here!
  4727. # Heating state will be calculated later after parsing ctc.info.target (explicit target)
  4728. # which is the authoritative source the slicer uses.
  4729. if not respect_local:
  4730. if 0 <= mqtt_target <= 60:
  4731. # Store as "decoded" target - may be overridden by explicit target fields
  4732. temps["_chamber_decoded_target"] = float(mqtt_target)
  4733. # Chamber target temperature (set by print file or display)
  4734. if "mc_target_cham" in data:
  4735. mc_target = float(data["mc_target_cham"])
  4736. logger.debug("[%s] mc_target_cham raw value: %s", self.serial_number, mc_target)
  4737. # Filter out encoded/invalid values - valid chamber target is 0-60°C
  4738. if 0 <= mc_target <= 60:
  4739. temps["chamber_target"] = mc_target
  4740. # H2D series: Chamber temp is in info.temp (may be encoded or direct °C)
  4741. # NOTE: Don't set chamber_heating here - let ctc.info.target or fallback logic handle it
  4742. # The encoded target in info.temp may be stale (slicer uses ctc.info.target as source of truth)
  4743. try:
  4744. if "info" in data and isinstance(data["info"], dict):
  4745. info_temp = data["info"].get("temp")
  4746. if info_temp is not None and "chamber" not in temps:
  4747. # Check for encoded value (target * 65536 + current)
  4748. if info_temp > 500:
  4749. # Decode: extract current temperature and target
  4750. target = info_temp // 65536
  4751. current = info_temp % 65536
  4752. temps["chamber"] = float(current)
  4753. # Store decoded target as fallback (may be overridden by ctc.info.target)
  4754. if "_chamber_decoded_target" not in temps:
  4755. temps["_chamber_decoded_target"] = float(target)
  4756. logger.debug(
  4757. f"[{self.serial_number}] info.temp encoded: {info_temp} -> current={current}, decoded_target={target}"
  4758. )
  4759. elif -50 < info_temp < 100:
  4760. # Valid direct temperature - heater is OFF
  4761. temps["chamber"] = float(info_temp)
  4762. temps["chamber_target"] = 0.0 # Direct value means heater off
  4763. self._debug_on_change(
  4764. "info_temp_direct",
  4765. info_temp,
  4766. "[%s] info.temp direct: %s°C (heater OFF)",
  4767. self.serial_number,
  4768. info_temp,
  4769. )
  4770. # H2D series: Dual extruder temps are in device.extruder.info array
  4771. # Temperature values are encoded as fixed-point (value / 65536 = °C)
  4772. if "device" in data and isinstance(data["device"], dict):
  4773. device = data["device"]
  4774. # Parse dual extruder temperatures
  4775. extruder_data = device.get("extruder", {})
  4776. extruder_info = extruder_data.get("info", [])
  4777. if isinstance(extruder_info, list) and len(extruder_info) >= 1:
  4778. # H2D nozzle mapping: id=0 is RIGHT nozzle (default), id=1 is LEFT nozzle
  4779. # Only parse dual nozzle temps if this is actually a dual nozzle printer (H2D)
  4780. # has_h2d_extruder_info requires len(extruder_info) >= 2
  4781. if has_h2d_extruder_info:
  4782. # Right nozzle (extruder 0) - use extruder_info for actual temp, not nozzle_temper
  4783. # nozzle_temper field seems to mirror left nozzle on H2D, so use extruder_info[0]
  4784. if "temp" in extruder_info[0]:
  4785. temp_val = extruder_info[0]["temp"]
  4786. if temp_val > 500:
  4787. # Encoded format: temp = target * 65536 + current
  4788. target = temp_val // 65536
  4789. current = temp_val % 65536
  4790. if -50 < current < 500:
  4791. temps["nozzle_2"] = float(current)
  4792. if 0 < target < 500:
  4793. temps["nozzle_2_target"] = float(target)
  4794. temps["nozzle_2_heating"] = target > 0 and current < target
  4795. elif -50 < temp_val < 500:
  4796. # Direct Celsius value = heater is OFF
  4797. temps["nozzle_2"] = float(temp_val)
  4798. temps["nozzle_2_target"] = 0.0
  4799. temps["nozzle_2_heating"] = False
  4800. # Left nozzle (extruder 1) - only for dual nozzle printers
  4801. # H2D protocol: temp field encoding depends on value
  4802. # - When > 500: encoded as (target * 65536 + current) - heater is ON
  4803. # - When < 500: direct Celsius current temp only - heater is OFF
  4804. if len(extruder_info) >= 2 and "temp" in extruder_info[1]:
  4805. ext1 = extruder_info[1]
  4806. temp_val = ext1["temp"]
  4807. # Check if we recently set the target locally (within 5 seconds)
  4808. # If so, don't let MQTT data overwrite it
  4809. local_set_time = self.state.temperatures.get("_nozzle_target_set_time", 0)
  4810. respect_local_target = (time.time() - local_set_time) < 5.0
  4811. if temp_val > 500:
  4812. # Encoded format: temp = target * 65536 + current
  4813. target = temp_val // 65536
  4814. current = temp_val % 65536
  4815. if 0 < target < 500 and not respect_local_target:
  4816. temps["nozzle_target"] = float(target)
  4817. if -50 < current < 500:
  4818. temps["nozzle"] = float(current)
  4819. # Heating = encoded AND we're using the MQTT target (not local override)
  4820. # If local target is being respected, use local target to determine heating
  4821. if respect_local_target:
  4822. local_target = self.state.temperatures.get("nozzle_target", 0)
  4823. temps["nozzle_heating"] = local_target > 0 and current < local_target
  4824. else:
  4825. temps["nozzle_heating"] = target > 0 and current < target
  4826. elif -50 < temp_val < 500:
  4827. # Direct Celsius = heater is OFF (or at target with heater off)
  4828. temps["nozzle"] = float(temp_val)
  4829. if not respect_local_target:
  4830. temps["nozzle_target"] = 0.0
  4831. temps["nozzle_heating"] = False # Direct = not heating
  4832. # The extruder snow is read by _parse_extruder_position, before the
  4833. # AMS block of the same frame (tray_now resolution needs it first).
  4834. # Parse bed heating state from device.bed.info.temp encoding
  4835. # temp > 500 means encoded (target*65536+current), heating = target > 0 AND current < target
  4836. bed_data = device.get("bed", {})
  4837. bed_info = bed_data.get("info", {})
  4838. if "temp" in bed_info:
  4839. temp_val = bed_info["temp"]
  4840. if temp_val > 500:
  4841. target = temp_val // 65536
  4842. current = temp_val % 65536
  4843. temps["bed_heating"] = target > 0 and current < target
  4844. else:
  4845. temps["bed_heating"] = False
  4846. # Parse chamber temp from device.ctc.info.temp if not already set
  4847. ctc_data = device.get("ctc", {})
  4848. ctc_info = ctc_data.get("info", {})
  4849. # Parse airduct mode (0=cooling, 1=heating)
  4850. airduct_data = device.get("airduct", {})
  4851. if "modeCur" in airduct_data:
  4852. new_mode = airduct_data["modeCur"]
  4853. if new_mode != self.state.airduct_mode:
  4854. logger.debug(
  4855. f"[{self.serial_number}] airduct_mode changed: {self.state.airduct_mode} -> {new_mode}"
  4856. )
  4857. self.state.airduct_mode = new_mode
  4858. # Parse individual airduct fan parts (new-protocol models: P2S/X2D/H2*).
  4859. # Raw part ids are bit-packed — decoded id = raw_id >> 4 (bits 4-11),
  4860. # mirroring Bambu Studio DevFan::ParseV3_0. Decoded ids follow the
  4861. # AIR_FUN enum: 1=part cooling, 2=aux, 3=chamber/exhaust,
  4862. # 10=second aux (FAN_REMOTE_COOLING_1). Aux 2 is the right fan and
  4863. # 10 the left on the P2S, the other way round on the X2D (#3373;
  4864. # Bambu Studio's N7.json / N6.json). The airduct `parts` list only
  4865. # contains the fans that physically exist, so it doubles as a
  4866. # presence signal for the two P2S/X2D add-on kits:
  4867. # - id 10 (second auxiliary part cooling fan) — reported ONLY here,
  4868. # never mirrored into a flat big_fanX_speed field.
  4869. # - id 3 (chamber exhaust fan) — its speed is mirrored into
  4870. # big_fan2_speed, but the part is only listed when the External
  4871. # Exhaust Fan kit (get_version module "eef") is installed.
  4872. # `state` is already a 0-100 percentage.
  4873. parts = airduct_data.get("parts")
  4874. if isinstance(parts, list):
  4875. speeds: dict[int, int] = {}
  4876. for part in parts:
  4877. if not isinstance(part, dict):
  4878. continue
  4879. try:
  4880. # Studio reads the id with get_flag_bits(id, 4, 8),
  4881. # so mask after shifting for the same reason `state`
  4882. # is masked below. Every id seen in the wild
  4883. # (16/32/48/160) decodes identically either way —
  4884. # this is consistency, not a live bug.
  4885. part_id = (int(part["id"]) >> 4) & 0xFF
  4886. # `state` is bit-packed like its sibling `range`
  4887. # (end << 16 | start), so take only the low 8 bits —
  4888. # the same decode Bambu Studio does with
  4889. # get_flag_bits(state, 0, 8). Without the mask a
  4890. # packed value would clamp to 100 instead of
  4891. # decoding to the real percentage.
  4892. part_state = int(part["state"]) & 0xFF
  4893. except (KeyError, ValueError, TypeError):
  4894. continue
  4895. # Ids seen across the support-package archive:
  4896. # 1 part cooling, 2 aux, 3 chamber/exhaust,
  4897. # 6 (H2 series, unmapped), 10 second aux.
  4898. speeds[part_id] = max(0, min(100, part_state))
  4899. # Absence in this list is what tells us a kit is NOT fitted,
  4900. # so it may only be trusted when the list is a full
  4901. # inventory rather than a diff frame. `device.airduct` is
  4902. # pushed field by field — the `modeCur` handler above exists
  4903. # for exactly that reason — and a truncated `parts` read as
  4904. # gospel would retract both accessory badges mid-print and
  4905. # start rejecting `aux2` on a printer that has the fan.
  4906. #
  4907. # Every airduct layout in the support-package archive
  4908. # (P2S base 1,2 / P2S+kit 1,2,3 / X2D 1,2,3,10 /
  4909. # H2C,H2D,H2S 1,2,3,6 — 37 of 37 bundles) contains both the
  4910. # part cooling fan and the aux fan, neither of which is
  4911. # optional on any machine that reports an airduct at all.
  4912. # A list carrying both is therefore a complete inventory; a
  4913. # list missing either is a partial frame, and we take its
  4914. # speeds without touching presence.
  4915. is_full_inventory = 1 in speeds and 2 in speeds
  4916. left_aux_speed = speeds.get(10)
  4917. if left_aux_speed is None and not is_full_inventory:
  4918. # Partial frame that didn't mention the second aux fan —
  4919. # keep whatever we already knew about it.
  4920. left_aux_speed = self.state.left_aux_fan_speed
  4921. if left_aux_speed != self.state.left_aux_fan_speed:
  4922. logger.debug(
  4923. f"[{self.serial_number}] left_aux_fan_speed changed: "
  4924. f"{self.state.left_aux_fan_speed} -> {left_aux_speed}"
  4925. )
  4926. # A FULL parts list without id 10 means the second aux fan is
  4927. # not installed — report None so the UI can hide the widget.
  4928. self.state.left_aux_fan_speed = left_aux_speed
  4929. # id 3 present == chamber exhaust fan installed (base P2S
  4930. # omits it). Only ever retracted on a full inventory.
  4931. if 3 in speeds:
  4932. self.state.exhaust_fan_present = True
  4933. elif is_full_inventory:
  4934. self.state.exhaust_fan_present = False
  4935. # Parse chamber temp - may be encoded as (target*65536+current) when > 500
  4936. # Check if we recently set the target locally (within 5 seconds)
  4937. local_set_time = self.state.temperatures.get("_chamber_target_set_time", 0)
  4938. respect_local_target = (time.time() - local_set_time) < 5.0
  4939. # Log ctc_info contents for debugging
  4940. if ctc_info:
  4941. self._debug_on_change(
  4942. "ctc_info_keys",
  4943. tuple(ctc_info.keys()),
  4944. "[%s] ctc_info keys: %s",
  4945. self.serial_number,
  4946. list(ctc_info.keys()),
  4947. )
  4948. # FIRST: Parse explicit ctc.info.target if available - this is the authoritative target
  4949. # (what the slicer shows). This OVERRIDES any previously decoded target.
  4950. explicit_target = None
  4951. if "target" in ctc_info:
  4952. target_val = ctc_info["target"]
  4953. logger.debug(
  4954. f"[{self.serial_number}] ctc_info.target explicit value: {target_val}, respect_local={respect_local_target}"
  4955. )
  4956. # Filter out invalid values (valid chamber target is 0-60°C)
  4957. if 0 <= target_val <= 60 and not respect_local_target:
  4958. explicit_target = float(target_val)
  4959. temps["chamber_target"] = explicit_target # Override any previous value
  4960. logger.debug(
  4961. f"[{self.serial_number}] Setting chamber_target from ctc_info.target: {explicit_target}"
  4962. )
  4963. # Parse chamber temp from ctc.info.temp - may be encoded
  4964. if "temp" in ctc_info and "chamber" not in temps:
  4965. temp_val = ctc_info["temp"]
  4966. logger.debug("[%s] ctc_info.temp raw value: %s", self.serial_number, temp_val)
  4967. if temp_val > 500:
  4968. # Encoded value: decode target and current
  4969. decoded_target = temp_val // 65536
  4970. current = temp_val % 65536
  4971. temps["chamber"] = float(current)
  4972. logger.debug(
  4973. f"[{self.serial_number}] ctc_info.temp decoded: target={decoded_target}, current={current}, explicit_target={explicit_target}"
  4974. )
  4975. # Determine which target to use for heating state:
  4976. # Priority: local target > explicit target > decoded target
  4977. if respect_local_target:
  4978. local_target = self.state.temperatures.get("chamber_target", 0)
  4979. temps["chamber_heating"] = local_target > 0 and current < local_target
  4980. elif explicit_target is not None:
  4981. # Use explicit ctc.info.target - this is what slicer sees
  4982. temps["chamber_heating"] = explicit_target > 0 and current < explicit_target
  4983. else:
  4984. # Fallback to decoded target only if no explicit target available
  4985. if not respect_local_target and "chamber_target" not in temps:
  4986. temps["chamber_target"] = float(decoded_target)
  4987. temps["chamber_heating"] = decoded_target > 0 and current < decoded_target
  4988. else:
  4989. # Direct value (not encoded) - heater is OFF
  4990. temps["chamber"] = float(temp_val)
  4991. temps["chamber_heating"] = False
  4992. except Exception as e:
  4993. logger.warning("[%s] Error parsing H2D temperatures: %s", self.serial_number, e)
  4994. if temps:
  4995. # Handle chamber_target: prefer explicit over decoded
  4996. if "_chamber_decoded_target" in temps and "chamber_target" not in temps:
  4997. # No explicit target available, use decoded target from chamber_temper
  4998. temps["chamber_target"] = temps["_chamber_decoded_target"]
  4999. # Remove internal temp key before merging
  5000. temps.pop("_chamber_decoded_target", None)
  5001. # Merge new temps into existing, preserving valid values when new ones are filtered out
  5002. for key, value in temps.items():
  5003. self.state.temperatures[key] = value
  5004. # Notify bed temperature updates (used by event-driven bed cooldown monitor)
  5005. if "bed" in temps and self.on_bed_temp_update:
  5006. self.on_bed_temp_update(temps["bed"])
  5007. # Calculate chamber_heating after all targets are known
  5008. # Priority: local target (if recent) > explicit target (chamber_target) > 0
  5009. if "chamber" in temps and "chamber_heating" not in temps:
  5010. current = self.state.temperatures.get("chamber", 0)
  5011. local_set_time = self.state.temperatures.get("_chamber_target_set_time", 0)
  5012. respect_local = (time.time() - local_set_time) < 5.0
  5013. if respect_local:
  5014. # Use locally-set target
  5015. target = self.state.temperatures.get("chamber_target", 0)
  5016. else:
  5017. # Use explicit/decoded target from MQTT
  5018. target = self.state.temperatures.get("chamber_target", 0)
  5019. self.state.temperatures["chamber_heating"] = target > 0 and current < target
  5020. self._debug_on_change(
  5021. "chamber_heating",
  5022. (target, current, self.state.temperatures["chamber_heating"], respect_local),
  5023. "[%s] Chamber heating calculated: target=%s, current=%s, heating=%s, respect_local=%s",
  5024. self.serial_number,
  5025. target,
  5026. current,
  5027. self.state.temperatures["chamber_heating"],
  5028. respect_local,
  5029. )
  5030. # Debug: log chamber value if it was updated
  5031. if "chamber" in temps:
  5032. self._debug_on_change(
  5033. "chamber_temp",
  5034. (
  5035. self.state.temperatures.get("chamber"),
  5036. self.state.temperatures.get("chamber_target"),
  5037. self.state.temperatures.get("chamber_heating"),
  5038. ),
  5039. "[%s] Chamber temp updated to: %s, target: %s, heating: %s",
  5040. self.serial_number,
  5041. self.state.temperatures.get("chamber"),
  5042. self.state.temperatures.get("chamber_target"),
  5043. self.state.temperatures.get("chamber_heating"),
  5044. )
  5045. # Calculate nozzle_heating for single nozzle printers (not set by H2D parsing)
  5046. # For H2D, nozzle_heating is set in temps dict; for single nozzle, calculate here
  5047. if "nozzle" in temps and "nozzle_heating" not in temps:
  5048. current = self.state.temperatures.get("nozzle", 0)
  5049. target = self.state.temperatures.get("nozzle_target", 0)
  5050. self.state.temperatures["nozzle_heating"] = target > 0 and current < target
  5051. # Parse HMS (Health Management System) errors
  5052. if "hms" in data:
  5053. hms_list = data["hms"]
  5054. logger.debug("[%s] HMS data received: %s", self.serial_number, hms_list)
  5055. # A `print_error` fault is not in `hms[]` and its field only comes
  5056. # when it changes, so a list rebuilt from `hms[]` keeps it (#3487).
  5057. print_error_entries = [e for e in self.state.hms_errors if _is_print_error_entry(e)]
  5058. self.state.hms_errors = []
  5059. verify_failed = False
  5060. if isinstance(hms_list, list):
  5061. for hms in hms_list:
  5062. if isinstance(hms, dict):
  5063. # HMS format: {"attr": attribute_code, "code": error_code}
  5064. # attr contains module/severity info, code contains error number
  5065. # Both are needed to construct the wiki URL
  5066. attr = hms.get("attr", 0)
  5067. code = hms.get("code", 0)
  5068. if isinstance(attr, str):
  5069. attr = int(attr.replace("0x", ""), 16) if attr else 0
  5070. if isinstance(code, str):
  5071. code = int(code.replace("0x", ""), 16) if code else 0
  5072. # attr is module, module no., part, part no. (a byte each);
  5073. # code is the alert level (high 16 bits) then the error
  5074. # (low 16). The level is 1 error (task stopped), 2 warning
  5075. # (task paused), 3 notification; 0 is invalid. This is how
  5076. # Bambu Studio decodes it (DevHMSItem::parse_hms_info). It
  5077. # used to be read from attr bits 8-15, which is the part
  5078. # byte (#2728).
  5079. severity = (code >> 16) & 0xFFFF
  5080. # Module is in attr byte 3 (bits 24-31)
  5081. module = (attr >> 24) & 0xFF
  5082. # Skip non-error status codes. A real fault has a level of
  5083. # at least 1 in the high half, so its code is >= 0x10000
  5084. # and clears this; lower values are status/phase
  5085. # indicators some firmware sends during normal printing.
  5086. if code < 0x4000:
  5087. continue
  5088. # Skip user-action echoes — the printer firmware emits these
  5089. # as part of normal user-cancel sequences. They're not faults
  5090. # and shouldn't count toward "X problem" badges or surface as
  5091. # red pips on the printer card. Backend's notification path
  5092. # already suppresses 0500_400E for the same reason.
  5093. short_code = f"{(attr >> 16) & 0xFFFF:04X}_{code & 0xFFFF:04X}"
  5094. if short_code in _HMS_USER_ACTION_CODES:
  5095. continue
  5096. # The full 16-char identifier is the firmware's matching key
  5097. # and the HMS catalogue's key for this kind of fault; the
  5098. # short code discards the part and alert-level groups. The
  5099. # action table still has some short-form entries, so that
  5100. # lookup falls back to it.
  5101. full_code = f"{attr:08X}{code:08X}"
  5102. if full_code == HMS_MQTT_VERIFY_FAILED:
  5103. verify_failed = True
  5104. actions = get_actions_for_error_code(self.serial_number[:3], full_code)
  5105. if not actions:
  5106. actions = get_actions_for_error_code(self.serial_number[:3], short_code.replace("_", ""))
  5107. self.state.hms_errors.append(
  5108. HMSError(
  5109. code=f"0x{code:x}" if code else "0x0",
  5110. attr=attr,
  5111. module=module,
  5112. # No fallback: 0 is Bambu's "invalid" level, and
  5113. # promoting it would render it as a fault.
  5114. severity=severity,
  5115. actions=actions,
  5116. job_id=self.state.subtask_id,
  5117. full_code=full_code,
  5118. description=describe_fault(full_code, self.serial_number[:3]),
  5119. )
  5120. )
  5121. hms_short_codes = _hms_short_codes(self.state.hms_errors)
  5122. self.state.hms_errors.extend(e for e in print_error_entries if _hms_short_code(e) not in hms_short_codes)
  5123. self._apply_mqtt_verify_state(verify_failed)
  5124. # Parse print_error - this is a different error format than HMS
  5125. # print_error is a 32-bit integer where:
  5126. # - High 16 bits contain module info (e.g., 0x0500)
  5127. # - Low 16 bits contain error code (e.g., 0x8061)
  5128. # Format on printer screen: [0500-8061] -> short code: 0500_8061
  5129. if "print_error" in data:
  5130. print_error = data["print_error"]
  5131. # The field holds the one current fault, and 0 once it is resolved,
  5132. # for example when the filament-load prompt is answered on the
  5133. # printer. The entry of a code that is no longer reported goes
  5134. # (#3487); the entry of the same code is kept as it is.
  5135. self.state.hms_errors = [
  5136. e for e in self.state.hms_errors if not _is_print_error_entry(e) or e.attr == print_error
  5137. ]
  5138. if print_error and print_error != 0:
  5139. # Extract components: MMMMEEEE -> MMMM_EEEE
  5140. module = (print_error >> 16) & 0xFFFF # High 16 bits (e.g., 0x0500)
  5141. error = print_error & 0xFFFF # Low 16 bits (e.g., 0x8061)
  5142. # Values below 0x4000 are status/phase indicators, not real errors.
  5143. # All known HMS errors use 0x4xxx (fatal), 0x8xxx (warning), 0xCxxx (prompt).
  5144. # Some firmware sends low values like 0x0002 during normal printing.
  5145. if error < 0x4000:
  5146. pass # Skip — not a real error
  5147. else:
  5148. # Store in a format that matches the community error database
  5149. # attr stores the full 32-bit value for reconstruction
  5150. # code stores the short format string for lookup
  5151. short_code = f"{module:04X}_{error:04X}"
  5152. logger.debug(
  5153. f"[{self.serial_number}] print_error: {print_error} (0x{print_error:08x}) -> short_code={short_code}"
  5154. )
  5155. # Same user-action filter as the hms[] branch above — print_error
  5156. # carries the same cancel echoes (e.g. 0500_400E) and they must
  5157. # not surface as faults on the printer card.
  5158. if short_code in _HMS_USER_ACTION_CODES:
  5159. pass # cancel echo — silently drop
  5160. else:
  5161. # Only add if not already in HMS errors (avoid duplicates)
  5162. if short_code not in _hms_short_codes(self.state.hms_errors):
  5163. # Bambu's HMS catalog keys by 3-letter device code (the SN
  5164. # prefix) and a 16-char short error code without the
  5165. # underscore separator we store internally.
  5166. actions = get_actions_for_error_code(self.serial_number[:3], short_code.replace("_", ""))
  5167. # Bambu pushes the current job as `subtask_id` on the
  5168. # state stream; the HMS-action commands echo it back as
  5169. # `job_id`. The error payload itself doesn't carry the
  5170. # id, so snapshot it from the live state at parse time
  5171. # and freeze it on the HMSError so subsequent
  5172. # job changes don't invalidate the action.
  5173. job_id = self.state.subtask_id
  5174. logger.debug(
  5175. "[%s, %s] HMS available actions: %s (job_id=%s)",
  5176. self.serial_number[:3],
  5177. short_code.replace("_", ""),
  5178. actions,
  5179. job_id,
  5180. )
  5181. self.state.hms_errors.append(
  5182. HMSError(
  5183. code=f"0x{error:x}",
  5184. attr=print_error, # Store full value for display
  5185. module=module >> 8, # High byte of module (e.g., 0x05)
  5186. # print_error has no level field; its error
  5187. # number's first digit carries it instead.
  5188. severity=alert_level_from_print_error(error),
  5189. actions=actions,
  5190. job_id=job_id,
  5191. # print_error is already 32-bit — `f"{print_error:08X}"`
  5192. # is the firmware's matching key with no truncation.
  5193. full_code=f"{print_error:08X}",
  5194. description=describe_fault(f"{print_error:08X}", self.serial_number[:3]),
  5195. )
  5196. )
  5197. # Parse home_flag first so SD-card detection below can prefer it.
  5198. # Bit 8 = HAS_SDCARD_NORMAL, bit 9 = HAS_SDCARD_ABNORMAL, bit 11 = store-to-SD,
  5199. # bit 23 = door-open (X1 family only).
  5200. home_flag = None
  5201. if "home_flag" in data:
  5202. home_flag = data["home_flag"]
  5203. if home_flag < 0:
  5204. home_flag = home_flag & 0xFFFFFFFF
  5205. # SD card presence: the only remaining consumer is the firmware-update
  5206. # precondition check (firmware_update.py). Use the top-level `sdcard`
  5207. # field when present with a permissive truthy check covering the
  5208. # bool/int/"HAS_SDCARD_NORMAL" variants real firmware emits. We do NOT
  5209. # derive this from home_flag — heartbeat pushes clear bits 8-9 even
  5210. # when a card is inserted, which caused the badge to flap before the
  5211. # badge was removed entirely.
  5212. if "sdcard" in data:
  5213. raw_sdcard = data["sdcard"]
  5214. if isinstance(raw_sdcard, str):
  5215. self.state.sdcard = "HAS_SDCARD" in raw_sdcard.upper() or raw_sdcard.lower() in ("true", "normal", "1")
  5216. else:
  5217. self.state.sdcard = bool(raw_sdcard)
  5218. self.state.sdcard_reported = True
  5219. if home_flag is not None:
  5220. store_to_sdcard = bool((home_flag >> 11) & 1)
  5221. if store_to_sdcard != self.state.store_to_sdcard:
  5222. logger.debug(
  5223. f"[{self.serial_number}] store_to_sdcard changed: {self.state.store_to_sdcard} -> {store_to_sdcard}"
  5224. )
  5225. self.state.store_to_sdcard = store_to_sdcard
  5226. # Door open detection — source depends on printer family:
  5227. # X1 series (X1, X1C, X1E): home_flag bit 23
  5228. # All others (P1/P2/H2/A1/N-series): top-level `stat` field (hex string), bit 23
  5229. # Both share the same bitmask (0x00800000) but live in different fields.
  5230. model_upper = (self.model or "").upper().strip()
  5231. is_x1_family = model_upper in ("X1", "X1C", "X1E")
  5232. if is_x1_family and home_flag is not None:
  5233. door_open = (home_flag & 0x00800000) != 0
  5234. if door_open != self.state.door_open:
  5235. logger.debug(
  5236. "[%s] door_open changed: %s -> %s (home_flag=0x%08X)",
  5237. self.serial_number,
  5238. self.state.door_open,
  5239. door_open,
  5240. home_flag,
  5241. )
  5242. self.state.door_open = door_open
  5243. elif not is_x1_family and "stat" in data:
  5244. try:
  5245. stat_value = int(data["stat"], 16) if isinstance(data["stat"], str) else int(data["stat"])
  5246. door_open = (stat_value & 0x00800000) != 0
  5247. if door_open != self.state.door_open:
  5248. logger.debug(
  5249. "[%s] door_open changed: %s -> %s (stat=0x%08X)",
  5250. self.serial_number,
  5251. self.state.door_open,
  5252. door_open,
  5253. stat_value,
  5254. )
  5255. self.state.door_open = door_open
  5256. except (ValueError, TypeError):
  5257. logger.debug("[%s] could not parse stat field: %r", self.serial_number, data["stat"])
  5258. # Parse timelapse status (recording active during print). Status frames
  5259. # only — the project_file ack echoes back the per-job timelapse flag we
  5260. # asked for, which is a request, not the recorder's state (#3040).
  5261. if "timelapse" in data and is_printer_status_frame(data):
  5262. logger.debug("[%s] timelapse field: %s", self.serial_number, data["timelapse"])
  5263. self.state.timelapse = data["timelapse"] is True
  5264. # Track if timelapse was ever active during this print
  5265. if self.state.timelapse and self._was_running:
  5266. self._timelapse_during_print = True
  5267. # Parse ipcam/live view status
  5268. if "ipcam" in data:
  5269. ipcam_data = data["ipcam"]
  5270. self._debug_on_change("ipcam", ipcam_data, "[%s] ipcam field: %s", self.serial_number, ipcam_data)
  5271. if isinstance(ipcam_data, dict):
  5272. # Check ipcam_record field for live view status
  5273. self.state.ipcam = ipcam_data.get("ipcam_record") == "enable"
  5274. # Check timelapse field (H2D sends it here, not in xcam)
  5275. if "timelapse" in ipcam_data:
  5276. timelapse_enabled = ipcam_data.get("timelapse") == "enable"
  5277. if timelapse_enabled != self.state.timelapse:
  5278. logger.debug(
  5279. f"[{self.serial_number}] timelapse changed (from ipcam): {self.state.timelapse} -> {timelapse_enabled}"
  5280. )
  5281. self.state.timelapse = timelapse_enabled
  5282. # Track if timelapse was ever active during this print
  5283. if self.state.timelapse and self._was_running:
  5284. self._timelapse_during_print = True
  5285. logger.debug("[%s] Timelapse detected during print (from ipcam)", self.serial_number)
  5286. else:
  5287. self.state.ipcam = ipcam_data is True
  5288. # Parse WiFi signal strength (dBm)
  5289. if "wifi_signal" in data:
  5290. wifi_signal = data["wifi_signal"]
  5291. self._debug_on_change(
  5292. "wifi_signal", wifi_signal, "[%s] wifi_signal received: %s", self.serial_number, wifi_signal
  5293. )
  5294. if isinstance(wifi_signal, (int, float)):
  5295. self.state.wifi_signal = int(wifi_signal)
  5296. elif isinstance(wifi_signal, str):
  5297. # Handle string format like "-52dBm"
  5298. try:
  5299. self.state.wifi_signal = int(wifi_signal.replace("dBm", "").strip())
  5300. except ValueError:
  5301. pass # Ignore unparseable wifi_signal strings; field is non-critical
  5302. # Detect ethernet connection: printers on ethernet with WiFi disabled
  5303. # report a hardcoded wifi_signal of -90 dBm. Real WiFi signals vary
  5304. # (typically -30 to -80 dBm). Only check models with an ethernet port.
  5305. from backend.app.utils.printer_models import has_ethernet
  5306. if has_ethernet(self.model):
  5307. self.state.wired_network = self.state.wifi_signal == -90
  5308. # Parse print speed level (1=silent, 2=standard, 3=sport, 4=ludicrous)
  5309. if "spd_lvl" in data:
  5310. new_speed = data["spd_lvl"]
  5311. if new_speed != self.state.speed_level:
  5312. logger.debug(
  5313. "[%s] speed_level changed: %s -> %s", self.serial_number, self.state.speed_level, new_speed
  5314. )
  5315. self.state.speed_level = new_speed
  5316. # Parse skipped objects from printer status (s_obj field)
  5317. # This allows us to restore skipped objects state after reconnection
  5318. if "s_obj" in data:
  5319. s_obj = data["s_obj"]
  5320. if isinstance(s_obj, list):
  5321. # Update skipped objects from printer's list
  5322. new_skipped = [int(oid) for oid in s_obj if isinstance(oid, (int, str))]
  5323. if new_skipped != self.state.skipped_objects:
  5324. logger.debug("[%s] skipped_objects updated from printer: %s", self.serial_number, new_skipped)
  5325. self.state.skipped_objects = new_skipped
  5326. for oid in new_skipped:
  5327. self._unconfirmed_skips.pop(oid, None)
  5328. self._check_unconfirmed_skips()
  5329. # Parse chamber light status from lights_report
  5330. if "lights_report" in data:
  5331. lights = data["lights_report"]
  5332. logger.debug("[%s] lights_report: %s", self.serial_number, lights)
  5333. if isinstance(lights, list):
  5334. for light in lights:
  5335. if isinstance(light, dict) and light.get("node") == "chamber_light":
  5336. new_light_state = light.get("mode") == "on"
  5337. if new_light_state != self.state.chamber_light:
  5338. logger.debug(
  5339. f"[{self.serial_number}] chamber_light changed: {self.state.chamber_light} -> {new_light_state}"
  5340. )
  5341. self.state.chamber_light = new_light_state
  5342. break
  5343. # Parse nozzle hardware info (single nozzle printers)
  5344. if "nozzle_type" in data:
  5345. self.state.nozzles[0].nozzle_type = str(data["nozzle_type"])
  5346. if "nozzle_diameter" in data:
  5347. self.state.nozzles[0].nozzle_diameter = str(data["nozzle_diameter"])
  5348. # Parse nozzle hardware info (dual nozzle printers - H2D series)
  5349. # Left nozzle
  5350. if "left_nozzle_type" in data:
  5351. self.state.nozzles[0].nozzle_type = str(data["left_nozzle_type"])
  5352. if "left_nozzle_diameter" in data:
  5353. self.state.nozzles[0].nozzle_diameter = str(data["left_nozzle_diameter"])
  5354. # Right nozzle
  5355. if "right_nozzle_type" in data:
  5356. self.state.nozzles[1].nozzle_type = str(data["right_nozzle_type"])
  5357. if "right_nozzle_diameter" in data:
  5358. self.state.nozzles[1].nozzle_diameter = str(data["right_nozzle_diameter"])
  5359. # Alternative format for dual nozzle (nozzle_type_2, etc.)
  5360. if "nozzle_type_2" in data:
  5361. self.state.nozzles[1].nozzle_type = str(data["nozzle_type_2"])
  5362. if "nozzle_diameter_2" in data:
  5363. self.state.nozzles[1].nozzle_diameter = str(data["nozzle_diameter_2"])
  5364. # H2D/H2C series: Nozzle hardware info is in device.nozzle.info array
  5365. if "device" in data and isinstance(data["device"], dict):
  5366. device = data["device"]
  5367. nozzle_data = device.get("nozzle", {})
  5368. # H2C rack position (#2800). `tar_id` is where the carriage is
  5369. # headed, `src_id` where it came from; mid-swap they differ, so
  5370. # dispatch prefers tar_id and falls back to src_id. Both are
  5371. # sticky — the field is only pushed when it changes, so an
  5372. # absent key must leave the last known value alone rather than
  5373. # reset it to None.
  5374. if isinstance(nozzle_data, dict):
  5375. for key, attr in (("src_id", "nozzle_rack_src_id"), ("tar_id", "nozzle_rack_tar_id")):
  5376. if key not in nozzle_data:
  5377. continue
  5378. try:
  5379. parsed_id = int(nozzle_data[key])
  5380. except (TypeError, ValueError):
  5381. continue
  5382. if getattr(self.state, attr) != parsed_id:
  5383. setattr(self.state, attr, parsed_id)
  5384. # DEBUG, not INFO: these move on every tool change, so
  5385. # a long multi-material print would otherwise write
  5386. # thousands of lines. The dispatch log records both
  5387. # values once per print, which is where triage needs
  5388. # them. Same reasoning as the one-shot `nozzle_info`
  5389. # log below.
  5390. logger.debug(
  5391. "[%s] Nozzle rack %s -> %s",
  5392. self.serial_number,
  5393. key,
  5394. parsed_id,
  5395. )
  5396. nozzle_info = nozzle_data.get("info", [])
  5397. if isinstance(nozzle_info, list):
  5398. # H2 series: nozzle_info contains extended nozzle data (wear, serial,
  5399. # max_temp, etc.) for all nozzles: L/R hotend (IDs 0,1) and rack slots
  5400. # (IDs 16-21 on H2C). Store ALL entries so the frontend can use them
  5401. # for hover cards on both the L/R indicator and the nozzle rack card.
  5402. if nozzle_info:
  5403. self.state.nozzle_rack = sorted(
  5404. [
  5405. {
  5406. "id": n.get("id", i),
  5407. "type": str(n.get("type", "")),
  5408. "diameter": str(n.get("diameter", "")),
  5409. "wear": n.get("wear"),
  5410. "stat": n.get("stat"),
  5411. # H2C uses "tm", H2D uses "max_temp"
  5412. "max_temp": n.get("max_temp") or n.get("tm", 0),
  5413. # H2C uses "sn", H2D uses "serial_number"
  5414. "serial_number": str(n.get("serial_number") or n.get("sn", "")),
  5415. # H2C uses "color_m", H2D uses "filament_colour"
  5416. "filament_color": str(n.get("filament_colour") or n.get("color_m", "")),
  5417. # H2C uses "fila_id", H2D uses "filament_id"
  5418. "filament_id": str(n.get("filament_id") or n.get("fila_id", "")),
  5419. "filament_type": str(n.get("tray_type", "") or n.get("filament_type", "")),
  5420. # H3C: home rack position 0-8 (the mounted hotend reports id 0)
  5421. "addr_id": n.get("addr_id") if isinstance(n.get("addr_id"), int) else None,
  5422. }
  5423. for i, n in enumerate(nozzle_info)
  5424. ],
  5425. key=lambda x: x["id"],
  5426. )
  5427. if not hasattr(self, "_nozzle_rack_logged") and nozzle_info:
  5428. self._nozzle_rack_logged = True
  5429. logger.debug(
  5430. "[%s] Nozzle info: %d entries, IDs: %s",
  5431. self.serial_number,
  5432. len(nozzle_info),
  5433. [n.get("id") for n in nozzle_info],
  5434. )
  5435. for nozzle in nozzle_info:
  5436. idx = nozzle.get("id", 0)
  5437. if idx < len(self.state.nozzles):
  5438. if "type" in nozzle and nozzle["type"]:
  5439. self.state.nozzles[idx].nozzle_type = str(nozzle["type"])
  5440. if "diameter" in nozzle:
  5441. self.state.nozzles[idx].nozzle_diameter = str(nozzle["diameter"])
  5442. # Preserve AMS, vt_tray, ams_extruder_map, and mapping data when updating raw_data
  5443. # (these fields aren't sent in every MQTT push, only when changed)
  5444. ams_data = self.state.raw_data.get("ams")
  5445. vt_tray_data = self.state.raw_data.get("vt_tray")
  5446. ams_extruder_map_data = self.state.raw_data.get("ams_extruder_map")
  5447. mapping_data = self.state.raw_data.get("mapping")
  5448. # Normalize vt_tray in data before assigning to raw_data: MQTT sends it
  5449. # as a dict but consumers expect a list. Without this, the dev mode probe
  5450. # below can release the GIL (via publish), letting the event-loop thread
  5451. # read raw_data["vt_tray"] as a dict and crash iterating over string keys.
  5452. if "vt_tray" in data and isinstance(data["vt_tray"], dict):
  5453. data["vt_tray"] = [data["vt_tray"]]
  5454. self.state.raw_data = data
  5455. # Restore preserved fields BEFORE any work that may release the GIL
  5456. # (e.g. _probe_developer_mode publishes an MQTT message).
  5457. if ams_data is not None:
  5458. self.state.raw_data["ams"] = ams_data
  5459. if vt_tray_data is not None:
  5460. self.state.raw_data["vt_tray"] = vt_tray_data
  5461. if ams_extruder_map_data is not None:
  5462. self.state.raw_data["ams_extruder_map"] = ams_extruder_map_data
  5463. if mapping_data is not None and "mapping" not in data:
  5464. self.state.raw_data["mapping"] = mapping_data
  5465. # Parse developer LAN mode from "fun" field
  5466. if "fun" in data:
  5467. try:
  5468. fun_val = data["fun"]
  5469. fun_int = fun_val if isinstance(fun_val, int) else int(fun_val, 16)
  5470. self.state.developer_mode = (fun_int & 0x20000000) == 0
  5471. except (ValueError, TypeError):
  5472. pass
  5473. elif self.state.developer_mode is None and not self._dev_mode_probed:
  5474. # No "fun" field — A1/P1 series never send it, so we need to probe.
  5475. # Two gates: (1) wait for a full pushall (30+ keys) so we don't probe
  5476. # before a pushall that might contain "fun" arrives, and (2) delay 5s
  5477. # after connect to let the MQTT session stabilize — probing too early
  5478. # can destabilize some firmware MQTT brokers (#887).
  5479. if not self._dev_mode_needs_probe and len(data) > 30:
  5480. # First full status without "fun" — mark that probe is needed
  5481. self._dev_mode_needs_probe = True
  5482. if self._dev_mode_needs_probe and time.monotonic() - self._connect_time >= 5.0:
  5483. self._probe_developer_mode()
  5484. elif self._dev_mode_needs_probe:
  5485. logger.debug(
  5486. "[%s] Deferring developer mode probe (%.1fs since connect, need 5s)",
  5487. self.serial_number,
  5488. time.monotonic() - self._connect_time,
  5489. )
  5490. elif self._dev_mode_probed and self._dev_mode_probe_seq is not None:
  5491. # Probe was sent but no response yet — check for timeout.
  5492. # A half-broken MQTT session (e.g. after keep-alive timeout reconnect)
  5493. # may deliver status pushes but silently drop commands (#887).
  5494. elapsed = time.monotonic() - self._dev_mode_probe_time
  5495. if elapsed > 10.0:
  5496. self._dev_mode_probe_failures += 1
  5497. logger.warning(
  5498. "[%s] Developer mode probe timed out after %.0fs (attempt %d)",
  5499. self.serial_number,
  5500. elapsed,
  5501. self._dev_mode_probe_failures,
  5502. )
  5503. self._dev_mode_probe_seq = None
  5504. if self._dev_mode_probe_failures >= 2:
  5505. self.force_reconnect_stale_session("developer mode probe unanswered 2×")
  5506. else:
  5507. # Allow retry on next full status message
  5508. self._dev_mode_probed = False
  5509. # Zombie session detection: if an ams_filament_setting command has been
  5510. # pending for >10s with no response, the publish path is likely dead (#887).
  5511. if self._last_ams_cmd_time > 0:
  5512. elapsed = time.monotonic() - self._last_ams_cmd_time
  5513. if elapsed > 10.0:
  5514. self._ams_cmd_unanswered += 1
  5515. logger.warning(
  5516. "[%s] ams_filament_setting unanswered for %.0fs (count=%d)",
  5517. self.serial_number,
  5518. elapsed,
  5519. self._ams_cmd_unanswered,
  5520. )
  5521. self._last_ams_cmd_time = 0.0 # don't re-trigger on next push_status
  5522. if self._ams_cmd_unanswered >= 2:
  5523. self.force_reconnect_stale_session("ams_filament_setting unanswered 2\u00d7")
  5524. self._ams_cmd_unanswered = 0
  5525. # Log mapping data when received (for usage tracking debugging)
  5526. if "mapping" in data:
  5527. logger.debug("[%s] MQTT mapping field: %s", self.serial_number, data["mapping"])
  5528. # Log state transitions for debugging
  5529. if "gcode_state" in data:
  5530. logger.debug(
  5531. f"[{self.serial_number}] gcode_state: {self._previous_gcode_state} -> {self.state.state}, "
  5532. f"file: {self.state.gcode_file}, subtask: {self.state.subtask_name}"
  5533. )
  5534. # Detect print start (state changes TO RUNNING with a file)
  5535. current_file = self.state.gcode_file or self.state.current_print
  5536. is_new_print = (
  5537. self.state.state == "RUNNING"
  5538. and self._previous_gcode_state is not None # #1304: skip on first push after Bambuddy startup
  5539. and self._previous_gcode_state != "RUNNING"
  5540. and current_file
  5541. and not self._was_running # Prevent duplicates when resuming from PAUSE
  5542. )
  5543. # Also detect if file changed while running (new print started)
  5544. is_file_change = (
  5545. self.state.state == "RUNNING"
  5546. and current_file
  5547. and current_file != self._previous_gcode_file
  5548. and self._previous_gcode_file is not None
  5549. )
  5550. # Track RUNNING state for more robust completion detection
  5551. running_first_observed = False
  5552. if self.state.state == "RUNNING" and current_file:
  5553. if not self._was_running:
  5554. logger.debug("[%s] Now tracking RUNNING state for %s", self.serial_number, current_file)
  5555. # Check if timelapse was enabled in the same message (xcam parsed before this)
  5556. if self.state.timelapse:
  5557. self._timelapse_during_print = True
  5558. logger.debug("[%s] Timelapse detected when entering RUNNING state", self.serial_number)
  5559. # Mark this as the first RUNNING observation of the session.
  5560. # If is_new_print also fires below, on_print_start handles
  5561. # baseline capture and we suppress on_print_running_observed
  5562. # to avoid double-capture. If is_new_print does NOT fire
  5563. # (Bambuddy started mid-print — the #1304 guard suppressed
  5564. # it), main.py needs this hook to catch the restart-recovery
  5565. # case (#1485 follow-up).
  5566. running_first_observed = True
  5567. self._was_running = True
  5568. self._completion_triggered = False
  5569. if is_new_print or is_file_change:
  5570. # Clear any old HMS errors when a new print starts
  5571. self.state.hms_errors = []
  5572. # The last print's pauses; this one's come from its 3MF (#2984).
  5573. self.state.pause_points = []
  5574. self.state.pause_warned_layers = set()
  5575. # Reset layer tracking for new print (needed for layer-based timelapse)
  5576. # #3317: only above 1. Every print reports layer 1 first, which
  5577. # clears a higher value; a previous print that ended on layer 1
  5578. # would make this print's own first layer look stale.
  5579. self._stale_layer_num = self.state.layer_num if self.state.layer_num > 1 else 0
  5580. self.state.layer_num = 0
  5581. # Reset total_layers so the previous print's value can't bleed into
  5582. # this print's usage-tracker split (#1771 follow-on to the
  5583. # preservation guard at the `total_layer_num` parse above — that
  5584. # guard ignores firmware-reset 0s, so the explicit reset has to
  5585. # happen here instead).
  5586. #
  5587. # #2702: reset to *this frame's* total, not to 0. The frame that
  5588. # trips the new-print detection can carry the new print's
  5589. # `total_layer_num` as well — the parse above has already applied
  5590. # it, and zeroing unconditionally threw it away. That looked
  5591. # harmless but is not recoverable: Bambu firmware sends only
  5592. # changed fields, so the printer never offers the total again, and
  5593. # the print runs to completion at `n/0` in the UI, in
  5594. # `{total_layers}` notifications, and as the usage-split
  5595. # denominator. The value only reappears on the next full pushall
  5596. # (reconnect / Force Refresh), which is why the symptom looked
  5597. # random and why a *stable* connection made it worse.
  5598. self.state.total_layers = total_from_this_frame
  5599. # If the starting frame brought no total, ask for one. Costs one
  5600. # MQTT message per print and covers the ordering where the printer
  5601. # published the total a frame or two before the state flip.
  5602. self._total_layers_refresh_armed = not total_from_this_frame
  5603. if self._total_layers_refresh_armed:
  5604. self._request_push_all()
  5605. # Reset completion tracking for new print
  5606. self._was_running = True
  5607. self._completion_triggered = False
  5608. # #1721: rearm the end-of-print finish-photo trigger for the new print
  5609. self._finish_photo_captured = False
  5610. # #2547: rearm the end-of-print telemetry probe for the new print
  5611. self._eop_probe_armed = True
  5612. self._eop_probe_open = False
  5613. self._eop_probe_frames = 0
  5614. self._eop_probe_last = {}
  5615. # Reset last valid progress/layer for usage tracking
  5616. self._last_valid_progress = 0.0
  5617. self._last_valid_layer_num = 0
  5618. # Clear and seed tray change log for mid-print usage splitting
  5619. self.state.tray_change_log.clear()
  5620. # Seeded with the assigned spools by usage_tracker.on_print_start.
  5621. self.state.spool_change_log = []
  5622. tn = self.state.tray_now
  5623. if self.tray_layout.is_loaded_tray(tn):
  5624. self.state.tray_change_log.append((tn, 0))
  5625. # Initialize timelapse tracking based on current state
  5626. # NOTE: xcam data is parsed BEFORE this code runs in _process_message,
  5627. # so self.state.timelapse may already be set from this message.
  5628. # We preserve that value instead of blindly resetting to False.
  5629. if self.state.timelapse:
  5630. self._timelapse_during_print = True
  5631. logger.debug("[%s] Timelapse detected at print start", self.serial_number)
  5632. else:
  5633. self._timelapse_during_print = False
  5634. if (is_new_print or is_file_change) and self.on_print_start:
  5635. logger.info(
  5636. f"[{self.serial_number}] PRINT START detected - file: {current_file}, "
  5637. f"subtask: {self.state.subtask_name}, is_new: {is_new_print}, is_file_change: {is_file_change}"
  5638. )
  5639. self.on_print_start(
  5640. {
  5641. "filename": current_file,
  5642. "subtask_name": self.state.subtask_name,
  5643. "remaining_time": self.state.remaining_time * 60
  5644. if self.state.remaining_time > 0
  5645. else None, # Convert minutes to seconds
  5646. "raw_data": data,
  5647. "ams_mapping": self._captured_ams_mapping,
  5648. }
  5649. )
  5650. elif running_first_observed and self.on_print_running_observed:
  5651. # Restart-recovery hook (#1485 follow-up): Bambuddy started mid-
  5652. # print, so the #1304 first-push guard suppressed on_print_start,
  5653. # but we still need main.py to capture a fresh timelapse baseline
  5654. # before the printer uploads the in-flight MP4. Same payload
  5655. # shape as on_print_start so the consumer can reuse fields.
  5656. logger.info(
  5657. f"[{self.serial_number}] RUNNING observed without PRINT START "
  5658. f"(restart-recovery) - file: {current_file}, subtask: {self.state.subtask_name}"
  5659. )
  5660. self.on_print_running_observed(
  5661. {
  5662. "filename": current_file,
  5663. "subtask_name": self.state.subtask_name,
  5664. "remaining_time": self.state.remaining_time * 60 if self.state.remaining_time > 0 else None,
  5665. "raw_data": data,
  5666. "ams_mapping": self._captured_ams_mapping,
  5667. }
  5668. )
  5669. # Detect print completion (FINISH = success, FAILED = error, IDLE = aborted)
  5670. # Use _was_running flag in addition to _previous_gcode_state for more robust detection
  5671. # This handles cases where server restarts during a print
  5672. should_trigger_completion = (
  5673. self.state.state in ("FINISH", "FAILED")
  5674. and not self._completion_triggered
  5675. and self.on_print_complete
  5676. and (
  5677. self._previous_gcode_state == "RUNNING" # Normal transition
  5678. or (self._was_running and self._previous_gcode_state != self.state.state) # After server restart
  5679. # Pre-print failure (#1111): printer rejected the job during setup
  5680. # — wrong nozzle size, AMS error, etc. The print never reaches
  5681. # RUNNING, so without this branch neither the RUNNING check nor
  5682. # _was_running match and the queue item stays stuck at "printing".
  5683. # Restricted to FAILED from pre-print states so a stale FAILED on
  5684. # first connection (prev=None) still can't accidentally fire.
  5685. or (self.state.state == "FAILED" and self._previous_gcode_state in ("PREPARE", "SLICING"))
  5686. )
  5687. )
  5688. # For IDLE, only trigger if we just came from RUNNING (explicit abort/cancel)
  5689. if (
  5690. self.state.state == "IDLE"
  5691. and self._previous_gcode_state == "RUNNING"
  5692. and not self._completion_triggered
  5693. and self.on_print_complete
  5694. ):
  5695. should_trigger_completion = True
  5696. # Log when we FIRST see a terminal state but DON'T trigger completion (diagnostics)
  5697. # Only log on the transition (prev != current) to avoid flooding logs every MQTT update
  5698. if (
  5699. not should_trigger_completion
  5700. and self.state.state in ("FINISH", "FAILED")
  5701. and self._previous_gcode_state != self.state.state
  5702. ):
  5703. logger.info(
  5704. f"[{self.serial_number}] State is {self.state.state} but completion NOT triggered: "
  5705. f"prev={self._previous_gcode_state}, was_running={self._was_running}, "
  5706. f"already_triggered={self._completion_triggered}, has_callback={bool(self.on_print_complete)}"
  5707. )
  5708. # Mark as triggered so state is clean for the next print cycle
  5709. self._completion_triggered = True
  5710. if should_trigger_completion:
  5711. if self.state.state == "FINISH":
  5712. status = "completed"
  5713. elif self.state.state == "FAILED":
  5714. status = "failed"
  5715. else:
  5716. status = "aborted"
  5717. logger.info(
  5718. f"[{self.serial_number}] PRINT COMPLETE detected - state: {self.state.state}, "
  5719. f"status: {status}, file: {self._previous_gcode_file or current_file}, "
  5720. f"subtask: {self.state.subtask_name}, was_running: {self._was_running}, "
  5721. f"timelapse_during_print: {self._timelapse_during_print}"
  5722. )
  5723. timelapse_was_active = self._timelapse_during_print
  5724. # #1721 fallback: if the stage-22 trigger never fired (cancel,
  5725. # external-spool-only, HMS halt, or firmware variant that skips
  5726. # the unload phase) fire the finish-photo moment now. Bed has
  5727. # already dropped, framing is worse, but we still capture.
  5728. # Only on successful completion — aborted/failed prints don't
  5729. # produce a meaningful finish photo.
  5730. if status == "completed" and not self._finish_photo_captured and self.on_finish_photo_moment:
  5731. self._finish_photo_captured = True
  5732. logger.info(
  5733. f"[{self.serial_number}] FINISH PHOTO MOMENT (FINISH fallback) — "
  5734. f"stage-22 never fired; capturing at FINISH-state transition"
  5735. )
  5736. self.on_finish_photo_moment(
  5737. {
  5738. "trigger": "finish_state",
  5739. "filename": self._previous_gcode_file or current_file,
  5740. "subtask_name": self.state.subtask_name,
  5741. "timelapse_was_active": timelapse_was_active,
  5742. }
  5743. )
  5744. self._completion_triggered = True
  5745. self._was_running = False
  5746. self._timelapse_during_print = False # Reset for next print
  5747. # Include HMS errors for failure reason detection
  5748. hms_errors_data = [e.completion_payload() for e in self.state.hms_errors or []]
  5749. from backend.app.utils.printer_models import usage_progress
  5750. last_progress = usage_progress(
  5751. self.model, self._last_valid_progress, self._last_valid_layer_num, self.state.total_layers
  5752. )
  5753. self.on_print_complete(
  5754. {
  5755. "status": status,
  5756. "subtask_id": self.state.subtask_id,
  5757. "filename": self._previous_gcode_file or current_file,
  5758. "subtask_name": self.state.subtask_name,
  5759. "raw_data": data,
  5760. "timelapse_was_active": timelapse_was_active,
  5761. "hms_errors": hms_errors_data,
  5762. "ams_mapping": self._captured_ams_mapping,
  5763. # Last valid progress/layer before firmware reset (for partial usage tracking)
  5764. "last_progress": last_progress,
  5765. "last_layer_num": self._last_valid_layer_num,
  5766. }
  5767. )
  5768. self._captured_ams_mapping = None
  5769. # Same lifecycle as the mapping above: it described *this* print.
  5770. # Leaving it set would hand the next print an answer about where a
  5771. # different file went, and a stale "internal storage" reading costs
  5772. # an archive that the FTPS sweep would have found (#2780).
  5773. self.state.current_project_url = None
  5774. self._previous_gcode_state = self.state.state
  5775. if current_file:
  5776. self._previous_gcode_file = current_file
  5777. if self.on_state_change:
  5778. self.on_state_change(self.state)
  5779. def _request_push_all(self):
  5780. """Request full status update from printer."""
  5781. if self._client:
  5782. message = {"pushing": {"command": "pushall"}}
  5783. self._client.publish(self.topic_publish, json.dumps(message), qos=1)
  5784. def _probe_developer_mode(self):
  5785. """Probe developer mode by sending an ams_filament_setting for the external slot.
  5786. Some printers (A1/P1 series) never send the "fun" field in MQTT status.
  5787. For these, we detect developer mode by sending a harmless command and
  5788. checking whether the printer accepts or rejects it:
  5789. - result="success" → developer mode ON (commands accepted)
  5790. - result="failed", reason="mqtt message verify failed" → developer mode OFF
  5791. The probe re-sends the current external slot configuration so it's a no-op
  5792. when the command succeeds. If there's no external slot data yet, we send a
  5793. reset (empty filament) which is also safe.
  5794. """
  5795. if not self._client or not self.state.connected:
  5796. return
  5797. self._dev_mode_probed = True
  5798. self._dev_mode_probe_time = time.monotonic()
  5799. self._sequence_id += 1
  5800. seq = str(self._sequence_id)
  5801. self._dev_mode_probe_seq = seq
  5802. # Build probe command: re-send current external slot config (no-op on success)
  5803. vt_tray = self.state.raw_data.get("vt_tray", []) if self.state.raw_data else []
  5804. current = vt_tray[0] if vt_tray else {}
  5805. command = {
  5806. "print": {
  5807. "command": "ams_filament_setting",
  5808. "ams_id": 255,
  5809. "tray_id": 0,
  5810. "slot_id": 0,
  5811. "tray_info_idx": current.get("tray_info_idx", ""),
  5812. "tray_type": current.get("tray_type", ""),
  5813. "tray_sub_brands": current.get("tray_sub_brands", ""),
  5814. "tray_color": current.get("tray_color", "00000000"),
  5815. "nozzle_temp_min": current.get("nozzle_temp_min", 0),
  5816. "nozzle_temp_max": current.get("nozzle_temp_max", 0),
  5817. "sequence_id": seq,
  5818. }
  5819. }
  5820. setting_id = current.get("setting_id")
  5821. if setting_id:
  5822. command["print"]["setting_id"] = setting_id
  5823. logger.info("[%s] Probing developer mode via ams_filament_setting (seq=%s)", self.serial_number, seq)
  5824. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  5825. def _apply_mqtt_verify_state(self, verify_failed: bool) -> None:
  5826. """Reconcile developer_mode with the printer's own command-verification verdict.
  5827. ``HMS_MQTT_VERIFY_FAILED`` is the only *direct* evidence we ever get that
  5828. control commands are being refused, so it outranks the probe in both
  5829. directions:
  5830. * present → developer_mode is definitively False, whatever the probe
  5831. concluded. The probe can only read the response to its own
  5832. ``ams_filament_setting``; on P1 firmware a refusal is reported here
  5833. instead, so the probe answers ENABLED while every print silently dies
  5834. (#2732).
  5835. * gone again → drop the HMS-derived False back to unknown and re-arm the
  5836. probe, so a user who enables Developer Mode and restarts the printer
  5837. isn't stuck behind a verdict nothing would ever revisit.
  5838. A False that came from the probe or the ``fun`` bit is left alone — this
  5839. only ever unwinds its own latch.
  5840. """
  5841. if verify_failed:
  5842. if not self._dev_mode_from_hms:
  5843. logger.warning(
  5844. "[%s] Printer reported HMS %s (MQTT command verification failed): it is "
  5845. "rejecting control commands, so prints, temperature changes and filament "
  5846. "loads will be ignored. Enable Developer Mode on the printer and restart it.",
  5847. self.serial_number,
  5848. HMS_MQTT_VERIFY_FAILED,
  5849. )
  5850. self._dev_mode_from_hms = True
  5851. self.state.developer_mode = False
  5852. return
  5853. if not self._dev_mode_from_hms:
  5854. return
  5855. logger.info(
  5856. "[%s] HMS %s cleared — re-probing developer mode",
  5857. self.serial_number,
  5858. HMS_MQTT_VERIFY_FAILED,
  5859. )
  5860. self._dev_mode_from_hms = False
  5861. self.state.developer_mode = None
  5862. self._dev_mode_probed = False
  5863. self._dev_mode_needs_probe = False
  5864. def _handle_dev_mode_probe_response(self, data: dict):
  5865. """Handle response to the developer mode probe command.
  5866. Sets developer_mode based on whether the printer accepted or rejected the command.
  5867. Three outcomes, not two. An explicit ``success`` proves commands are
  5868. accepted and an explicit verify-failure proves they are not, but anything
  5869. else proves nothing — P1S firmware 01.10.00.00 answers this probe with a
  5870. bare ``{"command": "ams_filament_setting", "sequence_id": "3"}`` and no
  5871. ``result`` at all, while refusing every control command and reporting
  5872. ``HMS_MQTT_VERIFY_FAILED`` instead. Reading that empty response as ENABLED
  5873. is what put ``developer_mode: pass`` in the support bundle of a printer
  5874. that had not accepted a command all day (#2732). Leaving it unknown makes
  5875. the connection diagnostic report ``skip``, which is the honest answer.
  5876. """
  5877. self._dev_mode_probe_seq = None # One-shot: don't match future responses
  5878. self._dev_mode_probe_failures = 0 # Reset on any response
  5879. result = data.get("result", "")
  5880. reason = data.get("reason", "")
  5881. if result == "failed" and "verify failed" in reason:
  5882. self.state.developer_mode = False
  5883. logger.info("[%s] Developer mode probe: DISABLED (reason=%r)", self.serial_number, reason)
  5884. elif str(result).lower() == "success":
  5885. self.state.developer_mode = True
  5886. logger.info("[%s] Developer mode probe: ENABLED (result=%r)", self.serial_number, result)
  5887. else:
  5888. # An HMS verdict already recorded here is real evidence; don't let an
  5889. # inconclusive probe response wipe it back to unknown.
  5890. if not self._dev_mode_from_hms:
  5891. self.state.developer_mode = None
  5892. logger.info(
  5893. "[%s] Developer mode probe: INCONCLUSIVE (result=%r, reason=%r) — "
  5894. "the printer neither confirmed nor refused the command",
  5895. self.serial_number,
  5896. result,
  5897. reason,
  5898. )
  5899. if self.on_state_change:
  5900. self.on_state_change(self.state)
  5901. def _request_version(self):
  5902. """Request firmware version info from printer."""
  5903. if self._client:
  5904. self._sequence_id += 1
  5905. message = {
  5906. "info": {
  5907. "sequence_id": str(self._sequence_id),
  5908. "command": "get_version",
  5909. }
  5910. }
  5911. logger.debug("[%s] Requesting firmware version info", self.serial_number)
  5912. self._client.publish(self.topic_publish, json.dumps(message), qos=1)
  5913. def request_status_update(self) -> bool:
  5914. """Request a full status update from the printer (public API).
  5915. Sends both pushall and get_accessories commands to refresh all data
  5916. including nozzle hardware info.
  5917. Returns:
  5918. True if the request was sent, False if not connected.
  5919. """
  5920. if not self._client or not self.state.connected:
  5921. logger.warning("[%s] request_status_update: not connected", self.serial_number)
  5922. return False
  5923. logger.debug("[%s] Requesting status update (pushall)", self.serial_number)
  5924. self._request_push_all()
  5925. # Note: get_accessories returns stale nozzle data on H2D.
  5926. # The correct nozzle data comes from push_status response.
  5927. return True
  5928. def _prime_kprofile_request(self):
  5929. """Send a priming K-profile request on connect.
  5930. Bambu printers often ignore the first K-profile request after connection,
  5931. so we send a dummy request on connect to 'prime' the system.
  5932. """
  5933. if self._client:
  5934. self._sequence_id += 1
  5935. command = {
  5936. "print": {
  5937. "command": "extrusion_cali_get",
  5938. "filament_id": "",
  5939. "nozzle_diameter": "0.4",
  5940. "sequence_id": str(self._sequence_id),
  5941. }
  5942. }
  5943. logger.debug("[%s] Sending K-profile priming request", self.serial_number)
  5944. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  5945. def connect(self, loop: asyncio.AbstractEventLoop | None = None):
  5946. """Connect to the printer MQTT broker.
  5947. Args:
  5948. loop: The asyncio event loop to use for thread-safe callbacks.
  5949. If not provided, will try to get the running loop.
  5950. """
  5951. self._loop = loop
  5952. BambuMQTTClient._client_instance_counter += 1
  5953. client_id = f"bambuddy_{self.serial_number}_{os.getpid()}_{BambuMQTTClient._client_instance_counter}"
  5954. self._client = mqtt.Client(
  5955. callback_api_version=mqtt.CallbackAPIVersion.VERSION2,
  5956. client_id=client_id,
  5957. protocol=mqtt.MQTTv311,
  5958. )
  5959. # Bambu's broker has racy PUBACK matching with paho's QoS=1 inflight
  5960. # tracking (#1164). The default ceiling of 20 wedges sessions after
  5961. # ~16-20 cumulative commands; lifting it well above any realistic
  5962. # session count keeps QoS=1 working without changing wire-protocol
  5963. # behaviour across printer models.
  5964. self._client.max_inflight_messages_set(1000)
  5965. self._client.username_pw_set("bblp", self.access_code)
  5966. self._client.on_connect = self._on_connect
  5967. self._client.on_disconnect = self._on_disconnect
  5968. self._client.on_subscribe = self._on_subscribe
  5969. self._client.on_message = self._on_message
  5970. # TLS setup - Bambu uses self-signed certs
  5971. ssl_context = ssl.create_default_context()
  5972. ssl_context.check_hostname = False
  5973. ssl_context.verify_mode = ssl.CERT_NONE
  5974. # Same reasoning as ImplicitFTP_TLS in bambu_ftp.py: create_default_context()
  5975. # inherits its protocol floor from the OpenSSL build instead of declaring one.
  5976. # Every Bambu broker measured (X1C, H2D on :8883) speaks TLS 1.2 and refuses
  5977. # 1.0/1.1/1.3, so this floor is a no-op on the wire and closes the gap on
  5978. # bare-metal installs whose build allows TLS 1.0.
  5979. ssl_context.minimum_version = ssl.TLSVersion.TLSv1_2
  5980. self._client.tls_set_context(ssl_context)
  5981. # Backoff reconnects to avoid tight reconnect loops on unstable brokers.
  5982. self._client.reconnect_delay_set(min_delay=1, max_delay=30)
  5983. # Keepalive: paho sends PINGREQs at this interval, broker considers
  5984. # client dead at 1.5x. 30s is a good balance — fast enough to detect
  5985. # real network loss (45s), not so aggressive that transient hiccups
  5986. # trigger false disconnects. Stale detection (60s no messages) handles
  5987. # the P1S/P1P firmware bug where the broker stops publishing but the
  5988. # TCP connection stays alive.
  5989. self._client.connect_async(self.ip_address, self.MQTT_PORT, keepalive=30)
  5990. self._client.loop_start()
  5991. def start_print(
  5992. self,
  5993. filename: str,
  5994. plate_id: int = 1,
  5995. ams_mapping: list[int] | None = None,
  5996. bed_levelling: str = "auto",
  5997. flow_cali: str = "auto",
  5998. vibration_cali: bool = True,
  5999. layer_inspect: bool = False,
  6000. timelapse: bool = False,
  6001. use_ams: bool = True,
  6002. nozzle_offset_cali: str = "auto",
  6003. nozzle_mapping: str | None = None,
  6004. nozzle_slot_extruders: str | None = None,
  6005. plate_uses_only_external: bool = False,
  6006. ):
  6007. """Start a print job on the printer.
  6008. The file should already be uploaded to the printer's root directory via FTP.
  6009. Args:
  6010. filename: Name of the uploaded file
  6011. plate_id: Plate number to print (default 1)
  6012. ams_mapping: List of tray IDs for each filament slot in the 3MF.
  6013. Global tray ID = (ams_id * 4) + slot_id, external = 254
  6014. timelapse: Record timelapse video
  6015. bed_levelling: Bed levelling — tri-state "off"/"on"/"auto" (auto skips
  6016. if the bed was levelled recently, matching BambuStudio).
  6017. flow_cali: Flow/pressure advance calibration — "off"/"on"/"auto".
  6018. vibration_cali: Vibration compensation calibration
  6019. layer_inspect: First layer AI inspection
  6020. use_ams: Use AMS for automatic filament changes
  6021. plate_uses_only_external: The caller determined from the plate's
  6022. own filament list that it prints only from the spool holder;
  6023. use_ams=False then stands even if the mapping names a real
  6024. tray (one another plate of the file uses, #3087)
  6025. nozzle_offset_cali: Nozzle offset calibration — "off"/"on"/"auto"
  6026. (dual-nozzle printers only — silently ignored on single-nozzle).
  6027. nozzle_mapping: Opaque JSON string captured from BambuStudio's
  6028. project_file for H2C rack-swap (O1C2) (#1780). When non-null
  6029. AND the printer is dual-nozzle, parsed and injected as the
  6030. `nozzle_mapping` array on the dispatched project_file so the
  6031. firmware honours the user's slicer pick instead of falling
  6032. back to "last matching nozzle" auto-pick. Silently ignored
  6033. on single-nozzle printers.
  6034. nozzle_slot_extruders: Opaque JSON string of per-filament-slot
  6035. MQTT extruder indices, derived from the 3MF when no
  6036. BambuStudio capture exists (#2800). Consulted only on
  6037. nozzle-rack models (H2C) and only when `nozzle_mapping` did
  6038. not already supply one; resolved here into physical rack
  6039. positions using the live `device.nozzle` state. When it
  6040. cannot be resolved the field is omitted and the firmware
  6041. picks, as it did before this existed.
  6042. Returns True when the start command was published, False otherwise
  6043. (not connected, or the printer is already busy — see the run-state
  6044. guard below).
  6045. """
  6046. # Never dispatch project_file to a printer that is not idle (#2598).
  6047. # This is the single publish choke point for every dispatch path — the
  6048. # queue scheduler, a manual start, a webhook, and a Virtual-Printer
  6049. # forwarded job all funnel through here — so one guard covers them all.
  6050. # The firmware rejects a start while busy with 0500_4004 ("Device is
  6051. # busy and cannot start a new task"), and on an A1 mini that error
  6052. # cancels the RUNNING job (#2598). IDLE / FINISH / FAILED are valid
  6053. # start targets; only the active-print states are refused. (A
  6054. # transport-level QoS-1 replay on reconnect would bypass this guard;
  6055. # _on_connect empties paho's outbox before it can re-send (#3454).)
  6056. if self.state.state in _ACTIVE_PRINT_STATES:
  6057. logger.warning(
  6058. "[%s] start_print refused: printer busy (gcode_state=%s) — not publishing project_file for %s",
  6059. self.serial_number,
  6060. self.state.state,
  6061. filename,
  6062. )
  6063. return False
  6064. if self._client and self.state.connected:
  6065. # Bambu print command format — matches Bambu Studio's format.
  6066. # The calibration/leveling fields (timelapse, bed_leveling,
  6067. # flow_cali, vibration_cali, layer_inspect) are JSON booleans for
  6068. # every model. An earlier revision integer-encoded them for the H2
  6069. # family (H2D/H2S/H2C/X2D) on the belief that H2 firmware required
  6070. # 0/1 — but a BambuStudio request-topic capture from a real H2D
  6071. # sends plain booleans, and the integer encoding made the H2S
  6072. # silently skip flow-dynamics calibration (#1478). use_ams is the
  6073. # one field that genuinely must stay boolean: H2D Pro firmware
  6074. # reads an integer use_ams as a nozzle index (1 = deputy), which is
  6075. # what actually caused the wrong-extruder routing behind #1386.
  6076. # Dual-nozzle routing for external spool (254 = deputy/left,
  6077. # 255 = main/right) and the use_ams=False fallback. H2S is in the
  6078. # H2 firmware family but is single-nozzle, despite sharing serial
  6079. # prefix "094" with H2D. Prefer runtime detection from
  6080. # device.extruder.info (set in _handle_push_status); fall back to
  6081. # model name for the brief window after connect before push data
  6082. # arrives. _is_dual_nozzle only ever flips False→True, so it's safe
  6083. # as the primary signal.
  6084. from backend.app.utils.printer_models import is_dual_nozzle_model, is_nozzle_rack_model
  6085. is_dual_nozzle = self._is_dual_nozzle or is_dual_nozzle_model(self.model)
  6086. # Build ams_mapping2 from ams_mapping (detailed format with ams_id/slot_id)
  6087. ams_mapping2 = []
  6088. # BambuStudio converts virtual tray IDs (254/255) to -1 in the flat
  6089. # ams_mapping and relies on ams_mapping2 for external spool details.
  6090. # Passing raw 254/255 in the flat array causes H2D firmware to fail
  6091. # with 0700_8012 "Failed to get AMS mapping table".
  6092. flat_ams_mapping = []
  6093. layout = self.tray_layout
  6094. if ams_mapping is not None:
  6095. for tray_id in ams_mapping:
  6096. # Ensure tray_id is an integer (may be string from JSON)
  6097. tray_id = int(tray_id) if tray_id is not None else -1
  6098. rack_slot = layout.rack_slot(tray_id) if tray_id >= 0 else None
  6099. if tray_id == -1:
  6100. # Unmapped filament slot
  6101. flat_ams_mapping.append(-1)
  6102. ams_mapping2.append({"ams_id": 255, "slot_id": 255})
  6103. elif layout.rack and layout.is_external(tray_id):
  6104. # A rack printer's per-hotend input 247-255, as Studio
  6105. # sends it: -1 flat, its own id in ams_mapping2.
  6106. flat_ams_mapping.append(-1)
  6107. ams_mapping2.append({"ams_id": tray_id, "slot_id": 0})
  6108. elif rack_slot is not None:
  6109. # Rack AMS slot, as Studio sends it: 28 + k flat,
  6110. # {ams_id: 32, slot_id: k} in ams_mapping2.
  6111. flat_ams_mapping.append(tray_id)
  6112. ams_mapping2.append({"ams_id": rack_slot[0], "slot_id": rack_slot[1]})
  6113. elif tray_id >= 254:
  6114. # External/virtual spool. BambuStudio convention:
  6115. # 255 = VIRTUAL_TRAY_MAIN_ID (main/right nozzle)
  6116. # 254 = VIRTUAL_TRAY_DEPUTY_ID (deputy/left nozzle)
  6117. # Flat mapping must use -1 (firmware doesn't accept raw 254/255).
  6118. # Single-nozzle printers (X1C, P1S, A1, etc.) report tray_now=254
  6119. # for external spool, but BambuStudio always sends ams_id=255
  6120. # (VIRTUAL_TRAY_MAIN_ID) in ams_mapping2. Sending 254 causes the
  6121. # firmware to target AMS tray 0 instead of external spool, leading
  6122. # to 07FF_8012 "Failed to get AMS mapping table" or stuck prints.
  6123. # Only H2D dual-nozzle printers use 254 (deputy/left nozzle).
  6124. flat_ams_mapping.append(-1)
  6125. ext_ams_id = tray_id if is_dual_nozzle else 255
  6126. ams_mapping2.append({"ams_id": ext_ams_id, "slot_id": 0})
  6127. elif tray_id >= 128:
  6128. # AMS-HT: global tray ID IS the ams_id (single tray per unit)
  6129. flat_ams_mapping.append(tray_id)
  6130. ams_mapping2.append({"ams_id": tray_id, "slot_id": 0})
  6131. elif (_a2l := a2l_lite_wire_ids(layout.slot_key(tray_id)[0], tray_id)) is not None:
  6132. # A2L AMS-Lite (normalised global 24-27): flat mapping is the
  6133. # LOCAL slot 0-3 and ams_mapping2 carries {ams_id:16, slot_id:0-3}
  6134. # — both CONFIRMED against the firmware's own mapping
  6135. # (flat [1], ams_mapping2 {ams_id:16, slot_id:1}).
  6136. _wire_ams, _wire_slot, _ = _a2l
  6137. flat_ams_mapping.append(_wire_slot)
  6138. ams_mapping2.append({"ams_id": _wire_ams, "slot_id": _wire_slot})
  6139. else:
  6140. # Regular AMS tray: Global tray ID = (ams_id * 4) + slot_id
  6141. ams_id, slot_id = layout.slot_key(tray_id)
  6142. flat_ams_mapping.append(tray_id)
  6143. ams_mapping2.append({"ams_id": ams_id, "slot_id": slot_id})
  6144. # Reconcile use_ams against the resolved ams_mapping for single-nozzle
  6145. # printers — the mapping is authoritative about whether this print
  6146. # actually feeds from the AMS. Skip for dual-nozzle printers, where
  6147. # use_ams encodes nozzle routing rather than an AMS on/off flag.
  6148. # H2S falls through here now (#1386): it is single-nozzle and was
  6149. # hitting the dual-nozzle bypass, which caused 07FF_8012 when printing
  6150. # without an AMS attached.
  6151. #
  6152. # Two symmetric corrections:
  6153. #
  6154. # (a) A mapping that resolves a *real* AMS tray (0-253) forces
  6155. # use_ams=True even if it arrived False. A print sent to a Virtual
  6156. # Printer is sliced against the VP, which advertises no AMS, so the
  6157. # slicer sends use_ams=false and that gets stamped on the queue item
  6158. # — but at dispatch the scheduler colour-matches a real printer and
  6159. # resolves a real AMS slot. Without this, the stale False reaches the
  6160. # printer, which ignores the mapped slot and aborts at layer 0 on the
  6161. # empty external spool ("not enough filament"). Diagnosed by
  6162. # @Sawtaytoes (#2595, PR #2596).
  6163. #
  6164. # (b) Only an *explicit* external/virtual spool (254/255) may downgrade
  6165. # to use_ams=False. P1S/P1P with no AMS rejects use_ams=True with
  6166. # "Failed to get AMS mapping table". An unresolved slot (-1) does
  6167. # NEITHER: it means the mapping was never resolved — e.g. a frontend
  6168. # status-load race that persisted [-1] (#2589) — and treating it as
  6169. # external silently started the print against an empty feed. A genuine
  6170. # external selection is >=254; unresolved is -1; a loaded tray is
  6171. # 0-253. Keeping them distinct means an unresolved mapping fails loudly
  6172. # (or is recomputed upstream) instead of silently going external, and
  6173. # never gets force-enabled by (a) either.
  6174. if ams_mapping and not is_dual_nozzle:
  6175. has_real_tray = any(
  6176. t is not None and 0 <= int(t) <= 253 and not layout.is_external(int(t)) for t in ams_mapping
  6177. )
  6178. all_external = all(t is None or int(t) >= 254 or layout.is_external(int(t)) for t in ams_mapping)
  6179. # (Not when the scheduler worked out from the plate's own
  6180. # filament list that it prints only from the spool holder: a
  6181. # real tray here is then one another plate of the file uses.)
  6182. if has_real_tray and not use_ams and not plate_uses_only_external:
  6183. use_ams = True
  6184. logger.info(
  6185. "[%s] AMS mapping resolved a real slot — setting use_ams=True (#2595)",
  6186. self.serial_number,
  6187. )
  6188. elif use_ams and all_external:
  6189. use_ams = False
  6190. logger.info(
  6191. "[%s] All filament slots use external spool — setting use_ams=False",
  6192. self.serial_number,
  6193. )
  6194. # (c) A single-nozzle printer that reported no AMS at all can only
  6195. # print from the spool holder, whatever the mapping says. With
  6196. # nothing set on the holder the matcher resolves no mapping, so
  6197. # neither (a) nor (b) ran and the print went out as use_ams=True,
  6198. # which the firmware refuses with 07FF_8012 "Failed to get AMS
  6199. # mapping table" (#3356). An empty raw_data["ams"] is the
  6200. # printer's own report of no AMS; a missing key means no AMS
  6201. # push has been handled yet (a reconnect), which changes nothing.
  6202. if use_ams and not is_dual_nozzle and self.state.raw_data.get("ams") == []:
  6203. use_ams = False
  6204. logger.info("[%s] Printer has no AMS — setting use_ams=False (#3356)", self.serial_number)
  6205. # Unique per-submission identity fields. Hardcoded "0" values caused
  6206. # third-party MQTT observers (OctoEverywhere, etc.) to see reprints as
  6207. # continuations of the same job: the printer reuses gcode_start_time
  6208. # from the prior print with task_id=0, so observers latch onto a stale
  6209. # timestamp and report compounding durations on repeat replays (#1011).
  6210. # BambuStudio mints fresh IDs per submission; matching that behavior
  6211. # makes the printer emit a clean state-transition for each job.
  6212. # md5 is left empty — firmware historically accepts "" as "skip
  6213. # validation" (unlike Studio, we don't have the file's real md5 here
  6214. # without re-reading the upload, and sending a synthetic wrong digest
  6215. # risks activation of md5 verification on some firmwares).
  6216. # Cap at signed int32 max: P1S firmware (01.10.00.00) clamps oversized
  6217. # task identity fields to 2**31-1, so raw epoch-ms (13 digits, ~1.7e12)
  6218. # overflows and every submission ends up with the same task_id from
  6219. # the printer's perspective — the printer then treats a fresh dispatch
  6220. # as a continuation of the last FAILED job and never leaves IDLE (#1042).
  6221. # Modulo keeps uniqueness within a ~24-day wrap window; `or 1` guards
  6222. # the (astronomically unlikely) zero case since task_id=0 is rejected.
  6223. submission_id = str(int(time.time() * 1000) % 2_147_483_647 or 1)
  6224. # Remember it so on_print_start can persist a restart-stable id on
  6225. # the archive even before the printer echoes subtask_id back (#1485).
  6226. self.last_dispatch_subtask_id = submission_id
  6227. self.last_start_refusal = None
  6228. # Tri-state calibration options → BambuStudio's getValueInt encoding:
  6229. # off=0 (never), on=1 (force every print), auto=2 (printer runs it
  6230. # only if it wasn't done recently). The paired bool field is true
  6231. # only for the explicit "on" state — for "auto" the bool is false and
  6232. # the int carries the intent, exactly as BambuStudio's SelectMachine
  6233. # sends it. Unknown values fall back to auto.
  6234. _tristate_wire = {"off": 0, "on": 1, "auto": 2}
  6235. bed_level_int = _tristate_wire.get(bed_levelling, 2)
  6236. flow_cali_int = _tristate_wire.get(flow_cali, 2)
  6237. nozzle_cali_int = _tristate_wire.get(nozzle_offset_cali, 2)
  6238. command = {
  6239. "print": {
  6240. "sequence_id": "20000",
  6241. "command": "project_file",
  6242. "param": f"Metadata/plate_{plate_id}.gcode",
  6243. "url": f"ftp://{filename}",
  6244. "file": filename,
  6245. "md5": "",
  6246. "bed_type": "auto",
  6247. "timelapse": timelapse,
  6248. # bed_leveling stays a JSON bool (true only for "on") and
  6249. # auto_bed_leveling carries the tri-state int — the exact
  6250. # two-field shape BambuStudio sends. The int must stay a plain
  6251. # number, never quoted (#1478 boolean-family concern applies to
  6252. # the *_cali bools, not these companion ints).
  6253. "bed_leveling": bed_levelling == "on",
  6254. "auto_bed_leveling": bed_level_int,
  6255. "flow_cali": flow_cali == "on",
  6256. "vibration_cali": vibration_cali,
  6257. "layer_inspect": layer_inspect,
  6258. "use_ams": use_ams,
  6259. # No "cfg": it is the printer's device-config bitmask
  6260. # (auto-refill, detect-on-insert, chamber light, ...), not a
  6261. # per-job field — BambuStudio's PrintParams has no such
  6262. # member. We used to send "0"; firmware ignores it, but it
  6263. # comes straight back in the project_file ack (#3040).
  6264. # extrude_cali_flag gates flow-dynamics calibration:
  6265. # 0 = never, 1 = force every print, 2 = auto (run only if the
  6266. # filament wasn't calibrated recently). #1721 saw stage 8
  6267. # ("Calibrating dynamic flow") still queued when we send 2 —
  6268. # that is exactly the auto contract (the printer queues the
  6269. # stage and skips it at runtime if recent), not a bug, so 2 is
  6270. # the right wire value for "auto". off/on remain 0/1.
  6271. "extrude_cali_flag": flow_cali_int,
  6272. "extrude_cali_manual_mode": 0,
  6273. # 0 = never, 1 = force, 2 = auto (skip if recent). #1721 saw
  6274. # stage 39 ("Nozzle offset calibration") still queued on 2 —
  6275. # again the auto contract, not a failure to suppress.
  6276. # BambuStudio exposes the toggle only for dual-nozzle
  6277. # (H2D/H2D Pro/H2C/X2D); single-nozzle prints resolve to 0 so
  6278. # firmware never runs a calibration the head doesn't support.
  6279. "nozzle_offset_cali": nozzle_cali_int if is_dual_nozzle else 0,
  6280. "subtask_name": filename.replace(".3mf", "").replace(".gcode", ""),
  6281. "profile_id": "0",
  6282. "project_id": submission_id,
  6283. "subtask_id": submission_id,
  6284. "task_id": submission_id,
  6285. }
  6286. }
  6287. # P2S-specific parameter adjustments
  6288. # P2S printer doesn't support vibration calibration like X1/P1 series
  6289. if self.model and self.model.upper().strip() in ("P2S", "N7"):
  6290. command["print"]["vibration_cali"] = False
  6291. logger.debug("[%s] P2S detected: disabling vibration_cali", self.serial_number)
  6292. # Add AMS mapping if provided
  6293. if ams_mapping is not None:
  6294. command["print"]["ams_mapping"] = flat_ams_mapping
  6295. command["print"]["ams_mapping2"] = ams_mapping2
  6296. # H2C dual-nozzle-rack slicer-pick preservation (#1780).
  6297. # `nozzle_mapping` carries per-filament physical nozzle position
  6298. # IDs (`list[int]`), JSON-string-encoded when it leaves the queue
  6299. # item; parse here so the wire ships an array, matching
  6300. # BambuStudio's project_file shape. Gate by `is_dual_nozzle`
  6301. # defensively — single-nozzle firmwares would ignore the field
  6302. # but we err on the side of not emitting unrecognised fields. A
  6303. # parse failure is logged but never blocks the dispatch — the
  6304. # firmware will fall back to its auto-pick path, which is the
  6305. # pre-fix behaviour.
  6306. if is_dual_nozzle and nozzle_mapping:
  6307. try:
  6308. command["print"]["nozzle_mapping"] = json.loads(nozzle_mapping)
  6309. except json.JSONDecodeError:
  6310. logger.warning(
  6311. "[%s] Invalid nozzle_mapping JSON on dispatch, omitting from "
  6312. "project_file (firmware will auto-pick): %r",
  6313. self.serial_number,
  6314. nozzle_mapping,
  6315. )
  6316. # Nozzle-rack fallback (#2800). Only consulted when BambuStudio
  6317. # never saw the job, so it can never override a real capture. The
  6318. # queue stores extruder indices per filament slot; the physical
  6319. # rack position they resolve to is only knowable here, because the
  6320. # mounted hotend can change between queueing and dispatch.
  6321. if is_nozzle_rack_model(self.model) and nozzle_slot_extruders and "nozzle_mapping" not in command["print"]:
  6322. try:
  6323. slot_extruders = json.loads(nozzle_slot_extruders)
  6324. except (json.JSONDecodeError, TypeError):
  6325. # TypeError covers a caller handing us the list itself
  6326. # rather than its JSON — the field is opaque by contract,
  6327. # and a print must not die over the difference.
  6328. slot_extruders = None
  6329. logger.warning(
  6330. "[%s] Invalid nozzle_slot_extruders JSON on dispatch, "
  6331. "omitting nozzle_mapping (firmware will auto-pick): %r",
  6332. self.serial_number,
  6333. nozzle_slot_extruders,
  6334. )
  6335. if isinstance(slot_extruders, list):
  6336. rack_nozzle_id = (
  6337. self.state.nozzle_rack_tar_id
  6338. if self.state.nozzle_rack_tar_id in _RACK_NOZZLE_IDS
  6339. else self.state.nozzle_rack_src_id
  6340. )
  6341. resolved = resolve_rack_nozzle_mapping(slot_extruders, rack_nozzle_id)
  6342. if resolved is None:
  6343. logger.info(
  6344. "[%s] Nozzle rack slots %s not resolvable (tar_id=%s src_id=%s); "
  6345. "omitting nozzle_mapping so the firmware picks",
  6346. self.serial_number,
  6347. slot_extruders,
  6348. self.state.nozzle_rack_tar_id,
  6349. self.state.nozzle_rack_src_id,
  6350. )
  6351. else:
  6352. logger.info(
  6353. "[%s] Nozzle rack mapping: slots=%s rack_id=%s -> %s",
  6354. self.serial_number,
  6355. slot_extruders,
  6356. rack_nozzle_id,
  6357. resolved,
  6358. )
  6359. command["print"]["nozzle_mapping"] = resolved
  6360. logger.info("[%s] Sending print command: %s", self.serial_number, json.dumps(command))
  6361. # Remember this dispatch so its echo on the topic is recognised as
  6362. # ours rather than logged as a slicer's.
  6363. self._own_project_file_key = self._project_file_key(command["print"])
  6364. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  6365. # Record what we dispatched so /cover can pick the right plate
  6366. # thumbnail even when the printer's gcode_file echo is just the
  6367. # 3MF filename without a plate path (#1166). Match the same
  6368. # subtask_name shape we send so the comparison in the cover route
  6369. # works against state.subtask_name reflected back via MQTT.
  6370. self.state.dispatched_plate_id = plate_id
  6371. self.state.dispatched_subtask = command["print"]["subtask_name"]
  6372. return True
  6373. else:
  6374. # Log why we couldn't send the command
  6375. if not self._client:
  6376. logger.error("[%s] Cannot start print: MQTT client not initialized", self.serial_number)
  6377. elif not self.state.connected:
  6378. logger.error(
  6379. f"[{self.serial_number}] Cannot start print: Printer not connected (client exists but disconnected). "
  6380. f"Connection state: {self.state.connected}, Last message: {self._last_message_time}"
  6381. )
  6382. return False
  6383. def stop_print(self) -> bool:
  6384. """Stop the current print job."""
  6385. if self._client and self.state.connected:
  6386. command = {"print": {"command": "stop", "sequence_id": "0"}}
  6387. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  6388. logger.info("[%s] Sent stop print command", self.serial_number)
  6389. return True
  6390. return False
  6391. def set_xcam_option(
  6392. self, module_name: str, enabled: bool, print_halt: bool = True, sensitivity: str = "medium"
  6393. ) -> bool:
  6394. """Set an xcam (AI detection) option on the printer.
  6395. Args:
  6396. module_name: The xcam module to control (e.g., "spaghetti_detector",
  6397. "first_layer_inspector", "printing_monitor", "buildplate_marker_detector")
  6398. enabled: Whether to enable or disable the feature
  6399. print_halt: Whether to halt print on detection (only applies to some detectors)
  6400. sensitivity: Sensitivity level ("low", "medium", "high", or "never_halt")
  6401. Returns:
  6402. True if command was sent, False if not connected
  6403. """
  6404. if not self._client or not self.state.connected:
  6405. return False
  6406. # auto_recovery_step_loss uses a different command format (print.print_option)
  6407. if module_name == "auto_recovery_step_loss":
  6408. return self._set_print_option("auto_recovery", enabled)
  6409. self._sequence_id += 1
  6410. # Build the xcam control command (exact OrcaSlicer format)
  6411. # Key findings from OrcaSlicer source:
  6412. # - Uses "xcam" wrapper (not "print")
  6413. # - print_halt is ALWAYS true (legacy protocol requirement)
  6414. # - Both "control" and "enable" are set to the same value
  6415. # - halt_print_sensitivity controls actual halt behavior
  6416. command = {
  6417. "xcam": {
  6418. "command": "xcam_control_set",
  6419. "sequence_id": str(self._sequence_id),
  6420. "module_name": module_name,
  6421. "control": enabled,
  6422. "enable": enabled, # old protocol compatibility
  6423. "print_halt": True, # ALWAYS true per OrcaSlicer
  6424. }
  6425. }
  6426. # Only add sensitivity if not "never_halt"
  6427. # OrcaSlicer uses halt_print_sensitivity for ALL detectors
  6428. # The module_name field determines which detector's sensitivity is being set
  6429. if sensitivity and sensitivity != "never_halt":
  6430. command["xcam"]["halt_print_sensitivity"] = sensitivity
  6431. command_json = json.dumps(command)
  6432. self._client.publish(self.topic_publish, command_json, qos=1)
  6433. logger.debug(
  6434. "[%s] Set xcam option: %s=%s, sensitivity=%s", self.serial_number, module_name, enabled, sensitivity
  6435. )
  6436. logger.debug("[%s] MQTT command sent: %s", self.serial_number, command_json)
  6437. # OrcaSlicer pattern: Set hold timer to ignore incoming data for 3 seconds
  6438. # This prevents stale MQTT data from immediately overwriting our change
  6439. self._xcam_hold_start[module_name] = time.time()
  6440. # Update local state immediately for responsive UI
  6441. # NOTE: Spaghetti and Pileup sensitivities are linked in firmware
  6442. # When spaghetti_detector sensitivity is changed, pileup also changes
  6443. if module_name == "spaghetti_detector":
  6444. self.state.print_options.spaghetti_detector = enabled
  6445. self.state.print_options.print_halt = print_halt
  6446. if sensitivity and sensitivity != "never_halt":
  6447. # spaghetti_detector controls BOTH spaghetti and pileup sensitivities
  6448. self.state.print_options.halt_print_sensitivity = sensitivity
  6449. self.state.print_options.pileup_sensitivity = sensitivity
  6450. self._xcam_hold_start["halt_print_sensitivity"] = time.time()
  6451. self._xcam_hold_start["pileup_sensitivity"] = time.time()
  6452. elif module_name == "first_layer_inspector":
  6453. self.state.print_options.first_layer_inspector = enabled
  6454. elif module_name == "printing_monitor":
  6455. self.state.print_options.printing_monitor = enabled
  6456. elif module_name == "buildplate_marker_detector":
  6457. self.state.print_options.buildplate_marker_detector = enabled
  6458. elif module_name == "allow_skip_parts":
  6459. self.state.print_options.allow_skip_parts = enabled
  6460. elif module_name == "pileup_detector":
  6461. self.state.print_options.pileup_detector = enabled
  6462. # Pileup sensitivity is linked to spaghetti - both are set via spaghetti_detector
  6463. elif module_name == "clump_detector":
  6464. self.state.print_options.nozzle_clumping_detector = enabled
  6465. if sensitivity and sensitivity != "never_halt":
  6466. self.state.print_options.nozzle_clumping_sensitivity = sensitivity
  6467. self._xcam_hold_start["nozzle_clumping_sensitivity"] = time.time()
  6468. elif module_name == "airprint_detector":
  6469. self.state.print_options.airprint_detector = enabled
  6470. if sensitivity and sensitivity != "never_halt":
  6471. self.state.print_options.airprint_sensitivity = sensitivity
  6472. self._xcam_hold_start["airprint_sensitivity"] = time.time()
  6473. elif module_name == "auto_recovery_step_loss":
  6474. self.state.print_options.auto_recovery_step_loss = enabled
  6475. return True
  6476. def _set_print_option(self, option_name: str, enabled: bool) -> bool:
  6477. """Set a print option using the print.print_option command.
  6478. This is different from xcam_control_set and is used for options like:
  6479. - auto_recovery
  6480. - air_print_detect
  6481. - filament_tangle_detect
  6482. - nozzle_blob_detect
  6483. - sound_enable
  6484. Args:
  6485. option_name: The option to control (e.g., "auto_recovery")
  6486. enabled: Whether to enable or disable the option
  6487. Returns:
  6488. True if command was sent, False if not connected
  6489. """
  6490. if not self._client or not self.state.connected:
  6491. return False
  6492. self._sequence_id += 1
  6493. command = {
  6494. "print": {
  6495. "command": "print_option",
  6496. "sequence_id": str(self._sequence_id),
  6497. option_name: enabled,
  6498. }
  6499. }
  6500. command_json = json.dumps(command)
  6501. self._client.publish(self.topic_publish, command_json, qos=1)
  6502. logger.debug("[%s] Set print option: %s=%s", self.serial_number, option_name, enabled)
  6503. # Set hold timer
  6504. hold_key = f"print_option_{option_name}"
  6505. self._xcam_hold_start[hold_key] = time.time()
  6506. # Update local state immediately
  6507. if option_name == "auto_recovery":
  6508. self.state.print_options.auto_recovery_step_loss = enabled
  6509. elif option_name == "auto_switch_filament":
  6510. self.state.ams_filament_backup = enabled
  6511. return True
  6512. def set_ams_filament_backup(self, enabled: bool) -> bool:
  6513. """Toggle AMS Filament Backup (a.k.a. auto-switch / auto-refill).
  6514. Mirrors BambuStudio's "AMS Filament Backup" checkbox. Verified payload
  6515. shape from H2D capture 2026-06-20.
  6516. """
  6517. return self._set_print_option("auto_switch_filament", enabled)
  6518. def start_calibration(
  6519. self,
  6520. bed_leveling: bool = False,
  6521. vibration: bool = False,
  6522. motor_noise: bool = False,
  6523. nozzle_offset: bool = False,
  6524. high_temp_heatbed: bool = False,
  6525. ) -> bool:
  6526. """Start printer calibration with selected options.
  6527. Args:
  6528. bed_leveling: Run bed leveling calibration
  6529. vibration: Run vibration compensation calibration
  6530. motor_noise: Run motor noise cancellation calibration
  6531. nozzle_offset: Run nozzle offset calibration (dual nozzle printers)
  6532. high_temp_heatbed: Run high-temperature heatbed calibration
  6533. Returns:
  6534. True if command was sent, False if not connected
  6535. """
  6536. if not self._client or not self.state.connected:
  6537. return False
  6538. # Build calibration bitmask based on OrcaSlicer DeviceManager.cpp
  6539. # Bit 0: xcam_cali (not exposed in UI)
  6540. # Bit 1: bed_leveling
  6541. # Bit 2: vibration
  6542. # Bit 3: motor_noise
  6543. # Bit 4: nozzle_cali
  6544. # Bit 5: bed_cali (high-temp heatbed)
  6545. # Bit 6: clumppos_cali (not exposed in UI)
  6546. option = 0
  6547. if bed_leveling:
  6548. option |= 1 << 1
  6549. if vibration:
  6550. option |= 1 << 2
  6551. if motor_noise:
  6552. option |= 1 << 3
  6553. if nozzle_offset:
  6554. option |= 1 << 4
  6555. if high_temp_heatbed:
  6556. option |= 1 << 5
  6557. if option == 0:
  6558. logger.warning("[%s] No calibration options selected", self.serial_number)
  6559. return False
  6560. self._sequence_id += 1
  6561. command = {
  6562. "print": {
  6563. "command": "calibration",
  6564. "sequence_id": str(self._sequence_id),
  6565. "option": option,
  6566. }
  6567. }
  6568. command_json = json.dumps(command)
  6569. self._client.publish(self.topic_publish, command_json, qos=1)
  6570. logger.info(
  6571. f"[{self.serial_number}] Starting calibration: "
  6572. f"bed_leveling={bed_leveling}, vibration={vibration}, "
  6573. f"motor_noise={motor_noise}, nozzle_offset={nozzle_offset}, "
  6574. f"high_temp_heatbed={high_temp_heatbed} (option={option})"
  6575. )
  6576. return True
  6577. def disconnect(self, timeout: float = 0):
  6578. """Disconnect from the printer.
  6579. Waits up to *timeout* for paho to report the disconnect, then lets the
  6580. client go without joining its network thread — the callers are route
  6581. handlers (printer edited, deleted, disconnected by hand) running on the
  6582. asyncio thread, and that join has no bound (#3068)."""
  6583. if self._client:
  6584. old_client = self._client
  6585. self._disconnection_event = threading.Event()
  6586. old_client.disconnect()
  6587. # The callback that sets this fires on paho's thread, so it has to
  6588. # be given its window before retire_paho_client detaches it.
  6589. self._disconnection_event.wait(timeout=timeout)
  6590. self._client = None
  6591. retire_paho_client(old_client, self.serial_number)
  6592. self.state.connected = False
  6593. # Deliberately no on_state_change here. paho's disconnect callback
  6594. # used to land during the join, but `_on_disconnect` suppresses
  6595. # itself for a clean disconnect of a printer that reported within
  6596. # the last 10s -- which is every healthy printer -- so a
  6597. # hand-disconnected printer never broadcast one. Announcing it now
  6598. # would fire the connected→disconnected edge in
  6599. # `on_printer_status_change` and notify the user their printer went
  6600. # offline a minute after they disconnected it on purpose (#1752).
  6601. # The callers drop the client from the manager anyway, so the next
  6602. # status read already shows it gone.
  6603. def enable_logging(self, enabled: bool = True):
  6604. """Enable or disable MQTT message logging."""
  6605. self._logging_enabled = enabled
  6606. # Don't clear logs when stopping - user can manually clear with clear_logs()
  6607. def get_logs(self) -> list[MQTTLogEntry]:
  6608. """Get all logged MQTT messages."""
  6609. return list(self._message_log)
  6610. def clear_logs(self):
  6611. """Clear the message log."""
  6612. self._message_log.clear()
  6613. @property
  6614. def logging_enabled(self) -> bool:
  6615. """Check if logging is enabled."""
  6616. return self._logging_enabled
  6617. def register_raw_message_handler(self, handler: Callable[[str, bytes], None]) -> None:
  6618. """Register a handler invoked for every incoming MQTT message.
  6619. Used by the VP MQTT bridge to republish the printer's report pushes to
  6620. slicers connected to a virtual printer in non-proxy mode. Handlers run
  6621. on paho's network thread and must not block; exceptions are caught.
  6622. """
  6623. if handler not in self._raw_message_handlers:
  6624. self._raw_message_handlers.append(handler)
  6625. def unregister_raw_message_handler(self, handler: Callable[[str, bytes], None]) -> None:
  6626. """Unregister a previously-registered raw-message handler."""
  6627. try:
  6628. self._raw_message_handlers.remove(handler)
  6629. except ValueError:
  6630. pass
  6631. def publish_raw(self, topic: str, payload: bytes | str, qos: int = 1) -> bool:
  6632. """Publish a pre-formed payload directly to the printer's MQTT broker.
  6633. Used by the VP MQTT bridge to forward slicer-originated commands without
  6634. giving it one of our own sequence ids. Returns False if the
  6635. underlying paho client isn't ready.
  6636. """
  6637. if self._client is None:
  6638. return False
  6639. try:
  6640. info = self._client.publish(topic, payload, qos=qos)
  6641. return info.rc == mqtt.MQTT_ERR_SUCCESS
  6642. except Exception:
  6643. logger.exception("[%s] publish_raw failed for topic=%s", self.serial_number, topic)
  6644. return False
  6645. def _ams3h_drying_zone_id(self, ams_id: int) -> int:
  6646. """The drying zone id of AMS 3H unit ``ams_id`` from the last status, else 0."""
  6647. unit = self._ams_unit(ams_id)
  6648. return _mqtt_int((unit or {}).get("dry_zone_id")) or 0
  6649. def send_drying_command(
  6650. self, ams_id: int, temp: int, duration: int, mode: int = 1, filament: str = "", rotate_tray: bool = False
  6651. ):
  6652. """Send AMS drying start/stop command.
  6653. Args:
  6654. ams_id: AMS unit ID (0-3 for AMS 2 Pro, 128-135 for AMS-HT)
  6655. temp: Target drying temperature (45-65 for AMS 2 Pro, 45-85 for AMS-HT)
  6656. duration: Drying duration in hours
  6657. mode: 1=start, 0=stop
  6658. filament: Filament type string (e.g. "PLA", "PETG")
  6659. rotate_tray: Whether to rotate the spool during drying for even heat
  6660. """
  6661. if not self._client:
  6662. return False
  6663. self._sequence_id += 1
  6664. # A2L AMS-Lite: normalised id 6 -> physical 16 on the wire (the Lite does
  6665. # not actually support drying, but keep the translation consistent). The
  6666. # _drying_targets dict below stays keyed by the normalised id so the
  6667. # on_drying_complete callback matches the telemetry.
  6668. wire_ams_id = a2l_lite_wire_ids(ams_id, 0)[0] if ams_id == A2L_LITE_NORMALIZED_AMS_ID else ams_id
  6669. ams3h = self._rack_ams_type(ams_id) == AmsType.ZMULTI_A
  6670. command = {
  6671. "print": {
  6672. "sequence_id": str(self._sequence_id),
  6673. "command": "ams_filament_drying",
  6674. "ams_id": wire_ams_id,
  6675. "temp": temp,
  6676. "cooling_temp": 20 if mode == 1 else 0,
  6677. "duration": duration,
  6678. "humidity": 0,
  6679. "mode": mode,
  6680. "rotate_tray": rotate_tray,
  6681. "filament": filament,
  6682. "close_power_conflict": False,
  6683. }
  6684. }
  6685. if ams3h:
  6686. # As Studio 02.09 sends it (DevFilaSystemCtrl.cpp): a start names
  6687. # the drying zone and cooling_temp; a stop names no zone. The AMS 3H
  6688. # can't turn spools.
  6689. command["print"]["rotate_tray"] = False
  6690. if mode == 1:
  6691. command["print"]["zone_id"] = self._ams3h_drying_zone_id(ams_id)
  6692. command["print"]["cooling_temp"] = ams3h_drying_cooling_temp(filament)
  6693. # Log the full wire JSON at INFO so support bundles capture exactly
  6694. # what we sent — needed to diagnose silent rejections (#1447) where
  6695. # the printer ACKs the command but never starts/stops drying.
  6696. # Paired with the ams_filament_drying response-payload INFO log so
  6697. # both halves of the conversation land in the bundle by default.
  6698. wire_json = json.dumps(command)
  6699. self._client.publish(self.topic_publish, wire_json, qos=1)
  6700. logger.info(
  6701. "[%s] Sent ams_filament_drying: %s",
  6702. self.serial_number,
  6703. wire_json,
  6704. )
  6705. # Track the active-cycle target so the badge can show "PETG @ 65°C"
  6706. # while drying. Bambu only echoes dry_time on subsequent pushes.
  6707. # duration_hours is not shown anywhere; it is what lets the cycle-end log
  6708. # say how much of the requested time the firmware actually ran (#2770).
  6709. if mode == 1:
  6710. self._drying_targets[ams_id] = {
  6711. "filament": filament or "",
  6712. "temp": int(temp),
  6713. "duration_hours": int(duration),
  6714. }
  6715. self._drying_stops_sent.discard(ams_id)
  6716. # A start sent while a cycle is still counting down replaces it
  6717. # without dry_time passing through 0; begin a fresh record so the
  6718. # new target and length are the ones reported (#2863).
  6719. self._dry_cycles.pop(ams_id, None)
  6720. else:
  6721. self._drying_targets.pop(ams_id, None)
  6722. # Remember that this cycle's end is ours, so the cycle-end log
  6723. # attributes it to Bambuddy instead of to the firmware (#2770). A
  6724. # stop always ends the cycle far short of its duration, which is
  6725. # otherwise indistinguishable from the firmware abandoning it.
  6726. self._drying_stops_sent.add(ams_id)
  6727. return True
  6728. @staticmethod
  6729. def _parse_kprofile_entries(filaments: list, response_nozzle: str | None, log_errors: bool) -> list[KProfile]:
  6730. """Build KProfile objects from an ``extrusion_cali_get`` filaments array.
  6731. The printer reports ``nozzle_diameter`` **only on the response
  6732. envelope** — the per-filament entries carry just setting_id,
  6733. filament_id, name, k_value, n_coef and cali_idx. Defaulting the
  6734. per-entry lookup to "0.4" therefore stamped every profile 0.4mm on
  6735. single-nozzle printers regardless of the installed nozzle (#1748),
  6736. which broke the K-Profiles display and, worse, the cali_idx cascade
  6737. in the inventory/Spoolman assign paths that matches on
  6738. nozzle_diameter. Fall back to the envelope value instead, and only
  6739. to "0.4" when the envelope has none either.
  6740. ``or`` rather than a dict default on purpose: it also covers an entry
  6741. that carries the key with an empty value, and stops ``str()`` turning
  6742. a missing envelope value into the literal "None".
  6743. """
  6744. profiles: list[KProfile] = []
  6745. for i, f in enumerate(filaments):
  6746. if not isinstance(f, dict):
  6747. continue
  6748. try:
  6749. profiles.append(
  6750. KProfile(
  6751. # cali_idx is the actual slot/calibration index from the printer
  6752. slot_id=f.get("cali_idx", i),
  6753. extruder_id=int(f.get("extruder_id", 0)),
  6754. nozzle_id=str(f.get("nozzle_id", "")),
  6755. nozzle_diameter=str(f.get("nozzle_diameter") or response_nozzle or "0.4"),
  6756. filament_id=str(f.get("filament_id", "")),
  6757. name=str(f.get("name", "")),
  6758. k_value=str(f.get("k_value", "0.000000")),
  6759. n_coef=str(f.get("n_coef", "0.000000")),
  6760. ams_id=int(f.get("ams_id", 0)),
  6761. tray_id=int(f.get("tray_id", -1)),
  6762. setting_id=f.get("setting_id"),
  6763. )
  6764. )
  6765. except (ValueError, TypeError) as e:
  6766. # Skip malformed entries; the remaining profiles stay usable.
  6767. # Unsolicited broadcasts arrive constantly, so only a response
  6768. # someone is actually waiting on is worth a warning.
  6769. if log_errors:
  6770. logger.warning("Failed to parse K-profile: %s", e)
  6771. else:
  6772. logger.debug("Failed to parse K-profile from broadcast: %s", e)
  6773. return profiles
  6774. def _store_kprofiles(self, profiles: list, response_nozzle: str | None) -> None:
  6775. """File one calibration-table response under its nozzle diameter.
  6776. ``response_nozzle`` names the table the printer just sent, so that
  6777. bucket is replaced wholesale and every other one is left alone. When
  6778. the envelope carries no diameter, fall back to the diameters the parsed
  6779. profiles claim for themselves — and if there are none of those either,
  6780. keep what we have rather than dropping a table we cannot attribute.
  6781. ``state.kprofiles`` stays a flat list because that is what its readers
  6782. expect; the three assign paths already filter it by ``nozzle_diameter``
  6783. and were quietly finding nothing whenever the last response happened to
  6784. be for a different nozzle.
  6785. """
  6786. buckets: dict[str, list] = {}
  6787. if response_nozzle:
  6788. buckets[str(response_nozzle)] = list(profiles)
  6789. else:
  6790. for profile in profiles:
  6791. buckets.setdefault(str(profile.nozzle_diameter), []).append(profile)
  6792. if not buckets:
  6793. return
  6794. self._kprofiles_by_nozzle.update(buckets)
  6795. self.state.kprofiles = [
  6796. kp for nozzle in sorted(self._kprofiles_by_nozzle) for kp in self._kprofiles_by_nozzle[nozzle]
  6797. ]
  6798. def _handle_kprofile_response(self, data: dict):
  6799. """Handle K-profile response from printer."""
  6800. response_nozzle = data.get("nozzle_diameter")
  6801. response_seq_id = str(data.get("sequence_id", ""))
  6802. filaments = data.get("filaments", [])
  6803. # Snapshot the map: the asyncio thread adds and removes entries while
  6804. # this MQTT callback thread walks it.
  6805. pending = dict(self._pending_kprofile_requests)
  6806. request = pending.get(response_seq_id)
  6807. if request is None and pending:
  6808. # Firmware that doesn't echo our sequence_id still has to be
  6809. # served, so fall back to the pre-#1748 rule of matching on the
  6810. # nozzle size. Only requests still waiting are eligible, and the
  6811. # sequence_id lookup above has already claimed any response that
  6812. # identifies itself, so this can no longer hand request A's
  6813. # answer to request B when both are in flight.
  6814. request = next(
  6815. (r for r in pending.values() if r["nozzle"] == response_nozzle and r["profiles"] is None),
  6816. None,
  6817. )
  6818. if pending:
  6819. logger.info(
  6820. "[%s] K-profile response: nozzle=%s, seq_id=%s, %d profiles, matched=%s",
  6821. self.serial_number,
  6822. response_nozzle,
  6823. response_seq_id or "?",
  6824. len(filaments),
  6825. request is not None,
  6826. )
  6827. if request is None and pending:
  6828. # A request is outstanding and this isn't its answer. The printer
  6829. # broadcasts extrusion_cali_get unsolicited, so letting this
  6830. # through would replace state.kprofiles with another nozzle's
  6831. # profiles while the caller is still waiting.
  6832. logger.debug(
  6833. "[%s] Ignoring unmatched K-profile response: nozzle=%s, seq_id=%s",
  6834. self.serial_number,
  6835. response_nozzle,
  6836. response_seq_id or "?",
  6837. )
  6838. return
  6839. profiles = self._parse_kprofile_entries(filaments, response_nozzle, log_errors=request is not None)
  6840. self._store_kprofiles(profiles, response_nozzle)
  6841. if request is None:
  6842. # Unsolicited broadcast with nothing in flight: state is refreshed,
  6843. # nobody to wake. Worth a line — this is the printer answering
  6844. # somebody else (BambuStudio queries the same report topic), and
  6845. # until it was bucketed by nozzle it was also the quietest way for
  6846. # the AMS card's K values to change underneath us.
  6847. logger.debug(
  6848. "[%s] Adopted unsolicited K-profile table: nozzle=%s, %d profiles",
  6849. self.serial_number,
  6850. response_nozzle or "?",
  6851. len(profiles),
  6852. )
  6853. return
  6854. logger.info("[%s] Got %s K-profiles for nozzle=%s", self.serial_number, len(profiles), response_nozzle)
  6855. request["profiles"] = profiles
  6856. # Signal the waiter. Use the thread-safe path since MQTT callbacks run
  6857. # in a different thread than the event loop.
  6858. event = request["event"]
  6859. if self._loop and self._loop.is_running():
  6860. self._loop.call_soon_threadsafe(event.set)
  6861. else:
  6862. # Fallback for when loop is not available
  6863. event.set()
  6864. async def get_kprofiles(
  6865. self, nozzle_diameter: str = "0.4", timeout: float = 5.0, max_retries: int = 3
  6866. ) -> list[KProfile]:
  6867. """Request K-profiles from the printer with retry logic.
  6868. Bambu printers sometimes ignore the first K-profile request, so we
  6869. implement retry logic to ensure reliable retrieval.
  6870. Args:
  6871. nozzle_diameter: Filter by nozzle diameter (e.g., "0.4")
  6872. timeout: Timeout in seconds to wait for each response attempt
  6873. max_retries: Maximum number of retry attempts
  6874. Returns:
  6875. List of KProfile objects; empty when the printer has none for
  6876. the nozzle.
  6877. Raises:
  6878. KProfileReadError: not connected, or no answer to any attempt.
  6879. Returning an empty list made that a printer without profiles
  6880. (#3404).
  6881. """
  6882. if not self._client or not self.state.connected:
  6883. logger.warning("[%s] Cannot get K-profiles: not connected", self.serial_number)
  6884. raise KProfileReadError("Printer not connected")
  6885. # Capture current event loop for thread-safe callback
  6886. try:
  6887. self._loop = asyncio.get_running_loop()
  6888. except RuntimeError:
  6889. logger.warning("[%s] No running event loop", self.serial_number)
  6890. raise KProfileReadError("No running event loop") from None
  6891. for attempt in range(max_retries):
  6892. # Register this attempt under its own sequence_id so a concurrent
  6893. # request for a different nozzle size can't consume its response
  6894. # (#1748) — the pending map is keyed by exactly the id we send.
  6895. self._sequence_id += 1
  6896. seq_id = str(self._sequence_id)
  6897. request: dict = {"nozzle": nozzle_diameter, "event": asyncio.Event(), "profiles": None}
  6898. self._pending_kprofile_requests[seq_id] = request
  6899. # Send the command with nozzle_diameter filter
  6900. command = {
  6901. "print": {
  6902. "command": "extrusion_cali_get",
  6903. "filament_id": "",
  6904. "nozzle_diameter": nozzle_diameter,
  6905. "sequence_id": seq_id,
  6906. }
  6907. }
  6908. logger.info(
  6909. f"[{self.serial_number}] Requesting K-profiles for nozzle_diameter={nozzle_diameter} (attempt {attempt + 1}/{max_retries}, seq_id={seq_id})"
  6910. )
  6911. logger.debug("[%s] K-profile request JSON: %s", self.serial_number, json.dumps(command))
  6912. # Wait for the response (the handler matches it back to this entry)
  6913. try:
  6914. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  6915. await asyncio.wait_for(request["event"].wait(), timeout=timeout)
  6916. profiles = request["profiles"] or []
  6917. logger.info(
  6918. f"[{self.serial_number}] Got {len(profiles)} K-profiles for nozzle={nozzle_diameter} on attempt {attempt + 1}"
  6919. )
  6920. return profiles
  6921. except TimeoutError:
  6922. logger.warning(
  6923. f"[{self.serial_number}] Timeout on K-profiles request attempt {attempt + 1}/{max_retries}"
  6924. )
  6925. if attempt < max_retries - 1:
  6926. # Brief delay before retry
  6927. await asyncio.sleep(0.5)
  6928. finally:
  6929. self._pending_kprofile_requests.pop(seq_id, None)
  6930. logger.error("[%s] Failed to get K-profiles after %s attempts", self.serial_number, max_retries)
  6931. raise KProfileReadError("The printer did not answer the K-profile request")
  6932. def _publish_cali_write(self, command: dict, seq_id: str) -> bool:
  6933. """Publish a K-profile write and arm its ack slot.
  6934. Registration happens before the publish because the printer answers in
  6935. well under a second — measured at 70-150ms — which is comfortably
  6936. before an async caller gets back to awaiting.
  6937. """
  6938. self._pending_cali_acks[seq_id] = None
  6939. try:
  6940. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  6941. except Exception:
  6942. self._pending_cali_acks.pop(seq_id, None)
  6943. raise
  6944. return True
  6945. async def await_cali_ack(self, seq_id: str, timeout: float = 6.0) -> tuple[bool, str]:
  6946. """Wait for the printer's verdict on a K-profile write.
  6947. Returns ``(ok, detail)``. ``ok`` is False only when the printer
  6948. explicitly said ``result: "fail"`` — a timeout returns True with a
  6949. detail string, because "no answer" is not evidence of rejection and
  6950. older firmware may not answer at all. Callers that need certainty read
  6951. the calibration table back.
  6952. Polled rather than event-driven on purpose: the ack is filled in by the
  6953. MQTT callback thread, and polling a dict costs one lookup every 50ms
  6954. for at most a few hundred milliseconds, against the cross-thread
  6955. event plumbing it would otherwise take.
  6956. """
  6957. deadline = time.monotonic() + timeout
  6958. try:
  6959. while time.monotonic() < deadline:
  6960. ack = self._pending_cali_acks.get(seq_id)
  6961. if ack is not None:
  6962. result = str(ack.get("result", "")).lower()
  6963. reason = str(ack.get("reason", "") or "")
  6964. if result == "fail":
  6965. return (False, reason or "printer reported failure")
  6966. return (True, reason)
  6967. await asyncio.sleep(0.05)
  6968. finally:
  6969. self._pending_cali_acks.pop(seq_id, None)
  6970. logger.warning("[%s] No ack for K-profile write seq=%s within %.1fs", self.serial_number, seq_id, timeout)
  6971. return (True, CALI_ACK_UNCONFIRMED)
  6972. def set_kprofile(
  6973. self,
  6974. filament_id: str,
  6975. name: str,
  6976. k_value: str,
  6977. nozzle_diameter: str = "0.4",
  6978. nozzle_id: str = "HS00-0.4",
  6979. extruder_id: int = 0,
  6980. setting_id: str | None = None,
  6981. slot_id: int = 0,
  6982. cali_idx: int | None = None,
  6983. ) -> str | None:
  6984. """Set/update a K-profile on the printer.
  6985. Args:
  6986. filament_id: Bambu filament identifier
  6987. name: Profile name
  6988. k_value: Pressure advance value (e.g., "0.020000")
  6989. nozzle_diameter: Nozzle diameter (e.g., "0.4")
  6990. nozzle_id: Nozzle identifier (e.g., "HS00-0.4")
  6991. extruder_id: Extruder ID (0 or 1 for dual nozzle)
  6992. setting_id: Existing setting ID for updates, None for new
  6993. slot_id: Calibration index (cali_idx) for the profile
  6994. cali_idx: For edits, the existing slot being edited (enables in-place edit)
  6995. Returns:
  6996. The sequence_id the command was sent under, so the caller can
  6997. await the printer's verdict via await_cali_ack. None if the
  6998. command could not be sent.
  6999. """
  7000. if not self._client or not self.state.connected:
  7001. logger.warning("[%s] Cannot set K-profile: not connected", self.serial_number)
  7002. return None
  7003. self._sequence_id += 1
  7004. seq_id = str(self._sequence_id)
  7005. # Build the filament entry - printer uses cali_idx for profile identification
  7006. # For new profiles (slot_id=0), use cali_idx=-1 to tell printer to create new slot
  7007. # For edits, use the provided cali_idx or slot_id
  7008. if cali_idx is not None:
  7009. effective_cali_idx = cali_idx
  7010. else:
  7011. effective_cali_idx = -1 if slot_id == 0 else slot_id
  7012. # Generate a setting_id for new profiles (required by printer)
  7013. # Format: "PF" + 17 random digits
  7014. import random
  7015. if not setting_id and slot_id == 0:
  7016. setting_id = f"PF{random.randint(10000000000000000, 99999999999999999)}"
  7017. filament_entry = {
  7018. "ams_id": 0,
  7019. "cali_idx": effective_cali_idx,
  7020. "extruder_id": extruder_id,
  7021. "filament_id": filament_id,
  7022. "k_value": k_value,
  7023. "n_coef": "0.000000",
  7024. "name": name,
  7025. "nozzle_diameter": nozzle_diameter,
  7026. "nozzle_id": nozzle_id,
  7027. "setting_id": setting_id if setting_id else "",
  7028. # 0, not -1. Single-nozzle firmware validates this field and
  7029. # answers `result: "fail", reason: "invalid tray_id"` to -1 — while
  7030. # applying the write anyway, so the rejection looked like noise.
  7031. # Measured on an X1C: flipping only this value turns the ack into
  7032. # `success` (#2718). BambuStudio always sends a real tray_id and
  7033. # defaults it to 0 for a manually entered profile.
  7034. "tray_id": 0,
  7035. }
  7036. command = {
  7037. "print": {
  7038. "command": "extrusion_cali_set",
  7039. "filaments": [filament_entry],
  7040. "nozzle_diameter": nozzle_diameter,
  7041. "sequence_id": seq_id,
  7042. }
  7043. }
  7044. command_json = json.dumps(command)
  7045. logger.info(
  7046. f"[{self.serial_number}] Setting K-profile: {name} = {k_value} (cali_idx={effective_cali_idx}, new={slot_id == 0})"
  7047. )
  7048. logger.debug("[%s] K-profile SET command: %s", self.serial_number, command_json)
  7049. self._publish_cali_write(command, seq_id)
  7050. return seq_id
  7051. def set_kprofiles_batch(
  7052. self,
  7053. profiles: list[dict],
  7054. nozzle_diameter: str = "0.4",
  7055. ) -> str | None:
  7056. """Set multiple K-profiles in a single command (for dual-nozzle).
  7057. Args:
  7058. profiles: List of profile dicts, each with:
  7059. - filament_id, name, k_value, nozzle_id, extruder_id, setting_id (optional), slot_id
  7060. nozzle_diameter: Common nozzle diameter for all profiles
  7061. Returns:
  7062. The sequence_id the command was sent under (see set_kprofile),
  7063. or None if it could not be sent.
  7064. """
  7065. if not self._client or not self.state.connected:
  7066. logger.warning("[%s] Cannot set K-profiles batch: not connected", self.serial_number)
  7067. return None
  7068. import random
  7069. self._sequence_id += 1
  7070. seq_id = str(self._sequence_id)
  7071. filament_entries = []
  7072. for p in profiles:
  7073. slot_id = p.get("slot_id", 0)
  7074. cali_idx = p.get("cali_idx")
  7075. if cali_idx is not None:
  7076. effective_cali_idx = cali_idx
  7077. else:
  7078. effective_cali_idx = -1 if slot_id == 0 else slot_id
  7079. setting_id = p.get("setting_id")
  7080. if not setting_id and slot_id == 0:
  7081. setting_id = f"PF{random.randint(10000000000000000, 99999999999999999)}"
  7082. filament_entries.append(
  7083. {
  7084. "ams_id": 0,
  7085. "cali_idx": effective_cali_idx,
  7086. "extruder_id": p.get("extruder_id", 0),
  7087. "filament_id": p.get("filament_id", ""),
  7088. "k_value": p.get("k_value", "0.020000"),
  7089. "n_coef": "0.000000",
  7090. "name": p.get("name", ""),
  7091. "nozzle_diameter": nozzle_diameter,
  7092. "nozzle_id": p.get("nozzle_id", f"HS00-{nozzle_diameter}"),
  7093. "setting_id": setting_id if setting_id else "",
  7094. # See set_kprofile: -1 is rejected as "invalid tray_id" by
  7095. # single-nozzle firmware even though the write lands (#2718).
  7096. "tray_id": 0,
  7097. }
  7098. )
  7099. command = {
  7100. "print": {
  7101. "command": "extrusion_cali_set",
  7102. "filaments": filament_entries,
  7103. "nozzle_diameter": nozzle_diameter,
  7104. "sequence_id": seq_id,
  7105. }
  7106. }
  7107. command_json = json.dumps(command)
  7108. logger.info("[%s] Setting %s K-profiles in batch", self.serial_number, len(filament_entries))
  7109. logger.debug("[%s] K-profile SET batch command: %s", self.serial_number, command_json)
  7110. self._publish_cali_write(command, seq_id)
  7111. return seq_id
  7112. def delete_kprofile(
  7113. self,
  7114. cali_idx: int,
  7115. filament_id: str,
  7116. nozzle_id: str,
  7117. nozzle_diameter: str = "0.4",
  7118. extruder_id: int = 0,
  7119. setting_id: str | None = None,
  7120. ) -> str | None:
  7121. """Delete a K-profile from the printer.
  7122. Args:
  7123. cali_idx: The calibration index (slot_id) of the profile to delete
  7124. filament_id: Bambu filament identifier
  7125. nozzle_id: Nozzle identifier (e.g., "HH00-0.4")
  7126. nozzle_diameter: Nozzle diameter (e.g., "0.4")
  7127. extruder_id: Extruder ID (0 or 1 for dual nozzle)
  7128. setting_id: Unique setting identifier (for X1C series)
  7129. Returns:
  7130. The sequence_id the command was sent under (see set_kprofile),
  7131. or None if it could not be sent.
  7132. """
  7133. if not self._client or not self.state.connected:
  7134. logger.warning("[%s] Cannot delete K-profile: not connected", self.serial_number)
  7135. return None
  7136. self._sequence_id += 1
  7137. seq_id = str(self._sequence_id)
  7138. # Dual-nozzle K-profile delete uses the extruder_id/nozzle_id format;
  7139. # single-nozzle printers (X1C/P1/A1/P2S/H2S) need the setting_id form.
  7140. # Prefer runtime detection from device.extruder.info; fall back to
  7141. # model name. H2S is single-nozzle but shares serial prefix "094" with
  7142. # H2D, so a prefix-only check misclassified it (#1386).
  7143. from backend.app.utils.printer_models import is_dual_nozzle_model
  7144. is_dual_nozzle = self._is_dual_nozzle or is_dual_nozzle_model(self.model)
  7145. if is_dual_nozzle:
  7146. # H2D format: uses extruder_id, nozzle_id, nozzle_diameter
  7147. command = {
  7148. "print": {
  7149. "command": "extrusion_cali_del",
  7150. "sequence_id": seq_id,
  7151. "extruder_id": extruder_id,
  7152. "nozzle_id": nozzle_id,
  7153. "filament_id": filament_id,
  7154. "cali_idx": cali_idx,
  7155. "nozzle_diameter": nozzle_diameter,
  7156. }
  7157. }
  7158. else:
  7159. # X1C/P1/A1 format: include all fields like the set command
  7160. # The delete command structure should match what set uses
  7161. command = {
  7162. "print": {
  7163. "command": "extrusion_cali_del",
  7164. "sequence_id": seq_id,
  7165. "filament_id": filament_id,
  7166. "cali_idx": cali_idx,
  7167. "setting_id": setting_id if setting_id else "",
  7168. "nozzle_diameter": nozzle_diameter,
  7169. "nozzle_id": nozzle_id,
  7170. "extruder_id": extruder_id,
  7171. }
  7172. }
  7173. command_json = json.dumps(command)
  7174. logger.info(
  7175. f"[{self.serial_number}] Deleting K-profile: cali_idx={cali_idx}, filament={filament_id}, setting_id={setting_id}, dual={is_dual_nozzle}"
  7176. )
  7177. logger.debug("[%s] K-profile DELETE command: %s", self.serial_number, command_json)
  7178. # QoS 1 for reliable delivery (at least once)
  7179. self._publish_cali_write(command, seq_id)
  7180. return seq_id
  7181. # =========================================================================
  7182. # Printer Control Commands
  7183. # =========================================================================
  7184. def pause_print(self) -> bool:
  7185. """Pause the current print job."""
  7186. if not self._client or not self.state.connected:
  7187. logger.warning("[%s] Cannot pause print: not connected", self.serial_number)
  7188. return False
  7189. command = {"print": {"command": "pause", "sequence_id": "0"}}
  7190. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7191. logger.info("[%s] Sent pause print command", self.serial_number)
  7192. return True
  7193. def resume_print(self) -> bool:
  7194. """Resume a paused print job."""
  7195. if not self._client or not self.state.connected:
  7196. logger.warning("[%s] Cannot resume print: not connected", self.serial_number)
  7197. return False
  7198. command = {"print": {"command": "resume", "sequence_id": "0"}}
  7199. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7200. logger.info("[%s] Sent resume print command", self.serial_number)
  7201. return True
  7202. def clear_hms_errors(self) -> bool:
  7203. """Clear HMS/print errors on the printer and locally."""
  7204. if not self._client or not self.state.connected:
  7205. logger.warning("[%s] Cannot clear HMS errors: not connected", self.serial_number)
  7206. return False
  7207. command = {"print": {"command": "clean_print_error", "sequence_id": "0"}}
  7208. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7209. self.state.hms_errors = []
  7210. logger.info("[%s] Sent clear HMS errors command", self.serial_number)
  7211. return True
  7212. def _handle_skip_objects_answer(self, print_data: dict) -> None:
  7213. """The printer's answer to skip_objects: a refusal is logged and the
  7214. objects are no longer shown as skipped."""
  7215. obj_list = self._skip_commands.pop(str(print_data.get("sequence_id", "")), None)
  7216. result = str(print_data.get("result", "") or "").lower()
  7217. if obj_list is None or result in ("", "success"):
  7218. return
  7219. logger.error(
  7220. "[%s] Printer refused skipping objects %s: result=%s reason=%s",
  7221. self.serial_number,
  7222. obj_list,
  7223. print_data.get("result"),
  7224. print_data.get("reason", ""),
  7225. )
  7226. for oid in obj_list:
  7227. self._unconfirmed_skips.pop(oid, None)
  7228. self.state.skipped_objects = [oid for oid in self.state.skipped_objects if oid not in obj_list]
  7229. def _check_unconfirmed_skips(self) -> None:
  7230. """Log, once, a skip the printer's s_obj list never showed."""
  7231. if not self._unconfirmed_skips:
  7232. return
  7233. if self.state.state not in ("RUNNING", "PAUSE"):
  7234. # The print ended; its skips are moot.
  7235. self._unconfirmed_skips.clear()
  7236. self._skip_commands.clear()
  7237. return
  7238. now = time.monotonic()
  7239. # A copy: skip_objects adds to the dict from the event loop while this
  7240. # runs on the MQTT thread.
  7241. pending = list(self._unconfirmed_skips.items())
  7242. expired = [oid for oid, sent_at in pending if now - sent_at > SKIP_CONFIRM_TIMEOUT_S]
  7243. if not expired:
  7244. return
  7245. logger.error(
  7246. "[%s] Printer did not confirm skipping objects %s within %.0fs; they may still be printed",
  7247. self.serial_number,
  7248. sorted(expired),
  7249. SKIP_CONFIRM_TIMEOUT_S,
  7250. )
  7251. for oid in expired:
  7252. self._unconfirmed_skips.pop(oid, None)
  7253. def skip_objects(self, object_ids: list[int]) -> bool:
  7254. """Skip specific objects during a print.
  7255. This command tells the printer to skip printing the specified objects.
  7256. The object IDs come from the slice_info.config file in the 3MF.
  7257. Args:
  7258. object_ids: List of identify_id values from slice_info.config
  7259. Returns:
  7260. True if command was sent, False otherwise
  7261. """
  7262. if not self._client or not self.state.connected:
  7263. logger.warning("[%s] Cannot skip objects: not connected", self.serial_number)
  7264. return False
  7265. if self.state.state != "RUNNING" and self.state.state != "PAUSE":
  7266. logger.warning(
  7267. f"[{self.serial_number}] Cannot skip objects: printer not printing (state={self.state.state})"
  7268. )
  7269. return False
  7270. if not object_ids:
  7271. logger.warning("[%s] Cannot skip objects: no object IDs provided", self.serial_number)
  7272. return False
  7273. # Validate all IDs are integers
  7274. try:
  7275. obj_list = [int(oid) for oid in object_ids]
  7276. except (ValueError, TypeError) as e:
  7277. logger.warning("[%s] Invalid object IDs: %s", self.serial_number, e)
  7278. return False
  7279. self._sequence_id += 1
  7280. command = {"print": {"sequence_id": str(self._sequence_id), "command": "skip_objects", "obj_list": obj_list}}
  7281. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7282. logger.info("[%s] Sent skip_objects command: %s", self.serial_number, obj_list)
  7283. sent_at = time.monotonic()
  7284. for oid in obj_list:
  7285. self._unconfirmed_skips.setdefault(oid, sent_at)
  7286. self._skip_commands[str(self._sequence_id)] = obj_list
  7287. # Track skipped objects in state
  7288. for oid in obj_list:
  7289. if oid not in self.state.skipped_objects:
  7290. self.state.skipped_objects.append(oid)
  7291. return True
  7292. def send_gcode(self, gcode: str) -> bool:
  7293. """Send G-code command(s) to the printer.
  7294. Multiple commands can be separated by newlines.
  7295. Args:
  7296. gcode: G-code command(s) to send
  7297. Returns:
  7298. True if command was sent, False otherwise
  7299. """
  7300. if not self._client or not self.state.connected:
  7301. logger.warning("[%s] Cannot send G-code: not connected", self.serial_number)
  7302. return False
  7303. self._sequence_id += 1
  7304. command = {"print": {"command": "gcode_line", "param": gcode, "sequence_id": str(self._sequence_id)}}
  7305. # Use QoS 1 for reliable delivery (at least once)
  7306. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7307. logger.debug("[%s] Sent G-code: %s...", self.serial_number, gcode[:50])
  7308. return True
  7309. def set_bed_temperature(self, target: int) -> bool:
  7310. """Set the bed target temperature.
  7311. Args:
  7312. target: Target temperature in Celsius (0 to turn off)
  7313. Returns:
  7314. True if command was sent, False otherwise
  7315. """
  7316. return self.send_gcode(f"M140 S{target}")
  7317. def set_nozzle_temperature(self, target: int, nozzle: int = 0) -> bool:
  7318. """Set the nozzle target temperature.
  7319. Args:
  7320. target: Target temperature in Celsius (0 to turn off)
  7321. nozzle: Nozzle index (0 for right/default, 1 for left on H2D)
  7322. Returns:
  7323. True if command was sent, False otherwise
  7324. """
  7325. # Use M104 for non-blocking
  7326. # Always use T parameter for H2D compatibility
  7327. result = self.send_gcode(f"M104 T{nozzle} S{target}")
  7328. # H2D quirk: left nozzle (nozzle=1) target isn't reported in MQTT
  7329. # Track it locally so we can display it correctly
  7330. if result and nozzle == 1:
  7331. self.state.temperatures["nozzle_target"] = float(target)
  7332. self.state.temperatures["_nozzle_target_set_time"] = time.time()
  7333. logger.info("[%s] Tracking LEFT nozzle target locally: %s°C", self.serial_number, target)
  7334. return result
  7335. def set_chamber_temperature(self, target: int) -> bool:
  7336. """Set the chamber target temperature.
  7337. Args:
  7338. target: Target temperature in Celsius (0 to turn off heating)
  7339. Returns:
  7340. True if command was sent, False otherwise
  7341. """
  7342. # The H3C's heater only runs in the airduct's heating mode.
  7343. from backend.app.utils.printer_models import chamber_heater_needs_heating_mode
  7344. if target > 0 and self.state.airduct_mode != 1 and chamber_heater_needs_heating_mode(self.model):
  7345. logger.info(
  7346. "[%s] Chamber target %s°C: switching the airduct to heating mode first (H3C)",
  7347. self.serial_number,
  7348. target,
  7349. )
  7350. self.set_airduct_mode("heating")
  7351. # M141 sets chamber temperature
  7352. result = self.send_gcode(f"M141 S{target}")
  7353. # Track chamber target locally (MQTT reports encoded values that need filtering)
  7354. if result:
  7355. self.state.temperatures["chamber_target"] = float(target)
  7356. self.state.temperatures["_chamber_target_set_time"] = time.time()
  7357. # Update heating state immediately based on new target
  7358. current_temp = self.state.temperatures.get("chamber", 0)
  7359. self.state.temperatures["chamber_heating"] = target > 0 and current_temp < target
  7360. logger.info(
  7361. f"[{self.serial_number}] Tracking chamber target locally: {target}°C (heating={self.state.temperatures['chamber_heating']})"
  7362. )
  7363. return result
  7364. def set_print_speed(self, mode: int) -> bool:
  7365. """Set the print speed mode.
  7366. Args:
  7367. mode: Speed mode (1=silent, 2=standard, 3=sport, 4=ludicrous)
  7368. Returns:
  7369. True if command was sent, False otherwise
  7370. """
  7371. if not self._client or not self.state.connected:
  7372. logger.warning("[%s] Cannot set print speed: not connected", self.serial_number)
  7373. return False
  7374. if mode not in (1, 2, 3, 4):
  7375. logger.warning("[%s] Invalid speed mode: %s", self.serial_number, mode)
  7376. return False
  7377. command = {"print": {"command": "print_speed", "param": str(mode), "sequence_id": "0"}}
  7378. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7379. logger.info("[%s] Set print speed mode to %s", self.serial_number, mode)
  7380. return True
  7381. def set_fan_speed(self, fan: int, speed: int) -> bool:
  7382. """Set fan speed.
  7383. Args:
  7384. fan: Fan index (1=part cooling, 2=auxiliary, 3=chamber, 10=second auxiliary).
  7385. Index 10 is the second auxiliary part cooling fan: left on the P2S
  7386. (an accessory kit), right on the X2D, where 2 is the left (#3373)
  7387. (airduct part id 10); Bambu's official machine profiles drive it with
  7388. "M106 P10" in start/layer-change gcode.
  7389. speed: Speed 0-255 (0=off, 255=full)
  7390. Returns:
  7391. True if command was sent, False otherwise
  7392. """
  7393. if fan not in (1, 2, 3, 10):
  7394. logger.warning("[%s] Invalid fan index: %s", self.serial_number, fan)
  7395. return False
  7396. speed = max(0, min(255, speed)) # Clamp to 0-255
  7397. return self.send_gcode(f"M106 P{fan} S{speed}")
  7398. def set_airduct_mode(self, mode: str) -> bool:
  7399. """Set air conditioning mode (cooling or heating).
  7400. Args:
  7401. mode: "cooling" (modeId=0) or "heating" (modeId=1)
  7402. - Cooling: Suitable for PLA/PETG/TPU, filters and cools chamber air
  7403. - Heating: Suitable for ABS/ASA/PC/PA, circulates and heats chamber air,
  7404. closes top exhaust flap
  7405. Returns:
  7406. True if command was sent, False otherwise
  7407. """
  7408. if not self._client or not self.state.connected:
  7409. logger.warning("[%s] Cannot set airduct mode: not connected", self.serial_number)
  7410. return False
  7411. self._sequence_id += 1
  7412. mode_id = 0 if mode == "cooling" else 1
  7413. command = {
  7414. "print": {"command": "set_airduct", "modeId": mode_id, "sequence_id": str(self._sequence_id), "submode": -1}
  7415. }
  7416. # Use QoS 1 for reliable delivery
  7417. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7418. logger.info(
  7419. "[%s] Set airduct mode to %s (modeId=%s, seq=%s)", self.serial_number, mode, mode_id, self._sequence_id
  7420. )
  7421. return True
  7422. def set_chamber_light(self, on: bool) -> bool:
  7423. """Turn chamber light on or off.
  7424. Args:
  7425. on: True to turn on, False to turn off
  7426. Returns:
  7427. True if command was sent, False otherwise
  7428. """
  7429. if not self._client or not self.state.connected:
  7430. logger.warning("[%s] Cannot set chamber light: not connected", self.serial_number)
  7431. return False
  7432. mode = "on" if on else "off"
  7433. # Control both chamber lights (some printers like H2D have two)
  7434. for led_node in ["chamber_light", "chamber_light2"]:
  7435. self._sequence_id += 1
  7436. command = {
  7437. "system": {
  7438. "command": "ledctrl",
  7439. "led_node": led_node,
  7440. "led_mode": mode,
  7441. "led_on_time": 500,
  7442. "led_off_time": 500,
  7443. "loop_times": 0,
  7444. "interval_time": 0,
  7445. "sequence_id": str(self._sequence_id),
  7446. }
  7447. }
  7448. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7449. logger.info("[%s] Set chamber lights %s (seq=%s)", self.serial_number, "on" if on else "off", self._sequence_id)
  7450. return True
  7451. def select_extruder(self, extruder: int) -> bool:
  7452. """Select the active extruder for dual-nozzle printers (H2D).
  7453. Args:
  7454. extruder: Extruder index (0=right, 1=left for H2D)
  7455. Returns:
  7456. True if command was sent, False otherwise
  7457. """
  7458. if extruder not in (0, 1):
  7459. logger.warning("[%s] Invalid extruder: %s", self.serial_number, extruder)
  7460. return False
  7461. if not self._client or not self.state.connected:
  7462. logger.warning("[%s] Cannot switch extruder: not connected", self.serial_number)
  7463. return False
  7464. # H2D extruder switching via select_extruder command
  7465. # Command format captured from OrcaSlicer:
  7466. # {"print": {"command": "select_extruder", "extruder_index": 0, "sequence_id": "..."}}
  7467. # extruder_index: 0 = RIGHT, 1 = LEFT
  7468. self._sequence_id += 1
  7469. command = {
  7470. "print": {"command": "select_extruder", "extruder_index": extruder, "sequence_id": str(self._sequence_id)}
  7471. }
  7472. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7473. logger.info(
  7474. "[%s] Sent select_extruder command: extruder_index=%s (0=right, 1=left)", self.serial_number, extruder
  7475. )
  7476. return True
  7477. def _ams_unit(self, ams_id: int) -> dict | None:
  7478. """AMS unit ``ams_id`` in the last status, or None."""
  7479. for unit in self.state.raw_data.get("ams") or []:
  7480. if isinstance(unit, dict) and _mqtt_int(unit.get("id")) == ams_id:
  7481. return unit
  7482. return None
  7483. def _rack_tray(self, tray_id: int | None) -> tuple[int, int, dict | None] | None:
  7484. """``(ams_id, slot, tray)`` of a rack AMS slot's global tray id (the AMS 3H's 28-36), else None."""
  7485. if not isinstance(tray_id, int):
  7486. return None
  7487. located = self.tray_layout.rack_slot(tray_id)
  7488. if located is None:
  7489. return None
  7490. ams_id, slot = located
  7491. unit = self._ams_unit(ams_id) or {}
  7492. tray = next(
  7493. (t for t in unit.get("tray") or [] if isinstance(t, dict) and _mqtt_int(t.get("id")) == slot),
  7494. None,
  7495. )
  7496. return ams_id, slot, tray
  7497. def rack_tray_has_filament(self, tray_id: int) -> bool:
  7498. """Whether rack AMS slot ``tray_id`` reports a filament type, which Studio requires before a Load.
  7499. The AMS 3H registers a spool only once it has pulled the filament in at the inlet.
  7500. """
  7501. rack = self._rack_tray(tray_id)
  7502. return bool(rack and rack[2] and rack[2].get("tray_type"))
  7503. @staticmethod
  7504. def _tray_mid_temp(tray: dict | None) -> int:
  7505. """Midpoint of a tray's nozzle_temp_min/max, or -1 (as Studio's ams_change_filament)."""
  7506. if tray is None:
  7507. return -1
  7508. low, high = _mqtt_int(tray.get("nozzle_temp_min")), _mqtt_int(tray.get("nozzle_temp_max"))
  7509. return (low + high) // 2 if low and high and low > 0 and high > 0 else -1
  7510. def _rack_change_filament(self, tray_id: int, load: bool) -> bool:
  7511. """Load AMS 3H slot ``tray_id`` into its own hotend, or unload that hotend.
  7512. As Studio 02.09 sends it for a direct-connected rack (PageFilament.cpp):
  7513. load targets 32 at slot k, unload 255 at slot 255 - k (the feeder to
  7514. retract). The AMS 3H can't rewind: an unload ends with a hand pull.
  7515. """
  7516. client = self._client
  7517. rack = self._rack_tray(tray_id)
  7518. if client is None or rack is None:
  7519. return False
  7520. ams_id, slot, tray = rack
  7521. on_head = self._rack_tray(self.state.tray_now)
  7522. self._sequence_id += 1
  7523. command = {
  7524. "print": {
  7525. "command": "ams_change_filament",
  7526. "sequence_id": str(self._sequence_id),
  7527. "ams_id": ams_id,
  7528. "target": ams_id if load else 255,
  7529. "slot_id": slot if load else 255 - slot,
  7530. "extruder_id": 0,
  7531. "curr_temp": self._tray_mid_temp(on_head[2] if on_head else None),
  7532. "tar_temp": self._tray_mid_temp(tray),
  7533. }
  7534. }
  7535. command_json = json.dumps(command)
  7536. logger.info(
  7537. "[%s] Publishing ams_change_filament (%s, AMS 3H slot %d): %s",
  7538. self.serial_number,
  7539. "load" if load else "unload",
  7540. slot + 1,
  7541. command_json,
  7542. )
  7543. client.publish(self.topic_publish, command_json, qos=1)
  7544. if load:
  7545. self.state.pending_tray_target = tray_id
  7546. self.state.pending_tray_target_at = time.monotonic()
  7547. else:
  7548. self.state.pending_tray_target = None
  7549. self.state.pending_tray_target_at = None
  7550. return True
  7551. def ams_load_filament(self, tray_id: int, extruder_id: int | None = None) -> bool:
  7552. """Load filament from a specific AMS tray.
  7553. Args:
  7554. tray_id: Global tray ID — 0..15 for AMS slots, 24..27 for the A2L
  7555. AMS-Lite, 128..135 for an AMS-HT (its unit id), 254 for external spool
  7556. (single-external printers and Ext-L on dual-nozzle H2D),
  7557. 255 for Ext-R on dual-nozzle H2D.
  7558. extruder_id: Which hotend to feed (0 = right/main, 1 = left/deputy).
  7559. Sent only when given, matching BambuStudio: ``extruder_id`` is
  7560. an optional field on ``ams_change_filament``
  7561. (``DeviceManager::command_ams_change_filament``) and Studio
  7562. omits it unless a Filament Track Switch is installed. Without a
  7563. switch the firmware derives the hotend from the AMS's own
  7564. extruder binding and an explicit value is redundant; *with* one
  7565. every AMS reports 0xE and is bound to a switch inlet instead, so
  7566. the firmware has nothing to derive from and the load silently
  7567. does nothing until we name the hotend.
  7568. Returns:
  7569. True if command was sent, False otherwise
  7570. """
  7571. if not self._client or not self.state.connected:
  7572. logger.warning("[%s] Cannot load filament: not connected", self.serial_number)
  7573. return False
  7574. if self.tray_layout.rack_units:
  7575. # Only an AMS 3H slot can be loaded: an external input or an AMS-B
  7576. # can't feed itself (Studio's CanAutoFeed).
  7577. rack = self._rack_tray(tray_id)
  7578. if rack is None or self.tray_layout.ams_type(rack[0]) != AmsType.ZMULTI_A:
  7579. logger.warning("[%s] Load: tray %s is not an AMS 3H slot", self.serial_number, tray_id)
  7580. return False
  7581. if not self.rack_tray_has_filament(tray_id):
  7582. logger.warning("[%s] Load: AMS 3H slot %d has no filament", self.serial_number, rack[1] + 1)
  7583. return False
  7584. return self._rack_change_filament(tray_id, load=True)
  7585. # Build the ams_change_filament command. Encoding differs by target type:
  7586. # - AMS slots (0..15, A2L 24..27, AMS-HT 128..135): see
  7587. # change_filament_wire_ids; curr/tar_temp = -1.
  7588. # - External spool (tray_id=254): legacy capture from a single-extruder
  7589. # printer used slot_id=254, curr/tar_temp=-1; preserved here.
  7590. # - Ext-R on dual-nozzle H2D (tray_id=255): captured shape from
  7591. # BambuStudio uses slot_id=0 (extruder index, 0=right), and
  7592. # curr_temp/tar_temp = the actual right-nozzle temp. See #891.
  7593. self._sequence_id += 1
  7594. wire_target = tray_id
  7595. if tray_id == 255:
  7596. ams_id = 255
  7597. slot_id = 0 # extruder index for the right nozzle
  7598. right_temp = int(self.state.temperatures.get("nozzle_2", 0) or 0)
  7599. if right_temp < 180:
  7600. right_temp = 215 # Reasonable default if right nozzle is cold/unknown
  7601. curr_temp = right_temp
  7602. tar_temp = right_temp
  7603. elif tray_id == 254:
  7604. ams_id = 255
  7605. slot_id = 254
  7606. curr_temp = -1
  7607. tar_temp = -1
  7608. else:
  7609. # A regular AMS, the A2L AMS-Lite (physical unit 16) or an AMS-HT
  7610. # (128-135), as BambuStudio addresses each.
  7611. ams_id, slot_id, wire_target = change_filament_wire_ids(tray_id, self.tray_layout)
  7612. curr_temp = -1
  7613. tar_temp = -1
  7614. command = {
  7615. "print": {
  7616. "command": "ams_change_filament",
  7617. "sequence_id": str(self._sequence_id),
  7618. "ams_id": ams_id,
  7619. "slot_id": slot_id,
  7620. "target": wire_target,
  7621. "curr_temp": curr_temp,
  7622. "tar_temp": tar_temp,
  7623. }
  7624. }
  7625. if extruder_id is not None:
  7626. command["print"]["extruder_id"] = int(extruder_id)
  7627. command_json = json.dumps(command)
  7628. logger.info("[%s] Publishing ams_change_filament command: %s", self.serial_number, command_json)
  7629. self._client.publish(self.topic_publish, command_json, qos=1)
  7630. logger.info("[%s] Loading filament from tray %s (AMS %s slot %s)", self.serial_number, tray_id, ams_id, slot_id)
  7631. # Track this load request for H2D dual-nozzle disambiguation
  7632. # H2D reports only slot number (0-3) in tray_now, so we use our tracked value
  7633. self.state.pending_tray_target = tray_id
  7634. self.state.pending_tray_target_at = time.monotonic()
  7635. logger.info("[%s] Set pending_tray_target=%s for H2D disambiguation", self.serial_number, tray_id)
  7636. return True
  7637. def ams_unload_filament(self, tray_id: int | None = None) -> bool:
  7638. """Unload filament, optionally naming the slot to unload.
  7639. Args:
  7640. tray_id: Global tray ID of the slot being unloaded. When given, the
  7641. command is addressed to that slot's AMS and is only sent if an
  7642. extruder is actually fed from it — BambuStudio does the same
  7643. (``StatusPanel::on_ams_unload`` walks the extruders and sends
  7644. nothing when none matches). When omitted, the pre-existing
  7645. behaviour is kept: unload whatever ``tray_now`` names.
  7646. ``tray_now`` is a single value for the whole printer, so on a dual-nozzle
  7647. machine with both hotends loaded it names only one of them and an
  7648. unaddressed unload picks that one regardless of which slot the operator
  7649. clicked. Passing the slot is what makes the two hotends distinguishable.
  7650. Returns:
  7651. True if command was sent, False otherwise
  7652. """
  7653. if not self._client or not self.state.connected:
  7654. logger.warning("[%s] Cannot unload filament: not connected", self.serial_number)
  7655. return False
  7656. if self.tray_layout.rack_units:
  7657. # The hotend of the named AMS 3H slot, else of the one on the toolhead.
  7658. source = tray_id if tray_id is not None else self.state.tray_now
  7659. if self._rack_tray(source) is None:
  7660. logger.warning("[%s] Unload: no AMS 3H slot to unload (tray %s)", self.serial_number, source)
  7661. return False
  7662. return self._rack_change_filament(source, load=False)
  7663. # Get the currently loaded tray info
  7664. tray_now = self.state.tray_now
  7665. source_tray = tray_now if tray_id is None else tray_id
  7666. logger.info("[%s] Unload requested, tray_now=%s, tray_id=%s", self.serial_number, tray_now, tray_id)
  7667. # Determine source ams_id for the unload command
  7668. if source_tray == 255 or source_tray == 254:
  7669. ams_id = 255 # No filament or external spool
  7670. else:
  7671. # Source AMS: the A2L AMS-Lite as physical 16, an AMS-HT as its unit id.
  7672. ams_id = change_filament_wire_ids(source_tray, self.tray_layout)[0]
  7673. # Refuse an addressed unload of a slot no hotend is holding — but only on
  7674. # a printer that has more than one hotend, which is the only case the
  7675. # check exists for. With one hotend there is nothing to disambiguate:
  7676. # tray_now already names the loaded slot exactly, and running the check
  7677. # anyway would stake unload on `snow` meaning ams*4+slot there too. It
  7678. # very likely does, but single-nozzle machines do report the block —
  7679. # BambuStudio has a dedicated branch for `m_total_extder_count == 1` and
  7680. # an X1C on the maintainer's own network sends `device.extruder` — and
  7681. # nobody has read a single-nozzle `snow` off the wire. Guessing wrong
  7682. # would 409 every unload on every X1C, P1S and A1.
  7683. #
  7684. # Gated on the runtime flag rather than on len(extruder_slots), which is
  7685. # rebuilt from each payload's array and would flip the check off for any
  7686. # frame that carried a short one; and deliberately not on
  7687. # ``is_dual_nozzle_model``, whose model-name fallback reports at least
  7688. # one single-nozzle machine as dual (#1386) — the false positive there is
  7689. # exactly the case this gate exists to keep out.
  7690. #
  7691. # The external spool is excluded for a different reason: 254/255 are not
  7692. # ams*4+slot, so the local-slot arithmetic below cannot describe them.
  7693. if tray_id is not None and tray_id not in (254, 255) and self._is_dual_nozzle and self.state.extruder_slots:
  7694. local_slot = change_filament_wire_ids(tray_id, self.tray_layout)[1]
  7695. holder = next(
  7696. (ext for ext, slot in self.state.extruder_slots.items() if slot.holds(ams_id, local_slot)),
  7697. None,
  7698. )
  7699. if holder is None:
  7700. logger.info(
  7701. "[%s] Unload skipped: no extruder is fed from AMS %s slot %s",
  7702. self.serial_number,
  7703. ams_id,
  7704. local_slot,
  7705. )
  7706. return False
  7707. logger.info(
  7708. "[%s] Unloading AMS %s slot %s from extruder %s", self.serial_number, ams_id, local_slot, holder
  7709. )
  7710. # Command format from BambuStudio traffic capture:
  7711. # - No extruder_id field
  7712. # - For UNLOAD: curr_temp and tar_temp are the actual nozzle temp (e.g., 210)
  7713. # - slot_id=255 and target=255 for unload
  7714. # Get current nozzle temperature for the unload command
  7715. nozzle_temp = int(self.state.temperatures.get("nozzle", 210))
  7716. if nozzle_temp < 180:
  7717. nozzle_temp = 210 # Default to PLA temp if nozzle is cold
  7718. self._sequence_id += 1
  7719. command = {
  7720. "print": {
  7721. "command": "ams_change_filament",
  7722. "sequence_id": str(self._sequence_id),
  7723. "ams_id": ams_id,
  7724. "slot_id": 255, # 255 = unload marker
  7725. "target": 255, # 255 = unload destination
  7726. "curr_temp": nozzle_temp,
  7727. "tar_temp": nozzle_temp,
  7728. }
  7729. }
  7730. command_json = json.dumps(command)
  7731. logger.info("[%s] Publishing ams_change_filament (unload) command: %s", self.serial_number, command_json)
  7732. self._client.publish(self.topic_publish, command_json, qos=1)
  7733. logger.info("[%s] Unloading filament (tray_now was %s)", self.serial_number, tray_now)
  7734. # Clear tracked load request since we're unloading
  7735. self.state.pending_tray_target = None
  7736. self.state.pending_tray_target_at = None
  7737. logger.info("[%s] Cleared pending_tray_target (unload)", self.serial_number)
  7738. return True
  7739. def ams_control(self, action: str) -> bool:
  7740. """Control AMS operations.
  7741. Args:
  7742. action: "resume", "reset", or "pause"
  7743. Returns:
  7744. True if command was sent, False otherwise
  7745. """
  7746. if not self._client or not self.state.connected:
  7747. logger.warning("[%s] Cannot control AMS: not connected", self.serial_number)
  7748. return False
  7749. if action not in ("resume", "reset", "pause"):
  7750. logger.warning("[%s] Invalid AMS action: %s", self.serial_number, action)
  7751. return False
  7752. command = {"print": {"command": "ams_control", "param": action, "sequence_id": "0"}}
  7753. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7754. logger.info("[%s] AMS control: %s", self.serial_number, action)
  7755. return True
  7756. async def ams_refresh_tray(self, ams_id: int, tray_id: int) -> tuple[bool, str]:
  7757. """Trigger RFID re-read for a specific AMS tray.
  7758. Sends ``ams_get_rfid`` and waits for the printer's answer. Firmware
  7759. that refuses it (#3206: X1Plus on base 01.08.02.00 answers ``FAIL`` /
  7760. ``ERROR STATE``) gets the legacy ``M620 R<global tray>`` gcode instead,
  7761. which is what Bambu Studio sends to printers without the new protocol.
  7762. The fallback only follows an explicit refusal, so firmware that takes
  7763. ``ams_get_rfid`` never sees it.
  7764. Success means the printer accepted the request, not that the tag was
  7765. read: the slot updating in the next push is the only proof of that.
  7766. Args:
  7767. ams_id: AMS unit ID (0-3, or 128 for H2D external tray)
  7768. tray_id: Tray ID within the AMS (0-3)
  7769. Returns:
  7770. Tuple of (success, message)
  7771. """
  7772. if not self._client or not self.state.connected:
  7773. logger.warning("[%s] Cannot refresh AMS tray: not connected", self.serial_number)
  7774. return False, "Printer not connected"
  7775. # Check if filament is currently loaded (tray_now != 255)
  7776. # RFID refresh requires the AMS to move filament, which can't happen if one is loaded
  7777. tray_now = self.state.tray_now
  7778. if tray_now != 255:
  7779. # Decode which tray is loaded for the message
  7780. layout = self.tray_layout
  7781. if tray_now == 254:
  7782. loaded_tray = "external spool"
  7783. elif (rack := layout.rack_slot(tray_now)) is not None:
  7784. loaded_tray = f"{unit_label(rack[0], layout.ams_type(rack[0]))} slot {rack[1] + 1}"
  7785. elif tray_now >= 0 and tray_now < 128:
  7786. loaded_ams, loaded_slot = layout.slot_key(tray_now)
  7787. loaded_tray = f"AMS {loaded_ams + 1} slot {loaded_slot + 1}"
  7788. else:
  7789. loaded_tray = f"tray {tray_now}"
  7790. logger.warning("[%s] Cannot refresh AMS tray: filament loaded from %s", self.serial_number, loaded_tray)
  7791. return False, f"Please unload filament first. Currently loaded: {loaded_tray}"
  7792. # A2L AMS-Lite: physical unit 16 + local slot (matches ams_mapping2).
  7793. wire_ams_id, wire_slot_id = ams_id, tray_id
  7794. if (_a2l := a2l_lite_wire_ids(ams_id, tray_id)) is not None:
  7795. wire_ams_id, wire_slot_id, _ = _a2l
  7796. logger.info("[%s] Triggering RFID re-read: AMS %s, slot %s", self.serial_number, ams_id, tray_id)
  7797. refused = await self._send_rfid_command(
  7798. {"command": "ams_get_rfid", "ams_id": wire_ams_id, "slot_id": wire_slot_id}
  7799. )
  7800. if refused is None:
  7801. return True, f"Refreshing AMS {ams_id} tray {tray_id}"
  7802. # M620 R only for what Bambu Studio sends it to: a model older than the
  7803. # newer protocol, on one of the four regular AMS units (the only ones
  7804. # with a legacy global tray index). Never during a job either: a
  7805. # gcode_line would be executed inside the running print.
  7806. from backend.app.utils.printer_models import uses_legacy_rfid_refresh
  7807. if (
  7808. not 0 <= wire_ams_id <= 3
  7809. or not uses_legacy_rfid_refresh(self.model)
  7810. or self.state.state in _ACTIVE_PRINT_STATES
  7811. ):
  7812. return False, f"Printer refused the RFID refresh: {refused}"
  7813. logger.info(
  7814. "[%s] ams_get_rfid refused (%s), falling back to M620 R%s",
  7815. self.serial_number,
  7816. refused,
  7817. legacy_tray_index(wire_ams_id, wire_slot_id),
  7818. )
  7819. legacy_refused = await self._send_rfid_command(
  7820. {"command": "gcode_line", "param": f"M620 R{legacy_tray_index(wire_ams_id, wire_slot_id)}\n"}
  7821. )
  7822. if legacy_refused is None:
  7823. return True, f"Refreshing AMS {ams_id} tray {tray_id} (legacy command)"
  7824. return False, f"Printer refused the RFID refresh: {legacy_refused}"
  7825. # The answer to ams_get_rfid was measured at 11ms in #3206's capture.
  7826. _rfid_ack_timeout: float = 3.0
  7827. async def _send_rfid_command(self, print_command: dict) -> str | None:
  7828. """Publish one RFID refresh command and wait for the printer's answer.
  7829. Returns the printer's reason when it answered ``FAIL``, else None.
  7830. No answer within ``_rfid_ack_timeout`` counts as accepted, because
  7831. silence is not evidence of refusal and older firmware may not answer
  7832. at all.
  7833. """
  7834. timeout = self._rfid_ack_timeout
  7835. self._sequence_id += 1
  7836. seq_id = str(self._sequence_id)
  7837. command = {"print": {**print_command, "sequence_id": seq_id}}
  7838. self._pending_rfid_acks[seq_id] = None
  7839. try:
  7840. self._client.publish(self.topic_publish, json.dumps(command), qos=1)
  7841. deadline = time.monotonic() + timeout
  7842. while time.monotonic() < deadline:
  7843. ack = self._pending_rfid_acks.get(seq_id)
  7844. if ack is not None:
  7845. if str(ack.get("result", "")).lower() == "fail":
  7846. return str(ack.get("reason", "") or "") or "printer reported failure"
  7847. return None
  7848. await asyncio.sleep(0.05)
  7849. finally:
  7850. self._pending_rfid_acks.pop(seq_id, None)
  7851. logger.info(
  7852. "[%s] No answer to %s seq=%s within %.1fs", self.serial_number, print_command["command"], seq_id, timeout
  7853. )
  7854. return None
  7855. def ams_set_filament_setting(
  7856. self,
  7857. ams_id: int,
  7858. tray_id: int,
  7859. tray_info_idx: str,
  7860. tray_type: str,
  7861. tray_sub_brands: str,
  7862. tray_color: str,
  7863. nozzle_temp_min: int,
  7864. nozzle_temp_max: int,
  7865. setting_id: str = "",
  7866. ) -> bool:
  7867. """Set AMS tray filament settings (type, color, temperature).
  7868. Note: K value is set separately via extrusion_cali_sel command.
  7869. Args:
  7870. ams_id: AMS unit ID (0-3 for regular AMS, 128-135 for HT AMS)
  7871. tray_id: Tray ID within the AMS (0-3)
  7872. tray_info_idx: Filament ID short format (e.g., "GFL05")
  7873. tray_type: Filament type (e.g., "PLA", "PETG")
  7874. tray_sub_brands: Sub-brand name (e.g., "PLA Basic", "PETG HF")
  7875. tray_color: Color in RRGGBBAA hex format (e.g., "FFFF00FF")
  7876. nozzle_temp_min: Minimum nozzle temperature
  7877. nozzle_temp_max: Maximum nozzle temperature
  7878. setting_id: Full setting ID with version (e.g., "GFSL05_07") - optional
  7879. Returns:
  7880. True if command was sent, False otherwise
  7881. """
  7882. if not self._client or not self.state.connected:
  7883. logger.warning("[%s] Cannot set AMS filament setting: not connected", self.serial_number)
  7884. return False
  7885. # Calculate mqtt IDs based on AMS type.
  7886. # External-spool convention verified against a BambuStudio→X1C packet capture
  7887. # (issue #1279, May 2026): for `ams_filament_setting` Studio sends the
  7888. # *global* tray index in `tray_id`, not a local position within the virtual
  7889. # unit. The printer's response echoes `tray_id: 0` (slot position), which
  7890. # is what the original code was matching — but the request and response
  7891. # use different semantics for that field. Sending `tray_id: 0` is what
  7892. # the P1S in #1279 rejected with `result: "fail"`.
  7893. if ams_id == 255:
  7894. vt_tray = self.state.raw_data.get("vt_tray", []) if self.state.raw_data else []
  7895. if len(vt_tray) > 1:
  7896. # Dual external slots (H2D): each ext slot is its own virtual AMS unit
  7897. # (254=ext-L / slot 0, 255=ext-R / slot 1). The dual case is NOT
  7898. # covered by the X1C capture — left at `mqtt_tray_id = 0` until a
  7899. # captured Studio→H2D exchange confirms the correct value.
  7900. mqtt_ams_id = external_tray_id(tray_id)
  7901. mqtt_tray_id = 0
  7902. else:
  7903. # Single external slot (X1C, P1S, A1): global tray_id=254.
  7904. mqtt_ams_id = 255
  7905. mqtt_tray_id = 254
  7906. slot_id = 0
  7907. elif (_a2l := a2l_lite_wire_ids(ams_id, tray_id)) is not None:
  7908. # A2L AMS-Lite: physical unit 16, local 0-3 slot (matches the
  7909. # firmware's own ams_mapping2 {ams_id:16, slot_id:0-3}).
  7910. mqtt_ams_id, slot_id, _ = _a2l
  7911. mqtt_tray_id = slot_id
  7912. elif self._rack_ams_type(ams_id) is not None:
  7913. # AMS 3H: unit 32 with its slot 0-8 in tray_id and slot_id (verified).
  7914. mqtt_ams_id = ams_id
  7915. mqtt_tray_id = slot_id = tray_id
  7916. elif ams_id <= 3:
  7917. mqtt_ams_id = ams_id
  7918. mqtt_tray_id = tray_id
  7919. slot_id = tray_id
  7920. else:
  7921. # AMS-HT: single tray per unit
  7922. mqtt_ams_id = ams_id
  7923. mqtt_tray_id = tray_id
  7924. slot_id = 0
  7925. command = {
  7926. "print": {
  7927. "command": "ams_filament_setting",
  7928. "ams_id": mqtt_ams_id,
  7929. "tray_id": mqtt_tray_id,
  7930. "slot_id": slot_id,
  7931. "tray_info_idx": tray_info_idx,
  7932. "tray_type": tray_type,
  7933. "tray_sub_brands": tray_sub_brands,
  7934. # UPPERCASE, always: lowercase hex is silently read as zeros by
  7935. # P1S firmware and acknowledged as a success (#2987).
  7936. "tray_color": wire_tray_color(tray_color),
  7937. "nozzle_temp_min": nozzle_temp_min,
  7938. "nozzle_temp_max": nozzle_temp_max,
  7939. "sequence_id": "0",
  7940. }
  7941. }
  7942. # Include setting_id if provided (helps slicer show correct profile)
  7943. if setting_id:
  7944. command["print"]["setting_id"] = setting_id
  7945. command_json = json.dumps(command)
  7946. logger.info(
  7947. f"[{self.serial_number}] Publishing ams_filament_setting: AMS {ams_id}, tray {tray_id}, tray_info_idx={tray_info_idx}, setting_id={setting_id}"
  7948. )
  7949. logger.debug("[%s] ams_filament_setting command: %s", self.serial_number, command_json)
  7950. self._client.publish(self.topic_publish, command_json, qos=1)
  7951. self._last_ams_cmd_time = time.monotonic()
  7952. return True
  7953. def reset_ams_slot(self, ams_id: int, tray_id: int) -> bool:
  7954. """Reset an AMS slot to empty/unconfigured state.
  7955. Args:
  7956. ams_id: AMS unit ID (0-3 for regular AMS, 128-135 for HT AMS)
  7957. tray_id: Tray ID within the AMS (0-3)
  7958. Returns:
  7959. True if command was sent, False otherwise
  7960. """
  7961. if not self._client or not self.state.connected:
  7962. logger.warning("[%s] Cannot reset AMS slot: not connected", self.serial_number)
  7963. return False
  7964. # Calculate mqtt IDs based on AMS type — same convention as
  7965. # ams_set_filament_setting above. See its comment for the #1279 capture rationale.
  7966. if ams_id == 255:
  7967. vt_tray = self.state.raw_data.get("vt_tray", []) if self.state.raw_data else []
  7968. if len(vt_tray) > 1:
  7969. # Dual external slots (H2D): each ext slot is its own virtual AMS unit
  7970. mqtt_ams_id = external_tray_id(tray_id)
  7971. mqtt_tray_id = 0
  7972. else:
  7973. # Single external slot (X1C, P1S, A1): global tray_id=254.
  7974. mqtt_ams_id = 255
  7975. mqtt_tray_id = 254
  7976. slot_id = 0
  7977. elif (_a2l := a2l_lite_wire_ids(ams_id, tray_id)) is not None:
  7978. # A2L AMS-Lite: physical unit 16, local 0-3 slot (matches ams_mapping2).
  7979. mqtt_ams_id, slot_id, _ = _a2l
  7980. mqtt_tray_id = slot_id
  7981. elif self._rack_ams_type(ams_id) is not None:
  7982. # AMS 3H: unit 32 with its slot 0-8 (see ams_set_filament_setting).
  7983. mqtt_ams_id = ams_id
  7984. mqtt_tray_id = slot_id = tray_id
  7985. elif ams_id <= 3:
  7986. mqtt_ams_id = ams_id
  7987. mqtt_tray_id = tray_id
  7988. slot_id = tray_id
  7989. else:
  7990. # AMS-HT: single tray per unit
  7991. mqtt_ams_id = ams_id
  7992. mqtt_tray_id = tray_id
  7993. slot_id = 0
  7994. command = {
  7995. "print": {
  7996. "command": "ams_filament_setting",
  7997. "ams_id": mqtt_ams_id,
  7998. "tray_id": mqtt_tray_id,
  7999. "slot_id": slot_id,
  8000. "tray_info_idx": "",
  8001. "tray_type": "",
  8002. "tray_sub_brands": "",
  8003. "tray_color": "00000000",
  8004. "nozzle_temp_min": 0,
  8005. "nozzle_temp_max": 0,
  8006. "sequence_id": "0",
  8007. }
  8008. }
  8009. command_json = json.dumps(command)
  8010. logger.info("[%s] Resetting AMS slot: AMS %s, tray %s", self.serial_number, ams_id, tray_id)
  8011. logger.debug("[%s] reset_ams_slot command: %s", self.serial_number, command_json)
  8012. self._client.publish(self.topic_publish, command_json, qos=1)
  8013. self._last_ams_cmd_time = time.monotonic()
  8014. return True
  8015. def extrusion_cali_sel(
  8016. self,
  8017. ams_id: int,
  8018. tray_id: int,
  8019. cali_idx: int,
  8020. filament_id: str,
  8021. nozzle_diameter: str = "0.4",
  8022. ) -> bool:
  8023. """Set calibration profile (K value) for an AMS slot.
  8024. This command selects a K profile from the printer's calibration list.
  8025. Use cali_idx=-1 to use the default K value (0.020).
  8026. Note: Do NOT send setting_id in this command — BambuStudio never includes
  8027. it, and adding it causes the firmware to mislink the profile on X1C/P1S.
  8028. Args:
  8029. ams_id: AMS unit ID (0-3 for regular AMS, 128-135 for HT AMS)
  8030. tray_id: Tray ID within the AMS (0-3)
  8031. cali_idx: Calibration profile index (-1 for default)
  8032. filament_id: Filament preset ID (same as tray_info_idx)
  8033. nozzle_diameter: Nozzle diameter string (e.g., "0.4")
  8034. Returns:
  8035. True if command was sent, False otherwise
  8036. """
  8037. if not self._client or not self.state.connected:
  8038. logger.warning("[%s] Cannot set calibration: not connected", self.serial_number)
  8039. return False
  8040. # Calculate mqtt IDs based on AMS type.
  8041. # IMPORTANT: extrusion_cali_sel uses GLOBAL tray_id (unlike ams_filament_setting
  8042. # which uses LOCAL). BambuStudio confirms: tray_id = ams_id * 4 + slot.
  8043. if ams_id == 255:
  8044. # External spool: extrusion_cali_sel uses GLOBAL tray_id (unlike
  8045. # ams_filament_setting which uses LOCAL tray_id=0).
  8046. vt_tray = self.state.raw_data.get("vt_tray", []) if self.state.raw_data else []
  8047. if len(vt_tray) > 1:
  8048. # Dual external slots (H2D): each ext slot is its own virtual AMS unit
  8049. # Confirmed from BambuStudio logs: ext-R sends ams_id=255, tray_id=255
  8050. mqtt_ams_id = external_tray_id(tray_id)
  8051. mqtt_tray_id = external_tray_id(tray_id)
  8052. else:
  8053. # Single external slot (X1C, P1S, A1): global tray_id=254
  8054. mqtt_ams_id = 254
  8055. mqtt_tray_id = 254
  8056. slot_id = 0
  8057. elif self._rack_ams_type(ams_id) is not None:
  8058. # AMS 3H: unit 32, slot k in tray_id and slot_id ({32, 8, 8} verified).
  8059. mqtt_ams_id = ams_id
  8060. mqtt_tray_id = slot_id = tray_id
  8061. elif ams_id <= 3:
  8062. mqtt_ams_id = ams_id
  8063. mqtt_tray_id = legacy_tray_index(ams_id, tray_id)
  8064. slot_id = tray_id
  8065. elif (_a2l := a2l_lite_wire_ids(ams_id, tray_id)) is not None:
  8066. # A2L AMS-Lite: physical unit 16 + local slot are confirmed; the GLOBAL
  8067. # tray_id this command wants (physical 16*4+slot) is extrapolated (no
  8068. # A2L cali_sel capture yet) — see a2l_lite_wire_ids.
  8069. mqtt_ams_id, slot_id, mqtt_tray_id = _a2l
  8070. elif is_ams_ht_id(ams_id):
  8071. mqtt_ams_id = ams_id
  8072. mqtt_tray_id = tray_id
  8073. slot_id = 0
  8074. else:
  8075. mqtt_ams_id = ams_id
  8076. mqtt_tray_id = tray_id
  8077. slot_id = 0
  8078. command = {
  8079. "print": {
  8080. "command": "extrusion_cali_sel",
  8081. "cali_idx": cali_idx,
  8082. "filament_id": filament_id,
  8083. "nozzle_diameter": nozzle_diameter,
  8084. "ams_id": mqtt_ams_id,
  8085. "tray_id": mqtt_tray_id,
  8086. "slot_id": slot_id,
  8087. "sequence_id": "0",
  8088. }
  8089. }
  8090. command_json = json.dumps(command)
  8091. logger.info(
  8092. f"[{self.serial_number}] Publishing extrusion_cali_sel: AMS {ams_id}, tray {tray_id}, cali_idx={cali_idx}"
  8093. )
  8094. logger.debug("[%s] extrusion_cali_sel command: %s", self.serial_number, command_json)
  8095. self._client.publish(self.topic_publish, command_json, qos=1)
  8096. return True
  8097. def extrusion_cali_set(
  8098. self,
  8099. tray_id: int,
  8100. k_value: float,
  8101. nozzle_diameter: str = "0.4",
  8102. nozzle_temp: int = 220,
  8103. filament_id: str = "",
  8104. setting_id: str = "",
  8105. name: str = "",
  8106. cali_idx: int = -1,
  8107. ) -> bool:
  8108. """Directly set K value (pressure advance) for a tray.
  8109. Uses the filaments array format required by current firmware.
  8110. Args:
  8111. tray_id: Global tray ID (ams_id * 4 + slot)
  8112. k_value: Pressure advance K value (e.g., 0.020)
  8113. nozzle_diameter: Nozzle diameter string (e.g., "0.4")
  8114. nozzle_temp: Nozzle temperature for calibration reference
  8115. filament_id: Filament preset ID (e.g., "GFA02")
  8116. setting_id: Setting ID (e.g., "GFSA02_07")
  8117. name: Profile display name
  8118. cali_idx: Calibration index (-1 for new)
  8119. Returns:
  8120. True if command was sent, False otherwise
  8121. """
  8122. if not self._client or not self.state.connected:
  8123. logger.warning("[%s] Cannot set K value: not connected", self.serial_number)
  8124. return False
  8125. # Was reusing the previous command's id — harmless while nothing
  8126. # correlated on it, but the printer echoes sequence_id back and the
  8127. # K-profile write path now matches acks by it (#2718).
  8128. self._sequence_id += 1
  8129. nozzle_id = f"HS00-{nozzle_diameter}"
  8130. # A2L AMS-Lite: a normalised global tray (24-27) must go out as the
  8131. # physical global (extrapolated 64-67; see a2l_lite_wire_ids). ams_id
  8132. # stays 0 (hardcoded, as for every other unit here).
  8133. wire_tray_id = tray_id
  8134. if (
  8135. 0 <= tray_id <= 253
  8136. and (_a2l := a2l_lite_wire_ids(self.tray_layout.slot_key(tray_id)[0], tray_id)) is not None
  8137. ):
  8138. wire_tray_id = _a2l[2]
  8139. filament_entry = {
  8140. "ams_id": 0,
  8141. "cali_idx": cali_idx,
  8142. "extruder_id": 0,
  8143. "filament_id": filament_id,
  8144. "k_value": f"{k_value:.6f}",
  8145. "n_coef": "1.400000",
  8146. "name": name,
  8147. "nozzle_diameter": nozzle_diameter,
  8148. "nozzle_id": nozzle_id,
  8149. "setting_id": setting_id,
  8150. "tray_id": wire_tray_id,
  8151. }
  8152. command = {
  8153. "print": {
  8154. "command": "extrusion_cali_set",
  8155. "filaments": [filament_entry],
  8156. "nozzle_diameter": nozzle_diameter,
  8157. "sequence_id": str(self._sequence_id),
  8158. }
  8159. }
  8160. command_json = json.dumps(command)
  8161. logger.info("[%s] Publishing extrusion_cali_set: tray %s, k_value=%s", self.serial_number, tray_id, k_value)
  8162. logger.debug("[%s] extrusion_cali_set command: %s", self.serial_number, command_json)
  8163. self._client.publish(self.topic_publish, command_json, qos=1)
  8164. return True
  8165. def execute_hms_action(self, print_error: str, action: str, job_id: str | None = None) -> bool:
  8166. """Dispatch the user's choice from the HMS-error modal as a printer command.
  8167. Args:
  8168. print_error: Canonical hex identifier for the fault — 8 chars for the
  8169. 32-bit `print_error` path, 16 chars for the 64-bit `hms[]` path
  8170. (HMSError.full_code). Carried through unchanged from the route.
  8171. Converted to its DECIMAL string form for the `ignore` /
  8172. `idle_ignore` commands' `err` field, which is what the firmware
  8173. actually compares against the active fault. The pre-#1869
  8174. hex-string `err` was silently rejected because the firmware was
  8175. being asked to match `"05008051"` against int 0x05008051
  8176. (= 83918929 decimal) — see BambuStudio's
  8177. DeviceManager.cpp:1450-1462 (`command_hms_ignore`) which passes
  8178. `std::to_string(int m_error_code)`.
  8179. action: One of HMSAction's string values.
  8180. job_id: The `subtask_id` snapshotted onto the HMSError at parse-time.
  8181. Required by BambuStudio's `command_hms_ignore` / `command_hms_stop`
  8182. shapes; empty string is the no-job-id sentinel.
  8183. Returns False when the MQTT client is offline or when `action` is unknown
  8184. so the route surfaces it as a 4xx rather than a silent no-op.
  8185. """
  8186. if not self._client or not self.state.connected:
  8187. logger.warning("[%s] Cannot execute HMS action: not connected", self.serial_number)
  8188. return False
  8189. # Always re-push the full state after a command so the modal's underlying
  8190. # status query reflects the new error list (or absence) on the next tick.
  8191. def publish(payload: dict):
  8192. self._client.publish(self.topic_publish, json.dumps(payload), qos=1)
  8193. self._client.publish(
  8194. self.topic_publish, json.dumps({"pushing": {"command": "pushall", "sequence_id": "0"}}), qos=1
  8195. )
  8196. # BambuStudio's `err` field is the DECIMAL string of the error code's int
  8197. # value (DeviceErrorDialog.cpp passes `std::to_string(m_error_code)` to
  8198. # every command_hms_* call). Our route hands us the hex string —
  8199. # convert. Falls back to the raw input if it's not parseable so the
  8200. # firmware can reject it and the route can surface 502 instead of us
  8201. # raising ValueError mid-dispatch.
  8202. try:
  8203. err_decimal = str(int(print_error, 16))
  8204. except ValueError:
  8205. err_decimal = print_error
  8206. def hms_resume():
  8207. # Plain resume — verified against the user's H2D/H2S to leave PAUSE
  8208. # cleanly when "Problem Solved and Resume" is clicked. BambuStudio
  8209. # sends `{command: "resume", err: "<decimal>", param: "reserve",
  8210. # job_id: ...}` from `command_hms_resume`; we kept the simpler
  8211. # shape historically because it works, and changing it without a
  8212. # field test risks regressing a path that the user has confirmed.
  8213. publish(
  8214. {
  8215. "print": {
  8216. "command": "resume",
  8217. "param": "",
  8218. "sequence_id": "0",
  8219. }
  8220. }
  8221. )
  8222. def hms_stop():
  8223. # Same as hms_resume — plain shape, confirmed working by the user
  8224. # for "Stop Printing".
  8225. publish(
  8226. {
  8227. "print": {
  8228. "command": "stop",
  8229. "param": "",
  8230. "sequence_id": "0",
  8231. }
  8232. }
  8233. )
  8234. def hms_ignore_command():
  8235. # BambuStudio's `command_hms_ignore` (DeviceManager.cpp:1450) —
  8236. # what the "Ignore this and Resume" button actually publishes.
  8237. # Distinct from `idle_ignore`: this command has the firmware
  8238. # suppress the next re-check of the named fault AND resume the
  8239. # paused print in a single operation. The previous Bambuddy code
  8240. # redirected IGNORE_RESUME to a plain `resume`, which is why the
  8241. # wrong-plate HMS came back 1-2 s later: `resume` means "I fixed
  8242. # the problem, re-check normally" so the firmware re-detected the
  8243. # wrong plate and re-paused with the same code (#1869).
  8244. #
  8245. # BambuStudio also routes IGNORE_NO_REMINDER_NEXT_TIME (a.k.a.
  8246. # DONT_REMIND_NEXT_TIME) to this same command — the persistent
  8247. # variant of "don't remind next time" lives on `idle_ignore`'s
  8248. # type=1, not as a separate ignore shape.
  8249. publish(
  8250. {
  8251. "print": {
  8252. "command": "ignore",
  8253. "err": err_decimal,
  8254. "param": "reserve",
  8255. "job_id": job_id or "",
  8256. "sequence_id": "0",
  8257. }
  8258. }
  8259. )
  8260. def hms_idle_ignore(persistent: bool = False):
  8261. # `idle_ignore` is BambuStudio's "dismiss this warning without
  8262. # resuming" command for non-pause warnings — what
  8263. # `command_hms_idle_ignore` (DeviceManager.cpp:1424) sends.
  8264. # type=0 dismisses once, type=1 suppresses the same warning
  8265. # permanently. Used by NO_REMINDER_NEXT_TIME, which BambuStudio
  8266. # explicitly dispatches via `command_hms_idle_ignore(..., 0)` —
  8267. # NOT via the resume-bearing `ignore` command.
  8268. publish(
  8269. {
  8270. "print": {
  8271. "command": "idle_ignore",
  8272. "err": err_decimal,
  8273. "type": 1 if persistent else 0,
  8274. "sequence_id": "0",
  8275. }
  8276. }
  8277. )
  8278. def ams_control(param: str):
  8279. publish(
  8280. {
  8281. "print": {
  8282. "command": "ams_control",
  8283. "param": param,
  8284. "sequence_id": "0",
  8285. }
  8286. }
  8287. )
  8288. def clean_print_error():
  8289. # Matches the existing `clear_hms_errors` shape — Bambu does not
  8290. # expect `print_error` in the body; the command clears whatever
  8291. # error dialog is currently active on the printer.
  8292. publish(
  8293. {
  8294. "print": {
  8295. "command": "clean_print_error",
  8296. "sequence_id": "0",
  8297. }
  8298. }
  8299. )
  8300. def uiop_close():
  8301. # `err` is the 8-char hex short code (already a string from the
  8302. # frontend), uppercased for consistency with how BambuStudio sends it.
  8303. publish(
  8304. {
  8305. "system": {
  8306. "command": "uiop",
  8307. "name": "print_error",
  8308. "action": "close",
  8309. "source": 1,
  8310. "type": "dialog",
  8311. "err": print_error.upper(),
  8312. "sequence_id": "0",
  8313. }
  8314. }
  8315. )
  8316. match action:
  8317. case (
  8318. HMSAction.RESUME_PRINTING
  8319. | HMSAction.RESUME_PRINTING_DEFECTS
  8320. | HMSAction.RESUME_PRINTING_PROBELM_SOLVED
  8321. | HMSAction.PROBLEM_SOLVED_RESUME
  8322. | HMSAction.FILAMENT_LOAD_RESUME
  8323. | HMSAction.PROCEED
  8324. ):
  8325. hms_resume()
  8326. case HMSAction.STOP_PRINTING:
  8327. hms_stop()
  8328. case HMSAction.IGNORE_RESUME | HMSAction.IGNORE_NO_REMINDER_NEXT_TIME | HMSAction.DONT_REMIND_NEXT_TIME:
  8329. # All three buttons map to BambuStudio's `command_hms_ignore`
  8330. # (DeviceErrorDialog.cpp:596-602). The "no reminder next time"
  8331. # half of IGNORE_NO_REMINDER_NEXT_TIME is the firmware's
  8332. # responsibility — the wire shape is identical.
  8333. hms_ignore_command()
  8334. case HMSAction.NO_REMINDER_NEXT_TIME:
  8335. # BambuStudio's NO_REMINDER_NEXT_TIME branch dispatches
  8336. # `command_hms_idle_ignore` with type=0
  8337. # (DeviceErrorDialog.cpp:588-590). Distinct from the
  8338. # IGNORE_* buttons above: idle_ignore does NOT resume, only
  8339. # dismisses the dialog.
  8340. hms_idle_ignore(persistent=False)
  8341. case HMSAction.FILAMENT_EXTRUDED | HMSAction.DBL_CHECK_DONE:
  8342. ams_control("done")
  8343. case (
  8344. HMSAction.RETRY_FILAMENT_EXTRUDED
  8345. | HMSAction.CONTINUE
  8346. | HMSAction.RETRY_PROBLEM_SOLVED
  8347. | HMSAction.DBL_CHECK_RETRY
  8348. ):
  8349. ams_control("resume")
  8350. case HMSAction.ABORT:
  8351. ams_control("abort")
  8352. case HMSAction.OK_BUTTON:
  8353. clean_print_error()
  8354. case HMSAction.DBL_CHECK_OK:
  8355. clean_print_error()
  8356. uiop_close()
  8357. case HMSAction.DBL_CHECK_RESUME:
  8358. # Plain resume — not HMS-aware, no err/job_id.
  8359. publish(
  8360. {
  8361. "print": {
  8362. "command": "resume",
  8363. "param": "",
  8364. "sequence_id": "0",
  8365. }
  8366. }
  8367. )
  8368. case HMSAction.REFRESH_NOZZLE:
  8369. publish({"print": {"command": "refresh_nozzle", "sequence_id": "0"}})
  8370. case HMSAction.TURN_OFF_FIRE_ALARM:
  8371. publish({"print": {"command": "buzzer_ctrl", "mode": 0, "sequence_id": "0"}})
  8372. case HMSAction.STOP_DRYING:
  8373. publish({"print": {"command": "auto_stop_ams_dry", "sequence_id": "0"}})
  8374. case HMSAction.DISABLE_PURIFICATION:
  8375. publish({"print": {"command": "close_air_filt", "sequence_id": "0"}})
  8376. case (
  8377. HMSAction.CHECK_ASSISTANT
  8378. | HMSAction.JUMP_TO_LIVEVIEW
  8379. | HMSAction.OK_JUMP_RACK
  8380. | HMSAction.REMOVE_CLOSE_BTN
  8381. | HMSAction.LOAD_VIRTUAL_TRAY
  8382. | HMSAction.CANCLE
  8383. | HMSAction.DBL_CHECK_CANCEL
  8384. ):
  8385. # UI-only actions — the printer's own screen handles these; the
  8386. # modal still surfaces them so the user has parity with Studio.
  8387. pass
  8388. case _:
  8389. logger.warning("[%s] Unknown HMS action '%s'", self.serial_number, action)
  8390. return False
  8391. return True