Skip to content

Commit

Permalink
Clarify comments of api functions
Browse files Browse the repository at this point in the history
  • Loading branch information
MiquelIR committed Jun 27, 2017
1 parent da3dae3 commit af71e82
Showing 1 changed file with 21 additions and 24 deletions.
45 changes: 21 additions & 24 deletions primestg/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,73 +26,70 @@ def create_service(self):

def get_daily_incremental(self, meters, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S02 report for the corresponding meters
Asks for a S02 report to the specified meter.
:param meters: a meter_id
:return: an S02 report for the corresponding meter
"""
if isinstance(meters, list):
meters = ','.join(meters)
return self.send('S02', meters, date_from, date_to)

def get_all_daily_incremental(self, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S02 report for the corresponding meters
Asks for a S02 report to all meters.
:return: an S02 report from every meter
"""
return self.send('S02', '', date_from, date_to)

def get_monthly_billing(self, meters, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S04 report for the corresponding meters
Asks for a S04 report to the specified meter.
:param meters: a meter_id
:return: an S04 report for the corresponding meter
"""
if isinstance(meters, list):
meters = ','.join(meters)
return self.send('S04', meters, date_from, date_to)

def get_all_monthly_billing(self, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S04 report for the corresponding meters
Asks for a S04 report to all meters.
:return: an S04 report from every meter
"""
return self.send('S04', '', date_from, date_to)

def get_daily_absolute(self, meters, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S05 report for the corresponding meters
Asks for a S05 report to the specified meter.
:param meters: a meter_id
:return: an S05 report for the corresponding meter
"""
if isinstance(meters, list):
meters = ','.join(meters)
return self.send('S05', meters, date_from, date_to)

def get_all_daily_absolute(self, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S05 report for the corresponding meters
Asks for a S05 report to all meters.
:return: an S05 report from every meter
"""
return self.send('S05', '', date_from, date_to)

def get_meter_events(self, meters, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S09 report for the corresponding meters
Asks for a S09 report to the specified meter.
:param meters: a meter_id
:return: an S09 report for the corresponding meter
"""
if isinstance(meters, list):
meters = ','.join(meters)
return self.send('S09', meters, date_from, date_to)

def get_meter_parameters(self, meters, date_from, date_to):
"""
If meter is empty list do it for all meters.
:param meters: either meter_id, list of meter_id's or empty list
:return: an S06 report for the corresponding meters
Asks for a S06 report to the specified meter.
:param meters: a meter_id
:return: an S06 report for the corresponding meter
"""
if isinstance(meters, list):
meters = ','.join(meters)
Expand Down

0 comments on commit af71e82

Please sign in to comment.