Epok Engine

EPOK RUNTIME

epok::PocketStationService::set_time

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Sets the clock (year 1900-2099).

Belongs to
epok::PocketStationService
Header
pocketstation.hpp
Overloads
1

Declaration

Declaration
PocketError set_time(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint8_t weekday, unsigned port = 0)

Sets the clock (year 1900-2099).

ParameterTypeMeaning
yearuint16_tNot documented; consult the linked header.
monthuint8_tNot documented; consult the linked header.
dayuint8_tNot documented; consult the linked header.
houruint8_tNot documented; consult the linked header.
minuteuint8_tNot documented; consult the linked header.
seconduint8_tNot documented; consult the linked header.
weekdayuint8_tNot documented; consult the linked header.
portunsigned intNot documented; consult the linked header.

Returns: PocketError. Consult the linked header for its meaning.

Example sketch

C++ example
#include "pocketstation.hpp"

// Assume these named values have been initialized with valid data:
// uint16_t year
// uint8_t month
// uint8_t day
// uint8_t hour
// uint8_t minute
// uint8_t second
// uint8_t weekday
// unsigned int port

epok::PocketStationService& object = /* obtain a valid instance */;

auto result = object.set_time(year, month, day, hour, minute, second, weekday, port);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/pocketstation.hpp:378

Related members