ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::vnc Namespace Reference

Data Structures

class  VncClient
 RFB (VNC) client that draws the remote framebuffer into a display. More...
 

Enumerations

enum class  VncPixelFormat : uint8_t { VNC_PIXEL_FORMAT_AUTO , VNC_PIXEL_FORMAT_RGB565 , VNC_PIXEL_FORMAT_RGB332 }
 
enum class  VncKeyAction : uint8_t { VNC_KEY_ACTION_PRESS , VNC_KEY_ACTION_DOWN , VNC_KEY_ACTION_UP }
 
enum class  VncState : uint8_t {
  VNC_STATE_IDLE , VNC_STATE_HANDSHAKE , VNC_STATE_RUNNING , VNC_STATE_STOPPED ,
  VNC_STATE_AUTH_FAILED
}
 
enum class  VncStep : uint8_t {
  VNC_STEP_VERSION , VNC_STEP_SECURITY_COUNT , VNC_STEP_SECURITY_LIST , VNC_STEP_SECURITY_TYPE_33 ,
  VNC_STEP_CHALLENGE , VNC_STEP_SECURITY_RESULT , VNC_STEP_REASON_LENGTH , VNC_STEP_REASON ,
  VNC_STEP_SERVER_INIT , VNC_STEP_SERVER_NAME , VNC_STEP_SESSION_START , VNC_STEP_MESSAGE ,
  VNC_STEP_RECT , VNC_STEP_RECT_DONE , VNC_STEP_RAW , VNC_STEP_TILE ,
  VNC_STEP_TILE_RAW , VNC_STEP_SUBRECTS , VNC_STEP_SKIP
}
 
enum class  VncParse : uint8_t { VNC_PARSE_MORE , VNC_PARSE_PAUSE , VNC_PARSE_STOP }
 
enum class  VncFailure : uint8_t { VNC_FAILURE_TRANSIENT , VNC_FAILURE_CONFIG , VNC_FAILURE_AUTH , VNC_FAILURE_AUTH_AMBIGUOUS }
 

Functions

 ESPHOME_LOG_TAG (TAG, "vnc")
 
 PROGMEM_STRING_TABLE (PixelFormatStrings, "auto", "RGB565", "RGB332")
 
 for (uint8_t i=0;i< out_bits;i++)
 
void des_encrypt_block (const uint8_t key[8], uint8_t block[8])
 DES-ECB encryption of one block in place. The key is in normal DES byte order; parity bits are ignored.
 
void vnc_auth_response (const uint8_t *key_progmem, uint8_t challenge[16])
 VNC Authentication response: encrypts both 8-byte halves of the challenge in place.
 

Variables

static uint64_t const uint8_t * table
 
static uint64_t const uint8_t uint8_t out_bits
 
static uint64_t const uint8_t uint8_t uint8_t in_bits
 
return out
 

Enumeration Type Documentation

◆ VncFailure

enum class esphome::vnc::VncFailure : uint8_t
strong
Enumerator
VNC_FAILURE_TRANSIENT 
VNC_FAILURE_CONFIG 
VNC_FAILURE_AUTH 
VNC_FAILURE_AUTH_AMBIGUOUS 

Definition at line 67 of file vnc_client.h.

◆ VncKeyAction

enum class esphome::vnc::VncKeyAction : uint8_t
strong
Enumerator
VNC_KEY_ACTION_PRESS 
VNC_KEY_ACTION_DOWN 
VNC_KEY_ACTION_UP 

Definition at line 23 of file vnc_client.h.

◆ VncParse

enum class esphome::vnc::VncParse : uint8_t
strong
Enumerator
VNC_PARSE_MORE 
VNC_PARSE_PAUSE 
VNC_PARSE_STOP 

Definition at line 61 of file vnc_client.h.

◆ VncPixelFormat

enum class esphome::vnc::VncPixelFormat : uint8_t
strong
Enumerator
VNC_PIXEL_FORMAT_AUTO 
VNC_PIXEL_FORMAT_RGB565 
VNC_PIXEL_FORMAT_RGB332 

Definition at line 17 of file vnc_client.h.

◆ VncState

enum class esphome::vnc::VncState : uint8_t
strong
Enumerator
VNC_STATE_IDLE 
VNC_STATE_HANDSHAKE 
VNC_STATE_RUNNING 
VNC_STATE_STOPPED 
VNC_STATE_AUTH_FAILED 

Definition at line 29 of file vnc_client.h.

◆ VncStep

enum class esphome::vnc::VncStep : uint8_t
strong
Enumerator
VNC_STEP_VERSION 
VNC_STEP_SECURITY_COUNT 
VNC_STEP_SECURITY_LIST 
VNC_STEP_SECURITY_TYPE_33 
VNC_STEP_CHALLENGE 
VNC_STEP_SECURITY_RESULT 
VNC_STEP_REASON_LENGTH 
VNC_STEP_REASON 
VNC_STEP_SERVER_INIT 
VNC_STEP_SERVER_NAME 
VNC_STEP_SESSION_START 
VNC_STEP_MESSAGE 
VNC_STEP_RECT 
VNC_STEP_RECT_DONE 
VNC_STEP_RAW 
VNC_STEP_TILE 
VNC_STEP_TILE_RAW 
VNC_STEP_SUBRECTS 
VNC_STEP_SKIP 

Definition at line 37 of file vnc_client.h.

Function Documentation

◆ des_encrypt_block()

void esphome::vnc::des_encrypt_block ( const uint8_t key[8],
uint8_t block[8] )

DES-ECB encryption of one block in place. The key is in normal DES byte order; parity bits are ignored.

Definition at line 146 of file vnc_des.cpp.

◆ ESPHOME_LOG_TAG()

esphome::vnc::ESPHOME_LOG_TAG ( TAG ,
"vnc"  )

◆ for()

esphome::vnc::for ( )

Definition at line 95 of file vnc_des.cpp.

◆ PROGMEM_STRING_TABLE()

esphome::vnc::PROGMEM_STRING_TABLE ( PixelFormatStrings ,
"auto" ,
"RGB565" ,
"RGB332"  )

◆ vnc_auth_response()

void esphome::vnc::vnc_auth_response ( const uint8_t * key_progmem,
uint8_t challenge[16] )

VNC Authentication response: encrypts both 8-byte halves of the challenge in place.

key_progmem points to 8 bytes in PROGMEM, already bit-reversed per the VNC convention.

Definition at line 153 of file vnc_des.cpp.

Variable Documentation

◆ in_bits

uint64_t const uint8_t uint8_t uint8_t esphome::vnc::in_bits
Initial value:
{
uint64_t out = 0
std::vector< uint8_t > & out
Definition gif.cpp:49

Definition at line 93 of file vnc_des.cpp.

◆ out

return esphome::vnc::out

Definition at line 98 of file vnc_des.cpp.

◆ out_bits

uint64_t const uint8_t uint8_t esphome::vnc::out_bits

Definition at line 92 of file vnc_des.cpp.

◆ table

uint64_t const uint8_t* esphome::vnc::table

Definition at line 92 of file vnc_des.cpp.