Skip to content

Commit

Permalink
Update README and bump version to 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
alextsam committed Aug 26, 2018
1 parent c55b4db commit bf5e89e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
14 changes: 5 additions & 9 deletions Readme.md
@@ -1,8 +1,8 @@
# Sodaq_nbIOT
# Sodaq_nbIOT v2

Arduino library for using with the uBlox nbIOT modules.

The firmware version of the module should be >= 06.57,A03.02.
The firmware version of the module should be >= 06.57,A03.02.

Please check http://support.sodaq.com/sodaq-one/firmware-upgrade/ for the latest firmware.

Expand Down Expand Up @@ -78,19 +78,15 @@ Method|Description
**getSentMessagesCount(SentMessageStatus filter)**|Returns the number of messages that are either pending (filter == Pending) or failed to be transmitted (filter == Error) on the modem.
**createSocket(uint16_t localPort = 0)**|Create a UDP socket for the specified local port, returns the socket handle.
**closeSocket(uint8_t socket)**|Close a UDP socket by handle, returns true if successful.
**socketSend(uint8_t socket, const char\* remoteIP, const uint16_t remotePort, char\* buffer, size_t size)**|Send a udp payload buffer to a specified remote IP and port, through a specific socket.
**socketSend(uint8_t socket, const char\* remoteIP, const uint16_t remotePort, const uint8_t\* buffer, size_t size)**|Send a UDP payload buffer to a specified remote IP and port, through a specific socket.
**socketSend(uint8_t socket, const char\* remoteIP, const uint16_t remotePort, const char\* str)**|Send a UDP string to a specified remote IP and port, through a specific socket.
**socketReceiveHex(char\* buffer, size_t length, SaraN2UDPPacketMetadata\* p = NULL)**|Receive pending socket data as hex data in a passed buffer. Optionally pass a helper object to receive metadata about the origin of the socket data.
**socketReceiveBytes(uint8_t\* buffer, size_t length, SaraN2UDPPacketMetadata\* p = NULL)**|Receive pending socket data as binary data in a passed buffer. Optionally pass a helper object to receive metadata about the origin of the socket data.
**getPendingUDPBytes()**| Return the number of pending bytes, gets updated by calling socketReceiveXXX.
**hasPendingUDPBytes()**| Helper function returning if getPendingUDPBytes() > 0.
**ping(char\* ip)**| Ping a specific IP address.
**waitForUDPResponse(uint32_t timeoutMS = DEFAULT_UDP_TIMOUT_MS)**|Calls isAlive() until the passed timeout, or until a UDP packet has been received on any socket.






## Contributing

1. Fork it!
Expand All @@ -101,7 +97,7 @@ Method|Description

## License

Copyright (c) 2015-2016 Sodaq. All rights reserved.
Copyright (c) 2018 Sodaq. All rights reserved.

This file is part of Sodaq_nbIOT.

Expand Down
2 changes: 1 addition & 1 deletion library.properties
@@ -1,5 +1,5 @@
name=Sodaq_nbIOT
version=1.5.0
version=2.0.0
author=Alex Tsamakos,SODAQ
maintainer=Kees Bakker <kees@m2m4all.com>
sentence=An Arduino library for the uBlox nbIOT modules.
Expand Down

0 comments on commit bf5e89e

Please sign in to comment.