Trade-offs and warnings
Consult the linked header for this operation’s ownership, lifetime and failure behavior.
EPOK RUNTIME
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.
Kernel memory access (RAM, I/O, flash), up to 128 bytes.
PocketError read_memory(uint32_t address, void* out, uint8_t size, unsigned port = 0)Kernel memory access (RAM, I/O, flash), up to 128 bytes.
| Parameter | Type | Meaning |
|---|---|---|
address | uint32_t | Not documented; consult the linked header. |
out | void * | Not documented; consult the linked header. |
size | uint8_t | Not documented; consult the linked header. |
port | unsigned int | Not documented; consult the linked header. |
Returns: PocketError. Consult the linked header for its meaning.
#include "pocketstation.hpp"
// Assume these named values have been initialized with valid data:
// uint32_t address
// void * out
// uint8_t size
// unsigned int port
epok::PocketStationService& object = /* obtain a valid instance */;
auto result = object.read_memory(address, out, size, port);Consult the linked header for this operation’s ownership, lifetime and failure behavior.
Declared in runtime/pocketstation.hpp:358
callCalls link function `function` of the running program.MethodconnectedPerforms `connected` as part of the pocketstation module.MethodfindFinds a file by name; `*block` receives its first block.MethodinstallCopies an embedded program to the card (replacing an older copy) and returns its first block.Methodinstall_and_launchInstalls (if needed) and starts an embedded program.MethodlaunchStarts the program whose first block is `block` (0 = start-up screen).MethodprobeTrue when a PocketStation (not a plain memory card) is in the slot.Methodread_directoryReads the 16 directory frames (block 0) in one batch.Methodread_sectorReads sector as part of the pocketstation module.MethodreceivePocket Lua link: the message published with `link.send(n)`; size 0 when none.MethodsendPocket Lua link: a message for `link.received()` / `link.byte(i)`.Methodset_ledThe red LED (through the PocketStation's I/O port).Method