mirror of
				https://github.com/esphome/esphome.git
				synced 2025-11-03 16:41:50 +00:00 
			
		
		
		
	Compare commits
	
		
			707 Commits
		
	
	
		
			2025.6.3
			...
			revert-943
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					01ac30f210 | ||
| 
						 | 
					189d20a822 | ||
| 
						 | 
					08defd7360 | ||
| 
						 | 
					59d466a6c8 | ||
| 
						 | 
					85435e6b5f | ||
| 
						 | 
					f9453f9642 | ||
| 
						 | 
					f6cdbe37f9 | ||
| 
						 | 
					d6b222c370 | ||
| 
						 | 
					eecdaa5163 | ||
| 
						 | 
					4933ef780b | ||
| 
						 | 
					1702356fc8 | ||
| 
						 | 
					05f6d01cbe | ||
| 
						 | 
					573dad1736 | ||
| 
						 | 
					3a6cc0ea3d | ||
| 
						 | 
					2f9475a927 | ||
| 
						 | 
					8dce7b0905 | ||
| 
						 | 
					8b0ad3072f | ||
| 
						 | 
					93028a4d90 | ||
| 
						 | 
					c9793f3741 | ||
| 
						 | 
					5029e248eb | ||
| 
						 | 
					087970bca8 | ||
| 
						 | 
					7f0c66f835 | ||
| 
						 | 
					84ed1bcf34 | ||
| 
						 | 
					6ed9214465 | ||
| 
						 | 
					a3690422bf | ||
| 
						 | 
					20b61d4bdb | ||
| 
						 | 
					a2ed209542 | ||
| 
						 | 
					14862904ac | ||
| 
						 | 
					bcc56648c0 | ||
| 
						 | 
					e00839a608 | ||
| 
						 | 
					cf73f72119 | ||
| 
						 | 
					981b906579 | ||
| 
						 | 
					0e2520e4c0 | ||
| 
						 | 
					84ffa4274c | ||
| 
						 | 
					d64e4d3c49 | ||
| 
						 | 
					d54db471bd | ||
| 
						 | 
					a9d6ece752 | ||
| 
						 | 
					da491f7090 | ||
| 
						 | 
					11f970edec | ||
| 
						 | 
					6d37b916dc | ||
| 
						 | 
					b6e0188c42 | ||
| 
						 | 
					b7ce8c116b | ||
| 
						 | 
					2b87589562 | ||
| 
						 | 
					f808c38f10 | ||
| 
						 | 
					88ccde4ba1 | ||
| 
						 | 
					9ac10d7276 | ||
| 
						 | 
					457689fa1d | ||
| 
						 | 
					773a8b8fb7 | ||
| 
						 | 
					c5c0237a4b | ||
| 
						 | 
					e79589efee | ||
| 
						 | 
					ffebd30033 | ||
| 
						 | 
					cb87f156d0 | ||
| 
						 | 
					06eba96fdc | ||
| 
						 | 
					27119ef7ad | ||
| 
						 | 
					73f58dfe80 | ||
| 
						 | 
					729f20d765 | ||
| 
						 | 
					ba72298a63 | ||
| 
						 | 
					ba1de5feff | ||
| 
						 | 
					1344103086 | ||
| 
						 | 
					5bff9bc8d9 | ||
| 
						 | 
					568e774116 | ||
| 
						 | 
					c74f12be98 | ||
| 
						 | 
					705ea4ebaa | ||
| 
						 | 
					ec2e0c50f1 | ||
| 
						 | 
					544cf9b9c0 | ||
| 
						 | 
					99850255f0 | ||
| 
						 | 
					4a27b34685 | ||
| 
						 | 
					f863189f96 | ||
| 
						 | 
					04d9698681 | ||
| 
						 | 
					15ba2326ad | ||
| 
						 | 
					6398bb2fdf | ||
| 
						 | 
					108e447072 | ||
| 
						 | 
					cc187ef276 | ||
| 
						 | 
					a3e626757e | ||
| 
						 | 
					5cd7f156b9 | ||
| 
						 | 
					3960e2bae7 | ||
| 
						 | 
					f9534fbd5d | ||
| 
						 | 
					0744abe098 | ||
| 
						 | 
					49df68beb6 | ||
| 
						 | 
					e94cb03272 | ||
| 
						 | 
					6ac1073469 | ||
| 
						 | 
					378b687a82 | ||
| 
						 | 
					babaa1db3f | ||
| 
						 | 
					bb6f8aeb94 | ||
| 
						 | 
					b636b844fc | ||
| 
						 | 
					d7a5db3dda | ||
| 
						 | 
					ac7f125eb5 | ||
| 
						 | 
					7bfb08e602 | ||
| 
						 | 
					a994ad3642 | ||
| 
						 | 
					116c91e9c5 | ||
| 
						 | 
					5a4e2a3eaf | ||
| 
						 | 
					1a7757e7ca | ||
| 
						 | 
					e2976162b5 | ||
| 
						 | 
					cf40306297 | ||
| 
						 | 
					fef2369e66 | ||
| 
						 | 
					2b5cceda58 | ||
| 
						 | 
					3bb5a9e2f7 | ||
| 
						 | 
					a614a68f1a | ||
| 
						 | 
					dc26ed9c46 | ||
| 
						 | 
					8674012406 | ||
| 
						 | 
					ae12deff87 | ||
| 
						 | 
					cb6acfe24b | ||
| 
						 | 
					fc8c5a7438 | ||
| 
						 | 
					f8777d3b66 | ||
| 
						 | 
					76e75f4cdc | ||
| 
						 | 
					896d7f8f76 | ||
| 
						 | 
					d92ee563f2 | ||
| 
						 | 
					d6ff790823 | ||
| 
						 | 
					7ac60c15dc | ||
| 
						 | 
					71cb429a86 | ||
| 
						 | 
					89924ae468 | ||
| 
						 | 
					7efe1b8698 | ||
| 
						 | 
					ac08fb314f | ||
| 
						 | 
					0f0038df24 | ||
| 
						 | 
					b17e2019c7 | ||
| 
						 | 
					e56b681506 | ||
| 
						 | 
					238c72b66f | ||
| 
						 | 
					118b74b7cd | ||
| 
						 | 
					5343a6d16a | ||
| 
						 | 
					db62a94712 | ||
| 
						 | 
					74ce3d2c0b | ||
| 
						 | 
					a04c2c8471 | ||
| 
						 | 
					16a426c182 | ||
| 
						 | 
					e485895d97 | ||
| 
						 | 
					5fed708761 | ||
| 
						 | 
					fe1050a583 | ||
| 
						 | 
					305667b06d | ||
| 
						 | 
					fc286c8bf4 | ||
| 
						 | 
					c60fe4c372 | ||
| 
						 | 
					a8d53b7c68 | ||
| 
						 | 
					9508871474 | ||
| 
						 | 
					a45a45c688 | ||
| 
						 | 
					46da075226 | ||
| 
						 | 
					efd83dedda | ||
| 
						 | 
					06bd1472de | ||
| 
						 | 
					bb9011d65d | ||
| 
						 | 
					5b5982cfdd | ||
| 
						 | 
					ecd310dae1 | ||
| 
						 | 
					acca629c5c | ||
| 
						 | 
					0aabdaa0c7 | ||
| 
						 | 
					e5aed29231 | ||
| 
						 | 
					2540e7edb2 | ||
| 
						 | 
					5511d61dba | ||
| 
						 | 
					e474a33abd | ||
| 
						 | 
					534a1cf2e7 | ||
| 
						 | 
					335110d71f | ||
| 
						 | 
					6e31fb181e | ||
| 
						 | 
					7d30d1e987 | ||
| 
						 | 
					1e35c07327 | ||
| 
						 | 
					5b3d61b4a6 | ||
| 
						 | 
					727e8ca376 | ||
| 
						 | 
					5ed77c10ae | ||
| 
						 | 
					89b9bddf1b | ||
| 
						 | 
					65cbb0d741 | ||
| 
						 | 
					9533d52d86 | ||
| 
						 | 
					6fe4ffa0cf | ||
| 
						 | 
					19a68dc650 | ||
| 
						 | 
					576ce7ee35 | ||
| 
						 | 
					8a45e877bb | ||
| 
						 | 
					84607c1255 | ||
| 
						 | 
					8664ec0a3b | ||
| 
						 | 
					32d8c60a0b | ||
| 
						 | 
					976a1e27b4 | ||
| 
						 | 
					cc2c1b1d89 | ||
| 
						 | 
					85495d38b7 | ||
| 
						 | 
					84a77ee427 | ||
| 
						 | 
					11a4115e30 | ||
| 
						 | 
					121ed687f3 | ||
| 
						 | 
					c602f3082e | ||
| 
						 | 
					4a43f922c6 | ||
| 
						 | 
					21e66b76e4 | ||
| 
						 | 
					cdeed7afa7 | ||
| 
						 | 
					6cefe943e9 | ||
| 
						 | 
					6f74decd79 | ||
| 
						 | 
					60350e8abd | ||
| 
						 | 
					08407706aa | ||
| 
						 | 
					cb8d9dca2a | ||
| 
						 | 
					3f8494bf8f | ||
| 
						 | 
					95a08579f6 | ||
| 
						 | 
					a11c39bdc9 | ||
| 
						 | 
					71cc298363 | ||
| 
						 | 
					0d422bd74f | ||
| 
						 | 
					ce3a16f03c | ||
| 
						 | 
					72905f5f42 | ||
| 
						 | 
					b5b301f935 | ||
| 
						 | 
					afc48812fa | ||
| 
						 | 
					e189add8a3 | ||
| 
						 | 
					f8146bd340 | ||
| 
						 | 
					ec5a517a76 | ||
| 
						 | 
					f7314adff4 | ||
| 
						 | 
					f0f76066f3 | ||
| 
						 | 
					35c7937df3 | ||
| 
						 | 
					a18adb8f6e | ||
| 
						 | 
					1ebf157768 | ||
| 
						 | 
					4bd0561ba3 | ||
| 
						 | 
					a18ddd1169 | ||
| 
						 | 
					158a3b2835 | ||
| 
						 | 
					eb8a241a01 | ||
| 
						 | 
					7cdb48b820 | ||
| 
						 | 
					558e175c6b | ||
| 
						 | 
					dfa8c8c77f | ||
| 
						 | 
					7f807e08b1 | ||
| 
						 | 
					fc1fd3f897 | ||
| 
						 | 
					f5afe1145e | ||
| 
						 | 
					91e5bcf787 | ||
| 
						 | 
					4378d10f45 | ||
| 
						 | 
					6178e7d6c8 | ||
| 
						 | 
					b01f42d995 | ||
| 
						 | 
					3f842806ae | ||
| 
						 | 
					2347375757 | ||
| 
						 | 
					513908d8a0 | ||
| 
						 | 
					f7acad747f | ||
| 
						 | 
					b361b93722 | ||
| 
						 | 
					3713f7004d | ||
| 
						 | 
					1a9f02fa63 | ||
| 
						 | 
					66dd5138b9 | ||
| 
						 | 
					44979f0840 | ||
| 
						 | 
					7ad1b039f9 | ||
| 
						 | 
					e255d73c29 | ||
| 
						 | 
					46f5c44b37 | ||
| 
						 | 
					9d80889bc9 | ||
| 
						 | 
					08a5ba6ef1 | ||
| 
						 | 
					28128c65e5 | ||
| 
						 | 
					efcad565ee | ||
| 
						 | 
					cd987feb5b | ||
| 
						 | 
					b2406f9def | ||
| 
						 | 
					b1048d6e25 | ||
| 
						 | 
					a8263cb79f | ||
| 
						 | 
					7868b2b456 | ||
| 
						 | 
					faaaded0b1 | ||
| 
						 | 
					c14b102776 | ||
| 
						 | 
					b1655b3fd4 | ||
| 
						 | 
					02999195cd | ||
| 
						 | 
					8415467dab | ||
| 
						 | 
					66b6985975 | ||
| 
						 | 
					b6e8f6398c | ||
| 
						 | 
					0958e49965 | ||
| 
						 | 
					f4cd559a0b | ||
| 
						 | 
					c93b892ccc | ||
| 
						 | 
					78c32eac04 | ||
| 
						 | 
					9e621a1769 | ||
| 
						 | 
					d0b45f7cb6 | ||
| 
						 | 
					e40b45cab1 | ||
| 
						 | 
					b15a09e8bc | ||
| 
						 | 
					5707389faa | ||
| 
						 | 
					15768ec00d | ||
| 
						 | 
					2c478efcba | ||
| 
						 | 
					9ae8c5b147 | ||
| 
						 | 
					63e2e2b2a2 | ||
| 
						 | 
					3ab1ee7a04 | ||
| 
						 | 
					f3c0c0c00c | ||
| 
						 | 
					231bcb1f7d | ||
| 
						 | 
					9cac1c824e | ||
| 
						 | 
					c691f01c7f | ||
| 
						 | 
					b648944973 | ||
| 
						 | 
					40935f7ae4 | ||
| 
						 | 
					e152690867 | ||
| 
						 | 
					b1c86fe30e | ||
| 
						 | 
					b695f13f86 | ||
| 
						 | 
					ab54a880c1 | ||
| 
						 | 
					f745135bdc | ||
| 
						 | 
					30c4b91697 | ||
| 
						 | 
					bfaf2547e3 | ||
| 
						 | 
					b5be45273f | ||
| 
						 | 
					5c2dea79ef | ||
| 
						 | 
					e012fd5b32 | ||
| 
						 | 
					856cb182fc | ||
| 
						 | 
					6486147da1 | ||
| 
						 | 
					5480675dd8 | ||
| 
						 | 
					6ab3de65a6 | ||
| 
						 | 
					5d9cba3dce | ||
| 
						 | 
					3f78db5c63 | ||
| 
						 | 
					eb81b8a1c8 | ||
| 
						 | 
					de0656a188 | ||
| 
						 | 
					90a16ffa89 | ||
| 
						 | 
					4182076f64 | ||
| 
						 | 
					8c8c08d40c | ||
| 
						 | 
					82120bc5d7 | ||
| 
						 | 
					9769f8a4cc | ||
| 
						 | 
					0968338064 | ||
| 
						 | 
					18e2f41424 | ||
| 
						 | 
					bd0fe34b14 | ||
| 
						 | 
					6e90feeccf | ||
| 
						 | 
					37982290f7 | ||
| 
						 | 
					02b7db7311 | ||
| 
						 | 
					9bc3ff5f53 | ||
| 
						 | 
					786cb7ded5 | ||
| 
						 | 
					7f01c25782 | ||
| 
						 | 
					321f2f87b0 | ||
| 
						 | 
					11a051401f | ||
| 
						 | 
					6148dd7e41 | ||
| 
						 | 
					42b6939e90 | ||
| 
						 | 
					35b3f75f7c | ||
| 
						 | 
					78e8001aa8 | ||
| 
						 | 
					84fc6ff71a | ||
| 
						 | 
					a896190de5 | ||
| 
						 | 
					e599ab1a03 | ||
| 
						 | 
					d3342d6a1a | ||
| 
						 | 
					3f492e3b82 | ||
| 
						 | 
					b959baf3d6 | ||
| 
						 | 
					63b8a219e6 | ||
| 
						 | 
					84349b6d05 | ||
| 
						 | 
					0f15250f12 | ||
| 
						 | 
					c2f7dcfa6d | ||
| 
						 | 
					778b586d78 | ||
| 
						 | 
					d3d1ba553d | ||
| 
						 | 
					a572d4eb47 | ||
| 
						 | 
					9ae45ba8aa | ||
| 
						 | 
					8f58ca3a2a | ||
| 
						 | 
					e3da197adf | ||
| 
						 | 
					b2a8b0a22f | ||
| 
						 | 
					619e2d69c0 | ||
| 
						 | 
					f78e71c86a | ||
| 
						 | 
					f8c45573f3 | ||
| 
						 | 
					e231d334a3 | ||
| 
						 | 
					e7d819a656 | ||
| 
						 | 
					16292a9f13 | ||
| 
						 | 
					873f4125c5 | ||
| 
						 | 
					90f0ebb22b | ||
| 
						 | 
					4153380f99 | ||
| 
						 | 
					740c0ef9d7 | ||
| 
						 | 
					b4521e1d8c | ||
| 
						 | 
					10ca7ed85b | ||
| 
						 | 
					e43efdaaec | ||
| 
						 | 
					9207bf97f3 | ||
| 
						 | 
					c13317f807 | ||
| 
						 | 
					77d1d0414d | ||
| 
						 | 
					8f42bc6aac | ||
| 
						 | 
					9beb4e2cd4 | ||
| 
						 | 
					097aac2183 | ||
| 
						 | 
					d31b8ad2e2 | ||
| 
						 | 
					f5c8595a46 | ||
| 
						 | 
					02d1894a9f | ||
| 
						 | 
					fc337aef69 | ||
| 
						 | 
					b21c76a6c6 | ||
| 
						 | 
					5416cee2c9 | ||
| 
						 | 
					9e002cd7a3 | ||
| 
						 | 
					9451781915 | ||
| 
						 | 
					84956b6dc5 | ||
| 
						 | 
					6f19808eff | ||
| 
						 | 
					cd8e1548bf | ||
| 
						 | 
					48d55a70c0 | ||
| 
						 | 
					18787b0be0 | ||
| 
						 | 
					39e01c42e1 | ||
| 
						 | 
					c760f89e46 | ||
| 
						 | 
					01b4e214b9 | ||
| 
						 | 
					bc7cfeb9cd | ||
| 
						 | 
					36dd203e74 | ||
| 
						 | 
					8605994cc6 | ||
| 
						 | 
					80fbe28088 | ||
| 
						 | 
					1d9f17a57c | ||
| 
						 | 
					42947bcf56 | ||
| 
						 | 
					3c864b2bca | ||
| 
						 | 
					35d88fc0d6 | ||
| 
						 | 
					7a6894e087 | ||
| 
						 | 
					1b222ceca3 | ||
| 
						 | 
					bab3deee1b | ||
| 
						 | 
					ccd30110b1 | ||
| 
						 | 
					904c7b8a3a | ||
| 
						 | 
					fa262673e4 | ||
| 
						 | 
					0ef5f1fd65 | ||
| 
						 | 
					23dd2d648e | ||
| 
						 | 
					5ba493acc3 | ||
| 
						 | 
					a5055094d0 | ||
| 
						 | 
					92d03dd196 | ||
| 
						 | 
					bd75f0dfea | ||
| 
						 | 
					f4ac951b15 | ||
| 
						 | 
					e020110579 | ||
| 
						 | 
					1fda40f0ce | ||
| 
						 | 
					a5e42e1bd0 | ||
| 
						 | 
					8863188dd8 | ||
| 
						 | 
					7747a5aa62 | ||
| 
						 | 
					32419645ca | ||
| 
						 | 
					634aa55364 | ||
| 
						 | 
					dd5ba5a90c | ||
| 
						 | 
					0138ef36cf | ||
| 
						 | 
					ca5ee0ce07 | ||
| 
						 | 
					79b5fcf31a | ||
| 
						 | 
					2243e44750 | ||
| 
						 | 
					01f949e097 | ||
| 
						 | 
					143bf694c7 | ||
| 
						 | 
					983db6215f | ||
| 
						 | 
					bef20b60d0 | ||
| 
						 | 
					475fe60f27 | ||
| 
						 | 
					8953e53a04 | ||
| 
						 | 
					143702beef | ||
| 
						 | 
					05238b447f | ||
| 
						 | 
					0d94246858 | ||
| 
						 | 
					2be4951ad9 | ||
| 
						 | 
					16bb81814c | ||
| 
						 | 
					7d92499e4c | ||
| 
						 | 
					a240f0af90 | ||
| 
						 | 
					fc59c08800 | ||
| 
						 | 
					e2c60f5384 | ||
| 
						 | 
					33d48732aa | ||
| 
						 | 
					9a1edaa4f4 | ||
| 
						 | 
					926e4fa3e1 | ||
| 
						 | 
					97dd96b60d | ||
| 
						 | 
					e9c7596e00 | ||
| 
						 | 
					ff836a8434 | ||
| 
						 | 
					3d9c977826 | ||
| 
						 | 
					c1a994b1d9 | ||
| 
						 | 
					6616567b05 | ||
| 
						 | 
					0ffc446315 | ||
| 
						 | 
					a692bd98ef | ||
| 
						 | 
					6178ab7513 | ||
| 
						 | 
					d24e237967 | ||
| 
						 | 
					267574f24c | ||
| 
						 | 
					5235c80781 | ||
| 
						 | 
					0ccc5e340e | ||
| 
						 | 
					86c6e4da2a | ||
| 
						 | 
					5c8b330eaa | ||
| 
						 | 
					4158a5c2a3 | ||
| 
						 | 
					05c5364490 | ||
| 
						 | 
					78eb236a4a | ||
| 
						 | 
					691cc5f7dc | ||
| 
						 | 
					b3d7f001af | ||
| 
						 | 
					3f8b691c32 | ||
| 
						 | 
					a30f01d668 | ||
| 
						 | 
					4648804db6 | ||
| 
						 | 
					51377b2625 | ||
| 
						 | 
					256f9f9943 | ||
| 
						 | 
					a72905191a | ||
| 
						 | 
					7150f2806f | ||
| 
						 | 
					ee8ee4e646 | ||
| 
						 | 
					fb357b8965 | ||
| 
						 | 
					c4fac1a2ae | ||
| 
						 | 
					42a1f6922f | ||
| 
						 | 
					206659ddb8 | ||
| 
						 | 
					440de12e3f | ||
| 
						 | 
					b122112d58 | ||
| 
						 | 
					fe258e1007 | ||
| 
						 | 
					3976fd02ea | ||
| 
						 | 
					e58c793da2 | ||
| 
						 | 
					90fb3680d4 | ||
| 
						 | 
					832a787271 | ||
| 
						 | 
					29747fc730 | ||
| 
						 | 
					e2de6ee29d | ||
| 
						 | 
					053feb5e3b | ||
| 
						 | 
					31f36df4ba | ||
| 
						 | 
					3ef392d433 | ||
| 
						 | 
					138ff749f3 | ||
| 
						 | 
					e88b8d10ec | ||
| 
						 | 
					8147d117a0 | ||
| 
						 | 
					c6f7e84256 | ||
| 
						 | 
					db877e688a | ||
| 
						 | 
					4e25b6da7b | ||
| 
						 | 
					83512b88c4 | ||
| 
						 | 
					fde5f88192 | ||
| 
						 | 
					2510b5ffb5 | ||
| 
						 | 
					364b6ca8d0 | ||
| 
						 | 
					e49b89a051 | ||
| 
						 | 
					bdd52dbaa4 | ||
| 
						 | 
					765793505d | ||
| 
						 | 
					a303f93236 | ||
| 
						 | 
					492580edc3 | ||
| 
						 | 
					1368139f4d | ||
| 
						 | 
					b6fade7339 | ||
| 
						 | 
					8da322fe9e | ||
| 
						 | 
					e5a699a004 | ||
| 
						 | 
					e061b6dc55 | ||
| 
						 | 
					4673a5b48c | ||
| 
						 | 
					0bc18a8281 | ||
| 
						 | 
					20ba035e3b | ||
| 
						 | 
					f7019a4ed7 | ||
| 
						 | 
					a1291c2730 | ||
| 
						 | 
					b0f8922056 | ||
| 
						 | 
					4e9e48e2e7 | ||
| 
						 | 
					86e7013f40 | ||
| 
						 | 
					58b4e7dab2 | ||
| 
						 | 
					d686257cff | ||
| 
						 | 
					adb7ccdbc7 | ||
| 
						 | 
					d00e20ccdf | ||
| 
						 | 
					25457da97c | ||
| 
						 | 
					14d7c4bdbd | ||
| 
						 | 
					eef71a79da | ||
| 
						 | 
					547c7d6dc8 | ||
| 
						 | 
					1ef7b2d64f | ||
| 
						 | 
					107304b274 | ||
| 
						 | 
					b2b6f41ef3 | ||
| 
						 | 
					34db02661c | ||
| 
						 | 
					798eef41b9 | ||
| 
						 | 
					658e4bac47 | ||
| 
						 | 
					5b55e205ef | ||
| 
						 | 
					4ef5c941c9 | ||
| 
						 | 
					b9391f2cd4 | ||
| 
						 | 
					00eb56d8db | ||
| 
						 | 
					60eac6ea07 | ||
| 
						 | 
					9b3ece4caf | ||
| 
						 | 
					289aedcfe2 | ||
| 
						 | 
					4cdc804c17 | ||
| 
						 | 
					56a963dfe6 | ||
| 
						 | 
					f6f0e52d5e | ||
| 
						 | 
					eba2c82fec | ||
| 
						 | 
					fae96e279c | ||
| 
						 | 
					2fb23becec | ||
| 
						 | 
					095acce3e2 | ||
| 
						 | 
					5fa9d22c5d | ||
| 
						 | 
					785b14ac84 | ||
| 
						 | 
					84ab758b22 | ||
| 
						 | 
					03566c34ed | ||
| 
						 | 
					6a096c1d5a | ||
| 
						 | 
					04a46de237 | ||
| 
						 | 
					0083abe3b5 | ||
| 
						 | 
					3470305d9d | ||
| 
						 | 
					35de36d690 | ||
| 
						 | 
					16ef5a9377 | ||
| 
						 | 
					e3ccb9b46c | ||
| 
						 | 
					8c34b72b62 | ||
| 
						 | 
					27c745d5a1 | ||
| 
						 | 
					9a0ba1657e | ||
| 
						 | 
					db7a420e54 | ||
| 
						 | 
					e58baab563 | ||
| 
						 | 
					08c88ba0f2 | ||
| 
						 | 
					78c8cd4c4e | ||
| 
						 | 
					98e106e0ae | ||
| 
						 | 
					0cbb5e6c1c | ||
| 
						 | 
					8014cbc71e | ||
| 
						 | 
					aaa7117ec9 | ||
| 
						 | 
					3930609d8b | ||
| 
						 | 
					3e553f517b | ||
| 
						 | 
					af0bb634c6 | ||
| 
						 | 
					8a9769d4e9 | ||
| 
						 | 
					d86f319d66 | ||
| 
						 | 
					9890659f61 | ||
| 
						 | 
					140ca070a2 | ||
| 
						 | 
					6a354d7c94 | ||
| 
						 | 
					7f8dd4b254 | ||
| 
						 | 
					0b1b8f05e1 | ||
| 
						 | 
					53e9ffe656 | ||
| 
						 | 
					2289073a1e | ||
| 
						 | 
					687cb1cd2b | ||
| 
						 | 
					e907050a17 | ||
| 
						 | 
					a4b57c7e44 | ||
| 
						 | 
					24bbfcdce7 | ||
| 
						 | 
					d78b720350 | ||
| 
						 | 
					d592208c74 | ||
| 
						 | 
					971bbd088c | ||
| 
						 | 
					b743577ebe | ||
| 
						 | 
					a4cc6166a0 | ||
| 
						 | 
					ed9850c4a4 | ||
| 
						 | 
					ddbcf8549c | ||
| 
						 | 
					921d0888cd | ||
| 
						 | 
					21e1f3d103 | ||
| 
						 | 
					53ab016098 | ||
| 
						 | 
					0c249a7006 | ||
| 
						 | 
					86c0fb48a3 | ||
| 
						 | 
					3f1f99cf37 | ||
| 
						 | 
					13d4823db6 | ||
| 
						 | 
					30f61b26ff | ||
| 
						 | 
					58b7d0b412 | ||
| 
						 | 
					d37f5b87bd | ||
| 
						 | 
					3f65cee17c | ||
| 
						 | 
					094bf19ec4 | ||
| 
						 | 
					f8d59b5aeb | ||
| 
						 | 
					e9870c2922 | ||
| 
						 | 
					52ca8deb10 | ||
| 
						 | 
					156a9160ba | ||
| 
						 | 
					68d66c873e | ||
| 
						 | 
					c0b1f32889 | ||
| 
						 | 
					837dd46adf | ||
| 
						 | 
					13512440ac | ||
| 
						 | 
					7931423e8c | ||
| 
						 | 
					62f28902c5 | ||
| 
						 | 
					1f94e4cc14 | ||
| 
						 | 
					61dfd5541f | ||
| 
						 | 
					87321ce10b | ||
| 
						 | 
					4f5aacdb3a | ||
| 
						 | 
					b182f2d544 | ||
| 
						 | 
					4fac8e9cd5 | ||
| 
						 | 
					d94896c0fb | ||
| 
						 | 
					15c5dd222f | ||
| 
						 | 
					2930c8e9a8 | ||
| 
						 | 
					b12b9b97f4 | ||
| 
						 | 
					09e5aa6011 | ||
| 
						 | 
					9549304007 | ||
| 
						 | 
					f7ac32ceda | ||
| 
						 | 
					92365f133d | ||
| 
						 | 
					9daa9a6de8 | ||
| 
						 | 
					23b1e428de | ||
| 
						 | 
					f029f4f20e | ||
| 
						 | 
					79e3d2b2d7 | ||
| 
						 | 
					c74e5e0f04 | ||
| 
						 | 
					15ef93ccc9 | ||
| 
						 | 
					e017250445 | ||
| 
						 | 
					17497eec43 | ||
| 
						 | 
					6d0c6329ad | ||
| 
						 | 
					f35be6b5cc | ||
| 
						 | 
					b18ff48b4a | ||
| 
						 | 
					7c28134214 | ||
| 
						 | 
					16860e8a30 | ||
| 
						 | 
					5362d1a89f | ||
| 
						 | 
					5531296ee0 | ||
| 
						 | 
					47db5e26f3 | ||
| 
						 | 
					cf5197b68a | ||
| 
						 | 
					9f831e91b3 | ||
| 
						 | 
					2df0ebd895 | ||
| 
						 | 
					7ad6dab383 | ||
| 
						 | 
					612c8d5841 | ||
| 
						 | 
					a35e476be5 | ||
| 
						 | 
					87a7157fc4 | ||
| 
						 | 
					ac942e0670 | ||
| 
						 | 
					2ad266582f | ||
| 
						 | 
					1a47164876 | ||
| 
						 | 
					cd22723623 | ||
| 
						 | 
					aecaffa2f5 | ||
| 
						 | 
					87df3596a2 | ||
| 
						 | 
					41c7852128 | ||
| 
						 | 
					78ec9856fb | ||
| 
						 | 
					2a45467bf6 | ||
| 
						 | 
					7fc5bfd787 | ||
| 
						 | 
					04f592ba6d | ||
| 
						 | 
					59889a6286 | ||
| 
						 | 
					dc5cbd4df8 | ||
| 
						 | 
					7ab9083d77 | ||
| 
						 | 
					788803d588 | ||
| 
						 | 
					cbfd904b9f | ||
| 
						 | 
					c81dbf9d59 | ||
| 
						 | 
					ac9c608542 | ||
| 
						 | 
					a6c20853ca | ||
| 
						 | 
					4ef0264ed3 | ||
| 
						 | 
					169db9cc0a | ||
| 
						 | 
					b693b8ccb1 | ||
| 
						 | 
					3e98cceb00 | ||
| 
						 | 
					46d962dcf1 | ||
| 
						 | 
					7dbad42470 | ||
| 
						 | 
					eb97781f68 | ||
| 
						 | 
					4d0f8528d2 | ||
| 
						 | 
					2c17b2bacc | ||
| 
						 | 
					30bea20f7a | ||
| 
						 | 
					d4cb4ef994 | ||
| 
						 | 
					9c90ca297a | ||
| 
						 | 
					a9e1a4cef3 | ||
| 
						 | 
					0ce3621ac0 | ||
| 
						 | 
					d527398dae | ||
| 
						 | 
					2e9ac8945d | ||
| 
						 | 
					40a5638005 | ||
| 
						 | 
					8ba22183b9 | ||
| 
						 | 
					2e11e66db4 | ||
| 
						 | 
					eeb0710ad4 | ||
| 
						 | 
					43c677ef37 | ||
| 
						 | 
					95544e489d | ||
| 
						 | 
					a08d021f77 | ||
| 
						 | 
					b7b1d17ecb | ||
| 
						 | 
					aa180b9581 | ||
| 
						 | 
					57388254c4 | ||
| 
						 | 
					f16f4e2c4c | ||
| 
						 | 
					89b70e4352 | ||
| 
						 | 
					6667336bd8 | ||
| 
						 | 
					669ef7a0b1 | ||
| 
						 | 
					c612985930 | ||
| 
						 | 
					2e534ce41e | ||
| 
						 | 
					fedb54bb38 | ||
| 
						 | 
					fd3c22945b | ||
| 
						 | 
					53496a1ecd | ||
| 
						 | 
					808f964841 | ||
| 
						 | 
					3bc5db4fd7 | ||
| 
						 | 
					0bf613bd34 | ||
| 
						 | 
					43ab63455b | ||
| 
						 | 
					47e7988c8e | ||
| 
						 | 
					7ed095e635 | ||
| 
						 | 
					cb8b0ec62e | ||
| 
						 | 
					bf161f1eaa | ||
| 
						 | 
					78c8447d1e | ||
| 
						 | 
					5ffe50381a | ||
| 
						 | 
					b08bd0c24a | ||
| 
						 | 
					738ad8e9d3 | ||
| 
						 | 
					fa7c42511a | ||
| 
						 | 
					68ef9cb3dc | ||
| 
						 | 
					8e176b9c61 | ||
| 
						 | 
					c4f7c2d259 | ||
| 
						 | 
					882bfc79c7 | ||
| 
						 | 
					c17a3b6fcc | ||
| 
						 | 
					28d11553e0 | ||
| 
						 | 
					1dbebe90ba | ||
| 
						 | 
					06810e8e6a | ||
| 
						 | 
					bd85ba9b6a | ||
| 
						 | 
					be58cdda3b | ||
| 
						 | 
					fcce4a8be6 | ||
| 
						 | 
					61a558a062 | ||
| 
						 | 
					59f69ac5ca | ||
| 
						 | 
					f82ac34784 | ||
| 
						 | 
					07cf6e723b | ||
| 
						 | 
					78e3c6333f | ||
| 
						 | 
					98e2684107 | ||
| 
						 | 
					cb019fff9a | ||
| 
						 | 
					4305c44440 | ||
| 
						 | 
					a1e4143600 | ||
| 
						 | 
					374c33e8dc | ||
| 
						 | 
					dcfe7af9d3 | ||
| 
						 | 
					049c7e00ca | ||
| 
						 | 
					ee37d2f9c8 | ||
| 
						 | 
					92ea697119 | ||
| 
						 | 
					1c488d375f | ||
| 
						 | 
					1a03b4949f | ||
| 
						 | 
					731b7808cd | ||
| 
						 | 
					d9da4cf24d | ||
| 
						 | 
					666a3ee5e9 | ||
| 
						 | 
					02469c2d4c | ||
| 
						 | 
					2a629cae93 | ||
| 
						 | 
					1f14c316a3 | ||
| 
						 | 
					dac738a916 | ||
| 
						 | 
					261b561bb2 | ||
| 
						 | 
					0228379a2e | ||
| 
						 | 
					da79215bc3 | ||
| 
						 | 
					a59e1c7011 | ||
| 
						 | 
					f467c79a20 | 
							
								
								
									
										222
									
								
								.ai/instructions.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										222
									
								
								.ai/instructions.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,222 @@
 | 
			
		||||
# ESPHome AI Collaboration Guide
 | 
			
		||||
 | 
			
		||||
This document provides essential context for AI models interacting with this project. Adhering to these guidelines will ensure consistency and maintain code quality.
 | 
			
		||||
 | 
			
		||||
## 1. Project Overview & Purpose
 | 
			
		||||
 | 
			
		||||
*   **Primary Goal:** ESPHome is a system to configure microcontrollers (like ESP32, ESP8266, RP2040, and LibreTiny-based chips) using simple yet powerful YAML configuration files. It generates C++ firmware that can be compiled and flashed to these devices, allowing users to control them remotely through home automation systems.
 | 
			
		||||
*   **Business Domain:** Internet of Things (IoT), Home Automation.
 | 
			
		||||
 | 
			
		||||
## 2. Core Technologies & Stack
 | 
			
		||||
 | 
			
		||||
*   **Languages:** Python (>=3.10), C++ (gnu++20)
 | 
			
		||||
*   **Frameworks & Runtimes:** PlatformIO, Arduino, ESP-IDF.
 | 
			
		||||
*   **Build Systems:** PlatformIO is the primary build system. CMake is used as an alternative.
 | 
			
		||||
*   **Configuration:** YAML.
 | 
			
		||||
*   **Key Libraries/Dependencies:**
 | 
			
		||||
    *   **Python:** `voluptuous` (for configuration validation), `PyYAML` (for parsing configuration files), `paho-mqtt` (for MQTT communication), `tornado` (for the web server), `aioesphomeapi` (for the native API).
 | 
			
		||||
    *   **C++:** `ArduinoJson` (for JSON serialization/deserialization), `AsyncMqttClient-esphome` (for MQTT), `ESPAsyncWebServer` (for the web server).
 | 
			
		||||
*   **Package Manager(s):** `pip` (for Python dependencies), `platformio` (for C++/PlatformIO dependencies).
 | 
			
		||||
*   **Communication Protocols:** Protobuf (for native API), MQTT, HTTP.
 | 
			
		||||
 | 
			
		||||
## 3. Architectural Patterns
 | 
			
		||||
 | 
			
		||||
*   **Overall Architecture:** The project follows a code-generation architecture. The Python code parses user-defined YAML configuration files and generates C++ source code. This C++ code is then compiled and flashed to the target microcontroller using PlatformIO.
 | 
			
		||||
 | 
			
		||||
*   **Directory Structure Philosophy:**
 | 
			
		||||
    *   `/esphome`: Contains the core Python source code for the ESPHome application.
 | 
			
		||||
    *   `/esphome/components`: Contains the individual components that can be used in ESPHome configurations. Each component is a self-contained unit with its own C++ and Python code.
 | 
			
		||||
    *   `/tests`: Contains all unit and integration tests for the Python code.
 | 
			
		||||
    *   `/docker`: Contains Docker-related files for building and running ESPHome in a container.
 | 
			
		||||
    *   `/script`: Contains helper scripts for development and maintenance.
 | 
			
		||||
 | 
			
		||||
*   **Core Architectural Components:**
 | 
			
		||||
    1.  **Configuration System** (`esphome/config*.py`): Handles YAML parsing and validation using Voluptuous, schema definitions, and multi-platform configurations.
 | 
			
		||||
    2.  **Code Generation** (`esphome/codegen.py`, `esphome/cpp_generator.py`): Manages Python to C++ code generation, template processing, and build flag management.
 | 
			
		||||
    3.  **Component System** (`esphome/components/`): Contains modular hardware and software components with platform-specific implementations and dependency management.
 | 
			
		||||
    4.  **Core Framework** (`esphome/core/`): Manages the application lifecycle, hardware abstraction, and component registration.
 | 
			
		||||
    5.  **Dashboard** (`esphome/dashboard/`): A web-based interface for device configuration, management, and OTA updates.
 | 
			
		||||
 | 
			
		||||
*   **Platform Support:**
 | 
			
		||||
    1.  **ESP32** (`components/esp32/`): Espressif ESP32 family. Supports multiple variants (S2, S3, C3, etc.) and both IDF and Arduino frameworks.
 | 
			
		||||
    2.  **ESP8266** (`components/esp8266/`): Espressif ESP8266. Arduino framework only, with memory constraints.
 | 
			
		||||
    3.  **RP2040** (`components/rp2040/`): Raspberry Pi Pico/RP2040. Arduino framework with PIO (Programmable I/O) support.
 | 
			
		||||
    4.  **LibreTiny** (`components/libretiny/`): Realtek and Beken chips. Supports multiple chip families and auto-generated components.
 | 
			
		||||
 | 
			
		||||
## 4. Coding Conventions & Style Guide
 | 
			
		||||
 | 
			
		||||
*   **Formatting:**
 | 
			
		||||
    *   **Python:** Uses `ruff` and `flake8` for linting and formatting. Configuration is in `pyproject.toml`.
 | 
			
		||||
    *   **C++:** Uses `clang-format` for formatting. Configuration is in `.clang-format`.
 | 
			
		||||
 | 
			
		||||
*   **Naming Conventions:**
 | 
			
		||||
    *   **Python:** Follows PEP 8. Use clear, descriptive names following snake_case.
 | 
			
		||||
    *   **C++:** Follows the Google C++ Style Guide.
 | 
			
		||||
 | 
			
		||||
*   **Component Structure:**
 | 
			
		||||
    *   **Standard Files:**
 | 
			
		||||
        ```
 | 
			
		||||
        components/[component_name]/
 | 
			
		||||
        ├── __init__.py          # Component configuration schema and code generation
 | 
			
		||||
        ├── [component].h        # C++ header file (if needed)
 | 
			
		||||
        ├── [component].cpp      # C++ implementation (if needed)
 | 
			
		||||
        └── [platform]/         # Platform-specific implementations
 | 
			
		||||
            ├── __init__.py      # Platform-specific configuration
 | 
			
		||||
            ├── [platform].h     # Platform C++ header
 | 
			
		||||
            └── [platform].cpp   # Platform C++ implementation
 | 
			
		||||
        ```
 | 
			
		||||
 | 
			
		||||
    *   **Component Metadata:**
 | 
			
		||||
        - `DEPENDENCIES`: List of required components
 | 
			
		||||
        - `AUTO_LOAD`: Components to automatically load
 | 
			
		||||
        - `CONFLICTS_WITH`: Incompatible components
 | 
			
		||||
        - `CODEOWNERS`: GitHub usernames responsible for maintenance
 | 
			
		||||
        - `MULTI_CONF`: Whether multiple instances are allowed
 | 
			
		||||
 | 
			
		||||
*   **Code Generation & Common Patterns:**
 | 
			
		||||
    *   **Configuration Schema Pattern:**
 | 
			
		||||
        ```python
 | 
			
		||||
        import esphome.codegen as cg
 | 
			
		||||
        import esphome.config_validation as cv
 | 
			
		||||
        from esphome.const import CONF_KEY, CONF_ID
 | 
			
		||||
 | 
			
		||||
        CONF_PARAM = "param"  # A constant that does not yet exist in esphome/const.py
 | 
			
		||||
 | 
			
		||||
        my_component_ns = cg.esphome_ns.namespace("my_component")
 | 
			
		||||
        MyComponent = my_component_ns.class_("MyComponent", cg.Component)
 | 
			
		||||
 | 
			
		||||
        CONFIG_SCHEMA = cv.Schema({
 | 
			
		||||
            cv.GenerateID(): cv.declare_id(MyComponent),
 | 
			
		||||
            cv.Required(CONF_KEY): cv.string,
 | 
			
		||||
            cv.Optional(CONF_PARAM, default=42): cv.int_,
 | 
			
		||||
        }).extend(cv.COMPONENT_SCHEMA)
 | 
			
		||||
 | 
			
		||||
        async def to_code(config):
 | 
			
		||||
            var = cg.new_Pvariable(config[CONF_ID])
 | 
			
		||||
            await cg.register_component(var, config)
 | 
			
		||||
            cg.add(var.set_key(config[CONF_KEY]))
 | 
			
		||||
            cg.add(var.set_param(config[CONF_PARAM]))
 | 
			
		||||
        ```
 | 
			
		||||
 | 
			
		||||
    *   **C++ Class Pattern:**
 | 
			
		||||
        ```cpp
 | 
			
		||||
        namespace esphome {
 | 
			
		||||
        namespace my_component {
 | 
			
		||||
 | 
			
		||||
        class MyComponent : public Component {
 | 
			
		||||
         public:
 | 
			
		||||
          void setup() override;
 | 
			
		||||
          void loop() override;
 | 
			
		||||
          void dump_config() override;
 | 
			
		||||
 | 
			
		||||
          void set_key(const std::string &key) { this->key_ = key; }
 | 
			
		||||
          void set_param(int param) { this->param_ = param; }
 | 
			
		||||
 | 
			
		||||
         protected:
 | 
			
		||||
          std::string key_;
 | 
			
		||||
          int param_{0};
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        }  // namespace my_component
 | 
			
		||||
        }  // namespace esphome
 | 
			
		||||
        ```
 | 
			
		||||
 | 
			
		||||
    *   **Common Component Examples:**
 | 
			
		||||
        - **Sensor:**
 | 
			
		||||
          ```python
 | 
			
		||||
          from esphome.components import sensor
 | 
			
		||||
          CONFIG_SCHEMA = sensor.sensor_schema(MySensor).extend(cv.polling_component_schema("60s"))
 | 
			
		||||
          async def to_code(config):
 | 
			
		||||
              var = await sensor.new_sensor(config)
 | 
			
		||||
              await cg.register_component(var, config)
 | 
			
		||||
          ```
 | 
			
		||||
 | 
			
		||||
        - **Binary Sensor:**
 | 
			
		||||
          ```python
 | 
			
		||||
          from esphome.components import binary_sensor
 | 
			
		||||
          CONFIG_SCHEMA = binary_sensor.binary_sensor_schema().extend({ ... })
 | 
			
		||||
          async def to_code(config):
 | 
			
		||||
              var = await binary_sensor.new_binary_sensor(config)
 | 
			
		||||
          ```
 | 
			
		||||
 | 
			
		||||
        - **Switch:**
 | 
			
		||||
          ```python
 | 
			
		||||
          from esphome.components import switch
 | 
			
		||||
          CONFIG_SCHEMA = switch.switch_schema().extend({ ... })
 | 
			
		||||
          async def to_code(config):
 | 
			
		||||
              var = await switch.new_switch(config)
 | 
			
		||||
          ```
 | 
			
		||||
 | 
			
		||||
*   **Configuration Validation:**
 | 
			
		||||
    *   **Common Validators:** `cv.int_`, `cv.float_`, `cv.string`, `cv.boolean`, `cv.int_range(min=0, max=100)`, `cv.positive_int`, `cv.percentage`.
 | 
			
		||||
    *   **Complex Validation:** `cv.All(cv.string, cv.Length(min=1, max=50))`, `cv.Any(cv.int_, cv.string)`.
 | 
			
		||||
    *   **Platform-Specific:** `cv.only_on(["esp32", "esp8266"])`, `cv.only_with_arduino`.
 | 
			
		||||
    *   **Schema Extensions:**
 | 
			
		||||
        ```python
 | 
			
		||||
        CONFIG_SCHEMA = cv.Schema({ ... })
 | 
			
		||||
         .extend(cv.COMPONENT_SCHEMA)
 | 
			
		||||
         .extend(uart.UART_DEVICE_SCHEMA)
 | 
			
		||||
         .extend(i2c.i2c_device_schema(0x48))
 | 
			
		||||
         .extend(spi.spi_device_schema(cs_pin_required=True))
 | 
			
		||||
        ```
 | 
			
		||||
 | 
			
		||||
## 5. Key Files & Entrypoints
 | 
			
		||||
 | 
			
		||||
*   **Main Entrypoint(s):** `esphome/__main__.py` is the main entrypoint for the ESPHome command-line interface.
 | 
			
		||||
*   **Configuration:**
 | 
			
		||||
    *   `pyproject.toml`: Defines the Python project metadata and dependencies.
 | 
			
		||||
    *   `platformio.ini`: Configures the PlatformIO build environments for different microcontrollers.
 | 
			
		||||
    *   `.pre-commit-config.yaml`: Configures the pre-commit hooks for linting and formatting.
 | 
			
		||||
*   **CI/CD Pipeline:** Defined in `.github/workflows`.
 | 
			
		||||
 | 
			
		||||
## 6. Development & Testing Workflow
 | 
			
		||||
 | 
			
		||||
*   **Local Development Environment:** Use the provided Docker container or create a Python virtual environment and install dependencies from `requirements_dev.txt`.
 | 
			
		||||
*   **Running Commands:** Use the `script/run-in-env.py` script to execute commands within the project's virtual environment. For example, to run the linter: `python3 script/run-in-env.py pre-commit run`.
 | 
			
		||||
*   **Testing:**
 | 
			
		||||
    *   **Python:** Run unit tests with `pytest`.
 | 
			
		||||
    *   **C++:** Use `clang-tidy` for static analysis.
 | 
			
		||||
    *   **Component Tests:** YAML-based compilation tests are located in `tests/`. The structure is as follows:
 | 
			
		||||
        ```
 | 
			
		||||
        tests/
 | 
			
		||||
        ├── test_build_components/ # Base test configurations
 | 
			
		||||
        └── components/[component]/ # Component-specific tests
 | 
			
		||||
        ```
 | 
			
		||||
        Run them using `script/test_build_components`. Use `-c <component>` to test specific components and `-t <target>` for specific platforms.
 | 
			
		||||
*   **Debugging and Troubleshooting:**
 | 
			
		||||
    *   **Debug Tools:**
 | 
			
		||||
        - `esphome config <file>.yaml` to validate configuration.
 | 
			
		||||
        - `esphome compile <file>.yaml` to compile without uploading.
 | 
			
		||||
        - Check the Dashboard for real-time logs.
 | 
			
		||||
        - Use component-specific debug logging.
 | 
			
		||||
    *   **Common Issues:**
 | 
			
		||||
        - **Import Errors**: Check component dependencies and `PYTHONPATH`.
 | 
			
		||||
        - **Validation Errors**: Review configuration schema definitions.
 | 
			
		||||
        - **Build Errors**: Check platform compatibility and library versions.
 | 
			
		||||
        - **Runtime Errors**: Review generated C++ code and component logic.
 | 
			
		||||
 | 
			
		||||
## 7. Specific Instructions for AI Collaboration
 | 
			
		||||
 | 
			
		||||
*   **Contribution Workflow (Pull Request Process):**
 | 
			
		||||
    1.  **Fork & Branch:** Create a new branch in your fork.
 | 
			
		||||
    2.  **Make Changes:** Adhere to all coding conventions and patterns.
 | 
			
		||||
    3.  **Test:** Create component tests for all supported platforms and run the full test suite locally.
 | 
			
		||||
    4.  **Lint:** Run `pre-commit` to ensure code is compliant.
 | 
			
		||||
    5.  **Commit:** Commit your changes. There is no strict format for commit messages.
 | 
			
		||||
    6.  **Pull Request:** Submit a PR against the `dev` branch. The Pull Request title should have a prefix of the component being worked on (e.g., `[display] Fix bug`, `[abc123] Add new component`). Update documentation, examples, and add `CODEOWNERS` entries as needed. Pull requests should always be made with the PULL_REQUEST_TEMPLATE.md template filled out correctly.
 | 
			
		||||
 | 
			
		||||
*   **Documentation Contributions:**
 | 
			
		||||
    *   Documentation is hosted in the separate `esphome/esphome-docs` repository.
 | 
			
		||||
    *   The contribution workflow is the same as for the codebase.
 | 
			
		||||
 | 
			
		||||
*   **Best Practices:**
 | 
			
		||||
    *   **Component Development:** Keep dependencies minimal, provide clear error messages, and write comprehensive docstrings and tests.
 | 
			
		||||
    *   **Code Generation:** Generate minimal and efficient C++ code. Validate all user inputs thoroughly. Support multiple platform variations.
 | 
			
		||||
    *   **Configuration Design:** Aim for simplicity with sensible defaults, while allowing for advanced customization.
 | 
			
		||||
 | 
			
		||||
*   **Security:** Be mindful of security when making changes to the API, web server, or any other network-related code. Do not hardcode secrets or keys.
 | 
			
		||||
 | 
			
		||||
*   **Dependencies & Build System Integration:**
 | 
			
		||||
    *   **Python:** When adding a new Python dependency, add it to the appropriate `requirements*.txt` file and `pyproject.toml`.
 | 
			
		||||
    *   **C++ / PlatformIO:** When adding a new C++ dependency, add it to `platformio.ini` and use `cg.add_library`.
 | 
			
		||||
    *   **Build Flags:** Use `cg.add_build_flag(...)` to add compiler flags.
 | 
			
		||||
							
								
								
									
										1
									
								
								.clang-tidy.hash
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.clang-tidy.hash
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1 @@
 | 
			
		||||
4df2fc55e977ba821978fac5f1e721ce2338e23647050b7005b4c801b1770739
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
[run]
 | 
			
		||||
omit = 
 | 
			
		||||
omit =
 | 
			
		||||
    esphome/components/*
 | 
			
		||||
    tests/integration/*
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										92
									
								
								.github/ISSUE_TEMPLATE/bug_report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										92
									
								
								.github/ISSUE_TEMPLATE/bug_report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,92 @@
 | 
			
		||||
name: Report an issue with ESPHome
 | 
			
		||||
description: Report an issue with ESPHome.
 | 
			
		||||
body:
 | 
			
		||||
  - type: markdown
 | 
			
		||||
    attributes:
 | 
			
		||||
      value: |
 | 
			
		||||
        This issue form is for reporting bugs only!
 | 
			
		||||
 | 
			
		||||
        If you have a feature request or enhancement, please [request them here instead][fr].
 | 
			
		||||
 | 
			
		||||
        [fr]: https://github.com/orgs/esphome/discussions
 | 
			
		||||
  - type: textarea
 | 
			
		||||
    validations:
 | 
			
		||||
      required: true
 | 
			
		||||
    id: problem
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: The problem
 | 
			
		||||
      description: >-
 | 
			
		||||
        Describe the issue you are experiencing here to communicate to the
 | 
			
		||||
        maintainers. Tell us what you were trying to do and what happened.
 | 
			
		||||
 | 
			
		||||
        Provide a clear and concise description of what the problem is.
 | 
			
		||||
 | 
			
		||||
  - type: markdown
 | 
			
		||||
    attributes:
 | 
			
		||||
      value: |
 | 
			
		||||
        ## Environment
 | 
			
		||||
  - type: input
 | 
			
		||||
    id: version
 | 
			
		||||
    validations:
 | 
			
		||||
      required: true
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: Which version of ESPHome has the issue?
 | 
			
		||||
      description: >
 | 
			
		||||
        ESPHome version like 1.19, 2025.6.0 or 2025.XX.X-dev.
 | 
			
		||||
  - type: dropdown
 | 
			
		||||
    validations:
 | 
			
		||||
      required: true
 | 
			
		||||
    id: installation
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: What type of installation are you using?
 | 
			
		||||
      options:
 | 
			
		||||
        - Home Assistant Add-on
 | 
			
		||||
        - Docker
 | 
			
		||||
        - pip
 | 
			
		||||
  - type: dropdown
 | 
			
		||||
    validations:
 | 
			
		||||
      required: true
 | 
			
		||||
    id: platform
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: What platform are you using?
 | 
			
		||||
      options:
 | 
			
		||||
        - ESP8266
 | 
			
		||||
        - ESP32
 | 
			
		||||
        - RP2040
 | 
			
		||||
        - BK72XX
 | 
			
		||||
        - RTL87XX
 | 
			
		||||
        - LN882X
 | 
			
		||||
        - Host
 | 
			
		||||
        - Other
 | 
			
		||||
  - type: input
 | 
			
		||||
    id: component_name
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: Component causing the issue
 | 
			
		||||
      description: >
 | 
			
		||||
        The name of the component or platform. For example, api/i2c or ultrasonic.
 | 
			
		||||
 | 
			
		||||
  - type: markdown
 | 
			
		||||
    attributes:
 | 
			
		||||
      value: |
 | 
			
		||||
        # Details
 | 
			
		||||
  - type: textarea
 | 
			
		||||
    id: config
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: YAML Config
 | 
			
		||||
      description: |
 | 
			
		||||
        Include a complete YAML configuration file demonstrating the problem here. Preferably post the *entire* file - don't make assumptions about what is unimportant. However, if it's a large or complicated config then you will need to reduce it to the smallest possible file *that still demonstrates the problem*. If you don't provide enough information to *easily* reproduce the problem, it's unlikely your bug report will get any attention. Logs do not belong here, attach them below.
 | 
			
		||||
      render: yaml
 | 
			
		||||
  - type: textarea
 | 
			
		||||
    id: logs
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: Anything in the logs that might be useful for us?
 | 
			
		||||
      description: For example, error message, or stack traces. Serial or USB logs are much more useful than WiFi logs.
 | 
			
		||||
      render: txt
 | 
			
		||||
  - type: textarea
 | 
			
		||||
    id: additional
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: Additional information
 | 
			
		||||
      description: >
 | 
			
		||||
        If you have any additional information for us, use the field below.
 | 
			
		||||
        Please note, you can attach screenshots or screen recordings here, by
 | 
			
		||||
        dragging and dropping files in the field below.
 | 
			
		||||
							
								
								
									
										26
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										26
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,15 +1,21 @@
 | 
			
		||||
---
 | 
			
		||||
blank_issues_enabled: false
 | 
			
		||||
contact_links:
 | 
			
		||||
  - name: Issue Tracker
 | 
			
		||||
    url: https://github.com/esphome/issues
 | 
			
		||||
    about: Please create bug reports in the dedicated issue tracker.
 | 
			
		||||
  - name: Feature Request Tracker
 | 
			
		||||
    url: https://github.com/esphome/feature-requests
 | 
			
		||||
    about: |
 | 
			
		||||
      Please create feature requests in the dedicated feature request tracker.
 | 
			
		||||
  - name: Report an issue with the ESPHome documentation
 | 
			
		||||
    url: https://github.com/esphome/esphome-docs/issues/new/choose
 | 
			
		||||
    about: Report an issue with the ESPHome documentation.
 | 
			
		||||
  - name: Report an issue with the ESPHome web server
 | 
			
		||||
    url: https://github.com/esphome/esphome-webserver/issues/new/choose
 | 
			
		||||
    about: Report an issue with the ESPHome web server.
 | 
			
		||||
  - name: Report an issue with the ESPHome Builder / Dashboard
 | 
			
		||||
    url: https://github.com/esphome/dashboard/issues/new/choose
 | 
			
		||||
    about: Report an issue with the ESPHome Builder / Dashboard.
 | 
			
		||||
  - name: Report an issue with the ESPHome API client
 | 
			
		||||
    url: https://github.com/esphome/aioesphomeapi/issues/new/choose
 | 
			
		||||
    about: Report an issue with the ESPHome API client.
 | 
			
		||||
  - name: Make a Feature Request
 | 
			
		||||
    url: https://github.com/orgs/esphome/discussions
 | 
			
		||||
    about: Please create feature requests in the dedicated feature request tracker.
 | 
			
		||||
  - name: Frequently Asked Question
 | 
			
		||||
    url: https://esphome.io/guides/faq.html
 | 
			
		||||
    about: |
 | 
			
		||||
      Please view the FAQ for common questions and what
 | 
			
		||||
      to include in a bug report.
 | 
			
		||||
    about: Please view the FAQ for common questions and what to include in a bug report.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										1
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							@@ -26,6 +26,7 @@
 | 
			
		||||
- [ ] RP2040
 | 
			
		||||
- [ ] BK72xx
 | 
			
		||||
- [ ] RTL87xx
 | 
			
		||||
- [ ] nRF52840
 | 
			
		||||
 | 
			
		||||
## Example entry for `config.yaml`:
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								.github/actions/restore-python/action.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/actions/restore-python/action.yml
									
									
									
									
										vendored
									
									
								
							@@ -41,7 +41,7 @@ runs:
 | 
			
		||||
      shell: bash
 | 
			
		||||
      run: |
 | 
			
		||||
        python -m venv venv
 | 
			
		||||
        ./venv/Scripts/activate
 | 
			
		||||
        source ./venv/Scripts/activate
 | 
			
		||||
        python --version
 | 
			
		||||
        pip install -r requirements.txt -r requirements_test.txt
 | 
			
		||||
        pip install -e .
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										1
									
								
								.github/copilot-instructions.md
									
									
									
									
										vendored
									
									
										Symbolic link
									
								
							
							
						
						
									
										1
									
								
								.github/copilot-instructions.md
									
									
									
									
										vendored
									
									
										Symbolic link
									
								
							@@ -0,0 +1 @@
 | 
			
		||||
../.ai/instructions.md
 | 
			
		||||
							
								
								
									
										9
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							@@ -9,6 +9,9 @@ updates:
 | 
			
		||||
      # Hypotehsis is only used for testing and is updated quite often
 | 
			
		||||
      - dependency-name: hypothesis
 | 
			
		||||
  - package-ecosystem: github-actions
 | 
			
		||||
    labels:
 | 
			
		||||
      - "dependencies"
 | 
			
		||||
      - "github-actions"
 | 
			
		||||
    directory: "/"
 | 
			
		||||
    schedule:
 | 
			
		||||
      interval: daily
 | 
			
		||||
@@ -20,11 +23,17 @@ updates:
 | 
			
		||||
          - "docker/login-action"
 | 
			
		||||
          - "docker/setup-buildx-action"
 | 
			
		||||
  - package-ecosystem: github-actions
 | 
			
		||||
    labels:
 | 
			
		||||
      - "dependencies"
 | 
			
		||||
      - "github-actions"
 | 
			
		||||
    directory: "/.github/actions/build-image"
 | 
			
		||||
    schedule:
 | 
			
		||||
      interval: daily
 | 
			
		||||
    open-pull-requests-limit: 10
 | 
			
		||||
  - package-ecosystem: github-actions
 | 
			
		||||
    labels:
 | 
			
		||||
      - "dependencies"
 | 
			
		||||
      - "github-actions"
 | 
			
		||||
    directory: "/.github/actions/restore-python"
 | 
			
		||||
    schedule:
 | 
			
		||||
      interval: daily
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										620
									
								
								.github/workflows/auto-label-pr.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										620
									
								
								.github/workflows/auto-label-pr.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,620 @@
 | 
			
		||||
name: Auto Label PR
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  # Runs only on pull_request_target due to having access to a App token.
 | 
			
		||||
  # This means PRs from forks will not be able to alter this workflow to get the tokens
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [labeled, opened, reopened, synchronize, edited]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
env:
 | 
			
		||||
  SMALL_PR_THRESHOLD: 30
 | 
			
		||||
  MAX_LABELS: 15
 | 
			
		||||
  TOO_BIG_THRESHOLD: 1000
 | 
			
		||||
  COMPONENT_LABEL_THRESHOLD: 10
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  label:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    if: github.event.action != 'labeled' || github.event.sender.type != 'Bot'
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
 | 
			
		||||
      - name: Generate a token
 | 
			
		||||
        id: generate-token
 | 
			
		||||
        uses: actions/create-github-app-token@v2
 | 
			
		||||
        with:
 | 
			
		||||
          app-id: ${{ secrets.ESPHOME_GITHUB_APP_ID }}
 | 
			
		||||
          private-key: ${{ secrets.ESPHOME_GITHUB_APP_PRIVATE_KEY }}
 | 
			
		||||
 | 
			
		||||
      - name: Auto Label PR
 | 
			
		||||
        uses: actions/github-script@v7.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          github-token: ${{ steps.generate-token.outputs.token }}
 | 
			
		||||
          script: |
 | 
			
		||||
            const fs = require('fs');
 | 
			
		||||
 | 
			
		||||
            // Constants
 | 
			
		||||
            const SMALL_PR_THRESHOLD = parseInt('${{ env.SMALL_PR_THRESHOLD }}');
 | 
			
		||||
            const MAX_LABELS = parseInt('${{ env.MAX_LABELS }}');
 | 
			
		||||
            const TOO_BIG_THRESHOLD = parseInt('${{ env.TOO_BIG_THRESHOLD }}');
 | 
			
		||||
            const COMPONENT_LABEL_THRESHOLD = parseInt('${{ env.COMPONENT_LABEL_THRESHOLD }}');
 | 
			
		||||
            const BOT_COMMENT_MARKER = '<!-- auto-label-pr-bot -->';
 | 
			
		||||
            const CODEOWNERS_MARKER = '<!-- codeowners-request -->';
 | 
			
		||||
            const TOO_BIG_MARKER = '<!-- too-big-request -->';
 | 
			
		||||
 | 
			
		||||
            const MANAGED_LABELS = [
 | 
			
		||||
              'new-component',
 | 
			
		||||
              'new-platform',
 | 
			
		||||
              'new-target-platform',
 | 
			
		||||
              'merging-to-release',
 | 
			
		||||
              'merging-to-beta',
 | 
			
		||||
              'core',
 | 
			
		||||
              'small-pr',
 | 
			
		||||
              'dashboard',
 | 
			
		||||
              'github-actions',
 | 
			
		||||
              'by-code-owner',
 | 
			
		||||
              'has-tests',
 | 
			
		||||
              'needs-tests',
 | 
			
		||||
              'needs-docs',
 | 
			
		||||
              'needs-codeowners',
 | 
			
		||||
              'too-big',
 | 
			
		||||
              'labeller-recheck'
 | 
			
		||||
            ];
 | 
			
		||||
 | 
			
		||||
            const DOCS_PR_PATTERNS = [
 | 
			
		||||
              /https:\/\/github\.com\/esphome\/esphome-docs\/pull\/\d+/,
 | 
			
		||||
              /esphome\/esphome-docs#\d+/
 | 
			
		||||
            ];
 | 
			
		||||
 | 
			
		||||
            // Global state
 | 
			
		||||
            const { owner, repo } = context.repo;
 | 
			
		||||
            const pr_number = context.issue.number;
 | 
			
		||||
 | 
			
		||||
            // Get current labels and PR data
 | 
			
		||||
            const { data: currentLabelsData } = await github.rest.issues.listLabelsOnIssue({
 | 
			
		||||
              owner,
 | 
			
		||||
              repo,
 | 
			
		||||
              issue_number: pr_number
 | 
			
		||||
            });
 | 
			
		||||
            const currentLabels = currentLabelsData.map(label => label.name);
 | 
			
		||||
            const managedLabels = currentLabels.filter(label =>
 | 
			
		||||
              label.startsWith('component: ') || MANAGED_LABELS.includes(label)
 | 
			
		||||
            );
 | 
			
		||||
 | 
			
		||||
            // Check for mega-PR early - if present, skip most automatic labeling
 | 
			
		||||
            const isMegaPR = currentLabels.includes('mega-pr');
 | 
			
		||||
 | 
			
		||||
            // Get all PR files with automatic pagination
 | 
			
		||||
            const prFiles = await github.paginate(
 | 
			
		||||
              github.rest.pulls.listFiles,
 | 
			
		||||
              {
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                pull_number: pr_number
 | 
			
		||||
              }
 | 
			
		||||
            );
 | 
			
		||||
 | 
			
		||||
            // Calculate data from PR files
 | 
			
		||||
            const changedFiles = prFiles.map(file => file.filename);
 | 
			
		||||
            const totalChanges = prFiles.reduce((sum, file) => sum + (file.additions || 0) + (file.deletions || 0), 0);
 | 
			
		||||
 | 
			
		||||
            console.log('Current labels:', currentLabels.join(', '));
 | 
			
		||||
            console.log('Changed files:', changedFiles.length);
 | 
			
		||||
            console.log('Total changes:', totalChanges);
 | 
			
		||||
            if (isMegaPR) {
 | 
			
		||||
              console.log('Mega-PR detected - applying limited labeling logic');
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Fetch API data
 | 
			
		||||
            async function fetchApiData() {
 | 
			
		||||
              try {
 | 
			
		||||
                const response = await fetch('https://data.esphome.io/components.json');
 | 
			
		||||
                const componentsData = await response.json();
 | 
			
		||||
                return {
 | 
			
		||||
                  targetPlatforms: componentsData.target_platforms || [],
 | 
			
		||||
                  platformComponents: componentsData.platform_components || []
 | 
			
		||||
                };
 | 
			
		||||
              } catch (error) {
 | 
			
		||||
                console.log('Failed to fetch components data from API:', error.message);
 | 
			
		||||
                return { targetPlatforms: [], platformComponents: [] };
 | 
			
		||||
              }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Merge branch detection
 | 
			
		||||
            async function detectMergeBranch() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const baseRef = context.payload.pull_request.base.ref;
 | 
			
		||||
 | 
			
		||||
              if (baseRef === 'release') {
 | 
			
		||||
                labels.add('merging-to-release');
 | 
			
		||||
              } else if (baseRef === 'beta') {
 | 
			
		||||
                labels.add('merging-to-beta');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Component and platform labeling
 | 
			
		||||
            async function detectComponentPlatforms(apiData) {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const componentRegex = /^esphome\/components\/([^\/]+)\//;
 | 
			
		||||
              const targetPlatformRegex = new RegExp(`^esphome\/components\/(${apiData.targetPlatforms.join('|')})/`);
 | 
			
		||||
 | 
			
		||||
              for (const file of changedFiles) {
 | 
			
		||||
                const componentMatch = file.match(componentRegex);
 | 
			
		||||
                if (componentMatch) {
 | 
			
		||||
                  labels.add(`component: ${componentMatch[1]}`);
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                const platformMatch = file.match(targetPlatformRegex);
 | 
			
		||||
                if (platformMatch) {
 | 
			
		||||
                  labels.add(`platform: ${platformMatch[1]}`);
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: New component detection
 | 
			
		||||
            async function detectNewComponents() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const addedFiles = prFiles.filter(file => file.status === 'added').map(file => file.filename);
 | 
			
		||||
 | 
			
		||||
              for (const file of addedFiles) {
 | 
			
		||||
                const componentMatch = file.match(/^esphome\/components\/([^\/]+)\/__init__\.py$/);
 | 
			
		||||
                if (componentMatch) {
 | 
			
		||||
                  try {
 | 
			
		||||
                    const content = fs.readFileSync(file, 'utf8');
 | 
			
		||||
                    if (content.includes('IS_TARGET_PLATFORM = True')) {
 | 
			
		||||
                      labels.add('new-target-platform');
 | 
			
		||||
                    }
 | 
			
		||||
                  } catch (error) {
 | 
			
		||||
                    console.log(`Failed to read content of ${file}:`, error.message);
 | 
			
		||||
                  }
 | 
			
		||||
                  labels.add('new-component');
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: New platform detection
 | 
			
		||||
            async function detectNewPlatforms(apiData) {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const addedFiles = prFiles.filter(file => file.status === 'added').map(file => file.filename);
 | 
			
		||||
 | 
			
		||||
              for (const file of addedFiles) {
 | 
			
		||||
                const platformFileMatch = file.match(/^esphome\/components\/([^\/]+)\/([^\/]+)\.py$/);
 | 
			
		||||
                if (platformFileMatch) {
 | 
			
		||||
                  const [, component, platform] = platformFileMatch;
 | 
			
		||||
                  if (apiData.platformComponents.includes(platform)) {
 | 
			
		||||
                    labels.add('new-platform');
 | 
			
		||||
                  }
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                const platformDirMatch = file.match(/^esphome\/components\/([^\/]+)\/([^\/]+)\/__init__\.py$/);
 | 
			
		||||
                if (platformDirMatch) {
 | 
			
		||||
                  const [, component, platform] = platformDirMatch;
 | 
			
		||||
                  if (apiData.platformComponents.includes(platform)) {
 | 
			
		||||
                    labels.add('new-platform');
 | 
			
		||||
                  }
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Core files detection
 | 
			
		||||
            async function detectCoreChanges() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const coreFiles = changedFiles.filter(file =>
 | 
			
		||||
                file.startsWith('esphome/core/') ||
 | 
			
		||||
                (file.startsWith('esphome/') && file.split('/').length === 2)
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              if (coreFiles.length > 0) {
 | 
			
		||||
                labels.add('core');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: PR size detection
 | 
			
		||||
            async function detectPRSize() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const testChanges = prFiles
 | 
			
		||||
                .filter(file => file.filename.startsWith('tests/'))
 | 
			
		||||
                .reduce((sum, file) => sum + (file.additions || 0) + (file.deletions || 0), 0);
 | 
			
		||||
 | 
			
		||||
              const nonTestChanges = totalChanges - testChanges;
 | 
			
		||||
 | 
			
		||||
              if (totalChanges <= SMALL_PR_THRESHOLD) {
 | 
			
		||||
                labels.add('small-pr');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Don't add too-big if mega-pr label is already present
 | 
			
		||||
              if (nonTestChanges > TOO_BIG_THRESHOLD && !isMegaPR) {
 | 
			
		||||
                labels.add('too-big');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Dashboard changes
 | 
			
		||||
            async function detectDashboardChanges() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const dashboardFiles = changedFiles.filter(file =>
 | 
			
		||||
                file.startsWith('esphome/dashboard/') ||
 | 
			
		||||
                file.startsWith('esphome/components/dashboard_import/')
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              if (dashboardFiles.length > 0) {
 | 
			
		||||
                labels.add('dashboard');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: GitHub Actions changes
 | 
			
		||||
            async function detectGitHubActionsChanges() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const githubActionsFiles = changedFiles.filter(file =>
 | 
			
		||||
                file.startsWith('.github/workflows/')
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              if (githubActionsFiles.length > 0) {
 | 
			
		||||
                labels.add('github-actions');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Code owner detection
 | 
			
		||||
            async function detectCodeOwner() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
 | 
			
		||||
              try {
 | 
			
		||||
                const { data: codeownersFile } = await github.rest.repos.getContent({
 | 
			
		||||
                  owner,
 | 
			
		||||
                  repo,
 | 
			
		||||
                  path: 'CODEOWNERS',
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                const codeownersContent = Buffer.from(codeownersFile.content, 'base64').toString('utf8');
 | 
			
		||||
                const prAuthor = context.payload.pull_request.user.login;
 | 
			
		||||
 | 
			
		||||
                const codeownersLines = codeownersContent.split('\n')
 | 
			
		||||
                  .map(line => line.trim())
 | 
			
		||||
                  .filter(line => line && !line.startsWith('#'));
 | 
			
		||||
 | 
			
		||||
                const codeownersRegexes = codeownersLines.map(line => {
 | 
			
		||||
                  const parts = line.split(/\s+/);
 | 
			
		||||
                  const pattern = parts[0];
 | 
			
		||||
                  const owners = parts.slice(1);
 | 
			
		||||
 | 
			
		||||
                  let regex;
 | 
			
		||||
                  if (pattern.endsWith('*')) {
 | 
			
		||||
                    const dir = pattern.slice(0, -1);
 | 
			
		||||
                    regex = new RegExp(`^${dir.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}`);
 | 
			
		||||
                  } else if (pattern.includes('*')) {
 | 
			
		||||
                    // First escape all regex special chars except *, then replace * with .*
 | 
			
		||||
                    const regexPattern = pattern
 | 
			
		||||
                      .replace(/[.+?^${}()|[\]\\]/g, '\\$&')
 | 
			
		||||
                      .replace(/\*/g, '.*');
 | 
			
		||||
                    regex = new RegExp(`^${regexPattern}$`);
 | 
			
		||||
                  } else {
 | 
			
		||||
                    regex = new RegExp(`^${pattern.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}$`);
 | 
			
		||||
                  }
 | 
			
		||||
 | 
			
		||||
                  return { regex, owners };
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                for (const file of changedFiles) {
 | 
			
		||||
                  for (const { regex, owners } of codeownersRegexes) {
 | 
			
		||||
                    if (regex.test(file) && owners.some(owner => owner === `@${prAuthor}`)) {
 | 
			
		||||
                      labels.add('by-code-owner');
 | 
			
		||||
                      return labels;
 | 
			
		||||
                    }
 | 
			
		||||
                  }
 | 
			
		||||
                }
 | 
			
		||||
              } catch (error) {
 | 
			
		||||
                console.log('Failed to read or parse CODEOWNERS file:', error.message);
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Test detection
 | 
			
		||||
            async function detectTests() {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
              const testFiles = changedFiles.filter(file => file.startsWith('tests/'));
 | 
			
		||||
 | 
			
		||||
              if (testFiles.length > 0) {
 | 
			
		||||
                labels.add('has-tests');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Strategy: Requirements detection
 | 
			
		||||
            async function detectRequirements(allLabels) {
 | 
			
		||||
              const labels = new Set();
 | 
			
		||||
 | 
			
		||||
              // Check for missing tests
 | 
			
		||||
              if ((allLabels.has('new-component') || allLabels.has('new-platform')) && !allLabels.has('has-tests')) {
 | 
			
		||||
                labels.add('needs-tests');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Check for missing docs
 | 
			
		||||
              if (allLabels.has('new-component') || allLabels.has('new-platform')) {
 | 
			
		||||
                const prBody = context.payload.pull_request.body || '';
 | 
			
		||||
                const hasDocsLink = DOCS_PR_PATTERNS.some(pattern => pattern.test(prBody));
 | 
			
		||||
 | 
			
		||||
                if (!hasDocsLink) {
 | 
			
		||||
                  labels.add('needs-docs');
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Check for missing CODEOWNERS
 | 
			
		||||
              if (allLabels.has('new-component')) {
 | 
			
		||||
                const codeownersModified = prFiles.some(file =>
 | 
			
		||||
                  file.filename === 'CODEOWNERS' &&
 | 
			
		||||
                  (file.status === 'modified' || file.status === 'added') &&
 | 
			
		||||
                  (file.additions || 0) > 0
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                if (!codeownersModified) {
 | 
			
		||||
                  labels.add('needs-codeowners');
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return labels;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Generate review messages
 | 
			
		||||
            function generateReviewMessages(finalLabels) {
 | 
			
		||||
              const messages = [];
 | 
			
		||||
              const prAuthor = context.payload.pull_request.user.login;
 | 
			
		||||
 | 
			
		||||
              // Too big message
 | 
			
		||||
              if (finalLabels.includes('too-big')) {
 | 
			
		||||
                const testChanges = prFiles
 | 
			
		||||
                  .filter(file => file.filename.startsWith('tests/'))
 | 
			
		||||
                  .reduce((sum, file) => sum + (file.additions || 0) + (file.deletions || 0), 0);
 | 
			
		||||
                const nonTestChanges = totalChanges - testChanges;
 | 
			
		||||
 | 
			
		||||
                const tooManyLabels = finalLabels.length > MAX_LABELS;
 | 
			
		||||
                const tooManyChanges = nonTestChanges > TOO_BIG_THRESHOLD;
 | 
			
		||||
 | 
			
		||||
                let message = `${TOO_BIG_MARKER}\n### 📦 Pull Request Size\n\n`;
 | 
			
		||||
 | 
			
		||||
                if (tooManyLabels && tooManyChanges) {
 | 
			
		||||
                  message += `This PR is too large with ${nonTestChanges} line changes (excluding tests) and affects ${finalLabels.length} different components/areas.`;
 | 
			
		||||
                } else if (tooManyLabels) {
 | 
			
		||||
                  message += `This PR affects ${finalLabels.length} different components/areas.`;
 | 
			
		||||
                } else {
 | 
			
		||||
                  message += `This PR is too large with ${nonTestChanges} line changes (excluding tests).`;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                message += ` Please consider breaking it down into smaller, focused PRs to make review easier and reduce the risk of conflicts.\n\n`;
 | 
			
		||||
                message += `For guidance on breaking down large PRs, see: https://developers.esphome.io/contributing/submitting-your-work/#how-to-approach-large-submissions`;
 | 
			
		||||
 | 
			
		||||
                messages.push(message);
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // CODEOWNERS message
 | 
			
		||||
              if (finalLabels.includes('needs-codeowners')) {
 | 
			
		||||
                const message = `${CODEOWNERS_MARKER}\n### 👥 Code Ownership\n\n` +
 | 
			
		||||
                  `Hey there @${prAuthor},\n` +
 | 
			
		||||
                  `Thanks for submitting this pull request! Can you add yourself as a codeowner for this integration? ` +
 | 
			
		||||
                  `This way we can notify you if a bug report for this integration is reported.\n\n` +
 | 
			
		||||
                  `In \`__init__.py\` of the integration, please add:\n\n` +
 | 
			
		||||
                  `\`\`\`python\nCODEOWNERS = ["@${prAuthor}"]\n\`\`\`\n\n` +
 | 
			
		||||
                  `And run \`script/build_codeowners.py\``;
 | 
			
		||||
 | 
			
		||||
                messages.push(message);
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return messages;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Handle reviews
 | 
			
		||||
            async function handleReviews(finalLabels) {
 | 
			
		||||
              const reviewMessages = generateReviewMessages(finalLabels);
 | 
			
		||||
              const hasReviewableLabels = finalLabels.some(label =>
 | 
			
		||||
                ['too-big', 'needs-codeowners'].includes(label)
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              const { data: reviews } = await github.rest.pulls.listReviews({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                pull_number: pr_number
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              const botReviews = reviews.filter(review =>
 | 
			
		||||
                review.user.type === 'Bot' &&
 | 
			
		||||
                review.state === 'CHANGES_REQUESTED' &&
 | 
			
		||||
                review.body && review.body.includes(BOT_COMMENT_MARKER)
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              if (hasReviewableLabels) {
 | 
			
		||||
                const reviewBody = `${BOT_COMMENT_MARKER}\n\n${reviewMessages.join('\n\n---\n\n')}`;
 | 
			
		||||
 | 
			
		||||
                if (botReviews.length > 0) {
 | 
			
		||||
                  // Update existing review
 | 
			
		||||
                  await github.rest.pulls.updateReview({
 | 
			
		||||
                    owner,
 | 
			
		||||
                    repo,
 | 
			
		||||
                    pull_number: pr_number,
 | 
			
		||||
                    review_id: botReviews[0].id,
 | 
			
		||||
                    body: reviewBody
 | 
			
		||||
                  });
 | 
			
		||||
                  console.log('Updated existing bot review');
 | 
			
		||||
                } else {
 | 
			
		||||
                  // Create new review
 | 
			
		||||
                  await github.rest.pulls.createReview({
 | 
			
		||||
                    owner,
 | 
			
		||||
                    repo,
 | 
			
		||||
                    pull_number: pr_number,
 | 
			
		||||
                    body: reviewBody,
 | 
			
		||||
                    event: 'REQUEST_CHANGES'
 | 
			
		||||
                  });
 | 
			
		||||
                  console.log('Created new bot review');
 | 
			
		||||
                }
 | 
			
		||||
              } else if (botReviews.length > 0) {
 | 
			
		||||
                // Dismiss existing reviews
 | 
			
		||||
                for (const review of botReviews) {
 | 
			
		||||
                  try {
 | 
			
		||||
                    await github.rest.pulls.dismissReview({
 | 
			
		||||
                      owner,
 | 
			
		||||
                      repo,
 | 
			
		||||
                      pull_number: pr_number,
 | 
			
		||||
                      review_id: review.id,
 | 
			
		||||
                      message: 'Review dismissed: All requirements have been met'
 | 
			
		||||
                    });
 | 
			
		||||
                    console.log(`Dismissed bot review ${review.id}`);
 | 
			
		||||
                  } catch (error) {
 | 
			
		||||
                    console.log(`Failed to dismiss review ${review.id}:`, error.message);
 | 
			
		||||
                  }
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Main execution
 | 
			
		||||
            const apiData = await fetchApiData();
 | 
			
		||||
            const baseRef = context.payload.pull_request.base.ref;
 | 
			
		||||
 | 
			
		||||
            // Early exit for non-dev branches
 | 
			
		||||
            if (baseRef !== 'dev') {
 | 
			
		||||
              const branchLabels = await detectMergeBranch();
 | 
			
		||||
              const finalLabels = Array.from(branchLabels);
 | 
			
		||||
 | 
			
		||||
              console.log('Computed labels (merge branch only):', finalLabels.join(', '));
 | 
			
		||||
 | 
			
		||||
              // Apply labels
 | 
			
		||||
              if (finalLabels.length > 0) {
 | 
			
		||||
                await github.rest.issues.addLabels({
 | 
			
		||||
                  owner,
 | 
			
		||||
                  repo,
 | 
			
		||||
                  issue_number: pr_number,
 | 
			
		||||
                  labels: finalLabels
 | 
			
		||||
                });
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Remove old managed labels
 | 
			
		||||
              const labelsToRemove = managedLabels.filter(label => !finalLabels.includes(label));
 | 
			
		||||
              for (const label of labelsToRemove) {
 | 
			
		||||
                try {
 | 
			
		||||
                  await github.rest.issues.removeLabel({
 | 
			
		||||
                    owner,
 | 
			
		||||
                    repo,
 | 
			
		||||
                    issue_number: pr_number,
 | 
			
		||||
                    name: label
 | 
			
		||||
                  });
 | 
			
		||||
                } catch (error) {
 | 
			
		||||
                  console.log(`Failed to remove label ${label}:`, error.message);
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Run all strategies
 | 
			
		||||
            const [
 | 
			
		||||
              branchLabels,
 | 
			
		||||
              componentLabels,
 | 
			
		||||
              newComponentLabels,
 | 
			
		||||
              newPlatformLabels,
 | 
			
		||||
              coreLabels,
 | 
			
		||||
              sizeLabels,
 | 
			
		||||
              dashboardLabels,
 | 
			
		||||
              actionsLabels,
 | 
			
		||||
              codeOwnerLabels,
 | 
			
		||||
              testLabels
 | 
			
		||||
            ] = await Promise.all([
 | 
			
		||||
              detectMergeBranch(),
 | 
			
		||||
              detectComponentPlatforms(apiData),
 | 
			
		||||
              detectNewComponents(),
 | 
			
		||||
              detectNewPlatforms(apiData),
 | 
			
		||||
              detectCoreChanges(),
 | 
			
		||||
              detectPRSize(),
 | 
			
		||||
              detectDashboardChanges(),
 | 
			
		||||
              detectGitHubActionsChanges(),
 | 
			
		||||
              detectCodeOwner(),
 | 
			
		||||
              detectTests()
 | 
			
		||||
            ]);
 | 
			
		||||
 | 
			
		||||
            // Combine all labels
 | 
			
		||||
            const allLabels = new Set([
 | 
			
		||||
              ...branchLabels,
 | 
			
		||||
              ...componentLabels,
 | 
			
		||||
              ...newComponentLabels,
 | 
			
		||||
              ...newPlatformLabels,
 | 
			
		||||
              ...coreLabels,
 | 
			
		||||
              ...sizeLabels,
 | 
			
		||||
              ...dashboardLabels,
 | 
			
		||||
              ...actionsLabels,
 | 
			
		||||
              ...codeOwnerLabels,
 | 
			
		||||
              ...testLabels
 | 
			
		||||
            ]);
 | 
			
		||||
 | 
			
		||||
            // Detect requirements based on all other labels
 | 
			
		||||
            const requirementLabels = await detectRequirements(allLabels);
 | 
			
		||||
            for (const label of requirementLabels) {
 | 
			
		||||
              allLabels.add(label);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            let finalLabels = Array.from(allLabels);
 | 
			
		||||
 | 
			
		||||
            // For mega-PRs, exclude component labels if there are too many
 | 
			
		||||
            if (isMegaPR) {
 | 
			
		||||
              const componentLabels = finalLabels.filter(label => label.startsWith('component: '));
 | 
			
		||||
              if (componentLabels.length > COMPONENT_LABEL_THRESHOLD) {
 | 
			
		||||
                finalLabels = finalLabels.filter(label => !label.startsWith('component: '));
 | 
			
		||||
                console.log(`Mega-PR detected - excluding ${componentLabels.length} component labels (threshold: ${COMPONENT_LABEL_THRESHOLD})`);
 | 
			
		||||
              }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Handle too many labels (only for non-mega PRs)
 | 
			
		||||
            const tooManyLabels = finalLabels.length > MAX_LABELS;
 | 
			
		||||
 | 
			
		||||
            if (tooManyLabels && !isMegaPR && !finalLabels.includes('too-big')) {
 | 
			
		||||
              finalLabels = ['too-big'];
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            console.log('Computed labels:', finalLabels.join(', '));
 | 
			
		||||
 | 
			
		||||
            // Handle reviews
 | 
			
		||||
            await handleReviews(finalLabels);
 | 
			
		||||
 | 
			
		||||
            // Apply labels
 | 
			
		||||
            if (finalLabels.length > 0) {
 | 
			
		||||
              console.log(`Adding labels: ${finalLabels.join(', ')}`);
 | 
			
		||||
              await github.rest.issues.addLabels({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                issue_number: pr_number,
 | 
			
		||||
                labels: finalLabels
 | 
			
		||||
              });
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Remove old managed labels
 | 
			
		||||
            const labelsToRemove = managedLabels.filter(label => !finalLabels.includes(label));
 | 
			
		||||
            for (const label of labelsToRemove) {
 | 
			
		||||
              console.log(`Removing label: ${label}`);
 | 
			
		||||
              try {
 | 
			
		||||
                await github.rest.issues.removeLabel({
 | 
			
		||||
                  owner,
 | 
			
		||||
                  repo,
 | 
			
		||||
                  issue_number: pr_number,
 | 
			
		||||
                  name: label
 | 
			
		||||
                });
 | 
			
		||||
              } catch (error) {
 | 
			
		||||
                console.log(`Failed to remove label ${label}:`, error.message);
 | 
			
		||||
              }
 | 
			
		||||
            }
 | 
			
		||||
							
								
								
									
										75
									
								
								.github/workflows/ci-clang-tidy-hash.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										75
									
								
								.github/workflows/ci-clang-tidy-hash.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,75 @@
 | 
			
		||||
name: Clang-tidy Hash CI
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    paths:
 | 
			
		||||
      - ".clang-tidy"
 | 
			
		||||
      - "platformio.ini"
 | 
			
		||||
      - "requirements_dev.txt"
 | 
			
		||||
      - ".clang-tidy.hash"
 | 
			
		||||
      - "script/clang_tidy_hash.py"
 | 
			
		||||
      - ".github/workflows/ci-clang-tidy-hash.yml"
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  verify-hash:
 | 
			
		||||
    name: Verify clang-tidy hash
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
 | 
			
		||||
      - name: Set up Python
 | 
			
		||||
        uses: actions/setup-python@v5.6.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.11"
 | 
			
		||||
 | 
			
		||||
      - name: Verify hash
 | 
			
		||||
        run: |
 | 
			
		||||
          python script/clang_tidy_hash.py --verify
 | 
			
		||||
 | 
			
		||||
      - if: failure()
 | 
			
		||||
        name: Show hash details
 | 
			
		||||
        run: |
 | 
			
		||||
          python script/clang_tidy_hash.py
 | 
			
		||||
          echo "## Job Failed" | tee -a $GITHUB_STEP_SUMMARY
 | 
			
		||||
          echo "You have modified clang-tidy configuration but have not updated the hash." | tee -a $GITHUB_STEP_SUMMARY
 | 
			
		||||
          echo "Please run 'script/clang_tidy_hash.py --update' and commit the changes." | tee -a $GITHUB_STEP_SUMMARY
 | 
			
		||||
 | 
			
		||||
      - if: failure()
 | 
			
		||||
        name: Request changes
 | 
			
		||||
        uses: actions/github-script@v7.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          script: |
 | 
			
		||||
            await github.rest.pulls.createReview({
 | 
			
		||||
              pull_number: context.issue.number,
 | 
			
		||||
              owner: context.repo.owner,
 | 
			
		||||
              repo: context.repo.repo,
 | 
			
		||||
              event: 'REQUEST_CHANGES',
 | 
			
		||||
              body: 'You have modified clang-tidy configuration but have not updated the hash.\nPlease run `script/clang_tidy_hash.py --update` and commit the changes.'
 | 
			
		||||
            })
 | 
			
		||||
 | 
			
		||||
      - if: success()
 | 
			
		||||
        name: Dismiss review
 | 
			
		||||
        uses: actions/github-script@v7.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          script: |
 | 
			
		||||
            let reviews = await github.rest.pulls.listReviews({
 | 
			
		||||
              pull_number: context.issue.number,
 | 
			
		||||
              owner: context.repo.owner,
 | 
			
		||||
              repo: context.repo.repo
 | 
			
		||||
            });
 | 
			
		||||
            for (let review of reviews.data) {
 | 
			
		||||
              if (review.user.login === 'github-actions[bot]' && review.state === 'CHANGES_REQUESTED') {
 | 
			
		||||
                await github.rest.pulls.dismissReview({
 | 
			
		||||
                  pull_number: context.issue.number,
 | 
			
		||||
                  owner: context.repo.owner,
 | 
			
		||||
                  repo: context.repo.repo,
 | 
			
		||||
                  review_id: review.id,
 | 
			
		||||
                  message: 'Clang-tidy hash now matches configuration.'
 | 
			
		||||
                });
 | 
			
		||||
              }
 | 
			
		||||
            }
 | 
			
		||||
							
								
								
									
										4
									
								
								.github/workflows/ci-docker.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/ci-docker.yml
									
									
									
									
										vendored
									
									
								
							@@ -47,9 +47,9 @@ jobs:
 | 
			
		||||
      - name: Set up Python
 | 
			
		||||
        uses: actions/setup-python@v5.6.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.10"
 | 
			
		||||
          python-version: "3.11"
 | 
			
		||||
      - name: Set up Docker Buildx
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.10.0
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.11.1
 | 
			
		||||
 | 
			
		||||
      - name: Set TAG
 | 
			
		||||
        run: |
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										284
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										284
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							@@ -20,8 +20,8 @@ permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
env:
 | 
			
		||||
  DEFAULT_PYTHON: "3.10"
 | 
			
		||||
  PYUPGRADE_TARGET: "--py310-plus"
 | 
			
		||||
  DEFAULT_PYTHON: "3.11"
 | 
			
		||||
  PYUPGRADE_TARGET: "--py311-plus"
 | 
			
		||||
 | 
			
		||||
concurrency:
 | 
			
		||||
  # yamllint disable-line rule:line-length
 | 
			
		||||
@@ -39,7 +39,7 @@ jobs:
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Generate cache-key
 | 
			
		||||
        id: cache-key
 | 
			
		||||
        run: echo key="${{ hashFiles('requirements.txt', 'requirements_test.txt') }}" >> $GITHUB_OUTPUT
 | 
			
		||||
        run: echo key="${{ hashFiles('requirements.txt', 'requirements_test.txt', '.pre-commit-config.yaml') }}" >> $GITHUB_OUTPUT
 | 
			
		||||
      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
        id: python
 | 
			
		||||
        uses: actions/setup-python@v5.6.0
 | 
			
		||||
@@ -58,56 +58,16 @@ jobs:
 | 
			
		||||
          python -m venv venv
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          python --version
 | 
			
		||||
          pip install -r requirements.txt -r requirements_test.txt
 | 
			
		||||
          pip install -r requirements.txt -r requirements_test.txt pre-commit
 | 
			
		||||
          pip install -e .
 | 
			
		||||
 | 
			
		||||
  ruff:
 | 
			
		||||
    name: Check ruff
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
          cache-key: ${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - name: Run Ruff
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          ruff format esphome tests
 | 
			
		||||
      - name: Suggested changes
 | 
			
		||||
        run: script/ci-suggest-changes
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  flake8:
 | 
			
		||||
    name: Check flake8
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
          cache-key: ${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - name: Run flake8
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          flake8 esphome
 | 
			
		||||
      - name: Suggested changes
 | 
			
		||||
        run: script/ci-suggest-changes
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  pylint:
 | 
			
		||||
    name: Check pylint
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
    if: needs.determine-jobs.outputs.python-linters == 'true'
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
@@ -124,27 +84,6 @@ jobs:
 | 
			
		||||
        run: script/ci-suggest-changes
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  pyupgrade:
 | 
			
		||||
    name: Check pyupgrade
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
          cache-key: ${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - name: Run pyupgrade
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          pyupgrade ${{ env.PYUPGRADE_TARGET }} `find esphome -name "*.py" -type f`
 | 
			
		||||
      - name: Suggested changes
 | 
			
		||||
        run: script/ci-suggest-changes
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  ci-custom:
 | 
			
		||||
    name: Run script/ci-custom
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
@@ -173,7 +112,6 @@ jobs:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      matrix:
 | 
			
		||||
        python-version:
 | 
			
		||||
          - "3.10"
 | 
			
		||||
          - "3.11"
 | 
			
		||||
          - "3.12"
 | 
			
		||||
          - "3.13"
 | 
			
		||||
@@ -189,14 +127,10 @@ jobs:
 | 
			
		||||
            os: windows-latest
 | 
			
		||||
          - python-version: "3.12"
 | 
			
		||||
            os: windows-latest
 | 
			
		||||
          - python-version: "3.10"
 | 
			
		||||
            os: windows-latest
 | 
			
		||||
          - python-version: "3.13"
 | 
			
		||||
            os: macOS-latest
 | 
			
		||||
          - python-version: "3.12"
 | 
			
		||||
            os: macOS-latest
 | 
			
		||||
          - python-version: "3.10"
 | 
			
		||||
            os: macOS-latest
 | 
			
		||||
    runs-on: ${{ matrix.os }}
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
@@ -204,6 +138,7 @@ jobs:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        id: restore-python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ matrix.python-version }}
 | 
			
		||||
@@ -213,56 +148,108 @@ jobs:
 | 
			
		||||
      - name: Run pytest
 | 
			
		||||
        if: matrix.os == 'windows-latest'
 | 
			
		||||
        run: |
 | 
			
		||||
          ./venv/Scripts/activate
 | 
			
		||||
          pytest -vv --cov-report=xml --tb=native -n auto tests
 | 
			
		||||
          . ./venv/Scripts/activate.ps1
 | 
			
		||||
          pytest -vv --cov-report=xml --tb=native -n auto tests --ignore=tests/integration/
 | 
			
		||||
      - name: Run pytest
 | 
			
		||||
        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macOS-latest'
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          pytest -vv --cov-report=xml --tb=native -n auto tests
 | 
			
		||||
          pytest -vv --cov-report=xml --tb=native -n auto tests --ignore=tests/integration/
 | 
			
		||||
      - name: Upload coverage to Codecov
 | 
			
		||||
        uses: codecov/codecov-action@v5.4.3
 | 
			
		||||
        with:
 | 
			
		||||
          token: ${{ secrets.CODECOV_TOKEN }}
 | 
			
		||||
      - name: Save Python virtual environment cache
 | 
			
		||||
        if: github.ref == 'refs/heads/dev'
 | 
			
		||||
        uses: actions/cache/save@v4.2.3
 | 
			
		||||
        with:
 | 
			
		||||
          path: venv
 | 
			
		||||
          key: ${{ runner.os }}-${{ steps.restore-python.outputs.python-version }}-venv-${{ needs.common.outputs.cache-key }}
 | 
			
		||||
 | 
			
		||||
  clang-format:
 | 
			
		||||
    name: Check clang-format
 | 
			
		||||
  determine-jobs:
 | 
			
		||||
    name: Determine which jobs to run
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    outputs:
 | 
			
		||||
      integration-tests: ${{ steps.determine.outputs.integration-tests }}
 | 
			
		||||
      clang-tidy: ${{ steps.determine.outputs.clang-tidy }}
 | 
			
		||||
      python-linters: ${{ steps.determine.outputs.python-linters }}
 | 
			
		||||
      changed-components: ${{ steps.determine.outputs.changed-components }}
 | 
			
		||||
      component-test-count: ${{ steps.determine.outputs.component-test-count }}
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
        with:
 | 
			
		||||
          # Fetch enough history to find the merge base
 | 
			
		||||
          fetch-depth: 2
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
          cache-key: ${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - name: Install clang-format
 | 
			
		||||
      - name: Determine which tests to run
 | 
			
		||||
        id: determine
 | 
			
		||||
        env:
 | 
			
		||||
          GH_TOKEN: ${{ github.token }}
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          pip install clang-format -c requirements_dev.txt
 | 
			
		||||
      - name: Run clang-format
 | 
			
		||||
          output=$(python script/determine-jobs.py)
 | 
			
		||||
          echo "Test determination output:"
 | 
			
		||||
          echo "$output" | jq
 | 
			
		||||
 | 
			
		||||
          # Extract individual fields
 | 
			
		||||
          echo "integration-tests=$(echo "$output" | jq -r '.integration_tests')" >> $GITHUB_OUTPUT
 | 
			
		||||
          echo "clang-tidy=$(echo "$output" | jq -r '.clang_tidy')" >> $GITHUB_OUTPUT
 | 
			
		||||
          echo "python-linters=$(echo "$output" | jq -r '.python_linters')" >> $GITHUB_OUTPUT
 | 
			
		||||
          echo "changed-components=$(echo "$output" | jq -c '.changed_components')" >> $GITHUB_OUTPUT
 | 
			
		||||
          echo "component-test-count=$(echo "$output" | jq -r '.component_test_count')" >> $GITHUB_OUTPUT
 | 
			
		||||
 | 
			
		||||
  integration-tests:
 | 
			
		||||
    name: Run integration tests
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
    if: needs.determine-jobs.outputs.integration-tests == 'true'
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Set up Python 3.13
 | 
			
		||||
        id: python
 | 
			
		||||
        uses: actions/setup-python@v5.6.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.13"
 | 
			
		||||
      - name: Restore Python virtual environment
 | 
			
		||||
        id: cache-venv
 | 
			
		||||
        uses: actions/cache@v4.2.3
 | 
			
		||||
        with:
 | 
			
		||||
          path: venv
 | 
			
		||||
          key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - name: Create Python virtual environment
 | 
			
		||||
        if: steps.cache-venv.outputs.cache-hit != 'true'
 | 
			
		||||
        run: |
 | 
			
		||||
          python -m venv venv
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          python --version
 | 
			
		||||
          pip install -r requirements.txt -r requirements_test.txt
 | 
			
		||||
          pip install -e .
 | 
			
		||||
      - name: Register matcher
 | 
			
		||||
        run: echo "::add-matcher::.github/workflows/matchers/pytest.json"
 | 
			
		||||
      - name: Run integration tests
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          script/clang-format -i
 | 
			
		||||
          git diff-index --quiet HEAD --
 | 
			
		||||
      - name: Suggested changes
 | 
			
		||||
        run: script/ci-suggest-changes
 | 
			
		||||
        if: always()
 | 
			
		||||
          pytest -vv --no-cov --tb=native -n auto tests/integration/
 | 
			
		||||
 | 
			
		||||
  clang-tidy:
 | 
			
		||||
    name: ${{ matrix.name }}
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - ruff
 | 
			
		||||
      - ci-custom
 | 
			
		||||
      - clang-format
 | 
			
		||||
      - flake8
 | 
			
		||||
      - pylint
 | 
			
		||||
      - pytest
 | 
			
		||||
      - pyupgrade
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
    if: needs.determine-jobs.outputs.clang-tidy == 'true'
 | 
			
		||||
    env:
 | 
			
		||||
      GH_TOKEN: ${{ github.token }}
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      max-parallel: 2
 | 
			
		||||
@@ -301,6 +288,10 @@ jobs:
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
        with:
 | 
			
		||||
          # Need history for HEAD~1 to work for checking changed files
 | 
			
		||||
          fetch-depth: 2
 | 
			
		||||
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
@@ -312,14 +303,14 @@ jobs:
 | 
			
		||||
        uses: actions/cache@v4.2.3
 | 
			
		||||
        with:
 | 
			
		||||
          path: ~/.platformio
 | 
			
		||||
          key: platformio-${{ matrix.pio_cache_key }}
 | 
			
		||||
          key: platformio-${{ matrix.pio_cache_key }}-${{ hashFiles('platformio.ini') }}
 | 
			
		||||
 | 
			
		||||
      - name: Cache platformio
 | 
			
		||||
        if: github.ref != 'refs/heads/dev'
 | 
			
		||||
        uses: actions/cache/restore@v4.2.3
 | 
			
		||||
        with:
 | 
			
		||||
          path: ~/.platformio
 | 
			
		||||
          key: platformio-${{ matrix.pio_cache_key }}
 | 
			
		||||
          key: platformio-${{ matrix.pio_cache_key }}-${{ hashFiles('platformio.ini') }}
 | 
			
		||||
 | 
			
		||||
      - name: Register problem matchers
 | 
			
		||||
        run: |
 | 
			
		||||
@@ -333,10 +324,28 @@ jobs:
 | 
			
		||||
          mkdir -p .temp
 | 
			
		||||
          pio run --list-targets -e esp32-idf-tidy
 | 
			
		||||
 | 
			
		||||
      - name: Check if full clang-tidy scan needed
 | 
			
		||||
        id: check_full_scan
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          if python script/clang_tidy_hash.py --check; then
 | 
			
		||||
            echo "full_scan=true" >> $GITHUB_OUTPUT
 | 
			
		||||
            echo "reason=hash_changed" >> $GITHUB_OUTPUT
 | 
			
		||||
          else
 | 
			
		||||
            echo "full_scan=false" >> $GITHUB_OUTPUT
 | 
			
		||||
            echo "reason=normal" >> $GITHUB_OUTPUT
 | 
			
		||||
          fi
 | 
			
		||||
 | 
			
		||||
      - name: Run clang-tidy
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          script/clang-tidy --all-headers --fix ${{ matrix.options }} ${{ matrix.ignore_errors && '|| true' || '' }}
 | 
			
		||||
          if [ "${{ steps.check_full_scan.outputs.full_scan }}" = "true" ]; then
 | 
			
		||||
            echo "Running FULL clang-tidy scan (hash changed)"
 | 
			
		||||
            script/clang-tidy --all-headers --fix ${{ matrix.options }} ${{ matrix.ignore_errors && '|| true' || '' }}
 | 
			
		||||
          else
 | 
			
		||||
            echo "Running clang-tidy on changed files only"
 | 
			
		||||
            script/clang-tidy --all-headers --fix --changed ${{ matrix.options }} ${{ matrix.ignore_errors && '|| true' || '' }}
 | 
			
		||||
          fi
 | 
			
		||||
        env:
 | 
			
		||||
          # Also cache libdeps, store them in a ~/.platformio subfolder
 | 
			
		||||
          PLATFORMIO_LIBDEPS_DIR: ~/.platformio/libdeps
 | 
			
		||||
@@ -346,59 +355,18 @@ jobs:
 | 
			
		||||
        # yamllint disable-line rule:line-length
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  list-components:
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    if: github.event_name == 'pull_request'
 | 
			
		||||
    outputs:
 | 
			
		||||
      components: ${{ steps.list-components.outputs.components }}
 | 
			
		||||
      count: ${{ steps.list-components.outputs.count }}
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
        with:
 | 
			
		||||
          # Fetch enough history so `git merge-base refs/remotes/origin/dev HEAD` works.
 | 
			
		||||
          fetch-depth: 500
 | 
			
		||||
      - name: Get target branch
 | 
			
		||||
        id: target-branch
 | 
			
		||||
        run: |
 | 
			
		||||
          echo "branch=${{ github.event.pull_request.base.ref }}" >> $GITHUB_OUTPUT
 | 
			
		||||
      - name: Fetch ${{ steps.target-branch.outputs.branch }} branch
 | 
			
		||||
        run: |
 | 
			
		||||
          git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin +refs/heads/${{ steps.target-branch.outputs.branch }}:refs/remotes/origin/${{ steps.target-branch.outputs.branch }}
 | 
			
		||||
          git merge-base refs/remotes/origin/${{ steps.target-branch.outputs.branch }} HEAD
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
          cache-key: ${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - name: Find changed components
 | 
			
		||||
        id: list-components
 | 
			
		||||
        run: |
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          components=$(script/list-components.py --changed --branch ${{ steps.target-branch.outputs.branch }})
 | 
			
		||||
          output_components=$(echo "$components" | jq -R -s -c 'split("\n")[:-1] | map(select(length > 0))')
 | 
			
		||||
          count=$(echo "$output_components" | jq length)
 | 
			
		||||
 | 
			
		||||
          echo "components=$output_components" >> $GITHUB_OUTPUT
 | 
			
		||||
          echo "count=$count" >> $GITHUB_OUTPUT
 | 
			
		||||
 | 
			
		||||
          echo "$count Components:"
 | 
			
		||||
          echo "$output_components" | jq
 | 
			
		||||
 | 
			
		||||
  test-build-components:
 | 
			
		||||
    name: Component test ${{ matrix.file }}
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - list-components
 | 
			
		||||
    if: github.event_name == 'pull_request' && fromJSON(needs.list-components.outputs.count) > 0 && fromJSON(needs.list-components.outputs.count) < 100
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
    if: github.event_name == 'pull_request' && fromJSON(needs.determine-jobs.outputs.component-test-count) > 0 && fromJSON(needs.determine-jobs.outputs.component-test-count) < 100
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      max-parallel: 2
 | 
			
		||||
      matrix:
 | 
			
		||||
        file: ${{ fromJson(needs.list-components.outputs.components) }}
 | 
			
		||||
        file: ${{ fromJson(needs.determine-jobs.outputs.changed-components) }}
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Install dependencies
 | 
			
		||||
        run: |
 | 
			
		||||
@@ -426,8 +394,8 @@ jobs:
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - list-components
 | 
			
		||||
    if: github.event_name == 'pull_request' && fromJSON(needs.list-components.outputs.count) >= 100
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
    if: github.event_name == 'pull_request' && fromJSON(needs.determine-jobs.outputs.component-test-count) >= 100
 | 
			
		||||
    outputs:
 | 
			
		||||
      matrix: ${{ steps.split.outputs.components }}
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -436,7 +404,7 @@ jobs:
 | 
			
		||||
      - name: Split components into 20 groups
 | 
			
		||||
        id: split
 | 
			
		||||
        run: |
 | 
			
		||||
          components=$(echo '${{ needs.list-components.outputs.components }}' | jq -c '.[]' | shuf | jq -s -c '[_nwise(20) | join(" ")]')
 | 
			
		||||
          components=$(echo '${{ needs.determine-jobs.outputs.changed-components }}' | jq -c '.[]' | shuf | jq -s -c '[_nwise(20) | join(" ")]')
 | 
			
		||||
          echo "components=$components" >> $GITHUB_OUTPUT
 | 
			
		||||
 | 
			
		||||
  test-build-components-split:
 | 
			
		||||
@@ -444,9 +412,9 @@ jobs:
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - list-components
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
      - test-build-components-splitter
 | 
			
		||||
    if: github.event_name == 'pull_request' && fromJSON(needs.list-components.outputs.count) >= 100
 | 
			
		||||
    if: github.event_name == 'pull_request' && fromJSON(needs.determine-jobs.outputs.component-test-count) >= 100
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      max-parallel: 4
 | 
			
		||||
@@ -483,23 +451,41 @@ jobs:
 | 
			
		||||
            ./script/test_build_components -e compile -c $component
 | 
			
		||||
          done
 | 
			
		||||
 | 
			
		||||
  pre-commit-ci-lite:
 | 
			
		||||
    name: pre-commit.ci lite
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    if: github.event_name == 'pull_request' && github.base_ref != 'beta' && github.base_ref != 'release'
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Restore Python
 | 
			
		||||
        uses: ./.github/actions/restore-python
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
          cache-key: ${{ needs.common.outputs.cache-key }}
 | 
			
		||||
      - uses: pre-commit/action@v3.0.1
 | 
			
		||||
        env:
 | 
			
		||||
          SKIP: pylint,clang-tidy-hash
 | 
			
		||||
      - uses: pre-commit-ci/lite-action@v1.1.0
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  ci-status:
 | 
			
		||||
    name: CI Status
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - ruff
 | 
			
		||||
      - ci-custom
 | 
			
		||||
      - clang-format
 | 
			
		||||
      - flake8
 | 
			
		||||
      - pylint
 | 
			
		||||
      - pytest
 | 
			
		||||
      - pyupgrade
 | 
			
		||||
      - integration-tests
 | 
			
		||||
      - clang-tidy
 | 
			
		||||
      - list-components
 | 
			
		||||
      - determine-jobs
 | 
			
		||||
      - test-build-components
 | 
			
		||||
      - test-build-components-splitter
 | 
			
		||||
      - test-build-components-split
 | 
			
		||||
      - pre-commit-ci-lite
 | 
			
		||||
    if: always()
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Success
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										324
									
								
								.github/workflows/codeowner-review-request.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										324
									
								
								.github/workflows/codeowner-review-request.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,324 @@
 | 
			
		||||
# This workflow automatically requests reviews from codeowners when:
 | 
			
		||||
# 1. A PR is opened, reopened, or synchronized (updated)
 | 
			
		||||
# 2. A PR is marked as ready for review
 | 
			
		||||
#
 | 
			
		||||
# It reads the CODEOWNERS file and matches all changed files in the PR against
 | 
			
		||||
# the codeowner patterns, then requests reviews from the appropriate owners
 | 
			
		||||
# while avoiding duplicate requests for users who have already been requested
 | 
			
		||||
# or have already reviewed the PR.
 | 
			
		||||
 | 
			
		||||
name: Request Codeowner Reviews
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  # Needs to be pull_request_target to get write permissions
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [opened, reopened, synchronize, ready_for_review]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  request-codeowner-reviews:
 | 
			
		||||
    name: Run
 | 
			
		||||
    if: ${{ !github.event.pull_request.draft }}
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Request reviews from component codeowners
 | 
			
		||||
        uses: actions/github-script@v7.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          script: |
 | 
			
		||||
            const owner = context.repo.owner;
 | 
			
		||||
            const repo = context.repo.repo;
 | 
			
		||||
            const pr_number = context.payload.pull_request.number;
 | 
			
		||||
 | 
			
		||||
            console.log(`Processing PR #${pr_number} for codeowner review requests`);
 | 
			
		||||
 | 
			
		||||
            // Hidden marker to identify bot comments from this workflow
 | 
			
		||||
            const BOT_COMMENT_MARKER = '<!-- codeowner-review-request-bot -->';
 | 
			
		||||
 | 
			
		||||
            try {
 | 
			
		||||
              // Get the list of changed files in this PR
 | 
			
		||||
              const { data: files } = await github.rest.pulls.listFiles({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                pull_number: pr_number
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              const changedFiles = files.map(file => file.filename);
 | 
			
		||||
              console.log(`Found ${changedFiles.length} changed files`);
 | 
			
		||||
 | 
			
		||||
              if (changedFiles.length === 0) {
 | 
			
		||||
                console.log('No changed files found, skipping codeowner review requests');
 | 
			
		||||
                return;
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Fetch CODEOWNERS file from root
 | 
			
		||||
              const { data: codeownersFile } = await github.rest.repos.getContent({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                path: 'CODEOWNERS',
 | 
			
		||||
                ref: context.payload.pull_request.base.sha
 | 
			
		||||
              });
 | 
			
		||||
              const codeownersContent = Buffer.from(codeownersFile.content, 'base64').toString('utf8');
 | 
			
		||||
 | 
			
		||||
              // Parse CODEOWNERS file to extract all patterns and their owners
 | 
			
		||||
              const codeownersLines = codeownersContent.split('\n')
 | 
			
		||||
                .map(line => line.trim())
 | 
			
		||||
                .filter(line => line && !line.startsWith('#'));
 | 
			
		||||
 | 
			
		||||
              const codeownersPatterns = [];
 | 
			
		||||
 | 
			
		||||
              // Convert CODEOWNERS pattern to regex (robust glob handling)
 | 
			
		||||
              function globToRegex(pattern) {
 | 
			
		||||
                // Escape regex special characters except for glob wildcards
 | 
			
		||||
                let regexStr = pattern
 | 
			
		||||
                  .replace(/([.+^=!:${}()|[\]\\])/g, '\\$1') // escape regex chars
 | 
			
		||||
                  .replace(/\*\*/g, '.*') // globstar
 | 
			
		||||
                  .replace(/\*/g, '[^/]*') // single star
 | 
			
		||||
                  .replace(/\?/g, '.'); // question mark
 | 
			
		||||
                return new RegExp('^' + regexStr + '$');
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Helper function to create comment body
 | 
			
		||||
              function createCommentBody(reviewersList, teamsList, matchedFileCount, isSuccessful = true) {
 | 
			
		||||
                const reviewerMentions = reviewersList.map(r => `@${r}`);
 | 
			
		||||
                const teamMentions = teamsList.map(t => `@${owner}/${t}`);
 | 
			
		||||
                const allMentions = [...reviewerMentions, ...teamMentions].join(', ');
 | 
			
		||||
 | 
			
		||||
                if (isSuccessful) {
 | 
			
		||||
                  return `${BOT_COMMENT_MARKER}\n👋 Hi there! I've automatically requested reviews from codeowners based on the files changed in this PR.\n\n${allMentions} - You've been requested to review this PR as codeowner(s) of ${matchedFileCount} file(s) that were modified. Thanks for your time! 🙏`;
 | 
			
		||||
                } else {
 | 
			
		||||
                  return `${BOT_COMMENT_MARKER}\n👋 Hi there! This PR modifies ${matchedFileCount} file(s) with codeowners.\n\n${allMentions} - As codeowner(s) of the affected files, your review would be appreciated! 🙏\n\n_Note: Automatic review request may have failed, but you're still welcome to review._`;
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              for (const line of codeownersLines) {
 | 
			
		||||
                const parts = line.split(/\s+/);
 | 
			
		||||
                if (parts.length < 2) continue;
 | 
			
		||||
 | 
			
		||||
                const pattern = parts[0];
 | 
			
		||||
                const owners = parts.slice(1);
 | 
			
		||||
 | 
			
		||||
                // Use robust glob-to-regex conversion
 | 
			
		||||
                const regex = globToRegex(pattern);
 | 
			
		||||
                codeownersPatterns.push({ pattern, regex, owners });
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              console.log(`Parsed ${codeownersPatterns.length} codeowner patterns`);
 | 
			
		||||
 | 
			
		||||
              // Match changed files against CODEOWNERS patterns
 | 
			
		||||
              const matchedOwners = new Set();
 | 
			
		||||
              const matchedTeams = new Set();
 | 
			
		||||
              const fileMatches = new Map(); // Track which files matched which patterns
 | 
			
		||||
 | 
			
		||||
              for (const file of changedFiles) {
 | 
			
		||||
                for (const { pattern, regex, owners } of codeownersPatterns) {
 | 
			
		||||
                  if (regex.test(file)) {
 | 
			
		||||
                    console.log(`File '${file}' matches pattern '${pattern}' with owners: ${owners.join(', ')}`);
 | 
			
		||||
 | 
			
		||||
                    if (!fileMatches.has(file)) {
 | 
			
		||||
                      fileMatches.set(file, []);
 | 
			
		||||
                    }
 | 
			
		||||
                    fileMatches.get(file).push({ pattern, owners });
 | 
			
		||||
 | 
			
		||||
                    // Add owners to the appropriate set (remove @ prefix)
 | 
			
		||||
                    for (const owner of owners) {
 | 
			
		||||
                      const cleanOwner = owner.startsWith('@') ? owner.slice(1) : owner;
 | 
			
		||||
                      if (cleanOwner.includes('/')) {
 | 
			
		||||
                        // Team mention (org/team-name)
 | 
			
		||||
                        const teamName = cleanOwner.split('/')[1];
 | 
			
		||||
                        matchedTeams.add(teamName);
 | 
			
		||||
                      } else {
 | 
			
		||||
                        // Individual user
 | 
			
		||||
                        matchedOwners.add(cleanOwner);
 | 
			
		||||
                      }
 | 
			
		||||
                    }
 | 
			
		||||
                  }
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              if (matchedOwners.size === 0 && matchedTeams.size === 0) {
 | 
			
		||||
                console.log('No codeowners found for any changed files');
 | 
			
		||||
                return;
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Remove the PR author from reviewers
 | 
			
		||||
              const prAuthor = context.payload.pull_request.user.login;
 | 
			
		||||
              matchedOwners.delete(prAuthor);
 | 
			
		||||
 | 
			
		||||
              // Get current reviewers to avoid duplicate requests (but still mention them)
 | 
			
		||||
              const { data: prData } = await github.rest.pulls.get({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                pull_number: pr_number
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              const currentReviewers = new Set();
 | 
			
		||||
              const currentTeams = new Set();
 | 
			
		||||
 | 
			
		||||
              if (prData.requested_reviewers) {
 | 
			
		||||
                prData.requested_reviewers.forEach(reviewer => {
 | 
			
		||||
                  currentReviewers.add(reviewer.login);
 | 
			
		||||
                });
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              if (prData.requested_teams) {
 | 
			
		||||
                prData.requested_teams.forEach(team => {
 | 
			
		||||
                  currentTeams.add(team.slug);
 | 
			
		||||
                });
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Check for completed reviews to avoid re-requesting users who have already reviewed
 | 
			
		||||
              const { data: reviews } = await github.rest.pulls.listReviews({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                pull_number: pr_number
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              const reviewedUsers = new Set();
 | 
			
		||||
              reviews.forEach(review => {
 | 
			
		||||
                reviewedUsers.add(review.user.login);
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              // Check for previous comments from this workflow to avoid duplicate pings
 | 
			
		||||
              const comments = await github.paginate(
 | 
			
		||||
                github.rest.issues.listComments,
 | 
			
		||||
                {
 | 
			
		||||
                  owner,
 | 
			
		||||
                  repo,
 | 
			
		||||
                  issue_number: pr_number
 | 
			
		||||
                }
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              const previouslyPingedUsers = new Set();
 | 
			
		||||
              const previouslyPingedTeams = new Set();
 | 
			
		||||
 | 
			
		||||
              // Look for comments from github-actions bot that contain our bot marker
 | 
			
		||||
              const workflowComments = comments.filter(comment =>
 | 
			
		||||
                comment.user.type === 'Bot' &&
 | 
			
		||||
                comment.body.includes(BOT_COMMENT_MARKER)
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              // Extract previously mentioned users and teams from workflow comments
 | 
			
		||||
              for (const comment of workflowComments) {
 | 
			
		||||
                // Match @username patterns (not team mentions)
 | 
			
		||||
                const userMentions = comment.body.match(/@([a-zA-Z0-9_.-]+)(?![/])/g) || [];
 | 
			
		||||
                userMentions.forEach(mention => {
 | 
			
		||||
                  const username = mention.slice(1); // remove @
 | 
			
		||||
                  previouslyPingedUsers.add(username);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                // Match @org/team patterns
 | 
			
		||||
                const teamMentions = comment.body.match(/@[a-zA-Z0-9_.-]+\/([a-zA-Z0-9_.-]+)/g) || [];
 | 
			
		||||
                teamMentions.forEach(mention => {
 | 
			
		||||
                  const teamName = mention.split('/')[1];
 | 
			
		||||
                  previouslyPingedTeams.add(teamName);
 | 
			
		||||
                });
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              console.log(`Found ${previouslyPingedUsers.size} previously pinged users and ${previouslyPingedTeams.size} previously pinged teams`);
 | 
			
		||||
 | 
			
		||||
              // Remove users who have already been pinged in previous workflow comments
 | 
			
		||||
              previouslyPingedUsers.forEach(user => {
 | 
			
		||||
                matchedOwners.delete(user);
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              previouslyPingedTeams.forEach(team => {
 | 
			
		||||
                matchedTeams.delete(team);
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              // Remove only users who have already submitted reviews (not just requested reviewers)
 | 
			
		||||
              reviewedUsers.forEach(reviewer => {
 | 
			
		||||
                matchedOwners.delete(reviewer);
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              // For teams, we'll still remove already requested teams to avoid API errors
 | 
			
		||||
              currentTeams.forEach(team => {
 | 
			
		||||
                matchedTeams.delete(team);
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              const reviewersList = Array.from(matchedOwners);
 | 
			
		||||
              const teamsList = Array.from(matchedTeams);
 | 
			
		||||
 | 
			
		||||
              if (reviewersList.length === 0 && teamsList.length === 0) {
 | 
			
		||||
                console.log('No eligible reviewers found (all may already be requested, reviewed, or previously pinged)');
 | 
			
		||||
                return;
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              const totalReviewers = reviewersList.length + teamsList.length;
 | 
			
		||||
              console.log(`Requesting reviews from ${reviewersList.length} users and ${teamsList.length} teams for ${fileMatches.size} matched files`);
 | 
			
		||||
 | 
			
		||||
              // Request reviews
 | 
			
		||||
              try {
 | 
			
		||||
                const requestParams = {
 | 
			
		||||
                  owner,
 | 
			
		||||
                  repo,
 | 
			
		||||
                  pull_number: pr_number
 | 
			
		||||
                };
 | 
			
		||||
 | 
			
		||||
                // Filter out users who are already requested reviewers for the API call
 | 
			
		||||
                const newReviewers = reviewersList.filter(reviewer => !currentReviewers.has(reviewer));
 | 
			
		||||
                const newTeams = teamsList.filter(team => !currentTeams.has(team));
 | 
			
		||||
 | 
			
		||||
                if (newReviewers.length > 0) {
 | 
			
		||||
                  requestParams.reviewers = newReviewers;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                if (newTeams.length > 0) {
 | 
			
		||||
                  requestParams.team_reviewers = newTeams;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                // Only make the API call if there are new reviewers to request
 | 
			
		||||
                if (newReviewers.length > 0 || newTeams.length > 0) {
 | 
			
		||||
                  await github.rest.pulls.requestReviewers(requestParams);
 | 
			
		||||
                  console.log(`Successfully requested reviews from ${newReviewers.length} new users and ${newTeams.length} new teams`);
 | 
			
		||||
                } else {
 | 
			
		||||
                  console.log('All codeowners are already requested reviewers or have reviewed');
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                // Only add a comment if there are new codeowners to mention (not previously pinged)
 | 
			
		||||
                if (reviewersList.length > 0 || teamsList.length > 0) {
 | 
			
		||||
                  const commentBody = createCommentBody(reviewersList, teamsList, fileMatches.size, true);
 | 
			
		||||
 | 
			
		||||
                  await github.rest.issues.createComment({
 | 
			
		||||
                    owner,
 | 
			
		||||
                    repo,
 | 
			
		||||
                    issue_number: pr_number,
 | 
			
		||||
                    body: commentBody
 | 
			
		||||
                  });
 | 
			
		||||
                  console.log(`Added comment mentioning ${reviewersList.length} users and ${teamsList.length} teams`);
 | 
			
		||||
                } else {
 | 
			
		||||
                  console.log('No new codeowners to mention in comment (all previously pinged)');
 | 
			
		||||
                }
 | 
			
		||||
              } catch (error) {
 | 
			
		||||
                if (error.status === 422) {
 | 
			
		||||
                  console.log('Some reviewers may already be requested or unavailable:', error.message);
 | 
			
		||||
 | 
			
		||||
                  // Only try to add a comment if there are new codeowners to mention
 | 
			
		||||
                  if (reviewersList.length > 0 || teamsList.length > 0) {
 | 
			
		||||
                    const commentBody = createCommentBody(reviewersList, teamsList, fileMatches.size, false);
 | 
			
		||||
 | 
			
		||||
                    try {
 | 
			
		||||
                      await github.rest.issues.createComment({
 | 
			
		||||
                        owner,
 | 
			
		||||
                        repo,
 | 
			
		||||
                        issue_number: pr_number,
 | 
			
		||||
                        body: commentBody
 | 
			
		||||
                      });
 | 
			
		||||
                      console.log(`Added fallback comment mentioning ${reviewersList.length} users and ${teamsList.length} teams`);
 | 
			
		||||
                    } catch (commentError) {
 | 
			
		||||
                      console.log('Failed to add comment:', commentError.message);
 | 
			
		||||
                    }
 | 
			
		||||
                  } else {
 | 
			
		||||
                    console.log('No new codeowners to mention in fallback comment');
 | 
			
		||||
                  }
 | 
			
		||||
                } else {
 | 
			
		||||
                  throw error;
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
            } catch (error) {
 | 
			
		||||
              console.log('Failed to process codeowner review requests:', error.message);
 | 
			
		||||
              console.error(error);
 | 
			
		||||
            }
 | 
			
		||||
							
								
								
									
										157
									
								
								.github/workflows/external-component-bot.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										157
									
								
								.github/workflows/external-component-bot.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,157 @@
 | 
			
		||||
name: Add External Component Comment
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [opened, synchronize]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read       #  Needed to fetch PR details
 | 
			
		||||
  issues: write        #  Needed to create and update comments (PR comments are managed via the issues REST API)
 | 
			
		||||
  pull-requests: write  # also needed?
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  external-comment:
 | 
			
		||||
    name: External component comment
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Add external component comment
 | 
			
		||||
        uses: actions/github-script@v7.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          github-token: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
          script: |
 | 
			
		||||
            // Generate external component usage instructions
 | 
			
		||||
            function generateExternalComponentInstructions(prNumber, componentNames, owner, repo) {
 | 
			
		||||
                let source;
 | 
			
		||||
                if (owner === 'esphome' && repo === 'esphome')
 | 
			
		||||
                    source = `github://pr#${prNumber}`;
 | 
			
		||||
                else
 | 
			
		||||
                    source = `github://${owner}/${repo}@pull/${prNumber}/head`;
 | 
			
		||||
                return `To use the changes from this PR as an external component, add the following to your ESPHome configuration YAML file:
 | 
			
		||||
 | 
			
		||||
            \`\`\`yaml
 | 
			
		||||
            external_components:
 | 
			
		||||
              - source: ${source}
 | 
			
		||||
                components: [${componentNames.join(', ')}]
 | 
			
		||||
                refresh: 1h
 | 
			
		||||
            \`\`\``;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Generate repo clone instructions
 | 
			
		||||
            function generateRepoInstructions(prNumber, owner, repo, branch) {
 | 
			
		||||
                return `To use the changes in this PR:
 | 
			
		||||
 | 
			
		||||
            \`\`\`bash
 | 
			
		||||
            # Clone the repository:
 | 
			
		||||
            git clone https://github.com/${owner}/${repo}
 | 
			
		||||
            cd ${repo}
 | 
			
		||||
 | 
			
		||||
            # Checkout the PR branch:
 | 
			
		||||
            git fetch origin pull/${prNumber}/head:${branch}
 | 
			
		||||
            git checkout ${branch}
 | 
			
		||||
 | 
			
		||||
            # Install the development version:
 | 
			
		||||
            script/setup
 | 
			
		||||
 | 
			
		||||
            # Activate the development version:
 | 
			
		||||
            source venv/bin/activate
 | 
			
		||||
            \`\`\`
 | 
			
		||||
 | 
			
		||||
            Now you can run \`esphome\` as usual to test the changes in this PR.
 | 
			
		||||
            `;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            async function createComment(octokit, owner, repo, prNumber, esphomeChanges, componentChanges) {
 | 
			
		||||
                const commentMarker = "<!-- This comment was generated automatically by the external-component-bot workflow. -->";
 | 
			
		||||
                const legacyCommentMarker = "<!-- This comment was generated automatically by a GitHub workflow. -->";
 | 
			
		||||
                let commentBody;
 | 
			
		||||
                if (esphomeChanges.length === 1) {
 | 
			
		||||
                    commentBody = generateExternalComponentInstructions(prNumber, componentChanges, owner, repo);
 | 
			
		||||
                } else {
 | 
			
		||||
                    commentBody = generateRepoInstructions(prNumber, owner, repo, context.payload.pull_request.head.ref);
 | 
			
		||||
                }
 | 
			
		||||
                commentBody += `\n\n---\n(Added by the PR bot)\n\n${commentMarker}`;
 | 
			
		||||
 | 
			
		||||
                // Check for existing bot comment
 | 
			
		||||
                const comments = await github.paginate(
 | 
			
		||||
                    github.rest.issues.listComments,
 | 
			
		||||
                    {
 | 
			
		||||
                        owner: owner,
 | 
			
		||||
                        repo: repo,
 | 
			
		||||
                        issue_number: prNumber,
 | 
			
		||||
                        per_page: 100,
 | 
			
		||||
                    }
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                const sorted = comments.sort((a, b) => new Date(b.updated_at) - new Date(a.updated_at));
 | 
			
		||||
 | 
			
		||||
                const botComment = sorted.find(comment =>
 | 
			
		||||
                    (
 | 
			
		||||
                      comment.body.includes(commentMarker) ||
 | 
			
		||||
                      comment.body.includes(legacyCommentMarker)
 | 
			
		||||
                    ) && comment.user.type === "Bot"
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                if (botComment && botComment.body === commentBody) {
 | 
			
		||||
                    // No changes in the comment, do nothing
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                if (botComment) {
 | 
			
		||||
                    // Update existing comment
 | 
			
		||||
                    await github.rest.issues.updateComment({
 | 
			
		||||
                        owner: owner,
 | 
			
		||||
                        repo: repo,
 | 
			
		||||
                        comment_id: botComment.id,
 | 
			
		||||
                        body: commentBody,
 | 
			
		||||
                    });
 | 
			
		||||
                } else {
 | 
			
		||||
                    // Create new comment
 | 
			
		||||
                    await github.rest.issues.createComment({
 | 
			
		||||
                        owner: owner,
 | 
			
		||||
                        repo: repo,
 | 
			
		||||
                        issue_number: prNumber,
 | 
			
		||||
                        body: commentBody,
 | 
			
		||||
                    });
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            async function getEsphomeAndComponentChanges(github, owner, repo, prNumber) {
 | 
			
		||||
                const changedFiles = await github.rest.pulls.listFiles({
 | 
			
		||||
                    owner: owner,
 | 
			
		||||
                    repo: repo,
 | 
			
		||||
                    pull_number: prNumber,
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                const esphomeChanges = changedFiles.data
 | 
			
		||||
                    .filter(file => file.filename !== "esphome/core/defines.h" && file.filename.startsWith('esphome/'))
 | 
			
		||||
                    .map(file => {
 | 
			
		||||
                        const match = file.filename.match(/esphome\/([^/]+)/);
 | 
			
		||||
                        return match ? match[1] : null;
 | 
			
		||||
                    })
 | 
			
		||||
                    .filter(it => it !== null);
 | 
			
		||||
 | 
			
		||||
                if (esphomeChanges.length === 0) {
 | 
			
		||||
                    return {esphomeChanges: [], componentChanges: []};
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                const uniqueEsphomeChanges = [...new Set(esphomeChanges)];
 | 
			
		||||
                const componentChanges = changedFiles.data
 | 
			
		||||
                    .filter(file => file.filename.startsWith('esphome/components/'))
 | 
			
		||||
                    .map(file => {
 | 
			
		||||
                        const match = file.filename.match(/esphome\/components\/([^/]+)\//);
 | 
			
		||||
                        return match ? match[1] : null;
 | 
			
		||||
                    })
 | 
			
		||||
                    .filter(it => it !== null);
 | 
			
		||||
 | 
			
		||||
                return {esphomeChanges: uniqueEsphomeChanges, componentChanges: [...new Set(componentChanges)]};
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Start of main code.
 | 
			
		||||
 | 
			
		||||
            const prNumber = context.payload.pull_request.number;
 | 
			
		||||
            const {owner, repo} = context.repo;
 | 
			
		||||
 | 
			
		||||
            const {esphomeChanges, componentChanges} = await getEsphomeAndComponentChanges(github, owner, repo, prNumber);
 | 
			
		||||
            if (componentChanges.length !== 0) {
 | 
			
		||||
                await createComment(github, owner, repo, prNumber, esphomeChanges, componentChanges);
 | 
			
		||||
            }
 | 
			
		||||
							
								
								
									
										163
									
								
								.github/workflows/issue-codeowner-notify.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										163
									
								
								.github/workflows/issue-codeowner-notify.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,163 @@
 | 
			
		||||
# This workflow automatically notifies codeowners when an issue is labeled with component labels.
 | 
			
		||||
# It reads the CODEOWNERS file to find the maintainers for the labeled components
 | 
			
		||||
# and posts a comment mentioning them to ensure they're aware of the issue.
 | 
			
		||||
 | 
			
		||||
name: Notify Issue Codeowners
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  issues:
 | 
			
		||||
    types: [labeled]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  issues: write
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  notify-codeowners:
 | 
			
		||||
    name: Run
 | 
			
		||||
    if: ${{ startsWith(github.event.label.name, format('component{0} ', ':')) }}
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Notify codeowners for component issues
 | 
			
		||||
        uses: actions/github-script@v7.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          script: |
 | 
			
		||||
            const owner = context.repo.owner;
 | 
			
		||||
            const repo = context.repo.repo;
 | 
			
		||||
            const issue_number = context.payload.issue.number;
 | 
			
		||||
            const labelName = context.payload.label.name;
 | 
			
		||||
 | 
			
		||||
            console.log(`Processing issue #${issue_number} with label: ${labelName}`);
 | 
			
		||||
 | 
			
		||||
            // Hidden marker to identify bot comments from this workflow
 | 
			
		||||
            const BOT_COMMENT_MARKER = '<!-- issue-codeowner-notify-bot -->';
 | 
			
		||||
 | 
			
		||||
            // Extract component name from label
 | 
			
		||||
            const componentName = labelName.replace('component: ', '');
 | 
			
		||||
            console.log(`Component: ${componentName}`);
 | 
			
		||||
 | 
			
		||||
            try {
 | 
			
		||||
              // Fetch CODEOWNERS file from root
 | 
			
		||||
              const { data: codeownersFile } = await github.rest.repos.getContent({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                path: 'CODEOWNERS'
 | 
			
		||||
              });
 | 
			
		||||
              const codeownersContent = Buffer.from(codeownersFile.content, 'base64').toString('utf8');
 | 
			
		||||
 | 
			
		||||
              // Parse CODEOWNERS file to extract component mappings
 | 
			
		||||
              const codeownersLines = codeownersContent.split('\n')
 | 
			
		||||
                .map(line => line.trim())
 | 
			
		||||
                .filter(line => line && !line.startsWith('#'));
 | 
			
		||||
 | 
			
		||||
              let componentOwners = null;
 | 
			
		||||
 | 
			
		||||
              for (const line of codeownersLines) {
 | 
			
		||||
                const parts = line.split(/\s+/);
 | 
			
		||||
                if (parts.length < 2) continue;
 | 
			
		||||
 | 
			
		||||
                const pattern = parts[0];
 | 
			
		||||
                const owners = parts.slice(1);
 | 
			
		||||
 | 
			
		||||
                // Look for component patterns: esphome/components/{component}/*
 | 
			
		||||
                const componentMatch = pattern.match(/^esphome\/components\/([^\/]+)\/\*$/);
 | 
			
		||||
                if (componentMatch && componentMatch[1] === componentName) {
 | 
			
		||||
                  componentOwners = owners;
 | 
			
		||||
                  break;
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              if (!componentOwners) {
 | 
			
		||||
                console.log(`No codeowners found for component: ${componentName}`);
 | 
			
		||||
                return;
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              console.log(`Found codeowners for '${componentName}': ${componentOwners.join(', ')}`);
 | 
			
		||||
 | 
			
		||||
              // Separate users and teams
 | 
			
		||||
              const userOwners = [];
 | 
			
		||||
              const teamOwners = [];
 | 
			
		||||
 | 
			
		||||
              for (const owner of componentOwners) {
 | 
			
		||||
                const cleanOwner = owner.startsWith('@') ? owner.slice(1) : owner;
 | 
			
		||||
                if (cleanOwner.includes('/')) {
 | 
			
		||||
                  // Team mention (org/team-name)
 | 
			
		||||
                  teamOwners.push(`@${cleanOwner}`);
 | 
			
		||||
                } else {
 | 
			
		||||
                  // Individual user
 | 
			
		||||
                  userOwners.push(`@${cleanOwner}`);
 | 
			
		||||
                }
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Remove issue author from mentions to avoid self-notification
 | 
			
		||||
              const issueAuthor = context.payload.issue.user.login;
 | 
			
		||||
              const filteredUserOwners = userOwners.filter(mention =>
 | 
			
		||||
                mention !== `@${issueAuthor}`
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              // Check for previous comments from this workflow to avoid duplicate pings
 | 
			
		||||
              const comments = await github.paginate(
 | 
			
		||||
                github.rest.issues.listComments,
 | 
			
		||||
                {
 | 
			
		||||
                  owner,
 | 
			
		||||
                  repo,
 | 
			
		||||
                  issue_number: issue_number
 | 
			
		||||
                }
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              const previouslyPingedUsers = new Set();
 | 
			
		||||
              const previouslyPingedTeams = new Set();
 | 
			
		||||
 | 
			
		||||
              // Look for comments from github-actions bot that contain codeowner pings for this component
 | 
			
		||||
              const workflowComments = comments.filter(comment =>
 | 
			
		||||
                comment.user.type === 'Bot' &&
 | 
			
		||||
                comment.body.includes(BOT_COMMENT_MARKER) &&
 | 
			
		||||
                comment.body.includes(`component: ${componentName}`)
 | 
			
		||||
              );
 | 
			
		||||
 | 
			
		||||
              // Extract previously mentioned users and teams from workflow comments
 | 
			
		||||
              for (const comment of workflowComments) {
 | 
			
		||||
                // Match @username patterns (not team mentions)
 | 
			
		||||
                const userMentions = comment.body.match(/@([a-zA-Z0-9_.-]+)(?![/])/g) || [];
 | 
			
		||||
                userMentions.forEach(mention => {
 | 
			
		||||
                  previouslyPingedUsers.add(mention); // Keep @ prefix for easy comparison
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                // Match @org/team patterns
 | 
			
		||||
                const teamMentions = comment.body.match(/@[a-zA-Z0-9_.-]+\/[a-zA-Z0-9_.-]+/g) || [];
 | 
			
		||||
                teamMentions.forEach(mention => {
 | 
			
		||||
                  previouslyPingedTeams.add(mention);
 | 
			
		||||
                });
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              console.log(`Found ${previouslyPingedUsers.size} previously pinged users and ${previouslyPingedTeams.size} previously pinged teams for component ${componentName}`);
 | 
			
		||||
 | 
			
		||||
              // Remove previously pinged users and teams
 | 
			
		||||
              const newUserOwners = filteredUserOwners.filter(mention => !previouslyPingedUsers.has(mention));
 | 
			
		||||
              const newTeamOwners = teamOwners.filter(mention => !previouslyPingedTeams.has(mention));
 | 
			
		||||
 | 
			
		||||
              const allMentions = [...newUserOwners, ...newTeamOwners];
 | 
			
		||||
 | 
			
		||||
              if (allMentions.length === 0) {
 | 
			
		||||
                console.log('No new codeowners to notify (all previously pinged or issue author is the only codeowner)');
 | 
			
		||||
                return;
 | 
			
		||||
              }
 | 
			
		||||
 | 
			
		||||
              // Create comment body
 | 
			
		||||
              const mentionString = allMentions.join(', ');
 | 
			
		||||
              const commentBody = `${BOT_COMMENT_MARKER}\n👋 Hey ${mentionString}!\n\nThis issue has been labeled with \`component: ${componentName}\` and you've been identified as a codeowner of this component. Please take a look when you have a chance!\n\nThanks for maintaining this component! 🙏`;
 | 
			
		||||
 | 
			
		||||
              // Post comment
 | 
			
		||||
              await github.rest.issues.createComment({
 | 
			
		||||
                owner,
 | 
			
		||||
                repo,
 | 
			
		||||
                issue_number: issue_number,
 | 
			
		||||
                body: commentBody
 | 
			
		||||
              });
 | 
			
		||||
 | 
			
		||||
              console.log(`Successfully notified new codeowners: ${mentionString}`);
 | 
			
		||||
 | 
			
		||||
            } catch (error) {
 | 
			
		||||
              console.log('Failed to process codeowner notifications:', error.message);
 | 
			
		||||
              console.error(error);
 | 
			
		||||
            }
 | 
			
		||||
							
								
								
									
										23
									
								
								.github/workflows/lock.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										23
									
								
								.github/workflows/lock.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,28 +1,11 @@
 | 
			
		||||
---
 | 
			
		||||
name: Lock
 | 
			
		||||
name: Lock closed issues and PRs
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  schedule:
 | 
			
		||||
    - cron: "30 0 * * *"
 | 
			
		||||
    - cron: "30 0 * * *"  # Run daily at 00:30 UTC
 | 
			
		||||
  workflow_dispatch:
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  issues: write
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
 | 
			
		||||
concurrency:
 | 
			
		||||
  group: lock
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  lock:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: dessant/lock-threads@v5.0.1
 | 
			
		||||
        with:
 | 
			
		||||
          pr-inactive-days: "1"
 | 
			
		||||
          pr-lock-reason: ""
 | 
			
		||||
          exclude-any-pr-labels: keep-open
 | 
			
		||||
 | 
			
		||||
          issue-inactive-days: "7"
 | 
			
		||||
          issue-lock-reason: ""
 | 
			
		||||
          exclude-any-issue-labels: keep-open
 | 
			
		||||
    uses: esphome/workflows/.github/workflows/lock.yml@main
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										6
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							@@ -96,10 +96,10 @@ jobs:
 | 
			
		||||
      - name: Set up Python
 | 
			
		||||
        uses: actions/setup-python@v5.6.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.10"
 | 
			
		||||
          python-version: "3.11"
 | 
			
		||||
 | 
			
		||||
      - name: Set up Docker Buildx
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.10.0
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.11.1
 | 
			
		||||
 | 
			
		||||
      - name: Log in to docker hub
 | 
			
		||||
        uses: docker/login-action@v3.4.0
 | 
			
		||||
@@ -178,7 +178,7 @@ jobs:
 | 
			
		||||
          merge-multiple: true
 | 
			
		||||
 | 
			
		||||
      - name: Set up Docker Buildx
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.10.0
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.11.1
 | 
			
		||||
 | 
			
		||||
      - name: Log in to docker hub
 | 
			
		||||
        if: matrix.registry == 'dockerhub'
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										25
									
								
								.github/workflows/yaml-lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										25
									
								
								.github/workflows/yaml-lint.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,25 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
name: YAML lint
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [dev, beta, release]
 | 
			
		||||
    paths:
 | 
			
		||||
      - "**.yaml"
 | 
			
		||||
      - "**.yml"
 | 
			
		||||
  pull_request:
 | 
			
		||||
    paths:
 | 
			
		||||
      - "**.yaml"
 | 
			
		||||
      - "**.yml"
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  yamllint:
 | 
			
		||||
    name: yamllint
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.2.2
 | 
			
		||||
      - name: Run yamllint
 | 
			
		||||
        uses: frenck/action-yamllint@v1.5.0
 | 
			
		||||
        with:
 | 
			
		||||
          strict: true
 | 
			
		||||
@@ -1,10 +1,17 @@
 | 
			
		||||
---
 | 
			
		||||
# See https://pre-commit.com for more information
 | 
			
		||||
# See https://pre-commit.com/hooks.html for more hooks
 | 
			
		||||
 | 
			
		||||
ci:
 | 
			
		||||
  autoupdate_commit_msg: 'pre-commit: autoupdate'
 | 
			
		||||
  autoupdate_schedule: off  # Disabled until ruff versions are synced between deps and pre-commit
 | 
			
		||||
  # Skip hooks that have issues in pre-commit CI environment
 | 
			
		||||
  skip: [pylint, clang-tidy-hash]
 | 
			
		||||
 | 
			
		||||
repos:
 | 
			
		||||
  - repo: https://github.com/astral-sh/ruff-pre-commit
 | 
			
		||||
    # Ruff version.
 | 
			
		||||
    rev: v0.11.10
 | 
			
		||||
    rev: v0.12.5
 | 
			
		||||
    hooks:
 | 
			
		||||
      # Run the linter.
 | 
			
		||||
      - id: ruff
 | 
			
		||||
@@ -12,7 +19,7 @@ repos:
 | 
			
		||||
      # Run the formatter.
 | 
			
		||||
      - id: ruff-format
 | 
			
		||||
  - repo: https://github.com/PyCQA/flake8
 | 
			
		||||
    rev: 7.2.0
 | 
			
		||||
    rev: 7.3.0
 | 
			
		||||
    hooks:
 | 
			
		||||
      - id: flake8
 | 
			
		||||
        additional_dependencies:
 | 
			
		||||
@@ -20,22 +27,25 @@ repos:
 | 
			
		||||
          - pydocstyle==5.1.1
 | 
			
		||||
        files: ^(esphome|tests)/.+\.py$
 | 
			
		||||
  - repo: https://github.com/pre-commit/pre-commit-hooks
 | 
			
		||||
    rev: v3.4.0
 | 
			
		||||
    rev: v5.0.0
 | 
			
		||||
    hooks:
 | 
			
		||||
      - id: no-commit-to-branch
 | 
			
		||||
        args:
 | 
			
		||||
          - --branch=dev
 | 
			
		||||
          - --branch=release
 | 
			
		||||
          - --branch=beta
 | 
			
		||||
      - id: end-of-file-fixer
 | 
			
		||||
      - id: trailing-whitespace
 | 
			
		||||
  - repo: https://github.com/asottile/pyupgrade
 | 
			
		||||
    rev: v3.20.0
 | 
			
		||||
    hooks:
 | 
			
		||||
      - id: pyupgrade
 | 
			
		||||
        args: [--py310-plus]
 | 
			
		||||
        args: [--py311-plus]
 | 
			
		||||
  - repo: https://github.com/adrienverge/yamllint.git
 | 
			
		||||
    rev: v1.37.1
 | 
			
		||||
    hooks:
 | 
			
		||||
      - id: yamllint
 | 
			
		||||
        exclude: ^(\.clang-format|\.clang-tidy)$
 | 
			
		||||
  - repo: https://github.com/pre-commit/mirrors-clang-format
 | 
			
		||||
    rev: v13.0.1
 | 
			
		||||
    hooks:
 | 
			
		||||
@@ -48,3 +58,10 @@ repos:
 | 
			
		||||
        entry: python3 script/run-in-env.py pylint
 | 
			
		||||
        language: system
 | 
			
		||||
        types: [python]
 | 
			
		||||
      - id: clang-tidy-hash
 | 
			
		||||
        name: Update clang-tidy hash
 | 
			
		||||
        entry: python script/clang_tidy_hash.py --update-if-changed
 | 
			
		||||
        language: python
 | 
			
		||||
        files: ^(\.clang-tidy|platformio\.ini|requirements_dev\.txt)$
 | 
			
		||||
        pass_filenames: false
 | 
			
		||||
        additional_dependencies: []
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										20
									
								
								CODEOWNERS
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								CODEOWNERS
									
									
									
									
									
								
							@@ -9,6 +9,7 @@
 | 
			
		||||
pyproject.toml @esphome/core
 | 
			
		||||
esphome/*.py @esphome/core
 | 
			
		||||
esphome/core/* @esphome/core
 | 
			
		||||
.github/** @esphome/core
 | 
			
		||||
 | 
			
		||||
# Integrations
 | 
			
		||||
esphome/components/a01nyub/* @MrSuicideParrot
 | 
			
		||||
@@ -28,7 +29,7 @@ esphome/components/aic3204/* @kbx81
 | 
			
		||||
esphome/components/airthings_ble/* @jeromelaban
 | 
			
		||||
esphome/components/airthings_wave_base/* @jeromelaban @kpfleming @ncareau
 | 
			
		||||
esphome/components/airthings_wave_mini/* @ncareau
 | 
			
		||||
esphome/components/airthings_wave_plus/* @jeromelaban
 | 
			
		||||
esphome/components/airthings_wave_plus/* @jeromelaban @precurse
 | 
			
		||||
esphome/components/alarm_control_panel/* @grahambrown11 @hwstar
 | 
			
		||||
esphome/components/alpha3/* @jan-hofmeier
 | 
			
		||||
esphome/components/am2315c/* @swoboda1337
 | 
			
		||||
@@ -87,6 +88,7 @@ esphome/components/bp1658cj/* @Cossid
 | 
			
		||||
esphome/components/bp5758d/* @Cossid
 | 
			
		||||
esphome/components/button/* @esphome/core
 | 
			
		||||
esphome/components/bytebuffer/* @clydebarrow
 | 
			
		||||
esphome/components/camera/* @DT-art1 @bdraco
 | 
			
		||||
esphome/components/canbus/* @danielschramm @mvturnho
 | 
			
		||||
esphome/components/cap1188/* @mreditor97
 | 
			
		||||
esphome/components/captive_portal/* @OttoWinter
 | 
			
		||||
@@ -124,6 +126,7 @@ esphome/components/dht/* @OttoWinter
 | 
			
		||||
esphome/components/display_menu_base/* @numo68
 | 
			
		||||
esphome/components/dps310/* @kbx81
 | 
			
		||||
esphome/components/ds1307/* @badbadc0ffee
 | 
			
		||||
esphome/components/ds2484/* @mrk-its
 | 
			
		||||
esphome/components/dsmr/* @glmnet @zuidwijk
 | 
			
		||||
esphome/components/duty_time/* @dudanov
 | 
			
		||||
esphome/components/ee895/* @Stock-M
 | 
			
		||||
@@ -146,6 +149,7 @@ esphome/components/esp32_ble_client/* @jesserockz
 | 
			
		||||
esphome/components/esp32_ble_server/* @Rapsssito @clydebarrow @jesserockz
 | 
			
		||||
esphome/components/esp32_camera_web_server/* @ayufan
 | 
			
		||||
esphome/components/esp32_can/* @Sympatron
 | 
			
		||||
esphome/components/esp32_hosted/* @swoboda1337
 | 
			
		||||
esphome/components/esp32_improv/* @jesserockz
 | 
			
		||||
esphome/components/esp32_rmt/* @jesserockz
 | 
			
		||||
esphome/components/esp32_rmt_led_strip/* @jesserockz
 | 
			
		||||
@@ -167,6 +171,7 @@ esphome/components/ft5x06/* @clydebarrow
 | 
			
		||||
esphome/components/ft63x6/* @gpambrozio
 | 
			
		||||
esphome/components/gcja5/* @gcormier
 | 
			
		||||
esphome/components/gdk101/* @Szewcson
 | 
			
		||||
esphome/components/gl_r01_i2c/* @pkejval
 | 
			
		||||
esphome/components/globals/* @esphome/core
 | 
			
		||||
esphome/components/gp2y1010au0f/* @zry98
 | 
			
		||||
esphome/components/gp8403/* @jesserockz
 | 
			
		||||
@@ -241,15 +246,18 @@ esphome/components/lcd_menu/* @numo68
 | 
			
		||||
esphome/components/ld2410/* @regevbr @sebcaps
 | 
			
		||||
esphome/components/ld2420/* @descipher
 | 
			
		||||
esphome/components/ld2450/* @hareeshmu
 | 
			
		||||
esphome/components/ld24xx/* @kbx81
 | 
			
		||||
esphome/components/ledc/* @OttoWinter
 | 
			
		||||
esphome/components/libretiny/* @kuba2k2
 | 
			
		||||
esphome/components/libretiny_pwm/* @kuba2k2
 | 
			
		||||
esphome/components/light/* @esphome/core
 | 
			
		||||
esphome/components/lightwaverf/* @max246
 | 
			
		||||
esphome/components/lilygo_t5_47/touchscreen/* @jesserockz
 | 
			
		||||
esphome/components/ln882x/* @lamauny
 | 
			
		||||
esphome/components/lock/* @esphome/core
 | 
			
		||||
esphome/components/logger/* @esphome/core
 | 
			
		||||
esphome/components/logger/select/* @clydebarrow
 | 
			
		||||
esphome/components/lps22/* @nagisa
 | 
			
		||||
esphome/components/ltr390/* @latonita @sjtrny
 | 
			
		||||
esphome/components/ltr501/* @latonita
 | 
			
		||||
esphome/components/ltr_als_ps/* @latonita
 | 
			
		||||
@@ -286,6 +294,7 @@ esphome/components/microphone/* @jesserockz @kahrendt
 | 
			
		||||
esphome/components/mics_4514/* @jesserockz
 | 
			
		||||
esphome/components/midea/* @dudanov
 | 
			
		||||
esphome/components/midea_ir/* @dudanov
 | 
			
		||||
esphome/components/mipi_dsi/* @clydebarrow
 | 
			
		||||
esphome/components/mipi_spi/* @clydebarrow
 | 
			
		||||
esphome/components/mitsubishi/* @RubyBailey
 | 
			
		||||
esphome/components/mixer/speaker/* @kahrendt
 | 
			
		||||
@@ -318,11 +327,13 @@ esphome/components/nextion/text_sensor/* @senexcrenshaw
 | 
			
		||||
esphome/components/nfc/* @jesserockz @kbx81
 | 
			
		||||
esphome/components/noblex/* @AGalfra
 | 
			
		||||
esphome/components/npi19/* @bakerkj
 | 
			
		||||
esphome/components/nrf52/* @tomaszduda23
 | 
			
		||||
esphome/components/number/* @esphome/core
 | 
			
		||||
esphome/components/one_wire/* @ssieb
 | 
			
		||||
esphome/components/online_image/* @clydebarrow @guillempages
 | 
			
		||||
esphome/components/opentherm/* @olegtarasov
 | 
			
		||||
esphome/components/openthread/* @mrene
 | 
			
		||||
esphome/components/opt3001/* @ccutrer
 | 
			
		||||
esphome/components/ota/* @esphome/core
 | 
			
		||||
esphome/components/output/* @esphome/core
 | 
			
		||||
esphome/components/packet_transport/* @clydebarrow
 | 
			
		||||
@@ -330,6 +341,7 @@ esphome/components/pca6416a/* @Mat931
 | 
			
		||||
esphome/components/pca9554/* @clydebarrow @hwstar
 | 
			
		||||
esphome/components/pcf85063/* @brogon
 | 
			
		||||
esphome/components/pcf8563/* @KoenBreeman
 | 
			
		||||
esphome/components/pi4ioe5v6408/* @jesserockz
 | 
			
		||||
esphome/components/pid/* @OttoWinter
 | 
			
		||||
esphome/components/pipsolar/* @andreashergert1984
 | 
			
		||||
esphome/components/pm1006/* @habbie
 | 
			
		||||
@@ -370,6 +382,7 @@ esphome/components/rp2040_pwm/* @jesserockz
 | 
			
		||||
esphome/components/rpi_dpi_rgb/* @clydebarrow
 | 
			
		||||
esphome/components/rtl87xx/* @kuba2k2
 | 
			
		||||
esphome/components/rtttl/* @glmnet
 | 
			
		||||
esphome/components/runtime_stats/* @bdraco
 | 
			
		||||
esphome/components/safe_mode/* @jsuanet @kbx81 @paulmonigatti
 | 
			
		||||
esphome/components/scd4x/* @martgras @sjtrny
 | 
			
		||||
esphome/components/script/* @esphome/core
 | 
			
		||||
@@ -436,6 +449,8 @@ esphome/components/sun/* @OttoWinter
 | 
			
		||||
esphome/components/sun_gtil2/* @Mat931
 | 
			
		||||
esphome/components/switch/* @esphome/core
 | 
			
		||||
esphome/components/switch/binary_sensor/* @ssieb
 | 
			
		||||
esphome/components/sx126x/* @swoboda1337
 | 
			
		||||
esphome/components/sx127x/* @swoboda1337
 | 
			
		||||
esphome/components/syslog/* @clydebarrow
 | 
			
		||||
esphome/components/t6615/* @tylermenezes
 | 
			
		||||
esphome/components/tc74/* @sethgirvan
 | 
			
		||||
@@ -494,6 +509,7 @@ esphome/components/voice_assistant/* @jesserockz @kahrendt
 | 
			
		||||
esphome/components/wake_on_lan/* @clydebarrow @willwill2will54
 | 
			
		||||
esphome/components/watchdog/* @oarcher
 | 
			
		||||
esphome/components/waveshare_epaper/* @clydebarrow
 | 
			
		||||
esphome/components/web_server/ota/* @esphome/core
 | 
			
		||||
esphome/components/web_server_base/* @OttoWinter
 | 
			
		||||
esphome/components/web_server_idf/* @dentra
 | 
			
		||||
esphome/components/weikai/* @DrCoolZic
 | 
			
		||||
@@ -520,8 +536,10 @@ esphome/components/xiaomi_lywsd03mmc/* @ahpohl
 | 
			
		||||
esphome/components/xiaomi_mhoc303/* @drug123
 | 
			
		||||
esphome/components/xiaomi_mhoc401/* @vevsvevs
 | 
			
		||||
esphome/components/xiaomi_rtcgq02lm/* @jesserockz
 | 
			
		||||
esphome/components/xiaomi_xmwsdj04mmc/* @medusalix
 | 
			
		||||
esphome/components/xl9535/* @mreditor97
 | 
			
		||||
esphome/components/xpt2046/touchscreen/* @nielsnl68 @numo68
 | 
			
		||||
esphome/components/xxtea/* @clydebarrow
 | 
			
		||||
esphome/components/zephyr/* @tomaszduda23
 | 
			
		||||
esphome/components/zhlt01/* @cfeenstra1024
 | 
			
		||||
esphome/components/zio_ultrasonic/* @kahrendt
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@ project and be sure to join us on [Discord](https://discord.gg/KhAMKrd).
 | 
			
		||||
 | 
			
		||||
**See also:**
 | 
			
		||||
 | 
			
		||||
[Documentation](https://esphome.io) -- [Issues](https://github.com/esphome/issues/issues) -- [Feature requests](https://github.com/esphome/feature-requests/issues)
 | 
			
		||||
[Documentation](https://esphome.io) -- [Issues](https://github.com/esphome/esphome/issues) -- [Feature requests](https://github.com/orgs/esphome/discussions)
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								Doxyfile
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								Doxyfile
									
									
									
									
									
								
							@@ -48,7 +48,7 @@ PROJECT_NAME           = ESPHome
 | 
			
		||||
# could be handy for archiving the generated documentation or if some version
 | 
			
		||||
# control system is used.
 | 
			
		||||
 | 
			
		||||
PROJECT_NUMBER         = 2025.6.3
 | 
			
		||||
PROJECT_NUMBER         = 2025.8.0-dev
 | 
			
		||||
 | 
			
		||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
 | 
			
		||||
# for a project that appears at the top of each page and should give viewer a
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
[Documentation](https://esphome.io) -- [Issues](https://github.com/esphome/issues/issues) -- [Feature requests](https://github.com/esphome/feature-requests/issues)
 | 
			
		||||
[Documentation](https://esphome.io) -- [Issues](https://github.com/esphome/esphome/issues) -- [Feature requests](https://github.com/orgs/esphome/discussions)
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -2,6 +2,7 @@
 | 
			
		||||
import argparse
 | 
			
		||||
from datetime import datetime
 | 
			
		||||
import functools
 | 
			
		||||
import getpass
 | 
			
		||||
import importlib
 | 
			
		||||
import logging
 | 
			
		||||
import os
 | 
			
		||||
@@ -34,11 +35,10 @@ from esphome.const import (
 | 
			
		||||
    CONF_PORT,
 | 
			
		||||
    CONF_SUBSTITUTIONS,
 | 
			
		||||
    CONF_TOPIC,
 | 
			
		||||
    PLATFORM_BK72XX,
 | 
			
		||||
    ENV_NOGITIGNORE,
 | 
			
		||||
    PLATFORM_ESP32,
 | 
			
		||||
    PLATFORM_ESP8266,
 | 
			
		||||
    PLATFORM_RP2040,
 | 
			
		||||
    PLATFORM_RTL87XX,
 | 
			
		||||
    SECRETS_FILES,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE, EsphomeError, coroutine
 | 
			
		||||
@@ -90,9 +90,9 @@ def choose_prompt(options, purpose: str = None):
 | 
			
		||||
def choose_upload_log_host(
 | 
			
		||||
    default, check_default, show_ota, show_mqtt, show_api, purpose: str = None
 | 
			
		||||
):
 | 
			
		||||
    options = []
 | 
			
		||||
    for port in get_serial_ports():
 | 
			
		||||
        options.append((f"{port.path} ({port.description})", port.path))
 | 
			
		||||
    options = [
 | 
			
		||||
        (f"{port.path} ({port.description})", port.path) for port in get_serial_ports()
 | 
			
		||||
    ]
 | 
			
		||||
    if default == "SERIAL":
 | 
			
		||||
        return choose_prompt(options, purpose=purpose)
 | 
			
		||||
    if (show_ota and "ota" in CORE.config) or (show_api and "api" in CORE.config):
 | 
			
		||||
@@ -120,9 +120,7 @@ def mqtt_logging_enabled(mqtt_config):
 | 
			
		||||
        return False
 | 
			
		||||
    if CONF_TOPIC not in log_topic:
 | 
			
		||||
        return False
 | 
			
		||||
    if log_topic.get(CONF_LEVEL, None) == "NONE":
 | 
			
		||||
        return False
 | 
			
		||||
    return True
 | 
			
		||||
    return log_topic.get(CONF_LEVEL, None) != "NONE"
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def get_port_type(port):
 | 
			
		||||
@@ -211,6 +209,9 @@ def wrap_to_code(name, comp):
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def write_cpp(config):
 | 
			
		||||
    if not get_bool_env(ENV_NOGITIGNORE):
 | 
			
		||||
        writer.write_gitignore()
 | 
			
		||||
 | 
			
		||||
    generate_cpp_contents(config)
 | 
			
		||||
    return write_cpp_file()
 | 
			
		||||
 | 
			
		||||
@@ -227,10 +228,13 @@ def generate_cpp_contents(config):
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def write_cpp_file():
 | 
			
		||||
    writer.write_platformio_project()
 | 
			
		||||
 | 
			
		||||
    code_s = indent(CORE.cpp_main_section)
 | 
			
		||||
    writer.write_cpp(code_s)
 | 
			
		||||
 | 
			
		||||
    from esphome.build_gen import platformio
 | 
			
		||||
 | 
			
		||||
    platformio.write_project()
 | 
			
		||||
 | 
			
		||||
    return 0
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@@ -332,7 +336,7 @@ def check_permissions(port):
 | 
			
		||||
            raise EsphomeError(
 | 
			
		||||
                "You do not have read or write permission on the selected serial port. "
 | 
			
		||||
                "To resolve this issue, you can add your user to the dialout group "
 | 
			
		||||
                f"by running the following command: sudo usermod -a -G dialout {os.getlogin()}. "
 | 
			
		||||
                f"by running the following command: sudo usermod -a -G dialout {getpass.getuser()}. "
 | 
			
		||||
                "You will need to log out & back in or reboot to activate the new group access."
 | 
			
		||||
            )
 | 
			
		||||
 | 
			
		||||
@@ -354,7 +358,7 @@ def upload_program(config, args, host):
 | 
			
		||||
        if CORE.target_platform in (PLATFORM_RP2040):
 | 
			
		||||
            return upload_using_platformio(config, args.device)
 | 
			
		||||
 | 
			
		||||
        if CORE.target_platform in (PLATFORM_BK72XX, PLATFORM_RTL87XX):
 | 
			
		||||
        if CORE.is_libretiny:
 | 
			
		||||
            return upload_using_platformio(config, host)
 | 
			
		||||
 | 
			
		||||
        return 1  # Unknown target platform
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										0
									
								
								esphome/build_gen/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								esphome/build_gen/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										102
									
								
								esphome/build_gen/platformio.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										102
									
								
								esphome/build_gen/platformio.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,102 @@
 | 
			
		||||
import os
 | 
			
		||||
 | 
			
		||||
from esphome.const import __version__
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
from esphome.helpers import mkdir_p, read_file, write_file_if_changed
 | 
			
		||||
from esphome.writer import find_begin_end, update_storage_json
 | 
			
		||||
 | 
			
		||||
INI_AUTO_GENERATE_BEGIN = "; ========== AUTO GENERATED CODE BEGIN ==========="
 | 
			
		||||
INI_AUTO_GENERATE_END = "; =========== AUTO GENERATED CODE END ============"
 | 
			
		||||
 | 
			
		||||
INI_BASE_FORMAT = (
 | 
			
		||||
    """; Auto generated code by esphome
 | 
			
		||||
 | 
			
		||||
[common]
 | 
			
		||||
lib_deps =
 | 
			
		||||
build_flags =
 | 
			
		||||
upload_flags =
 | 
			
		||||
 | 
			
		||||
""",
 | 
			
		||||
    """
 | 
			
		||||
 | 
			
		||||
""",
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def format_ini(data: dict[str, str | list[str]]) -> str:
 | 
			
		||||
    content = ""
 | 
			
		||||
    for key, value in sorted(data.items()):
 | 
			
		||||
        if isinstance(value, list):
 | 
			
		||||
            content += f"{key} =\n"
 | 
			
		||||
            for x in value:
 | 
			
		||||
                content += f"    {x}\n"
 | 
			
		||||
        else:
 | 
			
		||||
            content += f"{key} = {value}\n"
 | 
			
		||||
    return content
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def get_ini_content():
 | 
			
		||||
    CORE.add_platformio_option(
 | 
			
		||||
        "lib_deps",
 | 
			
		||||
        [x.as_lib_dep for x in CORE.platformio_libraries.values()]
 | 
			
		||||
        + ["${common.lib_deps}"],
 | 
			
		||||
    )
 | 
			
		||||
    # Sort to avoid changing build flags order
 | 
			
		||||
    CORE.add_platformio_option("build_flags", sorted(CORE.build_flags))
 | 
			
		||||
 | 
			
		||||
    # Sort to avoid changing build unflags order
 | 
			
		||||
    CORE.add_platformio_option("build_unflags", sorted(CORE.build_unflags))
 | 
			
		||||
 | 
			
		||||
    # Add extra script for C++ flags
 | 
			
		||||
    CORE.add_platformio_option("extra_scripts", [f"pre:{CXX_FLAGS_FILE_NAME}"])
 | 
			
		||||
 | 
			
		||||
    content = "[platformio]\n"
 | 
			
		||||
    content += f"description = ESPHome {__version__}\n"
 | 
			
		||||
 | 
			
		||||
    content += f"[env:{CORE.name}]\n"
 | 
			
		||||
    content += format_ini(CORE.platformio_options)
 | 
			
		||||
 | 
			
		||||
    return content
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def write_ini(content):
 | 
			
		||||
    update_storage_json()
 | 
			
		||||
    path = CORE.relative_build_path("platformio.ini")
 | 
			
		||||
 | 
			
		||||
    if os.path.isfile(path):
 | 
			
		||||
        text = read_file(path)
 | 
			
		||||
        content_format = find_begin_end(
 | 
			
		||||
            text, INI_AUTO_GENERATE_BEGIN, INI_AUTO_GENERATE_END
 | 
			
		||||
        )
 | 
			
		||||
    else:
 | 
			
		||||
        content_format = INI_BASE_FORMAT
 | 
			
		||||
    full_file = f"{content_format[0] + INI_AUTO_GENERATE_BEGIN}\n{content}"
 | 
			
		||||
    full_file += INI_AUTO_GENERATE_END + content_format[1]
 | 
			
		||||
    write_file_if_changed(path, full_file)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def write_project():
 | 
			
		||||
    mkdir_p(CORE.build_path)
 | 
			
		||||
 | 
			
		||||
    content = get_ini_content()
 | 
			
		||||
    write_ini(content)
 | 
			
		||||
 | 
			
		||||
    # Write extra script for C++ specific flags
 | 
			
		||||
    write_cxx_flags_script()
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
CXX_FLAGS_FILE_NAME = "cxx_flags.py"
 | 
			
		||||
CXX_FLAGS_FILE_CONTENTS = """# Auto-generated ESPHome script for C++ specific compiler flags
 | 
			
		||||
Import("env")
 | 
			
		||||
 | 
			
		||||
# Add C++ specific flags
 | 
			
		||||
"""
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def write_cxx_flags_script() -> None:
 | 
			
		||||
    path = CORE.relative_build_path(CXX_FLAGS_FILE_NAME)
 | 
			
		||||
    contents = CXX_FLAGS_FILE_CONTENTS
 | 
			
		||||
    if not CORE.is_host:
 | 
			
		||||
        contents += 'env.Append(CXXFLAGS=["-Wno-volatile"])'
 | 
			
		||||
        contents += "\n"
 | 
			
		||||
    write_file_if_changed(path, contents)
 | 
			
		||||
@@ -22,6 +22,7 @@ from esphome.cpp_generator import (  # noqa: F401
 | 
			
		||||
    TemplateArguments,
 | 
			
		||||
    add,
 | 
			
		||||
    add_build_flag,
 | 
			
		||||
    add_build_unflag,
 | 
			
		||||
    add_define,
 | 
			
		||||
    add_global,
 | 
			
		||||
    add_library,
 | 
			
		||||
@@ -34,6 +35,7 @@ from esphome.cpp_generator import (  # noqa: F401
 | 
			
		||||
    process_lambda,
 | 
			
		||||
    progmem_array,
 | 
			
		||||
    safe_exp,
 | 
			
		||||
    set_cpp_standard,
 | 
			
		||||
    statement,
 | 
			
		||||
    static_const_array,
 | 
			
		||||
    templatable,
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,6 @@ namespace a4988 {
 | 
			
		||||
static const char *const TAG = "a4988.stepper";
 | 
			
		||||
 | 
			
		||||
void A4988::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  if (this->sleep_pin_ != nullptr) {
 | 
			
		||||
    this->sleep_pin_->setup();
 | 
			
		||||
    this->sleep_pin_->digital_write(false);
 | 
			
		||||
 
 | 
			
		||||
@@ -7,8 +7,6 @@ namespace absolute_humidity {
 | 
			
		||||
static const char *const TAG = "absolute_humidity.sensor";
 | 
			
		||||
 | 
			
		||||
void AbsoluteHumidityComponent::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup for '%s'", this->get_name().c_str());
 | 
			
		||||
 | 
			
		||||
  ESP_LOGD(TAG, "  Added callback for temperature '%s'", this->temperature_sensor_->get_name().c_str());
 | 
			
		||||
  this->temperature_sensor_->add_on_state_callback([this](float state) { this->temperature_callback_(state); });
 | 
			
		||||
  if (this->temperature_sensor_->has_state()) {
 | 
			
		||||
 
 | 
			
		||||
@@ -4,6 +4,7 @@
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include <cmath>
 | 
			
		||||
#include <numbers>
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP8266
 | 
			
		||||
#include <core_esp8266_waveform.h>
 | 
			
		||||
@@ -193,18 +194,17 @@ void AcDimmer::setup() {
 | 
			
		||||
  setTimer1Callback(&timer_interrupt);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  // 80 Divider -> 1 count=1µs
 | 
			
		||||
  dimmer_timer = timerBegin(0, 80, true);
 | 
			
		||||
  timerAttachInterrupt(dimmer_timer, &AcDimmerDataStore::s_timer_intr, true);
 | 
			
		||||
  // timer frequency of 1mhz
 | 
			
		||||
  dimmer_timer = timerBegin(1000000);
 | 
			
		||||
  timerAttachInterrupt(dimmer_timer, &AcDimmerDataStore::s_timer_intr);
 | 
			
		||||
  // For ESP32, we can't use dynamic interval calculation because the timerX functions
 | 
			
		||||
  // are not callable from ISR (placed in flash storage).
 | 
			
		||||
  // Here we just use an interrupt firing every 50 µs.
 | 
			
		||||
  timerAlarmWrite(dimmer_timer, 50, true);
 | 
			
		||||
  timerAlarmEnable(dimmer_timer);
 | 
			
		||||
  timerAlarm(dimmer_timer, 50, true, 0);
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
void AcDimmer::write_state(float state) {
 | 
			
		||||
  state = std::acos(1 - (2 * state)) / 3.14159;  // RMS power compensation
 | 
			
		||||
  state = std::acos(1 - (2 * state)) / std::numbers::pi;  // RMS power compensation
 | 
			
		||||
  auto new_value = static_cast<uint16_t>(roundf(state * 65535));
 | 
			
		||||
  if (new_value != 0 && this->store_.value == 0)
 | 
			
		||||
    this->store_.init_cycle = this->init_with_half_cycle_;
 | 
			
		||||
 
 | 
			
		||||
@@ -5,13 +5,21 @@ from esphome.components.esp32.const import (
 | 
			
		||||
    VARIANT_ESP32,
 | 
			
		||||
    VARIANT_ESP32C2,
 | 
			
		||||
    VARIANT_ESP32C3,
 | 
			
		||||
    VARIANT_ESP32C5,
 | 
			
		||||
    VARIANT_ESP32C6,
 | 
			
		||||
    VARIANT_ESP32H2,
 | 
			
		||||
    VARIANT_ESP32S2,
 | 
			
		||||
    VARIANT_ESP32S3,
 | 
			
		||||
)
 | 
			
		||||
from esphome.config_helpers import filter_source_files_from_platform
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_ANALOG, CONF_INPUT, CONF_NUMBER, PLATFORM_ESP8266
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    CONF_ANALOG,
 | 
			
		||||
    CONF_INPUT,
 | 
			
		||||
    CONF_NUMBER,
 | 
			
		||||
    PLATFORM_ESP8266,
 | 
			
		||||
    PlatformFramework,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@esphome/core"]
 | 
			
		||||
@@ -44,82 +52,93 @@ SAMPLING_MODES = {
 | 
			
		||||
    "max": sampling_mode.MAX,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
adc1_channel_t = cg.global_ns.enum("adc1_channel_t")
 | 
			
		||||
adc2_channel_t = cg.global_ns.enum("adc2_channel_t")
 | 
			
		||||
adc_unit_t = cg.global_ns.enum("adc_unit_t", is_class=True)
 | 
			
		||||
 | 
			
		||||
adc_channel_t = cg.global_ns.enum("adc_channel_t", is_class=True)
 | 
			
		||||
 | 
			
		||||
# pin to adc1 channel mapping
 | 
			
		||||
# https://github.com/espressif/esp-idf/blob/v4.4.8/components/driver/include/driver/adc.h
 | 
			
		||||
ESP32_VARIANT_ADC1_PIN_TO_CHANNEL = {
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32: {
 | 
			
		||||
        36: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        37: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        38: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        39: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        32: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        33: adc1_channel_t.ADC1_CHANNEL_5,
 | 
			
		||||
        34: adc1_channel_t.ADC1_CHANNEL_6,
 | 
			
		||||
        35: adc1_channel_t.ADC1_CHANNEL_7,
 | 
			
		||||
        36: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        37: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        38: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        39: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        32: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        33: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        34: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
        35: adc_channel_t.ADC_CHANNEL_7,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32c2/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32C2: {
 | 
			
		||||
        0: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        0: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32c3/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32C3: {
 | 
			
		||||
        0: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        0: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
    },
 | 
			
		||||
    # ESP32-C5 ADC1 pin mapping - based on official ESP-IDF documentation
 | 
			
		||||
    # https://docs.espressif.com/projects/esp-idf/en/latest/esp32c5/api-reference/peripherals/gpio.html
 | 
			
		||||
    VARIANT_ESP32C5: {
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        6: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32c6/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32C6: {
 | 
			
		||||
        0: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        5: adc1_channel_t.ADC1_CHANNEL_5,
 | 
			
		||||
        6: adc1_channel_t.ADC1_CHANNEL_6,
 | 
			
		||||
        0: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        6: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32h2/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32H2: {
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        5: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32s2/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32S2: {
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        5: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        6: adc1_channel_t.ADC1_CHANNEL_5,
 | 
			
		||||
        7: adc1_channel_t.ADC1_CHANNEL_6,
 | 
			
		||||
        8: adc1_channel_t.ADC1_CHANNEL_7,
 | 
			
		||||
        9: adc1_channel_t.ADC1_CHANNEL_8,
 | 
			
		||||
        10: adc1_channel_t.ADC1_CHANNEL_9,
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        6: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        7: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
        8: adc_channel_t.ADC_CHANNEL_7,
 | 
			
		||||
        9: adc_channel_t.ADC_CHANNEL_8,
 | 
			
		||||
        10: adc_channel_t.ADC_CHANNEL_9,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32s3/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32S3: {
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        5: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        6: adc1_channel_t.ADC1_CHANNEL_5,
 | 
			
		||||
        7: adc1_channel_t.ADC1_CHANNEL_6,
 | 
			
		||||
        8: adc1_channel_t.ADC1_CHANNEL_7,
 | 
			
		||||
        9: adc1_channel_t.ADC1_CHANNEL_8,
 | 
			
		||||
        10: adc1_channel_t.ADC1_CHANNEL_9,
 | 
			
		||||
        1: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        3: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        6: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        7: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
        8: adc_channel_t.ADC_CHANNEL_7,
 | 
			
		||||
        9: adc_channel_t.ADC_CHANNEL_8,
 | 
			
		||||
        10: adc_channel_t.ADC_CHANNEL_9,
 | 
			
		||||
    },
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -128,54 +147,56 @@ ESP32_VARIANT_ADC1_PIN_TO_CHANNEL = {
 | 
			
		||||
ESP32_VARIANT_ADC2_PIN_TO_CHANNEL = {
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32: {
 | 
			
		||||
        4: adc2_channel_t.ADC2_CHANNEL_0,
 | 
			
		||||
        0: adc2_channel_t.ADC2_CHANNEL_1,
 | 
			
		||||
        2: adc2_channel_t.ADC2_CHANNEL_2,
 | 
			
		||||
        15: adc2_channel_t.ADC2_CHANNEL_3,
 | 
			
		||||
        13: adc2_channel_t.ADC2_CHANNEL_4,
 | 
			
		||||
        12: adc2_channel_t.ADC2_CHANNEL_5,
 | 
			
		||||
        14: adc2_channel_t.ADC2_CHANNEL_6,
 | 
			
		||||
        27: adc2_channel_t.ADC2_CHANNEL_7,
 | 
			
		||||
        25: adc2_channel_t.ADC2_CHANNEL_8,
 | 
			
		||||
        26: adc2_channel_t.ADC2_CHANNEL_9,
 | 
			
		||||
        4: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        0: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        2: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        15: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        13: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        12: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        14: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
        27: adc_channel_t.ADC_CHANNEL_7,
 | 
			
		||||
        25: adc_channel_t.ADC_CHANNEL_8,
 | 
			
		||||
        26: adc_channel_t.ADC_CHANNEL_9,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32c2/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32C2: {
 | 
			
		||||
        5: adc2_channel_t.ADC2_CHANNEL_0,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32c3/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32C3: {
 | 
			
		||||
        5: adc2_channel_t.ADC2_CHANNEL_0,
 | 
			
		||||
        5: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
    },
 | 
			
		||||
    # ESP32-C5 has no ADC2 channels
 | 
			
		||||
    VARIANT_ESP32C5: {},  # no ADC2
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32c6/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32C6: {},  # no ADC2
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32h2/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32H2: {},  # no ADC2
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32s2/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32S2: {
 | 
			
		||||
        11: adc2_channel_t.ADC2_CHANNEL_0,
 | 
			
		||||
        12: adc2_channel_t.ADC2_CHANNEL_1,
 | 
			
		||||
        13: adc2_channel_t.ADC2_CHANNEL_2,
 | 
			
		||||
        14: adc2_channel_t.ADC2_CHANNEL_3,
 | 
			
		||||
        15: adc2_channel_t.ADC2_CHANNEL_4,
 | 
			
		||||
        16: adc2_channel_t.ADC2_CHANNEL_5,
 | 
			
		||||
        17: adc2_channel_t.ADC2_CHANNEL_6,
 | 
			
		||||
        18: adc2_channel_t.ADC2_CHANNEL_7,
 | 
			
		||||
        19: adc2_channel_t.ADC2_CHANNEL_8,
 | 
			
		||||
        20: adc2_channel_t.ADC2_CHANNEL_9,
 | 
			
		||||
        11: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        12: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        13: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        14: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        15: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        16: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        17: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
        18: adc_channel_t.ADC_CHANNEL_7,
 | 
			
		||||
        19: adc_channel_t.ADC_CHANNEL_8,
 | 
			
		||||
        20: adc_channel_t.ADC_CHANNEL_9,
 | 
			
		||||
    },
 | 
			
		||||
    # https://github.com/espressif/esp-idf/blob/master/components/soc/esp32s3/include/soc/adc_channel.h
 | 
			
		||||
    VARIANT_ESP32S3: {
 | 
			
		||||
        11: adc2_channel_t.ADC2_CHANNEL_0,
 | 
			
		||||
        12: adc2_channel_t.ADC2_CHANNEL_1,
 | 
			
		||||
        13: adc2_channel_t.ADC2_CHANNEL_2,
 | 
			
		||||
        14: adc2_channel_t.ADC2_CHANNEL_3,
 | 
			
		||||
        15: adc2_channel_t.ADC2_CHANNEL_4,
 | 
			
		||||
        16: adc2_channel_t.ADC2_CHANNEL_5,
 | 
			
		||||
        17: adc2_channel_t.ADC2_CHANNEL_6,
 | 
			
		||||
        18: adc2_channel_t.ADC2_CHANNEL_7,
 | 
			
		||||
        19: adc2_channel_t.ADC2_CHANNEL_8,
 | 
			
		||||
        20: adc2_channel_t.ADC2_CHANNEL_9,
 | 
			
		||||
        11: adc_channel_t.ADC_CHANNEL_0,
 | 
			
		||||
        12: adc_channel_t.ADC_CHANNEL_1,
 | 
			
		||||
        13: adc_channel_t.ADC_CHANNEL_2,
 | 
			
		||||
        14: adc_channel_t.ADC_CHANNEL_3,
 | 
			
		||||
        15: adc_channel_t.ADC_CHANNEL_4,
 | 
			
		||||
        16: adc_channel_t.ADC_CHANNEL_5,
 | 
			
		||||
        17: adc_channel_t.ADC_CHANNEL_6,
 | 
			
		||||
        18: adc_channel_t.ADC_CHANNEL_7,
 | 
			
		||||
        19: adc_channel_t.ADC_CHANNEL_8,
 | 
			
		||||
        20: adc_channel_t.ADC_CHANNEL_9,
 | 
			
		||||
    },
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -229,3 +250,20 @@ def validate_adc_pin(value):
 | 
			
		||||
        )(value)
 | 
			
		||||
 | 
			
		||||
    raise NotImplementedError
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
FILTER_SOURCE_FILES = filter_source_files_from_platform(
 | 
			
		||||
    {
 | 
			
		||||
        "adc_sensor_esp32.cpp": {
 | 
			
		||||
            PlatformFramework.ESP32_ARDUINO,
 | 
			
		||||
            PlatformFramework.ESP32_IDF,
 | 
			
		||||
        },
 | 
			
		||||
        "adc_sensor_esp8266.cpp": {PlatformFramework.ESP8266_ARDUINO},
 | 
			
		||||
        "adc_sensor_rp2040.cpp": {PlatformFramework.RP2040_ARDUINO},
 | 
			
		||||
        "adc_sensor_libretiny.cpp": {
 | 
			
		||||
            PlatformFramework.BK72XX_ARDUINO,
 | 
			
		||||
            PlatformFramework.RTL87XX_ARDUINO,
 | 
			
		||||
            PlatformFramework.LN882X_ARDUINO,
 | 
			
		||||
        },
 | 
			
		||||
    }
 | 
			
		||||
)
 | 
			
		||||
 
 | 
			
		||||
@@ -3,20 +3,22 @@
 | 
			
		||||
#include "esphome/components/sensor/sensor.h"
 | 
			
		||||
#include "esphome/components/voltage_sampler/voltage_sampler.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
#include <esp_adc_cal.h>
 | 
			
		||||
#include "driver/adc.h"
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
#include "esp_adc/adc_cali.h"
 | 
			
		||||
#include "esp_adc/adc_cali_scheme.h"
 | 
			
		||||
#include "esp_adc/adc_oneshot.h"
 | 
			
		||||
#include "hal/adc_types.h"  // This defines ADC_CHANNEL_MAX
 | 
			
		||||
#endif                      // USE_ESP32
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
// clang-format off
 | 
			
		||||
#if (ESP_IDF_VERSION_MAJOR == 4 && ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 7)) || \
 | 
			
		||||
    (ESP_IDF_VERSION_MAJOR == 5 && \
 | 
			
		||||
#if (ESP_IDF_VERSION_MAJOR == 5 && \
 | 
			
		||||
     ((ESP_IDF_VERSION_MINOR == 0 && ESP_IDF_VERSION_PATCH >= 5) || \
 | 
			
		||||
      (ESP_IDF_VERSION_MINOR == 1 && ESP_IDF_VERSION_PATCH >= 3) || \
 | 
			
		||||
      (ESP_IDF_VERSION_MINOR >= 2)) \
 | 
			
		||||
@@ -28,79 +30,127 @@ static const adc_atten_t ADC_ATTEN_DB_12_COMPAT = ADC_ATTEN_DB_11;
 | 
			
		||||
#endif
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
enum class SamplingMode : uint8_t { AVG = 0, MIN = 1, MAX = 2 };
 | 
			
		||||
enum class SamplingMode : uint8_t {
 | 
			
		||||
  AVG = 0,
 | 
			
		||||
  MIN = 1,
 | 
			
		||||
  MAX = 2,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const LogString *sampling_mode_to_str(SamplingMode mode);
 | 
			
		||||
 | 
			
		||||
class Aggregator {
 | 
			
		||||
 public:
 | 
			
		||||
  Aggregator(SamplingMode mode);
 | 
			
		||||
  void add_sample(uint32_t value);
 | 
			
		||||
  uint32_t aggregate();
 | 
			
		||||
  Aggregator(SamplingMode mode);
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  SamplingMode mode_{SamplingMode::AVG};
 | 
			
		||||
  uint32_t aggr_{0};
 | 
			
		||||
  uint32_t samples_{0};
 | 
			
		||||
  SamplingMode mode_{SamplingMode::AVG};
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage_sampler::VoltageSampler {
 | 
			
		||||
 public:
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  /// Set the attenuation for this pin. Only available on the ESP32.
 | 
			
		||||
  void set_attenuation(adc_atten_t attenuation) { this->attenuation_ = attenuation; }
 | 
			
		||||
  void set_channel1(adc1_channel_t channel) {
 | 
			
		||||
    this->channel1_ = channel;
 | 
			
		||||
    this->channel2_ = ADC2_CHANNEL_MAX;
 | 
			
		||||
  }
 | 
			
		||||
  void set_channel2(adc2_channel_t channel) {
 | 
			
		||||
    this->channel2_ = channel;
 | 
			
		||||
    this->channel1_ = ADC1_CHANNEL_MAX;
 | 
			
		||||
  }
 | 
			
		||||
  void set_autorange(bool autorange) { this->autorange_ = autorange; }
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
  /// Update ADC values
 | 
			
		||||
  /// Update the sensor's state by reading the current ADC value.
 | 
			
		||||
  /// This method is called periodically based on the update interval.
 | 
			
		||||
  void update() override;
 | 
			
		||||
  /// Setup ADC
 | 
			
		||||
 | 
			
		||||
  /// Set up the ADC sensor by initializing hardware and calibration parameters.
 | 
			
		||||
  /// This method is called once during device initialization.
 | 
			
		||||
  void setup() override;
 | 
			
		||||
 | 
			
		||||
  /// Output the configuration details of the ADC sensor for debugging purposes.
 | 
			
		||||
  /// This method is called during the ESPHome setup process to log the configuration.
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  /// `HARDWARE_LATE` setup priority
 | 
			
		||||
 | 
			
		||||
  /// Return the setup priority for this component.
 | 
			
		||||
  /// Components with higher priority are initialized earlier during setup.
 | 
			
		||||
  /// @return A float representing the setup priority.
 | 
			
		||||
  float get_setup_priority() const override;
 | 
			
		||||
 | 
			
		||||
  /// Set the GPIO pin to be used by the ADC sensor.
 | 
			
		||||
  /// @param pin Pointer to an InternalGPIOPin representing the ADC input pin.
 | 
			
		||||
  void set_pin(InternalGPIOPin *pin) { this->pin_ = pin; }
 | 
			
		||||
 | 
			
		||||
  /// Enable or disable the output of raw ADC values (unprocessed data).
 | 
			
		||||
  /// @param output_raw Boolean indicating whether to output raw ADC values (true) or processed values (false).
 | 
			
		||||
  void set_output_raw(bool output_raw) { this->output_raw_ = output_raw; }
 | 
			
		||||
 | 
			
		||||
  /// Set the number of samples to be taken for ADC readings to improve accuracy.
 | 
			
		||||
  /// A higher sample count reduces noise but increases the reading time.
 | 
			
		||||
  /// @param sample_count The number of samples (e.g., 1, 4, 8).
 | 
			
		||||
  void set_sample_count(uint8_t sample_count);
 | 
			
		||||
 | 
			
		||||
  /// Set the sampling mode for how multiple ADC samples are combined into a single measurement.
 | 
			
		||||
  ///
 | 
			
		||||
  /// When multiple samples are taken (controlled by set_sample_count), they can be combined
 | 
			
		||||
  /// in one of three ways:
 | 
			
		||||
  ///   - SamplingMode::AVG: Compute the average (default)
 | 
			
		||||
  ///   - SamplingMode::MIN: Use the lowest sample value
 | 
			
		||||
  ///   - SamplingMode::MAX: Use the highest sample value
 | 
			
		||||
  /// @param sampling_mode The desired sampling mode to use for aggregating ADC samples.
 | 
			
		||||
  void set_sampling_mode(SamplingMode sampling_mode);
 | 
			
		||||
 | 
			
		||||
  /// Perform a single ADC sampling operation and return the measured value.
 | 
			
		||||
  /// This function handles raw readings, calibration, and averaging as needed.
 | 
			
		||||
  /// @return The sampled value as a float.
 | 
			
		||||
  float sample() override;
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP8266
 | 
			
		||||
  std::string unique_id() override;
 | 
			
		||||
#endif  // USE_ESP8266
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  /// Set the ADC attenuation level to adjust the input voltage range.
 | 
			
		||||
  /// This determines how the ADC interprets input voltages, allowing for greater precision
 | 
			
		||||
  /// or the ability to measure higher voltages depending on the chosen attenuation level.
 | 
			
		||||
  /// @param attenuation The desired ADC attenuation level (e.g., ADC_ATTEN_DB_0, ADC_ATTEN_DB_11).
 | 
			
		||||
  void set_attenuation(adc_atten_t attenuation) { this->attenuation_ = attenuation; }
 | 
			
		||||
 | 
			
		||||
  /// Configure the ADC to use a specific channel on a specific ADC unit.
 | 
			
		||||
  /// This sets the channel for single-shot or continuous ADC measurements.
 | 
			
		||||
  /// @param unit The ADC unit to use (ADC_UNIT_1 or ADC_UNIT_2).
 | 
			
		||||
  /// @param channel The ADC channel to configure, such as ADC_CHANNEL_0, ADC_CHANNEL_3, etc.
 | 
			
		||||
  void set_channel(adc_unit_t unit, adc_channel_t channel) {
 | 
			
		||||
    this->adc_unit_ = unit;
 | 
			
		||||
    this->channel_ = channel;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /// Set whether autoranging should be enabled for the ADC.
 | 
			
		||||
  /// Autoranging automatically adjusts the attenuation level to handle a wide range of input voltages.
 | 
			
		||||
  /// @param autorange Boolean indicating whether to enable autoranging.
 | 
			
		||||
  void set_autorange(bool autorange) { this->autorange_ = autorange; }
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
  void set_is_temperature() { this->is_temperature_ = true; }
 | 
			
		||||
#endif  // USE_RP2040
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  InternalGPIOPin *pin_;
 | 
			
		||||
  bool output_raw_{false};
 | 
			
		||||
  uint8_t sample_count_{1};
 | 
			
		||||
  bool output_raw_{false};
 | 
			
		||||
  InternalGPIOPin *pin_;
 | 
			
		||||
  SamplingMode sampling_mode_{SamplingMode::AVG};
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  float sample_autorange_();
 | 
			
		||||
  float sample_fixed_attenuation_();
 | 
			
		||||
  bool autorange_{false};
 | 
			
		||||
  adc_oneshot_unit_handle_t adc_handle_{nullptr};
 | 
			
		||||
  adc_cali_handle_t calibration_handle_{nullptr};
 | 
			
		||||
  adc_atten_t attenuation_{ADC_ATTEN_DB_0};
 | 
			
		||||
  adc_channel_t channel_;
 | 
			
		||||
  adc_unit_t adc_unit_;
 | 
			
		||||
  struct SetupFlags {
 | 
			
		||||
    uint8_t init_complete : 1;
 | 
			
		||||
    uint8_t config_complete : 1;
 | 
			
		||||
    uint8_t handle_init_complete : 1;
 | 
			
		||||
    uint8_t calibration_complete : 1;
 | 
			
		||||
    uint8_t reserved : 4;
 | 
			
		||||
  } setup_flags_{};
 | 
			
		||||
  static adc_oneshot_unit_handle_t shared_adc_handles[2];
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
  bool is_temperature_{false};
 | 
			
		||||
#endif  // USE_RP2040
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  adc_atten_t attenuation_{ADC_ATTEN_DB_0};
 | 
			
		||||
  adc1_channel_t channel1_{ADC1_CHANNEL_MAX};
 | 
			
		||||
  adc2_channel_t channel2_{ADC2_CHANNEL_MAX};
 | 
			
		||||
  bool autorange_{false};
 | 
			
		||||
#if ESP_IDF_VERSION_MAJOR >= 5
 | 
			
		||||
  esp_adc_cal_characteristics_t cal_characteristics_[SOC_ADC_ATTEN_NUM] = {};
 | 
			
		||||
#else
 | 
			
		||||
  esp_adc_cal_characteristics_t cal_characteristics_[ADC_ATTEN_MAX] = {};
 | 
			
		||||
#endif  // ESP_IDF_VERSION_MAJOR
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
 
 | 
			
		||||
@@ -61,7 +61,7 @@ uint32_t Aggregator::aggregate() {
 | 
			
		||||
 | 
			
		||||
void ADCSensor::update() {
 | 
			
		||||
  float value_v = this->sample();
 | 
			
		||||
  ESP_LOGV(TAG, "'%s': Got voltage=%.4fV", this->get_name().c_str(), value_v);
 | 
			
		||||
  ESP_LOGV(TAG, "'%s': Voltage=%.4fV", this->get_name().c_str(), value_v);
 | 
			
		||||
  this->publish_state(value_v);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -8,137 +8,314 @@ namespace adc {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "adc.esp32";
 | 
			
		||||
 | 
			
		||||
static const adc_bits_width_t ADC_WIDTH_MAX_SOC_BITS = static_cast<adc_bits_width_t>(ADC_WIDTH_MAX - 1);
 | 
			
		||||
adc_oneshot_unit_handle_t ADCSensor::shared_adc_handles[2] = {nullptr, nullptr};
 | 
			
		||||
 | 
			
		||||
#ifndef SOC_ADC_RTC_MAX_BITWIDTH
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32S2
 | 
			
		||||
static const int32_t SOC_ADC_RTC_MAX_BITWIDTH = 13;
 | 
			
		||||
#else
 | 
			
		||||
static const int32_t SOC_ADC_RTC_MAX_BITWIDTH = 12;
 | 
			
		||||
#endif  // USE_ESP32_VARIANT_ESP32S2
 | 
			
		||||
#endif  // SOC_ADC_RTC_MAX_BITWIDTH
 | 
			
		||||
const LogString *attenuation_to_str(adc_atten_t attenuation) {
 | 
			
		||||
  switch (attenuation) {
 | 
			
		||||
    case ADC_ATTEN_DB_0:
 | 
			
		||||
      return LOG_STR("0 dB");
 | 
			
		||||
    case ADC_ATTEN_DB_2_5:
 | 
			
		||||
      return LOG_STR("2.5 dB");
 | 
			
		||||
    case ADC_ATTEN_DB_6:
 | 
			
		||||
      return LOG_STR("6 dB");
 | 
			
		||||
    case ADC_ATTEN_DB_12_COMPAT:
 | 
			
		||||
      return LOG_STR("12 dB");
 | 
			
		||||
    default:
 | 
			
		||||
      return LOG_STR("Unknown Attenuation");
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static const int ADC_MAX = (1 << SOC_ADC_RTC_MAX_BITWIDTH) - 1;
 | 
			
		||||
static const int ADC_HALF = (1 << SOC_ADC_RTC_MAX_BITWIDTH) >> 1;
 | 
			
		||||
const LogString *adc_unit_to_str(adc_unit_t unit) {
 | 
			
		||||
  switch (unit) {
 | 
			
		||||
    case ADC_UNIT_1:
 | 
			
		||||
      return LOG_STR("ADC1");
 | 
			
		||||
    case ADC_UNIT_2:
 | 
			
		||||
      return LOG_STR("ADC2");
 | 
			
		||||
    default:
 | 
			
		||||
      return LOG_STR("Unknown ADC Unit");
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup for '%s'", this->get_name().c_str());
 | 
			
		||||
 | 
			
		||||
  if (this->channel1_ != ADC1_CHANNEL_MAX) {
 | 
			
		||||
    adc1_config_width(ADC_WIDTH_MAX_SOC_BITS);
 | 
			
		||||
    if (!this->autorange_) {
 | 
			
		||||
      adc1_config_channel_atten(this->channel1_, this->attenuation_);
 | 
			
		||||
    }
 | 
			
		||||
  } else if (this->channel2_ != ADC2_CHANNEL_MAX) {
 | 
			
		||||
    if (!this->autorange_) {
 | 
			
		||||
      adc2_config_channel_atten(this->channel2_, this->attenuation_);
 | 
			
		||||
  // Check if another sensor already initialized this ADC unit
 | 
			
		||||
  if (ADCSensor::shared_adc_handles[this->adc_unit_] == nullptr) {
 | 
			
		||||
    adc_oneshot_unit_init_cfg_t init_config = {};  // Zero initialize
 | 
			
		||||
    init_config.unit_id = this->adc_unit_;
 | 
			
		||||
    init_config.ulp_mode = ADC_ULP_MODE_DISABLE;
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
    init_config.clk_src = ADC_DIGI_CLK_SRC_DEFAULT;
 | 
			
		||||
#endif  // USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 ||
 | 
			
		||||
        // USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
    esp_err_t err = adc_oneshot_new_unit(&init_config, &ADCSensor::shared_adc_handles[this->adc_unit_]);
 | 
			
		||||
    if (err != ESP_OK) {
 | 
			
		||||
      ESP_LOGE(TAG, "Error initializing %s: %d", LOG_STR_ARG(adc_unit_to_str(this->adc_unit_)), err);
 | 
			
		||||
      this->mark_failed();
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
  this->adc_handle_ = ADCSensor::shared_adc_handles[this->adc_unit_];
 | 
			
		||||
 | 
			
		||||
  for (int32_t i = 0; i <= ADC_ATTEN_DB_12_COMPAT; i++) {
 | 
			
		||||
    auto adc_unit = this->channel1_ != ADC1_CHANNEL_MAX ? ADC_UNIT_1 : ADC_UNIT_2;
 | 
			
		||||
    auto cal_value = esp_adc_cal_characterize(adc_unit, (adc_atten_t) i, ADC_WIDTH_MAX_SOC_BITS,
 | 
			
		||||
                                              1100,  // default vref
 | 
			
		||||
                                              &this->cal_characteristics_[i]);
 | 
			
		||||
    switch (cal_value) {
 | 
			
		||||
      case ESP_ADC_CAL_VAL_EFUSE_VREF:
 | 
			
		||||
        ESP_LOGV(TAG, "Using eFuse Vref for calibration");
 | 
			
		||||
        break;
 | 
			
		||||
      case ESP_ADC_CAL_VAL_EFUSE_TP:
 | 
			
		||||
        ESP_LOGV(TAG, "Using two-point eFuse Vref for calibration");
 | 
			
		||||
        break;
 | 
			
		||||
      case ESP_ADC_CAL_VAL_DEFAULT_VREF:
 | 
			
		||||
      default:
 | 
			
		||||
        break;
 | 
			
		||||
    }
 | 
			
		||||
  this->setup_flags_.handle_init_complete = true;
 | 
			
		||||
 | 
			
		||||
  adc_oneshot_chan_cfg_t config = {
 | 
			
		||||
      .atten = this->attenuation_,
 | 
			
		||||
      .bitwidth = ADC_BITWIDTH_DEFAULT,
 | 
			
		||||
  };
 | 
			
		||||
  esp_err_t err = adc_oneshot_config_channel(this->adc_handle_, this->channel_, &config);
 | 
			
		||||
  if (err != ESP_OK) {
 | 
			
		||||
    ESP_LOGE(TAG, "Error configuring channel: %d", err);
 | 
			
		||||
    this->mark_failed();
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  this->setup_flags_.config_complete = true;
 | 
			
		||||
 | 
			
		||||
  // Initialize ADC calibration
 | 
			
		||||
  if (this->calibration_handle_ == nullptr) {
 | 
			
		||||
    adc_cali_handle_t handle = nullptr;
 | 
			
		||||
    esp_err_t err;
 | 
			
		||||
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || \
 | 
			
		||||
    USE_ESP32_VARIANT_ESP32S3 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
    // RISC-V variants and S3 use curve fitting calibration
 | 
			
		||||
    adc_cali_curve_fitting_config_t cali_config = {};  // Zero initialize first
 | 
			
		||||
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
 | 
			
		||||
    cali_config.chan = this->channel_;
 | 
			
		||||
#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
 | 
			
		||||
    cali_config.unit_id = this->adc_unit_;
 | 
			
		||||
    cali_config.atten = this->attenuation_;
 | 
			
		||||
    cali_config.bitwidth = ADC_BITWIDTH_DEFAULT;
 | 
			
		||||
 | 
			
		||||
    err = adc_cali_create_scheme_curve_fitting(&cali_config, &handle);
 | 
			
		||||
    if (err == ESP_OK) {
 | 
			
		||||
      this->calibration_handle_ = handle;
 | 
			
		||||
      this->setup_flags_.calibration_complete = true;
 | 
			
		||||
      ESP_LOGV(TAG, "Using curve fitting calibration");
 | 
			
		||||
    } else {
 | 
			
		||||
      ESP_LOGW(TAG, "Curve fitting calibration failed with error %d, will use uncalibrated readings", err);
 | 
			
		||||
      this->setup_flags_.calibration_complete = false;
 | 
			
		||||
    }
 | 
			
		||||
#else  // Other ESP32 variants use line fitting calibration
 | 
			
		||||
    adc_cali_line_fitting_config_t cali_config = {
 | 
			
		||||
      .unit_id = this->adc_unit_,
 | 
			
		||||
      .atten = this->attenuation_,
 | 
			
		||||
      .bitwidth = ADC_BITWIDTH_DEFAULT,
 | 
			
		||||
#if !defined(USE_ESP32_VARIANT_ESP32S2)
 | 
			
		||||
      .default_vref = 1100,  // Default reference voltage in mV
 | 
			
		||||
#endif  // !defined(USE_ESP32_VARIANT_ESP32S2)
 | 
			
		||||
    };
 | 
			
		||||
    err = adc_cali_create_scheme_line_fitting(&cali_config, &handle);
 | 
			
		||||
    if (err == ESP_OK) {
 | 
			
		||||
      this->calibration_handle_ = handle;
 | 
			
		||||
      this->setup_flags_.calibration_complete = true;
 | 
			
		||||
      ESP_LOGV(TAG, "Using line fitting calibration");
 | 
			
		||||
    } else {
 | 
			
		||||
      ESP_LOGW(TAG, "Line fitting calibration failed with error %d, will use uncalibrated readings", err);
 | 
			
		||||
      this->setup_flags_.calibration_complete = false;
 | 
			
		||||
    }
 | 
			
		||||
#endif  // USE_ESP32_VARIANT_ESP32C3 || ESP32C5 || ESP32C6 || ESP32S3 || ESP32H2
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->setup_flags_.init_complete = true;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::dump_config() {
 | 
			
		||||
  LOG_SENSOR("", "ADC Sensor", this);
 | 
			
		||||
  LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
  if (this->autorange_) {
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Attenuation: auto");
 | 
			
		||||
  } else {
 | 
			
		||||
    switch (this->attenuation_) {
 | 
			
		||||
      case ADC_ATTEN_DB_0:
 | 
			
		||||
        ESP_LOGCONFIG(TAG, "  Attenuation: 0db");
 | 
			
		||||
        break;
 | 
			
		||||
      case ADC_ATTEN_DB_2_5:
 | 
			
		||||
        ESP_LOGCONFIG(TAG, "  Attenuation: 2.5db");
 | 
			
		||||
        break;
 | 
			
		||||
      case ADC_ATTEN_DB_6:
 | 
			
		||||
        ESP_LOGCONFIG(TAG, "  Attenuation: 6db");
 | 
			
		||||
        break;
 | 
			
		||||
      case ADC_ATTEN_DB_12_COMPAT:
 | 
			
		||||
        ESP_LOGCONFIG(TAG, "  Attenuation: 12db");
 | 
			
		||||
        break;
 | 
			
		||||
      default:  // This is to satisfy the unused ADC_ATTEN_MAX
 | 
			
		||||
        break;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
  ESP_LOGCONFIG(TAG,
 | 
			
		||||
                "  Samples: %i\n"
 | 
			
		||||
                "  Channel:       %d\n"
 | 
			
		||||
                "  Unit:          %s\n"
 | 
			
		||||
                "  Attenuation:   %s\n"
 | 
			
		||||
                "  Samples:       %i\n"
 | 
			
		||||
                "  Sampling mode: %s",
 | 
			
		||||
                this->sample_count_, LOG_STR_ARG(sampling_mode_to_str(this->sampling_mode_)));
 | 
			
		||||
                this->channel_, LOG_STR_ARG(adc_unit_to_str(this->adc_unit_)),
 | 
			
		||||
                this->autorange_ ? "Auto" : LOG_STR_ARG(attenuation_to_str(this->attenuation_)), this->sample_count_,
 | 
			
		||||
                LOG_STR_ARG(sampling_mode_to_str(this->sampling_mode_)));
 | 
			
		||||
 | 
			
		||||
  ESP_LOGCONFIG(
 | 
			
		||||
      TAG,
 | 
			
		||||
      "  Setup Status:\n"
 | 
			
		||||
      "    Handle Init:  %s\n"
 | 
			
		||||
      "    Config:       %s\n"
 | 
			
		||||
      "    Calibration:  %s\n"
 | 
			
		||||
      "    Overall Init: %s",
 | 
			
		||||
      this->setup_flags_.handle_init_complete ? "OK" : "FAILED", this->setup_flags_.config_complete ? "OK" : "FAILED",
 | 
			
		||||
      this->setup_flags_.calibration_complete ? "OK" : "FAILED", this->setup_flags_.init_complete ? "OK" : "FAILED");
 | 
			
		||||
 | 
			
		||||
  LOG_UPDATE_INTERVAL(this);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
float ADCSensor::sample() {
 | 
			
		||||
  if (!this->autorange_) {
 | 
			
		||||
    auto aggr = Aggregator(this->sampling_mode_);
 | 
			
		||||
  if (this->autorange_) {
 | 
			
		||||
    return this->sample_autorange_();
 | 
			
		||||
  } else {
 | 
			
		||||
    return this->sample_fixed_attenuation_();
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
    for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
      int raw = -1;
 | 
			
		||||
      if (this->channel1_ != ADC1_CHANNEL_MAX) {
 | 
			
		||||
        raw = adc1_get_raw(this->channel1_);
 | 
			
		||||
      } else if (this->channel2_ != ADC2_CHANNEL_MAX) {
 | 
			
		||||
        adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw);
 | 
			
		||||
      }
 | 
			
		||||
      if (raw == -1) {
 | 
			
		||||
        return NAN;
 | 
			
		||||
      }
 | 
			
		||||
float ADCSensor::sample_fixed_attenuation_() {
 | 
			
		||||
  auto aggr = Aggregator(this->sampling_mode_);
 | 
			
		||||
 | 
			
		||||
      aggr.add_sample(raw);
 | 
			
		||||
  for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
    int raw;
 | 
			
		||||
    esp_err_t err = adc_oneshot_read(this->adc_handle_, this->channel_, &raw);
 | 
			
		||||
 | 
			
		||||
    if (err != ESP_OK) {
 | 
			
		||||
      ESP_LOGW(TAG, "ADC read failed with error %d", err);
 | 
			
		||||
      continue;
 | 
			
		||||
    }
 | 
			
		||||
    if (this->output_raw_) {
 | 
			
		||||
      return aggr.aggregate();
 | 
			
		||||
 | 
			
		||||
    if (raw == -1) {
 | 
			
		||||
      ESP_LOGW(TAG, "Invalid ADC reading");
 | 
			
		||||
      continue;
 | 
			
		||||
    }
 | 
			
		||||
    uint32_t mv =
 | 
			
		||||
        esp_adc_cal_raw_to_voltage(aggr.aggregate(), &this->cal_characteristics_[(int32_t) this->attenuation_]);
 | 
			
		||||
    return mv / 1000.0f;
 | 
			
		||||
 | 
			
		||||
    aggr.add_sample(raw);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  int raw12 = ADC_MAX, raw6 = ADC_MAX, raw2 = ADC_MAX, raw0 = ADC_MAX;
 | 
			
		||||
  uint32_t final_value = aggr.aggregate();
 | 
			
		||||
 | 
			
		||||
  if (this->channel1_ != ADC1_CHANNEL_MAX) {
 | 
			
		||||
    adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_12_COMPAT);
 | 
			
		||||
    raw12 = adc1_get_raw(this->channel1_);
 | 
			
		||||
    if (raw12 < ADC_MAX) {
 | 
			
		||||
      adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_6);
 | 
			
		||||
      raw6 = adc1_get_raw(this->channel1_);
 | 
			
		||||
      if (raw6 < ADC_MAX) {
 | 
			
		||||
        adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_2_5);
 | 
			
		||||
        raw2 = adc1_get_raw(this->channel1_);
 | 
			
		||||
        if (raw2 < ADC_MAX) {
 | 
			
		||||
          adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_0);
 | 
			
		||||
          raw0 = adc1_get_raw(this->channel1_);
 | 
			
		||||
        }
 | 
			
		||||
  if (this->output_raw_) {
 | 
			
		||||
    return final_value;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->calibration_handle_ != nullptr) {
 | 
			
		||||
    int voltage_mv;
 | 
			
		||||
    esp_err_t err = adc_cali_raw_to_voltage(this->calibration_handle_, final_value, &voltage_mv);
 | 
			
		||||
    if (err == ESP_OK) {
 | 
			
		||||
      return voltage_mv / 1000.0f;
 | 
			
		||||
    } else {
 | 
			
		||||
      ESP_LOGW(TAG, "ADC calibration conversion failed with error %d, disabling calibration", err);
 | 
			
		||||
      if (this->calibration_handle_ != nullptr) {
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || \
 | 
			
		||||
    USE_ESP32_VARIANT_ESP32S3 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
        adc_cali_delete_scheme_curve_fitting(this->calibration_handle_);
 | 
			
		||||
#else   // Other ESP32 variants use line fitting calibration
 | 
			
		||||
        adc_cali_delete_scheme_line_fitting(this->calibration_handle_);
 | 
			
		||||
#endif  // USE_ESP32_VARIANT_ESP32C3 || ESP32C5 || ESP32C6 || ESP32S3 || ESP32H2
 | 
			
		||||
        this->calibration_handle_ = nullptr;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
  } else if (this->channel2_ != ADC2_CHANNEL_MAX) {
 | 
			
		||||
    adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_12_COMPAT);
 | 
			
		||||
    adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw12);
 | 
			
		||||
    if (raw12 < ADC_MAX) {
 | 
			
		||||
      adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_6);
 | 
			
		||||
      adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw6);
 | 
			
		||||
      if (raw6 < ADC_MAX) {
 | 
			
		||||
        adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_2_5);
 | 
			
		||||
        adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw2);
 | 
			
		||||
        if (raw2 < ADC_MAX) {
 | 
			
		||||
          adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_0);
 | 
			
		||||
          adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw0);
 | 
			
		||||
        }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return final_value * 3.3f / 4095.0f;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
float ADCSensor::sample_autorange_() {
 | 
			
		||||
  // Auto-range mode
 | 
			
		||||
  auto read_atten = [this](adc_atten_t atten) -> std::pair<int, float> {
 | 
			
		||||
    // First reconfigure the attenuation for this reading
 | 
			
		||||
    adc_oneshot_chan_cfg_t config = {
 | 
			
		||||
        .atten = atten,
 | 
			
		||||
        .bitwidth = ADC_BITWIDTH_DEFAULT,
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    esp_err_t err = adc_oneshot_config_channel(this->adc_handle_, this->channel_, &config);
 | 
			
		||||
 | 
			
		||||
    if (err != ESP_OK) {
 | 
			
		||||
      ESP_LOGW(TAG, "Error configuring ADC channel for autorange: %d", err);
 | 
			
		||||
      return {-1, 0.0f};
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Need to recalibrate for the new attenuation
 | 
			
		||||
    if (this->calibration_handle_ != nullptr) {
 | 
			
		||||
      // Delete old calibration handle
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || \
 | 
			
		||||
    USE_ESP32_VARIANT_ESP32S3 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
      adc_cali_delete_scheme_curve_fitting(this->calibration_handle_);
 | 
			
		||||
#else
 | 
			
		||||
      adc_cali_delete_scheme_line_fitting(this->calibration_handle_);
 | 
			
		||||
#endif
 | 
			
		||||
      this->calibration_handle_ = nullptr;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Create new calibration handle for this attenuation
 | 
			
		||||
    adc_cali_handle_t handle = nullptr;
 | 
			
		||||
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || \
 | 
			
		||||
    USE_ESP32_VARIANT_ESP32S3 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
    adc_cali_curve_fitting_config_t cali_config = {};
 | 
			
		||||
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
 | 
			
		||||
    cali_config.chan = this->channel_;
 | 
			
		||||
#endif
 | 
			
		||||
    cali_config.unit_id = this->adc_unit_;
 | 
			
		||||
    cali_config.atten = atten;
 | 
			
		||||
    cali_config.bitwidth = ADC_BITWIDTH_DEFAULT;
 | 
			
		||||
 | 
			
		||||
    err = adc_cali_create_scheme_curve_fitting(&cali_config, &handle);
 | 
			
		||||
#else
 | 
			
		||||
    adc_cali_line_fitting_config_t cali_config = {
 | 
			
		||||
      .unit_id = this->adc_unit_,
 | 
			
		||||
      .atten = atten,
 | 
			
		||||
      .bitwidth = ADC_BITWIDTH_DEFAULT,
 | 
			
		||||
#if !defined(USE_ESP32_VARIANT_ESP32S2)
 | 
			
		||||
      .default_vref = 1100,
 | 
			
		||||
#endif
 | 
			
		||||
    };
 | 
			
		||||
    err = adc_cali_create_scheme_line_fitting(&cali_config, &handle);
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
    int raw;
 | 
			
		||||
    err = adc_oneshot_read(this->adc_handle_, this->channel_, &raw);
 | 
			
		||||
 | 
			
		||||
    if (err != ESP_OK) {
 | 
			
		||||
      ESP_LOGW(TAG, "ADC read failed in autorange with error %d", err);
 | 
			
		||||
      if (handle != nullptr) {
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || \
 | 
			
		||||
    USE_ESP32_VARIANT_ESP32S3 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
        adc_cali_delete_scheme_curve_fitting(handle);
 | 
			
		||||
#else
 | 
			
		||||
        adc_cali_delete_scheme_line_fitting(handle);
 | 
			
		||||
#endif
 | 
			
		||||
      }
 | 
			
		||||
      return {-1, 0.0f};
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    float voltage = 0.0f;
 | 
			
		||||
    if (handle != nullptr) {
 | 
			
		||||
      int voltage_mv;
 | 
			
		||||
      err = adc_cali_raw_to_voltage(handle, raw, &voltage_mv);
 | 
			
		||||
      if (err == ESP_OK) {
 | 
			
		||||
        voltage = voltage_mv / 1000.0f;
 | 
			
		||||
      } else {
 | 
			
		||||
        voltage = raw * 3.3f / 4095.0f;
 | 
			
		||||
      }
 | 
			
		||||
      // Clean up calibration handle
 | 
			
		||||
#if USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C5 || USE_ESP32_VARIANT_ESP32C6 || \
 | 
			
		||||
    USE_ESP32_VARIANT_ESP32S3 || USE_ESP32_VARIANT_ESP32H2
 | 
			
		||||
      adc_cali_delete_scheme_curve_fitting(handle);
 | 
			
		||||
#else
 | 
			
		||||
      adc_cali_delete_scheme_line_fitting(handle);
 | 
			
		||||
#endif
 | 
			
		||||
    } else {
 | 
			
		||||
      voltage = raw * 3.3f / 4095.0f;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return {raw, voltage};
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  auto [raw12, mv12] = read_atten(ADC_ATTEN_DB_12);
 | 
			
		||||
  if (raw12 == -1) {
 | 
			
		||||
    ESP_LOGE(TAG, "Failed to read ADC in autorange mode");
 | 
			
		||||
    return NAN;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  int raw6 = 4095, raw2 = 4095, raw0 = 4095;
 | 
			
		||||
  float mv6 = 0, mv2 = 0, mv0 = 0;
 | 
			
		||||
 | 
			
		||||
  if (raw12 < 4095) {
 | 
			
		||||
    auto [raw6_val, mv6_val] = read_atten(ADC_ATTEN_DB_6);
 | 
			
		||||
    raw6 = raw6_val;
 | 
			
		||||
    mv6 = mv6_val;
 | 
			
		||||
 | 
			
		||||
    if (raw6 < 4095 && raw6 != -1) {
 | 
			
		||||
      auto [raw2_val, mv2_val] = read_atten(ADC_ATTEN_DB_2_5);
 | 
			
		||||
      raw2 = raw2_val;
 | 
			
		||||
      mv2 = mv2_val;
 | 
			
		||||
 | 
			
		||||
      if (raw2 < 4095 && raw2 != -1) {
 | 
			
		||||
        auto [raw0_val, mv0_val] = read_atten(ADC_ATTEN_DB_0);
 | 
			
		||||
        raw0 = raw0_val;
 | 
			
		||||
        mv0 = mv0_val;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
@@ -147,19 +324,19 @@ float ADCSensor::sample() {
 | 
			
		||||
    return NAN;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  uint32_t mv12 = esp_adc_cal_raw_to_voltage(raw12, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_12_COMPAT]);
 | 
			
		||||
  uint32_t mv6 = esp_adc_cal_raw_to_voltage(raw6, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_6]);
 | 
			
		||||
  uint32_t mv2 = esp_adc_cal_raw_to_voltage(raw2, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_2_5]);
 | 
			
		||||
  uint32_t mv0 = esp_adc_cal_raw_to_voltage(raw0, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_0]);
 | 
			
		||||
 | 
			
		||||
  uint32_t c12 = std::min(raw12, ADC_HALF);
 | 
			
		||||
  uint32_t c6 = ADC_HALF - std::abs(raw6 - ADC_HALF);
 | 
			
		||||
  uint32_t c2 = ADC_HALF - std::abs(raw2 - ADC_HALF);
 | 
			
		||||
  uint32_t c0 = std::min(ADC_MAX - raw0, ADC_HALF);
 | 
			
		||||
  const int adc_half = 2048;
 | 
			
		||||
  uint32_t c12 = std::min(raw12, adc_half);
 | 
			
		||||
  uint32_t c6 = adc_half - std::abs(raw6 - adc_half);
 | 
			
		||||
  uint32_t c2 = adc_half - std::abs(raw2 - adc_half);
 | 
			
		||||
  uint32_t c0 = std::min(4095 - raw0, adc_half);
 | 
			
		||||
  uint32_t csum = c12 + c6 + c2 + c0;
 | 
			
		||||
 | 
			
		||||
  uint32_t mv_scaled = (mv12 * c12) + (mv6 * c6) + (mv2 * c2) + (mv0 * c0);
 | 
			
		||||
  return mv_scaled / (float) (csum * 1000U);
 | 
			
		||||
  if (csum == 0) {
 | 
			
		||||
    ESP_LOGE(TAG, "Invalid weight sum in autorange calculation");
 | 
			
		||||
    return NAN;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return (mv12 * c12 + mv6 * c6 + mv2 * c2 + mv0 * c0) / csum;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
 
 | 
			
		||||
@@ -17,7 +17,6 @@ namespace adc {
 | 
			
		||||
static const char *const TAG = "adc.esp8266";
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup for '%s'", this->get_name().c_str());
 | 
			
		||||
#ifndef USE_ADC_SENSOR_VCC
 | 
			
		||||
  this->pin_->setup();
 | 
			
		||||
#endif
 | 
			
		||||
@@ -56,8 +55,6 @@ float ADCSensor::sample() {
 | 
			
		||||
  return aggr.aggregate() / 1024.0f;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
std::string ADCSensor::unique_id() { return get_mac_address() + "-adc"; }
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,6 @@ namespace adc {
 | 
			
		||||
static const char *const TAG = "adc.libretiny";
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup for '%s'", this->get_name().c_str());
 | 
			
		||||
#ifndef USE_ADC_SENSOR_VCC
 | 
			
		||||
  this->pin_->setup();
 | 
			
		||||
#endif  // !USE_ADC_SENSOR_VCC
 | 
			
		||||
 
 | 
			
		||||
@@ -14,7 +14,6 @@ namespace adc {
 | 
			
		||||
static const char *const TAG = "adc.rp2040";
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup for '%s'", this->get_name().c_str());
 | 
			
		||||
  static bool initialized = false;
 | 
			
		||||
  if (!initialized) {
 | 
			
		||||
    adc_init();
 | 
			
		||||
 
 | 
			
		||||
@@ -10,13 +10,11 @@ from esphome.const import (
 | 
			
		||||
    CONF_NUMBER,
 | 
			
		||||
    CONF_PIN,
 | 
			
		||||
    CONF_RAW,
 | 
			
		||||
    CONF_WIFI,
 | 
			
		||||
    DEVICE_CLASS_VOLTAGE,
 | 
			
		||||
    STATE_CLASS_MEASUREMENT,
 | 
			
		||||
    UNIT_VOLT,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
import esphome.final_validate as fv
 | 
			
		||||
 | 
			
		||||
from . import (
 | 
			
		||||
    ATTENUATION_MODES,
 | 
			
		||||
@@ -24,6 +22,7 @@ from . import (
 | 
			
		||||
    ESP32_VARIANT_ADC2_PIN_TO_CHANNEL,
 | 
			
		||||
    SAMPLING_MODES,
 | 
			
		||||
    adc_ns,
 | 
			
		||||
    adc_unit_t,
 | 
			
		||||
    validate_adc_pin,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
@@ -57,21 +56,6 @@ def validate_config(config):
 | 
			
		||||
    return config
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def final_validate_config(config):
 | 
			
		||||
    if CORE.is_esp32:
 | 
			
		||||
        variant = get_esp32_variant()
 | 
			
		||||
        if (
 | 
			
		||||
            CONF_WIFI in fv.full_config.get()
 | 
			
		||||
            and config[CONF_PIN][CONF_NUMBER]
 | 
			
		||||
            in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant]
 | 
			
		||||
        ):
 | 
			
		||||
            raise cv.Invalid(
 | 
			
		||||
                f"{variant} doesn't support ADC on this pin when Wi-Fi is configured"
 | 
			
		||||
            )
 | 
			
		||||
 | 
			
		||||
    return config
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
ADCSensor = adc_ns.class_(
 | 
			
		||||
    "ADCSensor", sensor.Sensor, cg.PollingComponent, voltage_sampler.VoltageSampler
 | 
			
		||||
)
 | 
			
		||||
@@ -99,8 +83,6 @@ CONFIG_SCHEMA = cv.All(
 | 
			
		||||
    validate_config,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
FINAL_VALIDATE_SCHEMA = final_validate_config
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    var = cg.new_Pvariable(config[CONF_ID])
 | 
			
		||||
@@ -119,13 +101,13 @@ async def to_code(config):
 | 
			
		||||
    cg.add(var.set_sample_count(config[CONF_SAMPLES]))
 | 
			
		||||
    cg.add(var.set_sampling_mode(config[CONF_SAMPLING_MODE]))
 | 
			
		||||
 | 
			
		||||
    if attenuation := config.get(CONF_ATTENUATION):
 | 
			
		||||
        if attenuation == "auto":
 | 
			
		||||
            cg.add(var.set_autorange(cg.global_ns.true))
 | 
			
		||||
        else:
 | 
			
		||||
            cg.add(var.set_attenuation(attenuation))
 | 
			
		||||
 | 
			
		||||
    if CORE.is_esp32:
 | 
			
		||||
        if attenuation := config.get(CONF_ATTENUATION):
 | 
			
		||||
            if attenuation == "auto":
 | 
			
		||||
                cg.add(var.set_autorange(cg.global_ns.true))
 | 
			
		||||
            else:
 | 
			
		||||
                cg.add(var.set_attenuation(attenuation))
 | 
			
		||||
 | 
			
		||||
        variant = get_esp32_variant()
 | 
			
		||||
        pin_num = config[CONF_PIN][CONF_NUMBER]
 | 
			
		||||
        if (
 | 
			
		||||
@@ -133,10 +115,10 @@ async def to_code(config):
 | 
			
		||||
            and pin_num in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant]
 | 
			
		||||
        ):
 | 
			
		||||
            chan = ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant][pin_num]
 | 
			
		||||
            cg.add(var.set_channel1(chan))
 | 
			
		||||
            cg.add(var.set_channel(adc_unit_t.ADC_UNIT_1, chan))
 | 
			
		||||
        elif (
 | 
			
		||||
            variant in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL
 | 
			
		||||
            and pin_num in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant]
 | 
			
		||||
        ):
 | 
			
		||||
            chan = ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant][pin_num]
 | 
			
		||||
            cg.add(var.set_channel2(chan))
 | 
			
		||||
            cg.add(var.set_channel(adc_unit_t.ADC_UNIT_2, chan))
 | 
			
		||||
 
 | 
			
		||||
@@ -8,10 +8,7 @@ static const char *const TAG = "adc128s102";
 | 
			
		||||
 | 
			
		||||
float ADC128S102::get_setup_priority() const { return setup_priority::HARDWARE; }
 | 
			
		||||
 | 
			
		||||
void ADC128S102::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  this->spi_setup();
 | 
			
		||||
}
 | 
			
		||||
void ADC128S102::setup() { this->spi_setup(); }
 | 
			
		||||
 | 
			
		||||
void ADC128S102::dump_config() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "ADC128S102:");
 | 
			
		||||
 
 | 
			
		||||
@@ -85,8 +85,6 @@ class ADE7880 : public i2c::I2CDevice, public PollingComponent {
 | 
			
		||||
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  ADE7880Store store_{};
 | 
			
		||||
  InternalGPIOPin *irq0_pin_{nullptr};
 | 
			
		||||
 
 | 
			
		||||
@@ -10,7 +10,6 @@ static const uint8_t ADS1115_REGISTER_CONVERSION = 0x00;
 | 
			
		||||
static const uint8_t ADS1115_REGISTER_CONFIG = 0x01;
 | 
			
		||||
 | 
			
		||||
void ADS1115Component::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  uint16_t value;
 | 
			
		||||
  if (!this->read_byte_16(ADS1115_REGISTER_CONVERSION, &value)) {
 | 
			
		||||
    this->mark_failed();
 | 
			
		||||
 
 | 
			
		||||
@@ -49,7 +49,6 @@ class ADS1115Component : public Component, public i2c::I2CDevice {
 | 
			
		||||
  void setup() override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  /// HARDWARE_LATE setup priority
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
  void set_continuous_mode(bool continuous_mode) { continuous_mode_ = continuous_mode; }
 | 
			
		||||
 | 
			
		||||
  /// Helper method to request a measurement from a sensor.
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,6 @@ static const char *const TAG = "ads1118";
 | 
			
		||||
static const uint8_t ADS1118_DATA_RATE_860_SPS = 0b111;
 | 
			
		||||
 | 
			
		||||
void ADS1118::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  this->spi_setup();
 | 
			
		||||
 | 
			
		||||
  this->config_ = 0;
 | 
			
		||||
 
 | 
			
		||||
@@ -34,7 +34,6 @@ class ADS1118 : public Component,
 | 
			
		||||
  ADS1118() = default;
 | 
			
		||||
  void setup() override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
  /// Helper method to request a measurement from a sensor.
 | 
			
		||||
  float request_measurement(ADS1118Multiplexer multiplexer, ADS1118Gain gain, bool temperature_mode);
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -24,8 +24,6 @@ static const uint16_t ZP_CURRENT = 0x0000;
 | 
			
		||||
static const uint16_t ZP_DEFAULT = 0xFFFF;
 | 
			
		||||
 | 
			
		||||
void AGS10Component::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
 | 
			
		||||
  auto version = this->read_version_();
 | 
			
		||||
  if (version) {
 | 
			
		||||
    ESP_LOGD(TAG, "AGS10 Sensor Version: 0x%02X", *version);
 | 
			
		||||
@@ -45,8 +43,6 @@ void AGS10Component::setup() {
 | 
			
		||||
  } else {
 | 
			
		||||
    ESP_LOGE(TAG, "AGS10 Sensor Resistance: unknown");
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  ESP_LOGD(TAG, "Sensor initialized");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AGS10Component::update() {
 | 
			
		||||
 
 | 
			
		||||
@@ -31,8 +31,6 @@ class AGS10Component : public PollingComponent, public i2c::I2CDevice {
 | 
			
		||||
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * Modifies target address of AGS10.
 | 
			
		||||
   *
 | 
			
		||||
 
 | 
			
		||||
@@ -38,8 +38,6 @@ static const uint8_t AHT10_STATUS_BUSY = 0x80;
 | 
			
		||||
static const float AHT10_DIVISOR = 1048576.0f;  // 2^20, used for temperature and humidity calculations
 | 
			
		||||
 | 
			
		||||
void AHT10Component::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
 | 
			
		||||
  if (this->write(AHT10_SOFTRESET_CMD, sizeof(AHT10_SOFTRESET_CMD)) != i2c::ERROR_OK) {
 | 
			
		||||
    ESP_LOGE(TAG, "Reset failed");
 | 
			
		||||
  }
 | 
			
		||||
@@ -80,8 +78,6 @@ void AHT10Component::setup() {
 | 
			
		||||
    this->mark_failed();
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  ESP_LOGV(TAG, "Initialization complete");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AHT10Component::restart_read_() {
 | 
			
		||||
 
 | 
			
		||||
@@ -17,8 +17,6 @@ static const char *const TAG = "aic3204";
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
void AIC3204::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
 | 
			
		||||
  // Set register page to 0
 | 
			
		||||
  ERROR_CHECK(this->write_byte(AIC3204_PAGE_CTRL, 0x00), "Set page 0 failed");
 | 
			
		||||
  // Initiate SW reset (PLL is powered off as part of reset)
 | 
			
		||||
 
 | 
			
		||||
@@ -66,7 +66,6 @@ class AIC3204 : public audio_dac::AudioDac, public Component, public i2c::I2CDev
 | 
			
		||||
 public:
 | 
			
		||||
  void setup() override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
 | 
			
		||||
  bool set_mute_off() override;
 | 
			
		||||
  bool set_mute_on() override;
 | 
			
		||||
 
 | 
			
		||||
@@ -1 +1 @@
 | 
			
		||||
CODEOWNERS = ["@jeromelaban"]
 | 
			
		||||
CODEOWNERS = ["@jeromelaban", "@precurse"]
 | 
			
		||||
 
 | 
			
		||||
@@ -73,11 +73,29 @@ void AirthingsWavePlus::dump_config() {
 | 
			
		||||
  LOG_SENSOR("  ", "Illuminance", this->illuminance_sensor_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AirthingsWavePlus::AirthingsWavePlus() {
 | 
			
		||||
  this->service_uuid_ = espbt::ESPBTUUID::from_raw(SERVICE_UUID);
 | 
			
		||||
  this->sensors_data_characteristic_uuid_ = espbt::ESPBTUUID::from_raw(CHARACTERISTIC_UUID);
 | 
			
		||||
void AirthingsWavePlus::setup() {
 | 
			
		||||
  const char *service_uuid;
 | 
			
		||||
  const char *characteristic_uuid;
 | 
			
		||||
  const char *access_control_point_characteristic_uuid;
 | 
			
		||||
 | 
			
		||||
  // Change UUIDs for Wave Radon Gen2
 | 
			
		||||
  switch (this->wave_device_type_) {
 | 
			
		||||
    case WaveDeviceType::WAVE_GEN2:
 | 
			
		||||
      service_uuid = SERVICE_UUID_WAVE_RADON_GEN2;
 | 
			
		||||
      characteristic_uuid = CHARACTERISTIC_UUID_WAVE_RADON_GEN2;
 | 
			
		||||
      access_control_point_characteristic_uuid = ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID_WAVE_RADON_GEN2;
 | 
			
		||||
      break;
 | 
			
		||||
    default:
 | 
			
		||||
      // Wave Plus
 | 
			
		||||
      service_uuid = SERVICE_UUID;
 | 
			
		||||
      characteristic_uuid = CHARACTERISTIC_UUID;
 | 
			
		||||
      access_control_point_characteristic_uuid = ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->service_uuid_ = espbt::ESPBTUUID::from_raw(service_uuid);
 | 
			
		||||
  this->sensors_data_characteristic_uuid_ = espbt::ESPBTUUID::from_raw(characteristic_uuid);
 | 
			
		||||
  this->access_control_point_characteristic_uuid_ =
 | 
			
		||||
      espbt::ESPBTUUID::from_raw(ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID);
 | 
			
		||||
      espbt::ESPBTUUID::from_raw(access_control_point_characteristic_uuid);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace airthings_wave_plus
 | 
			
		||||
 
 | 
			
		||||
@@ -9,13 +9,20 @@ namespace airthings_wave_plus {
 | 
			
		||||
 | 
			
		||||
namespace espbt = esphome::esp32_ble_tracker;
 | 
			
		||||
 | 
			
		||||
enum WaveDeviceType : uint8_t { WAVE_PLUS = 0, WAVE_GEN2 = 1 };
 | 
			
		||||
 | 
			
		||||
static const char *const SERVICE_UUID = "b42e1c08-ade7-11e4-89d3-123b93f75cba";
 | 
			
		||||
static const char *const CHARACTERISTIC_UUID = "b42e2a68-ade7-11e4-89d3-123b93f75cba";
 | 
			
		||||
static const char *const ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID = "b42e2d06-ade7-11e4-89d3-123b93f75cba";
 | 
			
		||||
 | 
			
		||||
static const char *const SERVICE_UUID_WAVE_RADON_GEN2 = "b42e4a8e-ade7-11e4-89d3-123b93f75cba";
 | 
			
		||||
static const char *const CHARACTERISTIC_UUID_WAVE_RADON_GEN2 = "b42e4dcc-ade7-11e4-89d3-123b93f75cba";
 | 
			
		||||
static const char *const ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID_WAVE_RADON_GEN2 =
 | 
			
		||||
    "b42e50d8-ade7-11e4-89d3-123b93f75cba";
 | 
			
		||||
 | 
			
		||||
class AirthingsWavePlus : public airthings_wave_base::AirthingsWaveBase {
 | 
			
		||||
 public:
 | 
			
		||||
  AirthingsWavePlus();
 | 
			
		||||
  void setup() override;
 | 
			
		||||
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
 | 
			
		||||
@@ -23,12 +30,14 @@ class AirthingsWavePlus : public airthings_wave_base::AirthingsWaveBase {
 | 
			
		||||
  void set_radon_long_term(sensor::Sensor *radon_long_term) { radon_long_term_sensor_ = radon_long_term; }
 | 
			
		||||
  void set_co2(sensor::Sensor *co2) { co2_sensor_ = co2; }
 | 
			
		||||
  void set_illuminance(sensor::Sensor *illuminance) { illuminance_sensor_ = illuminance; }
 | 
			
		||||
  void set_device_type(WaveDeviceType wave_device_type) { wave_device_type_ = wave_device_type; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool is_valid_radon_value_(uint16_t radon);
 | 
			
		||||
  bool is_valid_co2_value_(uint16_t co2);
 | 
			
		||||
 | 
			
		||||
  void read_sensors(uint8_t *raw_value, uint16_t value_len) override;
 | 
			
		||||
  WaveDeviceType wave_device_type_{WaveDeviceType::WAVE_PLUS};
 | 
			
		||||
 | 
			
		||||
  sensor::Sensor *radon_sensor_{nullptr};
 | 
			
		||||
  sensor::Sensor *radon_long_term_sensor_{nullptr};
 | 
			
		||||
 
 | 
			
		||||
@@ -7,6 +7,7 @@ from esphome.const import (
 | 
			
		||||
    CONF_ILLUMINANCE,
 | 
			
		||||
    CONF_RADON,
 | 
			
		||||
    CONF_RADON_LONG_TERM,
 | 
			
		||||
    CONF_TVOC,
 | 
			
		||||
    DEVICE_CLASS_CARBON_DIOXIDE,
 | 
			
		||||
    DEVICE_CLASS_ILLUMINANCE,
 | 
			
		||||
    ICON_RADIOACTIVE,
 | 
			
		||||
@@ -15,6 +16,7 @@ from esphome.const import (
 | 
			
		||||
    UNIT_LUX,
 | 
			
		||||
    UNIT_PARTS_PER_MILLION,
 | 
			
		||||
)
 | 
			
		||||
from esphome.types import ConfigType
 | 
			
		||||
 | 
			
		||||
DEPENDENCIES = airthings_wave_base.DEPENDENCIES
 | 
			
		||||
 | 
			
		||||
@@ -25,35 +27,59 @@ AirthingsWavePlus = airthings_wave_plus_ns.class_(
 | 
			
		||||
    "AirthingsWavePlus", airthings_wave_base.AirthingsWaveBase
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
CONF_DEVICE_TYPE = "device_type"
 | 
			
		||||
WaveDeviceType = airthings_wave_plus_ns.enum("WaveDeviceType")
 | 
			
		||||
DEVICE_TYPES = {
 | 
			
		||||
    "WAVE_PLUS": WaveDeviceType.WAVE_PLUS,
 | 
			
		||||
    "WAVE_GEN2": WaveDeviceType.WAVE_GEN2,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = airthings_wave_base.BASE_SCHEMA.extend(
 | 
			
		||||
    {
 | 
			
		||||
        cv.GenerateID(): cv.declare_id(AirthingsWavePlus),
 | 
			
		||||
        cv.Optional(CONF_RADON): sensor.sensor_schema(
 | 
			
		||||
            unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
 | 
			
		||||
            icon=ICON_RADIOACTIVE,
 | 
			
		||||
            accuracy_decimals=0,
 | 
			
		||||
            state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
        ),
 | 
			
		||||
        cv.Optional(CONF_RADON_LONG_TERM): sensor.sensor_schema(
 | 
			
		||||
            unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
 | 
			
		||||
            icon=ICON_RADIOACTIVE,
 | 
			
		||||
            accuracy_decimals=0,
 | 
			
		||||
            state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
        ),
 | 
			
		||||
        cv.Optional(CONF_CO2): sensor.sensor_schema(
 | 
			
		||||
            unit_of_measurement=UNIT_PARTS_PER_MILLION,
 | 
			
		||||
            accuracy_decimals=0,
 | 
			
		||||
            device_class=DEVICE_CLASS_CARBON_DIOXIDE,
 | 
			
		||||
            state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
        ),
 | 
			
		||||
        cv.Optional(CONF_ILLUMINANCE): sensor.sensor_schema(
 | 
			
		||||
            unit_of_measurement=UNIT_LUX,
 | 
			
		||||
            accuracy_decimals=0,
 | 
			
		||||
            device_class=DEVICE_CLASS_ILLUMINANCE,
 | 
			
		||||
            state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
        ),
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
def validate_wave_gen2_config(config: ConfigType) -> ConfigType:
 | 
			
		||||
    """Validate that Wave Gen2 devices don't have CO2 or TVOC sensors."""
 | 
			
		||||
    if config[CONF_DEVICE_TYPE] == "WAVE_GEN2":
 | 
			
		||||
        if CONF_CO2 in config:
 | 
			
		||||
            raise cv.Invalid("Wave Gen2 devices do not support CO2 sensor")
 | 
			
		||||
        # Check for TVOC in the base schema config
 | 
			
		||||
        if CONF_TVOC in config:
 | 
			
		||||
            raise cv.Invalid("Wave Gen2 devices do not support TVOC sensor")
 | 
			
		||||
    return config
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = cv.All(
 | 
			
		||||
    airthings_wave_base.BASE_SCHEMA.extend(
 | 
			
		||||
        {
 | 
			
		||||
            cv.GenerateID(): cv.declare_id(AirthingsWavePlus),
 | 
			
		||||
            cv.Optional(CONF_RADON): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
 | 
			
		||||
                icon=ICON_RADIOACTIVE,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_RADON_LONG_TERM): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
 | 
			
		||||
                icon=ICON_RADIOACTIVE,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_CO2): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_PARTS_PER_MILLION,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_CARBON_DIOXIDE,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_ILLUMINANCE): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_LUX,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_ILLUMINANCE,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_DEVICE_TYPE, default="WAVE_PLUS"): cv.enum(
 | 
			
		||||
                DEVICE_TYPES, upper=True
 | 
			
		||||
            ),
 | 
			
		||||
        }
 | 
			
		||||
    ),
 | 
			
		||||
    validate_wave_gen2_config,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@@ -73,3 +99,4 @@ async def to_code(config):
 | 
			
		||||
    if config_illuminance := config.get(CONF_ILLUMINANCE):
 | 
			
		||||
        sens = await sensor.new_sensor(config_illuminance)
 | 
			
		||||
        cg.add(var.set_illuminance(sens))
 | 
			
		||||
    cg.add(var.set_device_type(config[CONF_DEVICE_TYPE]))
 | 
			
		||||
 
 | 
			
		||||
@@ -14,8 +14,8 @@ from esphome.const import (
 | 
			
		||||
    CONF_WEB_SERVER,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE, coroutine_with_priority
 | 
			
		||||
from esphome.core.entity_helpers import entity_duplicate_validator, setup_entity
 | 
			
		||||
from esphome.cpp_generator import MockObjClass
 | 
			
		||||
from esphome.cpp_helpers import setup_entity
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@grahambrown11", "@hwstar"]
 | 
			
		||||
IS_PLATFORM_COMPONENT = True
 | 
			
		||||
@@ -149,6 +149,9 @@ _ALARM_CONTROL_PANEL_SCHEMA = (
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
_ALARM_CONTROL_PANEL_SCHEMA.add_extra(entity_duplicate_validator("alarm_control_panel"))
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def alarm_control_panel_schema(
 | 
			
		||||
    class_: MockObjClass,
 | 
			
		||||
    *,
 | 
			
		||||
@@ -190,7 +193,7 @@ ALARM_CONTROL_PANEL_CONDITION_SCHEMA = maybe_simple_id(
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def setup_alarm_control_panel_core_(var, config):
 | 
			
		||||
    await setup_entity(var, config)
 | 
			
		||||
    await setup_entity(var, config, "alarm_control_panel")
 | 
			
		||||
    for conf in config.get(CONF_ON_STATE, []):
 | 
			
		||||
        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
 | 
			
		||||
        await automation.build_automation(trigger, [], conf)
 | 
			
		||||
 
 | 
			
		||||
@@ -41,7 +41,6 @@ class Alpha3 : public esphome::ble_client::BLEClientNode, public PollingComponen
 | 
			
		||||
  void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
 | 
			
		||||
                           esp_ble_gattc_cb_param_t *param) override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
  void set_flow_sensor(sensor::Sensor *sensor) { this->flow_sensor_ = sensor; }
 | 
			
		||||
  void set_head_sensor(sensor::Sensor *sensor) { this->head_sensor_ = sensor; }
 | 
			
		||||
  void set_power_sensor(sensor::Sensor *sensor) { this->power_sensor_ = sensor; }
 | 
			
		||||
 
 | 
			
		||||
@@ -90,8 +90,6 @@ bool AM2315C::convert_(uint8_t *data, float &humidity, float &temperature) {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AM2315C::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
 | 
			
		||||
  // get status
 | 
			
		||||
  uint8_t status = 0;
 | 
			
		||||
  if (this->read(&status, 1) != i2c::ERROR_OK) {
 | 
			
		||||
 
 | 
			
		||||
@@ -34,7 +34,6 @@ void AM2320Component::update() {
 | 
			
		||||
  this->status_clear_warning();
 | 
			
		||||
}
 | 
			
		||||
void AM2320Component::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  uint8_t data[8];
 | 
			
		||||
  data[0] = 0;
 | 
			
		||||
  data[1] = 4;
 | 
			
		||||
 
 | 
			
		||||
@@ -22,7 +22,6 @@ class Am43Component : public cover::Cover, public esphome::ble_client::BLEClient
 | 
			
		||||
  void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
 | 
			
		||||
                           esp_ble_gattc_cb_param_t *param) override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
  cover::CoverTraits get_traits() override;
 | 
			
		||||
  void set_pin(uint16_t pin) { this->pin_ = pin; }
 | 
			
		||||
  void set_invert_position(bool invert_position) { this->invert_position_ = invert_position; }
 | 
			
		||||
 
 | 
			
		||||
@@ -22,7 +22,6 @@ class Am43 : public esphome::ble_client::BLEClientNode, public PollingComponent
 | 
			
		||||
  void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
 | 
			
		||||
                           esp_ble_gattc_cb_param_t *param) override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
  void set_battery(sensor::Sensor *battery) { battery_ = battery; }
 | 
			
		||||
  void set_illuminance(sensor::Sensor *illuminance) { illuminance_ = illuminance; }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -12,8 +12,6 @@ class AnalogThresholdBinarySensor : public Component, public binary_sensor::Bina
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  void setup() override;
 | 
			
		||||
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
 | 
			
		||||
  void set_sensor(sensor::Sensor *analog_sensor);
 | 
			
		||||
  template<typename T> void set_upper_threshold(T upper_threshold) { this->upper_threshold_ = upper_threshold; }
 | 
			
		||||
  template<typename T> void set_lower_threshold(T lower_threshold) { this->lower_threshold_ = lower_threshold; }
 | 
			
		||||
 
 | 
			
		||||
@@ -17,7 +17,11 @@ void Anova::setup() {
 | 
			
		||||
  this->current_request_ = 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void Anova::loop() {}
 | 
			
		||||
void Anova::loop() {
 | 
			
		||||
  // Parent BLEClientNode has a loop() method, but this component uses
 | 
			
		||||
  // polling via update() and BLE callbacks so loop isn't needed
 | 
			
		||||
  this->disable_loop();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void Anova::control(const ClimateCall &call) {
 | 
			
		||||
  if (call.get_mode().has_value()) {
 | 
			
		||||
 
 | 
			
		||||
@@ -26,7 +26,6 @@ class Anova : public climate::Climate, public esphome::ble_client::BLEClientNode
 | 
			
		||||
  void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
 | 
			
		||||
                           esp_ble_gattc_cb_param_t *param) override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  float get_setup_priority() const override { return setup_priority::DATA; }
 | 
			
		||||
  climate::ClimateTraits traits() override {
 | 
			
		||||
    auto traits = climate::ClimateTraits();
 | 
			
		||||
    traits.set_supports_current_temperature(true);
 | 
			
		||||
 
 | 
			
		||||
@@ -54,8 +54,6 @@ enum {  // APDS9306 registers
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
void APDS9306::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
 | 
			
		||||
  uint8_t id;
 | 
			
		||||
  if (!this->read_byte(APDS9306_PART_ID, &id)) {  // Part ID register
 | 
			
		||||
    this->error_code_ = COMMUNICATION_FAILED;
 | 
			
		||||
@@ -86,8 +84,6 @@ void APDS9306::setup() {
 | 
			
		||||
 | 
			
		||||
  // Set to active mode
 | 
			
		||||
  APDS9306_WRITE_BYTE(APDS9306_MAIN_CTRL, 0x02);
 | 
			
		||||
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "APDS9306 setup complete");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void APDS9306::dump_config() {
 | 
			
		||||
 
 | 
			
		||||
@@ -15,7 +15,6 @@ static const char *const TAG = "apds9960";
 | 
			
		||||
#define APDS9960_WRITE_BYTE(reg, value) APDS9960_ERROR_CHECK(this->write_byte(reg, value));
 | 
			
		||||
 | 
			
		||||
void APDS9960::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  uint8_t id;
 | 
			
		||||
  if (!this->read_byte(0x92, &id)) {  // ID register
 | 
			
		||||
    this->error_code_ = COMMUNICATION_FAILED;
 | 
			
		||||
@@ -23,7 +22,7 @@ void APDS9960::setup() {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (id != 0xAB && id != 0x9C && id != 0xA8) {  // APDS9960 all should have one of these IDs
 | 
			
		||||
  if (id != 0xAB && id != 0x9C && id != 0xA8 && id != 0x9E) {  // APDS9960 all should have one of these IDs
 | 
			
		||||
    this->error_code_ = WRONG_ID;
 | 
			
		||||
    this->mark_failed();
 | 
			
		||||
    return;
 | 
			
		||||
 
 | 
			
		||||
@@ -3,6 +3,7 @@ import base64
 | 
			
		||||
from esphome import automation
 | 
			
		||||
from esphome.automation import Condition
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
from esphome.config_helpers import get_logger_level
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    CONF_ACTION,
 | 
			
		||||
@@ -23,8 +24,9 @@ from esphome.const import (
 | 
			
		||||
    CONF_TRIGGER_ID,
 | 
			
		||||
    CONF_VARIABLES,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import coroutine_with_priority
 | 
			
		||||
from esphome.core import CORE, coroutine_with_priority
 | 
			
		||||
 | 
			
		||||
DOMAIN = "api"
 | 
			
		||||
DEPENDENCIES = ["network"]
 | 
			
		||||
AUTO_LOAD = ["socket"]
 | 
			
		||||
CODEOWNERS = ["@OttoWinter"]
 | 
			
		||||
@@ -50,6 +52,9 @@ SERVICE_ARG_NATIVE_TYPES = {
 | 
			
		||||
}
 | 
			
		||||
CONF_ENCRYPTION = "encryption"
 | 
			
		||||
CONF_BATCH_DELAY = "batch_delay"
 | 
			
		||||
CONF_CUSTOM_SERVICES = "custom_services"
 | 
			
		||||
CONF_HOMEASSISTANT_SERVICES = "homeassistant_services"
 | 
			
		||||
CONF_HOMEASSISTANT_STATES = "homeassistant_states"
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def validate_encryption_key(value):
 | 
			
		||||
@@ -110,9 +115,13 @@ CONFIG_SCHEMA = cv.All(
 | 
			
		||||
            ): ACTIONS_SCHEMA,
 | 
			
		||||
            cv.Exclusive(CONF_ACTIONS, group_of_exclusion=CONF_ACTIONS): ACTIONS_SCHEMA,
 | 
			
		||||
            cv.Optional(CONF_ENCRYPTION): _encryption_schema,
 | 
			
		||||
            cv.Optional(
 | 
			
		||||
                CONF_BATCH_DELAY, default="100ms"
 | 
			
		||||
            ): cv.positive_time_period_milliseconds,
 | 
			
		||||
            cv.Optional(CONF_BATCH_DELAY, default="100ms"): cv.All(
 | 
			
		||||
                cv.positive_time_period_milliseconds,
 | 
			
		||||
                cv.Range(max=cv.TimePeriod(milliseconds=65535)),
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_CUSTOM_SERVICES, default=False): cv.boolean,
 | 
			
		||||
            cv.Optional(CONF_HOMEASSISTANT_SERVICES, default=False): cv.boolean,
 | 
			
		||||
            cv.Optional(CONF_HOMEASSISTANT_STATES, default=False): cv.boolean,
 | 
			
		||||
            cv.Optional(CONF_ON_CLIENT_CONNECTED): automation.validate_automation(
 | 
			
		||||
                single=True
 | 
			
		||||
            ),
 | 
			
		||||
@@ -131,27 +140,41 @@ async def to_code(config):
 | 
			
		||||
    await cg.register_component(var, config)
 | 
			
		||||
 | 
			
		||||
    cg.add(var.set_port(config[CONF_PORT]))
 | 
			
		||||
    cg.add(var.set_password(config[CONF_PASSWORD]))
 | 
			
		||||
    if config[CONF_PASSWORD]:
 | 
			
		||||
        cg.add_define("USE_API_PASSWORD")
 | 
			
		||||
        cg.add(var.set_password(config[CONF_PASSWORD]))
 | 
			
		||||
    cg.add(var.set_reboot_timeout(config[CONF_REBOOT_TIMEOUT]))
 | 
			
		||||
    cg.add(var.set_batch_delay(config[CONF_BATCH_DELAY]))
 | 
			
		||||
 | 
			
		||||
    for conf in config.get(CONF_ACTIONS, []):
 | 
			
		||||
        template_args = []
 | 
			
		||||
        func_args = []
 | 
			
		||||
        service_arg_names = []
 | 
			
		||||
        for name, var_ in conf[CONF_VARIABLES].items():
 | 
			
		||||
            native = SERVICE_ARG_NATIVE_TYPES[var_]
 | 
			
		||||
            template_args.append(native)
 | 
			
		||||
            func_args.append((native, name))
 | 
			
		||||
            service_arg_names.append(name)
 | 
			
		||||
        templ = cg.TemplateArguments(*template_args)
 | 
			
		||||
        trigger = cg.new_Pvariable(
 | 
			
		||||
            conf[CONF_TRIGGER_ID], templ, conf[CONF_ACTION], service_arg_names
 | 
			
		||||
        )
 | 
			
		||||
        cg.add(var.register_user_service(trigger))
 | 
			
		||||
        await automation.build_automation(trigger, func_args, conf)
 | 
			
		||||
    # Set USE_API_SERVICES if any services are enabled
 | 
			
		||||
    if config.get(CONF_ACTIONS) or config[CONF_CUSTOM_SERVICES]:
 | 
			
		||||
        cg.add_define("USE_API_SERVICES")
 | 
			
		||||
 | 
			
		||||
    if config[CONF_HOMEASSISTANT_SERVICES]:
 | 
			
		||||
        cg.add_define("USE_API_HOMEASSISTANT_SERVICES")
 | 
			
		||||
 | 
			
		||||
    if config[CONF_HOMEASSISTANT_STATES]:
 | 
			
		||||
        cg.add_define("USE_API_HOMEASSISTANT_STATES")
 | 
			
		||||
 | 
			
		||||
    if actions := config.get(CONF_ACTIONS, []):
 | 
			
		||||
        for conf in actions:
 | 
			
		||||
            template_args = []
 | 
			
		||||
            func_args = []
 | 
			
		||||
            service_arg_names = []
 | 
			
		||||
            for name, var_ in conf[CONF_VARIABLES].items():
 | 
			
		||||
                native = SERVICE_ARG_NATIVE_TYPES[var_]
 | 
			
		||||
                template_args.append(native)
 | 
			
		||||
                func_args.append((native, name))
 | 
			
		||||
                service_arg_names.append(name)
 | 
			
		||||
            templ = cg.TemplateArguments(*template_args)
 | 
			
		||||
            trigger = cg.new_Pvariable(
 | 
			
		||||
                conf[CONF_TRIGGER_ID], templ, conf[CONF_ACTION], service_arg_names
 | 
			
		||||
            )
 | 
			
		||||
            cg.add(var.register_user_service(trigger))
 | 
			
		||||
            await automation.build_automation(trigger, func_args, conf)
 | 
			
		||||
 | 
			
		||||
    if CONF_ON_CLIENT_CONNECTED in config:
 | 
			
		||||
        cg.add_define("USE_API_CLIENT_CONNECTED_TRIGGER")
 | 
			
		||||
        await automation.build_automation(
 | 
			
		||||
            var.get_client_connected_trigger(),
 | 
			
		||||
            [(cg.std_string, "client_info"), (cg.std_string, "client_address")],
 | 
			
		||||
@@ -159,6 +182,7 @@ async def to_code(config):
 | 
			
		||||
        )
 | 
			
		||||
 | 
			
		||||
    if CONF_ON_CLIENT_DISCONNECTED in config:
 | 
			
		||||
        cg.add_define("USE_API_CLIENT_DISCONNECTED_TRIGGER")
 | 
			
		||||
        await automation.build_automation(
 | 
			
		||||
            var.get_client_disconnected_trigger(),
 | 
			
		||||
            [(cg.std_string, "client_info"), (cg.std_string, "client_address")],
 | 
			
		||||
@@ -177,7 +201,7 @@ async def to_code(config):
 | 
			
		||||
            # and plaintext disabled. Only a factory reset can remove it.
 | 
			
		||||
            cg.add_define("USE_API_PLAINTEXT")
 | 
			
		||||
        cg.add_define("USE_API_NOISE")
 | 
			
		||||
        cg.add_library("esphome/noise-c", "0.1.6")
 | 
			
		||||
        cg.add_library("esphome/noise-c", "0.1.10")
 | 
			
		||||
    else:
 | 
			
		||||
        cg.add_define("USE_API_PLAINTEXT")
 | 
			
		||||
 | 
			
		||||
@@ -221,6 +245,7 @@ HOMEASSISTANT_ACTION_ACTION_SCHEMA = cv.All(
 | 
			
		||||
    HOMEASSISTANT_ACTION_ACTION_SCHEMA,
 | 
			
		||||
)
 | 
			
		||||
async def homeassistant_service_to_code(config, action_id, template_arg, args):
 | 
			
		||||
    cg.add_define("USE_API_HOMEASSISTANT_SERVICES")
 | 
			
		||||
    serv = await cg.get_variable(config[CONF_ID])
 | 
			
		||||
    var = cg.new_Pvariable(action_id, template_arg, serv, False)
 | 
			
		||||
    templ = await cg.templatable(config[CONF_ACTION], args, None)
 | 
			
		||||
@@ -264,6 +289,7 @@ HOMEASSISTANT_EVENT_ACTION_SCHEMA = cv.Schema(
 | 
			
		||||
    HOMEASSISTANT_EVENT_ACTION_SCHEMA,
 | 
			
		||||
)
 | 
			
		||||
async def homeassistant_event_to_code(config, action_id, template_arg, args):
 | 
			
		||||
    cg.add_define("USE_API_HOMEASSISTANT_SERVICES")
 | 
			
		||||
    serv = await cg.get_variable(config[CONF_ID])
 | 
			
		||||
    var = cg.new_Pvariable(action_id, template_arg, serv, True)
 | 
			
		||||
    templ = await cg.templatable(config[CONF_EVENT], args, None)
 | 
			
		||||
@@ -306,3 +332,38 @@ async def homeassistant_tag_scanned_to_code(config, action_id, template_arg, arg
 | 
			
		||||
@automation.register_condition("api.connected", APIConnectedCondition, {})
 | 
			
		||||
async def api_connected_to_code(config, condition_id, template_arg, args):
 | 
			
		||||
    return cg.new_Pvariable(condition_id, template_arg)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def FILTER_SOURCE_FILES() -> list[str]:
 | 
			
		||||
    """Filter out api_pb2_dump.cpp when proto message dumping is not enabled,
 | 
			
		||||
    user_services.cpp when no services are defined, and protocol-specific
 | 
			
		||||
    implementations based on encryption configuration."""
 | 
			
		||||
    files_to_filter: list[str] = []
 | 
			
		||||
 | 
			
		||||
    # api_pb2_dump.cpp is only needed when HAS_PROTO_MESSAGE_DUMP is defined
 | 
			
		||||
    # This is a particularly large file that still needs to be opened and read
 | 
			
		||||
    # all the way to the end even when ifdef'd out
 | 
			
		||||
    #
 | 
			
		||||
    # HAS_PROTO_MESSAGE_DUMP is defined when ESPHOME_LOG_HAS_VERY_VERBOSE is set,
 | 
			
		||||
    # which happens when the logger level is VERY_VERBOSE
 | 
			
		||||
    if get_logger_level() != "VERY_VERBOSE":
 | 
			
		||||
        files_to_filter.append("api_pb2_dump.cpp")
 | 
			
		||||
 | 
			
		||||
    # user_services.cpp is only needed when services are defined
 | 
			
		||||
    config = CORE.config.get(DOMAIN, {})
 | 
			
		||||
    if config and not config.get(CONF_ACTIONS) and not config[CONF_CUSTOM_SERVICES]:
 | 
			
		||||
        files_to_filter.append("user_services.cpp")
 | 
			
		||||
 | 
			
		||||
    # Filter protocol-specific implementations based on encryption configuration
 | 
			
		||||
    encryption_config = config.get(CONF_ENCRYPTION) if config else None
 | 
			
		||||
 | 
			
		||||
    # If encryption is not configured at all, we only need plaintext
 | 
			
		||||
    if encryption_config is None:
 | 
			
		||||
        files_to_filter.append("api_frame_helper_noise.cpp")
 | 
			
		||||
    # If encryption is configured with a key, we only need noise
 | 
			
		||||
    elif encryption_config.get(CONF_KEY):
 | 
			
		||||
        files_to_filter.append("api_frame_helper_plaintext.cpp")
 | 
			
		||||
    # If encryption is configured but no key is provided, we need both
 | 
			
		||||
    # (this allows a plaintext client to provide a noise key)
 | 
			
		||||
 | 
			
		||||
    return files_to_filter
 | 
			
		||||
 
 | 
			
		||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							@@ -13,15 +13,41 @@
 | 
			
		||||
#include <vector>
 | 
			
		||||
#include <functional>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
// Client information structure
 | 
			
		||||
struct ClientInfo {
 | 
			
		||||
  std::string name;      // Client name from Hello message
 | 
			
		||||
  std::string peername;  // IP:port from socket
 | 
			
		||||
 | 
			
		||||
  std::string get_combined_info() const {
 | 
			
		||||
    if (name == peername) {
 | 
			
		||||
      // Before Hello message, both are the same
 | 
			
		||||
      return name;
 | 
			
		||||
    }
 | 
			
		||||
    return name + " (" + peername + ")";
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Keepalive timeout in milliseconds
 | 
			
		||||
static constexpr uint32_t KEEPALIVE_TIMEOUT_MS = 60000;
 | 
			
		||||
// Maximum number of entities to process in a single batch during initial state/info sending
 | 
			
		||||
// This was increased from 20 to 24 after removing the unique_id field from entity info messages,
 | 
			
		||||
// which reduced message sizes allowing more entities per batch without exceeding packet limits
 | 
			
		||||
static constexpr size_t MAX_INITIAL_PER_BATCH = 24;
 | 
			
		||||
// Maximum number of packets to process in a single batch (platform-dependent)
 | 
			
		||||
// This limit exists to prevent stack overflow from the PacketInfo array in process_batch_
 | 
			
		||||
// Each PacketInfo is 8 bytes, so 64 * 8 = 512 bytes, 32 * 8 = 256 bytes
 | 
			
		||||
#if defined(USE_ESP32) || defined(USE_HOST)
 | 
			
		||||
static constexpr size_t MAX_PACKETS_PER_BATCH = 64;  // ESP32 has 8KB+ stack, HOST has plenty
 | 
			
		||||
#else
 | 
			
		||||
static constexpr size_t MAX_PACKETS_PER_BATCH = 32;  // ESP8266/RP2040/etc have smaller stacks
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
class APIConnection : public APIServerConnection {
 | 
			
		||||
 public:
 | 
			
		||||
  friend class APIServer;
 | 
			
		||||
  friend class ListEntitiesIterator;
 | 
			
		||||
  APIConnection(std::unique_ptr<socket::Socket> socket, APIServer *parent);
 | 
			
		||||
  virtual ~APIConnection();
 | 
			
		||||
 | 
			
		||||
@@ -30,109 +56,91 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
 | 
			
		||||
  bool send_list_info_done() {
 | 
			
		||||
    return this->schedule_message_(nullptr, &APIConnection::try_send_list_info_done,
 | 
			
		||||
                                   ListEntitiesDoneResponse::MESSAGE_TYPE);
 | 
			
		||||
                                   ListEntitiesDoneResponse::MESSAGE_TYPE, ListEntitiesDoneResponse::ESTIMATED_SIZE);
 | 
			
		||||
  }
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
  bool send_binary_sensor_state(binary_sensor::BinarySensor *binary_sensor);
 | 
			
		||||
  void send_binary_sensor_info(binary_sensor::BinarySensor *binary_sensor);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
  bool send_cover_state(cover::Cover *cover);
 | 
			
		||||
  void send_cover_info(cover::Cover *cover);
 | 
			
		||||
  void cover_command(const CoverCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_FAN
 | 
			
		||||
  bool send_fan_state(fan::Fan *fan);
 | 
			
		||||
  void send_fan_info(fan::Fan *fan);
 | 
			
		||||
  void fan_command(const FanCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LIGHT
 | 
			
		||||
  bool send_light_state(light::LightState *light);
 | 
			
		||||
  void send_light_info(light::LightState *light);
 | 
			
		||||
  void light_command(const LightCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SENSOR
 | 
			
		||||
  bool send_sensor_state(sensor::Sensor *sensor);
 | 
			
		||||
  void send_sensor_info(sensor::Sensor *sensor);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SWITCH
 | 
			
		||||
  bool send_switch_state(switch_::Switch *a_switch);
 | 
			
		||||
  void send_switch_info(switch_::Switch *a_switch);
 | 
			
		||||
  void switch_command(const SwitchCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT_SENSOR
 | 
			
		||||
  bool send_text_sensor_state(text_sensor::TextSensor *text_sensor);
 | 
			
		||||
  void send_text_sensor_info(text_sensor::TextSensor *text_sensor);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
  void set_camera_state(std::shared_ptr<esp32_camera::CameraImage> image);
 | 
			
		||||
  void send_camera_info(esp32_camera::ESP32Camera *camera);
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  void set_camera_state(std::shared_ptr<camera::CameraImage> image);
 | 
			
		||||
  void camera_image(const CameraImageRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
  bool send_climate_state(climate::Climate *climate);
 | 
			
		||||
  void send_climate_info(climate::Climate *climate);
 | 
			
		||||
  void climate_command(const ClimateCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_NUMBER
 | 
			
		||||
  bool send_number_state(number::Number *number);
 | 
			
		||||
  void send_number_info(number::Number *number);
 | 
			
		||||
  void number_command(const NumberCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATE
 | 
			
		||||
  bool send_date_state(datetime::DateEntity *date);
 | 
			
		||||
  void send_date_info(datetime::DateEntity *date);
 | 
			
		||||
  void date_command(const DateCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_TIME
 | 
			
		||||
  bool send_time_state(datetime::TimeEntity *time);
 | 
			
		||||
  void send_time_info(datetime::TimeEntity *time);
 | 
			
		||||
  void time_command(const TimeCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATETIME
 | 
			
		||||
  bool send_datetime_state(datetime::DateTimeEntity *datetime);
 | 
			
		||||
  void send_datetime_info(datetime::DateTimeEntity *datetime);
 | 
			
		||||
  void datetime_command(const DateTimeCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT
 | 
			
		||||
  bool send_text_state(text::Text *text);
 | 
			
		||||
  void send_text_info(text::Text *text);
 | 
			
		||||
  void text_command(const TextCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SELECT
 | 
			
		||||
  bool send_select_state(select::Select *select);
 | 
			
		||||
  void send_select_info(select::Select *select);
 | 
			
		||||
  void select_command(const SelectCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
  void send_button_info(button::Button *button);
 | 
			
		||||
  void button_command(const ButtonCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LOCK
 | 
			
		||||
  bool send_lock_state(lock::Lock *a_lock);
 | 
			
		||||
  void send_lock_info(lock::Lock *a_lock);
 | 
			
		||||
  void lock_command(const LockCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VALVE
 | 
			
		||||
  bool send_valve_state(valve::Valve *valve);
 | 
			
		||||
  void send_valve_info(valve::Valve *valve);
 | 
			
		||||
  void valve_command(const ValveCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
  bool send_media_player_state(media_player::MediaPlayer *media_player);
 | 
			
		||||
  void send_media_player_info(media_player::MediaPlayer *media_player);
 | 
			
		||||
  void media_player_command(const MediaPlayerCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
  bool try_send_log_message(int level, const char *tag, const char *line);
 | 
			
		||||
  bool try_send_log_message(int level, const char *tag, const char *line, size_t message_len);
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  void send_homeassistant_service_call(const HomeassistantServiceResponse &call) {
 | 
			
		||||
    if (!this->service_call_subscription_)
 | 
			
		||||
    if (!this->flags_.service_call_subscription)
 | 
			
		||||
      return;
 | 
			
		||||
    this->send_message(call);
 | 
			
		||||
    this->send_message(call, HomeassistantServiceResponse::MESSAGE_TYPE);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BLUETOOTH_PROXY
 | 
			
		||||
  void subscribe_bluetooth_le_advertisements(const SubscribeBluetoothLEAdvertisementsRequest &msg) override;
 | 
			
		||||
  void unsubscribe_bluetooth_le_advertisements(const UnsubscribeBluetoothLEAdvertisementsRequest &msg) override;
 | 
			
		||||
  bool send_bluetooth_le_advertisement(const BluetoothLEAdvertisementResponse &msg);
 | 
			
		||||
 | 
			
		||||
  void bluetooth_device_request(const BluetoothDeviceRequest &msg) override;
 | 
			
		||||
  void bluetooth_gatt_read(const BluetoothGATTReadRequest &msg) override;
 | 
			
		||||
@@ -141,15 +149,14 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  void bluetooth_gatt_write_descriptor(const BluetoothGATTWriteDescriptorRequest &msg) override;
 | 
			
		||||
  void bluetooth_gatt_get_services(const BluetoothGATTGetServicesRequest &msg) override;
 | 
			
		||||
  void bluetooth_gatt_notify(const BluetoothGATTNotifyRequest &msg) override;
 | 
			
		||||
  BluetoothConnectionsFreeResponse subscribe_bluetooth_connections_free(
 | 
			
		||||
      const SubscribeBluetoothConnectionsFreeRequest &msg) override;
 | 
			
		||||
  bool send_subscribe_bluetooth_connections_free_response(const SubscribeBluetoothConnectionsFreeRequest &msg) override;
 | 
			
		||||
  void bluetooth_scanner_set_mode(const BluetoothScannerSetModeRequest &msg) override;
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_HOMEASSISTANT_TIME
 | 
			
		||||
  void send_time_request() {
 | 
			
		||||
    GetTimeRequest req;
 | 
			
		||||
    this->send_message(req);
 | 
			
		||||
    this->send_message(req, GetTimeRequest::MESSAGE_TYPE);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
@@ -160,72 +167,78 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  void on_voice_assistant_audio(const VoiceAssistantAudio &msg) override;
 | 
			
		||||
  void on_voice_assistant_timer_event_response(const VoiceAssistantTimerEventResponse &msg) override;
 | 
			
		||||
  void on_voice_assistant_announce_request(const VoiceAssistantAnnounceRequest &msg) override;
 | 
			
		||||
  VoiceAssistantConfigurationResponse voice_assistant_get_configuration(
 | 
			
		||||
      const VoiceAssistantConfigurationRequest &msg) override;
 | 
			
		||||
  bool send_voice_assistant_get_configuration_response(const VoiceAssistantConfigurationRequest &msg) override;
 | 
			
		||||
  void voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
  bool send_alarm_control_panel_state(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel);
 | 
			
		||||
  void send_alarm_control_panel_info(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel);
 | 
			
		||||
  void alarm_control_panel_command(const AlarmControlPanelCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_EVENT
 | 
			
		||||
  void send_event(event::Event *event, const std::string &event_type);
 | 
			
		||||
  void send_event_info(event::Event *event);
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_UPDATE
 | 
			
		||||
  bool send_update_state(update::UpdateEntity *update);
 | 
			
		||||
  void send_update_info(update::UpdateEntity *update);
 | 
			
		||||
  void update_command(const UpdateCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  void on_disconnect_response(const DisconnectResponse &value) override;
 | 
			
		||||
  void on_ping_response(const PingResponse &value) override {
 | 
			
		||||
    // we initiated ping
 | 
			
		||||
    this->ping_retries_ = 0;
 | 
			
		||||
    this->sent_ping_ = false;
 | 
			
		||||
    this->flags_.sent_ping = false;
 | 
			
		||||
  }
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  void on_home_assistant_state_response(const HomeAssistantStateResponse &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_HOMEASSISTANT_TIME
 | 
			
		||||
  void on_get_time_response(const GetTimeResponse &value) override;
 | 
			
		||||
#endif
 | 
			
		||||
  HelloResponse hello(const HelloRequest &msg) override;
 | 
			
		||||
  ConnectResponse connect(const ConnectRequest &msg) override;
 | 
			
		||||
  DisconnectResponse disconnect(const DisconnectRequest &msg) override;
 | 
			
		||||
  PingResponse ping(const PingRequest &msg) override { return {}; }
 | 
			
		||||
  DeviceInfoResponse device_info(const DeviceInfoRequest &msg) override;
 | 
			
		||||
  bool send_hello_response(const HelloRequest &msg) override;
 | 
			
		||||
  bool send_connect_response(const ConnectRequest &msg) override;
 | 
			
		||||
  bool send_disconnect_response(const DisconnectRequest &msg) override;
 | 
			
		||||
  bool send_ping_response(const PingRequest &msg) override;
 | 
			
		||||
  bool send_device_info_response(const DeviceInfoRequest &msg) override;
 | 
			
		||||
  void list_entities(const ListEntitiesRequest &msg) override { this->list_entities_iterator_.begin(); }
 | 
			
		||||
  void subscribe_states(const SubscribeStatesRequest &msg) override {
 | 
			
		||||
    this->state_subscription_ = true;
 | 
			
		||||
    this->flags_.state_subscription = true;
 | 
			
		||||
    this->initial_state_iterator_.begin();
 | 
			
		||||
  }
 | 
			
		||||
  void subscribe_logs(const SubscribeLogsRequest &msg) override {
 | 
			
		||||
    this->log_subscription_ = msg.level;
 | 
			
		||||
    this->flags_.log_subscription = msg.level;
 | 
			
		||||
    if (msg.dump_config)
 | 
			
		||||
      App.schedule_dump_config();
 | 
			
		||||
  }
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  void subscribe_homeassistant_services(const SubscribeHomeassistantServicesRequest &msg) override {
 | 
			
		||||
    this->service_call_subscription_ = true;
 | 
			
		||||
    this->flags_.service_call_subscription = true;
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  void subscribe_home_assistant_states(const SubscribeHomeAssistantStatesRequest &msg) override;
 | 
			
		||||
  GetTimeResponse get_time(const GetTimeRequest &msg) override {
 | 
			
		||||
    // TODO
 | 
			
		||||
    return {};
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
  bool send_get_time_response(const GetTimeRequest &msg) override;
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  void execute_service(const ExecuteServiceRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
  NoiseEncryptionSetKeyResponse noise_encryption_set_key(const NoiseEncryptionSetKeyRequest &msg) override;
 | 
			
		||||
  bool send_noise_encryption_set_key_response(const NoiseEncryptionSetKeyRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  bool is_authenticated() override { return this->connection_state_ == ConnectionState::AUTHENTICATED; }
 | 
			
		||||
  bool is_connection_setup() override {
 | 
			
		||||
    return this->connection_state_ == ConnectionState ::CONNECTED || this->is_authenticated();
 | 
			
		||||
  bool is_authenticated() override {
 | 
			
		||||
    return static_cast<ConnectionState>(this->flags_.connection_state) == ConnectionState::AUTHENTICATED;
 | 
			
		||||
  }
 | 
			
		||||
  bool is_connection_setup() override {
 | 
			
		||||
    return static_cast<ConnectionState>(this->flags_.connection_state) == ConnectionState::CONNECTED ||
 | 
			
		||||
           this->is_authenticated();
 | 
			
		||||
  }
 | 
			
		||||
  uint8_t get_log_subscription_level() const { return this->flags_.log_subscription; }
 | 
			
		||||
  void on_fatal_error() override;
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
  void on_unauthenticated_access() override;
 | 
			
		||||
#endif
 | 
			
		||||
  void on_no_setup_connection() override;
 | 
			
		||||
  ProtoWriteBuffer create_buffer(uint32_t reserve_size) override {
 | 
			
		||||
    // FIXME: ensure no recursive writes can happen
 | 
			
		||||
@@ -273,39 +286,80 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  bool try_to_clear_buffer(bool log_out_of_space);
 | 
			
		||||
  bool send_buffer(ProtoWriteBuffer buffer, uint16_t message_type) override;
 | 
			
		||||
  bool send_buffer(ProtoWriteBuffer buffer, uint8_t message_type) override;
 | 
			
		||||
 | 
			
		||||
  std::string get_client_combined_info() const { return this->client_combined_info_; }
 | 
			
		||||
  std::string get_client_combined_info() const { return this->client_info_.get_combined_info(); }
 | 
			
		||||
 | 
			
		||||
  // Buffer allocator methods for batch processing
 | 
			
		||||
  ProtoWriteBuffer allocate_single_message_buffer(uint16_t size);
 | 
			
		||||
  ProtoWriteBuffer allocate_batch_message_buffer(uint16_t size);
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  // Helper function to fill common entity info fields
 | 
			
		||||
  static void fill_entity_info_base(esphome::EntityBase *entity, InfoResponseProtoMessage &response) {
 | 
			
		||||
    // Set common fields that are shared by all entity types
 | 
			
		||||
    response.key = entity->get_object_id_hash();
 | 
			
		||||
    response.object_id = entity->get_object_id();
 | 
			
		||||
  // Helper function to handle authentication completion
 | 
			
		||||
  void complete_authentication_();
 | 
			
		||||
 | 
			
		||||
    if (entity->has_own_name())
 | 
			
		||||
      response.name = entity->get_name();
 | 
			
		||||
 | 
			
		||||
    // Set common EntityBase properties
 | 
			
		||||
    response.icon = entity->get_icon();
 | 
			
		||||
    response.disabled_by_default = entity->is_disabled_by_default();
 | 
			
		||||
    response.entity_category = static_cast<enums::EntityCategory>(entity->get_entity_category());
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Helper function to fill common entity state fields
 | 
			
		||||
  static void fill_entity_state_base(esphome::EntityBase *entity, StateResponseProtoMessage &response) {
 | 
			
		||||
    response.key = entity->get_object_id_hash();
 | 
			
		||||
  }
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  void process_state_subscriptions_();
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Non-template helper to encode any ProtoMessage
 | 
			
		||||
  static uint16_t encode_message_to_buffer(ProtoMessage &msg, uint16_t message_type, APIConnection *conn,
 | 
			
		||||
  static uint16_t encode_message_to_buffer(ProtoMessage &msg, uint8_t message_type, APIConnection *conn,
 | 
			
		||||
                                           uint32_t remaining_size, bool is_single);
 | 
			
		||||
 | 
			
		||||
  // Helper to fill entity state base and encode message
 | 
			
		||||
  static uint16_t fill_and_encode_entity_state(EntityBase *entity, StateResponseProtoMessage &msg, uint8_t message_type,
 | 
			
		||||
                                               APIConnection *conn, uint32_t remaining_size, bool is_single) {
 | 
			
		||||
    msg.key = entity->get_object_id_hash();
 | 
			
		||||
#ifdef USE_DEVICES
 | 
			
		||||
    msg.device_id = entity->get_device_id();
 | 
			
		||||
#endif
 | 
			
		||||
    return encode_message_to_buffer(msg, message_type, conn, remaining_size, is_single);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Helper to fill entity info base and encode message
 | 
			
		||||
  static uint16_t fill_and_encode_entity_info(EntityBase *entity, InfoResponseProtoMessage &msg, uint8_t message_type,
 | 
			
		||||
                                              APIConnection *conn, uint32_t remaining_size, bool is_single) {
 | 
			
		||||
    // Set common fields that are shared by all entity types
 | 
			
		||||
    msg.key = entity->get_object_id_hash();
 | 
			
		||||
    // IMPORTANT: get_object_id() may return a temporary std::string
 | 
			
		||||
    std::string object_id = entity->get_object_id();
 | 
			
		||||
    msg.set_object_id(StringRef(object_id));
 | 
			
		||||
 | 
			
		||||
    if (entity->has_own_name()) {
 | 
			
		||||
      msg.set_name(entity->get_name());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Set common EntityBase properties
 | 
			
		||||
#ifdef USE_ENTITY_ICON
 | 
			
		||||
    msg.set_icon(entity->get_icon_ref());
 | 
			
		||||
#endif
 | 
			
		||||
    msg.disabled_by_default = entity->is_disabled_by_default();
 | 
			
		||||
    msg.entity_category = static_cast<enums::EntityCategory>(entity->get_entity_category());
 | 
			
		||||
#ifdef USE_DEVICES
 | 
			
		||||
    msg.device_id = entity->get_device_id();
 | 
			
		||||
#endif
 | 
			
		||||
    return encode_message_to_buffer(msg, message_type, conn, remaining_size, is_single);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  // Helper to check voice assistant validity and connection ownership
 | 
			
		||||
  inline bool check_voice_assistant_api_connection_() const;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Helper method to process multiple entities from an iterator in a batch
 | 
			
		||||
  template<typename Iterator> void process_iterator_batch_(Iterator &iterator) {
 | 
			
		||||
    size_t initial_size = this->deferred_batch_.size();
 | 
			
		||||
    while (!iterator.completed() && (this->deferred_batch_.size() - initial_size) < MAX_INITIAL_PER_BATCH) {
 | 
			
		||||
      iterator.advance();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // If the batch is full, process it immediately
 | 
			
		||||
    // Note: iterator.advance() already calls schedule_batch_() via schedule_message_()
 | 
			
		||||
    if (this->deferred_batch_.size() >= MAX_INITIAL_PER_BATCH) {
 | 
			
		||||
      this->process_batch_();
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
  static uint16_t try_send_binary_sensor_state(EntityBase *entity, APIConnection *conn, uint32_t remaining_size,
 | 
			
		||||
                                               bool is_single);
 | 
			
		||||
@@ -416,7 +470,7 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  static uint16_t try_send_update_info(EntityBase *entity, APIConnection *conn, uint32_t remaining_size,
 | 
			
		||||
                                       bool is_single);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  static uint16_t try_send_camera_info(EntityBase *entity, APIConnection *conn, uint32_t remaining_size,
 | 
			
		||||
                                       bool is_single);
 | 
			
		||||
#endif
 | 
			
		||||
@@ -429,127 +483,83 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  static uint16_t try_send_disconnect_request(EntityBase *entity, APIConnection *conn, uint32_t remaining_size,
 | 
			
		||||
                                              bool is_single);
 | 
			
		||||
 | 
			
		||||
  // Helper function to get estimated message size for buffer pre-allocation
 | 
			
		||||
  static uint16_t get_estimated_message_size(uint16_t message_type);
 | 
			
		||||
  // Batch message method for ping requests
 | 
			
		||||
  static uint16_t try_send_ping_request(EntityBase *entity, APIConnection *conn, uint32_t remaining_size,
 | 
			
		||||
                                        bool is_single);
 | 
			
		||||
 | 
			
		||||
  enum class ConnectionState {
 | 
			
		||||
    WAITING_FOR_HELLO,
 | 
			
		||||
    CONNECTED,
 | 
			
		||||
    AUTHENTICATED,
 | 
			
		||||
  } connection_state_{ConnectionState::WAITING_FOR_HELLO};
 | 
			
		||||
 | 
			
		||||
  bool remove_{false};
 | 
			
		||||
  // === Optimal member ordering for 32-bit systems ===
 | 
			
		||||
 | 
			
		||||
  // Group 1: Pointers (4 bytes each on 32-bit)
 | 
			
		||||
  std::unique_ptr<APIFrameHelper> helper_;
 | 
			
		||||
 | 
			
		||||
  std::string client_info_;
 | 
			
		||||
  std::string client_peername_;
 | 
			
		||||
  std::string client_combined_info_;
 | 
			
		||||
  uint32_t client_api_version_major_{0};
 | 
			
		||||
  uint32_t client_api_version_minor_{0};
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
  esp32_camera::CameraImageReader image_reader_;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  bool state_subscription_{false};
 | 
			
		||||
  int log_subscription_{ESPHOME_LOG_LEVEL_NONE};
 | 
			
		||||
  uint32_t last_traffic_;
 | 
			
		||||
  uint32_t next_ping_retry_{0};
 | 
			
		||||
  uint8_t ping_retries_{0};
 | 
			
		||||
  bool sent_ping_{false};
 | 
			
		||||
  bool service_call_subscription_{false};
 | 
			
		||||
  bool next_close_ = false;
 | 
			
		||||
  APIServer *parent_;
 | 
			
		||||
 | 
			
		||||
  // Group 2: Larger objects (must be 4-byte aligned)
 | 
			
		||||
  // These contain vectors/pointers internally, so putting them early ensures good alignment
 | 
			
		||||
  InitialStateIterator initial_state_iterator_;
 | 
			
		||||
  ListEntitiesIterator list_entities_iterator_;
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  std::unique_ptr<camera::CameraImageReader> image_reader_;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Group 3: Client info struct (24 bytes on 32-bit: 2 strings × 12 bytes each)
 | 
			
		||||
  ClientInfo client_info_;
 | 
			
		||||
 | 
			
		||||
  // Group 4: 4-byte types
 | 
			
		||||
  uint32_t last_traffic_;
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  int state_subs_at_ = -1;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Function pointer type for message encoding
 | 
			
		||||
  using MessageCreatorPtr = uint16_t (*)(EntityBase *, APIConnection *, uint32_t remaining_size, bool is_single);
 | 
			
		||||
 | 
			
		||||
  // Optimized MessageCreator class using union dispatch
 | 
			
		||||
  class MessageCreator {
 | 
			
		||||
   public:
 | 
			
		||||
    // Constructor for function pointer (message_type = 0)
 | 
			
		||||
    MessageCreator(MessageCreatorPtr ptr) : message_type_(0) { data_.ptr = ptr; }
 | 
			
		||||
    // Constructor for function pointer
 | 
			
		||||
    MessageCreator(MessageCreatorPtr ptr) { data_.function_ptr = ptr; }
 | 
			
		||||
 | 
			
		||||
    // Constructor for string state capture
 | 
			
		||||
    MessageCreator(const std::string &value, uint16_t msg_type) : message_type_(msg_type) {
 | 
			
		||||
      data_.string_ptr = new std::string(value);
 | 
			
		||||
    }
 | 
			
		||||
    explicit MessageCreator(const std::string &str_value) { data_.string_ptr = new std::string(str_value); }
 | 
			
		||||
 | 
			
		||||
    // Destructor
 | 
			
		||||
    ~MessageCreator() {
 | 
			
		||||
      // Clean up string data for string-based message types
 | 
			
		||||
      if (uses_string_data_()) {
 | 
			
		||||
        delete data_.string_ptr;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
    // No destructor - cleanup must be called explicitly with message_type
 | 
			
		||||
 | 
			
		||||
    // Copy constructor
 | 
			
		||||
    MessageCreator(const MessageCreator &other) : message_type_(other.message_type_) {
 | 
			
		||||
      if (message_type_ == 0) {
 | 
			
		||||
        data_.ptr = other.data_.ptr;
 | 
			
		||||
      } else if (uses_string_data_()) {
 | 
			
		||||
        data_.string_ptr = new std::string(*other.data_.string_ptr);
 | 
			
		||||
      } else {
 | 
			
		||||
        data_ = other.data_;  // For POD types
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
    // Delete copy operations - MessageCreator should only be moved
 | 
			
		||||
    MessageCreator(const MessageCreator &other) = delete;
 | 
			
		||||
    MessageCreator &operator=(const MessageCreator &other) = delete;
 | 
			
		||||
 | 
			
		||||
    // Move constructor
 | 
			
		||||
    MessageCreator(MessageCreator &&other) noexcept : data_(other.data_), message_type_(other.message_type_) {
 | 
			
		||||
      other.message_type_ = 0;  // Reset other to function pointer type
 | 
			
		||||
      other.data_.ptr = nullptr;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Assignment operators (needed for batch deduplication)
 | 
			
		||||
    MessageCreator &operator=(const MessageCreator &other) {
 | 
			
		||||
      if (this != &other) {
 | 
			
		||||
        // Clean up current string data if needed
 | 
			
		||||
        if (uses_string_data_()) {
 | 
			
		||||
          delete data_.string_ptr;
 | 
			
		||||
        }
 | 
			
		||||
        // Copy new data
 | 
			
		||||
        message_type_ = other.message_type_;
 | 
			
		||||
        if (other.message_type_ == 0) {
 | 
			
		||||
          data_.ptr = other.data_.ptr;
 | 
			
		||||
        } else if (other.uses_string_data_()) {
 | 
			
		||||
          data_.string_ptr = new std::string(*other.data_.string_ptr);
 | 
			
		||||
        } else {
 | 
			
		||||
          data_ = other.data_;
 | 
			
		||||
        }
 | 
			
		||||
      }
 | 
			
		||||
      return *this;
 | 
			
		||||
    }
 | 
			
		||||
    MessageCreator(MessageCreator &&other) noexcept : data_(other.data_) { other.data_.function_ptr = nullptr; }
 | 
			
		||||
 | 
			
		||||
    // Move assignment
 | 
			
		||||
    MessageCreator &operator=(MessageCreator &&other) noexcept {
 | 
			
		||||
      if (this != &other) {
 | 
			
		||||
        // Clean up current string data if needed
 | 
			
		||||
        if (uses_string_data_()) {
 | 
			
		||||
          delete data_.string_ptr;
 | 
			
		||||
        }
 | 
			
		||||
        // Move data
 | 
			
		||||
        message_type_ = other.message_type_;
 | 
			
		||||
        // IMPORTANT: Caller must ensure cleanup() was called if this contains a string!
 | 
			
		||||
        // In our usage, this happens in add_item() deduplication and vector::erase()
 | 
			
		||||
        data_ = other.data_;
 | 
			
		||||
        // Reset other to safe state
 | 
			
		||||
        other.message_type_ = 0;
 | 
			
		||||
        other.data_.ptr = nullptr;
 | 
			
		||||
        other.data_.function_ptr = nullptr;
 | 
			
		||||
      }
 | 
			
		||||
      return *this;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Call operator
 | 
			
		||||
    uint16_t operator()(EntityBase *entity, APIConnection *conn, uint32_t remaining_size, bool is_single) const;
 | 
			
		||||
    // Call operator - uses message_type to determine union type
 | 
			
		||||
    uint16_t operator()(EntityBase *entity, APIConnection *conn, uint32_t remaining_size, bool is_single,
 | 
			
		||||
                        uint8_t message_type) const;
 | 
			
		||||
 | 
			
		||||
    // Manual cleanup method - must be called before destruction for string types
 | 
			
		||||
    void cleanup(uint8_t message_type) {
 | 
			
		||||
#ifdef USE_EVENT
 | 
			
		||||
      if (message_type == EventResponse::MESSAGE_TYPE && data_.string_ptr != nullptr) {
 | 
			
		||||
        delete data_.string_ptr;
 | 
			
		||||
        data_.string_ptr = nullptr;
 | 
			
		||||
      }
 | 
			
		||||
#endif
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
   private:
 | 
			
		||||
    // Helper to check if this message type uses heap-allocated strings
 | 
			
		||||
    bool uses_string_data_() const { return message_type_ == EventResponse::MESSAGE_TYPE; }
 | 
			
		||||
    union CreatorData {
 | 
			
		||||
      MessageCreatorPtr ptr;    // 8 bytes
 | 
			
		||||
      std::string *string_ptr;  // 8 bytes
 | 
			
		||||
    } data_;                    // 8 bytes
 | 
			
		||||
    uint16_t message_type_;     // 2 bytes (0 = function ptr, >0 = state capture)
 | 
			
		||||
    union Data {
 | 
			
		||||
      MessageCreatorPtr function_ptr;
 | 
			
		||||
      std::string *string_ptr;
 | 
			
		||||
    } data_;  // 4 bytes on 32-bit, 8 bytes on 64-bit - same as before
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  // Generic batching mechanism for both state updates and entity info
 | 
			
		||||
@@ -557,33 +567,96 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
    struct BatchItem {
 | 
			
		||||
      EntityBase *entity;      // Entity pointer
 | 
			
		||||
      MessageCreator creator;  // Function that creates the message when needed
 | 
			
		||||
      uint16_t message_type;   // Message type for overhead calculation
 | 
			
		||||
      uint8_t message_type;    // Message type for overhead calculation (max 255)
 | 
			
		||||
      uint8_t estimated_size;  // Estimated message size (max 255 bytes)
 | 
			
		||||
 | 
			
		||||
      // Constructor for creating BatchItem
 | 
			
		||||
      BatchItem(EntityBase *entity, MessageCreator creator, uint16_t message_type)
 | 
			
		||||
          : entity(entity), creator(std::move(creator)), message_type(message_type) {}
 | 
			
		||||
      BatchItem(EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size)
 | 
			
		||||
          : entity(entity), creator(std::move(creator)), message_type(message_type), estimated_size(estimated_size) {}
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    std::vector<BatchItem> items;
 | 
			
		||||
    uint32_t batch_start_time{0};
 | 
			
		||||
    bool batch_scheduled{false};
 | 
			
		||||
 | 
			
		||||
   private:
 | 
			
		||||
    // Helper to cleanup items from the beginning
 | 
			
		||||
    void cleanup_items_(size_t count) {
 | 
			
		||||
      for (size_t i = 0; i < count; i++) {
 | 
			
		||||
        items[i].creator.cleanup(items[i].message_type);
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
   public:
 | 
			
		||||
    DeferredBatch() {
 | 
			
		||||
      // Pre-allocate capacity for typical batch sizes to avoid reallocation
 | 
			
		||||
      items.reserve(8);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    ~DeferredBatch() {
 | 
			
		||||
      // Ensure cleanup of any remaining items
 | 
			
		||||
      clear();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Add item to the batch
 | 
			
		||||
    void add_item(EntityBase *entity, MessageCreator creator, uint16_t message_type);
 | 
			
		||||
    void add_item(EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size);
 | 
			
		||||
    // Add item to the front of the batch (for high priority messages like ping)
 | 
			
		||||
    void add_item_front(EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size);
 | 
			
		||||
 | 
			
		||||
    // Clear all items with proper cleanup
 | 
			
		||||
    void clear() {
 | 
			
		||||
      cleanup_items_(items.size());
 | 
			
		||||
      items.clear();
 | 
			
		||||
      batch_scheduled = false;
 | 
			
		||||
      batch_start_time = 0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Remove processed items from the front with proper cleanup
 | 
			
		||||
    void remove_front(size_t count) {
 | 
			
		||||
      cleanup_items_(count);
 | 
			
		||||
      items.erase(items.begin(), items.begin() + count);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    bool empty() const { return items.empty(); }
 | 
			
		||||
    size_t size() const { return items.size(); }
 | 
			
		||||
    const BatchItem &operator[](size_t index) const { return items[index]; }
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  // DeferredBatch here (16 bytes, 4-byte aligned)
 | 
			
		||||
  DeferredBatch deferred_batch_;
 | 
			
		||||
 | 
			
		||||
  // ConnectionState enum for type safety
 | 
			
		||||
  enum class ConnectionState : uint8_t {
 | 
			
		||||
    WAITING_FOR_HELLO = 0,
 | 
			
		||||
    CONNECTED = 1,
 | 
			
		||||
    AUTHENTICATED = 2,
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  // Group 5: Pack all small members together to minimize padding
 | 
			
		||||
  // This group starts at a 4-byte boundary after DeferredBatch
 | 
			
		||||
  struct APIFlags {
 | 
			
		||||
    // Connection state only needs 2 bits (3 states)
 | 
			
		||||
    uint8_t connection_state : 2;
 | 
			
		||||
    // Log subscription needs 3 bits (log levels 0-7)
 | 
			
		||||
    uint8_t log_subscription : 3;
 | 
			
		||||
    // Boolean flags (1 bit each)
 | 
			
		||||
    uint8_t remove : 1;
 | 
			
		||||
    uint8_t state_subscription : 1;
 | 
			
		||||
    uint8_t sent_ping : 1;
 | 
			
		||||
 | 
			
		||||
    uint8_t service_call_subscription : 1;
 | 
			
		||||
    uint8_t next_close : 1;
 | 
			
		||||
    uint8_t batch_scheduled : 1;
 | 
			
		||||
    uint8_t batch_first_message : 1;          // For batch buffer allocation
 | 
			
		||||
    uint8_t should_try_send_immediately : 1;  // True after initial states are sent
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
    uint8_t log_only_mode : 1;
 | 
			
		||||
#endif
 | 
			
		||||
  } flags_{};  // 2 bytes total
 | 
			
		||||
 | 
			
		||||
  // 2-byte types immediately after flags_ (no padding between them)
 | 
			
		||||
  uint16_t client_api_version_major_{0};
 | 
			
		||||
  uint16_t client_api_version_minor_{0};
 | 
			
		||||
  // Total: 2 (flags) + 2 + 2 = 6 bytes, then 2 bytes padding to next 4-byte boundary
 | 
			
		||||
 | 
			
		||||
  uint32_t get_batch_delay_ms_() const;
 | 
			
		||||
  // Message will use 8 more bytes than the minimum size, and typical
 | 
			
		||||
  // MTU is 1500. Sometimes users will see as low as 1460 MTU.
 | 
			
		||||
@@ -596,26 +669,74 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  // to send in one go. This is the maximum size of a single packet
 | 
			
		||||
  // that can be sent over the network.
 | 
			
		||||
  // This is to avoid fragmentation of the packet.
 | 
			
		||||
  static constexpr size_t MAX_PACKET_SIZE = 1390;  // MTU
 | 
			
		||||
  static constexpr size_t MAX_BATCH_PACKET_SIZE = 1390;  // MTU
 | 
			
		||||
 | 
			
		||||
  bool schedule_batch_();
 | 
			
		||||
  void process_batch_();
 | 
			
		||||
  void clear_batch_() {
 | 
			
		||||
    this->deferred_batch_.clear();
 | 
			
		||||
    this->flags_.batch_scheduled = false;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // State for batch buffer allocation
 | 
			
		||||
  bool batch_first_message_{false};
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  // Helper to log a proto message from a MessageCreator object
 | 
			
		||||
  void log_proto_message_(EntityBase *entity, const MessageCreator &creator, uint8_t message_type) {
 | 
			
		||||
    this->flags_.log_only_mode = true;
 | 
			
		||||
    creator(entity, this, MAX_BATCH_PACKET_SIZE, true, message_type);
 | 
			
		||||
    this->flags_.log_only_mode = false;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  void log_batch_item_(const DeferredBatch::BatchItem &item) {
 | 
			
		||||
    // Use the helper to log the message
 | 
			
		||||
    this->log_proto_message_(item.entity, item.creator, item.message_type);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Helper method to send a message either immediately or via batching
 | 
			
		||||
  bool send_message_smart_(EntityBase *entity, MessageCreatorPtr creator, uint8_t message_type,
 | 
			
		||||
                           uint8_t estimated_size) {
 | 
			
		||||
    // Try to send immediately if:
 | 
			
		||||
    // 1. We should try to send immediately (should_try_send_immediately = true)
 | 
			
		||||
    // 2. Batch delay is 0 (user has opted in to immediate sending)
 | 
			
		||||
    // 3. Buffer has space available
 | 
			
		||||
    if (this->flags_.should_try_send_immediately && this->get_batch_delay_ms_() == 0 &&
 | 
			
		||||
        this->helper_->can_write_without_blocking()) {
 | 
			
		||||
      // Now actually encode and send
 | 
			
		||||
      if (creator(entity, this, MAX_BATCH_PACKET_SIZE, true) &&
 | 
			
		||||
          this->send_buffer(ProtoWriteBuffer{&this->parent_->get_shared_buffer_ref()}, message_type)) {
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
        // Log the message in verbose mode
 | 
			
		||||
        this->log_proto_message_(entity, MessageCreator(creator), message_type);
 | 
			
		||||
#endif
 | 
			
		||||
        return true;
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      // If immediate send failed, fall through to batching
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Fall back to scheduled batching
 | 
			
		||||
    return this->schedule_message_(entity, creator, message_type, estimated_size);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Helper function to schedule a deferred message with known message type
 | 
			
		||||
  bool schedule_message_(EntityBase *entity, MessageCreator creator, uint16_t message_type) {
 | 
			
		||||
    this->deferred_batch_.add_item(entity, std::move(creator), message_type);
 | 
			
		||||
  bool schedule_message_(EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size) {
 | 
			
		||||
    this->deferred_batch_.add_item(entity, std::move(creator), message_type, estimated_size);
 | 
			
		||||
    return this->schedule_batch_();
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Overload for function pointers (for info messages and current state reads)
 | 
			
		||||
  bool schedule_message_(EntityBase *entity, MessageCreatorPtr function_ptr, uint16_t message_type) {
 | 
			
		||||
    return schedule_message_(entity, MessageCreator(function_ptr), message_type);
 | 
			
		||||
  bool schedule_message_(EntityBase *entity, MessageCreatorPtr function_ptr, uint8_t message_type,
 | 
			
		||||
                         uint8_t estimated_size) {
 | 
			
		||||
    return schedule_message_(entity, MessageCreator(function_ptr), message_type, estimated_size);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Helper function to schedule a high priority message at the front of the batch
 | 
			
		||||
  bool schedule_message_front_(EntityBase *entity, MessageCreatorPtr function_ptr, uint8_t message_type,
 | 
			
		||||
                               uint8_t estimated_size) {
 | 
			
		||||
    this->deferred_batch_.add_item_front(entity, MessageCreator(function_ptr), message_type, estimated_size);
 | 
			
		||||
    return this->schedule_batch_();
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							@@ -2,21 +2,23 @@
 | 
			
		||||
#include <cstdint>
 | 
			
		||||
#include <deque>
 | 
			
		||||
#include <limits>
 | 
			
		||||
#include <span>
 | 
			
		||||
#include <utility>
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
#include "noise/protocol.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#include "api_noise_context.h"
 | 
			
		||||
#include "esphome/components/socket/socket.h"
 | 
			
		||||
#include "esphome/core/application.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
// uncomment to log raw packets
 | 
			
		||||
//#define HELPER_LOG_PACKETS
 | 
			
		||||
 | 
			
		||||
// Forward declaration
 | 
			
		||||
struct ClientInfo;
 | 
			
		||||
 | 
			
		||||
class ProtoWriteBuffer;
 | 
			
		||||
 | 
			
		||||
@@ -29,19 +31,16 @@ struct ReadPacketBuffer {
 | 
			
		||||
 | 
			
		||||
// Packed packet info structure to minimize memory usage
 | 
			
		||||
struct PacketInfo {
 | 
			
		||||
  uint16_t message_type;  // 2 bytes
 | 
			
		||||
  uint16_t offset;        // 2 bytes (sufficient for packet size ~1460 bytes)
 | 
			
		||||
  uint16_t payload_size;  // 2 bytes (up to 65535 bytes)
 | 
			
		||||
  uint16_t padding;       // 2 byte (for alignment)
 | 
			
		||||
  uint16_t offset;        // Offset in buffer where message starts
 | 
			
		||||
  uint16_t payload_size;  // Size of the message payload
 | 
			
		||||
  uint8_t message_type;   // Message type (0-255)
 | 
			
		||||
 | 
			
		||||
  PacketInfo(uint16_t type, uint16_t off, uint16_t size)
 | 
			
		||||
      : message_type(type), offset(off), payload_size(size), padding(0) {}
 | 
			
		||||
  PacketInfo(uint8_t type, uint16_t off, uint16_t size) : offset(off), payload_size(size), message_type(type) {}
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
enum class APIError : int {
 | 
			
		||||
enum class APIError : uint16_t {
 | 
			
		||||
  OK = 0,
 | 
			
		||||
  WOULD_BLOCK = 1001,
 | 
			
		||||
  BAD_HANDSHAKE_PACKET_LEN = 1002,
 | 
			
		||||
  BAD_INDICATOR = 1003,
 | 
			
		||||
  BAD_DATA_PACKET = 1004,
 | 
			
		||||
  TCP_NODELAY_FAILED = 1005,
 | 
			
		||||
@@ -52,16 +51,19 @@ enum class APIError : int {
 | 
			
		||||
  BAD_ARG = 1010,
 | 
			
		||||
  SOCKET_READ_FAILED = 1011,
 | 
			
		||||
  SOCKET_WRITE_FAILED = 1012,
 | 
			
		||||
  OUT_OF_MEMORY = 1018,
 | 
			
		||||
  CONNECTION_CLOSED = 1022,
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
  BAD_HANDSHAKE_PACKET_LEN = 1002,
 | 
			
		||||
  HANDSHAKESTATE_READ_FAILED = 1013,
 | 
			
		||||
  HANDSHAKESTATE_WRITE_FAILED = 1014,
 | 
			
		||||
  HANDSHAKESTATE_BAD_STATE = 1015,
 | 
			
		||||
  CIPHERSTATE_DECRYPT_FAILED = 1016,
 | 
			
		||||
  CIPHERSTATE_ENCRYPT_FAILED = 1017,
 | 
			
		||||
  OUT_OF_MEMORY = 1018,
 | 
			
		||||
  HANDSHAKESTATE_SETUP_FAILED = 1019,
 | 
			
		||||
  HANDSHAKESTATE_SPLIT_FAILED = 1020,
 | 
			
		||||
  BAD_HANDSHAKE_ERROR_BYTE = 1021,
 | 
			
		||||
  CONNECTION_CLOSED = 1022,
 | 
			
		||||
#endif
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const char *api_error_to_str(APIError err);
 | 
			
		||||
@@ -69,12 +71,13 @@ const char *api_error_to_str(APIError err);
 | 
			
		||||
class APIFrameHelper {
 | 
			
		||||
 public:
 | 
			
		||||
  APIFrameHelper() = default;
 | 
			
		||||
  explicit APIFrameHelper(std::unique_ptr<socket::Socket> socket) : socket_owned_(std::move(socket)) {
 | 
			
		||||
  explicit APIFrameHelper(std::unique_ptr<socket::Socket> socket, const ClientInfo *client_info)
 | 
			
		||||
      : socket_owned_(std::move(socket)), client_info_(client_info) {
 | 
			
		||||
    socket_ = socket_owned_.get();
 | 
			
		||||
  }
 | 
			
		||||
  virtual ~APIFrameHelper() = default;
 | 
			
		||||
  virtual APIError init() = 0;
 | 
			
		||||
  virtual APIError loop() = 0;
 | 
			
		||||
  virtual APIError loop();
 | 
			
		||||
  virtual APIError read_packet(ReadPacketBuffer *buffer) = 0;
 | 
			
		||||
  bool can_write_without_blocking() { return state_ == State::DATA && tx_buf_.empty(); }
 | 
			
		||||
  std::string getpeername() { return socket_->getpeername(); }
 | 
			
		||||
@@ -95,13 +98,11 @@ class APIFrameHelper {
 | 
			
		||||
    }
 | 
			
		||||
    return APIError::OK;
 | 
			
		||||
  }
 | 
			
		||||
  // Give this helper a name for logging
 | 
			
		||||
  void set_log_info(std::string info) { info_ = std::move(info); }
 | 
			
		||||
  virtual APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) = 0;
 | 
			
		||||
  virtual APIError write_protobuf_packet(uint8_t type, ProtoWriteBuffer buffer) = 0;
 | 
			
		||||
  // Write multiple protobuf packets in a single operation
 | 
			
		||||
  // packets contains (message_type, offset, length) for each message in the buffer
 | 
			
		||||
  // The buffer contains all messages with appropriate padding before each
 | 
			
		||||
  virtual APIError write_protobuf_packets(ProtoWriteBuffer buffer, const std::vector<PacketInfo> &packets) = 0;
 | 
			
		||||
  virtual APIError write_protobuf_packets(ProtoWriteBuffer buffer, std::span<const PacketInfo> packets) = 0;
 | 
			
		||||
  // Get the frame header padding required by this protocol
 | 
			
		||||
  virtual uint8_t frame_header_padding() = 0;
 | 
			
		||||
  // Get the frame footer size required by this protocol
 | 
			
		||||
@@ -110,23 +111,35 @@ class APIFrameHelper {
 | 
			
		||||
  bool is_socket_ready() const { return socket_ != nullptr && socket_->ready(); }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  // Struct for holding parsed frame data
 | 
			
		||||
  struct ParsedFrame {
 | 
			
		||||
    std::vector<uint8_t> msg;
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  // Buffer containing data to be sent
 | 
			
		||||
  struct SendBuffer {
 | 
			
		||||
    std::vector<uint8_t> data;
 | 
			
		||||
    uint16_t offset{0};  // Current offset within the buffer (uint16_t to reduce memory usage)
 | 
			
		||||
    std::unique_ptr<uint8_t[]> data;
 | 
			
		||||
    uint16_t size{0};    // Total size of the buffer
 | 
			
		||||
    uint16_t offset{0};  // Current offset within the buffer
 | 
			
		||||
 | 
			
		||||
    // Using uint16_t reduces memory usage since ESPHome API messages are limited to UINT16_MAX (65535) bytes
 | 
			
		||||
    uint16_t remaining() const { return static_cast<uint16_t>(data.size()) - offset; }
 | 
			
		||||
    const uint8_t *current_data() const { return data.data() + offset; }
 | 
			
		||||
    uint16_t remaining() const { return size - offset; }
 | 
			
		||||
    const uint8_t *current_data() const { return data.get() + offset; }
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  // Queue of data buffers to be sent
 | 
			
		||||
  std::deque<SendBuffer> tx_buf_;
 | 
			
		||||
  // Common implementation for writing raw data to socket
 | 
			
		||||
  APIError write_raw_(const struct iovec *iov, int iovcnt, uint16_t total_write_len);
 | 
			
		||||
 | 
			
		||||
  // Try to send data from the tx buffer
 | 
			
		||||
  APIError try_send_tx_buf_();
 | 
			
		||||
 | 
			
		||||
  // Helper method to buffer data from IOVs
 | 
			
		||||
  void buffer_data_from_iov_(const struct iovec *iov, int iovcnt, uint16_t total_write_len, uint16_t offset);
 | 
			
		||||
 | 
			
		||||
  // Common socket write error handling
 | 
			
		||||
  APIError handle_socket_write_error_();
 | 
			
		||||
  template<typename StateEnum>
 | 
			
		||||
  APIError write_raw_(const struct iovec *iov, int iovcnt, socket::Socket *socket, std::vector<uint8_t> &tx_buf,
 | 
			
		||||
                      const std::string &info, StateEnum &state, StateEnum failed_state);
 | 
			
		||||
 | 
			
		||||
  // Pointers first (4 bytes each)
 | 
			
		||||
  socket::Socket *socket_{nullptr};
 | 
			
		||||
  std::unique_ptr<socket::Socket> socket_owned_;
 | 
			
		||||
 | 
			
		||||
  // Common state enum for all frame helpers
 | 
			
		||||
  // Note: Not all states are used by all implementations
 | 
			
		||||
@@ -136,7 +149,7 @@ class APIFrameHelper {
 | 
			
		||||
  // - CLOSED: Used by both Noise and Plaintext
 | 
			
		||||
  // - FAILED: Used by both Noise and Plaintext
 | 
			
		||||
  // - EXPLICIT_REJECT: Only used by Noise protocol
 | 
			
		||||
  enum class State {
 | 
			
		||||
  enum class State : uint8_t {
 | 
			
		||||
    INITIALIZE = 1,
 | 
			
		||||
    CLIENT_HELLO = 2,  // Noise only
 | 
			
		||||
    SERVER_HELLO = 3,  // Noise only
 | 
			
		||||
@@ -147,127 +160,29 @@ class APIFrameHelper {
 | 
			
		||||
    EXPLICIT_REJECT = 8,  // Noise only
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  // Current state of the frame helper
 | 
			
		||||
  // Containers (size varies, but typically 12+ bytes on 32-bit)
 | 
			
		||||
  std::deque<SendBuffer> tx_buf_;
 | 
			
		||||
  std::vector<struct iovec> reusable_iovs_;
 | 
			
		||||
  std::vector<uint8_t> rx_buf_;
 | 
			
		||||
 | 
			
		||||
  // Pointer to client info (4 bytes on 32-bit)
 | 
			
		||||
  // Note: The pointed-to ClientInfo object must outlive this APIFrameHelper instance.
 | 
			
		||||
  const ClientInfo *client_info_{nullptr};
 | 
			
		||||
 | 
			
		||||
  // Group smaller types together
 | 
			
		||||
  uint16_t rx_buf_len_ = 0;
 | 
			
		||||
  State state_{State::INITIALIZE};
 | 
			
		||||
 | 
			
		||||
  // Helper name for logging
 | 
			
		||||
  std::string info_;
 | 
			
		||||
 | 
			
		||||
  // Socket for communication
 | 
			
		||||
  socket::Socket *socket_{nullptr};
 | 
			
		||||
  std::unique_ptr<socket::Socket> socket_owned_;
 | 
			
		||||
 | 
			
		||||
  // Common implementation for writing raw data to socket
 | 
			
		||||
  APIError write_raw_(const struct iovec *iov, int iovcnt);
 | 
			
		||||
 | 
			
		||||
  // Try to send data from the tx buffer
 | 
			
		||||
  APIError try_send_tx_buf_();
 | 
			
		||||
 | 
			
		||||
  // Helper method to buffer data from IOVs
 | 
			
		||||
  void buffer_data_from_iov_(const struct iovec *iov, int iovcnt, uint16_t total_write_len);
 | 
			
		||||
  template<typename StateEnum>
 | 
			
		||||
  APIError write_raw_(const struct iovec *iov, int iovcnt, socket::Socket *socket, std::vector<uint8_t> &tx_buf,
 | 
			
		||||
                      const std::string &info, StateEnum &state, StateEnum failed_state);
 | 
			
		||||
 | 
			
		||||
  uint8_t frame_header_padding_{0};
 | 
			
		||||
  uint8_t frame_footer_size_{0};
 | 
			
		||||
 | 
			
		||||
  // Reusable IOV array for write_protobuf_packets to avoid repeated allocations
 | 
			
		||||
  std::vector<struct iovec> reusable_iovs_;
 | 
			
		||||
 | 
			
		||||
  // Receive buffer for reading frame data
 | 
			
		||||
  std::vector<uint8_t> rx_buf_;
 | 
			
		||||
  uint16_t rx_buf_len_ = 0;
 | 
			
		||||
  // 5 bytes total, 3 bytes padding
 | 
			
		||||
 | 
			
		||||
  // Common initialization for both plaintext and noise protocols
 | 
			
		||||
  APIError init_common_();
 | 
			
		||||
 | 
			
		||||
  // Helper method to handle socket read results
 | 
			
		||||
  APIError handle_socket_read_result_(ssize_t received);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
class APINoiseFrameHelper : public APIFrameHelper {
 | 
			
		||||
 public:
 | 
			
		||||
  APINoiseFrameHelper(std::unique_ptr<socket::Socket> socket, std::shared_ptr<APINoiseContext> ctx)
 | 
			
		||||
      : APIFrameHelper(std::move(socket)), ctx_(std::move(ctx)) {
 | 
			
		||||
    // Noise header structure:
 | 
			
		||||
    // Pos 0: indicator (0x01)
 | 
			
		||||
    // Pos 1-2: encrypted payload size (16-bit big-endian)
 | 
			
		||||
    // Pos 3-6: encrypted type (16-bit) + data_len (16-bit)
 | 
			
		||||
    // Pos 7+: actual payload data
 | 
			
		||||
    frame_header_padding_ = 7;
 | 
			
		||||
  }
 | 
			
		||||
  ~APINoiseFrameHelper() override;
 | 
			
		||||
  APIError init() override;
 | 
			
		||||
  APIError loop() override;
 | 
			
		||||
  APIError read_packet(ReadPacketBuffer *buffer) override;
 | 
			
		||||
  APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override;
 | 
			
		||||
  APIError write_protobuf_packets(ProtoWriteBuffer buffer, const std::vector<PacketInfo> &packets) override;
 | 
			
		||||
  // Get the frame header padding required by this protocol
 | 
			
		||||
  uint8_t frame_header_padding() override { return frame_header_padding_; }
 | 
			
		||||
  // Get the frame footer size required by this protocol
 | 
			
		||||
  uint8_t frame_footer_size() override { return frame_footer_size_; }
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  APIError state_action_();
 | 
			
		||||
  APIError try_read_frame_(ParsedFrame *frame);
 | 
			
		||||
  APIError write_frame_(const uint8_t *data, uint16_t len);
 | 
			
		||||
  APIError init_handshake_();
 | 
			
		||||
  APIError check_handshake_finished_();
 | 
			
		||||
  void send_explicit_handshake_reject_(const std::string &reason);
 | 
			
		||||
  // Fixed-size header buffer for noise protocol:
 | 
			
		||||
  // 1 byte for indicator + 2 bytes for message size (16-bit value, not varint)
 | 
			
		||||
  // Note: Maximum message size is UINT16_MAX (65535), with a limit of 128 bytes during handshake phase
 | 
			
		||||
  uint8_t rx_header_buf_[3];
 | 
			
		||||
  uint8_t rx_header_buf_len_ = 0;
 | 
			
		||||
 | 
			
		||||
  std::vector<uint8_t> prologue_;
 | 
			
		||||
 | 
			
		||||
  std::shared_ptr<APINoiseContext> ctx_;
 | 
			
		||||
  NoiseHandshakeState *handshake_{nullptr};
 | 
			
		||||
  NoiseCipherState *send_cipher_{nullptr};
 | 
			
		||||
  NoiseCipherState *recv_cipher_{nullptr};
 | 
			
		||||
  NoiseProtocolId nid_;
 | 
			
		||||
};
 | 
			
		||||
#endif  // USE_API_NOISE
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_PLAINTEXT
 | 
			
		||||
class APIPlaintextFrameHelper : public APIFrameHelper {
 | 
			
		||||
 public:
 | 
			
		||||
  APIPlaintextFrameHelper(std::unique_ptr<socket::Socket> socket) : APIFrameHelper(std::move(socket)) {
 | 
			
		||||
    // Plaintext header structure (worst case):
 | 
			
		||||
    // Pos 0: indicator (0x00)
 | 
			
		||||
    // Pos 1-3: payload size varint (up to 3 bytes)
 | 
			
		||||
    // Pos 4-5: message type varint (up to 2 bytes)
 | 
			
		||||
    // Pos 6+: actual payload data
 | 
			
		||||
    frame_header_padding_ = 6;
 | 
			
		||||
  }
 | 
			
		||||
  ~APIPlaintextFrameHelper() override = default;
 | 
			
		||||
  APIError init() override;
 | 
			
		||||
  APIError loop() override;
 | 
			
		||||
  APIError read_packet(ReadPacketBuffer *buffer) override;
 | 
			
		||||
  APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override;
 | 
			
		||||
  APIError write_protobuf_packets(ProtoWriteBuffer buffer, const std::vector<PacketInfo> &packets) override;
 | 
			
		||||
  uint8_t frame_header_padding() override { return frame_header_padding_; }
 | 
			
		||||
  // Get the frame footer size required by this protocol
 | 
			
		||||
  uint8_t frame_footer_size() override { return frame_footer_size_; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  APIError try_read_frame_(ParsedFrame *frame);
 | 
			
		||||
  // Fixed-size header buffer for plaintext protocol:
 | 
			
		||||
  // We now store the indicator byte + the two varints.
 | 
			
		||||
  // To match noise protocol's maximum message size (UINT16_MAX = 65535), we need:
 | 
			
		||||
  // 1 byte for indicator + 3 bytes for message size varint (supports up to 2097151) + 2 bytes for message type varint
 | 
			
		||||
  //
 | 
			
		||||
  // While varints could theoretically be up to 10 bytes each for 64-bit values,
 | 
			
		||||
  // attempting to process messages with headers that large would likely crash the
 | 
			
		||||
  // ESP32 due to memory constraints.
 | 
			
		||||
  uint8_t rx_header_buf_[6];  // 1 byte indicator + 5 bytes for varints (3 for size + 2 for type)
 | 
			
		||||
  uint8_t rx_header_buf_pos_ = 0;
 | 
			
		||||
  bool rx_header_parsed_ = false;
 | 
			
		||||
  uint16_t rx_header_parsed_type_ = 0;
 | 
			
		||||
  uint16_t rx_header_parsed_len_ = 0;
 | 
			
		||||
};
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
#endif  // USE_API
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										583
									
								
								esphome/components/api/api_frame_helper_noise.cpp
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										583
									
								
								esphome/components/api/api_frame_helper_noise.cpp
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,583 @@
 | 
			
		||||
#include "api_frame_helper_noise.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
#include "api_connection.h"  // For ClientInfo struct
 | 
			
		||||
#include "esphome/core/application.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "proto.h"
 | 
			
		||||
#include <cstring>
 | 
			
		||||
#include <cinttypes>
 | 
			
		||||
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "api.noise";
 | 
			
		||||
static const char *const PROLOGUE_INIT = "NoiseAPIInit";
 | 
			
		||||
static constexpr size_t PROLOGUE_INIT_LEN = 12;  // strlen("NoiseAPIInit")
 | 
			
		||||
 | 
			
		||||
#define HELPER_LOG(msg, ...) ESP_LOGVV(TAG, "%s: " msg, this->client_info_->get_combined_info().c_str(), ##__VA_ARGS__)
 | 
			
		||||
 | 
			
		||||
#ifdef HELPER_LOG_PACKETS
 | 
			
		||||
#define LOG_PACKET_RECEIVED(buffer) ESP_LOGVV(TAG, "Received frame: %s", format_hex_pretty(buffer).c_str())
 | 
			
		||||
#define LOG_PACKET_SENDING(data, len) ESP_LOGVV(TAG, "Sending raw: %s", format_hex_pretty(data, len).c_str())
 | 
			
		||||
#else
 | 
			
		||||
#define LOG_PACKET_RECEIVED(buffer) ((void) 0)
 | 
			
		||||
#define LOG_PACKET_SENDING(data, len) ((void) 0)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
/// Convert a noise error code to a readable error
 | 
			
		||||
std::string noise_err_to_str(int err) {
 | 
			
		||||
  if (err == NOISE_ERROR_NO_MEMORY)
 | 
			
		||||
    return "NO_MEMORY";
 | 
			
		||||
  if (err == NOISE_ERROR_UNKNOWN_ID)
 | 
			
		||||
    return "UNKNOWN_ID";
 | 
			
		||||
  if (err == NOISE_ERROR_UNKNOWN_NAME)
 | 
			
		||||
    return "UNKNOWN_NAME";
 | 
			
		||||
  if (err == NOISE_ERROR_MAC_FAILURE)
 | 
			
		||||
    return "MAC_FAILURE";
 | 
			
		||||
  if (err == NOISE_ERROR_NOT_APPLICABLE)
 | 
			
		||||
    return "NOT_APPLICABLE";
 | 
			
		||||
  if (err == NOISE_ERROR_SYSTEM)
 | 
			
		||||
    return "SYSTEM";
 | 
			
		||||
  if (err == NOISE_ERROR_REMOTE_KEY_REQUIRED)
 | 
			
		||||
    return "REMOTE_KEY_REQUIRED";
 | 
			
		||||
  if (err == NOISE_ERROR_LOCAL_KEY_REQUIRED)
 | 
			
		||||
    return "LOCAL_KEY_REQUIRED";
 | 
			
		||||
  if (err == NOISE_ERROR_PSK_REQUIRED)
 | 
			
		||||
    return "PSK_REQUIRED";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_LENGTH)
 | 
			
		||||
    return "INVALID_LENGTH";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_PARAM)
 | 
			
		||||
    return "INVALID_PARAM";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_STATE)
 | 
			
		||||
    return "INVALID_STATE";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_NONCE)
 | 
			
		||||
    return "INVALID_NONCE";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_PRIVATE_KEY)
 | 
			
		||||
    return "INVALID_PRIVATE_KEY";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_PUBLIC_KEY)
 | 
			
		||||
    return "INVALID_PUBLIC_KEY";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_FORMAT)
 | 
			
		||||
    return "INVALID_FORMAT";
 | 
			
		||||
  if (err == NOISE_ERROR_INVALID_SIGNATURE)
 | 
			
		||||
    return "INVALID_SIGNATURE";
 | 
			
		||||
  return to_string(err);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Initialize the frame helper, returns OK if successful.
 | 
			
		||||
APIError APINoiseFrameHelper::init() {
 | 
			
		||||
  APIError err = init_common_();
 | 
			
		||||
  if (err != APIError::OK) {
 | 
			
		||||
    return err;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // init prologue
 | 
			
		||||
  size_t old_size = prologue_.size();
 | 
			
		||||
  prologue_.resize(old_size + PROLOGUE_INIT_LEN);
 | 
			
		||||
  std::memcpy(prologue_.data() + old_size, PROLOGUE_INIT, PROLOGUE_INIT_LEN);
 | 
			
		||||
 | 
			
		||||
  state_ = State::CLIENT_HELLO;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
// Helper for handling handshake frame errors
 | 
			
		||||
APIError APINoiseFrameHelper::handle_handshake_frame_error_(APIError aerr) {
 | 
			
		||||
  if (aerr == APIError::BAD_INDICATOR) {
 | 
			
		||||
    send_explicit_handshake_reject_("Bad indicator byte");
 | 
			
		||||
  } else if (aerr == APIError::BAD_HANDSHAKE_PACKET_LEN) {
 | 
			
		||||
    send_explicit_handshake_reject_("Bad handshake packet len");
 | 
			
		||||
  }
 | 
			
		||||
  return aerr;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Helper for handling noise library errors
 | 
			
		||||
APIError APINoiseFrameHelper::handle_noise_error_(int err, const char *func_name, APIError api_err) {
 | 
			
		||||
  if (err != 0) {
 | 
			
		||||
    state_ = State::FAILED;
 | 
			
		||||
    HELPER_LOG("%s failed: %s", func_name, noise_err_to_str(err).c_str());
 | 
			
		||||
    return api_err;
 | 
			
		||||
  }
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/// Run through handshake messages (if in that phase)
 | 
			
		||||
APIError APINoiseFrameHelper::loop() {
 | 
			
		||||
  // During handshake phase, process as many actions as possible until we can't progress
 | 
			
		||||
  // socket_->ready() stays true until next main loop, but state_action() will return
 | 
			
		||||
  // WOULD_BLOCK when no more data is available to read
 | 
			
		||||
  while (state_ != State::DATA && this->socket_->ready()) {
 | 
			
		||||
    APIError err = state_action_();
 | 
			
		||||
    if (err == APIError::WOULD_BLOCK) {
 | 
			
		||||
      break;
 | 
			
		||||
    }
 | 
			
		||||
    if (err != APIError::OK) {
 | 
			
		||||
      return err;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Use base class implementation for buffer sending
 | 
			
		||||
  return APIFrameHelper::loop();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/** Read a packet into the rx_buf_. If successful, stores frame data in the frame parameter
 | 
			
		||||
 *
 | 
			
		||||
 * @param frame: The struct to hold the frame information in.
 | 
			
		||||
 *   msg_start: points to the start of the payload - this pointer is only valid until the next
 | 
			
		||||
 *     try_receive_raw_ call
 | 
			
		||||
 *
 | 
			
		||||
 * @return 0 if a full packet is in rx_buf_
 | 
			
		||||
 * @return -1 if error, check errno.
 | 
			
		||||
 *
 | 
			
		||||
 * errno EWOULDBLOCK: Packet could not be read without blocking. Try again later.
 | 
			
		||||
 * errno ENOMEM: Not enough memory for reading packet.
 | 
			
		||||
 * errno API_ERROR_BAD_INDICATOR: Bad indicator byte at start of frame.
 | 
			
		||||
 * errno API_ERROR_HANDSHAKE_PACKET_LEN: Packet too big for this phase.
 | 
			
		||||
 */
 | 
			
		||||
APIError APINoiseFrameHelper::try_read_frame_(std::vector<uint8_t> *frame) {
 | 
			
		||||
  if (frame == nullptr) {
 | 
			
		||||
    HELPER_LOG("Bad argument for try_read_frame_");
 | 
			
		||||
    return APIError::BAD_ARG;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // read header
 | 
			
		||||
  if (rx_header_buf_len_ < 3) {
 | 
			
		||||
    // no header information yet
 | 
			
		||||
    uint8_t to_read = 3 - rx_header_buf_len_;
 | 
			
		||||
    ssize_t received = this->socket_->read(&rx_header_buf_[rx_header_buf_len_], to_read);
 | 
			
		||||
    APIError err = handle_socket_read_result_(received);
 | 
			
		||||
    if (err != APIError::OK) {
 | 
			
		||||
      return err;
 | 
			
		||||
    }
 | 
			
		||||
    rx_header_buf_len_ += static_cast<uint8_t>(received);
 | 
			
		||||
    if (static_cast<uint8_t>(received) != to_read) {
 | 
			
		||||
      // not a full read
 | 
			
		||||
      return APIError::WOULD_BLOCK;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (rx_header_buf_[0] != 0x01) {
 | 
			
		||||
      state_ = State::FAILED;
 | 
			
		||||
      HELPER_LOG("Bad indicator byte %u", rx_header_buf_[0]);
 | 
			
		||||
      return APIError::BAD_INDICATOR;
 | 
			
		||||
    }
 | 
			
		||||
    // header reading done
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // read body
 | 
			
		||||
  uint16_t msg_size = (((uint16_t) rx_header_buf_[1]) << 8) | rx_header_buf_[2];
 | 
			
		||||
 | 
			
		||||
  if (state_ != State::DATA && msg_size > 128) {
 | 
			
		||||
    // for handshake message only permit up to 128 bytes
 | 
			
		||||
    state_ = State::FAILED;
 | 
			
		||||
    HELPER_LOG("Bad packet len for handshake: %d", msg_size);
 | 
			
		||||
    return APIError::BAD_HANDSHAKE_PACKET_LEN;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // reserve space for body
 | 
			
		||||
  if (rx_buf_.size() != msg_size) {
 | 
			
		||||
    rx_buf_.resize(msg_size);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (rx_buf_len_ < msg_size) {
 | 
			
		||||
    // more data to read
 | 
			
		||||
    uint16_t to_read = msg_size - rx_buf_len_;
 | 
			
		||||
    ssize_t received = this->socket_->read(&rx_buf_[rx_buf_len_], to_read);
 | 
			
		||||
    APIError err = handle_socket_read_result_(received);
 | 
			
		||||
    if (err != APIError::OK) {
 | 
			
		||||
      return err;
 | 
			
		||||
    }
 | 
			
		||||
    rx_buf_len_ += static_cast<uint16_t>(received);
 | 
			
		||||
    if (static_cast<uint16_t>(received) != to_read) {
 | 
			
		||||
      // not all read
 | 
			
		||||
      return APIError::WOULD_BLOCK;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  LOG_PACKET_RECEIVED(rx_buf_);
 | 
			
		||||
  *frame = std::move(rx_buf_);
 | 
			
		||||
  // consume msg
 | 
			
		||||
  rx_buf_ = {};
 | 
			
		||||
  rx_buf_len_ = 0;
 | 
			
		||||
  rx_header_buf_len_ = 0;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/** To be called from read/write methods.
 | 
			
		||||
 *
 | 
			
		||||
 * This method runs through the internal handshake methods, if in that state.
 | 
			
		||||
 *
 | 
			
		||||
 * If the handshake is still active when this method returns and a read/write can't take place at
 | 
			
		||||
 * the moment, returns WOULD_BLOCK.
 | 
			
		||||
 * If an error occurred, returns that error. Only returns OK if the transport is ready for data
 | 
			
		||||
 * traffic.
 | 
			
		||||
 */
 | 
			
		||||
APIError APINoiseFrameHelper::state_action_() {
 | 
			
		||||
  int err;
 | 
			
		||||
  APIError aerr;
 | 
			
		||||
  if (state_ == State::INITIALIZE) {
 | 
			
		||||
    HELPER_LOG("Bad state for method: %d", (int) state_);
 | 
			
		||||
    return APIError::BAD_STATE;
 | 
			
		||||
  }
 | 
			
		||||
  if (state_ == State::CLIENT_HELLO) {
 | 
			
		||||
    // waiting for client hello
 | 
			
		||||
    std::vector<uint8_t> frame;
 | 
			
		||||
    aerr = try_read_frame_(&frame);
 | 
			
		||||
    if (aerr != APIError::OK) {
 | 
			
		||||
      return handle_handshake_frame_error_(aerr);
 | 
			
		||||
    }
 | 
			
		||||
    // ignore contents, may be used in future for flags
 | 
			
		||||
    // Resize for: existing prologue + 2 size bytes + frame data
 | 
			
		||||
    size_t old_size = prologue_.size();
 | 
			
		||||
    prologue_.resize(old_size + 2 + frame.size());
 | 
			
		||||
    prologue_[old_size] = (uint8_t) (frame.size() >> 8);
 | 
			
		||||
    prologue_[old_size + 1] = (uint8_t) frame.size();
 | 
			
		||||
    std::memcpy(prologue_.data() + old_size + 2, frame.data(), frame.size());
 | 
			
		||||
 | 
			
		||||
    state_ = State::SERVER_HELLO;
 | 
			
		||||
  }
 | 
			
		||||
  if (state_ == State::SERVER_HELLO) {
 | 
			
		||||
    // send server hello
 | 
			
		||||
    const std::string &name = App.get_name();
 | 
			
		||||
    const std::string &mac = get_mac_address();
 | 
			
		||||
 | 
			
		||||
    std::vector<uint8_t> msg;
 | 
			
		||||
    // Calculate positions and sizes
 | 
			
		||||
    size_t name_len = name.size() + 1;  // including null terminator
 | 
			
		||||
    size_t mac_len = mac.size() + 1;    // including null terminator
 | 
			
		||||
    size_t name_offset = 1;
 | 
			
		||||
    size_t mac_offset = name_offset + name_len;
 | 
			
		||||
    size_t total_size = 1 + name_len + mac_len;
 | 
			
		||||
 | 
			
		||||
    msg.resize(total_size);
 | 
			
		||||
 | 
			
		||||
    // chosen proto
 | 
			
		||||
    msg[0] = 0x01;
 | 
			
		||||
 | 
			
		||||
    // node name, terminated by null byte
 | 
			
		||||
    std::memcpy(msg.data() + name_offset, name.c_str(), name_len);
 | 
			
		||||
    // node mac, terminated by null byte
 | 
			
		||||
    std::memcpy(msg.data() + mac_offset, mac.c_str(), mac_len);
 | 
			
		||||
 | 
			
		||||
    aerr = write_frame_(msg.data(), msg.size());
 | 
			
		||||
    if (aerr != APIError::OK)
 | 
			
		||||
      return aerr;
 | 
			
		||||
 | 
			
		||||
    // start handshake
 | 
			
		||||
    aerr = init_handshake_();
 | 
			
		||||
    if (aerr != APIError::OK)
 | 
			
		||||
      return aerr;
 | 
			
		||||
 | 
			
		||||
    state_ = State::HANDSHAKE;
 | 
			
		||||
  }
 | 
			
		||||
  if (state_ == State::HANDSHAKE) {
 | 
			
		||||
    int action = noise_handshakestate_get_action(handshake_);
 | 
			
		||||
    if (action == NOISE_ACTION_READ_MESSAGE) {
 | 
			
		||||
      // waiting for handshake msg
 | 
			
		||||
      std::vector<uint8_t> frame;
 | 
			
		||||
      aerr = try_read_frame_(&frame);
 | 
			
		||||
      if (aerr != APIError::OK) {
 | 
			
		||||
        return handle_handshake_frame_error_(aerr);
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      if (frame.empty()) {
 | 
			
		||||
        send_explicit_handshake_reject_("Empty handshake message");
 | 
			
		||||
        return APIError::BAD_HANDSHAKE_ERROR_BYTE;
 | 
			
		||||
      } else if (frame[0] != 0x00) {
 | 
			
		||||
        HELPER_LOG("Bad handshake error byte: %u", frame[0]);
 | 
			
		||||
        send_explicit_handshake_reject_("Bad handshake error byte");
 | 
			
		||||
        return APIError::BAD_HANDSHAKE_ERROR_BYTE;
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      NoiseBuffer mbuf;
 | 
			
		||||
      noise_buffer_init(mbuf);
 | 
			
		||||
      noise_buffer_set_input(mbuf, frame.data() + 1, frame.size() - 1);
 | 
			
		||||
      err = noise_handshakestate_read_message(handshake_, &mbuf, nullptr);
 | 
			
		||||
      if (err != 0) {
 | 
			
		||||
        // Special handling for MAC failure
 | 
			
		||||
        send_explicit_handshake_reject_(err == NOISE_ERROR_MAC_FAILURE ? "Handshake MAC failure" : "Handshake error");
 | 
			
		||||
        return handle_noise_error_(err, "noise_handshakestate_read_message", APIError::HANDSHAKESTATE_READ_FAILED);
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      aerr = check_handshake_finished_();
 | 
			
		||||
      if (aerr != APIError::OK)
 | 
			
		||||
        return aerr;
 | 
			
		||||
    } else if (action == NOISE_ACTION_WRITE_MESSAGE) {
 | 
			
		||||
      uint8_t buffer[65];
 | 
			
		||||
      NoiseBuffer mbuf;
 | 
			
		||||
      noise_buffer_init(mbuf);
 | 
			
		||||
      noise_buffer_set_output(mbuf, buffer + 1, sizeof(buffer) - 1);
 | 
			
		||||
 | 
			
		||||
      err = noise_handshakestate_write_message(handshake_, &mbuf, nullptr);
 | 
			
		||||
      APIError aerr_write =
 | 
			
		||||
          handle_noise_error_(err, "noise_handshakestate_write_message", APIError::HANDSHAKESTATE_WRITE_FAILED);
 | 
			
		||||
      if (aerr_write != APIError::OK)
 | 
			
		||||
        return aerr_write;
 | 
			
		||||
      buffer[0] = 0x00;  // success
 | 
			
		||||
 | 
			
		||||
      aerr = write_frame_(buffer, mbuf.size + 1);
 | 
			
		||||
      if (aerr != APIError::OK)
 | 
			
		||||
        return aerr;
 | 
			
		||||
      aerr = check_handshake_finished_();
 | 
			
		||||
      if (aerr != APIError::OK)
 | 
			
		||||
        return aerr;
 | 
			
		||||
    } else {
 | 
			
		||||
      // bad state for action
 | 
			
		||||
      state_ = State::FAILED;
 | 
			
		||||
      HELPER_LOG("Bad action for handshake: %d", action);
 | 
			
		||||
      return APIError::HANDSHAKESTATE_BAD_STATE;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
  if (state_ == State::CLOSED || state_ == State::FAILED) {
 | 
			
		||||
    return APIError::BAD_STATE;
 | 
			
		||||
  }
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
void APINoiseFrameHelper::send_explicit_handshake_reject_(const std::string &reason) {
 | 
			
		||||
  std::vector<uint8_t> data;
 | 
			
		||||
  data.resize(reason.length() + 1);
 | 
			
		||||
  data[0] = 0x01;  // failure
 | 
			
		||||
 | 
			
		||||
  // Copy error message in bulk
 | 
			
		||||
  if (!reason.empty()) {
 | 
			
		||||
    std::memcpy(data.data() + 1, reason.c_str(), reason.length());
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // temporarily remove failed state
 | 
			
		||||
  auto orig_state = state_;
 | 
			
		||||
  state_ = State::EXPLICIT_REJECT;
 | 
			
		||||
  write_frame_(data.data(), data.size());
 | 
			
		||||
  state_ = orig_state;
 | 
			
		||||
}
 | 
			
		||||
APIError APINoiseFrameHelper::read_packet(ReadPacketBuffer *buffer) {
 | 
			
		||||
  int err;
 | 
			
		||||
  APIError aerr;
 | 
			
		||||
  aerr = state_action_();
 | 
			
		||||
  if (aerr != APIError::OK) {
 | 
			
		||||
    return aerr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (state_ != State::DATA) {
 | 
			
		||||
    return APIError::WOULD_BLOCK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  std::vector<uint8_t> frame;
 | 
			
		||||
  aerr = try_read_frame_(&frame);
 | 
			
		||||
  if (aerr != APIError::OK)
 | 
			
		||||
    return aerr;
 | 
			
		||||
 | 
			
		||||
  NoiseBuffer mbuf;
 | 
			
		||||
  noise_buffer_init(mbuf);
 | 
			
		||||
  noise_buffer_set_inout(mbuf, frame.data(), frame.size(), frame.size());
 | 
			
		||||
  err = noise_cipherstate_decrypt(recv_cipher_, &mbuf);
 | 
			
		||||
  APIError decrypt_err = handle_noise_error_(err, "noise_cipherstate_decrypt", APIError::CIPHERSTATE_DECRYPT_FAILED);
 | 
			
		||||
  if (decrypt_err != APIError::OK)
 | 
			
		||||
    return decrypt_err;
 | 
			
		||||
 | 
			
		||||
  uint16_t msg_size = mbuf.size;
 | 
			
		||||
  uint8_t *msg_data = frame.data();
 | 
			
		||||
  if (msg_size < 4) {
 | 
			
		||||
    state_ = State::FAILED;
 | 
			
		||||
    HELPER_LOG("Bad data packet: size %d too short", msg_size);
 | 
			
		||||
    return APIError::BAD_DATA_PACKET;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  uint16_t type = (((uint16_t) msg_data[0]) << 8) | msg_data[1];
 | 
			
		||||
  uint16_t data_len = (((uint16_t) msg_data[2]) << 8) | msg_data[3];
 | 
			
		||||
  if (data_len > msg_size - 4) {
 | 
			
		||||
    state_ = State::FAILED;
 | 
			
		||||
    HELPER_LOG("Bad data packet: data_len %u greater than msg_size %u", data_len, msg_size);
 | 
			
		||||
    return APIError::BAD_DATA_PACKET;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  buffer->container = std::move(frame);
 | 
			
		||||
  buffer->data_offset = 4;
 | 
			
		||||
  buffer->data_len = data_len;
 | 
			
		||||
  buffer->type = type;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
APIError APINoiseFrameHelper::write_protobuf_packet(uint8_t type, ProtoWriteBuffer buffer) {
 | 
			
		||||
  // Resize to include MAC space (required for Noise encryption)
 | 
			
		||||
  buffer.get_buffer()->resize(buffer.get_buffer()->size() + frame_footer_size_);
 | 
			
		||||
  PacketInfo packet{type, 0,
 | 
			
		||||
                    static_cast<uint16_t>(buffer.get_buffer()->size() - frame_header_padding_ - frame_footer_size_)};
 | 
			
		||||
  return write_protobuf_packets(buffer, std::span<const PacketInfo>(&packet, 1));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
APIError APINoiseFrameHelper::write_protobuf_packets(ProtoWriteBuffer buffer, std::span<const PacketInfo> packets) {
 | 
			
		||||
  APIError aerr = state_action_();
 | 
			
		||||
  if (aerr != APIError::OK) {
 | 
			
		||||
    return aerr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (state_ != State::DATA) {
 | 
			
		||||
    return APIError::WOULD_BLOCK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (packets.empty()) {
 | 
			
		||||
    return APIError::OK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  std::vector<uint8_t> *raw_buffer = buffer.get_buffer();
 | 
			
		||||
  uint8_t *buffer_data = raw_buffer->data();  // Cache buffer pointer
 | 
			
		||||
 | 
			
		||||
  this->reusable_iovs_.clear();
 | 
			
		||||
  this->reusable_iovs_.reserve(packets.size());
 | 
			
		||||
  uint16_t total_write_len = 0;
 | 
			
		||||
 | 
			
		||||
  // We need to encrypt each packet in place
 | 
			
		||||
  for (const auto &packet : packets) {
 | 
			
		||||
    // The buffer already has padding at offset
 | 
			
		||||
    uint8_t *buf_start = buffer_data + packet.offset;
 | 
			
		||||
 | 
			
		||||
    // Write noise header
 | 
			
		||||
    buf_start[0] = 0x01;  // indicator
 | 
			
		||||
    // buf_start[1], buf_start[2] to be set after encryption
 | 
			
		||||
 | 
			
		||||
    // Write message header (to be encrypted)
 | 
			
		||||
    const uint8_t msg_offset = 3;
 | 
			
		||||
    buf_start[msg_offset] = static_cast<uint8_t>(packet.message_type >> 8);      // type high byte
 | 
			
		||||
    buf_start[msg_offset + 1] = static_cast<uint8_t>(packet.message_type);       // type low byte
 | 
			
		||||
    buf_start[msg_offset + 2] = static_cast<uint8_t>(packet.payload_size >> 8);  // data_len high byte
 | 
			
		||||
    buf_start[msg_offset + 3] = static_cast<uint8_t>(packet.payload_size);       // data_len low byte
 | 
			
		||||
    // payload data is already in the buffer starting at offset + 7
 | 
			
		||||
 | 
			
		||||
    // Make sure we have space for MAC
 | 
			
		||||
    // The buffer should already have been sized appropriately
 | 
			
		||||
 | 
			
		||||
    // Encrypt the message in place
 | 
			
		||||
    NoiseBuffer mbuf;
 | 
			
		||||
    noise_buffer_init(mbuf);
 | 
			
		||||
    noise_buffer_set_inout(mbuf, buf_start + msg_offset, 4 + packet.payload_size,
 | 
			
		||||
                           4 + packet.payload_size + frame_footer_size_);
 | 
			
		||||
 | 
			
		||||
    int err = noise_cipherstate_encrypt(send_cipher_, &mbuf);
 | 
			
		||||
    APIError aerr = handle_noise_error_(err, "noise_cipherstate_encrypt", APIError::CIPHERSTATE_ENCRYPT_FAILED);
 | 
			
		||||
    if (aerr != APIError::OK)
 | 
			
		||||
      return aerr;
 | 
			
		||||
 | 
			
		||||
    // Fill in the encrypted size
 | 
			
		||||
    buf_start[1] = static_cast<uint8_t>(mbuf.size >> 8);
 | 
			
		||||
    buf_start[2] = static_cast<uint8_t>(mbuf.size);
 | 
			
		||||
 | 
			
		||||
    // Add iovec for this encrypted packet
 | 
			
		||||
    size_t packet_len = static_cast<size_t>(3 + mbuf.size);  // indicator + size + encrypted data
 | 
			
		||||
    this->reusable_iovs_.push_back({buf_start, packet_len});
 | 
			
		||||
    total_write_len += packet_len;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Send all encrypted packets in one writev call
 | 
			
		||||
  return this->write_raw_(this->reusable_iovs_.data(), this->reusable_iovs_.size(), total_write_len);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
APIError APINoiseFrameHelper::write_frame_(const uint8_t *data, uint16_t len) {
 | 
			
		||||
  uint8_t header[3];
 | 
			
		||||
  header[0] = 0x01;  // indicator
 | 
			
		||||
  header[1] = (uint8_t) (len >> 8);
 | 
			
		||||
  header[2] = (uint8_t) len;
 | 
			
		||||
 | 
			
		||||
  struct iovec iov[2];
 | 
			
		||||
  iov[0].iov_base = header;
 | 
			
		||||
  iov[0].iov_len = 3;
 | 
			
		||||
  if (len == 0) {
 | 
			
		||||
    return this->write_raw_(iov, 1, 3);  // Just header
 | 
			
		||||
  }
 | 
			
		||||
  iov[1].iov_base = const_cast<uint8_t *>(data);
 | 
			
		||||
  iov[1].iov_len = len;
 | 
			
		||||
 | 
			
		||||
  return this->write_raw_(iov, 2, 3 + len);  // Header + data
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/** Initiate the data structures for the handshake.
 | 
			
		||||
 *
 | 
			
		||||
 * @return 0 on success, -1 on error (check errno)
 | 
			
		||||
 */
 | 
			
		||||
APIError APINoiseFrameHelper::init_handshake_() {
 | 
			
		||||
  int err;
 | 
			
		||||
  memset(&nid_, 0, sizeof(nid_));
 | 
			
		||||
  // const char *proto = "Noise_NNpsk0_25519_ChaChaPoly_SHA256";
 | 
			
		||||
  // err = noise_protocol_name_to_id(&nid_, proto, strlen(proto));
 | 
			
		||||
  nid_.pattern_id = NOISE_PATTERN_NN;
 | 
			
		||||
  nid_.cipher_id = NOISE_CIPHER_CHACHAPOLY;
 | 
			
		||||
  nid_.dh_id = NOISE_DH_CURVE25519;
 | 
			
		||||
  nid_.prefix_id = NOISE_PREFIX_STANDARD;
 | 
			
		||||
  nid_.hybrid_id = NOISE_DH_NONE;
 | 
			
		||||
  nid_.hash_id = NOISE_HASH_SHA256;
 | 
			
		||||
  nid_.modifier_ids[0] = NOISE_MODIFIER_PSK0;
 | 
			
		||||
 | 
			
		||||
  err = noise_handshakestate_new_by_id(&handshake_, &nid_, NOISE_ROLE_RESPONDER);
 | 
			
		||||
  APIError aerr = handle_noise_error_(err, "noise_handshakestate_new_by_id", APIError::HANDSHAKESTATE_SETUP_FAILED);
 | 
			
		||||
  if (aerr != APIError::OK)
 | 
			
		||||
    return aerr;
 | 
			
		||||
 | 
			
		||||
  const auto &psk = ctx_->get_psk();
 | 
			
		||||
  err = noise_handshakestate_set_pre_shared_key(handshake_, psk.data(), psk.size());
 | 
			
		||||
  aerr = handle_noise_error_(err, "noise_handshakestate_set_pre_shared_key", APIError::HANDSHAKESTATE_SETUP_FAILED);
 | 
			
		||||
  if (aerr != APIError::OK)
 | 
			
		||||
    return aerr;
 | 
			
		||||
 | 
			
		||||
  err = noise_handshakestate_set_prologue(handshake_, prologue_.data(), prologue_.size());
 | 
			
		||||
  aerr = handle_noise_error_(err, "noise_handshakestate_set_prologue", APIError::HANDSHAKESTATE_SETUP_FAILED);
 | 
			
		||||
  if (aerr != APIError::OK)
 | 
			
		||||
    return aerr;
 | 
			
		||||
  // set_prologue copies it into handshakestate, so we can get rid of it now
 | 
			
		||||
  prologue_ = {};
 | 
			
		||||
 | 
			
		||||
  err = noise_handshakestate_start(handshake_);
 | 
			
		||||
  aerr = handle_noise_error_(err, "noise_handshakestate_start", APIError::HANDSHAKESTATE_SETUP_FAILED);
 | 
			
		||||
  if (aerr != APIError::OK)
 | 
			
		||||
    return aerr;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
APIError APINoiseFrameHelper::check_handshake_finished_() {
 | 
			
		||||
  assert(state_ == State::HANDSHAKE);
 | 
			
		||||
 | 
			
		||||
  int action = noise_handshakestate_get_action(handshake_);
 | 
			
		||||
  if (action == NOISE_ACTION_READ_MESSAGE || action == NOISE_ACTION_WRITE_MESSAGE)
 | 
			
		||||
    return APIError::OK;
 | 
			
		||||
  if (action != NOISE_ACTION_SPLIT) {
 | 
			
		||||
    state_ = State::FAILED;
 | 
			
		||||
    HELPER_LOG("Bad action for handshake: %d", action);
 | 
			
		||||
    return APIError::HANDSHAKESTATE_BAD_STATE;
 | 
			
		||||
  }
 | 
			
		||||
  int err = noise_handshakestate_split(handshake_, &send_cipher_, &recv_cipher_);
 | 
			
		||||
  APIError aerr = handle_noise_error_(err, "noise_handshakestate_split", APIError::HANDSHAKESTATE_SPLIT_FAILED);
 | 
			
		||||
  if (aerr != APIError::OK)
 | 
			
		||||
    return aerr;
 | 
			
		||||
 | 
			
		||||
  frame_footer_size_ = noise_cipherstate_get_mac_length(send_cipher_);
 | 
			
		||||
 | 
			
		||||
  HELPER_LOG("Handshake complete!");
 | 
			
		||||
  noise_handshakestate_free(handshake_);
 | 
			
		||||
  handshake_ = nullptr;
 | 
			
		||||
  state_ = State::DATA;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
APINoiseFrameHelper::~APINoiseFrameHelper() {
 | 
			
		||||
  if (handshake_ != nullptr) {
 | 
			
		||||
    noise_handshakestate_free(handshake_);
 | 
			
		||||
    handshake_ = nullptr;
 | 
			
		||||
  }
 | 
			
		||||
  if (send_cipher_ != nullptr) {
 | 
			
		||||
    noise_cipherstate_free(send_cipher_);
 | 
			
		||||
    send_cipher_ = nullptr;
 | 
			
		||||
  }
 | 
			
		||||
  if (recv_cipher_ != nullptr) {
 | 
			
		||||
    noise_cipherstate_free(recv_cipher_);
 | 
			
		||||
    recv_cipher_ = nullptr;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
extern "C" {
 | 
			
		||||
// declare how noise generates random bytes (here with a good HWRNG based on the RF system)
 | 
			
		||||
void noise_rand_bytes(void *output, size_t len) {
 | 
			
		||||
  if (!esphome::random_bytes(reinterpret_cast<uint8_t *>(output), len)) {
 | 
			
		||||
    ESP_LOGE(TAG, "Acquiring random bytes failed; rebooting");
 | 
			
		||||
    arch_restart();
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif  // USE_API_NOISE
 | 
			
		||||
#endif  // USE_API
 | 
			
		||||
							
								
								
									
										68
									
								
								esphome/components/api/api_frame_helper_noise.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										68
									
								
								esphome/components/api/api_frame_helper_noise.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,68 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
#include "api_frame_helper.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
#include "noise/protocol.h"
 | 
			
		||||
#include "api_noise_context.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
class APINoiseFrameHelper : public APIFrameHelper {
 | 
			
		||||
 public:
 | 
			
		||||
  APINoiseFrameHelper(std::unique_ptr<socket::Socket> socket, std::shared_ptr<APINoiseContext> ctx,
 | 
			
		||||
                      const ClientInfo *client_info)
 | 
			
		||||
      : APIFrameHelper(std::move(socket), client_info), ctx_(std::move(ctx)) {
 | 
			
		||||
    // Noise header structure:
 | 
			
		||||
    // Pos 0: indicator (0x01)
 | 
			
		||||
    // Pos 1-2: encrypted payload size (16-bit big-endian)
 | 
			
		||||
    // Pos 3-6: encrypted type (16-bit) + data_len (16-bit)
 | 
			
		||||
    // Pos 7+: actual payload data
 | 
			
		||||
    frame_header_padding_ = 7;
 | 
			
		||||
  }
 | 
			
		||||
  ~APINoiseFrameHelper() override;
 | 
			
		||||
  APIError init() override;
 | 
			
		||||
  APIError loop() override;
 | 
			
		||||
  APIError read_packet(ReadPacketBuffer *buffer) override;
 | 
			
		||||
  APIError write_protobuf_packet(uint8_t type, ProtoWriteBuffer buffer) override;
 | 
			
		||||
  APIError write_protobuf_packets(ProtoWriteBuffer buffer, std::span<const PacketInfo> packets) override;
 | 
			
		||||
  // Get the frame header padding required by this protocol
 | 
			
		||||
  uint8_t frame_header_padding() override { return frame_header_padding_; }
 | 
			
		||||
  // Get the frame footer size required by this protocol
 | 
			
		||||
  uint8_t frame_footer_size() override { return frame_footer_size_; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  APIError state_action_();
 | 
			
		||||
  APIError try_read_frame_(std::vector<uint8_t> *frame);
 | 
			
		||||
  APIError write_frame_(const uint8_t *data, uint16_t len);
 | 
			
		||||
  APIError init_handshake_();
 | 
			
		||||
  APIError check_handshake_finished_();
 | 
			
		||||
  void send_explicit_handshake_reject_(const std::string &reason);
 | 
			
		||||
  APIError handle_handshake_frame_error_(APIError aerr);
 | 
			
		||||
  APIError handle_noise_error_(int err, const char *func_name, APIError api_err);
 | 
			
		||||
 | 
			
		||||
  // Pointers first (4 bytes each)
 | 
			
		||||
  NoiseHandshakeState *handshake_{nullptr};
 | 
			
		||||
  NoiseCipherState *send_cipher_{nullptr};
 | 
			
		||||
  NoiseCipherState *recv_cipher_{nullptr};
 | 
			
		||||
 | 
			
		||||
  // Shared pointer (8 bytes on 32-bit = 4 bytes control block pointer + 4 bytes object pointer)
 | 
			
		||||
  std::shared_ptr<APINoiseContext> ctx_;
 | 
			
		||||
 | 
			
		||||
  // Vector (12 bytes on 32-bit)
 | 
			
		||||
  std::vector<uint8_t> prologue_;
 | 
			
		||||
 | 
			
		||||
  // NoiseProtocolId (size depends on implementation)
 | 
			
		||||
  NoiseProtocolId nid_;
 | 
			
		||||
 | 
			
		||||
  // Group small types together
 | 
			
		||||
  // Fixed-size header buffer for noise protocol:
 | 
			
		||||
  // 1 byte for indicator + 2 bytes for message size (16-bit value, not varint)
 | 
			
		||||
  // Note: Maximum message size is UINT16_MAX (65535), with a limit of 128 bytes during handshake phase
 | 
			
		||||
  uint8_t rx_header_buf_[3];
 | 
			
		||||
  uint8_t rx_header_buf_len_ = 0;
 | 
			
		||||
  // 4 bytes total, no padding
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif  // USE_API_NOISE
 | 
			
		||||
#endif  // USE_API
 | 
			
		||||
							
								
								
									
										290
									
								
								esphome/components/api/api_frame_helper_plaintext.cpp
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										290
									
								
								esphome/components/api/api_frame_helper_plaintext.cpp
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,290 @@
 | 
			
		||||
#include "api_frame_helper_plaintext.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_PLAINTEXT
 | 
			
		||||
#include "api_connection.h"  // For ClientInfo struct
 | 
			
		||||
#include "esphome/core/application.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "proto.h"
 | 
			
		||||
#include <cstring>
 | 
			
		||||
#include <cinttypes>
 | 
			
		||||
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "api.plaintext";
 | 
			
		||||
 | 
			
		||||
#define HELPER_LOG(msg, ...) ESP_LOGVV(TAG, "%s: " msg, this->client_info_->get_combined_info().c_str(), ##__VA_ARGS__)
 | 
			
		||||
 | 
			
		||||
#ifdef HELPER_LOG_PACKETS
 | 
			
		||||
#define LOG_PACKET_RECEIVED(buffer) ESP_LOGVV(TAG, "Received frame: %s", format_hex_pretty(buffer).c_str())
 | 
			
		||||
#define LOG_PACKET_SENDING(data, len) ESP_LOGVV(TAG, "Sending raw: %s", format_hex_pretty(data, len).c_str())
 | 
			
		||||
#else
 | 
			
		||||
#define LOG_PACKET_RECEIVED(buffer) ((void) 0)
 | 
			
		||||
#define LOG_PACKET_SENDING(data, len) ((void) 0)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
/// Initialize the frame helper, returns OK if successful.
 | 
			
		||||
APIError APIPlaintextFrameHelper::init() {
 | 
			
		||||
  APIError err = init_common_();
 | 
			
		||||
  if (err != APIError::OK) {
 | 
			
		||||
    return err;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  state_ = State::DATA;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
APIError APIPlaintextFrameHelper::loop() {
 | 
			
		||||
  if (state_ != State::DATA) {
 | 
			
		||||
    return APIError::BAD_STATE;
 | 
			
		||||
  }
 | 
			
		||||
  // Use base class implementation for buffer sending
 | 
			
		||||
  return APIFrameHelper::loop();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/** Read a packet into the rx_buf_. If successful, stores frame data in the frame parameter
 | 
			
		||||
 *
 | 
			
		||||
 * @param frame: The struct to hold the frame information in.
 | 
			
		||||
 *   msg: store the parsed frame in that struct
 | 
			
		||||
 *
 | 
			
		||||
 * @return See APIError
 | 
			
		||||
 *
 | 
			
		||||
 * error API_ERROR_BAD_INDICATOR: Bad indicator byte at start of frame.
 | 
			
		||||
 */
 | 
			
		||||
APIError APIPlaintextFrameHelper::try_read_frame_(std::vector<uint8_t> *frame) {
 | 
			
		||||
  if (frame == nullptr) {
 | 
			
		||||
    HELPER_LOG("Bad argument for try_read_frame_");
 | 
			
		||||
    return APIError::BAD_ARG;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // read header
 | 
			
		||||
  while (!rx_header_parsed_) {
 | 
			
		||||
    // Now that we know when the socket is ready, we can read up to 3 bytes
 | 
			
		||||
    // into the rx_header_buf_ before we have to switch back to reading
 | 
			
		||||
    // one byte at a time to ensure we don't read past the message and
 | 
			
		||||
    // into the next one.
 | 
			
		||||
 | 
			
		||||
    // Read directly into rx_header_buf_ at the current position
 | 
			
		||||
    // Try to get to at least 3 bytes total (indicator + 2 varint bytes), then read one byte at a time
 | 
			
		||||
    ssize_t received =
 | 
			
		||||
        this->socket_->read(&rx_header_buf_[rx_header_buf_pos_], rx_header_buf_pos_ < 3 ? 3 - rx_header_buf_pos_ : 1);
 | 
			
		||||
    APIError err = handle_socket_read_result_(received);
 | 
			
		||||
    if (err != APIError::OK) {
 | 
			
		||||
      return err;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // If this was the first read, validate the indicator byte
 | 
			
		||||
    if (rx_header_buf_pos_ == 0 && received > 0) {
 | 
			
		||||
      if (rx_header_buf_[0] != 0x00) {
 | 
			
		||||
        state_ = State::FAILED;
 | 
			
		||||
        HELPER_LOG("Bad indicator byte %u", rx_header_buf_[0]);
 | 
			
		||||
        return APIError::BAD_INDICATOR;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    rx_header_buf_pos_ += received;
 | 
			
		||||
 | 
			
		||||
    // Check for buffer overflow
 | 
			
		||||
    if (rx_header_buf_pos_ >= sizeof(rx_header_buf_)) {
 | 
			
		||||
      state_ = State::FAILED;
 | 
			
		||||
      HELPER_LOG("Header buffer overflow");
 | 
			
		||||
      return APIError::BAD_DATA_PACKET;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Need at least 3 bytes total (indicator + 2 varint bytes) before trying to parse
 | 
			
		||||
    if (rx_header_buf_pos_ < 3) {
 | 
			
		||||
      continue;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // At this point, we have at least 3 bytes total:
 | 
			
		||||
    //   - Validated indicator byte (0x00) stored at position 0
 | 
			
		||||
    //   - At least 2 bytes in the buffer for the varints
 | 
			
		||||
    // Buffer layout:
 | 
			
		||||
    //   [0]: indicator byte (0x00)
 | 
			
		||||
    //   [1-3]: Message size varint (variable length)
 | 
			
		||||
    //     - 2 bytes would only allow up to 16383, which is less than noise's UINT16_MAX (65535)
 | 
			
		||||
    //     - 3 bytes allows up to 2097151, ensuring we support at least as much as noise
 | 
			
		||||
    //   [2-5]: Message type varint (variable length)
 | 
			
		||||
    // We now attempt to parse both varints. If either is incomplete,
 | 
			
		||||
    // we'll continue reading more bytes.
 | 
			
		||||
 | 
			
		||||
    // Skip indicator byte at position 0
 | 
			
		||||
    uint8_t varint_pos = 1;
 | 
			
		||||
    uint32_t consumed = 0;
 | 
			
		||||
 | 
			
		||||
    auto msg_size_varint = ProtoVarInt::parse(&rx_header_buf_[varint_pos], rx_header_buf_pos_ - varint_pos, &consumed);
 | 
			
		||||
    if (!msg_size_varint.has_value()) {
 | 
			
		||||
      // not enough data there yet
 | 
			
		||||
      continue;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (msg_size_varint->as_uint32() > std::numeric_limits<uint16_t>::max()) {
 | 
			
		||||
      state_ = State::FAILED;
 | 
			
		||||
      HELPER_LOG("Bad packet: message size %" PRIu32 " exceeds maximum %u", msg_size_varint->as_uint32(),
 | 
			
		||||
                 std::numeric_limits<uint16_t>::max());
 | 
			
		||||
      return APIError::BAD_DATA_PACKET;
 | 
			
		||||
    }
 | 
			
		||||
    rx_header_parsed_len_ = msg_size_varint->as_uint16();
 | 
			
		||||
 | 
			
		||||
    // Move to next varint position
 | 
			
		||||
    varint_pos += consumed;
 | 
			
		||||
 | 
			
		||||
    auto msg_type_varint = ProtoVarInt::parse(&rx_header_buf_[varint_pos], rx_header_buf_pos_ - varint_pos, &consumed);
 | 
			
		||||
    if (!msg_type_varint.has_value()) {
 | 
			
		||||
      // not enough data there yet
 | 
			
		||||
      continue;
 | 
			
		||||
    }
 | 
			
		||||
    if (msg_type_varint->as_uint32() > std::numeric_limits<uint16_t>::max()) {
 | 
			
		||||
      state_ = State::FAILED;
 | 
			
		||||
      HELPER_LOG("Bad packet: message type %" PRIu32 " exceeds maximum %u", msg_type_varint->as_uint32(),
 | 
			
		||||
                 std::numeric_limits<uint16_t>::max());
 | 
			
		||||
      return APIError::BAD_DATA_PACKET;
 | 
			
		||||
    }
 | 
			
		||||
    rx_header_parsed_type_ = msg_type_varint->as_uint16();
 | 
			
		||||
    rx_header_parsed_ = true;
 | 
			
		||||
  }
 | 
			
		||||
  // header reading done
 | 
			
		||||
 | 
			
		||||
  // reserve space for body
 | 
			
		||||
  if (rx_buf_.size() != rx_header_parsed_len_) {
 | 
			
		||||
    rx_buf_.resize(rx_header_parsed_len_);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (rx_buf_len_ < rx_header_parsed_len_) {
 | 
			
		||||
    // more data to read
 | 
			
		||||
    uint16_t to_read = rx_header_parsed_len_ - rx_buf_len_;
 | 
			
		||||
    ssize_t received = this->socket_->read(&rx_buf_[rx_buf_len_], to_read);
 | 
			
		||||
    APIError err = handle_socket_read_result_(received);
 | 
			
		||||
    if (err != APIError::OK) {
 | 
			
		||||
      return err;
 | 
			
		||||
    }
 | 
			
		||||
    rx_buf_len_ += static_cast<uint16_t>(received);
 | 
			
		||||
    if (static_cast<uint16_t>(received) != to_read) {
 | 
			
		||||
      // not all read
 | 
			
		||||
      return APIError::WOULD_BLOCK;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  LOG_PACKET_RECEIVED(rx_buf_);
 | 
			
		||||
  *frame = std::move(rx_buf_);
 | 
			
		||||
  // consume msg
 | 
			
		||||
  rx_buf_ = {};
 | 
			
		||||
  rx_buf_len_ = 0;
 | 
			
		||||
  rx_header_buf_pos_ = 0;
 | 
			
		||||
  rx_header_parsed_ = false;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
APIError APIPlaintextFrameHelper::read_packet(ReadPacketBuffer *buffer) {
 | 
			
		||||
  APIError aerr;
 | 
			
		||||
 | 
			
		||||
  if (state_ != State::DATA) {
 | 
			
		||||
    return APIError::WOULD_BLOCK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  std::vector<uint8_t> frame;
 | 
			
		||||
  aerr = try_read_frame_(&frame);
 | 
			
		||||
  if (aerr != APIError::OK) {
 | 
			
		||||
    if (aerr == APIError::BAD_INDICATOR) {
 | 
			
		||||
      // Make sure to tell the remote that we don't
 | 
			
		||||
      // understand the indicator byte so it knows
 | 
			
		||||
      // we do not support it.
 | 
			
		||||
      struct iovec iov[1];
 | 
			
		||||
      // The \x00 first byte is the marker for plaintext.
 | 
			
		||||
      //
 | 
			
		||||
      // The remote will know how to handle the indicator byte,
 | 
			
		||||
      // but it likely won't understand the rest of the message.
 | 
			
		||||
      //
 | 
			
		||||
      // We must send at least 3 bytes to be read, so we add
 | 
			
		||||
      // a message after the indicator byte to ensures its long
 | 
			
		||||
      // enough and can aid in debugging.
 | 
			
		||||
      const char msg[] = "\x00"
 | 
			
		||||
                         "Bad indicator byte";
 | 
			
		||||
      iov[0].iov_base = (void *) msg;
 | 
			
		||||
      iov[0].iov_len = 19;
 | 
			
		||||
      this->write_raw_(iov, 1, 19);
 | 
			
		||||
    }
 | 
			
		||||
    return aerr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  buffer->container = std::move(frame);
 | 
			
		||||
  buffer->data_offset = 0;
 | 
			
		||||
  buffer->data_len = rx_header_parsed_len_;
 | 
			
		||||
  buffer->type = rx_header_parsed_type_;
 | 
			
		||||
  return APIError::OK;
 | 
			
		||||
}
 | 
			
		||||
APIError APIPlaintextFrameHelper::write_protobuf_packet(uint8_t type, ProtoWriteBuffer buffer) {
 | 
			
		||||
  PacketInfo packet{type, 0, static_cast<uint16_t>(buffer.get_buffer()->size() - frame_header_padding_)};
 | 
			
		||||
  return write_protobuf_packets(buffer, std::span<const PacketInfo>(&packet, 1));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
APIError APIPlaintextFrameHelper::write_protobuf_packets(ProtoWriteBuffer buffer, std::span<const PacketInfo> packets) {
 | 
			
		||||
  if (state_ != State::DATA) {
 | 
			
		||||
    return APIError::BAD_STATE;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (packets.empty()) {
 | 
			
		||||
    return APIError::OK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  std::vector<uint8_t> *raw_buffer = buffer.get_buffer();
 | 
			
		||||
  uint8_t *buffer_data = raw_buffer->data();  // Cache buffer pointer
 | 
			
		||||
 | 
			
		||||
  this->reusable_iovs_.clear();
 | 
			
		||||
  this->reusable_iovs_.reserve(packets.size());
 | 
			
		||||
  uint16_t total_write_len = 0;
 | 
			
		||||
 | 
			
		||||
  for (const auto &packet : packets) {
 | 
			
		||||
    // Calculate varint sizes for header layout
 | 
			
		||||
    uint8_t size_varint_len = api::ProtoSize::varint(static_cast<uint32_t>(packet.payload_size));
 | 
			
		||||
    uint8_t type_varint_len = api::ProtoSize::varint(static_cast<uint32_t>(packet.message_type));
 | 
			
		||||
    uint8_t total_header_len = 1 + size_varint_len + type_varint_len;
 | 
			
		||||
 | 
			
		||||
    // Calculate where to start writing the header
 | 
			
		||||
    // The header starts at the latest possible position to minimize unused padding
 | 
			
		||||
    //
 | 
			
		||||
    // Example 1 (small values): total_header_len = 3, header_offset = 6 - 3 = 3
 | 
			
		||||
    // [0-2]  - Unused padding
 | 
			
		||||
    // [3]    - 0x00 indicator byte
 | 
			
		||||
    // [4]    - Payload size varint (1 byte, for sizes 0-127)
 | 
			
		||||
    // [5]    - Message type varint (1 byte, for types 0-127)
 | 
			
		||||
    // [6...] - Actual payload data
 | 
			
		||||
    //
 | 
			
		||||
    // Example 2 (medium values): total_header_len = 4, header_offset = 6 - 4 = 2
 | 
			
		||||
    // [0-1]  - Unused padding
 | 
			
		||||
    // [2]    - 0x00 indicator byte
 | 
			
		||||
    // [3-4]  - Payload size varint (2 bytes, for sizes 128-16383)
 | 
			
		||||
    // [5]    - Message type varint (1 byte, for types 0-127)
 | 
			
		||||
    // [6...] - Actual payload data
 | 
			
		||||
    //
 | 
			
		||||
    // Example 3 (large values): total_header_len = 6, header_offset = 6 - 6 = 0
 | 
			
		||||
    // [0]    - 0x00 indicator byte
 | 
			
		||||
    // [1-3]  - Payload size varint (3 bytes, for sizes 16384-2097151)
 | 
			
		||||
    // [4-5]  - Message type varint (2 bytes, for types 128-32767)
 | 
			
		||||
    // [6...] - Actual payload data
 | 
			
		||||
    //
 | 
			
		||||
    // The message starts at offset + frame_header_padding_
 | 
			
		||||
    // So we write the header starting at offset + frame_header_padding_ - total_header_len
 | 
			
		||||
    uint8_t *buf_start = buffer_data + packet.offset;
 | 
			
		||||
    uint32_t header_offset = frame_header_padding_ - total_header_len;
 | 
			
		||||
 | 
			
		||||
    // Write the plaintext header
 | 
			
		||||
    buf_start[header_offset] = 0x00;  // indicator
 | 
			
		||||
 | 
			
		||||
    // Encode varints directly into buffer
 | 
			
		||||
    ProtoVarInt(packet.payload_size).encode_to_buffer_unchecked(buf_start + header_offset + 1, size_varint_len);
 | 
			
		||||
    ProtoVarInt(packet.message_type)
 | 
			
		||||
        .encode_to_buffer_unchecked(buf_start + header_offset + 1 + size_varint_len, type_varint_len);
 | 
			
		||||
 | 
			
		||||
    // Add iovec for this packet (header + payload)
 | 
			
		||||
    size_t packet_len = static_cast<size_t>(total_header_len + packet.payload_size);
 | 
			
		||||
    this->reusable_iovs_.push_back({buf_start + header_offset, packet_len});
 | 
			
		||||
    total_write_len += packet_len;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Send all packets in one writev call
 | 
			
		||||
  return write_raw_(this->reusable_iovs_.data(), this->reusable_iovs_.size(), total_write_len);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif  // USE_API_PLAINTEXT
 | 
			
		||||
#endif  // USE_API
 | 
			
		||||
							
								
								
									
										53
									
								
								esphome/components/api/api_frame_helper_plaintext.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										53
									
								
								esphome/components/api/api_frame_helper_plaintext.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,53 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
#include "api_frame_helper.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_PLAINTEXT
 | 
			
		||||
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
class APIPlaintextFrameHelper : public APIFrameHelper {
 | 
			
		||||
 public:
 | 
			
		||||
  APIPlaintextFrameHelper(std::unique_ptr<socket::Socket> socket, const ClientInfo *client_info)
 | 
			
		||||
      : APIFrameHelper(std::move(socket), client_info) {
 | 
			
		||||
    // Plaintext header structure (worst case):
 | 
			
		||||
    // Pos 0: indicator (0x00)
 | 
			
		||||
    // Pos 1-3: payload size varint (up to 3 bytes)
 | 
			
		||||
    // Pos 4-5: message type varint (up to 2 bytes)
 | 
			
		||||
    // Pos 6+: actual payload data
 | 
			
		||||
    frame_header_padding_ = 6;
 | 
			
		||||
  }
 | 
			
		||||
  ~APIPlaintextFrameHelper() override = default;
 | 
			
		||||
  APIError init() override;
 | 
			
		||||
  APIError loop() override;
 | 
			
		||||
  APIError read_packet(ReadPacketBuffer *buffer) override;
 | 
			
		||||
  APIError write_protobuf_packet(uint8_t type, ProtoWriteBuffer buffer) override;
 | 
			
		||||
  APIError write_protobuf_packets(ProtoWriteBuffer buffer, std::span<const PacketInfo> packets) override;
 | 
			
		||||
  uint8_t frame_header_padding() override { return frame_header_padding_; }
 | 
			
		||||
  // Get the frame footer size required by this protocol
 | 
			
		||||
  uint8_t frame_footer_size() override { return frame_footer_size_; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  APIError try_read_frame_(std::vector<uint8_t> *frame);
 | 
			
		||||
 | 
			
		||||
  // Group 2-byte aligned types
 | 
			
		||||
  uint16_t rx_header_parsed_type_ = 0;
 | 
			
		||||
  uint16_t rx_header_parsed_len_ = 0;
 | 
			
		||||
 | 
			
		||||
  // Group 1-byte types together
 | 
			
		||||
  // Fixed-size header buffer for plaintext protocol:
 | 
			
		||||
  // We now store the indicator byte + the two varints.
 | 
			
		||||
  // To match noise protocol's maximum message size (UINT16_MAX = 65535), we need:
 | 
			
		||||
  // 1 byte for indicator + 3 bytes for message size varint (supports up to 2097151) + 2 bytes for message type varint
 | 
			
		||||
  //
 | 
			
		||||
  // While varints could theoretically be up to 10 bytes each for 64-bit values,
 | 
			
		||||
  // attempting to process messages with headers that large would likely crash the
 | 
			
		||||
  // ESP32 due to memory constraints.
 | 
			
		||||
  uint8_t rx_header_buf_[6];  // 1 byte indicator + 5 bytes for varints (3 for size + 2 for type)
 | 
			
		||||
  uint8_t rx_header_buf_pos_ = 0;
 | 
			
		||||
  bool rx_header_parsed_ = false;
 | 
			
		||||
  // 8 bytes total, no padding needed
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif  // USE_API_PLAINTEXT
 | 
			
		||||
#endif  // USE_API
 | 
			
		||||
@@ -3,8 +3,7 @@
 | 
			
		||||
#include <cstdint>
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
using psk_t = std::array<uint8_t, 32>;
 | 
			
		||||
@@ -28,5 +27,4 @@ class APINoiseContext {
 | 
			
		||||
};
 | 
			
		||||
#endif  // USE_API_NOISE
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
 
 | 
			
		||||
@@ -23,3 +23,9 @@ extend google.protobuf.MessageOptions {
 | 
			
		||||
    optional bool no_delay = 1040 [default=false];
 | 
			
		||||
    optional string base_class = 1041;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
extend google.protobuf.FieldOptions {
 | 
			
		||||
    optional string field_ifdef = 1042;
 | 
			
		||||
    optional uint32 fixed_array_size = 50007;
 | 
			
		||||
    optional bool no_zero_copy = 50008 [default=false];
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										2075
									
								
								esphome/components/api/api_pb2_dump.cpp
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2075
									
								
								esphome/components/api/api_pb2_dump.cpp
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							@@ -2,11 +2,11 @@
 | 
			
		||||
// See script/api_protobuf/api_protobuf.py
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
class APIServerConnectionBase : public ProtoService {
 | 
			
		||||
 public:
 | 
			
		||||
@@ -17,11 +17,11 @@ class APIServerConnectionBase : public ProtoService {
 | 
			
		||||
 public:
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  template<typename T> bool send_message(const T &msg) {
 | 
			
		||||
  bool send_message(const ProtoMessage &msg, uint8_t message_type) {
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
    this->log_send_message_(T::message_name(), msg.dump());
 | 
			
		||||
    this->log_send_message_(msg.message_name(), msg.dump());
 | 
			
		||||
#endif
 | 
			
		||||
    return this->send_message_(msg, T::MESSAGE_TYPE);
 | 
			
		||||
    return this->send_message_(msg, message_type);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  virtual void on_hello_request(const HelloRequest &value){};
 | 
			
		||||
@@ -60,17 +60,25 @@ class APIServerConnectionBase : public ProtoService {
 | 
			
		||||
  virtual void on_noise_encryption_set_key_request(const NoiseEncryptionSetKeyRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  virtual void on_subscribe_homeassistant_services_request(const SubscribeHomeassistantServicesRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  virtual void on_subscribe_home_assistant_states_request(const SubscribeHomeAssistantStatesRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  virtual void on_home_assistant_state_response(const HomeAssistantStateResponse &value){};
 | 
			
		||||
#endif
 | 
			
		||||
  virtual void on_get_time_request(const GetTimeRequest &value){};
 | 
			
		||||
  virtual void on_get_time_response(const GetTimeResponse &value){};
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  virtual void on_execute_service_request(const ExecuteServiceRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  virtual void on_camera_image_request(const CameraImageRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
@@ -199,30 +207,36 @@ class APIServerConnectionBase : public ProtoService {
 | 
			
		||||
  virtual void on_update_command_request(const UpdateCommandRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
 protected:
 | 
			
		||||
  bool read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) override;
 | 
			
		||||
  void read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) override;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
 public:
 | 
			
		||||
  virtual HelloResponse hello(const HelloRequest &msg) = 0;
 | 
			
		||||
  virtual ConnectResponse connect(const ConnectRequest &msg) = 0;
 | 
			
		||||
  virtual DisconnectResponse disconnect(const DisconnectRequest &msg) = 0;
 | 
			
		||||
  virtual PingResponse ping(const PingRequest &msg) = 0;
 | 
			
		||||
  virtual DeviceInfoResponse device_info(const DeviceInfoRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_hello_response(const HelloRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_connect_response(const ConnectRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_disconnect_response(const DisconnectRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_ping_response(const PingRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_device_info_response(const DeviceInfoRequest &msg) = 0;
 | 
			
		||||
  virtual void list_entities(const ListEntitiesRequest &msg) = 0;
 | 
			
		||||
  virtual void subscribe_states(const SubscribeStatesRequest &msg) = 0;
 | 
			
		||||
  virtual void subscribe_logs(const SubscribeLogsRequest &msg) = 0;
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  virtual void subscribe_homeassistant_services(const SubscribeHomeassistantServicesRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  virtual void subscribe_home_assistant_states(const SubscribeHomeAssistantStatesRequest &msg) = 0;
 | 
			
		||||
  virtual GetTimeResponse get_time(const GetTimeRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
  virtual bool send_get_time_response(const GetTimeRequest &msg) = 0;
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  virtual void execute_service(const ExecuteServiceRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
  virtual NoiseEncryptionSetKeyResponse noise_encryption_set_key(const NoiseEncryptionSetKeyRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_noise_encryption_set_key_response(const NoiseEncryptionSetKeyRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
  virtual void button_command(const ButtonCommandRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  virtual void camera_image(const CameraImageRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
@@ -298,7 +312,7 @@ class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
  virtual void bluetooth_gatt_notify(const BluetoothGATTNotifyRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BLUETOOTH_PROXY
 | 
			
		||||
  virtual BluetoothConnectionsFreeResponse subscribe_bluetooth_connections_free(
 | 
			
		||||
  virtual bool send_subscribe_bluetooth_connections_free_response(
 | 
			
		||||
      const SubscribeBluetoothConnectionsFreeRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BLUETOOTH_PROXY
 | 
			
		||||
@@ -311,8 +325,7 @@ class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
  virtual void subscribe_voice_assistant(const SubscribeVoiceAssistantRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual VoiceAssistantConfigurationResponse voice_assistant_get_configuration(
 | 
			
		||||
      const VoiceAssistantConfigurationRequest &msg) = 0;
 | 
			
		||||
  virtual bool send_voice_assistant_get_configuration_response(const VoiceAssistantConfigurationRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) = 0;
 | 
			
		||||
@@ -329,17 +342,23 @@ class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
  void on_list_entities_request(const ListEntitiesRequest &msg) override;
 | 
			
		||||
  void on_subscribe_states_request(const SubscribeStatesRequest &msg) override;
 | 
			
		||||
  void on_subscribe_logs_request(const SubscribeLogsRequest &msg) override;
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  void on_subscribe_homeassistant_services_request(const SubscribeHomeassistantServicesRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  void on_subscribe_home_assistant_states_request(const SubscribeHomeAssistantStatesRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
  void on_get_time_request(const GetTimeRequest &msg) override;
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  void on_execute_service_request(const ExecuteServiceRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
  void on_noise_encryption_set_key_request(const NoiseEncryptionSetKeyRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
  void on_button_command_request(const ButtonCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  void on_camera_image_request(const CameraImageRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
@@ -438,5 +457,4 @@ class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
#endif
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
 
 | 
			
		||||
@@ -1,361 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "proto.h"
 | 
			
		||||
#include <cstdint>
 | 
			
		||||
#include <string>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
 | 
			
		||||
class ProtoSize {
 | 
			
		||||
 public:
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief ProtoSize class for Protocol Buffer serialization size calculation
 | 
			
		||||
   *
 | 
			
		||||
   * This class provides static methods to calculate the exact byte counts needed
 | 
			
		||||
   * for encoding various Protocol Buffer field types. All methods are designed to be
 | 
			
		||||
   * efficient for the common case where many fields have default values.
 | 
			
		||||
   *
 | 
			
		||||
   * Implements Protocol Buffer encoding size calculation according to:
 | 
			
		||||
   * https://protobuf.dev/programming-guides/encoding/
 | 
			
		||||
   *
 | 
			
		||||
   * Key features:
 | 
			
		||||
   * - Early-return optimization for zero/default values
 | 
			
		||||
   * - Direct total_size updates to avoid unnecessary additions
 | 
			
		||||
   * - Specialized handling for different field types according to protobuf spec
 | 
			
		||||
   * - Templated helpers for repeated fields and messages
 | 
			
		||||
   */
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode a uint32_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The uint32_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(uint32_t value) {
 | 
			
		||||
    // Optimized varint size calculation using leading zeros
 | 
			
		||||
    // Each 7 bits requires one byte in the varint encoding
 | 
			
		||||
    if (value < 128)
 | 
			
		||||
      return 1;  // 7 bits, common case for small values
 | 
			
		||||
 | 
			
		||||
    // For larger values, count bytes needed based on the position of the highest bit set
 | 
			
		||||
    if (value < 16384) {
 | 
			
		||||
      return 2;  // 14 bits
 | 
			
		||||
    } else if (value < 2097152) {
 | 
			
		||||
      return 3;  // 21 bits
 | 
			
		||||
    } else if (value < 268435456) {
 | 
			
		||||
      return 4;  // 28 bits
 | 
			
		||||
    } else {
 | 
			
		||||
      return 5;  // 32 bits (maximum for uint32_t)
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode a uint64_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The uint64_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(uint64_t value) {
 | 
			
		||||
    // Handle common case of values fitting in uint32_t (vast majority of use cases)
 | 
			
		||||
    if (value <= UINT32_MAX) {
 | 
			
		||||
      return varint(static_cast<uint32_t>(value));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // For larger values, determine size based on highest bit position
 | 
			
		||||
    if (value < (1ULL << 35)) {
 | 
			
		||||
      return 5;  // 35 bits
 | 
			
		||||
    } else if (value < (1ULL << 42)) {
 | 
			
		||||
      return 6;  // 42 bits
 | 
			
		||||
    } else if (value < (1ULL << 49)) {
 | 
			
		||||
      return 7;  // 49 bits
 | 
			
		||||
    } else if (value < (1ULL << 56)) {
 | 
			
		||||
      return 8;  // 56 bits
 | 
			
		||||
    } else if (value < (1ULL << 63)) {
 | 
			
		||||
      return 9;  // 63 bits
 | 
			
		||||
    } else {
 | 
			
		||||
      return 10;  // 64 bits (maximum for uint64_t)
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode an int32_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * Special handling is needed for negative values, which are sign-extended to 64 bits
 | 
			
		||||
   * in Protocol Buffers, resulting in a 10-byte varint.
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The int32_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(int32_t value) {
 | 
			
		||||
    // Negative values are sign-extended to 64 bits in protocol buffers,
 | 
			
		||||
    // which always results in a 10-byte varint for negative int32
 | 
			
		||||
    if (value < 0) {
 | 
			
		||||
      return 10;  // Negative int32 is always 10 bytes long
 | 
			
		||||
    }
 | 
			
		||||
    // For non-negative values, use the uint32_t implementation
 | 
			
		||||
    return varint(static_cast<uint32_t>(value));
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode an int64_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The int64_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(int64_t value) {
 | 
			
		||||
    // For int64_t, we convert to uint64_t and calculate the size
 | 
			
		||||
    // This works because the bit pattern determines the encoding size,
 | 
			
		||||
    // and we've handled negative int32 values as a special case above
 | 
			
		||||
    return varint(static_cast<uint64_t>(value));
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode a field ID and wire type
 | 
			
		||||
   *
 | 
			
		||||
   * @param field_id The field identifier
 | 
			
		||||
   * @param type The wire type value (from the WireType enum in the protobuf spec)
 | 
			
		||||
   * @return The number of bytes needed to encode the field ID and wire type
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t field(uint32_t field_id, uint32_t type) {
 | 
			
		||||
    uint32_t tag = (field_id << 3) | (type & 0b111);
 | 
			
		||||
    return varint(tag);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Common parameters for all add_*_field methods
 | 
			
		||||
   *
 | 
			
		||||
   * All add_*_field methods follow these common patterns:
 | 
			
		||||
   *
 | 
			
		||||
   * @param total_size Reference to the total message size to update
 | 
			
		||||
   * @param field_id_size Pre-calculated size of the field ID in bytes
 | 
			
		||||
   * @param value The value to calculate size for (type varies)
 | 
			
		||||
   * @param force Whether to calculate size even if the value is default/zero/empty
 | 
			
		||||
   *
 | 
			
		||||
   * Each method follows this implementation pattern:
 | 
			
		||||
   * 1. Skip calculation if value is default (0, false, empty) and not forced
 | 
			
		||||
   * 2. Calculate the size based on the field's encoding rules
 | 
			
		||||
   * 3. Add the field_id_size + calculated value size to total_size
 | 
			
		||||
   */
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an int32 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_int32_field(uint32_t &total_size, uint32_t field_id_size, int32_t value, bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    if (value < 0) {
 | 
			
		||||
      // Negative values are encoded as 10-byte varints in protobuf
 | 
			
		||||
      total_size += field_id_size + 10;
 | 
			
		||||
    } else {
 | 
			
		||||
      // For non-negative values, use the standard varint size
 | 
			
		||||
      total_size += field_id_size + varint(static_cast<uint32_t>(value));
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a uint32 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_uint32_field(uint32_t &total_size, uint32_t field_id_size, uint32_t value,
 | 
			
		||||
                                      bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a boolean field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_bool_field(uint32_t &total_size, uint32_t field_id_size, bool value, bool force = false) {
 | 
			
		||||
    // Skip calculation if value is false and not forced
 | 
			
		||||
    if (!value && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Boolean fields always use 1 byte when true
 | 
			
		||||
    total_size += field_id_size + 1;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a fixed field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * Fixed fields always take exactly N bytes (4 for fixed32/float, 8 for fixed64/double).
 | 
			
		||||
   *
 | 
			
		||||
   * @tparam NumBytes The number of bytes for this fixed field (4 or 8)
 | 
			
		||||
   * @param is_nonzero Whether the value is non-zero
 | 
			
		||||
   */
 | 
			
		||||
  template<uint32_t NumBytes>
 | 
			
		||||
  static inline void add_fixed_field(uint32_t &total_size, uint32_t field_id_size, bool is_nonzero,
 | 
			
		||||
                                     bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (!is_nonzero && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Fixed fields always take exactly NumBytes
 | 
			
		||||
    total_size += field_id_size + NumBytes;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an enum field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * Enum fields are encoded as uint32 varints.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_enum_field(uint32_t &total_size, uint32_t field_id_size, uint32_t value, bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Enums are encoded as uint32
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a sint32 field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * Sint32 fields use ZigZag encoding, which is more efficient for negative values.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_sint32_field(uint32_t &total_size, uint32_t field_id_size, int32_t value, bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // ZigZag encoding for sint32: (n << 1) ^ (n >> 31)
 | 
			
		||||
    uint32_t zigzag = (static_cast<uint32_t>(value) << 1) ^ (static_cast<uint32_t>(value >> 31));
 | 
			
		||||
    total_size += field_id_size + varint(zigzag);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an int64 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_int64_field(uint32_t &total_size, uint32_t field_id_size, int64_t value, bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a uint64 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_uint64_field(uint32_t &total_size, uint32_t field_id_size, uint64_t value,
 | 
			
		||||
                                      bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a sint64 field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * Sint64 fields use ZigZag encoding, which is more efficient for negative values.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_sint64_field(uint32_t &total_size, uint32_t field_id_size, int64_t value, bool force = false) {
 | 
			
		||||
    // Skip calculation if value is zero and not forced
 | 
			
		||||
    if (value == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // ZigZag encoding for sint64: (n << 1) ^ (n >> 63)
 | 
			
		||||
    uint64_t zigzag = (static_cast<uint64_t>(value) << 1) ^ (static_cast<uint64_t>(value >> 63));
 | 
			
		||||
    total_size += field_id_size + varint(zigzag);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a string/bytes field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_string_field(uint32_t &total_size, uint32_t field_id_size, const std::string &str,
 | 
			
		||||
                                      bool force = false) {
 | 
			
		||||
    // Skip calculation if string is empty and not forced
 | 
			
		||||
    if (str.empty() && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    const uint32_t str_size = static_cast<uint32_t>(str.size());
 | 
			
		||||
    total_size += field_id_size + varint(str_size) + str_size;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a nested message field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * This helper function directly updates the total_size reference if the nested size
 | 
			
		||||
   * is greater than zero or force is true.
 | 
			
		||||
   *
 | 
			
		||||
   * @param nested_size The pre-calculated size of the nested message
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_message_field(uint32_t &total_size, uint32_t field_id_size, uint32_t nested_size,
 | 
			
		||||
                                       bool force = false) {
 | 
			
		||||
    // Skip calculation if nested message is empty and not forced
 | 
			
		||||
    if (nested_size == 0 && !force) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    // Field ID + length varint + nested message content
 | 
			
		||||
    total_size += field_id_size + varint(nested_size) + nested_size;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a nested message field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * This templated version directly takes a message object, calculates its size internally,
 | 
			
		||||
   * and updates the total_size reference. This eliminates the need for a temporary variable
 | 
			
		||||
   * at the call site.
 | 
			
		||||
   *
 | 
			
		||||
   * @tparam MessageType The type of the nested message (inferred from parameter)
 | 
			
		||||
   * @param message The nested message object
 | 
			
		||||
   */
 | 
			
		||||
  template<typename MessageType>
 | 
			
		||||
  static inline void add_message_object(uint32_t &total_size, uint32_t field_id_size, const MessageType &message,
 | 
			
		||||
                                        bool force = false) {
 | 
			
		||||
    uint32_t nested_size = 0;
 | 
			
		||||
    message.calculate_size(nested_size);
 | 
			
		||||
 | 
			
		||||
    // Use the base implementation with the calculated nested_size
 | 
			
		||||
    add_message_field(total_size, field_id_size, nested_size, force);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the sizes of all messages in a repeated field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * This helper processes a vector of message objects, calculating the size for each message
 | 
			
		||||
   * and adding it to the total size.
 | 
			
		||||
   *
 | 
			
		||||
   * @tparam MessageType The type of the nested messages in the vector
 | 
			
		||||
   * @param messages Vector of message objects
 | 
			
		||||
   */
 | 
			
		||||
  template<typename MessageType>
 | 
			
		||||
  static inline void add_repeated_message(uint32_t &total_size, uint32_t field_id_size,
 | 
			
		||||
                                          const std::vector<MessageType> &messages) {
 | 
			
		||||
    // Skip if the vector is empty
 | 
			
		||||
    if (messages.empty()) {
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // For repeated fields, always use force=true
 | 
			
		||||
    for (const auto &message : messages) {
 | 
			
		||||
      add_message_object(total_size, field_id_size, message, true);
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -16,8 +16,7 @@
 | 
			
		||||
 | 
			
		||||
#include <algorithm>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "api";
 | 
			
		||||
 | 
			
		||||
@@ -31,7 +30,6 @@ APIServer::APIServer() {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void APIServer::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
  this->setup_controller();
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
@@ -47,6 +45,11 @@ void APIServer::setup() {
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Schedule reboot if no clients connect within timeout
 | 
			
		||||
  if (this->reboot_timeout_ != 0) {
 | 
			
		||||
    this->schedule_reboot_timeout_();
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->socket_ = socket::socket_ip_loop_monitored(SOCK_STREAM, 0);  // monitored for incoming connections
 | 
			
		||||
  if (this->socket_ == nullptr) {
 | 
			
		||||
    ESP_LOGW(TAG, "Could not create socket");
 | 
			
		||||
@@ -91,34 +94,42 @@ void APIServer::setup() {
 | 
			
		||||
 | 
			
		||||
#ifdef USE_LOGGER
 | 
			
		||||
  if (logger::global_logger != nullptr) {
 | 
			
		||||
    logger::global_logger->add_on_log_callback([this](int level, const char *tag, const char *message) {
 | 
			
		||||
      if (this->shutting_down_) {
 | 
			
		||||
        // Don't try to send logs during shutdown
 | 
			
		||||
        // as it could result in a recursion and
 | 
			
		||||
        // we would be filling a buffer we are trying to clear
 | 
			
		||||
        return;
 | 
			
		||||
      }
 | 
			
		||||
      for (auto &c : this->clients_) {
 | 
			
		||||
        if (!c->remove_)
 | 
			
		||||
          c->try_send_log_message(level, tag, message);
 | 
			
		||||
      }
 | 
			
		||||
    });
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  this->last_connected_ = millis();
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
  if (esp32_camera::global_esp32_camera != nullptr && !esp32_camera::global_esp32_camera->is_internal()) {
 | 
			
		||||
    esp32_camera::global_esp32_camera->add_image_callback(
 | 
			
		||||
        [this](const std::shared_ptr<esp32_camera::CameraImage> &image) {
 | 
			
		||||
    logger::global_logger->add_on_log_callback(
 | 
			
		||||
        [this](int level, const char *tag, const char *message, size_t message_len) {
 | 
			
		||||
          if (this->shutting_down_) {
 | 
			
		||||
            // Don't try to send logs during shutdown
 | 
			
		||||
            // as it could result in a recursion and
 | 
			
		||||
            // we would be filling a buffer we are trying to clear
 | 
			
		||||
            return;
 | 
			
		||||
          }
 | 
			
		||||
          for (auto &c : this->clients_) {
 | 
			
		||||
            if (!c->remove_)
 | 
			
		||||
              c->set_camera_state(image);
 | 
			
		||||
            if (!c->flags_.remove && c->get_log_subscription_level() >= level)
 | 
			
		||||
              c->try_send_log_message(level, tag, message, message_len);
 | 
			
		||||
          }
 | 
			
		||||
        });
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  if (camera::Camera::instance() != nullptr && !camera::Camera::instance()->is_internal()) {
 | 
			
		||||
    camera::Camera::instance()->add_image_callback([this](const std::shared_ptr<camera::CameraImage> &image) {
 | 
			
		||||
      for (auto &c : this->clients_) {
 | 
			
		||||
        if (!c->flags_.remove)
 | 
			
		||||
          c->set_camera_state(image);
 | 
			
		||||
      }
 | 
			
		||||
    });
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void APIServer::schedule_reboot_timeout_() {
 | 
			
		||||
  this->status_set_warning();
 | 
			
		||||
  this->set_timeout("api_reboot", this->reboot_timeout_, []() {
 | 
			
		||||
    if (!global_api_server->is_connected()) {
 | 
			
		||||
      ESP_LOGE(TAG, "No clients; rebooting");
 | 
			
		||||
      App.reboot();
 | 
			
		||||
    }
 | 
			
		||||
  });
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void APIServer::loop() {
 | 
			
		||||
@@ -130,71 +141,82 @@ void APIServer::loop() {
 | 
			
		||||
      auto sock = this->socket_->accept_loop_monitored((struct sockaddr *) &source_addr, &addr_len);
 | 
			
		||||
      if (!sock)
 | 
			
		||||
        break;
 | 
			
		||||
      ESP_LOGD(TAG, "Accepted %s", sock->getpeername().c_str());
 | 
			
		||||
      ESP_LOGD(TAG, "Accept %s", sock->getpeername().c_str());
 | 
			
		||||
 | 
			
		||||
      auto *conn = new APIConnection(std::move(sock), this);
 | 
			
		||||
      this->clients_.emplace_back(conn);
 | 
			
		||||
      conn->start();
 | 
			
		||||
 | 
			
		||||
      // Clear warning status and cancel reboot when first client connects
 | 
			
		||||
      if (this->clients_.size() == 1 && this->reboot_timeout_ != 0) {
 | 
			
		||||
        this->status_clear_warning();
 | 
			
		||||
        this->cancel_timeout("api_reboot");
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->clients_.empty()) {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Process clients and remove disconnected ones in a single pass
 | 
			
		||||
  if (!this->clients_.empty()) {
 | 
			
		||||
    size_t client_index = 0;
 | 
			
		||||
    while (client_index < this->clients_.size()) {
 | 
			
		||||
      auto &client = this->clients_[client_index];
 | 
			
		||||
 | 
			
		||||
      if (client->remove_) {
 | 
			
		||||
        // Handle disconnection
 | 
			
		||||
        this->client_disconnected_trigger_->trigger(client->client_info_, client->client_peername_);
 | 
			
		||||
        ESP_LOGV(TAG, "Removing connection to %s", client->client_info_.c_str());
 | 
			
		||||
 | 
			
		||||
        // Swap with the last element and pop (avoids expensive vector shifts)
 | 
			
		||||
        if (client_index < this->clients_.size() - 1) {
 | 
			
		||||
          std::swap(this->clients_[client_index], this->clients_.back());
 | 
			
		||||
        }
 | 
			
		||||
        this->clients_.pop_back();
 | 
			
		||||
        // Don't increment client_index since we need to process the swapped element
 | 
			
		||||
      } else {
 | 
			
		||||
        // Process active client
 | 
			
		||||
        client->loop();
 | 
			
		||||
        client_index++;  // Move to next client
 | 
			
		||||
      }
 | 
			
		||||
  // Check network connectivity once for all clients
 | 
			
		||||
  if (!network::is_connected()) {
 | 
			
		||||
    // Network is down - disconnect all clients
 | 
			
		||||
    for (auto &client : this->clients_) {
 | 
			
		||||
      client->on_fatal_error();
 | 
			
		||||
      ESP_LOGW(TAG, "%s: Network down; disconnect", client->get_client_combined_info().c_str());
 | 
			
		||||
    }
 | 
			
		||||
    // Continue to process and clean up the clients below
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->reboot_timeout_ != 0) {
 | 
			
		||||
    const uint32_t now = millis();
 | 
			
		||||
    if (!this->is_connected()) {
 | 
			
		||||
      if (now - this->last_connected_ > this->reboot_timeout_) {
 | 
			
		||||
        ESP_LOGE(TAG, "No client connected; rebooting");
 | 
			
		||||
        App.reboot();
 | 
			
		||||
      }
 | 
			
		||||
      this->status_set_warning();
 | 
			
		||||
    } else {
 | 
			
		||||
      this->last_connected_ = now;
 | 
			
		||||
      this->status_clear_warning();
 | 
			
		||||
  size_t client_index = 0;
 | 
			
		||||
  while (client_index < this->clients_.size()) {
 | 
			
		||||
    auto &client = this->clients_[client_index];
 | 
			
		||||
 | 
			
		||||
    if (!client->flags_.remove) {
 | 
			
		||||
      // Common case: process active client
 | 
			
		||||
      client->loop();
 | 
			
		||||
      client_index++;
 | 
			
		||||
      continue;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Rare case: handle disconnection
 | 
			
		||||
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
 | 
			
		||||
    this->client_disconnected_trigger_->trigger(client->client_info_.name, client->client_info_.peername);
 | 
			
		||||
#endif
 | 
			
		||||
    ESP_LOGV(TAG, "Remove connection %s", client->client_info_.name.c_str());
 | 
			
		||||
 | 
			
		||||
    // Swap with the last element and pop (avoids expensive vector shifts)
 | 
			
		||||
    if (client_index < this->clients_.size() - 1) {
 | 
			
		||||
      std::swap(this->clients_[client_index], this->clients_.back());
 | 
			
		||||
    }
 | 
			
		||||
    this->clients_.pop_back();
 | 
			
		||||
 | 
			
		||||
    // Schedule reboot when last client disconnects
 | 
			
		||||
    if (this->clients_.empty() && this->reboot_timeout_ != 0) {
 | 
			
		||||
      this->schedule_reboot_timeout_();
 | 
			
		||||
    }
 | 
			
		||||
    // Don't increment client_index since we need to process the swapped element
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void APIServer::dump_config() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG,
 | 
			
		||||
                "API Server:\n"
 | 
			
		||||
                "Server:\n"
 | 
			
		||||
                "  Address: %s:%u",
 | 
			
		||||
                network::get_use_address().c_str(), this->port_);
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Using noise encryption: %s", YESNO(this->noise_ctx_->has_psk()));
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Noise encryption: %s", YESNO(this->noise_ctx_->has_psk()));
 | 
			
		||||
  if (!this->noise_ctx_->has_psk()) {
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Supports noise encryption: YES");
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Supports encryption: YES");
 | 
			
		||||
  }
 | 
			
		||||
#else
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Using noise encryption: NO");
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Noise encryption: NO");
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool APIServer::uses_password() const { return !this->password_.empty(); }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
bool APIServer::check_password(const std::string &password) const {
 | 
			
		||||
  // depend only on input password length
 | 
			
		||||
  const char *a = this->password_.c_str();
 | 
			
		||||
@@ -223,199 +245,139 @@ bool APIServer::check_password(const std::string &password) const {
 | 
			
		||||
 | 
			
		||||
  return result == 0;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
void APIServer::handle_disconnect(APIConnection *conn) {}
 | 
			
		||||
 | 
			
		||||
// Macro for entities without extra parameters
 | 
			
		||||
#define API_DISPATCH_UPDATE(entity_type, entity_name) \
 | 
			
		||||
  void APIServer::on_##entity_name##_update(entity_type *obj) { /* NOLINT(bugprone-macro-parentheses) */ \
 | 
			
		||||
    if (obj->is_internal()) \
 | 
			
		||||
      return; \
 | 
			
		||||
    for (auto &c : this->clients_) \
 | 
			
		||||
      c->send_##entity_name##_state(obj); \
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
// Macro for entities with extra parameters (but parameters not used in send)
 | 
			
		||||
#define API_DISPATCH_UPDATE_IGNORE_PARAMS(entity_type, entity_name, ...) \
 | 
			
		||||
  void APIServer::on_##entity_name##_update(entity_type *obj, __VA_ARGS__) { /* NOLINT(bugprone-macro-parentheses) */ \
 | 
			
		||||
    if (obj->is_internal()) \
 | 
			
		||||
      return; \
 | 
			
		||||
    for (auto &c : this->clients_) \
 | 
			
		||||
      c->send_##entity_name##_state(obj); \
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
void APIServer::on_binary_sensor_update(binary_sensor::BinarySensor *obj, bool state) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_binary_sensor_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(binary_sensor::BinarySensor, binary_sensor)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
void APIServer::on_cover_update(cover::Cover *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_cover_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(cover::Cover, cover)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_FAN
 | 
			
		||||
void APIServer::on_fan_update(fan::Fan *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_fan_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(fan::Fan, fan)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_LIGHT
 | 
			
		||||
void APIServer::on_light_update(light::LightState *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_light_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(light::LightState, light)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SENSOR
 | 
			
		||||
void APIServer::on_sensor_update(sensor::Sensor *obj, float state) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_sensor_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE_IGNORE_PARAMS(sensor::Sensor, sensor, float state)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SWITCH
 | 
			
		||||
void APIServer::on_switch_update(switch_::Switch *obj, bool state) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_switch_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE_IGNORE_PARAMS(switch_::Switch, switch, bool state)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_TEXT_SENSOR
 | 
			
		||||
void APIServer::on_text_sensor_update(text_sensor::TextSensor *obj, const std::string &state) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_text_sensor_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE_IGNORE_PARAMS(text_sensor::TextSensor, text_sensor, const std::string &state)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
void APIServer::on_climate_update(climate::Climate *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_climate_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(climate::Climate, climate)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_NUMBER
 | 
			
		||||
void APIServer::on_number_update(number::Number *obj, float state) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_number_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE_IGNORE_PARAMS(number::Number, number, float state)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_DATETIME_DATE
 | 
			
		||||
void APIServer::on_date_update(datetime::DateEntity *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_date_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(datetime::DateEntity, date)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_DATETIME_TIME
 | 
			
		||||
void APIServer::on_time_update(datetime::TimeEntity *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_time_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(datetime::TimeEntity, time)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_DATETIME_DATETIME
 | 
			
		||||
void APIServer::on_datetime_update(datetime::DateTimeEntity *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_datetime_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(datetime::DateTimeEntity, datetime)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_TEXT
 | 
			
		||||
void APIServer::on_text_update(text::Text *obj, const std::string &state) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_text_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE_IGNORE_PARAMS(text::Text, text, const std::string &state)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SELECT
 | 
			
		||||
void APIServer::on_select_update(select::Select *obj, const std::string &state, size_t index) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_select_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE_IGNORE_PARAMS(select::Select, select, const std::string &state, size_t index)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_LOCK
 | 
			
		||||
void APIServer::on_lock_update(lock::Lock *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_lock_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(lock::Lock, lock)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_VALVE
 | 
			
		||||
void APIServer::on_valve_update(valve::Valve *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_valve_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(valve::Valve, valve)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
void APIServer::on_media_player_update(media_player::MediaPlayer *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_media_player_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(media_player::MediaPlayer, media_player)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_EVENT
 | 
			
		||||
// Event is a special case - it's the only entity that passes extra parameters to the send method
 | 
			
		||||
void APIServer::on_event(event::Event *obj, const std::string &event_type) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_event(obj, event_type);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_UPDATE
 | 
			
		||||
// Update is a special case - the method is called on_update, not on_update_update
 | 
			
		||||
void APIServer::on_update(update::UpdateEntity *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_update_state(obj);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
void APIServer::on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj) {
 | 
			
		||||
  if (obj->is_internal())
 | 
			
		||||
    return;
 | 
			
		||||
  for (auto &c : this->clients_)
 | 
			
		||||
    c->send_alarm_control_panel_state(obj);
 | 
			
		||||
}
 | 
			
		||||
API_DISPATCH_UPDATE(alarm_control_panel::AlarmControlPanel, alarm_control_panel)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
float APIServer::get_setup_priority() const { return setup_priority::AFTER_WIFI; }
 | 
			
		||||
 | 
			
		||||
void APIServer::set_port(uint16_t port) { this->port_ = port; }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
void APIServer::set_password(const std::string &password) { this->password_ = password; }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
void APIServer::set_batch_delay(uint32_t batch_delay) { this->batch_delay_ = batch_delay; }
 | 
			
		||||
void APIServer::set_batch_delay(uint16_t batch_delay) { this->batch_delay_ = batch_delay; }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
void APIServer::send_homeassistant_service_call(const HomeassistantServiceResponse &call) {
 | 
			
		||||
  for (auto &client : this->clients_) {
 | 
			
		||||
    client->send_homeassistant_service_call(call);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
void APIServer::subscribe_home_assistant_state(std::string entity_id, optional<std::string> attribute,
 | 
			
		||||
                                               std::function<void(std::string)> f) {
 | 
			
		||||
  this->state_subs_.push_back(HomeAssistantStateSubscription{
 | 
			
		||||
@@ -439,6 +401,7 @@ void APIServer::get_home_assistant_state(std::string entity_id, optional<std::st
 | 
			
		||||
const std::vector<APIServer::HomeAssistantStateSubscription> &APIServer::get_state_subs() const {
 | 
			
		||||
  return this->state_subs_;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
uint16_t APIServer::get_port() const { return this->port_; }
 | 
			
		||||
 | 
			
		||||
@@ -465,10 +428,11 @@ bool APIServer::save_noise_psk(psk_t psk, bool make_active) {
 | 
			
		||||
  ESP_LOGD(TAG, "Noise PSK saved");
 | 
			
		||||
  if (make_active) {
 | 
			
		||||
    this->set_timeout(100, [this, psk]() {
 | 
			
		||||
      ESP_LOGW(TAG, "Disconnecting all clients to reset connections");
 | 
			
		||||
      ESP_LOGW(TAG, "Disconnecting all clients to reset PSK");
 | 
			
		||||
      this->set_noise_psk(psk);
 | 
			
		||||
      for (auto &c : this->clients_) {
 | 
			
		||||
        c->send_message(DisconnectRequest());
 | 
			
		||||
        DisconnectRequest req;
 | 
			
		||||
        c->send_message(req, DisconnectRequest::MESSAGE_TYPE);
 | 
			
		||||
      }
 | 
			
		||||
    });
 | 
			
		||||
  }
 | 
			
		||||
@@ -479,7 +443,7 @@ bool APIServer::save_noise_psk(psk_t psk, bool make_active) {
 | 
			
		||||
#ifdef USE_HOMEASSISTANT_TIME
 | 
			
		||||
void APIServer::request_time() {
 | 
			
		||||
  for (auto &client : this->clients_) {
 | 
			
		||||
    if (!client->remove_ && client->is_authenticated())
 | 
			
		||||
    if (!client->flags_.remove && client->is_authenticated())
 | 
			
		||||
      client->send_time_request();
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
@@ -501,10 +465,12 @@ void APIServer::on_shutdown() {
 | 
			
		||||
 | 
			
		||||
  // Send disconnect requests to all connected clients
 | 
			
		||||
  for (auto &c : this->clients_) {
 | 
			
		||||
    if (!c->send_message(DisconnectRequest())) {
 | 
			
		||||
    DisconnectRequest req;
 | 
			
		||||
    if (!c->send_message(req, DisconnectRequest::MESSAGE_TYPE)) {
 | 
			
		||||
      // If we can't send the disconnect request directly (tx_buffer full),
 | 
			
		||||
      // schedule it in the batch so it will be sent with the 5ms timer
 | 
			
		||||
      c->schedule_message_(nullptr, &APIConnection::try_send_disconnect_request, DisconnectRequest::MESSAGE_TYPE);
 | 
			
		||||
      // schedule it at the front of the batch so it will be sent with priority
 | 
			
		||||
      c->schedule_message_front_(nullptr, &APIConnection::try_send_disconnect_request, DisconnectRequest::MESSAGE_TYPE,
 | 
			
		||||
                                 DisconnectRequest::ESTIMATED_SIZE);
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
@@ -520,6 +486,5 @@ bool APIServer::teardown() {
 | 
			
		||||
  return this->clients_.empty();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -12,12 +12,13 @@
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "list_entities.h"
 | 
			
		||||
#include "subscribe_state.h"
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
#include "user_services.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
struct SavedNoisePsk {
 | 
			
		||||
@@ -35,13 +36,14 @@ class APIServer : public Component, public Controller {
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
  void on_shutdown() override;
 | 
			
		||||
  bool teardown() override;
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
  bool check_password(const std::string &password) const;
 | 
			
		||||
  bool uses_password() const;
 | 
			
		||||
  void set_port(uint16_t port);
 | 
			
		||||
  void set_password(const std::string &password);
 | 
			
		||||
#endif
 | 
			
		||||
  void set_port(uint16_t port);
 | 
			
		||||
  void set_reboot_timeout(uint32_t reboot_timeout);
 | 
			
		||||
  void set_batch_delay(uint32_t batch_delay);
 | 
			
		||||
  uint32_t get_batch_delay() const { return batch_delay_; }
 | 
			
		||||
  void set_batch_delay(uint16_t batch_delay);
 | 
			
		||||
  uint16_t get_batch_delay() const { return batch_delay_; }
 | 
			
		||||
 | 
			
		||||
  // Get reference to shared buffer for API connections
 | 
			
		||||
  std::vector<uint8_t> &get_shared_buffer_ref() { return shared_write_buffer_; }
 | 
			
		||||
@@ -54,7 +56,7 @@ class APIServer : public Component, public Controller {
 | 
			
		||||
 | 
			
		||||
  void handle_disconnect(APIConnection *conn);
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
  void on_binary_sensor_update(binary_sensor::BinarySensor *obj, bool state) override;
 | 
			
		||||
  void on_binary_sensor_update(binary_sensor::BinarySensor *obj) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
  void on_cover_update(cover::Cover *obj) override;
 | 
			
		||||
@@ -104,8 +106,12 @@ class APIServer : public Component, public Controller {
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
  void on_media_player_update(media_player::MediaPlayer *obj) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  void send_homeassistant_service_call(const HomeassistantServiceResponse &call);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  void register_user_service(UserServiceDescriptor *descriptor) { this->user_services_.push_back(descriptor); }
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_HOMEASSISTANT_TIME
 | 
			
		||||
  void request_time();
 | 
			
		||||
#endif
 | 
			
		||||
@@ -122,6 +128,7 @@ class APIServer : public Component, public Controller {
 | 
			
		||||
 | 
			
		||||
  bool is_connected() const;
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  struct HomeAssistantStateSubscription {
 | 
			
		||||
    std::string entity_id;
 | 
			
		||||
    optional<std::string> attribute;
 | 
			
		||||
@@ -134,27 +141,52 @@ class APIServer : public Component, public Controller {
 | 
			
		||||
  void get_home_assistant_state(std::string entity_id, optional<std::string> attribute,
 | 
			
		||||
                                std::function<void(std::string)> f);
 | 
			
		||||
  const std::vector<HomeAssistantStateSubscription> &get_state_subs() const;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  const std::vector<UserServiceDescriptor *> &get_user_services() const { return this->user_services_; }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
 | 
			
		||||
  Trigger<std::string, std::string> *get_client_connected_trigger() const { return this->client_connected_trigger_; }
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
 | 
			
		||||
  Trigger<std::string, std::string> *get_client_disconnected_trigger() const {
 | 
			
		||||
    return this->client_disconnected_trigger_;
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool shutting_down_ = false;
 | 
			
		||||
  void schedule_reboot_timeout_();
 | 
			
		||||
  // Pointers and pointer-like types first (4 bytes each)
 | 
			
		||||
  std::unique_ptr<socket::Socket> socket_ = nullptr;
 | 
			
		||||
  uint16_t port_{6053};
 | 
			
		||||
  uint32_t reboot_timeout_{300000};
 | 
			
		||||
  uint32_t batch_delay_{100};
 | 
			
		||||
  uint32_t last_connected_{0};
 | 
			
		||||
  std::vector<std::unique_ptr<APIConnection>> clients_;
 | 
			
		||||
  std::string password_;
 | 
			
		||||
  std::vector<uint8_t> shared_write_buffer_;  // Shared proto write buffer for all connections
 | 
			
		||||
  std::vector<HomeAssistantStateSubscription> state_subs_;
 | 
			
		||||
  std::vector<UserServiceDescriptor *> user_services_;
 | 
			
		||||
#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
 | 
			
		||||
  Trigger<std::string, std::string> *client_connected_trigger_ = new Trigger<std::string, std::string>();
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
 | 
			
		||||
  Trigger<std::string, std::string> *client_disconnected_trigger_ = new Trigger<std::string, std::string>();
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // 4-byte aligned types
 | 
			
		||||
  uint32_t reboot_timeout_{300000};
 | 
			
		||||
 | 
			
		||||
  // Vectors and strings (12 bytes each on 32-bit)
 | 
			
		||||
  std::vector<std::unique_ptr<APIConnection>> clients_;
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
  std::string password_;
 | 
			
		||||
#endif
 | 
			
		||||
  std::vector<uint8_t> shared_write_buffer_;  // Shared proto write buffer for all connections
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  std::vector<HomeAssistantStateSubscription> state_subs_;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  std::vector<UserServiceDescriptor *> user_services_;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  // Group smaller types together
 | 
			
		||||
  uint16_t port_{6053};
 | 
			
		||||
  uint16_t batch_delay_{100};
 | 
			
		||||
  bool shutting_down_ = false;
 | 
			
		||||
  // 5 bytes used, 3 bytes padding
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
  std::shared_ptr<APINoiseContext> noise_ctx_ = std::make_shared<APINoiseContext>();
 | 
			
		||||
@@ -169,6 +201,5 @@ template<typename... Ts> class APIConnectedCondition : public Condition<Ts...> {
 | 
			
		||||
  bool check(Ts... x) override { return global_api_server->is_connected(); }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -4,9 +4,17 @@ import asyncio
 | 
			
		||||
from datetime import datetime
 | 
			
		||||
import logging
 | 
			
		||||
from typing import TYPE_CHECKING, Any
 | 
			
		||||
import warnings
 | 
			
		||||
 | 
			
		||||
from aioesphomeapi import APIClient, parse_log_message
 | 
			
		||||
from aioesphomeapi.log_runner import async_run
 | 
			
		||||
# Suppress protobuf version warnings
 | 
			
		||||
with warnings.catch_warnings():
 | 
			
		||||
    warnings.filterwarnings(
 | 
			
		||||
        "ignore", category=UserWarning, message=".*Protobuf gencode version.*"
 | 
			
		||||
    )
 | 
			
		||||
    from aioesphomeapi import APIClient, parse_log_message
 | 
			
		||||
    from aioesphomeapi.log_runner import async_run
 | 
			
		||||
 | 
			
		||||
import contextlib
 | 
			
		||||
 | 
			
		||||
from esphome.const import CONF_KEY, CONF_PASSWORD, CONF_PORT, __version__
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
@@ -60,7 +68,5 @@ async def async_run_logs(config: dict[str, Any], address: str) -> None:
 | 
			
		||||
 | 
			
		||||
def run_logs(config: dict[str, Any], address: str) -> None:
 | 
			
		||||
    """Run the logs command."""
 | 
			
		||||
    try:
 | 
			
		||||
    with contextlib.suppress(KeyboardInterrupt):
 | 
			
		||||
        asyncio.run(async_run_logs(config, address))
 | 
			
		||||
    except KeyboardInterrupt:
 | 
			
		||||
        pass
 | 
			
		||||
 
 | 
			
		||||
@@ -3,10 +3,12 @@
 | 
			
		||||
#include <map>
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
#include "user_services.h"
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
#endif
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
template<typename T, typename... Ts> class CustomAPIDeviceService : public UserServiceBase<Ts...> {
 | 
			
		||||
 public:
 | 
			
		||||
  CustomAPIDeviceService(const std::string &name, const std::array<std::string, sizeof...(Ts)> &arg_names, T *obj,
 | 
			
		||||
@@ -19,6 +21,7 @@ template<typename T, typename... Ts> class CustomAPIDeviceService : public UserS
 | 
			
		||||
  T *obj_;
 | 
			
		||||
  void (T::*callback_)(Ts...);
 | 
			
		||||
};
 | 
			
		||||
#endif  // USE_API_SERVICES
 | 
			
		||||
 | 
			
		||||
class CustomAPIDevice {
 | 
			
		||||
 public:
 | 
			
		||||
@@ -46,12 +49,14 @@ class CustomAPIDevice {
 | 
			
		||||
   * @param name The name of the service to register.
 | 
			
		||||
   * @param arg_names The name of the arguments for the service, must match the arguments of the function.
 | 
			
		||||
   */
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  template<typename T, typename... Ts>
 | 
			
		||||
  void register_service(void (T::*callback)(Ts...), const std::string &name,
 | 
			
		||||
                        const std::array<std::string, sizeof...(Ts)> &arg_names) {
 | 
			
		||||
    auto *service = new CustomAPIDeviceService<T, Ts...>(name, arg_names, (T *) this, callback);  // NOLINT
 | 
			
		||||
    global_api_server->register_user_service(service);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  /** Register a custom native API service that will show up in Home Assistant.
 | 
			
		||||
   *
 | 
			
		||||
@@ -71,11 +76,14 @@ class CustomAPIDevice {
 | 
			
		||||
   * @param callback The member function to call when the service is triggered.
 | 
			
		||||
   * @param name The name of the arguments for the service, must match the arguments of the function.
 | 
			
		||||
   */
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  template<typename T> void register_service(void (T::*callback)(), const std::string &name) {
 | 
			
		||||
    auto *service = new CustomAPIDeviceService<T>(name, {}, (T *) this, callback);  // NOLINT
 | 
			
		||||
    global_api_server->register_user_service(service);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_STATES
 | 
			
		||||
  /** Subscribe to the state (or attribute state) of an entity from Home Assistant.
 | 
			
		||||
   *
 | 
			
		||||
   * Usage:
 | 
			
		||||
@@ -127,7 +135,9 @@ class CustomAPIDevice {
 | 
			
		||||
    auto f = std::bind(callback, (T *) this, entity_id, std::placeholders::_1);
 | 
			
		||||
    global_api_server->subscribe_home_assistant_state(entity_id, optional<std::string>(attribute), f);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
  /** Call a Home Assistant service from ESPHome.
 | 
			
		||||
   *
 | 
			
		||||
   * Usage:
 | 
			
		||||
@@ -140,7 +150,7 @@ class CustomAPIDevice {
 | 
			
		||||
   */
 | 
			
		||||
  void call_homeassistant_service(const std::string &service_name) {
 | 
			
		||||
    HomeassistantServiceResponse resp;
 | 
			
		||||
    resp.service = service_name;
 | 
			
		||||
    resp.set_service(StringRef(service_name));
 | 
			
		||||
    global_api_server->send_homeassistant_service_call(resp);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
@@ -160,12 +170,12 @@ class CustomAPIDevice {
 | 
			
		||||
   */
 | 
			
		||||
  void call_homeassistant_service(const std::string &service_name, const std::map<std::string, std::string> &data) {
 | 
			
		||||
    HomeassistantServiceResponse resp;
 | 
			
		||||
    resp.service = service_name;
 | 
			
		||||
    resp.set_service(StringRef(service_name));
 | 
			
		||||
    for (auto &it : data) {
 | 
			
		||||
      HomeassistantServiceMap kv;
 | 
			
		||||
      kv.key = it.first;
 | 
			
		||||
      resp.data.emplace_back();
 | 
			
		||||
      auto &kv = resp.data.back();
 | 
			
		||||
      kv.set_key(StringRef(it.first));
 | 
			
		||||
      kv.value = it.second;
 | 
			
		||||
      resp.data.push_back(kv);
 | 
			
		||||
    }
 | 
			
		||||
    global_api_server->send_homeassistant_service_call(resp);
 | 
			
		||||
  }
 | 
			
		||||
@@ -182,7 +192,7 @@ class CustomAPIDevice {
 | 
			
		||||
   */
 | 
			
		||||
  void fire_homeassistant_event(const std::string &event_name) {
 | 
			
		||||
    HomeassistantServiceResponse resp;
 | 
			
		||||
    resp.service = event_name;
 | 
			
		||||
    resp.set_service(StringRef(event_name));
 | 
			
		||||
    resp.is_event = true;
 | 
			
		||||
    global_api_server->send_homeassistant_service_call(resp);
 | 
			
		||||
  }
 | 
			
		||||
@@ -202,18 +212,18 @@ class CustomAPIDevice {
 | 
			
		||||
   */
 | 
			
		||||
  void fire_homeassistant_event(const std::string &service_name, const std::map<std::string, std::string> &data) {
 | 
			
		||||
    HomeassistantServiceResponse resp;
 | 
			
		||||
    resp.service = service_name;
 | 
			
		||||
    resp.set_service(StringRef(service_name));
 | 
			
		||||
    resp.is_event = true;
 | 
			
		||||
    for (auto &it : data) {
 | 
			
		||||
      HomeassistantServiceMap kv;
 | 
			
		||||
      kv.key = it.first;
 | 
			
		||||
      resp.data.emplace_back();
 | 
			
		||||
      auto &kv = resp.data.back();
 | 
			
		||||
      kv.set_key(StringRef(it.first));
 | 
			
		||||
      kv.value = it.second;
 | 
			
		||||
      resp.data.push_back(kv);
 | 
			
		||||
    }
 | 
			
		||||
    global_api_server->send_homeassistant_service_call(resp);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -2,15 +2,27 @@
 | 
			
		||||
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#ifdef USE_API_HOMEASSISTANT_SERVICES
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
template<typename... X> class TemplatableStringValue : public TemplatableValue<std::string, X...> {
 | 
			
		||||
 private:
 | 
			
		||||
  // Helper to convert value to string - handles the case where value is already a string
 | 
			
		||||
  template<typename T> static std::string value_to_string(T &&val) { return to_string(std::forward<T>(val)); }
 | 
			
		||||
 | 
			
		||||
  // Overloads for string types - needed because std::to_string doesn't support them
 | 
			
		||||
  static std::string value_to_string(char *val) {
 | 
			
		||||
    return val ? std::string(val) : std::string();
 | 
			
		||||
  }  // For lambdas returning char* (e.g., itoa)
 | 
			
		||||
  static std::string value_to_string(const char *val) { return std::string(val); }  // For lambdas returning .c_str()
 | 
			
		||||
  static std::string value_to_string(const std::string &val) { return val; }
 | 
			
		||||
  static std::string value_to_string(std::string &&val) { return std::move(val); }
 | 
			
		||||
 | 
			
		||||
 public:
 | 
			
		||||
  TemplatableStringValue() : TemplatableValue<std::string, X...>() {}
 | 
			
		||||
 | 
			
		||||
@@ -19,11 +31,14 @@ template<typename... X> class TemplatableStringValue : public TemplatableValue<s
 | 
			
		||||
 | 
			
		||||
  template<typename F, enable_if_t<is_invocable<F, X...>::value, int> = 0>
 | 
			
		||||
  TemplatableStringValue(F f)
 | 
			
		||||
      : TemplatableValue<std::string, X...>([f](X... x) -> std::string { return to_string(f(x...)); }) {}
 | 
			
		||||
      : TemplatableValue<std::string, X...>([f](X... x) -> std::string { return value_to_string(f(x...)); }) {}
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class TemplatableKeyValuePair {
 | 
			
		||||
 public:
 | 
			
		||||
  // Keys are always string literals from YAML dictionary keys (e.g., "code", "event")
 | 
			
		||||
  // and never templatable values or lambdas. Only the value parameter can be a lambda/template.
 | 
			
		||||
  // Using pass-by-value with std::move allows optimal performance for both lvalues and rvalues.
 | 
			
		||||
  template<typename T> TemplatableKeyValuePair(std::string key, T value) : key(std::move(key)), value(value) {}
 | 
			
		||||
  std::string key;
 | 
			
		||||
  TemplatableStringValue<Ts...> value;
 | 
			
		||||
@@ -35,37 +50,39 @@ template<typename... Ts> class HomeAssistantServiceCallAction : public Action<Ts
 | 
			
		||||
 | 
			
		||||
  template<typename T> void set_service(T service) { this->service_ = service; }
 | 
			
		||||
 | 
			
		||||
  template<typename T> void add_data(std::string key, T value) {
 | 
			
		||||
    this->data_.push_back(TemplatableKeyValuePair<Ts...>(key, value));
 | 
			
		||||
  }
 | 
			
		||||
  // Keys are always string literals from the Python code generation (e.g., cg.add(var.add_data("tag_id", templ))).
 | 
			
		||||
  // The value parameter can be a lambda/template, but keys are never templatable.
 | 
			
		||||
  // Using pass-by-value allows the compiler to optimize for both lvalues and rvalues.
 | 
			
		||||
  template<typename T> void add_data(std::string key, T value) { this->data_.emplace_back(std::move(key), value); }
 | 
			
		||||
  template<typename T> void add_data_template(std::string key, T value) {
 | 
			
		||||
    this->data_template_.push_back(TemplatableKeyValuePair<Ts...>(key, value));
 | 
			
		||||
    this->data_template_.emplace_back(std::move(key), value);
 | 
			
		||||
  }
 | 
			
		||||
  template<typename T> void add_variable(std::string key, T value) {
 | 
			
		||||
    this->variables_.push_back(TemplatableKeyValuePair<Ts...>(key, value));
 | 
			
		||||
    this->variables_.emplace_back(std::move(key), value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  void play(Ts... x) override {
 | 
			
		||||
    HomeassistantServiceResponse resp;
 | 
			
		||||
    resp.service = this->service_.value(x...);
 | 
			
		||||
    std::string service_value = this->service_.value(x...);
 | 
			
		||||
    resp.set_service(StringRef(service_value));
 | 
			
		||||
    resp.is_event = this->is_event_;
 | 
			
		||||
    for (auto &it : this->data_) {
 | 
			
		||||
      HomeassistantServiceMap kv;
 | 
			
		||||
      kv.key = it.key;
 | 
			
		||||
      resp.data.emplace_back();
 | 
			
		||||
      auto &kv = resp.data.back();
 | 
			
		||||
      kv.set_key(StringRef(it.key));
 | 
			
		||||
      kv.value = it.value.value(x...);
 | 
			
		||||
      resp.data.push_back(kv);
 | 
			
		||||
    }
 | 
			
		||||
    for (auto &it : this->data_template_) {
 | 
			
		||||
      HomeassistantServiceMap kv;
 | 
			
		||||
      kv.key = it.key;
 | 
			
		||||
      resp.data_template.emplace_back();
 | 
			
		||||
      auto &kv = resp.data_template.back();
 | 
			
		||||
      kv.set_key(StringRef(it.key));
 | 
			
		||||
      kv.value = it.value.value(x...);
 | 
			
		||||
      resp.data_template.push_back(kv);
 | 
			
		||||
    }
 | 
			
		||||
    for (auto &it : this->variables_) {
 | 
			
		||||
      HomeassistantServiceMap kv;
 | 
			
		||||
      kv.key = it.key;
 | 
			
		||||
      resp.variables.emplace_back();
 | 
			
		||||
      auto &kv = resp.variables.back();
 | 
			
		||||
      kv.set_key(StringRef(it.key));
 | 
			
		||||
      kv.value = it.value.value(x...);
 | 
			
		||||
      resp.variables.push_back(kv);
 | 
			
		||||
    }
 | 
			
		||||
    this->parent_->send_homeassistant_service_call(resp);
 | 
			
		||||
  }
 | 
			
		||||
@@ -79,6 +96,6 @@ template<typename... Ts> class HomeAssistantServiceCallAction : public Action<Ts
 | 
			
		||||
  std::vector<TemplatableKeyValuePair<Ts...>> variables_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,162 +1,93 @@
 | 
			
		||||
#include "list_entities.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "api_connection.h"
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "esphome/core/application.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "esphome/core/util.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
// Generate entity handler implementations using macros
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
bool ListEntitiesIterator::on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) {
 | 
			
		||||
  this->client_->send_binary_sensor_info(binary_sensor);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(binary_sensor, binary_sensor::BinarySensor, ListEntitiesBinarySensorResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
bool ListEntitiesIterator::on_cover(cover::Cover *cover) {
 | 
			
		||||
  this->client_->send_cover_info(cover);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(cover, cover::Cover, ListEntitiesCoverResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_FAN
 | 
			
		||||
bool ListEntitiesIterator::on_fan(fan::Fan *fan) {
 | 
			
		||||
  this->client_->send_fan_info(fan);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(fan, fan::Fan, ListEntitiesFanResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LIGHT
 | 
			
		||||
bool ListEntitiesIterator::on_light(light::LightState *light) {
 | 
			
		||||
  this->client_->send_light_info(light);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(light, light::LightState, ListEntitiesLightResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SENSOR
 | 
			
		||||
bool ListEntitiesIterator::on_sensor(sensor::Sensor *sensor) {
 | 
			
		||||
  this->client_->send_sensor_info(sensor);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(sensor, sensor::Sensor, ListEntitiesSensorResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SWITCH
 | 
			
		||||
bool ListEntitiesIterator::on_switch(switch_::Switch *a_switch) {
 | 
			
		||||
  this->client_->send_switch_info(a_switch);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(switch, switch_::Switch, ListEntitiesSwitchResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
bool ListEntitiesIterator::on_button(button::Button *button) {
 | 
			
		||||
  this->client_->send_button_info(button);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(button, button::Button, ListEntitiesButtonResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT_SENSOR
 | 
			
		||||
bool ListEntitiesIterator::on_text_sensor(text_sensor::TextSensor *text_sensor) {
 | 
			
		||||
  this->client_->send_text_sensor_info(text_sensor);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(text_sensor, text_sensor::TextSensor, ListEntitiesTextSensorResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LOCK
 | 
			
		||||
bool ListEntitiesIterator::on_lock(lock::Lock *a_lock) {
 | 
			
		||||
  this->client_->send_lock_info(a_lock);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(lock, lock::Lock, ListEntitiesLockResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VALVE
 | 
			
		||||
bool ListEntitiesIterator::on_valve(valve::Valve *valve) {
 | 
			
		||||
  this->client_->send_valve_info(valve);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(valve, valve::Valve, ListEntitiesValveResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
bool ListEntitiesIterator::on_end() { return this->client_->send_list_info_done(); }
 | 
			
		||||
ListEntitiesIterator::ListEntitiesIterator(APIConnection *client) : client_(client) {}
 | 
			
		||||
bool ListEntitiesIterator::on_service(UserServiceDescriptor *service) {
 | 
			
		||||
  auto resp = service->encode_list_service_response();
 | 
			
		||||
  return this->client_->send_message(resp);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
bool ListEntitiesIterator::on_camera(esp32_camera::ESP32Camera *camera) {
 | 
			
		||||
  this->client_->send_camera_info(camera);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
LIST_ENTITIES_HANDLER(camera, camera::Camera, ListEntitiesCameraResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
bool ListEntitiesIterator::on_climate(climate::Climate *climate) {
 | 
			
		||||
  this->client_->send_climate_info(climate);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(climate, climate::Climate, ListEntitiesClimateResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_NUMBER
 | 
			
		||||
bool ListEntitiesIterator::on_number(number::Number *number) {
 | 
			
		||||
  this->client_->send_number_info(number);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(number, number::Number, ListEntitiesNumberResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_DATETIME_DATE
 | 
			
		||||
bool ListEntitiesIterator::on_date(datetime::DateEntity *date) {
 | 
			
		||||
  this->client_->send_date_info(date);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(date, datetime::DateEntity, ListEntitiesDateResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_DATETIME_TIME
 | 
			
		||||
bool ListEntitiesIterator::on_time(datetime::TimeEntity *time) {
 | 
			
		||||
  this->client_->send_time_info(time);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(time, datetime::TimeEntity, ListEntitiesTimeResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_DATETIME_DATETIME
 | 
			
		||||
bool ListEntitiesIterator::on_datetime(datetime::DateTimeEntity *datetime) {
 | 
			
		||||
  this->client_->send_datetime_info(datetime);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(datetime, datetime::DateTimeEntity, ListEntitiesDateTimeResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_TEXT
 | 
			
		||||
bool ListEntitiesIterator::on_text(text::Text *text) {
 | 
			
		||||
  this->client_->send_text_info(text);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(text, text::Text, ListEntitiesTextResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SELECT
 | 
			
		||||
bool ListEntitiesIterator::on_select(select::Select *select) {
 | 
			
		||||
  this->client_->send_select_info(select);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(select, select::Select, ListEntitiesSelectResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
bool ListEntitiesIterator::on_media_player(media_player::MediaPlayer *media_player) {
 | 
			
		||||
  this->client_->send_media_player_info(media_player);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(media_player, media_player::MediaPlayer, ListEntitiesMediaPlayerResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
bool ListEntitiesIterator::on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) {
 | 
			
		||||
  this->client_->send_alarm_control_panel_info(a_alarm_control_panel);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(alarm_control_panel, alarm_control_panel::AlarmControlPanel,
 | 
			
		||||
                      ListEntitiesAlarmControlPanelResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_EVENT
 | 
			
		||||
bool ListEntitiesIterator::on_event(event::Event *event) {
 | 
			
		||||
  this->client_->send_event_info(event);
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
LIST_ENTITIES_HANDLER(event, event::Event, ListEntitiesEventResponse)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_UPDATE
 | 
			
		||||
bool ListEntitiesIterator::on_update(update::UpdateEntity *update) {
 | 
			
		||||
  this->client_->send_update_info(update);
 | 
			
		||||
  return true;
 | 
			
		||||
LIST_ENTITIES_HANDLER(update, update::UpdateEntity, ListEntitiesUpdateResponse)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
// Special cases that don't follow the pattern
 | 
			
		||||
bool ListEntitiesIterator::on_end() { return this->client_->send_list_info_done(); }
 | 
			
		||||
 | 
			
		||||
ListEntitiesIterator::ListEntitiesIterator(APIConnection *client) : client_(client) {}
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
bool ListEntitiesIterator::on_service(UserServiceDescriptor *service) {
 | 
			
		||||
  auto resp = service->encode_list_service_response();
 | 
			
		||||
  return this->client_->send_message(resp, ListEntitiesServicesResponse::MESSAGE_TYPE);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -4,80 +4,89 @@
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/component_iterator.h"
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
class APIConnection;
 | 
			
		||||
 | 
			
		||||
// Macro for generating ListEntitiesIterator handlers
 | 
			
		||||
// Calls schedule_message_ with try_send_*_info
 | 
			
		||||
#define LIST_ENTITIES_HANDLER(entity_type, EntityClass, ResponseType) \
 | 
			
		||||
  bool ListEntitiesIterator::on_##entity_type(EntityClass *entity) { /* NOLINT(bugprone-macro-parentheses) */ \
 | 
			
		||||
    return this->client_->schedule_message_(entity, &APIConnection::try_send_##entity_type##_info, \
 | 
			
		||||
                                            ResponseType::MESSAGE_TYPE, ResponseType::ESTIMATED_SIZE); \
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
class ListEntitiesIterator : public ComponentIterator {
 | 
			
		||||
 public:
 | 
			
		||||
  ListEntitiesIterator(APIConnection *client);
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
  bool on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) override;
 | 
			
		||||
  bool on_binary_sensor(binary_sensor::BinarySensor *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
  bool on_cover(cover::Cover *cover) override;
 | 
			
		||||
  bool on_cover(cover::Cover *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_FAN
 | 
			
		||||
  bool on_fan(fan::Fan *fan) override;
 | 
			
		||||
  bool on_fan(fan::Fan *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LIGHT
 | 
			
		||||
  bool on_light(light::LightState *light) override;
 | 
			
		||||
  bool on_light(light::LightState *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SENSOR
 | 
			
		||||
  bool on_sensor(sensor::Sensor *sensor) override;
 | 
			
		||||
  bool on_sensor(sensor::Sensor *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SWITCH
 | 
			
		||||
  bool on_switch(switch_::Switch *a_switch) override;
 | 
			
		||||
  bool on_switch(switch_::Switch *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
  bool on_button(button::Button *button) override;
 | 
			
		||||
  bool on_button(button::Button *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT_SENSOR
 | 
			
		||||
  bool on_text_sensor(text_sensor::TextSensor *text_sensor) override;
 | 
			
		||||
  bool on_text_sensor(text_sensor::TextSensor *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
  bool on_service(UserServiceDescriptor *service) override;
 | 
			
		||||
#ifdef USE_ESP32_CAMERA
 | 
			
		||||
  bool on_camera(esp32_camera::ESP32Camera *camera) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CAMERA
 | 
			
		||||
  bool on_camera(camera::Camera *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
  bool on_climate(climate::Climate *climate) override;
 | 
			
		||||
  bool on_climate(climate::Climate *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_NUMBER
 | 
			
		||||
  bool on_number(number::Number *number) override;
 | 
			
		||||
  bool on_number(number::Number *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATE
 | 
			
		||||
  bool on_date(datetime::DateEntity *date) override;
 | 
			
		||||
  bool on_date(datetime::DateEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_TIME
 | 
			
		||||
  bool on_time(datetime::TimeEntity *time) override;
 | 
			
		||||
  bool on_time(datetime::TimeEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATETIME
 | 
			
		||||
  bool on_datetime(datetime::DateTimeEntity *datetime) override;
 | 
			
		||||
  bool on_datetime(datetime::DateTimeEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT
 | 
			
		||||
  bool on_text(text::Text *text) override;
 | 
			
		||||
  bool on_text(text::Text *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SELECT
 | 
			
		||||
  bool on_select(select::Select *select) override;
 | 
			
		||||
  bool on_select(select::Select *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LOCK
 | 
			
		||||
  bool on_lock(lock::Lock *a_lock) override;
 | 
			
		||||
  bool on_lock(lock::Lock *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VALVE
 | 
			
		||||
  bool on_valve(valve::Valve *valve) override;
 | 
			
		||||
  bool on_valve(valve::Valve *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
  bool on_media_player(media_player::MediaPlayer *media_player) override;
 | 
			
		||||
  bool on_media_player(media_player::MediaPlayer *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
  bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) override;
 | 
			
		||||
  bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_EVENT
 | 
			
		||||
  bool on_event(event::Event *event) override;
 | 
			
		||||
  bool on_event(event::Event *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_UPDATE
 | 
			
		||||
  bool on_update(update::UpdateEntity *update) override;
 | 
			
		||||
  bool on_update(update::UpdateEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
  bool on_end() override;
 | 
			
		||||
  bool completed() { return this->state_ == IteratorState::NONE; }
 | 
			
		||||
@@ -86,6 +95,5 @@ class ListEntitiesIterator : public ComponentIterator {
 | 
			
		||||
  APIConnection *client_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -3,12 +3,11 @@
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "api.proto";
 | 
			
		||||
 | 
			
		||||
void ProtoMessage::decode(const uint8_t *buffer, size_t length) {
 | 
			
		||||
void ProtoDecodableMessage::decode(const uint8_t *buffer, size_t length) {
 | 
			
		||||
  uint32_t i = 0;
 | 
			
		||||
  bool error = false;
 | 
			
		||||
  while (i < length) {
 | 
			
		||||
@@ -89,5 +88,4 @@ std::string ProtoMessage::dump() const {
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
 
 | 
			
		||||
@@ -3,15 +3,47 @@
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "esphome/core/string_ref.h"
 | 
			
		||||
 | 
			
		||||
#include <cassert>
 | 
			
		||||
#include <cstring>
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
#ifdef ESPHOME_LOG_HAS_VERY_VERBOSE
 | 
			
		||||
#define HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * StringRef Ownership Model for API Protocol Messages
 | 
			
		||||
 * ===================================================
 | 
			
		||||
 *
 | 
			
		||||
 * StringRef is used for zero-copy string handling in outgoing (SOURCE_SERVER) messages.
 | 
			
		||||
 * It holds a pointer and length to existing string data without copying.
 | 
			
		||||
 *
 | 
			
		||||
 * CRITICAL: The referenced string data MUST remain valid until message encoding completes.
 | 
			
		||||
 *
 | 
			
		||||
 * Safe StringRef Patterns:
 | 
			
		||||
 * 1. String literals: StringRef("literal") - Always safe (static storage duration)
 | 
			
		||||
 * 2. Member variables: StringRef(this->member_string_) - Safe if object outlives encoding
 | 
			
		||||
 * 3. Global/static strings: StringRef(GLOBAL_CONSTANT) - Always safe
 | 
			
		||||
 * 4. Local variables: Safe ONLY if encoding happens before function returns:
 | 
			
		||||
 *    std::string temp = compute_value();
 | 
			
		||||
 *    msg.set_field(StringRef(temp));
 | 
			
		||||
 *    return this->send_message(msg);  // temp is valid during encoding
 | 
			
		||||
 *
 | 
			
		||||
 * Unsafe Patterns (WILL cause crashes/corruption):
 | 
			
		||||
 * 1. Temporaries: msg.set_field(StringRef(obj.get_string())) // get_string() returns by value
 | 
			
		||||
 * 2. Concatenation: msg.set_field(StringRef(str1 + str2)) // Result is temporary
 | 
			
		||||
 *
 | 
			
		||||
 * For unsafe patterns, store in a local variable first:
 | 
			
		||||
 *    std::string temp = get_string();  // or str1 + str2
 | 
			
		||||
 *    msg.set_field(StringRef(temp));
 | 
			
		||||
 *
 | 
			
		||||
 * The send_*_response pattern ensures proper lifetime management by encoding
 | 
			
		||||
 * within the same function scope where temporaries are created.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/// Representation of a VarInt - in ProtoBuf should be 64bit but we only use 32bit
 | 
			
		||||
class ProtoVarInt {
 | 
			
		||||
@@ -59,7 +91,6 @@ class ProtoVarInt {
 | 
			
		||||
  uint32_t as_uint32() const { return this->value_; }
 | 
			
		||||
  uint64_t as_uint64() const { return this->value_; }
 | 
			
		||||
  bool as_bool() const { return this->value_; }
 | 
			
		||||
  template<typename T> T as_enum() const { return static_cast<T>(this->as_uint32()); }
 | 
			
		||||
  int32_t as_int32() const {
 | 
			
		||||
    // Not ZigZag encoded
 | 
			
		||||
    return static_cast<int32_t>(this->as_int64());
 | 
			
		||||
@@ -133,15 +164,25 @@ class ProtoVarInt {
 | 
			
		||||
  uint64_t value_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Forward declaration for decode_to_message and encode_to_writer
 | 
			
		||||
class ProtoMessage;
 | 
			
		||||
class ProtoDecodableMessage;
 | 
			
		||||
 | 
			
		||||
class ProtoLengthDelimited {
 | 
			
		||||
 public:
 | 
			
		||||
  explicit ProtoLengthDelimited(const uint8_t *value, size_t length) : value_(value), length_(length) {}
 | 
			
		||||
  std::string as_string() const { return std::string(reinterpret_cast<const char *>(this->value_), this->length_); }
 | 
			
		||||
  template<class C> C as_message() const {
 | 
			
		||||
    auto msg = C();
 | 
			
		||||
    msg.decode(this->value_, this->length_);
 | 
			
		||||
    return msg;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * Decode the length-delimited data into an existing ProtoDecodableMessage instance.
 | 
			
		||||
   *
 | 
			
		||||
   * This method allows decoding without templates, enabling use in contexts
 | 
			
		||||
   * where the message type is not known at compile time. The ProtoDecodableMessage's
 | 
			
		||||
   * decode() method will be called with the raw data and length.
 | 
			
		||||
   *
 | 
			
		||||
   * @param msg The ProtoDecodableMessage instance to decode into
 | 
			
		||||
   */
 | 
			
		||||
  void decode_to_message(ProtoDecodableMessage &msg) const;
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  const uint8_t *const value_;
 | 
			
		||||
@@ -166,23 +207,7 @@ class Proto32Bit {
 | 
			
		||||
  const uint32_t value_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class Proto64Bit {
 | 
			
		||||
 public:
 | 
			
		||||
  explicit Proto64Bit(uint64_t value) : value_(value) {}
 | 
			
		||||
  uint64_t as_fixed64() const { return this->value_; }
 | 
			
		||||
  int64_t as_sfixed64() const { return static_cast<int64_t>(this->value_); }
 | 
			
		||||
  double as_double() const {
 | 
			
		||||
    union {
 | 
			
		||||
      uint64_t raw;
 | 
			
		||||
      double value;
 | 
			
		||||
    } s{};
 | 
			
		||||
    s.raw = this->value_;
 | 
			
		||||
    return s.value;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  const uint64_t value_;
 | 
			
		||||
};
 | 
			
		||||
// NOTE: Proto64Bit class removed - wire type 1 (64-bit fixed) not supported
 | 
			
		||||
 | 
			
		||||
class ProtoWriteBuffer {
 | 
			
		||||
 public:
 | 
			
		||||
@@ -196,9 +221,9 @@ class ProtoWriteBuffer {
 | 
			
		||||
   * @param field_id Field number (tag) in the protobuf message
 | 
			
		||||
   * @param type Wire type value:
 | 
			
		||||
   *   - 0: Varint (int32, int64, uint32, uint64, sint32, sint64, bool, enum)
 | 
			
		||||
   *   - 1: 64-bit (fixed64, sfixed64, double)
 | 
			
		||||
   *   - 2: Length-delimited (string, bytes, embedded messages, packed repeated fields)
 | 
			
		||||
   *   - 5: 32-bit (fixed32, sfixed32, float)
 | 
			
		||||
   *   - Note: Wire type 1 (64-bit fixed) is not supported
 | 
			
		||||
   *
 | 
			
		||||
   * Following https://protobuf.dev/programming-guides/encoding/#structure
 | 
			
		||||
   */
 | 
			
		||||
@@ -212,12 +237,20 @@ class ProtoWriteBuffer {
 | 
			
		||||
 | 
			
		||||
    this->encode_field_raw(field_id, 2);  // type 2: Length-delimited string
 | 
			
		||||
    this->encode_varint_raw(len);
 | 
			
		||||
    auto *data = reinterpret_cast<const uint8_t *>(string);
 | 
			
		||||
    this->buffer_->insert(this->buffer_->end(), data, data + len);
 | 
			
		||||
 | 
			
		||||
    // Using resize + memcpy instead of insert provides significant performance improvement:
 | 
			
		||||
    // ~10-11x faster for 16-32 byte strings, ~3x faster for 64-byte strings
 | 
			
		||||
    // as it avoids iterator checks and potential element moves that insert performs
 | 
			
		||||
    size_t old_size = this->buffer_->size();
 | 
			
		||||
    this->buffer_->resize(old_size + len);
 | 
			
		||||
    std::memcpy(this->buffer_->data() + old_size, string, len);
 | 
			
		||||
  }
 | 
			
		||||
  void encode_string(uint32_t field_id, const std::string &value, bool force = false) {
 | 
			
		||||
    this->encode_string(field_id, value.data(), value.size(), force);
 | 
			
		||||
  }
 | 
			
		||||
  void encode_string(uint32_t field_id, const StringRef &ref, bool force = false) {
 | 
			
		||||
    this->encode_string(field_id, ref.c_str(), ref.size(), force);
 | 
			
		||||
  }
 | 
			
		||||
  void encode_bytes(uint32_t field_id, const uint8_t *data, size_t len, bool force = false) {
 | 
			
		||||
    this->encode_string(field_id, reinterpret_cast<const char *>(data), len, force);
 | 
			
		||||
  }
 | 
			
		||||
@@ -249,23 +282,10 @@ class ProtoWriteBuffer {
 | 
			
		||||
    this->write((value >> 16) & 0xFF);
 | 
			
		||||
    this->write((value >> 24) & 0xFF);
 | 
			
		||||
  }
 | 
			
		||||
  void encode_fixed64(uint32_t field_id, uint64_t value, bool force = false) {
 | 
			
		||||
    if (value == 0 && !force)
 | 
			
		||||
      return;
 | 
			
		||||
 | 
			
		||||
    this->encode_field_raw(field_id, 1);  // type 1: 64-bit fixed64
 | 
			
		||||
    this->write((value >> 0) & 0xFF);
 | 
			
		||||
    this->write((value >> 8) & 0xFF);
 | 
			
		||||
    this->write((value >> 16) & 0xFF);
 | 
			
		||||
    this->write((value >> 24) & 0xFF);
 | 
			
		||||
    this->write((value >> 32) & 0xFF);
 | 
			
		||||
    this->write((value >> 40) & 0xFF);
 | 
			
		||||
    this->write((value >> 48) & 0xFF);
 | 
			
		||||
    this->write((value >> 56) & 0xFF);
 | 
			
		||||
  }
 | 
			
		||||
  template<typename T> void encode_enum(uint32_t field_id, T value, bool force = false) {
 | 
			
		||||
    this->encode_uint32(field_id, static_cast<uint32_t>(value), force);
 | 
			
		||||
  }
 | 
			
		||||
  // NOTE: Wire type 1 (64-bit fixed: double, fixed64, sfixed64) is intentionally
 | 
			
		||||
  // not supported to reduce overhead on embedded systems. All ESPHome devices are
 | 
			
		||||
  // 32-bit microcontrollers where 64-bit operations are expensive. If 64-bit support
 | 
			
		||||
  // is needed in the future, the necessary encoding/decoding functions must be added.
 | 
			
		||||
  void encode_float(uint32_t field_id, float value, bool force = false) {
 | 
			
		||||
    if (value == 0.0f && !force)
 | 
			
		||||
      return;
 | 
			
		||||
@@ -306,18 +326,7 @@ class ProtoWriteBuffer {
 | 
			
		||||
    }
 | 
			
		||||
    this->encode_uint64(field_id, uvalue, force);
 | 
			
		||||
  }
 | 
			
		||||
  template<class C> void encode_message(uint32_t field_id, const C &value, bool force = false) {
 | 
			
		||||
    this->encode_field_raw(field_id, 2);  // type 2: Length-delimited message
 | 
			
		||||
    size_t begin = this->buffer_->size();
 | 
			
		||||
 | 
			
		||||
    value.encode(*this);
 | 
			
		||||
 | 
			
		||||
    const uint32_t nested_length = this->buffer_->size() - begin;
 | 
			
		||||
    // add size varint
 | 
			
		||||
    std::vector<uint8_t> var;
 | 
			
		||||
    ProtoVarInt(nested_length).encode(var);
 | 
			
		||||
    this->buffer_->insert(this->buffer_->begin() + begin, var.begin(), var.end());
 | 
			
		||||
  }
 | 
			
		||||
  void encode_message(uint32_t field_id, const ProtoMessage &value, bool force = false);
 | 
			
		||||
  std::vector<uint8_t> *get_buffer() const { return buffer_; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
@@ -327,21 +336,521 @@ class ProtoWriteBuffer {
 | 
			
		||||
class ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  virtual ~ProtoMessage() = default;
 | 
			
		||||
  virtual void encode(ProtoWriteBuffer buffer) const = 0;
 | 
			
		||||
  void decode(const uint8_t *buffer, size_t length);
 | 
			
		||||
  virtual void calculate_size(uint32_t &total_size) const = 0;
 | 
			
		||||
  // Default implementation for messages with no fields
 | 
			
		||||
  virtual void encode(ProtoWriteBuffer buffer) const {}
 | 
			
		||||
  // Default implementation for messages with no fields
 | 
			
		||||
  virtual void calculate_size(uint32_t &total_size) const {}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  std::string dump() const;
 | 
			
		||||
  virtual void dump_to(std::string &out) const = 0;
 | 
			
		||||
  virtual const char *message_name() const { return "unknown"; }
 | 
			
		||||
#endif
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Base class for messages that support decoding
 | 
			
		||||
class ProtoDecodableMessage : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  void decode(const uint8_t *buffer, size_t length);
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  virtual bool decode_varint(uint32_t field_id, ProtoVarInt value) { return false; }
 | 
			
		||||
  virtual bool decode_length(uint32_t field_id, ProtoLengthDelimited value) { return false; }
 | 
			
		||||
  virtual bool decode_32bit(uint32_t field_id, Proto32Bit value) { return false; }
 | 
			
		||||
  virtual bool decode_64bit(uint32_t field_id, Proto64Bit value) { return false; }
 | 
			
		||||
  // NOTE: decode_64bit removed - wire type 1 not supported
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class ProtoSize {
 | 
			
		||||
 public:
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief ProtoSize class for Protocol Buffer serialization size calculation
 | 
			
		||||
   *
 | 
			
		||||
   * This class provides static methods to calculate the exact byte counts needed
 | 
			
		||||
   * for encoding various Protocol Buffer field types. All methods are designed to be
 | 
			
		||||
   * efficient for the common case where many fields have default values.
 | 
			
		||||
   *
 | 
			
		||||
   * Implements Protocol Buffer encoding size calculation according to:
 | 
			
		||||
   * https://protobuf.dev/programming-guides/encoding/
 | 
			
		||||
   *
 | 
			
		||||
   * Key features:
 | 
			
		||||
   * - Early-return optimization for zero/default values
 | 
			
		||||
   * - Direct total_size updates to avoid unnecessary additions
 | 
			
		||||
   * - Specialized handling for different field types according to protobuf spec
 | 
			
		||||
   * - Templated helpers for repeated fields and messages
 | 
			
		||||
   */
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode a uint32_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The uint32_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(uint32_t value) {
 | 
			
		||||
    // Optimized varint size calculation using leading zeros
 | 
			
		||||
    // Each 7 bits requires one byte in the varint encoding
 | 
			
		||||
    if (value < 128)
 | 
			
		||||
      return 1;  // 7 bits, common case for small values
 | 
			
		||||
 | 
			
		||||
    // For larger values, count bytes needed based on the position of the highest bit set
 | 
			
		||||
    if (value < 16384) {
 | 
			
		||||
      return 2;  // 14 bits
 | 
			
		||||
    } else if (value < 2097152) {
 | 
			
		||||
      return 3;  // 21 bits
 | 
			
		||||
    } else if (value < 268435456) {
 | 
			
		||||
      return 4;  // 28 bits
 | 
			
		||||
    } else {
 | 
			
		||||
      return 5;  // 32 bits (maximum for uint32_t)
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode a uint64_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The uint64_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(uint64_t value) {
 | 
			
		||||
    // Handle common case of values fitting in uint32_t (vast majority of use cases)
 | 
			
		||||
    if (value <= UINT32_MAX) {
 | 
			
		||||
      return varint(static_cast<uint32_t>(value));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // For larger values, determine size based on highest bit position
 | 
			
		||||
    if (value < (1ULL << 35)) {
 | 
			
		||||
      return 5;  // 35 bits
 | 
			
		||||
    } else if (value < (1ULL << 42)) {
 | 
			
		||||
      return 6;  // 42 bits
 | 
			
		||||
    } else if (value < (1ULL << 49)) {
 | 
			
		||||
      return 7;  // 49 bits
 | 
			
		||||
    } else if (value < (1ULL << 56)) {
 | 
			
		||||
      return 8;  // 56 bits
 | 
			
		||||
    } else if (value < (1ULL << 63)) {
 | 
			
		||||
      return 9;  // 63 bits
 | 
			
		||||
    } else {
 | 
			
		||||
      return 10;  // 64 bits (maximum for uint64_t)
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode an int32_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * Special handling is needed for negative values, which are sign-extended to 64 bits
 | 
			
		||||
   * in Protocol Buffers, resulting in a 10-byte varint.
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The int32_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(int32_t value) {
 | 
			
		||||
    // Negative values are sign-extended to 64 bits in protocol buffers,
 | 
			
		||||
    // which always results in a 10-byte varint for negative int32
 | 
			
		||||
    if (value < 0) {
 | 
			
		||||
      return 10;  // Negative int32 is always 10 bytes long
 | 
			
		||||
    }
 | 
			
		||||
    // For non-negative values, use the uint32_t implementation
 | 
			
		||||
    return varint(static_cast<uint32_t>(value));
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode an int64_t value as a varint
 | 
			
		||||
   *
 | 
			
		||||
   * @param value The int64_t value to calculate size for
 | 
			
		||||
   * @return The number of bytes needed to encode the value
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t varint(int64_t value) {
 | 
			
		||||
    // For int64_t, we convert to uint64_t and calculate the size
 | 
			
		||||
    // This works because the bit pattern determines the encoding size,
 | 
			
		||||
    // and we've handled negative int32 values as a special case above
 | 
			
		||||
    return varint(static_cast<uint64_t>(value));
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates the size in bytes needed to encode a field ID and wire type
 | 
			
		||||
   *
 | 
			
		||||
   * @param field_id The field identifier
 | 
			
		||||
   * @param type The wire type value (from the WireType enum in the protobuf spec)
 | 
			
		||||
   * @return The number of bytes needed to encode the field ID and wire type
 | 
			
		||||
   */
 | 
			
		||||
  static inline uint32_t field(uint32_t field_id, uint32_t type) {
 | 
			
		||||
    uint32_t tag = (field_id << 3) | (type & 0b111);
 | 
			
		||||
    return varint(tag);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Common parameters for all add_*_field methods
 | 
			
		||||
   *
 | 
			
		||||
   * All add_*_field methods follow these common patterns:
 | 
			
		||||
   *
 | 
			
		||||
   * @param total_size Reference to the total message size to update
 | 
			
		||||
   * @param field_id_size Pre-calculated size of the field ID in bytes
 | 
			
		||||
   * @param value The value to calculate size for (type varies)
 | 
			
		||||
   * @param force Whether to calculate size even if the value is default/zero/empty
 | 
			
		||||
   *
 | 
			
		||||
   * Each method follows this implementation pattern:
 | 
			
		||||
   * 1. Skip calculation if value is default (0, false, empty) and not forced
 | 
			
		||||
   * 2. Calculate the size based on the field's encoding rules
 | 
			
		||||
   * 3. Add the field_id_size + calculated value size to total_size
 | 
			
		||||
   */
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an int32 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_int32_field(uint32_t &total_size, uint32_t field_id_size, int32_t value) {
 | 
			
		||||
    // Skip calculation if value is zero
 | 
			
		||||
    if (value == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    if (value < 0) {
 | 
			
		||||
      // Negative values are encoded as 10-byte varints in protobuf
 | 
			
		||||
      total_size += field_id_size + 10;
 | 
			
		||||
    } else {
 | 
			
		||||
      // For non-negative values, use the standard varint size
 | 
			
		||||
      total_size += field_id_size + varint(static_cast<uint32_t>(value));
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an int32 field to the total message size (repeated field version)
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_int32_field_repeated(uint32_t &total_size, uint32_t field_id_size, int32_t value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    if (value < 0) {
 | 
			
		||||
      // Negative values are encoded as 10-byte varints in protobuf
 | 
			
		||||
      total_size += field_id_size + 10;
 | 
			
		||||
    } else {
 | 
			
		||||
      // For non-negative values, use the standard varint size
 | 
			
		||||
      total_size += field_id_size + varint(static_cast<uint32_t>(value));
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a uint32 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_uint32_field(uint32_t &total_size, uint32_t field_id_size, uint32_t value) {
 | 
			
		||||
    // Skip calculation if value is zero
 | 
			
		||||
    if (value == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a uint32 field to the total message size (repeated field version)
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_uint32_field_repeated(uint32_t &total_size, uint32_t field_id_size, uint32_t value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a boolean field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_bool_field(uint32_t &total_size, uint32_t field_id_size, bool value) {
 | 
			
		||||
    // Skip calculation if value is false
 | 
			
		||||
    if (!value) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Boolean fields always use 1 byte when true
 | 
			
		||||
    total_size += field_id_size + 1;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a boolean field to the total message size (repeated field version)
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_bool_field_repeated(uint32_t &total_size, uint32_t field_id_size, bool value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    // Boolean fields always use 1 byte
 | 
			
		||||
    total_size += field_id_size + 1;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a float field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_float_field(uint32_t &total_size, uint32_t field_id_size, float value) {
 | 
			
		||||
    if (value != 0.0f) {
 | 
			
		||||
      total_size += field_id_size + 4;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // NOTE: add_double_field removed - wire type 1 (64-bit: double) not supported
 | 
			
		||||
  // to reduce overhead on embedded systems
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a fixed32 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_fixed32_field(uint32_t &total_size, uint32_t field_id_size, uint32_t value) {
 | 
			
		||||
    if (value != 0) {
 | 
			
		||||
      total_size += field_id_size + 4;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // NOTE: add_fixed64_field removed - wire type 1 (64-bit: fixed64) not supported
 | 
			
		||||
  // to reduce overhead on embedded systems
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a sfixed32 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_sfixed32_field(uint32_t &total_size, uint32_t field_id_size, int32_t value) {
 | 
			
		||||
    if (value != 0) {
 | 
			
		||||
      total_size += field_id_size + 4;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // NOTE: add_sfixed64_field removed - wire type 1 (64-bit: sfixed64) not supported
 | 
			
		||||
  // to reduce overhead on embedded systems
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an enum field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * Enum fields are encoded as uint32 varints.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_enum_field(uint32_t &total_size, uint32_t field_id_size, uint32_t value) {
 | 
			
		||||
    // Skip calculation if value is zero
 | 
			
		||||
    if (value == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Enums are encoded as uint32
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an enum field to the total message size (repeated field version)
 | 
			
		||||
   *
 | 
			
		||||
   * Enum fields are encoded as uint32 varints.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_enum_field_repeated(uint32_t &total_size, uint32_t field_id_size, uint32_t value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    // Enums are encoded as uint32
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a sint32 field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * Sint32 fields use ZigZag encoding, which is more efficient for negative values.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_sint32_field(uint32_t &total_size, uint32_t field_id_size, int32_t value) {
 | 
			
		||||
    // Skip calculation if value is zero
 | 
			
		||||
    if (value == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // ZigZag encoding for sint32: (n << 1) ^ (n >> 31)
 | 
			
		||||
    uint32_t zigzag = (static_cast<uint32_t>(value) << 1) ^ (static_cast<uint32_t>(value >> 31));
 | 
			
		||||
    total_size += field_id_size + varint(zigzag);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a sint32 field to the total message size (repeated field version)
 | 
			
		||||
   *
 | 
			
		||||
   * Sint32 fields use ZigZag encoding, which is more efficient for negative values.
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_sint32_field_repeated(uint32_t &total_size, uint32_t field_id_size, int32_t value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    // ZigZag encoding for sint32: (n << 1) ^ (n >> 31)
 | 
			
		||||
    uint32_t zigzag = (static_cast<uint32_t>(value) << 1) ^ (static_cast<uint32_t>(value >> 31));
 | 
			
		||||
    total_size += field_id_size + varint(zigzag);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an int64 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_int64_field(uint32_t &total_size, uint32_t field_id_size, int64_t value) {
 | 
			
		||||
    // Skip calculation if value is zero
 | 
			
		||||
    if (value == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of an int64 field to the total message size (repeated field version)
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_int64_field_repeated(uint32_t &total_size, uint32_t field_id_size, int64_t value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a uint64 field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_uint64_field(uint32_t &total_size, uint32_t field_id_size, uint64_t value) {
 | 
			
		||||
    // Skip calculation if value is zero
 | 
			
		||||
    if (value == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a uint64 field to the total message size (repeated field version)
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_uint64_field_repeated(uint32_t &total_size, uint32_t field_id_size, uint64_t value) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    total_size += field_id_size + varint(value);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // NOTE: sint64 support functions (add_sint64_field, add_sint64_field_repeated) removed
 | 
			
		||||
  // sint64 type is not supported by ESPHome API to reduce overhead on embedded systems
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a string field using length
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_string_field(uint32_t &total_size, uint32_t field_id_size, size_t len) {
 | 
			
		||||
    // Skip calculation if string is empty
 | 
			
		||||
    if (len == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Field ID + length varint + string bytes
 | 
			
		||||
    total_size += field_id_size + varint(static_cast<uint32_t>(len)) + static_cast<uint32_t>(len);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a string/bytes field to the total message size (repeated field version)
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_string_field_repeated(uint32_t &total_size, uint32_t field_id_size, const std::string &str) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    const uint32_t str_size = static_cast<uint32_t>(str.size());
 | 
			
		||||
    total_size += field_id_size + varint(str_size) + str_size;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a bytes field to the total message size
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_bytes_field(uint32_t &total_size, uint32_t field_id_size, size_t len) {
 | 
			
		||||
    // Skip calculation if bytes is empty
 | 
			
		||||
    if (len == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Field ID + length varint + data bytes
 | 
			
		||||
    total_size += field_id_size + varint(static_cast<uint32_t>(len)) + static_cast<uint32_t>(len);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a nested message field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * This helper function directly updates the total_size reference if the nested size
 | 
			
		||||
   * is greater than zero.
 | 
			
		||||
   *
 | 
			
		||||
   * @param nested_size The pre-calculated size of the nested message
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_message_field(uint32_t &total_size, uint32_t field_id_size, uint32_t nested_size) {
 | 
			
		||||
    // Skip calculation if nested message is empty
 | 
			
		||||
    if (nested_size == 0) {
 | 
			
		||||
      return;  // No need to update total_size
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Calculate and directly add to total_size
 | 
			
		||||
    // Field ID + length varint + nested message content
 | 
			
		||||
    total_size += field_id_size + varint(nested_size) + nested_size;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a nested message field to the total message size (repeated field version)
 | 
			
		||||
   *
 | 
			
		||||
   * @param nested_size The pre-calculated size of the nested message
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_message_field_repeated(uint32_t &total_size, uint32_t field_id_size, uint32_t nested_size) {
 | 
			
		||||
    // Always calculate size for repeated fields
 | 
			
		||||
    // Field ID + length varint + nested message content
 | 
			
		||||
    total_size += field_id_size + varint(nested_size) + nested_size;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a nested message field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * This version takes a ProtoMessage object, calculates its size internally,
 | 
			
		||||
   * and updates the total_size reference. This eliminates the need for a temporary variable
 | 
			
		||||
   * at the call site.
 | 
			
		||||
   *
 | 
			
		||||
   * @param message The nested message object
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_message_object(uint32_t &total_size, uint32_t field_id_size, const ProtoMessage &message) {
 | 
			
		||||
    uint32_t nested_size = 0;
 | 
			
		||||
    message.calculate_size(nested_size);
 | 
			
		||||
 | 
			
		||||
    // Use the base implementation with the calculated nested_size
 | 
			
		||||
    add_message_field(total_size, field_id_size, nested_size);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the size of a nested message field to the total message size (repeated field version)
 | 
			
		||||
   *
 | 
			
		||||
   * @param message The nested message object
 | 
			
		||||
   */
 | 
			
		||||
  static inline void add_message_object_repeated(uint32_t &total_size, uint32_t field_id_size,
 | 
			
		||||
                                                 const ProtoMessage &message) {
 | 
			
		||||
    uint32_t nested_size = 0;
 | 
			
		||||
    message.calculate_size(nested_size);
 | 
			
		||||
 | 
			
		||||
    // Use the base implementation with the calculated nested_size
 | 
			
		||||
    add_message_field_repeated(total_size, field_id_size, nested_size);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * @brief Calculates and adds the sizes of all messages in a repeated field to the total message size
 | 
			
		||||
   *
 | 
			
		||||
   * This helper processes a vector of message objects, calculating the size for each message
 | 
			
		||||
   * and adding it to the total size.
 | 
			
		||||
   *
 | 
			
		||||
   * @tparam MessageType The type of the nested messages in the vector
 | 
			
		||||
   * @param messages Vector of message objects
 | 
			
		||||
   */
 | 
			
		||||
  template<typename MessageType>
 | 
			
		||||
  static inline void add_repeated_message(uint32_t &total_size, uint32_t field_id_size,
 | 
			
		||||
                                          const std::vector<MessageType> &messages) {
 | 
			
		||||
    // Skip if the vector is empty
 | 
			
		||||
    if (messages.empty()) {
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Use the repeated field version for all messages
 | 
			
		||||
    for (const auto &message : messages) {
 | 
			
		||||
      add_message_object_repeated(total_size, field_id_size, message);
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Implementation of encode_message - must be after ProtoMessage is defined
 | 
			
		||||
inline void ProtoWriteBuffer::encode_message(uint32_t field_id, const ProtoMessage &value, bool force) {
 | 
			
		||||
  this->encode_field_raw(field_id, 2);  // type 2: Length-delimited message
 | 
			
		||||
 | 
			
		||||
  // Calculate the message size first
 | 
			
		||||
  uint32_t msg_length_bytes = 0;
 | 
			
		||||
  value.calculate_size(msg_length_bytes);
 | 
			
		||||
 | 
			
		||||
  // Calculate how many bytes the length varint needs
 | 
			
		||||
  uint32_t varint_length_bytes = ProtoSize::varint(msg_length_bytes);
 | 
			
		||||
 | 
			
		||||
  // Reserve exact space for the length varint
 | 
			
		||||
  size_t begin = this->buffer_->size();
 | 
			
		||||
  this->buffer_->resize(this->buffer_->size() + varint_length_bytes);
 | 
			
		||||
 | 
			
		||||
  // Write the length varint directly
 | 
			
		||||
  ProtoVarInt(msg_length_bytes).encode_to_buffer_unchecked(this->buffer_->data() + begin, varint_length_bytes);
 | 
			
		||||
 | 
			
		||||
  // Now encode the message content - it will append to the buffer
 | 
			
		||||
  value.encode(*this);
 | 
			
		||||
 | 
			
		||||
  // Verify that the encoded size matches what we calculated
 | 
			
		||||
  assert(this->buffer_->size() == begin + varint_length_bytes + msg_length_bytes);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Implementation of decode_to_message - must be after ProtoDecodableMessage is defined
 | 
			
		||||
inline void ProtoLengthDelimited::decode_to_message(ProtoDecodableMessage &msg) const {
 | 
			
		||||
  msg.decode(this->value_, this->length_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
template<typename T> const char *proto_enum_to_string(T value);
 | 
			
		||||
 | 
			
		||||
class ProtoService {
 | 
			
		||||
@@ -350,7 +859,9 @@ class ProtoService {
 | 
			
		||||
  virtual bool is_authenticated() = 0;
 | 
			
		||||
  virtual bool is_connection_setup() = 0;
 | 
			
		||||
  virtual void on_fatal_error() = 0;
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
  virtual void on_unauthenticated_access() = 0;
 | 
			
		||||
#endif
 | 
			
		||||
  virtual void on_no_setup_connection() = 0;
 | 
			
		||||
  /**
 | 
			
		||||
   * Create a buffer with a reserved size.
 | 
			
		||||
@@ -360,11 +871,11 @@ class ProtoService {
 | 
			
		||||
   * @return A ProtoWriteBuffer object with the reserved size.
 | 
			
		||||
   */
 | 
			
		||||
  virtual ProtoWriteBuffer create_buffer(uint32_t reserve_size) = 0;
 | 
			
		||||
  virtual bool send_buffer(ProtoWriteBuffer buffer, uint16_t message_type) = 0;
 | 
			
		||||
  virtual bool read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) = 0;
 | 
			
		||||
  virtual bool send_buffer(ProtoWriteBuffer buffer, uint8_t message_type) = 0;
 | 
			
		||||
  virtual void read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) = 0;
 | 
			
		||||
 | 
			
		||||
  // Optimized method that pre-allocates buffer based on message size
 | 
			
		||||
  bool send_message_(const ProtoMessage &msg, uint16_t message_type) {
 | 
			
		||||
  bool send_message_(const ProtoMessage &msg, uint8_t message_type) {
 | 
			
		||||
    uint32_t msg_size = 0;
 | 
			
		||||
    msg.calculate_size(msg_size);
 | 
			
		||||
 | 
			
		||||
@@ -377,7 +888,30 @@ class ProtoService {
 | 
			
		||||
    // Send the buffer
 | 
			
		||||
    return this->send_buffer(buffer, message_type);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Authentication helper methods
 | 
			
		||||
  bool check_connection_setup_() {
 | 
			
		||||
    if (!this->is_connection_setup()) {
 | 
			
		||||
      this->on_no_setup_connection();
 | 
			
		||||
      return false;
 | 
			
		||||
    }
 | 
			
		||||
    return true;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  bool check_authenticated_() {
 | 
			
		||||
#ifdef USE_API_PASSWORD
 | 
			
		||||
    if (!this->check_connection_setup_()) {
 | 
			
		||||
      return false;
 | 
			
		||||
    }
 | 
			
		||||
    if (!this->is_authenticated()) {
 | 
			
		||||
      this->on_unauthenticated_access();
 | 
			
		||||
      return false;
 | 
			
		||||
    }
 | 
			
		||||
    return true;
 | 
			
		||||
#else
 | 
			
		||||
    return this->check_connection_setup_();
 | 
			
		||||
#endif
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
 
 | 
			
		||||
@@ -3,78 +3,70 @@
 | 
			
		||||
#include "api_connection.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
// Generate entity handler implementations using macros
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
bool InitialStateIterator::on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) {
 | 
			
		||||
  return this->client_->send_binary_sensor_state(binary_sensor);
 | 
			
		||||
}
 | 
			
		||||
INITIAL_STATE_HANDLER(binary_sensor, binary_sensor::BinarySensor)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
bool InitialStateIterator::on_cover(cover::Cover *cover) { return this->client_->send_cover_state(cover); }
 | 
			
		||||
INITIAL_STATE_HANDLER(cover, cover::Cover)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_FAN
 | 
			
		||||
bool InitialStateIterator::on_fan(fan::Fan *fan) { return this->client_->send_fan_state(fan); }
 | 
			
		||||
INITIAL_STATE_HANDLER(fan, fan::Fan)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LIGHT
 | 
			
		||||
bool InitialStateIterator::on_light(light::LightState *light) { return this->client_->send_light_state(light); }
 | 
			
		||||
INITIAL_STATE_HANDLER(light, light::LightState)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SENSOR
 | 
			
		||||
bool InitialStateIterator::on_sensor(sensor::Sensor *sensor) { return this->client_->send_sensor_state(sensor); }
 | 
			
		||||
INITIAL_STATE_HANDLER(sensor, sensor::Sensor)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SWITCH
 | 
			
		||||
bool InitialStateIterator::on_switch(switch_::Switch *a_switch) { return this->client_->send_switch_state(a_switch); }
 | 
			
		||||
INITIAL_STATE_HANDLER(switch, switch_::Switch)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT_SENSOR
 | 
			
		||||
bool InitialStateIterator::on_text_sensor(text_sensor::TextSensor *text_sensor) {
 | 
			
		||||
  return this->client_->send_text_sensor_state(text_sensor);
 | 
			
		||||
}
 | 
			
		||||
INITIAL_STATE_HANDLER(text_sensor, text_sensor::TextSensor)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
bool InitialStateIterator::on_climate(climate::Climate *climate) { return this->client_->send_climate_state(climate); }
 | 
			
		||||
INITIAL_STATE_HANDLER(climate, climate::Climate)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_NUMBER
 | 
			
		||||
bool InitialStateIterator::on_number(number::Number *number) { return this->client_->send_number_state(number); }
 | 
			
		||||
INITIAL_STATE_HANDLER(number, number::Number)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATE
 | 
			
		||||
bool InitialStateIterator::on_date(datetime::DateEntity *date) { return this->client_->send_date_state(date); }
 | 
			
		||||
INITIAL_STATE_HANDLER(date, datetime::DateEntity)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_TIME
 | 
			
		||||
bool InitialStateIterator::on_time(datetime::TimeEntity *time) { return this->client_->send_time_state(time); }
 | 
			
		||||
INITIAL_STATE_HANDLER(time, datetime::TimeEntity)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATETIME
 | 
			
		||||
bool InitialStateIterator::on_datetime(datetime::DateTimeEntity *datetime) {
 | 
			
		||||
  return this->client_->send_datetime_state(datetime);
 | 
			
		||||
}
 | 
			
		||||
INITIAL_STATE_HANDLER(datetime, datetime::DateTimeEntity)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT
 | 
			
		||||
bool InitialStateIterator::on_text(text::Text *text) { return this->client_->send_text_state(text); }
 | 
			
		||||
INITIAL_STATE_HANDLER(text, text::Text)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SELECT
 | 
			
		||||
bool InitialStateIterator::on_select(select::Select *select) { return this->client_->send_select_state(select); }
 | 
			
		||||
INITIAL_STATE_HANDLER(select, select::Select)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LOCK
 | 
			
		||||
bool InitialStateIterator::on_lock(lock::Lock *a_lock) { return this->client_->send_lock_state(a_lock); }
 | 
			
		||||
INITIAL_STATE_HANDLER(lock, lock::Lock)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VALVE
 | 
			
		||||
bool InitialStateIterator::on_valve(valve::Valve *valve) { return this->client_->send_valve_state(valve); }
 | 
			
		||||
INITIAL_STATE_HANDLER(valve, valve::Valve)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
bool InitialStateIterator::on_media_player(media_player::MediaPlayer *media_player) {
 | 
			
		||||
  return this->client_->send_media_player_state(media_player);
 | 
			
		||||
}
 | 
			
		||||
INITIAL_STATE_HANDLER(media_player, media_player::MediaPlayer)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
bool InitialStateIterator::on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) {
 | 
			
		||||
  return this->client_->send_alarm_control_panel_state(a_alarm_control_panel);
 | 
			
		||||
}
 | 
			
		||||
INITIAL_STATE_HANDLER(alarm_control_panel, alarm_control_panel::AlarmControlPanel)
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_UPDATE
 | 
			
		||||
bool InitialStateIterator::on_update(update::UpdateEntity *update) { return this->client_->send_update_state(update); }
 | 
			
		||||
INITIAL_STATE_HANDLER(update, update::UpdateEntity)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
// Special cases (button and event) are already defined inline in subscribe_state.h
 | 
			
		||||
 | 
			
		||||
InitialStateIterator::InitialStateIterator(APIConnection *client) : client_(client) {}
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -5,76 +5,82 @@
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/component_iterator.h"
 | 
			
		||||
#include "esphome/core/controller.h"
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
class APIConnection;
 | 
			
		||||
 | 
			
		||||
// Macro for generating InitialStateIterator handlers
 | 
			
		||||
// Calls send_*_state
 | 
			
		||||
#define INITIAL_STATE_HANDLER(entity_type, EntityClass) \
 | 
			
		||||
  bool InitialStateIterator::on_##entity_type(EntityClass *entity) { /* NOLINT(bugprone-macro-parentheses) */ \
 | 
			
		||||
    return this->client_->send_##entity_type##_state(entity); \
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
class InitialStateIterator : public ComponentIterator {
 | 
			
		||||
 public:
 | 
			
		||||
  InitialStateIterator(APIConnection *client);
 | 
			
		||||
#ifdef USE_BINARY_SENSOR
 | 
			
		||||
  bool on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) override;
 | 
			
		||||
  bool on_binary_sensor(binary_sensor::BinarySensor *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_COVER
 | 
			
		||||
  bool on_cover(cover::Cover *cover) override;
 | 
			
		||||
  bool on_cover(cover::Cover *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_FAN
 | 
			
		||||
  bool on_fan(fan::Fan *fan) override;
 | 
			
		||||
  bool on_fan(fan::Fan *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LIGHT
 | 
			
		||||
  bool on_light(light::LightState *light) override;
 | 
			
		||||
  bool on_light(light::LightState *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SENSOR
 | 
			
		||||
  bool on_sensor(sensor::Sensor *sensor) override;
 | 
			
		||||
  bool on_sensor(sensor::Sensor *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SWITCH
 | 
			
		||||
  bool on_switch(switch_::Switch *a_switch) override;
 | 
			
		||||
  bool on_switch(switch_::Switch *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
  bool on_button(button::Button *button) override { return true; };
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT_SENSOR
 | 
			
		||||
  bool on_text_sensor(text_sensor::TextSensor *text_sensor) override;
 | 
			
		||||
  bool on_text_sensor(text_sensor::TextSensor *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_CLIMATE
 | 
			
		||||
  bool on_climate(climate::Climate *climate) override;
 | 
			
		||||
  bool on_climate(climate::Climate *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_NUMBER
 | 
			
		||||
  bool on_number(number::Number *number) override;
 | 
			
		||||
  bool on_number(number::Number *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATE
 | 
			
		||||
  bool on_date(datetime::DateEntity *date) override;
 | 
			
		||||
  bool on_date(datetime::DateEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_TIME
 | 
			
		||||
  bool on_time(datetime::TimeEntity *time) override;
 | 
			
		||||
  bool on_time(datetime::TimeEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_DATETIME_DATETIME
 | 
			
		||||
  bool on_datetime(datetime::DateTimeEntity *datetime) override;
 | 
			
		||||
  bool on_datetime(datetime::DateTimeEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_TEXT
 | 
			
		||||
  bool on_text(text::Text *text) override;
 | 
			
		||||
  bool on_text(text::Text *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_SELECT
 | 
			
		||||
  bool on_select(select::Select *select) override;
 | 
			
		||||
  bool on_select(select::Select *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_LOCK
 | 
			
		||||
  bool on_lock(lock::Lock *a_lock) override;
 | 
			
		||||
  bool on_lock(lock::Lock *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VALVE
 | 
			
		||||
  bool on_valve(valve::Valve *valve) override;
 | 
			
		||||
  bool on_valve(valve::Valve *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
  bool on_media_player(media_player::MediaPlayer *media_player) override;
 | 
			
		||||
  bool on_media_player(media_player::MediaPlayer *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
  bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) override;
 | 
			
		||||
  bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_EVENT
 | 
			
		||||
  bool on_event(event::Event *event) override { return true; };
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_UPDATE
 | 
			
		||||
  bool on_update(update::UpdateEntity *update) override;
 | 
			
		||||
  bool on_update(update::UpdateEntity *entity) override;
 | 
			
		||||
#endif
 | 
			
		||||
  bool completed() { return this->state_ == IteratorState::NONE; }
 | 
			
		||||
 | 
			
		||||
@@ -82,6 +88,5 @@ class InitialStateIterator : public ComponentIterator {
 | 
			
		||||
  APIConnection *client_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,8 +1,7 @@
 | 
			
		||||
#include "user_services.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
template<> bool get_execute_arg_value<bool>(const ExecuteServiceArgument &arg) { return arg.bool_; }
 | 
			
		||||
template<> int32_t get_execute_arg_value<int32_t>(const ExecuteServiceArgument &arg) {
 | 
			
		||||
@@ -40,5 +39,4 @@ template<> enums::ServiceArgType to_service_arg_type<std::vector<std::string>>()
 | 
			
		||||
  return enums::SERVICE_ARG_TYPE_STRING_ARRAY;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
 
 | 
			
		||||
@@ -7,14 +7,16 @@
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
#ifdef USE_API_SERVICES
 | 
			
		||||
namespace esphome::api {
 | 
			
		||||
 | 
			
		||||
class UserServiceDescriptor {
 | 
			
		||||
 public:
 | 
			
		||||
  virtual ListEntitiesServicesResponse encode_list_service_response() = 0;
 | 
			
		||||
 | 
			
		||||
  virtual bool execute_service(const ExecuteServiceRequest &req) = 0;
 | 
			
		||||
 | 
			
		||||
  bool is_internal() { return false; }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
template<typename T> T get_execute_arg_value(const ExecuteServiceArgument &arg);
 | 
			
		||||
@@ -30,14 +32,14 @@ template<typename... Ts> class UserServiceBase : public UserServiceDescriptor {
 | 
			
		||||
 | 
			
		||||
  ListEntitiesServicesResponse encode_list_service_response() override {
 | 
			
		||||
    ListEntitiesServicesResponse msg;
 | 
			
		||||
    msg.name = this->name_;
 | 
			
		||||
    msg.set_name(StringRef(this->name_));
 | 
			
		||||
    msg.key = this->key_;
 | 
			
		||||
    std::array<enums::ServiceArgType, sizeof...(Ts)> arg_types = {to_service_arg_type<Ts>()...};
 | 
			
		||||
    for (int i = 0; i < sizeof...(Ts); i++) {
 | 
			
		||||
      ListEntitiesServicesArgument arg;
 | 
			
		||||
      msg.args.emplace_back();
 | 
			
		||||
      auto &arg = msg.args.back();
 | 
			
		||||
      arg.type = arg_types[i];
 | 
			
		||||
      arg.name = this->arg_names_[i];
 | 
			
		||||
      msg.args.push_back(arg);
 | 
			
		||||
      arg.set_name(StringRef(this->arg_names_[i]));
 | 
			
		||||
    }
 | 
			
		||||
    return msg;
 | 
			
		||||
  }
 | 
			
		||||
@@ -71,5 +73,5 @@ template<typename... Ts> class UserServiceTrigger : public UserServiceBase<Ts...
 | 
			
		||||
  void execute(Ts... x) override { this->trigger(x...); }  // NOLINT
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
}  // namespace esphome::api
 | 
			
		||||
#endif  // USE_API_SERVICES
 | 
			
		||||
 
 | 
			
		||||
@@ -7,8 +7,6 @@ namespace as3935 {
 | 
			
		||||
static const char *const TAG = "as3935";
 | 
			
		||||
 | 
			
		||||
void AS3935Component::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Running setup");
 | 
			
		||||
 | 
			
		||||
  this->irq_pin_->setup();
 | 
			
		||||
  LOG_PIN("  IRQ Pin: ", this->irq_pin_);
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -7,9 +7,7 @@ namespace as3935_spi {
 | 
			
		||||
static const char *const TAG = "as3935_spi";
 | 
			
		||||
 | 
			
		||||
void SPIAS3935Component::setup() {
 | 
			
		||||
  ESP_LOGI(TAG, "SPIAS3935Component setup started!");
 | 
			
		||||
  this->spi_setup();
 | 
			
		||||
  ESP_LOGI(TAG, "SPI setup finished!");
 | 
			
		||||
  AS3935Component::setup();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user