Skip to content

v1.5.0

Latest
Latest

Choose a tag to compare

View all tags
@devArnoud devArnoud released this 24 Feb 13:37
v1.5.0
51b16ce
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Walter Modem Library Release Notes (ESP-IDF) v1.5.0

Breaking Changes

Event-Driven Architecture Refactor (#136)

The library has been modernized with a complete event-driven architecture, replacing the old polling-based approach. This change significantly improves efficiency and code maintainability but requires updates to existing code.

Key Breaking Changes:

  • Event Handler Signatures: All event handlers now use structured event data passed as const pointers. Old handler signatures will not compile. The new pattern is:

    void handler(WM<Protocol>EventType event, const WM<Protocol>EventData* data, void* args)

    This applies to Socket, HTTP, MQTT, CoAP, and GNSS protocols.

  • GNSS Assistance Structure: Changed from named fields to array indexing:

    // Old (broken): rsp.data.gnssAssistance.almanac.available
// New: rsp.data.gnssAssistance[WALTER_MODEM_GNSS_ASSISTANCE_TYPE_ALMANAC].available

Migration Benefits:

  • Non-blocking, event-driven architecture
  • Efficient handling of multiple rapid events
  • Consistent API across all protocols
  • Rich event metadata (topic, data_len, msg_id, etc.)

See the migration guide in PR #136 for detailed examples and complete migration instructions.

Deprecations

The following still work but generate warnings. Update your code to avoid future removal:

  • Polling Methods: The following polling methods are deprecated and may not behave as expected. They will compile but generate runtime warnings:

    • httpDidRing(), mqttDidRing(), coapDidRing(), socketAvailable()
    • Replace with *Receive() calls inside event handlers for reliable behavior

  • Socket API Parameter Order: socket_id is now the first parameter in all socket functions (previously was last or in the middle). Old order still works but logs runtime warnings.

  • Event Registration Methods: Use set<Protocol>EventHandler() instead of <protocol>SetEventHandler(). For example:

    • Old: modem.httpSetEventHandler()
    • New: modem.setHTTPEventHandler()

  • Status Check Methods: httpGetContextStatus(), coapGetContextStatus(), and getMqttStatus() are deprecated. Track connection state in your event handlers instead.

New Features

Temperature and Voltage Monitoring (#137)

Added comprehensive hardware monitoring capabilities for the modem:

Temperature Monitoring:

  • Configure temperature thresholds and monitoring modes (off/on/emergency-shutdown)
  • Query current temperature and status via getTemperature()
  • Event callbacks for temperature alerts via setTemperatureEventHandler()
  • New enums: WalterModemTempMonitorMode, WalterModemTempStatus

Voltage Monitoring:

  • Configure voltage thresholds, measurement periods, and monitoring modes
  • Query current voltage and status via getVoltage()
  • Event callbacks for voltage alerts via setVoltageEventHandler()
  • New enums: WalterModemVoltageMonitorMode, WalterModemVoltageStatus

Enhanced Examples:

  • Updated bluecherry example with monitoring demonstrations
  • JSON payload format for sensor data
  • Improved sync error handling with retry logic

HTTP Header Customization (#120)

Added extra_header_line parameter to HTTP functions, allowing custom HTTP headers for advanced use cases.

Bug Fixes

Socket Race Condition (#110)

Fixed a critical race condition that could cause a panic when closing a socket before all data was received. This resolves stability issues in high-throughput scenarios. (Issue #109)

SIM Card ID Retrieval (#126)

Fixed incorrect parsing of ICCID and eUICCID values in getSIMCardID():

  • ICCID: Now correctly handles 18-22 digit length
  • eUICCID (EID): Now correctly parses all 32 digits
  • Improved parsing logic to properly extract values from AT+SQNCCID response

HTTP Status Code Type (#128)

Corrected httpStatus type from signed to uint16_t, properly representing HTTP status codes from 100-599. (Issue #127)

Other Changes

  • socketConfig: Reduced default connection timeout from 60s to 30s for faster failure detection
  • GNSS Updates: gnssUpdateAssistance() now returns immediately; listen for WALTER_MODEM_GNSS_EVENT_ASSISTANCE in event handlers
  • Protocol Connections: Connection methods return on AT command response, not on full connection establishment. Monitor connection status via event handlers.

Resources

  • Updated examples available in the /examples folder
  • Full migration guide: PR #136
  • API documentation: Check inline doxygen comments
Assets 2
Loading