Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uraimo/UBloxGPS.swift
A Swift library for boards with the u-Blox 6/7/8 family of A-GPS receivers
https://github.com/uraimo/UBloxGPS.swift
gps neo6m raspberrypi u-blox
Last synced: 3 months ago
JSON representation
A Swift library for boards with the u-Blox 6/7/8 family of A-GPS receivers
- Host: GitHub
- URL: https://github.com/uraimo/UBloxGPS.swift
- Owner: uraimo
- License: other
- Created: 2017-04-06T18:40:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-26T16:50:55.000Z (about 5 years ago)
- Last Synced: 2024-07-28T14:34:34.180Z (3 months ago)
- Topics: gps, neo6m, raspberrypi, u-blox
- Language: Swift
- Size: 3.08 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-embedded-swift - UBloxGPS.swift - A Swift library for boards with the u-Blox 6/7/8 family of A-GPS receivers (Sensors / Networking, IoT, Bus Protocols, …)
README
# UBloxGPS.swift
*A Swift library for boards with the u-Blox 6/7/8 family of A-GPS receivers with an UART serial connection.*
# Summary
This library interfaces with boards based on u-Blox 6/7/8 A-GPS receivers, that use the NMEA0183 protocol to provide GPS data over an UART serial connection (for a low cost option, search for some NEO6M-based board that usually cost around a measly $20). UBX configuration commands and connection via I2C are not supported at the moment.
You'll be able to retrieve your current location, elevation, speed, status data on the currently reachable satellites and more.
The first time you'll use the receiver it will need a few minutes to find some satellites and provide a position, but after that a few seconds will be enough to obtain a valid position.
## Supported Boards
Every board supported by [SwiftyGPIO](https://github.com/uraimo/SwiftyGPIO) with support for UART interfaces.
To use this library, you'll need a Linux ARM board with Swift 3.x.
The example below will use a RaspberryPi 2 board but you can easily modify the example to use one the the other supported boards, a full working demo projects for the RaspberryPi2 is available in the `Examples` directory.
## Usage
If you are using a RaspberryPi, run `raspi-config` and enable the serial port _but disable_ the Linux login support in `Interfacing Options > Serial`.
The first thing we need to do is to obtain an instance of `UARTInterface` from SwiftyGPIO and use it to initialize the `UBloxGPS` object:
```swift
import SwiftyGPIO
import UBloxGPS
let uarts = SwiftyGPIO.UARTs(for:.RaspberryPi2)!
var uart = uarts[0]
let gps = UBloxGPS(uart)
```
We must then start the background thread that will update the GPS location and other information calling `startUpdating`. The library allows to print a quick recap of all available data with `printStatus`:
```swift
gps.startUpdating()
// We'll simply clear the screen and print a recap of the current gps data
while true {
system("clear")
gps.printStatus()
sleep(2)
}
```
The `UBloxGPS` object has some accessible properties that you can use to retrieve the specific data you need:
| Property | Description |
|-----------|------------|
| isDataValid | Is the current GPS data valid? True when a valid position is obtained |
| datetime | Date and time in stringified format |
| latitude | Latitude in degrees |
| longitude | Longitude in degrees |
| satellitesNum | Number of visible satellites |
| satellitesActiveNum | Number of active satellites (visible and with a signal strong enough to used) |
| altitude | Altitude from sea level |
| altitudeUnit | Unit for altitude |
| satellites | Information about the satellites that are currently in the line of sight (max 12), the structure contains: a numerical id, elevation (0..60 in degrees), azimuth (0..360 in degrees) and an snr(dB) value for an indication of the noise affecting the signal |
When you don't need to update the location data anymore or to pause updates just call `stopUpdating()`.
## Installation
Please refer to the [SwiftyGPIO](https://github.com/uraimo/SwiftyGPIO) readme for Swift installation instructions.
Once your board runs Swift, if your version support the Swift Package Manager, you can simply add this library as a dependency of your project and compile with `swift build`:
```swift
let package = Package(
name: "MyProject",
dependencies: [
.Package(url: "https://github.com/uraimo/UBloxGPS.swift.git", majorVersion: 1),
...
]
...
)
```
The directory `Examples` contains sample projects that uses SPM, compile it and run the sample with `./.build/debug/TestNEO6M`.
If SPM is not supported, you'll need to manually download the library and its dependencies:
wget https://raw.githubusercontent.com/uraimo/UBloxGPS.swift/master/Sources/UBloxGPS.swift https://raw.githubusercontent.com/uraimo/SwiftyGPIO/master/Sources/SwiftyGPIO.swift https://raw.githubusercontent.com/uraimo/SwiftyGPIO/master/Sources/Presets.swift https://raw.githubusercontent.com/uraimo/SwiftyGPIO/master/Sources/UART.swift https://raw.githubusercontent.com/uraimo/SwiftyGPIO/master/Sources/SunXi.swift
And once all the files have been downloaded, create an additional file that will contain the code of your application (e.g. main.swift). When your code is ready, compile it with:
swiftc *.swift
The compiler will create a **main** executable.