Documentation ¶
Overview ¶
Determine position, velocity and altitude using GPS.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/GPSV2_Bricklet_Go.html.
Index ¶
- Constants
- type BootloaderMode
- type BootloaderStatus
- type Fix
- type FixLEDConfig
- type Function
- type GPSV2Bricklet
- func (device *GPSV2Bricklet) DeregisterAltitudeCallback(registrationId uint64)
- func (device *GPSV2Bricklet) DeregisterCoordinatesCallback(registrationId uint64)
- func (device *GPSV2Bricklet) DeregisterDateTimeCallback(registrationId uint64)
- func (device *GPSV2Bricklet) DeregisterMotionCallback(registrationId uint64)
- func (device *GPSV2Bricklet) DeregisterPulsePerSecondCallback(registrationId uint64)
- func (device *GPSV2Bricklet) DeregisterStatusCallback(registrationId uint64)
- func (device *GPSV2Bricklet) GetAPIVersion() [3]uint8
- func (device *GPSV2Bricklet) GetAltitude() (altitude int32, geoidalSeparation int32, err error)
- func (device *GPSV2Bricklet) GetAltitudeCallbackPeriod() (period uint32, err error)
- func (device *GPSV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)
- func (device *GPSV2Bricklet) GetChipTemperature() (temperature int16, err error)
- func (device *GPSV2Bricklet) GetCoordinates() (latitude uint32, ns rune, longitude uint32, ew rune, err error)
- func (device *GPSV2Bricklet) GetCoordinatesCallbackPeriod() (period uint32, err error)
- func (device *GPSV2Bricklet) GetDateTime() (date uint32, time uint32, err error)
- func (device *GPSV2Bricklet) GetDateTimeCallbackPeriod() (period uint32, err error)
- func (device *GPSV2Bricklet) GetFixLEDConfig() (config FixLEDConfig, err error)
- func (device *GPSV2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *GPSV2Bricklet) GetMotion() (course uint32, speed uint32, err error)
- func (device *GPSV2Bricklet) GetMotionCallbackPeriod() (period uint32, err error)
- func (device *GPSV2Bricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *GPSV2Bricklet) GetSBASConfig() (sbasConfig SBAS, err error)
- func (device *GPSV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, ...)
- func (device *GPSV2Bricklet) GetSatelliteStatus(satelliteSystem SatelliteSystem, satelliteNumber uint8) (elevation int16, azimuth int16, snr int16, err error)
- func (device *GPSV2Bricklet) GetSatelliteSystemStatus(satelliteSystem SatelliteSystem) (satelliteNumbers []uint8, fix Fix, pdop uint16, hdop uint16, vdop uint16, ...)
- func (device *GPSV2Bricklet) GetSatelliteSystemStatusLowLevel(satelliteSystem SatelliteSystem) (satelliteNumbersLength uint8, satelliteNumbersData [12]uint8, fix Fix, ...)
- func (device *GPSV2Bricklet) GetStatus() (hasFix bool, satellitesView uint8, err error)
- func (device *GPSV2Bricklet) GetStatusCallbackPeriod() (period uint32, err error)
- func (device *GPSV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
- func (device *GPSV2Bricklet) ReadUID() (uid uint32, err error)
- func (device *GPSV2Bricklet) RegisterAltitudeCallback(fn func(int32, int32)) uint64
- func (device *GPSV2Bricklet) RegisterCoordinatesCallback(fn func(uint32, rune, uint32, rune)) uint64
- func (device *GPSV2Bricklet) RegisterDateTimeCallback(fn func(uint32, uint32)) uint64
- func (device *GPSV2Bricklet) RegisterMotionCallback(fn func(uint32, uint32)) uint64
- func (device *GPSV2Bricklet) RegisterPulsePerSecondCallback(fn func()) uint64
- func (device *GPSV2Bricklet) RegisterStatusCallback(fn func(bool, uint8)) uint64
- func (device *GPSV2Bricklet) Reset() (err error)
- func (device *GPSV2Bricklet) Restart(restartType RestartType) (err error)
- func (device *GPSV2Bricklet) SetAltitudeCallbackPeriod(period uint32) (err error)
- func (device *GPSV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
- func (device *GPSV2Bricklet) SetCoordinatesCallbackPeriod(period uint32) (err error)
- func (device *GPSV2Bricklet) SetDateTimeCallbackPeriod(period uint32) (err error)
- func (device *GPSV2Bricklet) SetFixLEDConfig(config FixLEDConfig) (err error)
- func (device *GPSV2Bricklet) SetMotionCallbackPeriod(period uint32) (err error)
- func (device *GPSV2Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *GPSV2Bricklet) SetResponseExpectedAll(responseExpected bool)
- func (device *GPSV2Bricklet) SetSBASConfig(sbasConfig SBAS) (err error)
- func (device *GPSV2Bricklet) SetStatusCallbackPeriod(period uint32) (err error)
- func (device *GPSV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
- func (device *GPSV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
- func (device *GPSV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
- func (device *GPSV2Bricklet) WriteUID(uid uint32) (err error)
- type RestartType
- type SBAS
- type SatelliteSystem
- type StatusLEDConfig
Constants ¶
const DeviceDisplayName = "GPS Bricklet 2.0"
const DeviceIdentifier = 276
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BootloaderMode ¶
type BootloaderMode = uint8
const ( BootloaderModeBootloader BootloaderMode = 0 BootloaderModeFirmware BootloaderMode = 1 BootloaderModeBootloaderWaitForReboot BootloaderMode = 2 BootloaderModeFirmwareWaitForReboot BootloaderMode = 3 BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4 )
type BootloaderStatus ¶
type BootloaderStatus = uint8
const ( BootloaderStatusOK BootloaderStatus = 0 BootloaderStatusInvalidMode BootloaderStatus = 1 BootloaderStatusNoChange BootloaderStatus = 2 BootloaderStatusEntryFunctionNotPresent BootloaderStatus = 3 BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4 BootloaderStatusCRCMismatch BootloaderStatus = 5 )
type FixLEDConfig ¶
type FixLEDConfig = uint8
const ( FixLEDConfigOff FixLEDConfig = 0 FixLEDConfigOn FixLEDConfig = 1 FixLEDConfigShowHeartbeat FixLEDConfig = 2 FixLEDConfigShowFix FixLEDConfig = 3 FixLEDConfigShowPPS FixLEDConfig = 4 )
type Function ¶
type Function = uint8
const ( FunctionGetCoordinates Function = 1 FunctionGetStatus Function = 2 FunctionGetAltitude Function = 3 FunctionGetMotion Function = 4 FunctionGetDateTime Function = 5 FunctionRestart Function = 6 FunctionGetSatelliteSystemStatusLowLevel Function = 7 FunctionGetSatelliteStatus Function = 8 FunctionSetFixLEDConfig Function = 9 FunctionGetFixLEDConfig Function = 10 FunctionSetCoordinatesCallbackPeriod Function = 11 FunctionGetCoordinatesCallbackPeriod Function = 12 FunctionSetStatusCallbackPeriod Function = 13 FunctionGetStatusCallbackPeriod Function = 14 FunctionSetAltitudeCallbackPeriod Function = 15 FunctionGetAltitudeCallbackPeriod Function = 16 FunctionSetMotionCallbackPeriod Function = 17 FunctionGetMotionCallbackPeriod Function = 18 FunctionSetDateTimeCallbackPeriod Function = 19 FunctionGetDateTimeCallbackPeriod Function = 20 FunctionSetSBASConfig Function = 27 FunctionGetSBASConfig Function = 28 FunctionGetSPITFPErrorCount Function = 234 FunctionSetBootloaderMode Function = 235 FunctionGetBootloaderMode Function = 236 FunctionSetWriteFirmwarePointer Function = 237 FunctionWriteFirmware Function = 238 FunctionSetStatusLEDConfig Function = 239 FunctionGetStatusLEDConfig Function = 240 FunctionGetChipTemperature Function = 242 FunctionReset Function = 243 FunctionWriteUID Function = 248 FunctionReadUID Function = 249 FunctionGetIdentity Function = 255 FunctionCallbackPulsePerSecond Function = 21 FunctionCallbackCoordinates Function = 22 FunctionCallbackStatus Function = 23 FunctionCallbackAltitude Function = 24 FunctionCallbackMotion Function = 25 FunctionCallbackDateTime Function = 26 )
type GPSV2Bricklet ¶
type GPSV2Bricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (GPSV2Bricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*GPSV2Bricklet) DeregisterAltitudeCallback ¶
func (device *GPSV2Bricklet) DeregisterAltitudeCallback(registrationId uint64)
Remove a registered Altitude callback.
func (*GPSV2Bricklet) DeregisterCoordinatesCallback ¶
func (device *GPSV2Bricklet) DeregisterCoordinatesCallback(registrationId uint64)
Remove a registered Coordinates callback.
func (*GPSV2Bricklet) DeregisterDateTimeCallback ¶
func (device *GPSV2Bricklet) DeregisterDateTimeCallback(registrationId uint64)
Remove a registered Date Time callback.
func (*GPSV2Bricklet) DeregisterMotionCallback ¶
func (device *GPSV2Bricklet) DeregisterMotionCallback(registrationId uint64)
Remove a registered Motion callback.
func (*GPSV2Bricklet) DeregisterPulsePerSecondCallback ¶
func (device *GPSV2Bricklet) DeregisterPulsePerSecondCallback(registrationId uint64)
Remove a registered Pulse Per Second callback.
func (*GPSV2Bricklet) DeregisterStatusCallback ¶
func (device *GPSV2Bricklet) DeregisterStatusCallback(registrationId uint64)
Remove a registered Status callback.
func (*GPSV2Bricklet) GetAPIVersion ¶
func (device *GPSV2Bricklet) GetAPIVersion() [3]uint8
Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.
func (*GPSV2Bricklet) GetAltitude ¶
func (device *GPSV2Bricklet) GetAltitude() (altitude int32, geoidalSeparation int32, err error)
Returns the current altitude and corresponding geoidal separation.
This data is only valid if there is currently a fix as indicated by GetStatus.
func (*GPSV2Bricklet) GetAltitudeCallbackPeriod ¶
func (device *GPSV2Bricklet) GetAltitudeCallbackPeriod() (period uint32, err error)
Returns the period as set by SetAltitudeCallbackPeriod.
func (*GPSV2Bricklet) GetBootloaderMode ¶
func (device *GPSV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)
Returns the current bootloader mode, see SetBootloaderMode.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
func (*GPSV2Bricklet) GetChipTemperature ¶
func (device *GPSV2Bricklet) GetChipTemperature() (temperature int16, err error)
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
func (*GPSV2Bricklet) GetCoordinates ¶
func (device *GPSV2Bricklet) GetCoordinates() (latitude uint32, ns rune, longitude uint32, ew rune, err error)
Returns the GPS coordinates. Latitude and longitude are given in the “DD.dddddd°“ format, the value 57123468 means 57.123468°. The parameter “ns“ and “ew“ are the cardinal directions for latitude and longitude. Possible values for “ns“ and “ew“ are 'N', 'S', 'E' and 'W' (north, south, east and west).
This data is only valid if there is currently a fix as indicated by GetStatus.
func (*GPSV2Bricklet) GetCoordinatesCallbackPeriod ¶
func (device *GPSV2Bricklet) GetCoordinatesCallbackPeriod() (period uint32, err error)
Returns the period as set by SetCoordinatesCallbackPeriod.
func (*GPSV2Bricklet) GetDateTime ¶
func (device *GPSV2Bricklet) GetDateTime() (date uint32, time uint32, err error)
Returns the current date and time. The date is given in the format “ddmmyy“ and the time is given in the format “hhmmss.sss“. For example, 140713 means 14.07.13 as date and 195923568 means 19:59:23.568 as time.
func (*GPSV2Bricklet) GetDateTimeCallbackPeriod ¶
func (device *GPSV2Bricklet) GetDateTimeCallbackPeriod() (period uint32, err error)
Returns the period as set by SetDateTimeCallbackPeriod.
func (*GPSV2Bricklet) GetFixLEDConfig ¶
func (device *GPSV2Bricklet) GetFixLEDConfig() (config FixLEDConfig, err error)
Returns the configuration as set by SetFixLEDConfig
Associated constants:
- FixLEDConfigOff
- FixLEDConfigOn
- FixLEDConfigShowHeartbeat
- FixLEDConfigShowFix
- FixLEDConfigShowPPS
func (*GPSV2Bricklet) GetIdentity ¶
func (device *GPSV2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.
The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|
func (*GPSV2Bricklet) GetMotion ¶
func (device *GPSV2Bricklet) GetMotion() (course uint32, speed uint32, err error)
Returns the current course and speed. A course of 0° means the Bricklet is traveling north bound and 90° means it is traveling east bound.
Please note that this only returns useful values if an actual movement is present.
This data is only valid if there is currently a fix as indicated by GetStatus.
func (*GPSV2Bricklet) GetMotionCallbackPeriod ¶
func (device *GPSV2Bricklet) GetMotionCallbackPeriod() (period uint32, err error)
Returns the period as set by SetMotionCallbackPeriod.
func (*GPSV2Bricklet) GetResponseExpected ¶
func (device *GPSV2Bricklet) GetResponseExpected(functionID Function) (bool, error)
Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.
For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
See SetResponseExpected for the list of function ID constants available for this function.
func (*GPSV2Bricklet) GetSBASConfig ¶
func (device *GPSV2Bricklet) GetSBASConfig() (sbasConfig SBAS, err error)
Returns the SBAS configuration as set by SetSBASConfig
.. versionadded:: 2.0.2$nbsp;(Plugin)
Associated constants:
- SBASEnabled
- SBASDisabled
func (*GPSV2Bricklet) GetSPITFPErrorCount ¶
func (device *GPSV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into ¶
* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
func (*GPSV2Bricklet) GetSatelliteStatus ¶
func (device *GPSV2Bricklet) GetSatelliteStatus(satelliteSystem SatelliteSystem, satelliteNumber uint8) (elevation int16, azimuth int16, snr int16, err error)
Returns the current elevation, azimuth and SNR for a given satellite and satellite system.
The satellite number here always goes from 1 to 32. For GLONASS it corresponds to the satellites 65-96.
Galileo is not yet supported.
Associated constants:
- SatelliteSystemGPS
- SatelliteSystemGLONASS
- SatelliteSystemGalileo
func (*GPSV2Bricklet) GetSatelliteSystemStatus ¶
func (device *GPSV2Bricklet) GetSatelliteSystemStatus(satelliteSystem SatelliteSystem) (satelliteNumbers []uint8, fix Fix, pdop uint16, hdop uint16, vdop uint16, err error)
Returns the
* satellite numbers list (up to 12 items) * fix value, * PDOP value, * HDOP value and * VDOP value
for a given satellite system. Currently GPS and GLONASS are supported, Galileo is not yet supported.
The GPS and GLONASS satellites have unique numbers and the satellite list gives the numbers of the satellites that are currently utilized. The number 0 is not a valid satellite number and can be ignored in the list.
func (*GPSV2Bricklet) GetSatelliteSystemStatusLowLevel ¶
func (device *GPSV2Bricklet) GetSatelliteSystemStatusLowLevel(satelliteSystem SatelliteSystem) (satelliteNumbersLength uint8, satelliteNumbersData [12]uint8, fix Fix, pdop uint16, hdop uint16, vdop uint16, err error)
Returns the
* satellite numbers list (up to 12 items) * fix value, * PDOP value, * HDOP value and * VDOP value
for a given satellite system. Currently GPS and GLONASS are supported, Galileo is not yet supported.
The GPS and GLONASS satellites have unique numbers and the satellite list gives the numbers of the satellites that are currently utilized. The number 0 is not a valid satellite number and can be ignored in the list.
Associated constants:
- SatelliteSystemGPS
- SatelliteSystemGLONASS
- SatelliteSystemGalileo
- FixNoFix
- Fix2DFix
- Fix3DFix
func (*GPSV2Bricklet) GetStatus ¶
func (device *GPSV2Bricklet) GetStatus() (hasFix bool, satellitesView uint8, err error)
Returns if a fix is currently available as well as the number of satellites that are in view.
There is also a `green LED <gps_v2_bricklet_fix_led>` on the Bricklet that indicates the fix status.
func (*GPSV2Bricklet) GetStatusCallbackPeriod ¶
func (device *GPSV2Bricklet) GetStatusCallbackPeriod() (period uint32, err error)
Returns the period as set by SetStatusCallbackPeriod.
func (*GPSV2Bricklet) GetStatusLEDConfig ¶
func (device *GPSV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
Returns the configuration as set by SetStatusLEDConfig
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*GPSV2Bricklet) ReadUID ¶
func (device *GPSV2Bricklet) ReadUID() (uid uint32, err error)
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
func (*GPSV2Bricklet) RegisterAltitudeCallback ¶
func (device *GPSV2Bricklet) RegisterAltitudeCallback(fn func(int32, int32)) uint64
This callback is triggered periodically with the period that is set by SetAltitudeCallbackPeriod. The parameters are the same as for GetAltitude.
The RegisterAltitudeCallback callback is only triggered if the altitude changed since the last triggering and if there is currently a fix as indicated by GetStatus.
func (*GPSV2Bricklet) RegisterCoordinatesCallback ¶
func (device *GPSV2Bricklet) RegisterCoordinatesCallback(fn func(uint32, rune, uint32, rune)) uint64
This callback is triggered periodically with the period that is set by SetCoordinatesCallbackPeriod. The parameters are the same as for GetCoordinates.
The RegisterCoordinatesCallback callback is only triggered if the coordinates changed since the last triggering and if there is currently a fix as indicated by GetStatus.
func (*GPSV2Bricklet) RegisterDateTimeCallback ¶
func (device *GPSV2Bricklet) RegisterDateTimeCallback(fn func(uint32, uint32)) uint64
This callback is triggered periodically with the period that is set by SetDateTimeCallbackPeriod. The parameters are the same as for GetDateTime.
The RegisterDateTimeCallback callback is only triggered if the date or time changed since the last triggering.
func (*GPSV2Bricklet) RegisterMotionCallback ¶
func (device *GPSV2Bricklet) RegisterMotionCallback(fn func(uint32, uint32)) uint64
This callback is triggered periodically with the period that is set by SetMotionCallbackPeriod. The parameters are the same as for GetMotion.
The RegisterMotionCallback callback is only triggered if the motion changed since the last triggering and if there is currently a fix as indicated by GetStatus.
func (*GPSV2Bricklet) RegisterPulsePerSecondCallback ¶
func (device *GPSV2Bricklet) RegisterPulsePerSecondCallback(fn func()) uint64
This callback is triggered precisely once per second, see https://en.wikipedia.org/wiki/Pulse-per-second_signal.
The precision of two subsequent pulses will be skewed because of the latency in the USB/RS485/Ethernet connection. But in the long run this will be very precise. For example a count of 3600 pulses will take exactly 1 hour.
func (*GPSV2Bricklet) RegisterStatusCallback ¶
func (device *GPSV2Bricklet) RegisterStatusCallback(fn func(bool, uint8)) uint64
This callback is triggered periodically with the period that is set by SetStatusCallbackPeriod. The parameters are the same as for GetStatus.
The RegisterStatusCallback callback is only triggered if the status changed since the last triggering.
func (*GPSV2Bricklet) Reset ¶
func (device *GPSV2Bricklet) Reset() (err error)
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
func (*GPSV2Bricklet) Restart ¶
func (device *GPSV2Bricklet) Restart(restartType RestartType) (err error)
Restarts the GPS Bricklet, the following restart types are available:
Value| Description --- | --- 0| Hot start (use all available data in the NV store) 1| Warm start (don't use ephemeris at restart) 2| Cold start (don't use time| position| almanacs and ephemeris at restart) 3| Factory reset (clear all system/user configurations at restart)
Associated constants:
- RestartTypeHotStart
- RestartTypeWarmStart
- RestartTypeColdStart
- RestartTypeFactoryReset
func (*GPSV2Bricklet) SetAltitudeCallbackPeriod ¶
func (device *GPSV2Bricklet) SetAltitudeCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterAltitudeCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterAltitudeCallback callback is only triggered if the altitude changed since the last triggering.
func (*GPSV2Bricklet) SetBootloaderMode ¶
func (device *GPSV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
- BootloaderStatusOK
- BootloaderStatusInvalidMode
- BootloaderStatusNoChange
- BootloaderStatusEntryFunctionNotPresent
- BootloaderStatusDeviceIdentifierIncorrect
- BootloaderStatusCRCMismatch
func (*GPSV2Bricklet) SetCoordinatesCallbackPeriod ¶
func (device *GPSV2Bricklet) SetCoordinatesCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterCoordinatesCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterCoordinatesCallback callback is only triggered if the coordinates changed since the last triggering.
func (*GPSV2Bricklet) SetDateTimeCallbackPeriod ¶
func (device *GPSV2Bricklet) SetDateTimeCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterDateTimeCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterDateTimeCallback callback is only triggered if the date or time changed since the last triggering.
func (*GPSV2Bricklet) SetFixLEDConfig ¶
func (device *GPSV2Bricklet) SetFixLEDConfig(config FixLEDConfig) (err error)
Sets the fix LED configuration. By default the LED shows if the Bricklet got a GPS fix yet. If a fix is established the LED turns on. If there is no fix then the LED is turned off.
You can also turn the LED permanently on/off, show a heartbeat or let it blink in sync with the PPS (pulse per second) output of the GPS module.
If the Bricklet is in bootloader mode, the LED is off.
Associated constants:
- FixLEDConfigOff
- FixLEDConfigOn
- FixLEDConfigShowHeartbeat
- FixLEDConfigShowFix
- FixLEDConfigShowPPS
func (*GPSV2Bricklet) SetMotionCallbackPeriod ¶
func (device *GPSV2Bricklet) SetMotionCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterMotionCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterMotionCallback callback is only triggered if the motion changed since the last triggering.
func (*GPSV2Bricklet) SetResponseExpected ¶
func (device *GPSV2Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error
Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
func (*GPSV2Bricklet) SetResponseExpectedAll ¶
func (device *GPSV2Bricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
func (*GPSV2Bricklet) SetSBASConfig ¶
func (device *GPSV2Bricklet) SetSBASConfig(sbasConfig SBAS) (err error)
If https://en.wikipedia.org/wiki/GNSS_augmentation#Satellite-based_augmentation_system is enabled, the position accuracy increases (if SBAS satellites are in view), but the update rate is limited to 5Hz. With SBAS disabled the update rate is increased to 10Hz.
.. versionadded:: 2.0.2$nbsp;(Plugin)
Associated constants:
- SBASEnabled
- SBASDisabled
func (*GPSV2Bricklet) SetStatusCallbackPeriod ¶
func (device *GPSV2Bricklet) SetStatusCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterStatusCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterStatusCallback callback is only triggered if the status changed since the last triggering.
func (*GPSV2Bricklet) SetStatusLEDConfig ¶
func (device *GPSV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*GPSV2Bricklet) SetWriteFirmwarePointer ¶
func (device *GPSV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
func (*GPSV2Bricklet) WriteFirmware ¶
func (device *GPSV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
func (*GPSV2Bricklet) WriteUID ¶
func (device *GPSV2Bricklet) WriteUID(uid uint32) (err error)
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
type RestartType ¶
type RestartType = uint8
const ( RestartTypeHotStart RestartType = 0 RestartTypeWarmStart RestartType = 1 RestartTypeColdStart RestartType = 2 RestartTypeFactoryReset RestartType = 3 )
type SatelliteSystem ¶
type SatelliteSystem = uint8
const ( SatelliteSystemGPS SatelliteSystem = 0 SatelliteSystemGLONASS SatelliteSystem = 1 SatelliteSystemGalileo SatelliteSystem = 2 )
type StatusLEDConfig ¶
type StatusLEDConfig = uint8
const ( StatusLEDConfigOff StatusLEDConfig = 0 StatusLEDConfigOn StatusLEDConfig = 1 StatusLEDConfigShowHeartbeat StatusLEDConfig = 2 StatusLEDConfigShowStatus StatusLEDConfig = 3 )