Measurements¶

Description¶

Module: geocompy.gsi.dna.measurements

Definitions for the DNA measurements subsystem.

Types¶

GsiOnlineDNAMeasurements

Definitions¶

class GsiOnlineDNAMeasurements(parent: GsiOnlineType)[source]¶

Measurements subsystem of the DNA GSI Online protocol.

This subsystem gives access to measurement data. The communication (both get and set) is done through GSI data words.

Parameters:

parent: GsiOnlineType¶: The parent protocol instance of this subsystem.

get_date() → GsiOnlineResponse[datetime][source]¶

GET 561

Gets the current month and day.

Returns:: Current month and day wrapped in a datetime object (year should be ignored).
Return type:: GsiOnlineResponse

get_day_time() → GsiOnlineResponse[datetime][source]¶

GET 19

Gets the current month, day and time.

Returns:: Month, day and time wrapped in a datetime object (year should be ignored).
Return type:: GsiOnlineResponse

get_distance() → GsiOnlineResponse[float][source]¶

GET 32

Measures the distance from the aimed levelling staff in meters.

Returns:: Distance.
Return type:: GsiOnlineResponse

get_full_date() → GsiOnlineResponse[datetime][source]¶

GET 17

Gets the current full date (year, month, day).

Returns:: Full date.
Return type:: GsiOnlineResponse

get_instrument_type() → GsiOnlineResponse[str][source]¶

GET 13

Gets the instrument type name.

Returns:: Instrument type.
Return type:: GsiOnlineResponse

get_note() → GsiOnlineResponse[str][source]¶

GET 71

Gets the current point note/remark.

Returns:: Point note.
Return type:: GsiOnlineResponse

get_point_id() → GsiOnlineResponse[str][source]¶

GET 11

Gets the current running point ID.

Returns:: Point ID.
Return type:: GsiOnlineResponse

get_reading() → GsiOnlineResponse[float][source]¶

GET 330

Takes a reading on the aimed levelling staff in meters.

Returns:: Staff reading.
Return type:: GsiOnlineResponse

get_serialnumber() → GsiOnlineResponse[int][source]¶

GET 12

Gets the serial number of the instrument.

Returns:: Serial number.
Return type:: GsiOnlineResponse

get_software_version() → GsiOnlineResponse[float][source]¶

GET 599

Gets the software version of the instrument.

Returns:: Software version as float (integer part is major, fractional part is minor version with 4 decimals maximum).
Return type:: GsiOnlineResponse

get_temperature() → GsiOnlineResponse[float][source]¶

GET 95

Measures and returns the internal temperature in Celsius degrees.

Returns:: Internal temperature.
Return type:: GsiOnlineResponse

get_time() → GsiOnlineResponse[datetime][source]¶

GET 560

Gets the current time.

Returns:: Current time wrapped in a datetime object (year, month and day should be ignored).
Return type:: GsiOnlineResponse

get_year() → GsiOnlineResponse[datetime][source]¶

GET 562

Gets the current year.

Returns:: Current year wrapped in a datetime object (month and day should be ignored).
Return type:: GsiOnlineResponse

set_date(date: datetime) → GsiOnlineResponse[bool][source]¶

PUT 561

Sets the month and day.

Parameters:

date: datetime¶

Returns:

Success of the change.

Return type:

GsiOnlineResponse

set_note(note: str) → GsiOnlineResponse[bool][source]¶

PUT 71

Sets the point note/remark.

Parameters:

note: str¶: Point note.

Returns:

Success of the change.

Return type:

GsiOnlineResponse

set_point_id(ptid: str) → GsiOnlineResponse[bool][source]¶

PUT 11

Sets the running point ID.

Parameters:

ptid: str¶: Point ID.

Returns:

Success of the change.

Return type:

GsiOnlineResponse

set_time(time: datetime) → GsiOnlineResponse[bool][source]¶

PUT 560

Sets the hours, minutes and seconds on the instrument.

Parameters:

time: datetime¶: New time to set.

Returns:

Success of the change.

Return type:

GsiOnlineResponse

set_year(year: datetime) → GsiOnlineResponse[bool][source]¶

PUT 562

Sets the year.

Parameters:

year: datetime¶

Returns:

Success of the change.

Return type:

GsiOnlineResponse