@@ -298,112 +298,112 @@ void loop() {
298298
299299## 🔧 API Reference
300300
301- # GeoLinker API Reference
301+ ### GeoLinker API Reference
302302
303- ## Common Methods
303+ ### Common Methods
304304
305- ### `void setApiKey(const String& key)`
305+ #### `void setApiKey(const String& key)`
306306Set your GeoLinker API key.
307307- **Parameters:** `key` — API key string
308308
309- ### `void setDeviceID(const String& id)`
309+ #### `void setDeviceID(const String& id)`
310310Set the unique device identifier.
311311- **Parameters:** `id` — Device name or ID
312312
313- ### `void setUpdateInterval_seconds(uint32_t interval_s)`
313+ #### `void setUpdateInterval_seconds(uint32_t interval_s)`
314314Set data upload interval (in seconds).
315315- **Parameters:** `interval_s` — Interval in seconds (default: 60)
316316
317- ### `void setDebugLevel(uint8_t level)`
317+ #### `void setDebugLevel(uint8_t level)`
318318Set debug verbosity.
319319- **Parameters:** `level` — `DEBUG_NONE` (0), `DEBUG_BASIC` (1), `DEBUG_VERBOSE` (2)
320320
321- ### `void enableOfflineStorage(bool enable)`
321+ #### `void enableOfflineStorage(bool enable)`
322322Enable/disable offline data buffering.
323323- **Parameters:** `enable` — `true` to enable
324324
325- ### `void enableAutoReconnect(bool enable)`
325+ #### `void enableAutoReconnect(bool enable)`
326326Enable/disable automatic reconnection (WiFi or GSM).
327327- **Parameters:** `enable` — `true` to enable
328328
329- ### `void setPayloads(const std::map<String, float>& payloads)`
329+ #### `void setPayloads(const std::map<String, float>& payloads)`
330330Set additional sensor data.
331331- **Parameters:** `payloads` — Map of sensor names/values (max 5)
332332
333- ### `void setBatteryLevel(uint8_t percent)`
333+ #### `void setBatteryLevel(uint8_t percent)`
334334Set battery level for reporting.
335335- **Parameters:** `percent` — Battery % (0–100)
336336
337- ### `void setTimeOffset(int hourOffset, int minuteOffset)`
337+ #### `void setTimeOffset(int hourOffset, int minuteOffset)`
338338Set timezone offset from UTC.
339339- **Parameters:**
340340 - `hourOffset` (int): Hours offset
341341 - `minuteOffset` (int): Minutes offset
342342
343- ### `void setOfflineBufferLimit(uint8_t limit)`
343+ #### `void setOfflineBufferLimit(uint8_t limit)`
344344Set offline buffer size.
345345- **Parameters:** `limit` — Max entries (default: 100)
346346
347- ### `void setNetworkMode(NetworkBackendType mode)`
347+ #### `void setNetworkMode(NetworkBackendType mode)`
348348Set backend to WiFi or GSM/Cellular.
349349- **Parameters:** `mode` — `GEOLINKER_WIFI` or `GEOLINKER_CELLULAR`
350350
351- ### `uint8_t loop()`
351+ #### `uint8_t loop()`
352352Main library function; call regularly in your loop.
353353- **Returns:** Status code (see Status Codes table)
354354
355355---
356356
357- ## WiFi Related Methods
357+ ### WiFi Related Methods
358358
359- ### `void setWiFiCredentials(const char* ssid, const char* password)`
359+ #### `void setWiFiCredentials(const char* ssid, const char* password)`
360360Set WiFi credentials.
361361- **Parameters:**
362362 - `ssid`: WiFi network name
363363 - `password`: WiFi password
364364
365- ### `bool connectToWiFi()`
365+ #### `bool connectToWiFi()`
366366Connect to WiFi using stored credentials.
367367- **Returns:** `true` if connected successfully
368368
369369---
370370
371- ## GSM/Cellular Related Methods
371+ ### GSM/Cellular Related Methods
372372
373- ### `void setModemCredentials(const char* apn, const char* user = nullptr, const char* pass = nullptr)`
373+ #### `void setModemCredentials(const char* apn, const char* user = nullptr, const char* pass = nullptr)`
374374Set APN/credentials for GSM modem.
375375- **Parameters:**
376376 - `apn`: Access Point Name
377377 - `user`: Username (optional)
378378 - `pass`: Password (optional)
379379
380- ### `void beginModem(Stream& serial, uint8_t powerPin = 255, uint8_t resetPin = 255, bool autoPowerCycle = false)`
380+ #### `void beginModem(Stream& serial, uint8_t powerPin = 255, uint8_t resetPin = 255, bool autoPowerCycle = false)`
381381Initialise GSM modem interface.
382382- **Parameters:**
383383 - `serial`: Serial interface for modem
384384 - `powerPin`: (Optional) Modem power pin
385385 - `resetPin`: (Optional) Modem reset pin
386386 - `autoPowerCycle`: (Optional) Power cycle at startup
387387
388- ### `void setModemTimeouts(uint32_t commandTimeoutMs = 5000, uint32_t httpTimeoutMs = 10000)`
388+ #### `void setModemTimeouts(uint32_t commandTimeoutMs = 5000, uint32_t httpTimeoutMs = 10000)`
389389Configure GSM modem timeouts.
390390- **Parameters:**
391391 - `commandTimeoutMs`: AT command timeout
392392 - `httpTimeoutMs`: HTTP timeout
393393
394- ### `int getModemNetworkStatus()`
394+ #### `int getModemNetworkStatus()`
395395Get modem network registration status.
396396- **Returns:** Registration status code
397397
398- ### `int getModemGprsStatus()`
398+ #### `int getModemGprsStatus()`
399399Get modem GPRS context status.
400400- **Returns:** 1 if attached, 0 otherwise
401401
402402---
403403
404- ## GPS Related Methods
404+ ### GPS Related Methods
405405
406- ### `bool begin(Stream& serial)`
406+ #### `bool begin(Stream& serial)`
407407Initialise GeoLinker with GPS serial connection.
408408- **Parameters:** `serial` — Serial stream (e.g. `Serial1`, `SoftwareSerial`)
409409- **Returns:** `true` if successful
0 commit comments