Eclipse2017
===========



The Eclipse2017 Service provides access to US weather data along the path of the Great American Eclipse.
For more information about the eclipse, check out https://www.greatamericaneclipse.com/.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: Eclipse2017.availableStations(maxReadingMedian: Number, maxDistanceFromCenter: Number, latitude: Latitude?, longitude: Longitude?, maxDistanceFromPoint: Number?)

    Get a list of reporting weather stations for the given arguments.

    **Arguments:**

    - ``maxReadingMedian: Number`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) 
    - ``maxDistanceFromCenter: Number`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) 
    - ``latitude: Latitude?`` (`Latitude </docs/fundamentals/rpc-arg-types.html#Latitude>`__) 
    - ``longitude: Longitude?`` (`Longitude </docs/fundamentals/rpc-arg-types.html#Longitude>`__) 
    - ``maxDistanceFromPoint: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) 


.. function:: Eclipse2017.conditionHistory(stationId: String, limit: String)

    Get the reported conditions for a given weather station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``limit: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Number of results to return (max is 3000)


.. function:: Eclipse2017.conditionHistoryRange(stationId: String, startTime: String, endTime: String)

    Get the reported conditions during a given time for a given weather station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``startTime: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``endTime: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 


.. function:: Eclipse2017.eclipsePath()

    Get the path of the eclipse as a list of latitude, longitude, and time.


.. function:: Eclipse2017.pastCondition(stationId: String, time: String)

    Get historical conditions at a given weather station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``time: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 


.. function:: Eclipse2017.pastTemperature(stationId: String, time: String)

    Get historical temperature for a given weather station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``time: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 


.. function:: Eclipse2017.selectPointBased()

    Get stations selected based on the points of the eclipse path.


.. function:: Eclipse2017.selectSectionBased(numSections: Integer, perSection: Integer)

    Divide the eclipse path into a number of sections and select weather stations from each section.

    **Arguments:**

    - ``numSections: Integer`` (`Integer </docs/fundamentals/rpc-arg-types.html#Integer>`__) - Number of sections to divide the path into
    - ``perSection: Integer`` (`Integer </docs/fundamentals/rpc-arg-types.html#Integer>`__) - Number of stations to select


.. function:: Eclipse2017.stationInfo(stationId: String)

    Get information about a given reporting station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Reporting station ID (pws)


.. function:: Eclipse2017.stations()

    Get a list of reporting stations IDs (pws field).


.. function:: Eclipse2017.stationsInfo()

    Get information about all reporting weather stations.


.. function:: Eclipse2017.temperatureHistory(stationId: String, limit: String)

    Get the reported temperatures for a given weather station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``limit: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Number of results to return (max is 3000)


.. function:: Eclipse2017.temperatureHistoryRange(stationId: String, startTime: String, endTime: String)

    Get the reported temperatures during a given time for a given weather station.

    **Arguments:**

    - ``stationId: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``startTime: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``endTime: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__)