mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-09-19 22:07:28 +02:00
1 line
No EOL
11 KiB
JavaScript
1 line
No EOL
11 KiB
JavaScript
Search.setIndex({docnames:["actor","contribute","core","index","install","kettle_controller","properties","sensor","standards","step","webapis"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["actor.rst","contribute.rst","core.rst","index.rst","install.rst","kettle_controller.rst","properties.rst","sensor.rst","standards.rst","step.rst","webapis.rst"],objects:{"cbpi.api":{CBPiActor:[0,0,1,""],CBPiKettleLogic:[5,0,1,""],CBPiSensor:[7,0,1,""],CBPiSimpleStep:[9,0,1,""],Property:[6,0,1,""]},"cbpi.api.CBPiActor":{_abc_impl:[0,1,1,""],init:[0,2,1,""],off:[0,2,1,""],on:[0,2,1,""],reprJSON:[0,2,1,""],state:[0,2,1,""],stop:[0,2,1,""]},"cbpi.api.CBPiKettleLogic":{init:[5,2,1,""],run:[5,2,1,""],stop:[5,2,1,""]},"cbpi.api.CBPiSensor":{init:[7,2,1,""],log_data:[7,2,1,""],run:[7,2,1,""],state:[7,2,1,""]},"cbpi.api.CBPiSimpleStep":{is_dirty:[9,2,1,""],managed_fields:[9,1,1,""],next:[9,2,1,""],reset:[9,2,1,""],reset_dirty:[9,2,1,""],run:[9,2,1,""],run_cycle:[9,2,1,""],running:[9,2,1,""],stop:[9,2,1,""]},"cbpi.api.Property":{Actor:[6,0,1,""],Kettle:[6,0,1,""],Number:[6,0,1,""],Select:[6,0,1,""],Sensor:[6,0,1,""],Text:[6,0,1,""]},"cbpi.controller.actor_controller":{ActorController:[0,0,1,""]},"cbpi.controller.actor_controller.ActorController":{_abc_impl:[0,1,1,""],_init_actor:[0,2,1,""],_post_add_callback:[0,2,1,""],_post_update_callback:[0,2,1,""],_pre_delete_callback:[0,2,1,""],_pre_update_callback:[0,2,1,""],_stop_actor:[0,2,1,""],call_action:[0,2,1,""],get_state:[0,2,1,""],init:[0,2,1,""],model:[0,1,1,""],off:[0,2,1,""],on:[0,2,1,""],toggle:[0,2,1,""]},"cbpi.controller.kettle_controller":{KettleController:[5,0,1,""]},"cbpi.controller.kettle_controller.KettleController":{_abc_impl:[5,1,1,""],_is_logic_running:[5,2,1,""],agitator_off:[5,2,1,""],agitator_on:[5,2,1,""],get_state:[5,2,1,""],get_temp:[5,2,1,""],get_traget_temp:[5,2,1,""],handle_automtic_event:[5,2,1,""],heater_off:[5,2,1,""],heater_on:[5,2,1,""],init:[5,2,1,""],job_stop:[5,2,1,""],model:[5,1,1,""],toggle_automtic:[5,2,1,""]},"cbpi.controller.sensor_controller":{SensorController:[7,0,1,""]},"cbpi.controller.sensor_controller.SensorController":{_abc_impl:[7,1,1,""],_post_add_callback:[7,2,1,""],_post_update_callback:[7,2,1,""],_pre_delete_callback:[7,2,1,""],_pre_update_callback:[7,2,1,""],get_state:[7,2,1,""],get_value:[7,2,1,""],init:[7,2,1,""],init_sensor:[7,2,1,""],model:[7,1,1,""],stop_sensor:[7,2,1,""]},"cbpi.controller.step_controller":{StepController:[9,0,1,""]},"cbpi.controller.step_controller.StepController":{handle_action:[9,2,1,""],handle_reset:[9,2,1,""],init:[9,2,1,""],next:[9,2,1,""],start:[9,2,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:attribute","2":"py:method"},terms:{"1wire":6,"abstract":[],"boolean":5,"break":5,"byte":[],"class":[0,5,6,7,9],"default":[],"function":8,"import":[0,5,6,7,9],"int":[0,5,6],"new":[8,9],"public":8,"return":[0,5,6,7,8,9],"super":[4,7],"switch":[0,5,8],"true":[0,5,6,7,9],"try":[0,5,6],"while":[5,7],FOR:[],For:[4,6],One:8,THE:[],That:[4,9,10],The:[0,4,5,6,8,9,10],Theses:6,Using:[0,6],YES:[],__delattr__:[],__dict__:[],__dir__:[],__eq__:[],__format__:[],__ge__:[],__getattribute__:[],__gt__:[],__hash__:[],__init__:[0,5,6,7,9],__init_subclass__:[],__le__:[],__lt__:[],__name__:[0,6],__ne__:[],__new__:[],__reduce__:[],__reduce_ex__:[],__repr__:[],__setattr__:[],__sizeof__:[],__str__:[],__subclasscheck__:[],__subclasshook__:[],__weakref__:[],_abc_data:[0,5,7],_abc_impl:[0,5,7],_asyncio:0,_exception_count:[],_get_manged_fields_as_arrai:[],_init_actor:0,_interv:[],_is_logic_run:5,_max_except:[],_post_add_callback:[0,7],_post_delete_callback:[],_post_update_callback:[0,7],_pre_add_callback:[],_pre_delete_callback:[0,7],_pre_update_callback:[0,7],_simplestep__dirti:[],_step_don:[],_stop_actor:0,abc:[],abcmeta:[],access:8,accur:[],action:[7,8,9],actor:[3,5,7,8],actor_control:0,actor_id:0,actorcontrol:3,actorhttp:[],actormodel:0,add:[4,8],adding:8,addtion:[8,9],after:[8,10],again:4,agitator_off:5,agitator_on:5,aiohttp:8,algorithm:[],alia:[0,5,7],all:[0,4,5,6,7,8],allow:[],also:4,amaz:5,api:[0,3,5,6,7,9],app:5,applic:[],architectur:3,arg:[0,5,7,9],assigend:9,async:[5,7,8,9],asyncio:[5,7,9],attent:4,auth_requir:8,automat:[4,5],avail:[6,8,10],avoid:8,await:[5,7],babel:8,babelj:8,babl:8,background:[5,9],background_task:[],base:[0,5,7,8,9],between:0,block:[],bodi:[],brew:3,build:8,bus:[5,7,8],cach:[],call:[0,4,5,6,7,8,9],call_act:0,callback:5,can:[0,4,6,7,8,10],caus:8,cbpi:[0,4,5,6,7,8,9],cbpi_api:[],cbpiactor1:4,cbpiactor:[3,6],cbpieventbu:3,cbpiexcept:[0,6],cbpiextens:[0,5,7],cbpikettlelog:3,cbpisensor:3,cbpisimplestep:3,cbpiwebsocket:3,ccstom:9,chanag:[],chang:8,check:9,clazz:[],client:[8,10],clone:[],code:[0,5],com:[],command:4,compon:8,component:[],concept:8,config:[0,4,5,7,9],configur:[0,6,7,9],connect:[0,6,8,10],continu:9,control:[0,3,5,8,9],conveni:5,core:[0,3,5,6,7,8,9],coupl:8,craftbeerpi4:[],craftbeerpi:8,creat:[0,4,5,7],create_futur:5,crud_control:[0,5,7],crudcontrol:[0,5,7],current:[0,8,9,10],custom:3,customactor:[0,6],customkettlelog:5,customlog:5,customsensor:7,customstep:[],customstepcbpi:9,cycl:9,dark:10,data:[0,8,10],databas:[0,5,7,8],decor:8,def:[0,5,6,7,8,9],default_callback:5,default_valu:6,defin:[8,9],delattr:[],delet:[],delete_al:[],depend:4,descript:[0,6],dict:[0,6],dir:[],directli:8,directori:4,dirti:9,doc:[8,10],document:[8,10],documentaiton:8,doe:[],done:[],download:3,dummyactor:0,dummykettlelog:5,dummysensor:7,dummystep:9,dure:[0,4,5,6,7,9],earli:[],easi:4,easili:8,els:5,enabl:10,end:[],endpoint:[3,10],error:[0,6],event:[0,5,8,9],eventbu:[],exampel:7,exampl:[4,6,8,9],except:[0,5,6,8],exect:9,execut:[5,9],expos:[6,8],extend:[8,9],extens:[0,3,5,6,7],fail:[0,6],faild:[0,6],fals:[0,6,8,9],file:3,find:8,finish:[],fire:[7,8],first:[4,9],flag:9,folder:4,follow:[4,8,10],force_db_upd:[],format:[],formatt:[],forward:8,found:[4,8],framework:8,from:[0,4,5,6,7,9],further:4,futur:[0,5],future_obj:5,gener:8,get:4,get_al:[],get_manged_fields_as_arrai:[],get_on:[],get_stat:[0,5,7],get_temp:5,get_traget_temp:5,get_valu:[5,7],getattr:[],getlogg:[0,6],git:[],github:[],goe:[],gpio:[0,6],gpioactor:[0,6],gpiorelayboardactor:[0,6],guidelin:3,hallo:[],handl:5,handle_act:9,handle_automtic_ev:5,handle_don:[],handle_next:[],handle_reset:9,handle_start:[],handle_step_don:[],handle_stop:[],handler:9,has:9,hash:[],have:[4,8],heater:5,heater_off:5,heater_on:5,hello:[5,8,9],help:[],helper:[],here:[0,5,6,7,8,9],homebrew:4,how:[6,8],http:[3,4,10],http_action:[],http_add:[],http_api:[],http_delete_on:[],http_endpoint:[],http_get_al:[],http_get_on:[],http_next:[],http_off:[],http_on:8,http_reset:[],http_start:[],http_toggl:[],http_updat:[],httpapi:[],implement:[5,9],implementaion:9,imporant:8,info:[0,6,8],inform:8,inherit:9,init:[0,5,6,7,9],init_sensor:7,initi:[0,5,7,9],initialis:[5,8],instal:3,instanc:[0,5,7],int64:[],integ:0,interfac:3,interg:[],intern:7,interv:[7,9],invalid:[],invok:9,ip_address:8,is_dirti:9,issubclass:[],job_stop:5,json:[],just:[4,8,10],keep:5,kei:[5,7,8,9],kettl:[3,6],kettle_control:5,kettle_id:5,kettle_log:[],kettlecontrol:3,kettlemodel:5,kwarg:[0,5,8,9],kwd:[0,5,7],label:[5,6,7,9],last:9,latest:8,least:[4,9],list:[6,8],listen:8,liten:[],load:[0,6],locat:8,log:[0,4,6,7],log_data:7,logger:[0,6],logic:[3,9],login:[],loop:5,loos:8,maco:3,magicmock:[0,6],mai:[],main:[0,5,8],make:[4,8],manag:9,managed_field:9,manuel83:[],manuel:[],mayb:8,mean:10,member:9,memori:[],messag:[8,9],met:[],method:[0,5,6,7,8,9],mock:[0,6],mockrpi:[0,6],model:[0,5,7],modifi:9,modul:[0,6],moment:10,more:8,my_callback:5,myaction:7,name:[0,5,7,9],need:[0,5,6,7,9,10],next:9,none:[0,5,6,7,8,9],normal:4,noth:[],notif:8,notifi:9,notimpl:[],number:[5,6,7,9],object:[0,5,7,9],off:[0,5,6],on_ev:8,one:[8,9],onli:8,oper:[],option:[0,4,6],org:[4,8],other:8,otherwis:9,out:[0,6],outcom:[],output:[0,6],overrid:[],overridden:[],overwritten:[5,9],packag:4,param:[0,5,6,7,9],parament:8,paramet:[0,5,6,7,8,9],pass:[0,5,6,7,8],password:10,patch:[0,6],patcher:[0,6],path:8,perform:8,persisit:9,pickl:[],pip3:4,pip:4,pipi:4,place:[8,9],plain:[],pleas:4,plugin:[0,3,5,6,7,8,9],pluin:3,point:[],pong:[],port:[8,10],power:[0,6,8],print:[0,5,6,9],process:[5,8],produc:[],project:4,properti:[0,3,5,7,9],propertytyp:[],provid:[0,9],push:[8,10],put:9,pyhton:8,pypi:4,python:[3,4],rais:[0,6],random:7,rapsbian:4,raspberri:3,reactj:8,readthedoc:8,recommend:10,redux:8,refer:[],regist:[0,5,6,7,8,9],remov:4,repr:[],reprjson:0,request:[8,9],request_map:8,requir:4,requset:[],reset:9,reset_dirti:9,respons:[5,8,9],rest:3,result:[5,8],rpi:[0,6],run:[3,5,6,7,9],run_cycl:9,runtim:7,scan:6,schema:[],secur:10,see:8,select:[0,6],self:[0,5,6,7,8,9],sensor:[3,5,6],sensor_control:7,sensor_id:7,sensorcontrol:7,sensormodel:7,sensorontrol:[],server:[0,3,5,6,7,8,9,10],server_ip:10,servic:[],session:8,set:6,set_result:5,setattr:[],setup:[0,5,6,7,9],shell:4,should:[8,9],show:9,signatur:[],simpl:[4,9],simplestep:[],size:[],sleep:[5,7],socket:8,some:8,sql:3,stabl:8,standard:3,start:[0,4,5,6,9],startup:[0,4,5,6,7,8,9,10],state:[0,6,7],statu:8,step:[3,8],step_control:9,stepcontrol:3,stepmodel:[],stop:[0,5,7,9],stop_sensor:7,str:[0,6],stretch:4,string:5,structur:8,subclass:[],success:[],sudo:4,support:0,sure:[4,8],swagger:[8,10],swtich:[],sys:[0,6],system:[6,8],tag:[],task:[],termin:10,test:[4,5,7,9,10],text:[6,7],thi:[0,5,6,7,8,9],time:6,timeout:5,timeouterror:5,toggl:[0,5],toggle_automt:5,top:8,topic:[0,5,8],trigger:[],txt:[],type:[6,8],type_cfg:[],typic:[5,6,8],under:[8,10],undoc:9,uninstal:4,unit:6,unittest:[0,6],unregist:5,updat:3,upgrad:4,url:8,usag:[],use:[6,10],used:8,user:[0,3,6,7],using:[8,10],valid:8,valu:[0,5,6,7,9],variabl:[6,7,9],version:[0,4,5,7,9],via:[4,8],virtual:[],wai:8,wait:[],wait_for:5,wait_for_ev:5,weak:[],web:[3,10],web_respons:[],webpack:8,websit:4,websocket:3,welt:[],when:5,where:4,whether:8,which:[0,5,6,7,9],within:8,woohoo:9,world:8,yaml:[0,5,7,9],yes:9,you:[0,5,6,7,8,9,10],your:[0,4,5,6,7,9]},titles:["Actor","Core","Core","Welcome to CraftBeerPi\u2019s documentation!","Installation","Kettle","Properties","Sensor","Standard & Guidelines","Brewing Step","REST API"],titleterms:{actor:[0,6],actorcontrol:0,api:[8,10],architectur:0,brew:9,cbpiactor:0,cbpieventbu:8,cbpikettlelog:5,cbpisensor:7,cbpisimplestep:9,cbpiwebsocket:8,control:7,core:[1,2],craftbeerpi:[3,4],custom:[0,5,6,7,8,9],document:3,download:4,endpoint:8,eventbu:[],extens:8,file:8,guidelin:8,http:8,instal:4,interfac:8,kettl:5,kettlecontrol:5,logic:5,maco:4,plugin:4,pluin:8,properti:6,python:8,raspberri:4,rest:[8,10],run:4,sensor:7,sensorcontrol:[],sensorontrol:[],server:4,simplestep:[],sql:8,standard:8,step:9,stepcontrol:9,updat:4,user:8,web:8,websocket:10,welcom:3}}) |