SNTP Helper

[中文]

• Public header: #include "brookesia/service_helper/network/sntp.hpp"

Overview

This page documents the SNTP helper Doxygen API: server, timezone, synchronization state, event helpers, and related macros.

API Reference

Header File

• service/framework/brookesia_service_helper/include/brookesia/service_helper/network/sntp.hpp

Classes

class SNTP : public esp_brookesia::service::helper::Base<SNTP>

Helper schema definitions for the SNTP service.

Public Types

enum class State

SNTP synchronization state.

Values:

enumerator Stopped

enumerator CheckingNetwork

enumerator Syncing

enumerator Synced

enumerator Max

enum class FunctionId

SNTP service function identifiers.

Values:

enumerator SetServers

enumerator SetTimezone

enumerator Start

enumerator Stop

enumerator GetServers

enumerator GetTimezone

enumerator GetState

enumerator IsTimeSynced

enumerator LoadData

enumerator ResetData

enumerator Max

enum class EventId

SNTP service event identifiers.

Values:

enumerator StateChanged

enumerator TimezoneChanged

enumerator Max

enum class FunctionSetServersParam

Parameter keys for FunctionId::SetServers.

Values:

enumerator Servers

enum class FunctionSetTimezoneParam

Parameter keys for FunctionId::SetTimezone.

Values:

enumerator Timezone

enum class EventStateChangedParam

Event keys for EventId::StateChanged.

Values:

enumerator State

enum class EventTimezoneChangedParam

Event keys for EventId::TimezoneChanged.

Values:

enumerator Timezone

Public Static Functions

static inline constexpr std::string_view get_name()

Name of the SNTP service.

Returns

std::string_view Stable service name.

static inline std::span<const FunctionSchema> get_function_schemas()

Get the function schemas exported by the SNTP service.

Returns

std::span<const FunctionSchema> Static schema span.

static inline std::span<const EventSchema> get_event_schemas()

Get the event schemas exported by the SNTP service.

Returns

std::span<const EventSchema> Static event schema span.