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